GENERAL_API
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.
|
|
PTA | |
APIs to manage dynamic aspects of Packet Traffic Arbitration (PTA).
|
|
ERROR_IDS |
Data Structures |
|
union | sl_wfx_general_commands_ids_t |
General command message IDs.
|
|
struct | sl_wfx_set_cca_config_req_body_t |
Request sent by host to set the Clear Channel Assessment configuration Set the CCA mode and the defer threshold.
|
|
struct | sl_wfx_set_cca_config_cnf_body_t |
Confirmation sent by Wlan firmware after a
SL_WFX_SET_CCA_CONFIG_REQ_ID
request.
|
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
218
of file
sl_wfx_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. |
◆ sl_wfx_set_cca_config_req_body_t
struct sl_wfx_set_cca_config_req_body_t |
Request sent by host to set the Clear Channel Assessment configuration Set the CCA mode and the defer threshold.
Definition at line
982
of file
sl_wfx_general_api.h
.
Data Fields | ||
---|---|---|
uint8_t | cca_thr_mode | CCA threshold mode. See enum sl_wfx_cc_thr_mode_t . |
uint8_t | reserved[3] | reserved for future use, set to 0 |
◆ sl_wfx_set_cca_config_cnf_body_t
struct sl_wfx_set_cca_config_cnf_body_t |
Confirmation sent by Wlan firmware after a SL_WFX_SET_CCA_CONFIG_REQ_ID request.
Definition at line
995
of file
sl_wfx_general_api.h
.
Data Fields | ||
---|---|---|
uint32_t | status | Confirmation status, see enum sl_wfx_status_t . |
Enumeration Type Documentation
◆ sl_wfx_cc_thr_mode_t
enum sl_wfx_cc_thr_mode_t |
◆ 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_SECURELINK_MAC_KEY_CNF_ID |
SET_SECURELINK_MAC_KEY confirmation Id returns body sl_wfx_set_securelink_mac_key_cnf_body_t |
SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_CNF_ID |
SECURELINK_EXCHANGE_PUB_KEYS confirmation Id returns body sl_wfx_securelink_exchange_pub_keys_cnf_body_t |
SL_WFX_SECURELINK_CONFIGURE_CNF_ID |
SECURELINK_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 |
SL_WFX_PTA_SETTINGS_CNF_ID |
PTA_SETTINGS confirmation Id returns sl_wfx_pta_settings_cnf_body_t |
SL_WFX_PTA_PRIORITY_CNF_ID |
PTA_PRIORITY confirmation Id returns sl_wfx_pta_priority_cnf_body_t |
SL_WFX_PTA_STATE_CNF_ID |
PTA_STATE confirmation Id returns sl_wfx_pta_state_cnf_body_t |
SL_WFX_SET_CCA_CONFIG_CNF_ID |
SET_CCA_CONFIG confirmation Id returns body sl_wfx_set_cca_config_cnf_body_t |
Definition at line
185
of file
sl_wfx_general_api.h
.
◆ 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_WAKEUP_IND_ID |
WAKE UP indication Id has no content |
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 |
SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_IND_ID |
SECURELINK_EXCHANGE_PUB_KEYS indication Id content is sl_wfx_securelink_exchange_pub_keys_ind_body_t |
Definition at line
204
of file
sl_wfx_general_api.h
.
◆ 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_SECURELINK_MAC_KEY_REQ_ID |
SET_SECURELINK_MAC_KEY request Id use body sl_wfx_set_securelink_mac_key_req_body_t and returns sl_wfx_set_securelink_mac_key_cnf_body_t |
SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_REQ_ID |
SECURELINK_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 |
SECURELINK_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_PTA_SETTINGS_REQ_ID |
PTA_SETTINGS request Id use body sl_wfx_pta_settings_req_body_t and returns sl_wfx_pta_settings_cnf_body_t |
SL_WFX_PTA_PRIORITY_REQ_ID |
PTA_PRIORITY request Id use body sl_wfx_pta_priority_req_body_t and returns sl_wfx_pta_priority_cnf_body_t |
SL_WFX_PTA_STATE_REQ_ID |
PTA_STATE request Id use body sl_wfx_pta_state_req_body_t and returns sl_wfx_pta_state_cnf_body_t |
SL_WFX_SET_CCA_CONFIG_REQ_ID |
SET_CCA_CONFIG request Id uses body sl_wfx_set_cca_config_req_body_t and returns sl_wfx_set_cca_config_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
165
of file
sl_wfx_general_api.h
.
◆ sl_wfx_status_t
enum sl_wfx_status_t |
General confirmation possible values for returned 'status' field WLAN All general confirmation messages have a field 'status' just after the message header.
A value of zero indicates the request is completed successfully.
Definition at line
233
of file
sl_wfx_general_api.h
.