General_Configuration

General configuration commands. More...

Classes
struct	sl_wfx_capabilities_s
	Capabilities offered by the WLAN used in command sl_wfx_startup_ind_body_t. More...
struct	sl_wfx_otp_regul_sel_mode_info_s
	REGUL_SEL_MODE OTP field reported in command sl_wfx_startup_ind_body_t. More...
struct	sl_wfx_otp_phy_info_s
	OTP_PHY_INFO OTP field reported in command sl_wfx_startup_ind_body_t. More...
struct	sl_wfx_startup_ind_body_s
	Startup Indication message. This is the first message sent to the host to confirm boot success. It gives detailed information on the HW and FW versions and capabilities. More...
struct	sl_wfx_startup_ind_s
struct	sl_wfx_configuration_req_body_s
	Configure the device. It sends a PDS compressed file that configures the device regarding board dependent parameters. The PDS compressed file must fit in a command buffer and have less than 256 elements. More...
struct	sl_wfx_configuration_req_s
struct	sl_wfx_configuration_cnf_body_s
	Confirmation message of CONFIGURATION command sl_wfx_configuration_req_body_t. More...
struct	sl_wfx_configuration_cnf_s
struct	sl_wfx_control_gpio_req_body_s
	Send a request to read or write a GPIO identified by its label (that is defined in the PDS) More...
struct	sl_wfx_control_gpio_req_s
struct	sl_wfx_control_gpio_cnf_body_s
	Confirmation from request to read and write a GPIO. More...
struct	sl_wfx_control_gpio_cnf_s
struct	sl_wfx_rx_stats_s
	RX stats from the GENERIC indication message sl_wfx_generic_ind_body_t. More...
struct	sl_wfx_tx_pwr_loop_info_s
	TX power loop info from the GENERIC indication message sl_wfx_generic_ind_body_t. More...
union	sl_wfx_indication_data_u
struct	sl_wfx_generic_ind_body_s
	the Generic indication message. More...
struct	sl_wfx_generic_ind_s
struct	sl_wfx_exception_ind_body_s
	Exception indication message. More...
struct	sl_wfx_exception_ind_s
struct	sl_wfx_error_ind_body_s
	Error indication message. More...
struct	sl_wfx_error_ind_s

Macros
#define	SL_WFX_OPN_SIZE   14
#define	SL_WFX_UID_SIZE   8
#define	SL_WFX_DISABLED_CHANNEL_LIST_SIZE   2
#define	SL_WFX_FIRMWARE_LABEL_SIZE   128
#define	SL_WFX_EXCEPTION_DATA_SIZE_MAX   1600

Typedefs
typedef enum sl_wfx_type_e	sl_wfx_fw_type_t
typedef struct sl_wfx_capabilities_s	sl_wfx_capabilities_t
	Capabilities offered by the WLAN used in command sl_wfx_startup_ind_body_t.
typedef struct sl_wfx_otp_regul_sel_mode_info_s	sl_wfx_otp_regul_sel_mode_info_t
	REGUL_SEL_MODE OTP field reported in command sl_wfx_startup_ind_body_t.
typedef struct sl_wfx_otp_phy_info_s	sl_wfx_otp_phy_info_t
	OTP_PHY_INFO OTP field reported in command sl_wfx_startup_ind_body_t.
typedef struct sl_wfx_startup_ind_body_s	sl_wfx_startup_ind_body_t
	Startup Indication message. This is the first message sent to the host to confirm boot success. It gives detailed information on the HW and FW versions and capabilities.
typedef struct sl_wfx_startup_ind_s	sl_wfx_startup_ind_t
typedef sl_wfx_header_t	sl_wfx_wakeup_ind_t
	Wake-up indication message. More...
typedef struct sl_wfx_configuration_req_body_s	sl_wfx_configuration_req_body_t
	Configure the device. It sends a PDS compressed file that configures the device regarding board dependent parameters. The PDS compressed file must fit in a command buffer and have less than 256 elements. More...
typedef struct sl_wfx_configuration_req_s	sl_wfx_configuration_req_t
typedef struct sl_wfx_configuration_cnf_body_s	sl_wfx_configuration_cnf_body_t
	Confirmation message of CONFIGURATION command sl_wfx_configuration_req_body_t.
typedef struct sl_wfx_configuration_cnf_s	sl_wfx_configuration_cnf_t
typedef enum sl_wfx_gpio_mode_e	sl_wfx_gpio_mode_t
	Configure GPIO mode. Used in sl_wfx_control_gpio_req_body_t.
typedef struct sl_wfx_control_gpio_req_body_s	sl_wfx_control_gpio_req_body_t
	Send a request to read or write a GPIO identified by its label (that is defined in the PDS) More...
typedef struct sl_wfx_control_gpio_req_s	sl_wfx_control_gpio_req_t
typedef enum sl_wfx_gpio_error_e	sl_wfx_gpio_error_t
	detailed error cause returned by CONTROL_GPIO confirmation message sl_wfx_control_gpio_cnf_body_t
typedef struct sl_wfx_control_gpio_cnf_body_s	sl_wfx_control_gpio_cnf_body_t
	Confirmation from request to read and write a GPIO.
typedef struct sl_wfx_control_gpio_cnf_s	sl_wfx_control_gpio_cnf_t
typedef sl_wfx_header_t	sl_wfx_shut_down_req_t
	SHUT_DOWN command. A hardware reset and complete reboot is required to resume from that state. There is no confirmation to this command. It is effective when WUP register bit and WUP pin (when used) are both to 0.
typedef enum sl_wfx_generic_indication_type_e	sl_wfx_generic_indication_type_t
	specifies the type of data reported by the indication message sl_wfx_generic_ind_body_t
typedef struct sl_wfx_rx_stats_s	sl_wfx_rx_stats_t
	RX stats from the GENERIC indication message sl_wfx_generic_ind_body_t.
typedef struct sl_wfx_tx_pwr_loop_info_s	sl_wfx_tx_pwr_loop_info_t
	TX power loop info from the GENERIC indication message sl_wfx_generic_ind_body_t.
typedef union sl_wfx_indication_data_u	sl_wfx_indication_data_t
typedef struct sl_wfx_generic_ind_body_s	sl_wfx_generic_ind_body_t
	the Generic indication message. More...
typedef struct sl_wfx_generic_ind_s	sl_wfx_generic_ind_t
typedef struct sl_wfx_exception_ind_body_s	sl_wfx_exception_ind_body_t
	Exception indication message. More...
typedef struct sl_wfx_exception_ind_s	sl_wfx_exception_ind_t
typedef struct sl_wfx_error_ind_body_s	sl_wfx_error_ind_body_t
	Error indication message. More...
typedef struct sl_wfx_error_ind_s	sl_wfx_error_ind_t

Enumerations
enum	sl_wfx_type_e { SL_WFX_FW_TYPE_ETF = 0x0 , SL_WFX_FW_TYPE_WFM = 0x1 , SL_WFX_FW_TYPE_WSM = 0x2 }
enum	sl_wfx_gpio_mode_e {   SL_WFX_GPIO_MODE_D0 = 0x0 , SL_WFX_GPIO_MODE_D1 = 0x1 , SL_WFX_GPIO_MODE_OD0 = 0x2 , SL_WFX_GPIO_MODE_OD1 = 0x3 ,   SL_WFX_GPIO_MODE_TRISTATE = 0x4 , SL_WFX_GPIO_MODE_TOGGLE = 0x5 , SL_WFX_GPIO_MODE_READ = 0x6 }
	Configure GPIO mode. Used in sl_wfx_control_gpio_req_body_t. More...
enum	sl_wfx_gpio_error_e { SL_WFX_GPIO_ERROR_0 = 0x0 , SL_WFX_GPIO_ERROR_1 = 0x1 , SL_WFX_GPIO_ERROR_2 = 0x2 }
	detailed error cause returned by CONTROL_GPIO confirmation message sl_wfx_control_gpio_cnf_body_t More...
enum	sl_wfx_generic_indication_type_e { SL_WFX_GENERIC_INDICATION_TYPE_RAW = 0x0 , SL_WFX_GENERIC_INDICATION_TYPE_STRING = 0x1 , SL_WFX_GENERIC_INDICATION_TYPE_RX_STATS = 0x2 , SL_WFX_GENERIC_INDICATION_TYPE_TX_PWR_LOOP_INFO = 0x3 }
	specifies the type of data reported by the indication message sl_wfx_generic_ind_body_t More...

Detailed Description

General configuration commands.

Typedef Documentation

sl_wfx_configuration_req_body_t

typedef struct sl_wfx_configuration_req_body_s sl_wfx_configuration_req_body_t

Configure the device. It sends a PDS compressed file that configures the device regarding board dependent parameters. The PDS compressed file must fit in a command buffer and have less than 256 elements.

Todo:

Need to create a specific doc to explain PDS

sl_wfx_control_gpio_req_body_t

typedef struct sl_wfx_control_gpio_req_body_s sl_wfx_control_gpio_req_body_t

Send a request to read or write a GPIO identified by its label (that is defined in the PDS)

After a write it also read back the value to check there is no drive conflict

sl_wfx_error_ind_body_t

typedef struct sl_wfx_error_ind_body_s sl_wfx_error_ind_body_t

Error indication message.

It reports user configuration errors. A reboot is needed after this message.

sl_wfx_exception_ind_body_t

typedef struct sl_wfx_exception_ind_body_s sl_wfx_exception_ind_body_t

Exception indication message.

It reports unexpected errors. A reboot is needed after this message.

sl_wfx_generic_ind_body_t

typedef struct sl_wfx_generic_ind_body_s sl_wfx_generic_ind_body_t

the Generic indication message.

It reports different type of information that can be printed by the driver.

sl_wfx_wakeup_ind_t

typedef sl_wfx_header_t sl_wfx_wakeup_ind_t

Wake-up indication message.

Since

API1.4.0

Its body is empty. It signals that the chip is awake and ready to receive commands after a wake-up request from the host. It generates a DATA_IRQ to the host driver when ready. It can be replaced or passed by another message that would have appeared concurrently like a Rx frame.

Enumeration Type Documentation

sl_wfx_generic_indication_type_e

enum sl_wfx_generic_indication_type_e

specifies the type of data reported by the indication message sl_wfx_generic_ind_body_t

Enumerator
SL_WFX_GENERIC_INDICATION_TYPE_RAW	Byte stream type, currently not used.
SL_WFX_GENERIC_INDICATION_TYPE_STRING	NULL terminating String.
SL_WFX_GENERIC_INDICATION_TYPE_RX_STATS	Rx statistics structure.
SL_WFX_GENERIC_INDICATION_TYPE_TX_PWR_LOOP_INFO	Tx power loop info structure.

sl_wfx_gpio_error_e

enum sl_wfx_gpio_error_e

detailed error cause returned by CONTROL_GPIO confirmation message sl_wfx_control_gpio_cnf_body_t

Enumerator
SL_WFX_GPIO_ERROR_0	Undefined GPIO_ID.
SL_WFX_GPIO_ERROR_1	GPIO_ID not configured in GPIO mode (gpio_enabled =0)
SL_WFX_GPIO_ERROR_2	Toggle not possible while in tristate.

sl_wfx_gpio_mode_e

enum sl_wfx_gpio_mode_e

Configure GPIO mode. Used in sl_wfx_control_gpio_req_body_t.

Enumerator
SL_WFX_GPIO_MODE_D0	Configure the GPIO to drive 0.
SL_WFX_GPIO_MODE_D1	Configure the GPIO to drive 1.
SL_WFX_GPIO_MODE_OD0	Configure the GPIO to open drain with pull_down to 0.
SL_WFX_GPIO_MODE_OD1	Configure the GPIO to open drain with pull_up to 1.
SL_WFX_GPIO_MODE_TRISTATE	Configure the GPIO to tristate.
SL_WFX_GPIO_MODE_TOGGLE	Toggle the GPIO output value : switches between D0 and D1 or between OD0 and OD1.
SL_WFX_GPIO_MODE_READ	Read the level at the GPIO pin.

sl_wfx_type_e

enum sl_wfx_type_e

Enumerator
SL_WFX_FW_TYPE_ETF	Test Firmware.
SL_WFX_FW_TYPE_WFM	WLAN Full MAC (WFM)
SL_WFX_FW_TYPE_WSM	WLAN Split MAC (WSM)