General API messages available in both split and full MAC.

Modules
General_Configuration
General configuration commands.

Secure_Link
APIs for Secure link configuration and usage.

Prevent_Firmware_Rollback
APIs for preventing Rollback of unsafe firmware images.

Data Structures
union	sl_wfx_general_commands_ids_t
	General command message IDs.

Enumerations
enum	sl_wfx_generic_requests_ids_t { SL_WFX_CONFIGURATION_REQ_ID = 0x09, SL_WFX_CONTROL_GPIO_REQ_ID = 0x26, SL_WFX_SET_SL_MAC_KEY_REQ_ID = 0x27, SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_REQ_ID = 0x28, SL_WFX_SECURELINK_CONFIGURE_REQ_ID = 0x29, SL_WFX_PREVENT_ROLLBACK_REQ_ID = 0x2a, SL_WFX_SHUT_DOWN_REQ_ID = 0x32 }
	General request message IDs.

enum	sl_wfx_general_confirmations_ids_t { SL_WFX_CONFIGURATION_CNF_ID = 0x09, SL_WFX_CONTROL_GPIO_CNF_ID = 0x26, SL_WFX_SET_SL_MAC_KEY_CNF_ID = 0x27, SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_CNF_ID = 0x28, SL_WFX_SECURELINK_CONFIGURE_CNF_ID = 0x29, SL_WFX_PREVENT_ROLLBACK_CNF_ID = 0xe7 }
	General confirmation message IDs.

enum	sl_wfx_general_indications_ids_t { SL_WFX_EXCEPTION_IND_ID = 0xe0, SL_WFX_STARTUP_IND_ID = 0xe1, SL_WFX_GENERIC_IND_ID = 0xe3, SL_WFX_ERROR_IND_ID = 0xe4 }
	General indications message IDs.

enum	sl_wfx_status_t { SL_WFX_STATUS_SUCCESS = 0x0, SL_WFX_STATUS_FAILURE = 0x1, SL_WFX_INVALID_PARAMETER = 0x2, SL_WFX_STATUS_GPIO_WARNING = 0x3, SL_WFX_ERROR_UNSUPPORTED_MSG_ID = 0x4, SL_MAC_KEY_STATUS_SUCCESS = 0x5A, SL_MAC_KEY_STATUS_FAILED_KEY_ALREADY_BURNED = 0x6B, SL_MAC_KEY_STATUS_FAILED_RAM_MODE_NOT_ALLOWED = 0x7C, SL_MAC_KEY_STATUS_FAILED_UNKNOWN_MODE = 0x8D, SL_PUB_KEY_EXCHANGE_STATUS_SUCCESS = 0x9E, SL_PUB_KEY_EXCHANGE_STATUS_FAILED = 0xAF, PREVENT_ROLLBACK_CNF_SUCCESS = 0x1234, PREVENT_ROLLBACK_CNF_WRONG_MAGIC_WORD = 0x1256 }
	General confirmation possible values for returned 'status' field.

Detailed Description

General API messages available in both split and full MAC.

Mainly used to boot and configure the part.
But some message are also used to report errors or information.

general requests are sl_wfx_generic_requests_ids_t
general indications are sl_wfx_general_indications_ids_t

Data Structure Documentation

◆ sl_wfx_general_commands_ids_t

union sl_wfx_general_commands_ids_t

General command message IDs.

All general API message IDs.

Definition at line 209 of file general_api.h .

Data Fields
sl_wfx_general_confirmations_ids_t	confirmation	Confirmation of a request from the wlan device to the host.
sl_wfx_general_indications_ids_t	indication	Indication from the wlan device to the host.
sl_wfx_generic_requests_ids_t	request	Request from the host to the wlan device.

Enumeration Type Documentation

◆ sl_wfx_general_confirmations_ids_t

enum sl_wfx_general_confirmations_ids_t

General confirmation message IDs.

API general confirmation message IDs returned by requests described in sl_wfx_general_requests_ids. These are messages from the WLAN towards the host.

Enumerator
SL_WFX_CONFIGURATION_CNF_ID	CONFIGURATION confirmation Id returns body sl_wfx_configuration_cnf_body_t
SL_WFX_CONTROL_GPIO_CNF_ID	CONTROL_GPIO confirmation Id returns body sl_wfx_control_gpio_cnf_body_t
SL_WFX_SET_SL_MAC_KEY_CNF_ID	SET_SL_MAC_KEY confirmation Id returns body sl_wfx_set_sl_mac_key_cnf_body_t
SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_CNF_ID	SL_EXCHANGE_PUB_KEYS confirmation Id returns body sl_wfx_securelink_exchange_pub_keys_cnf_body_t
SL_WFX_SECURELINK_CONFIGURE_CNF_ID	SL_CONFIGURE confirmation Id returns body sl_wfx_securelink_configure_cnf_body_t
SL_WFX_PREVENT_ROLLBACK_CNF_ID	PREVENT_ROLLBACK confirmation Id use body sl_wfx_prevent_rollback_cnf_body_t

Definition at line 182 of file general_api.h .

◆ sl_wfx_general_indications_ids_t

enum sl_wfx_general_indications_ids_t

General indications message IDs.

API general indication message IDs available in both split and full MAC. These are messages from the WLAN towards the host.

Enumerator
SL_WFX_EXCEPTION_IND_ID	EXCEPTION indication Id content is sl_wfx_exception_ind_body_t
SL_WFX_STARTUP_IND_ID	STARTUP indication Id content is sl_wfx_startup_ind_body_t
SL_WFX_GENERIC_IND_ID	GENERIC indication Id content is sl_wfx_generic_ind_body_t
SL_WFX_ERROR_IND_ID	ERROR indication Id content is sl_wfx_error_ind_body_t

Definition at line 197 of file general_api.h .

◆ sl_wfx_generic_requests_ids_t

enum sl_wfx_generic_requests_ids_t

General request message IDs.

API general request message IDs available in both split and full MAC. These are messages from the host towards the WLAN.

Enumerator
SL_WFX_CONFIGURATION_REQ_ID	CONFIGURATION request Id use body sl_wfx_configuration_req_body_t and returns sl_wfx_configuration_cnf_body_t
SL_WFX_CONTROL_GPIO_REQ_ID	CONTROL_GPIO request Id use body sl_wfx_control_gpio_req_body_t and returns sl_wfx_control_gpio_cnf_body_t
SL_WFX_SET_SL_MAC_KEY_REQ_ID	SET_SL_MAC_KEY request Id use body sl_wfx_set_sl_mac_key_req_body_t and returns sl_wfx_set_sl_mac_key_cnf_body_t
SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_REQ_ID	SL_EXCHANGE_PUB_KEYS request Id use body sl_wfx_securelink_exchange_pub_keys_req_body_t and returns sl_wfx_securelink_exchange_pub_keys_cnf_body_t
SL_WFX_SECURELINK_CONFIGURE_REQ_ID	SL_CONFIGURE request Id use body sl_wfx_securelink_configure_req_body_t and returns sl_wfx_securelink_exchange_pub_keys_cnf_body_t
SL_WFX_PREVENT_ROLLBACK_REQ_ID	PREVENT_ROLLBACK request Id use body sl_wfx_prevent_rollback_req_body_t and returns sl_wfx_prevent_rollback_cnf_body_t
SL_WFX_SHUT_DOWN_REQ_ID	SHUT_DOWN request Id use body sl_wfx_shut_down_req_t and never returns

Definition at line 166 of file general_api.h .

◆ sl_wfx_status_t

enum sl_wfx_status_t

General confirmation possible values for returned 'status' field.

All general confirmation messages have a field 'status' just after the message header.
A value of zero indicates the request is completed successfully.

Enumerator
SL_WFX_STATUS_SUCCESS	The firmware has successfully completed the request.
SL_WFX_STATUS_FAILURE	This is a generic failure code : other error codes do not apply.
SL_WFX_INVALID_PARAMETER	The request contains one or more invalid parameters.
SL_WFX_STATUS_GPIO_WARNING	Warning : the GPIO cmd is successful but the read value is not as expected (likely a drive conflict on the line)
SL_WFX_ERROR_UNSUPPORTED_MSG_ID	Unkown request ID or wrong interface ID used.
SL_MAC_KEY_STATUS_SUCCESS	Key has been correctly written.
SL_MAC_KEY_STATUS_FAILED_KEY_ALREADY_BURNED	Key already exists in OTP.
SL_MAC_KEY_STATUS_FAILED_RAM_MODE_NOT_ALLOWED	RAM mode is not allowed.
SL_MAC_KEY_STATUS_FAILED_UNKNOWN_MODE	Unknown mode (should be RAM or OTP)
SL_PUB_KEY_EXCHANGE_STATUS_SUCCESS	Host Public Key authenticated.
SL_PUB_KEY_EXCHANGE_STATUS_FAILED	Host Public Key authentication failed.
PREVENT_ROLLBACK_CNF_SUCCESS	OTP rollback value has been successfully updated.
PREVENT_ROLLBACK_CNF_WRONG_MAGIC_WORD	Wrong magic word detected.

Definition at line 224 of file general_api.h .

GENERAL_API

Modules

Data Structures

Enumerations