NetDev_WiFi_SPI_Lock

This function is called by a device driver to acquire the SPI lock and restrict the access to the SPI bus only to the wireless driver.

Files

net_bsp.c

Prototype

          static CPU_INT32U NetDev_WiFi_SPI_Lock (NET_IF  *p_if,
                                                  NET_ERR *p_err);

Note that since NetDev_WiFi_SPI_Lock() 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 lock.

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

• NetDev_WiFi_SPI_Lock must be implemented if more than one device’s hardware share the same SPI bus.
• Since each network device requires a unique NetDev_WiFi_SPI_Lock(), it is recommended that each device’s NetDev_WiFi_SPI_Lock() function be named using the following convention:

  NetDev_WiFi_[Device]SPI_Lock[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_SPI_Lock() function for the #2 RS9110 wireless device on an Atmel AT91SAM9263-EK should be named NetDev_WiFi_RS9110_SPI_Lock2(), or NetDev_WiFi_RS9110_SPI_Lock_2() with additional underscore optional.

See also section Network Board Support Package.