NetDev_WiFi_Stop

This function is called by a device driver’s NetDev_Stop() to stop &/or power down the wireless hardware.

Files

net_bsp.c

Prototype

          static void NetDev_WiFi_Stop (NET_IF  *p_if,
                                        NET_ERR *p_err);

Note: since NetDev_WiFi_Stop() 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 stop 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_Stop(), it is recommended that each device’s NetDev_WiFi_Stop() function be named using the following convention:

NetDev_WiFi_[Device]_Stop[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_Stop() function for the #2 RS9110 wireless device should be named NetDev_WiFi_RS9110_Stop2(), or NetDev_WiFI_RS9110_Stop_2() with additional underscore optional.