General API
To interact with WFx, the host has access to a set of API which are exposed both in the split MAC case and in the full MAC case. To find the related driver functions, see the table below or GENERAL_API group.
General API Commands
| Commands | Command ID | Associated driver function | Description |
|---|---|---|---|
| SL_WFX_CONFIGURATION | 0x09 | sl_wfx_send_configuration() | Configure the device through the Platform Data Set |
| SL_WFX_CONTROL_GPIO | 0x26 | sl_wfx_control_gpio() | Control a GPIO of the WFx |
| SL_WFX_SET_SL_MAC_KEY | 0x27 | sl_wfx_secure_link_set_mac_key() | Set the Secure Link MAC Key |
| SL_WFX_SECURELINK_EXCHANGE_PUB_KEYS | 0x28 | sl_wfx_secure_link_exchange_keys() | Exchange Secure Link public keys. |
| SL_WFX_SECURELINK_CONFIGURE | 0x29 | sl_wfx_secure_link_configure() | Modify Secure Link configuration |
| SL_WFX_PREVENT_ROLLBACK | 0x2a | sl_wfx_prevent_rollback() | Activate the prevent rollback feature. The chip will not boot on an older version of the firmware |
| SL_WFX_PTA_SETTINGS | 0x2b | sl_wfx_pta_settings() | Configure the PTA settings (required before sending a SL_WFX_PTA_STATE command) |
| SL_WFX_PTA_PRIORITY | 0x2c | sl_wfx_pta_priority() | Configure the PTA priority |
| SL_WFX_PTA_STATE | 0x2d | sl_wfx_pta_state() | Set the PTA state (on/off) |
| SL_WFX_SET_CCA_CONFIG_REQ_ID | 0x2e | sl_wfx_set_cca_config() | Configure the CCA mode |
| SL_WFX_SHUT_DOWN | 0x32 | sl_wfx_shutdown() | Send a request to shut down the internal power supplies |
For each available command, there is an associated confirmation with the same ID value.
General API Indications
| Indications | Indication ID | Associated structure | Description |
|---|---|---|---|
| SL_WFX_EXCEPTION_IND | 0xe0 | sl_wfx_exception_ind_body_t | Exception |
| SL_WFX_ERROR_IND | 0xe4 | sl_wfx_error_ind_body_t | Error |
| SL_WFX_STARTUP_IND | 0xe1 | sl_wfx_startup_ind_body_t | Startup indication |
| SL_WFX_GENERIC_IND | 0xe3 | sl_wfx_generic_ind_body_t | Generic status |
These indications have to be managed by the host depending on the application and use case.