Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

NetDev_ClkGetFreq()

This function is called by a device driver’s NetDev_Init() to return a specific network device’s clock frequency for a specific interface.

Files

net_bsp.c

Prototype

...

 

Note that since NetDev_ClkFreqGet() is accessed only by function pointer via a BSP interface structure, it doesn’t need to be globally available and should therefore be declared as ‘static’.

...

Pointer to variable that will receive the return error code from this function:

NET_DEV_ERR_NONE
NET_DEV_ERR_FAULT

...

This is not an exclusive list of return errors and specific network device’s or device BSP functions may return any other specific errors as required.

...

NetDev_[Device]ClkGetFreq[Number]() 

[Device]

Network device name or type, e.g. MACB (optional if the development board does not support multiple devices)

...

For example, the NetDev_ClkFreqGet() function for the #2 MACB Ethernet controller on an Atmel AT91SAM9263-EK should be named NetDev_MACB_ClkGetFreq2(), or NetDev_MACB_ClkGetFreq_2() with additional underscore optional.

See also Chapter 6Chapter 6, “Network Board Support Package”.