17 #ifndef _SL_WFX_GENERAL_API_H_
18 #define _SL_WFX_GENERAL_API_H_
25 #define SL_WFX_API_VERSION_MINOR 0x07
26 #define SL_WFX_API_VERSION_MAJOR 0x03
28 #define SL_WFX_SSID_SIZE 32
29 #define SL_WFX_MAC_ADDR_SIZE 6
30 #define SL_WFX_BSSID_SIZE SL_WFX_MAC_ADDR_SIZE
32 #define GENERAL_INTERFACE_ID 2
34 #define SL_WFX_MSG_ID_MASK 0x00FF
35 #define SL_WFX_MSG_TYPE_MASK 0x80
36 #define SL_WFX_MSG_SEQ_RANGE 0x0007
39 #define SL_WFX_REQ_BASE 0x00
40 #define SL_WFX_CNF_BASE 0x00
41 #define SL_WFX_IND_BASE SL_WFX_MSG_TYPE_MASK
54 typedef enum sl_wfx_rate_index_e {
55 SL_WFX_RATE_INDEX_B_1MBPS = 0,
56 SL_WFX_RATE_INDEX_B_2MBPS = 1,
57 SL_WFX_RATE_INDEX_B_5P5MBPS = 2,
58 SL_WFX_RATE_INDEX_B_11MBPS = 3,
59 SL_WFX_RATE_INDEX_PBCC_22MBPS = 4,
60 SL_WFX_RATE_INDEX_PBCC_33MBPS = 5,
61 SL_WFX_RATE_INDEX_G_6MBPS = 6,
62 SL_WFX_RATE_INDEX_G_9MBPS = 7,
63 SL_WFX_RATE_INDEX_G_12MBPS = 8,
64 SL_WFX_RATE_INDEX_G_18MBPS = 9,
65 SL_WFX_RATE_INDEX_G_24MBPS = 10,
66 SL_WFX_RATE_INDEX_G_36MBPS = 11,
67 SL_WFX_RATE_INDEX_G_48MBPS = 12,
68 SL_WFX_RATE_INDEX_G_54MBPS = 13,
69 SL_WFX_RATE_INDEX_N_6P5MBPS = 14,
70 SL_WFX_RATE_INDEX_N_13MBPS = 15,
71 SL_WFX_RATE_INDEX_N_19P5MBPS = 16,
72 SL_WFX_RATE_INDEX_N_26MBPS = 17,
73 SL_WFX_RATE_INDEX_N_39MBPS = 18,
74 SL_WFX_RATE_INDEX_N_52MBPS = 19,
75 SL_WFX_RATE_INDEX_N_58P5MBPS = 20,
76 SL_WFX_RATE_INDEX_N_65MBPS = 21,
77 SL_WFX_RATE_NUM_ENTRIES = 22
78 } sl_wfx_rate_index_t;
296 #define SL_WFX_OPN_SIZE 14
297 #define SL_WFX_UID_SIZE 8
298 #define SL_WFX_DISABLED_CHANNEL_LIST_SIZE 2
299 #define SL_WFX_FIRMWARE_LABEL_SIZE 128
308 uint8_t opn[SL_WFX_OPN_SIZE];
309 uint8_t uid[SL_WFX_UID_SIZE];
314 uint8_t mac_addr[2][SL_WFX_MAC_ADDR_SIZE];
315 uint8_t api_version_minor;
316 uint8_t api_version_major;
318 uint8_t firmware_build;
319 uint8_t firmware_minor;
320 uint8_t firmware_major;
322 uint8_t disabled_channel_list[SL_WFX_DISABLED_CHANNEL_LIST_SIZE];
326 uint8_t firmware_label[SL_WFX_FIRMWARE_LABEL_SIZE];
446 uint32_t nb_rx_by_rate[SL_WFX_RATE_NUM_ENTRIES];
447 uint16_t per[SL_WFX_RATE_NUM_ENTRIES];
448 int16_t snr[SL_WFX_RATE_NUM_ENTRIES];
449 int16_t rssi[SL_WFX_RATE_NUM_ENTRIES];
450 int16_t cfo[SL_WFX_RATE_NUM_ENTRIES];
473 uint8_t raw_data[376];
491 #define SL_WFX_EXCEPTION_DATA_SIZE_MAX 1600
559 #define SL_WFX_KEY_VALUE_SIZE 32
571 uint8_t key_value[SL_WFX_KEY_VALUE_SIZE];
591 #define SL_WFX_HOST_PUB_KEY_SIZE 32
592 #define SL_WFX_HOST_PUB_KEY_MAC_SIZE 64
612 uint8_t host_pub_key[SL_WFX_HOST_PUB_KEY_SIZE];
613 uint8_t host_pub_key_mac[SL_WFX_HOST_PUB_KEY_MAC_SIZE];
633 #define SL_WFX_NCP_PUB_KEY_SIZE 32
634 #define SL_WFX_NCP_PUB_KEY_MAC_SIZE 64
640 uint8_t ncp_pub_key[SL_WFX_NCP_PUB_KEY_SIZE];
641 uint8_t ncp_pub_key_mac[SL_WFX_NCP_PUB_KEY_MAC_SIZE];
649 #define SL_WFX_SESSION_KEY_PROTECTION_DISABLE_MAGIC 0xfa21e603
651 #define SL_WFX_ENCR_BMP_SIZE 32
674 uint8_t encr_bmp[SL_WFX_ENCR_BMP_SIZE];
692 uint8_t encr_bmp[SL_WFX_ENCR_BMP_SIZE];
1002 uint8_t reserved[3];
enum sl_wfx_cc_thr_mode_e sl_wfx_cc_thr_mode_t
CCA Mode definition.
sl_wfx_status_e
General confirmation possible values for returned 'status' field WLAN All general confirmation messag...
Definition: sl_wfx_general_api.h:233
sl_wfx_general_confirmations_ids_e
General confirmation message IDs.
Definition: sl_wfx_general_api.h:185
struct sl_wfx_set_cca_config_req_body_s 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...
enum sl_wfx_status_e sl_wfx_status_t
General confirmation possible values for returned 'status' field WLAN All general confirmation messag...
struct sl_wfx_set_cca_config_cnf_body_s sl_wfx_set_cca_config_cnf_body_t
Confirmation sent by Wlan firmware after a SL_WFX_SET_CCA_CONFIG_REQ_ID request.
sl_wfx_general_indications_ids_e
General indications message IDs.
Definition: sl_wfx_general_api.h:204
union sl_wfx_general_commands_ids_u sl_wfx_general_commands_ids_t
General command message IDs.
sl_wfx_generic_requests_ids_e
General request message IDs.
Definition: sl_wfx_general_api.h:165
enum sl_wfx_general_indications_ids_e sl_wfx_general_indications_ids_t
General indications message IDs.
enum sl_wfx_generic_requests_ids_e sl_wfx_generic_requests_ids_t
General request message IDs.
sl_wfx_cc_thr_mode_e
CCA Mode definition.
Definition: sl_wfx_general_api.h:991
enum sl_wfx_general_confirmations_ids_e sl_wfx_general_confirmations_ids_t
General confirmation message IDs.
@ SL_WFX_PREVENT_ROLLBACK_CNF_SUCCESS
OTP rollback value has been successfully updated.
Definition: sl_wfx_general_api.h:247
@ SL_WFX_MAC_KEY_STATUS_FAILED_RAM_MODE_NOT_ALLOWED
RAM mode is not allowed.
Definition: sl_wfx_general_api.h:242
@ SL_WFX_INVALID_PARAMETER
The request contains one or more invalid parameters.
Definition: sl_wfx_general_api.h:236
@ SL_WFX_PREVENT_ROLLBACK_CNF_WRONG_MAGIC_WORD
Wrong magic word detected.
Definition: sl_wfx_general_api.h:248
@ SL_WFX_PUB_KEY_EXCHANGE_STATUS_SUCCESS
Host Public Key authenticated.
Definition: sl_wfx_general_api.h:244
@ SL_WFX_MAC_KEY_STATUS_FAILED_UNKNOWN_MODE
Unknown mode (should be RAM or OTP)
Definition: sl_wfx_general_api.h:243
@ SL_WFX_STATUS_SUCCESS
The firmware has successfully completed the request.
Definition: sl_wfx_general_api.h:234
@ SL_WFX_MAC_KEY_STATUS_FAILED_KEY_ALREADY_BURNED
Key already exists in OTP.
Definition: sl_wfx_general_api.h:241
@ SL_WFX_STATUS_FAILURE
This is a generic failure code : other error codes do not apply.
Definition: sl_wfx_general_api.h:235
@ SL_WFX_ERROR_UNSUPPORTED_MSG_ID
Unknown request ID or wrong interface ID used.
Definition: sl_wfx_general_api.h:238
@ SL_WFX_PUB_KEY_EXCHANGE_STATUS_FAILED
Host Public Key authentication failed.
Definition: sl_wfx_general_api.h:245
@ SL_WFX_STATUS_GPIO_WARNING
Warning : the GPIO CMD is successful but the read value is not as expected (likely a drive conflict o...
Definition: sl_wfx_general_api.h:237
@ SL_WFX_MAC_KEY_STATUS_SUCCESS
Key has been correctly written.
Definition: sl_wfx_general_api.h:240
@ SL_WFX_PREVENT_ROLLBACK_CNF_ID
PREVENT_ROLLBACK confirmation Id use body sl_wfx_prevent_rollback_cnf_body_t
Definition: sl_wfx_general_api.h:191
@ SL_WFX_PTA_STATE_CNF_ID
PTA_STATE confirmation Id returns sl_wfx_pta_state_cnf_body_t
Definition: sl_wfx_general_api.h:194
@ SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_CNF_ID
SECURELINK_EXCHANGE_PUB_KEYS confirmation Id returns body sl_wfx_securelink_exchange_pub_keys_cnf_bod...
Definition: sl_wfx_general_api.h:189
@ SL_WFX_SECURELINK_CONFIGURE_CNF_ID
SECURELINK_CONFIGURE confirmation Id returns body sl_wfx_securelink_configure_cnf_body_t
Definition: sl_wfx_general_api.h:190
@ SL_WFX_PTA_PRIORITY_CNF_ID
PTA_PRIORITY confirmation Id returns sl_wfx_pta_priority_cnf_body_t
Definition: sl_wfx_general_api.h:193
@ SL_WFX_PTA_SETTINGS_CNF_ID
PTA_SETTINGS confirmation Id returns sl_wfx_pta_settings_cnf_body_t
Definition: sl_wfx_general_api.h:192
@ SL_WFX_CONTROL_GPIO_CNF_ID
CONTROL_GPIO confirmation Id returns body sl_wfx_control_gpio_cnf_body_t
Definition: sl_wfx_general_api.h:187
@ SL_WFX_CONFIGURATION_CNF_ID
CONFIGURATION confirmation Id returns body sl_wfx_configuration_cnf_body_t
Definition: sl_wfx_general_api.h:186
@ SL_WFX_SET_CCA_CONFIG_CNF_ID
SET_CCA_CONFIG confirmation Id returns body sl_wfx_set_cca_config_cnf_body_t
Definition: sl_wfx_general_api.h:195
@ 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
Definition: sl_wfx_general_api.h:188
@ SL_WFX_GENERIC_IND_ID
GENERIC indication Id content is sl_wfx_generic_ind_body_t
Definition: sl_wfx_general_api.h:208
@ SL_WFX_STARTUP_IND_ID
STARTUP indication Id content is sl_wfx_startup_ind_body_t
Definition: sl_wfx_general_api.h:206
@ 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: sl_wfx_general_api.h:210
@ SL_WFX_ERROR_IND_ID
ERROR indication Id content is sl_wfx_error_ind_body_t
Definition: sl_wfx_general_api.h:209
@ SL_WFX_WAKEUP_IND_ID
WAKE UP indication Id has no content
Definition: sl_wfx_general_api.h:207
@ SL_WFX_EXCEPTION_IND_ID
EXCEPTION indication Id content is sl_wfx_exception_ind_body_t
Definition: sl_wfx_general_api.h:205
@ 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 r...
Definition: sl_wfx_general_api.h:169
@ 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_b...
Definition: sl_wfx_general_api.h:172
@ 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
Definition: sl_wfx_general_api.h:174
@ SL_WFX_CONFIGURATION_REQ_ID
CONFIGURATION request Id use body sl_wfx_configuration_req_body_t and returns sl_wfx_configuration_cn...
Definition: sl_wfx_general_api.h:166
@ 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_wf...
Definition: sl_wfx_general_api.h:168
@ SL_WFX_SHUT_DOWN_REQ_ID
SHUT_DOWN request Id use body sl_wfx_shut_down_req_t and never returns
Definition: sl_wfx_general_api.h:176
@ 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_confi...
Definition: sl_wfx_general_api.h:175
@ 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_b...
Definition: sl_wfx_general_api.h:173
@ SL_WFX_PREVENT_ROLLBACK_REQ_ID
PREVENT_ROLLBACK request Id use body sl_wfx_prevent_rollback_req_body_t and returns sl_wfx_prevent_ro...
Definition: sl_wfx_general_api.h:171
@ 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_b...
Definition: sl_wfx_general_api.h:167
@ SL_WFX_SECURELINK_CONFIGURE_REQ_ID
SECURELINK_CONFIGURE request Id use body sl_wfx_securelink_configure_req_body_t and returns sl_wfx_se...
Definition: sl_wfx_general_api.h:170
@ SL_WFX_CCA_THR_MODE_RELATIVE
Use CCA defer threshold relative to channel noise.
Definition: sl_wfx_general_api.h:992
@ SL_WFX_CCA_THR_MODE_ABSOLUTE
Use absolute CCA defer threshold.
Definition: sl_wfx_general_api.h:993
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.
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....
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
struct sl_wfx_error_ind_body_s sl_wfx_error_ind_body_t
Error indication message.
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.
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 depen...
sl_wfx_header_t sl_wfx_wakeup_ind_t
Wake-up indication message.
Definition: sl_wfx_general_api.h:343
sl_wfx_gpio_error_e
detailed error cause returned by CONTROL_GPIO confirmation message sl_wfx_control_gpio_cnf_body_t
Definition: sl_wfx_general_api.h:402
sl_wfx_generic_indication_type_e
specifies the type of data reported by the indication message sl_wfx_generic_ind_body_t
Definition: sl_wfx_general_api.h:431
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....
Definition: sl_wfx_general_api.h:425
struct sl_wfx_configuration_cnf_body_s sl_wfx_configuration_cnf_body_t
Confirmation message of CONFIGURATION command sl_wfx_configuration_req_body_t.
struct sl_wfx_generic_ind_body_s sl_wfx_generic_ind_body_t
the Generic indication message.
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)
struct sl_wfx_exception_ind_body_s sl_wfx_exception_ind_body_t
Exception indication message.
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
sl_wfx_type_e
Definition: sl_wfx_general_api.h:260
struct sl_wfx_capabilities_s sl_wfx_capabilities_t
Capabilities offered by the WLAN used in command sl_wfx_startup_ind_body_t.
sl_wfx_gpio_mode_e
Configure GPIO mode. Used in sl_wfx_control_gpio_req_body_t.
Definition: sl_wfx_general_api.h:375
struct sl_wfx_rx_stats_s sl_wfx_rx_stats_t
RX stats from the GENERIC indication message sl_wfx_generic_ind_body_t.
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.
struct sl_wfx_control_gpio_cnf_body_s sl_wfx_control_gpio_cnf_body_t
Confirmation from request to read and write a GPIO.
enum sl_wfx_gpio_mode_e sl_wfx_gpio_mode_t
Configure GPIO mode. Used in sl_wfx_control_gpio_req_body_t.
@ SL_WFX_GPIO_ERROR_1
GPIO_ID not configured in GPIO mode (gpio_enabled =0)
Definition: sl_wfx_general_api.h:404
@ SL_WFX_GPIO_ERROR_2
Toggle not possible while in tristate.
Definition: sl_wfx_general_api.h:405
@ SL_WFX_GPIO_ERROR_0
Undefined GPIO_ID.
Definition: sl_wfx_general_api.h:403
@ SL_WFX_GENERIC_INDICATION_TYPE_RX_STATS
Rx statistics structure.
Definition: sl_wfx_general_api.h:434
@ SL_WFX_GENERIC_INDICATION_TYPE_RAW
Byte stream type, currently not used.
Definition: sl_wfx_general_api.h:432
@ SL_WFX_GENERIC_INDICATION_TYPE_STRING
NULL terminating String.
Definition: sl_wfx_general_api.h:433
@ SL_WFX_GENERIC_INDICATION_TYPE_TX_PWR_LOOP_INFO
Tx power loop info structure.
Definition: sl_wfx_general_api.h:435
@ SL_WFX_FW_TYPE_WFM
WLAN Full MAC (WFM)
Definition: sl_wfx_general_api.h:262
@ SL_WFX_FW_TYPE_WSM
WLAN Split MAC (WSM)
Definition: sl_wfx_general_api.h:263
@ SL_WFX_FW_TYPE_ETF
Test Firmware.
Definition: sl_wfx_general_api.h:261
@ SL_WFX_GPIO_MODE_OD1
Configure the GPIO to open drain with pull_up to 1.
Definition: sl_wfx_general_api.h:379
@ SL_WFX_GPIO_MODE_D0
Configure the GPIO to drive 0.
Definition: sl_wfx_general_api.h:376
@ SL_WFX_GPIO_MODE_TRISTATE
Configure the GPIO to tristate.
Definition: sl_wfx_general_api.h:380
@ SL_WFX_GPIO_MODE_D1
Configure the GPIO to drive 1.
Definition: sl_wfx_general_api.h:377
@ SL_WFX_GPIO_MODE_OD0
Configure the GPIO to open drain with pull_down to 0.
Definition: sl_wfx_general_api.h:378
@ SL_WFX_GPIO_MODE_TOGGLE
Toggle the GPIO output value : switches between D0 and D1 or between OD0 and OD1.
Definition: sl_wfx_general_api.h:381
@ SL_WFX_GPIO_MODE_READ
Read the level at the GPIO pin.
Definition: sl_wfx_general_api.h:382
struct sl_wfx_generic_message_s sl_wfx_generic_message_t
Generic message structure for all requests, confirmations and indications.
struct sl_wfx_header_s sl_wfx_header_t
General Message header structure.
struct sl_wfx_generic_confirmation_s sl_wfx_generic_confirmation_t
Generic confirmation message with the body reduced to the status field.
enum sl_wfx_pta_mode_e sl_wfx_pta_mode_t
PTA modes.
enum sl_wfx_grant_state_e sl_wfx_grant_state_t
Grant states.
struct sl_wfx_pta_priority_cnf_body_s sl_wfx_pta_priority_cnf_body_t
Confirmation sent by WLAN firmware after a SL_WFX_PTA_PRIORITY_REQ_ID request.
enum sl_wfx_pta_priority_e sl_wfx_pta_priority_t
Priority levels used by PTA for concurrent (Coex and WLAN) request arbitration.
struct sl_wfx_pta_settings_cnf_body_s sl_wfx_pta_settings_cnf_body_t
Confirmation sent by WLAN firmware after a SL_WFX_PTA_SETTINGS_REQ_ID request.
sl_wfx_signal_level_e
Signal levels.
Definition: sl_wfx_general_api.h:805
enum sl_wfx_signal_level_e sl_wfx_signal_level_t
Signal levels.
sl_wfx_pta_priority_e
Priority levels used by PTA for concurrent (Coex and WLAN) request arbitration.
Definition: sl_wfx_general_api.h:898
sl_wfx_grant_state_e
Grant states.
Definition: sl_wfx_general_api.h:821
enum sl_wfx_coex_type_e sl_wfx_coex_type_t
Coexistence types supported by PTA.
sl_wfx_coex_type_e
Coexistence types supported by PTA.
Definition: sl_wfx_general_api.h:813
struct sl_wfx_pta_state_cnf_body_s sl_wfx_pta_state_cnf_body_t
Confirmation sent by WLAN firmware after a SL_WFX_PTA_STATE_REQ_ID request.
sl_wfx_pta_mode_e
PTA modes.
Definition: sl_wfx_general_api.h:794
sl_wfx_pta_state_e
PTA states.
Definition: sl_wfx_general_api.h:953
enum sl_wfx_pta_state_e sl_wfx_pta_state_t
PTA states.
struct sl_wfx_pta_settings_req_body_s sl_wfx_pta_settings_req_body_t
Request sent by the host to set the PTA mode, the active levels on signals, the Coex type,...
struct sl_wfx_pta_priority_req_body_s sl_wfx_pta_priority_req_body_t
Request sent by the host to define the level of priority used to arbitrate concurrent Coex and WLAN r...
struct sl_wfx_pta_state_req_body_s sl_wfx_pta_state_req_body_t
Request sent by host to start or stop the PTA.
@ SL_WFX_SIGNAL_HIGH
Signal level is high.
Definition: sl_wfx_general_api.h:807
@ SL_WFX_SIGNAL_LOW
Signal level is low.
Definition: sl_wfx_general_api.h:806
@ SL_WFX_PTA_PRIORITY_COEX_MAXIMIZED
Maximizes priority to COEX.
Definition: sl_wfx_general_api.h:899
@ SL_WFX_PTA_PRIORITY_WLAN_MAXIMIZED
Maximizes priority to WLAN.
Definition: sl_wfx_general_api.h:903
@ SL_WFX_PTA_PRIORITY_BALANCED
Balanced PTA arbitration.
Definition: sl_wfx_general_api.h:901
@ SL_WFX_PTA_PRIORITY_WLAN_HIGH
High priority to WLAN, protects WLAN transmissions.
Definition: sl_wfx_general_api.h:902
@ SL_WFX_PTA_PRIORITY_COEX_HIGH
High priority to COEX, targets low-latency to COEX.
Definition: sl_wfx_general_api.h:900
@ SL_WFX_NO_GRANT
WLAN has the RF, Coex is not allowed to transmit.
Definition: sl_wfx_general_api.h:822
@ SL_WFX_GRANT
Coex is granted.
Definition: sl_wfx_general_api.h:823
@ SL_WFX_COEX_TYPE_BLE
Bluetooth Low-Energy Stack.
Definition: sl_wfx_general_api.h:815
@ SL_WFX_COEX_TYPE_GENERIC
IEEE 802.15.4 standards ZigBee SDK, Thread SDK, and so on.
Definition: sl_wfx_general_api.h:814
@ SL_WFX_PTA_1W_COEX_MASTER
PTA 1-wire interface with COEX master on PTA_RF_ACT pin (REQUEST signal),.
Definition: sl_wfx_general_api.h:796
@ SL_WFX_PTA_1W_WLAN_MASTER
PTA 1-wire interface with WLAN master on PTA_TX_CONF pin (GRANT signal),.
Definition: sl_wfx_general_api.h:795
@ SL_WFX_PTA_3W
PTA 3-wire interface on same pins as SL_WFX_PTA_2W, plus PTA_STATUS pin (PRIORITY signal)
Definition: sl_wfx_general_api.h:798
@ SL_WFX_PTA_4W
PTA 4-wire interface on same pins as SL_WFX_PTA_3W, plus PTA_FREQ pin (FREQ signal).
Definition: sl_wfx_general_api.h:799
@ SL_WFX_PTA_2W
PTA 2-wire interface on PTA_RF_ACT and PTA_TX_CONF pins (respectively REQUEST and GRANT signals),...
Definition: sl_wfx_general_api.h:797
@ SL_WFX_PTA_ON
PTA is on.
Definition: sl_wfx_general_api.h:955
@ SL_WFX_PTA_OFF
PTA is off.
Definition: sl_wfx_general_api.h:954
struct sl_wfx_prevent_rollback_cnf_body_s sl_wfx_prevent_rollback_cnf_body_t
Confirmation of the Prevent Rollback request.
struct sl_wfx_prevent_rollback_req_body_s sl_wfx_prevent_rollback_req_body_t
Prevent Rollback request.
struct sl_wfx_securelink_exchange_pub_keys_ind_body_s sl_wfx_securelink_exchange_pub_keys_ind_body_t
Indication for exchange of Secure Link Public Keys.
sl_wfx_securelink_mac_key_dest_e
destination of the Secure Link MAC key, used by request message sl_wfx_set_securelink_mac_key_req_bod...
Definition: sl_wfx_general_api.h:554
enum sl_wfx_secure_link_session_key_alg_e sl_wfx_secure_link_session_key_alg_t
Session Key computation algorithms.
struct sl_wfx_set_securemink_mac_key_req_body_s sl_wfx_set_securelink_mac_key_req_body_t
Set the Secure Link MAC key.
enum sl_wfx_securelink_mac_key_dest_e sl_wfx_securelink_mac_key_dest_t
destination of the Secure Link MAC key, used by request message sl_wfx_set_securelink_mac_key_req_bod...
sl_wfx_secure_link_state_e
*Secure Link' device state
Definition: sl_wfx_general_api.h:544
enum sl_wfx_secure_link_state_e sl_wfx_secure_link_state_t
*Secure Link' device state
struct sl_wfx_securelink_exchange_pub_keys_cnf_body_s sl_wfx_securelink_exchange_pub_keys_cnf_body_t
Confirmation for exchange of Secure Link Public Keys.
struct sl_wfx_securelink_configure_req_body_s sl_wfx_securelink_configure_req_body_t
Configure Secure Link Layer.
struct sl_wfx_securelink_configure_cnf_body_s sl_wfx_securelink_configure_cnf_body_t
Confirmation of Secure Link Layer configuration sl_wfx_securelink_configure_req_body_t.
struct sl_wfx_securelink_exchange_pub_keys_req_body_s sl_wfx_securelink_exchange_pub_keys_req_body_t
Exchange Secure Link Public Keys.
sl_wfx_secure_link_session_key_alg_e
Session Key computation algorithms.
Definition: sl_wfx_general_api.h:598
struct sl_wfx_set_securelink_mac_key_cnf_body_s sl_wfx_set_securelink_mac_key_cnf_body_t
Confirmation for the Secure Link MAC key setting.
@ SECURE_LINK_MAC_KEY_DEST_OTP
Key will be stored in OTP.
Definition: sl_wfx_general_api.h:555
@ SECURE_LINK_MAC_KEY_DEST_RAM
Key will be stored in RAM.
Definition: sl_wfx_general_api.h:556
@ SECURE_LINK_TRUSTED_ACTIVE_ENFORCED
Trusted (Enforced) mode.
Definition: sl_wfx_general_api.h:548
@ SECURE_LINK_NA_MODE
Reserved.
Definition: sl_wfx_general_api.h:545
@ SECURE_LINK_TRUSTED_MODE
Trusted (Evaluation) mode.
Definition: sl_wfx_general_api.h:547
@ SECURE_LINK_UNTRUSTED_MODE
Untrusted mode - SecureLink not available.
Definition: sl_wfx_general_api.h:546
@ SECURE_LINK_KDF
Session key is computed using KDF algorithm (not available yet)
Definition: sl_wfx_general_api.h:600
@ SECURE_LINK_CURVE25519
Session key is computed using curve25519 algorithm.
Definition: sl_wfx_general_api.h:599
This file contains the error ids for WLAN general API.
Capabilities offered by the WLAN used in command sl_wfx_startup_ind_body_t.
Definition: sl_wfx_general_api.h:269
uint8_t reserved4
Bit 24-31 : Reserved.
Definition: sl_wfx_general_api.h:274
uint8_t linkmode
Bit 0-1 : OTP SecureLink mode. 0=reserved, 1=untrusted (no secure link supported),...
Definition: sl_wfx_general_api.h:270
uint8_t reserved2
Bit 8-15 : Reserved.
Definition: sl_wfx_general_api.h:272
uint8_t reserved1
Bit 2-7 : Reserved.
Definition: sl_wfx_general_api.h:271
uint8_t reserved3
Bit 16-23 : Reserved.
Definition: sl_wfx_general_api.h:273
Confirmation message of CONFIGURATION command sl_wfx_configuration_req_body_t.
Definition: sl_wfx_general_api.h:363
uint32_t status
Configuration status. A value of zero indicates the boot is completed successfully (see enum sl_wfx_s...
Definition: sl_wfx_general_api.h:364
Definition: sl_wfx_general_api.h:367
Configure the device. It sends a PDS compressed file that configures the device regarding board depen...
Definition: sl_wfx_general_api.h:351
uint16_t length
pds_data length in bytes
Definition: sl_wfx_general_api.h:352
Definition: sl_wfx_general_api.h:356
Confirmation from request to read and write a GPIO.
Definition: sl_wfx_general_api.h:410
uint32_t value
the error detail (see enum sl_wfx_gpio_error_t) when sl_wfx_control_gpio_cnf_body_t::status reports a...
Definition: sl_wfx_general_api.h:412
uint32_t status
enum sl_wfx_status_t : a value of zero indicates the request is completed successfully.
Definition: sl_wfx_general_api.h:411
Definition: sl_wfx_general_api.h:415
Send a request to read or write a GPIO identified by its label (that is defined in the PDS)
Definition: sl_wfx_general_api.h:389
uint8_t gpio_label
Identify the GPIO by its label (defined in the PDS)
Definition: sl_wfx_general_api.h:390
uint8_t gpio_mode
define how to set or read the GPIO (see enum sl_wfx_gpio_mode_t)
Definition: sl_wfx_general_api.h:391
Definition: sl_wfx_general_api.h:394
Error indication message.
Definition: sl_wfx_general_api.h:513
uint32_t type
error type, see enum sl_wfx_error_t
Definition: sl_wfx_general_api.h:514
Definition: sl_wfx_general_api.h:518
Exception indication message.
Definition: sl_wfx_general_api.h:497
uint32_t reason
Reason of the exception.
Definition: sl_wfx_general_api.h:498
Definition: sl_wfx_general_api.h:502
Generic confirmation message with the body reduced to the status field.
Definition: sl_wfx_general_api.h:137
uint32_t status
See enum sl_wfx_status_t.
Definition: sl_wfx_general_api.h:139
sl_wfx_header_t header
4 bytes header
Definition: sl_wfx_general_api.h:138
the Generic indication message.
Definition: sl_wfx_general_api.h:481
uint32_t indication_type
Identify the indication data (see enum type sl_wfx_generic_indication_type_t)
Definition: sl_wfx_general_api.h:482
sl_wfx_indication_data_t indication_data
Indication data.
Definition: sl_wfx_general_api.h:483
Definition: sl_wfx_general_api.h:486
Generic message structure for all requests, confirmations and indications.
Definition: sl_wfx_general_api.h:124
sl_wfx_header_t header
4 bytes header
Definition: sl_wfx_general_api.h:125
OTP_PHY_INFO OTP field reported in command sl_wfx_startup_ind_body_t.
Definition: sl_wfx_general_api.h:290
uint8_t phy0_region
Bit 3-5 : DFS region corresponding to backoff vs. channel group table indexed 0.
Definition: sl_wfx_general_api.h:292
uint8_t phy1_region
Bit 0-2 : DFS region corresponding to backoff vs. channel group table indexed 1.
Definition: sl_wfx_general_api.h:291
uint8_t otp_phy_ver
Bit 6-7 : Revision of OTP info.
Definition: sl_wfx_general_api.h:293
REGUL_SEL_MODE OTP field reported in command sl_wfx_startup_ind_body_t.
Definition: sl_wfx_general_api.h:280
uint8_t reserved
Bit 4-7 : Reserved.
Definition: sl_wfx_general_api.h:284
uint8_t region_sel_mode
Definition: sl_wfx_general_api.h:281
Confirmation of the Prevent Rollback request.
Definition: sl_wfx_general_api.h:762
uint32_t status
Confirmation status, see enum sl_wfx_status_t.
Definition: sl_wfx_general_api.h:763
Definition: sl_wfx_general_api.h:766
Prevent Rollback request.
Definition: sl_wfx_general_api.h:746
uint32_t magic_word
Magic Word - should be 0x5C8912F3.
Definition: sl_wfx_general_api.h:747
Definition: sl_wfx_general_api.h:750
Confirmation sent by WLAN firmware after a SL_WFX_PTA_PRIORITY_REQ_ID request.
Definition: sl_wfx_general_api.h:941
uint32_t status
Confirmation status, see enum sl_wfx_status_t.
Definition: sl_wfx_general_api.h:942
Definition: sl_wfx_general_api.h:945
Request sent by the host to define the level of priority used to arbitrate concurrent Coex and WLAN r...
Definition: sl_wfx_general_api.h:929
uint32_t priority
The priority level, see enum sl_wfx_pta_priority_t.
Definition: sl_wfx_general_api.h:930
Definition: sl_wfx_general_api.h:933
Confirmation sent by WLAN firmware after a SL_WFX_PTA_SETTINGS_REQ_ID request.
Definition: sl_wfx_general_api.h:886
uint32_t status
Confirmation status, see enum sl_wfx_status_t.
Definition: sl_wfx_general_api.h:887
Definition: sl_wfx_general_api.h:890
Request sent by the host to set the PTA mode, the active levels on signals, the Coex type,...
Definition: sl_wfx_general_api.h:858
uint16_t periodic_tx_rx_sampling_time
The period (in microseconds) from first_slot_time of following samplings of the directionality on PRI...
Definition: sl_wfx_general_api.h:873
uint8_t default_grant_state
The state of the GRANT signal before arbitration at grant_valid_time, see enum sl_wfx_grant_state_t.
Definition: sl_wfx_general_api.h:865
uint16_t wlan_quota
The duration (in microseconds) for which RF is granted to WLAN before it is moved to Coex.
Definition: sl_wfx_general_api.h:875
uint8_t grant_valid_time
The time (in microseconds) from Coex request to the GRANT signal assertion (MAX(tx_rx_sampling_time,...
Definition: sl_wfx_general_api.h:870
uint8_t coex_type
The Coex type, see enum sl_wfx_coex_type_t.
Definition: sl_wfx_general_api.h:864
uint8_t simultaneous_rx_access
Boolean to allow both Coex and WLAN to receive concurrently, also named combined mode.
Definition: sl_wfx_general_api.h:866
uint8_t priority_signal_active_level
Active level on PRIORITY signal (PTA_STATUS pin), provided by Coex to set the priority of the request...
Definition: sl_wfx_general_api.h:861
uint8_t pta_mode
The PTA mode, see enum sl_wfx_pta_mode_t.
Definition: sl_wfx_general_api.h:859
uint8_t request_signal_active_level
Active level on REQUEST signal (PTA_RF_ACT pin), provided by Coex to request the RF,...
Definition: sl_wfx_general_api.h:860
uint8_t freq_sampling_time
The time (in microseconds) from the Coex request to the sampling of freq-match information on FREQ si...
Definition: sl_wfx_general_api.h:869
uint8_t priority_sampling_time
The time (in microseconds) from the Coex request to the sampling of the priority on PRIORITY signal (...
Definition: sl_wfx_general_api.h:867
uint8_t fem_control_time
The time (in microseconds) from Coex request to the control of FEM (grant_valid_time to 255)
Definition: sl_wfx_general_api.h:871
uint8_t first_slot_time
The time (in microseconds) from the Coex request to the beginning of reception or transmission (grant...
Definition: sl_wfx_general_api.h:872
uint8_t grant_signal_active_level
Active level on GRANT signal (PTA_TX_CONF pin), generated by PTA to grant the RF to Coex,...
Definition: sl_wfx_general_api.h:863
uint8_t freq_signal_active_level
Active level on FREQ signal (PTA_FREQ pin), provided by Coex in 4-wire mode when Coex and WLAN share ...
Definition: sl_wfx_general_api.h:862
uint8_t tx_rx_sampling_time
The time (in microseconds) from the Coex request to the sampling of the directionality on PRIORITY si...
Definition: sl_wfx_general_api.h:868
uint16_t coex_quota
The duration (in microseconds) for which RF is granted to Coex before it is moved to WLAN.
Definition: sl_wfx_general_api.h:874
Definition: sl_wfx_general_api.h:878
Confirmation sent by WLAN firmware after a SL_WFX_PTA_STATE_REQ_ID request.
Definition: sl_wfx_general_api.h:974
uint32_t status
Confirmation status, see enum sl_wfx_status_t.
Definition: sl_wfx_general_api.h:975
Definition: sl_wfx_general_api.h:978
Request sent by host to start or stop the PTA.
Definition: sl_wfx_general_api.h:962
uint32_t pta_state
Requested PTA state, see enum sl_wfx_pta_state_t.
Definition: sl_wfx_general_api.h:963
Definition: sl_wfx_general_api.h:966
RX stats from the GENERIC indication message sl_wfx_generic_ind_body_t.
Definition: sl_wfx_general_api.h:441
uint32_t per_total
PER on the total number of frame.
Definition: sl_wfx_general_api.h:444
uint32_t nb_crc_frame
Number of frame received with bad CRC.
Definition: sl_wfx_general_api.h:443
uint32_t pwr_clk_freq
Frequency of the low power clock in Hz.
Definition: sl_wfx_general_api.h:452
uint8_t is_ext_pwr_clk
Indicate if the low power clock is external.
Definition: sl_wfx_general_api.h:453
uint32_t throughput
Throughput calculated on correct frames received.
Definition: sl_wfx_general_api.h:445
int8_t current_temp
Current die temperature in Celsius.
Definition: sl_wfx_general_api.h:454
uint32_t nb_rx_frame
Total number of frame received.
Definition: sl_wfx_general_api.h:442
uint32_t date
This message transmission date in firmware timebase (microsecond)
Definition: sl_wfx_general_api.h:451
Confirmation of Secure Link Layer configuration sl_wfx_securelink_configure_req_body_t.
Definition: sl_wfx_general_api.h:690
uint32_t status
Request status (see enum sl_wfx_status_t)
Definition: sl_wfx_general_api.h:691
Configure Secure Link Layer.
Definition: sl_wfx_general_api.h:673
uint32_t disable_session_key_protection
Force the firmware to authorize the use of the same session key during a complete power cycle,...
Definition: sl_wfx_general_api.h:675
Confirmation for exchange of Secure Link Public Keys.
Definition: sl_wfx_general_api.h:624
uint32_t status
Request status (see enum sl_wfx_status_t)
Definition: sl_wfx_general_api.h:625
Definition: sl_wfx_general_api.h:628
Indication for exchange of Secure Link Public Keys.
Definition: sl_wfx_general_api.h:638
uint32_t status
Request status (see enum sl_wfx_status_t)
Definition: sl_wfx_general_api.h:639
Definition: sl_wfx_general_api.h:644
Exchange Secure Link Public Keys.
Definition: sl_wfx_general_api.h:610
uint32_t algorithm
Choice of the cryptographic algorithm used in the session key computation (see enum sl_wfx_secure_lin...
Definition: sl_wfx_general_api.h:611
Definition: sl_wfx_general_api.h:616
Confirmation sent by Wlan firmware after a SL_WFX_SET_CCA_CONFIG_REQ_ID request.
Definition: sl_wfx_general_api.h:1013
uint32_t status
Confirmation status, see enum sl_wfx_status_t.
Definition: sl_wfx_general_api.h:1014
Request sent by host to set the Clear Channel Assessment configuration Set the CCA mode and the defer...
Definition: sl_wfx_general_api.h:1000
uint8_t cca_thr_mode
CCA threshold mode. See enum sl_wfx_cc_thr_mode_t.
Definition: sl_wfx_general_api.h:1001
Definition: sl_wfx_general_api.h:1005
Definition: sl_wfx_general_api.h:1017
Confirmation for the Secure Link MAC key setting.
Definition: sl_wfx_general_api.h:582
uint32_t status
Key upload status (see enum sl_wfx_status_t)
Definition: sl_wfx_general_api.h:583
Definition: sl_wfx_general_api.h:586
Definition: sl_wfx_general_api.h:574
Set the Secure Link MAC key.
Definition: sl_wfx_general_api.h:569
uint8_t otp_or_ram
Key destination - OTP or RAM (see enum sl_wfx_securelink_mac_key_dest_t)
Definition: sl_wfx_general_api.h:570
Startup Indication message. This is the first message sent to the host to confirm boot success....
Definition: sl_wfx_general_api.h:305
uint8_t num_interfaces
number of interfaces (WIFI link : STA or AP) that can be created by the user
Definition: sl_wfx_general_api.h:313
uint16_t hardware_id
=RO misc_read_reg7 register value
Definition: sl_wfx_general_api.h:307
uint16_t num_inp_ch_bufs
Number of buffers available for request messages.
Definition: sl_wfx_general_api.h:310
uint32_t supported_rate_mask
A bit mask that indicates which rates are supported by the Physical layer. See enum api_rate_index.
Definition: sl_wfx_general_api.h:325
sl_wfx_otp_regul_sel_mode_info_t regul_sel_mode_info
OTP region selection mode info.
Definition: sl_wfx_general_api.h:323
sl_wfx_capabilities_t capabilities
List some FW options.
Definition: sl_wfx_general_api.h:317
uint8_t firmware_type
See enum sl_wfx_fw_type_t.
Definition: sl_wfx_general_api.h:321
uint16_t size_inp_ch_buf
TX Buffer size in bytes=request message max size.
Definition: sl_wfx_general_api.h:311
sl_wfx_otp_phy_info_t otp_phy_info
info on OTP backoff tables used to enforce the different DFS regulations.
Definition: sl_wfx_general_api.h:324
uint32_t status
Initialization status. A value of zero indicates the boot is completed successfully (see enum sl_wfx_...
Definition: sl_wfx_general_api.h:306
uint8_t num_links_aP
number of STA that are supported in AP mode
Definition: sl_wfx_general_api.h:312
Definition: sl_wfx_general_api.h:329
TX power loop info from the GENERIC indication message sl_wfx_generic_ind_body_t.
Definition: sl_wfx_general_api.h:460
uint8_t reserved
Reserved.
Definition: sl_wfx_general_api.h:467
uint8_t meas_index
Vpdet measurement index.
Definition: sl_wfx_general_api.h:466
uint16_t dig_gain
Used Tx digital gain.
Definition: sl_wfx_general_api.h:461
uint16_t ppa_gain
Used Tx PA gain.
Definition: sl_wfx_general_api.h:462
int16_t target_pout
Power target in qdBm.
Definition: sl_wfx_general_api.h:463
int16_t pestimation
FEM output power in qdBm.
Definition: sl_wfx_general_api.h:464
uint16_t vpdet
Measured Vpdet in mV.
Definition: sl_wfx_general_api.h:465
General command message IDs.
Definition: sl_wfx_general_api.h:218
sl_wfx_generic_requests_ids_t request
Request from the host to the WLAN device.
Definition: sl_wfx_general_api.h:219
sl_wfx_general_indications_ids_t indication
Indication from the WLAN device to the host.
Definition: sl_wfx_general_api.h:221
sl_wfx_general_confirmations_ids_t confirmation
Confirmation of a request from the WLAN device to the host.
Definition: sl_wfx_general_api.h:220
Definition: sl_wfx_general_api.h:470