Versions Compared

Key

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

...

Function NameDescription
NetDev_

...

CfgClkThis function is called by a device

...

driver’s NetDev_

...

Files

net_bsp.c

Prototype

 

 

Note: since NetDev_WiFi_Start() 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’.

Arguments

p_if

Pointer to specific interface to start device’s hardware.

p_err

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.

Returned Value

None.

Required Configuration

None.

Notes / Warnings

Since each network device requires a unique NetDev_WiFi_Start(), it is recommended that each device’s NetDev_WiFi_Start() function be named using the following convention:

NetDev_WiFi_[Device]_Start[Number]()

 

[Device]

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

[Number]

Network device number for each specific instance of device (optional if the development board does not support multiple instances of the specific device)

For example, the NetDev_WiFi_Start() function for the #2 RS9110 wireless devie should be named NetDev_WiFi_RS9110_Start2(), or NetDev_WiFI_RS9110_Start_2() with additional underscore optional.

...

Init() to configure a specific network device’s clocks on a specific interface.
NetDev_CfgGPIOThis function is called by a device driver’s NetDev_Init() to configure a specific network device’s general-purpose input/ouput (GPIO) on a specific interface.
NetDev_CfgIntCtrlThis function is called by a device driver’s NetDev_Init() to configure a specific network device’s interrupts and/or interrupt controller on a specific interface.
NetDev_ClkGetFreqThis function is called by a device driver’s NetDev_Init() to return a specific network device’s clock frequency for a specific interface.
NetDev_ISR_Handler()Handle a network device’s interrupts on a specific interface.