XCORE SDK
XCORE Software Development Kit
Modules | Classes | Typedefs | Enumerations
GENERAL_API

General API messages available in both split and full MAC. More...

Modules

 General_Configuration
 General configuration commands.
 
 
 Prevent_Firmware_Rollback
 APIs for preventing Rollback of unsafe firmware images.
 
 PTA
 APIs to manage dynamic aspects of Packet Traffic Arbitration (PTA).
 
 ERROR_IDS
 

Classes

union  sl_wfx_general_commands_ids_u
 General command message IDs. More...
 
struct  sl_wfx_set_cca_config_req_body_s
 Request sent by host to set the Clear Channel Assessment configuration Set the CCA mode and the defer threshold. More...
 
struct  sl_wfx_set_cca_config_req_s
 
struct  sl_wfx_set_cca_config_cnf_body_s
 Confirmation sent by Wlan firmware after a SL_WFX_SET_CCA_CONFIG_REQ_ID request. More...
 
struct  sl_wfx_set_cca_config_s
 

Typedefs

typedef enum sl_wfx_generic_requests_ids_e sl_wfx_generic_requests_ids_t
 General request message IDs. More...
 
typedef enum sl_wfx_general_confirmations_ids_e sl_wfx_general_confirmations_ids_t
 General confirmation message IDs. More...
 
typedef enum sl_wfx_general_indications_ids_e sl_wfx_general_indications_ids_t
 General indications message IDs. More...
 
typedef union sl_wfx_general_commands_ids_u sl_wfx_general_commands_ids_t
 General command message IDs. More...
 
typedef enum sl_wfx_status_e 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.
 
typedef enum sl_wfx_cc_thr_mode_e sl_wfx_cc_thr_mode_t
 CCA Mode definition.
 
typedef 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 threshold.
 
typedef struct sl_wfx_set_cca_config_req_s sl_wfx_set_cca_config_req_t
 
typedef 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.
 
typedef struct sl_wfx_set_cca_config_s sl_wfx_set_cca_config_t
 

Enumerations

enum  sl_wfx_generic_requests_ids_e {
  SL_WFX_CONFIGURATION_REQ_ID = 0x09 , SL_WFX_CONTROL_GPIO_REQ_ID = 0x26 , SL_WFX_SET_SECURELINK_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_PTA_SETTINGS_REQ_ID = 0x2b , SL_WFX_PTA_PRIORITY_REQ_ID = 0x2c ,
  SL_WFX_PTA_STATE_REQ_ID = 0x2d , SL_WFX_SET_CCA_CONFIG_REQ_ID = 0x2e , SL_WFX_SHUT_DOWN_REQ_ID = 0x32
}
 General request message IDs. More...
 
enum  sl_wfx_general_confirmations_ids_e {
  SL_WFX_CONFIGURATION_CNF_ID = 0x09 , SL_WFX_CONTROL_GPIO_CNF_ID = 0x26 , SL_WFX_SET_SECURELINK_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 = 0x2a , SL_WFX_PTA_SETTINGS_CNF_ID = 0x2b , SL_WFX_PTA_PRIORITY_CNF_ID = 0x2c ,
  SL_WFX_PTA_STATE_CNF_ID = 0x2d , SL_WFX_SET_CCA_CONFIG_CNF_ID = 0x2e
}
 General confirmation message IDs. More...
 
enum  sl_wfx_general_indications_ids_e {
  SL_WFX_EXCEPTION_IND_ID = 0xe0 , SL_WFX_STARTUP_IND_ID = 0xe1 , SL_WFX_WAKEUP_IND_ID = 0xe2 , SL_WFX_GENERIC_IND_ID = 0xe3 ,
  SL_WFX_ERROR_IND_ID = 0xe4 , SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS_IND_ID = 0xe5
}
 General indications message IDs. More...
 
enum  sl_wfx_status_e {
  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_WFX_MAC_KEY_STATUS_SUCCESS = 0x5A , SL_WFX_MAC_KEY_STATUS_FAILED_KEY_ALREADY_BURNED = 0x6B , SL_WFX_MAC_KEY_STATUS_FAILED_RAM_MODE_NOT_ALLOWED = 0x7C ,
  SL_WFX_MAC_KEY_STATUS_FAILED_UNKNOWN_MODE = 0x8D , SL_WFX_PUB_KEY_EXCHANGE_STATUS_SUCCESS = 0x9E , SL_WFX_PUB_KEY_EXCHANGE_STATUS_FAILED = 0xAF , SL_WFX_PREVENT_ROLLBACK_CNF_SUCCESS = 0x1234 ,
  SL_WFX_PREVENT_ROLLBACK_CNF_WRONG_MAGIC_WORD = 0x1256
}
 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. More...
 
enum  sl_wfx_cc_thr_mode_e { SL_WFX_CCA_THR_MODE_RELATIVE = 0x0 , SL_WFX_CCA_THR_MODE_ABSOLUTE = 0x1 }
 CCA Mode definition. More...
 

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.

Typedef Documentation

◆ sl_wfx_general_commands_ids_t

General command message IDs.

All general API message IDs.

◆ 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.

◆ 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.

◆ 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.

Enumeration Type Documentation

◆ sl_wfx_cc_thr_mode_e

CCA Mode definition.

Enumerator
SL_WFX_CCA_THR_MODE_RELATIVE 

Use CCA defer threshold relative to channel noise.

SL_WFX_CCA_THR_MODE_ABSOLUTE 

Use absolute CCA defer threshold.

◆ sl_wfx_general_confirmations_ids_e

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

◆ sl_wfx_general_indications_ids_e

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

◆ sl_wfx_generic_requests_ids_e

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

◆ sl_wfx_status_e

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.

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 

Unknown request ID or wrong interface ID used.

SL_WFX_MAC_KEY_STATUS_SUCCESS 

Key has been correctly written.

SL_WFX_MAC_KEY_STATUS_FAILED_KEY_ALREADY_BURNED 

Key already exists in OTP.

SL_WFX_MAC_KEY_STATUS_FAILED_RAM_MODE_NOT_ALLOWED 

RAM mode is not allowed.

SL_WFX_MAC_KEY_STATUS_FAILED_UNKNOWN_MODE 

Unknown mode (should be RAM or OTP)

SL_WFX_PUB_KEY_EXCHANGE_STATUS_SUCCESS 

Host Public Key authenticated.

SL_WFX_PUB_KEY_EXCHANGE_STATUS_FAILED 

Host Public Key authentication failed.

SL_WFX_PREVENT_ROLLBACK_CNF_SUCCESS 

OTP rollback value has been successfully updated.

SL_WFX_PREVENT_ROLLBACK_CNF_WRONG_MAGIC_WORD 

Wrong magic word detected.