Basic integration code for interfacing the WiFi Host Driver (WHD) with the Board Support Packages (BSPs). More...

Macros
#define	CYBSP_RSLT_WIFI_INIT_FAILED (CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_WHD_INTEGRATION, 0))
	Initialization of the WiFi driver failed. More...

#define	CYBSP_RSLT_WIFI_SDIO_ENUM_TIMEOUT (CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_WHD_INTEGRATION, 1))
	SDIO enumeration failed. More...

Functions
cy_rslt_t	cybsp_wifi_init_primary_extended (whd_interface_t interface, whd_resource_source_t resource_if, whd_buffer_funcs_t buffer_if, whd_netif_funcs_t netif_if)
	Initializes the primary interface for the WiFi driver on the board. More...

static cy_rslt_t	cybsp_wifi_init_primary (whd_interface_t *interface)
	Initializes the primary interface for the WiFi driver on the board using the default resource, buffer, and network interfaces. More...

cy_rslt_t	cybsp_wifi_init_secondary (whd_interface_t interface, whd_mac_t mac_address)
	This function initializes and adds a secondary interface to the WiFi driver. More...

cy_rslt_t	cybsp_wifi_deinit (whd_interface_t interface)
	De-initializes all WiFi interfaces and the WiFi driver. More...

whd_driver_t	cybsp_get_wifi_driver (void)
	Gets the wifi driver instance initialized by the driver. More...

Detailed Description

Basic integration code for interfacing the WiFi Host Driver (WHD) with the Board Support Packages (BSPs).

Macro Definition Documentation

#define CYBSP_RSLT_WIFI_INIT_FAILED (CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_WHD_INTEGRATION, 0))

Initialization of the WiFi driver failed.

Definition at line 43 of file cybsp_wifi.h.

#define CYBSP_RSLT_WIFI_SDIO_ENUM_TIMEOUT (CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_BOARD_LIB_WHD_INTEGRATION, 1))

SDIO enumeration failed.

Definition at line 47 of file cybsp_wifi.h.

Function Documentation

whd_driver_t cybsp_get_wifi_driver ( void )

Gets the wifi driver instance initialized by the driver.

This should only be called after being initialized by cybsp_wifi_init_primary() and before being deinitialized by cybsp_wifi_deinit(). This is also the only time where the driver reference is valid.

Returns: Wifi driver instance pointer.

cy_rslt_t cybsp_wifi_deinit ( whd_interface_t interface )

De-initializes all WiFi interfaces and the WiFi driver.

This function does the following:
1) Deinitializes all WiFi interfaces and WiFi driver.
2) Turns off the WiFi chip.

Parameters

[in] interface Interface to be de-initialized.

Returns: CY_RSLT_SUCCESS for successful de-initialization or error if de-initialization failed.

static cy_rslt_t cybsp_wifi_init_primary ( whd_interface_t * interface )

static

Initializes the primary interface for the WiFi driver on the board using the default resource, buffer, and network interfaces.

See cybsp_wifi_init_primary_extended() for more details.

Parameters

[out] interface Interface to be initialized

Returns: CY_RSLT_SUCCESS for successful initialization or error if initialization failed.

Definition at line 84 of file cybsp_wifi.h.

cy_rslt_t cybsp_wifi_init_primary_extended	(	whd_interface_t *	interface,
		whd_resource_source_t *	resource_if,
		whd_buffer_funcs_t *	buffer_if,
		whd_netif_funcs_t *	netif_if
	)

Initializes the primary interface for the WiFi driver on the board.

This sets up the WHD interface to use the Buffer management APIs and to communicate over the SDIO interface on the board. This function does the following:
1) Initializes the WiFi driver.
2) Turns on the WiFi chip.

Note: This function cannot be called multiple times. If the interface needs to be reinitialized, cybsp_wifi_deinit must be called before calling this function again.

Parameters

[out]	interface	Interface to be initialized
[in]	resource_if	Pointer to resource interface to provide resources to the driver initialization process. Passing NULL will use the default.
[in]	buffer_if	Pointer to a buffer interface to provide buffer related services to the driver instance. Passing NULL will use the default.
[in]	netif_if	Pointer to a whd_netif_funcs_t to provide network stack services to the driver instance. Passing NULL will use the default.

Returns: CY_RSLT_SUCCESS for successful initialization or error if initialization failed.

cy_rslt_t cybsp_wifi_init_secondary	(	whd_interface_t *	interface,
		whd_mac_t *	mac_address
	)

This function initializes and adds a secondary interface to the WiFi driver.

Note: This function does not initialize the WiFi driver or turn on the WiFi chip. That is required to be done by first calling cybsp_wifi_init_primary.

Parameters

[out]	interface	Interface to be initialized
[in]	mac_address	Mac address for secondary interface

Returns: CY_RSLT_SUCCESS for successful initialization or error if initialization failed.

Macros

Functions

Detailed Description

Macro Definition Documentation

Function Documentation

Important Information for this Arm website