Constants#
This section provides a reference to Si91x Device Management constants.
Modules#
Boot Configuration Feature Bitmaps
Enumerations#
Assertion type must be in the range of 0 to 15 (both included)
Assertion level must be in the range of 0 to 15 (both included)
TA-M4 command IDs.
Si91x read status types.
Si91x efuse data index.
Typedefs#
Si91x specific keepalive types.
Si91x band mode.
Si91X Region Code.
Si91x VAP-ID.
Si91x timeout type Moving forward, sl_si91x_timeout_type_t type will be deprecated.
Si91x performance profile.
Enumeration of Wi-Fi operation modes for the Si91x wireless device.
Si91x wireless co-existence mode.
Macros#
Get board OPN board configuration.
Get NWP timestamp.
Si91x specific keepalive types.
AP performs keepalive functionality based on the RX packets received from its stations.
AP performs keepalive functionality by sending a NULL DATA packet to the station.
Si91x band mode.
5 GHz Wi-Fi band (not currently supported)
Both 2.4 GHz and 5 GHZ WiFi band (not currently supported)
Si91x region code.
United States.
European Union.
Japan.
World domain.
Korea.
Singapore (not currently supported)
China.
Do not update region code during initialization.
Si91x Wi-Fi VAP ID.
Wi-Fi Access point VAP ID.
Wi-Fi Client 1 VAP ID.
Wi-Fi Access point 1 VAP ID.
Si91x Timeout types Used for setting association and authentication timeout request in milliseconds.
Used for setting dwell time per channel in milliseconds during active scan.
Used for setting WLAN keep alive time in seconds.
Used for setting dwell time per channel in milliseconds during passive scan.
Si91x performance profile.
Low power profile when the device is associated with an AP (MAX PSP).
Low power profile when the device is associated with an AP (FAST PSP). If SL_WIFI_ENABLE_ENHANCED_MAX_PSP bit is set in config_feature_bit_map, then this mode enables the Enhanced Max PSP feature.
Deep Sleep without RAM retention when the device is not associated with AP.
Deep Sleep with RAM retention when the device is not associated with AP.
Wi-Fi personal client mode.
Wi-Fi enterprise client mode.
Wi-Fi access point mode.
Wi-Fi transceiver mode.
Wi-Fi transmit test mode.
Wi-Fi concurrent mode.
Force the enumeration to be 16-bit.
Wireless local area network (WLAN) only mode.
WLAN mode (not currently supported)
Bluetooth only mode (not currently supported)
WLAN and Bluetooth mode (not currently supported)
Dual mode (not currently supported)
WLAN dual mode (not currently supported)
Bluetooth Low Energy (BLE) only mode, used when power save mode is not needed.
WLAN and BLE mode.
Force the enumeration to be 16-bit.
Enumeration Documentation#
sl_si91x_assertion_type_t#
sl_si91x_assertion_type_t
Assertion type must be in the range of 0 to 15 (both included)
| Enumerator | |
|---|---|
| SL_SI91X_ASSERTION_TYPE_LMAC | Assertion type specific to the LMAC core. |
| SL_SI91X_ASSERTION_TYPE_SME | Assertion type specific to the SME (Station Management Entity) core. |
| SL_SI91X_ASSERTION_TYPE_UMAC | Assertion type specific to the UMAC core. |
| SL_SI91X_ASSERTION_TYPE_NETX | Assertion type specific to the NETX (Networking Stack) core. |
| SL_SI91X_ASSERTION_TYPE_CA | Enables critical assertion indication and provides a RAM dump during critical assertions. |
| SL_SI91X_ASSERTION_TYPE_ALL | Enables assertion for all cores. |
sl_si91x_assertion_level_t#
sl_si91x_assertion_level_t
Assertion level must be in the range of 0 to 15 (both included)
| Enumerator | |
|---|---|
| SL_SI91X_ASSERTION_LEVEL_MIN | Minimum assertion level. Indicates that an assertion is mandatory. |
| SL_SI91X_ASSERTION_LEVEL_SP | Assertion for specific print messages, used for debugging or analysis. |
| SL_SI91X_ASSERTION_LEVEL_REC | Recoverable assertion level. Indicates that the system can recover from the assertion. |
| SL_SI91X_ASSERTION_LEVEL_INFO | Informational assertion level, used to log general information. |
| SL_SI91X_ASSERTION_LEVEL_MAX | Maximum assertion level. Enables all types of print statements. |
sl_si91x_ta_m4_commands_t#
sl_si91x_ta_m4_commands_t
TA-M4 command IDs.
New values may be added in future releases. Any code that switches on this enum (e.g. in NWP/TA firmware) must include a default case to handle unknown values gracefully. Managing interactions between the Trusted Application (TA) and the M4 core
| Enumerator | |
|---|---|
| SL_SI91X_TAKE_M4_64K | Allocates 64KB of memory for the M4 core. |
| SL_SI91X_GET_IPMU_PROGRAMMING_VALUES | Retrieves the programming values from the IPMU. |
| SL_SI91X_READ_TA_REGISTER | Reads the value from a Trusted Application (TA) register. |
| SL_SI91X_WRITE_TA_REGISTER | Writes a specified value to a TA register. |
| SL_SI91X_ENABLE_XTAL | Signals the NWP to configure clock switching between 1.3V and 3.3V. |
| SL_SI91X_WRITE_TO_COMMON_FLASH | Writes data to the common flash memory. |
| SL_SI91X_ENABLE_SIDE_BAND | Enables side-band crypto processing if the feature is enabled. |
| SL_SI91X_READ_FROM_COMMON_FLASH | Reads data from the common flash memory. |
| SL_SI91X_SET_TIMESTAMP_MEMORY_ADDRESS | Sets the memory address for timestamp storage. |
| SL_SI91X_MCU_SECURE_STORAGE_ENABLE_PROTECTION | Enables MCU secure storage write protection. |
| SL_SI91X_MCU_SECURE_STORAGE_DISABLE_PROTECTION | Disables MCU secure storage write protection. |
sl_si91x_read_status_t#
sl_si91x_read_status_t
Si91x read status types.
| Enumerator | |
|---|---|
| SL_SI91X_READ_NWP_DEBUG_PORT_STATUS | Read NWP debug port status. |
| SL_SI91X_READ_MCU_DEBUG_PORT_STATUS | Read MCU debug port status. |
sl_si91x_efuse_data_type_t#
sl_si91x_efuse_data_type_t
Si91x efuse data index.
| Enumerator | |
|---|---|
| SL_SI91X_EFUSE_MFG_SW_VERSION | Efuse data index for manufacturing software version. |
| SL_SI91X_EFUSE_PTE_CRC | Efuse data index for PTE CRC. |
Typedef Documentation#
sl_si91x_ap_keepalive_type_t#
typedef sl_wifi_ap_keepalive_type_t SL_DEPRECATED_API_WISECONNECT_4_0 sl_si91x_ap_keepalive_type_t
Si91x specific keepalive types.
Si91x specific keepalive types
sl_si91x_band_mode_t#
typedef sl_wifi_band_mode_t SL_DEPRECATED_API_WISECONNECT_4_0 sl_si91x_band_mode_t
Si91x band mode.
Note
Only 2.4 GHz is currently supported.
sl_si91x_region_code_t#
typedef sl_wifi_region_code_t SL_DEPRECATED_API_WISECONNECT_4_0 sl_si91x_region_code_t
Si91X Region Code.
sl_si91x_region_code_t
sl_si91x_vap_id_t#
typedef sl_wifi_vap_id_t SL_DEPRECATED_API_WISECONNECT_4_0 sl_si91x_vap_id_t
Si91x VAP-ID.
Si91x Wi-Fi VAP ID
sl_si91x_timeout_type_t#
typedef sl_wifi_timeout_type_t SL_DEPRECATED_API_WISECONNECT_4_1 sl_si91x_timeout_type_t
Si91x timeout type Moving forward, sl_si91x_timeout_type_t type will be deprecated.
Instead, use sl_wifi_timeout_type_t type. This is retained for backward compatibility.
sl_si91x_performance_profile_t#
typedef sl_wifi_system_performance_profile_t SL_DEPRECATED_API_WISECONNECT_4_0 sl_si91x_performance_profile_t
Si91x performance profile.
sl_si91x_operation_mode_t#
sl_si91x_operation_mode_t
Enumeration of Wi-Fi operation modes for the Si91x wireless device.
This enumeration defines the various operation modes supported by the Si91x wireless device. Each mode configures the device for a specific use case, such as client mode, access point mode, or transceiver mode.
sl_si91x_coex_mode_t#
typedef sl_wifi_system_coex_mode_t SL_DEPRECATED_API_WISECONNECT_4_0 sl_si91x_coex_mode_t
Si91x wireless co-existence mode.
Note
Only BLE, WLAN, and WLAN + BLE modes are supported.
Macro Definition Documentation#
SL_SI91X_AP_KEEP_ALIVE_DISABLE#
#define SL_SI91X_AP_KEEP_ALIVE_DISABLEValue:
SL_WIFI_AP_KEEP_ALIVE_DISABLE
Si91x specific keepalive types.
Disable keepalive functionality.
SL_SI91X_AP_DEAUTH_BASED_KEEP_ALIVE#
#define SL_SI91X_AP_DEAUTH_BASED_KEEP_ALIVEValue:
SL_WIFI_AP_DEAUTH_BASED_KEEP_ALIVE
AP performs keepalive functionality based on the RX packets received from its stations.
If no packet is received from the station within the AP keep alive timeout period, the AP disconnects the station.
SL_SI91X_AP_NULL_BASED_KEEP_ALIVE#
#define SL_SI91X_AP_NULL_BASED_KEEP_ALIVEValue:
SL_WIFI_AP_NULL_BASED_KEEP_ALIVE
AP performs keepalive functionality by sending a NULL DATA packet to the station.
If no ACK is received from the station after a specific number of retries, the AP discards the station.
SL_SI91X_WIFI_BAND_2_4GHZ#
#define SL_SI91X_WIFI_BAND_2_4GHZValue:
SL_WIFI_BAND_MODE_2_4GHZ
Si91x band mode.
2.4 GHz Wi-Fi band
SL_SI91X_WIFI_BAND_5GHZ#
#define SL_SI91X_WIFI_BAND_5GHZValue:
SL_WIFI_BAND_MODE_5GHZ
5 GHz Wi-Fi band (not currently supported)
SL_SI91X_WIFI_DUAL_BAND#
#define SL_SI91X_WIFI_DUAL_BANDValue:
SL_WIFI_DUAL_BAND_MODE
Both 2.4 GHz and 5 GHZ WiFi band (not currently supported)
DEFAULT_REGION#
#define DEFAULT_REGIONValue:
SL_WIFI_DEFAULT_REGION
Si91x region code.
Note
Singapore region is not currently supported.
The suggested mapping for different countries is to be used only for guidance purpose. The customer is expected to verify corresponding country emission requirements and get certification.
Guidance for Region code Mapping for Different Countries
Country | Country Code | Max power (Based on Regulatory domain) | Frequency Range (Based on Regulatory Domain) | Suggested Region Code Mapping |
|---|---|---|---|---|
Korea | KR | 23 dBm | 2400 - 2483.5 | SL_WIFI_REGION_KR |
Hong Kong | HK | 36 dBm | 2400 - 2483.5 | SL_WIFI_REGION_EU |
Singapore | SG | 200 mW (23 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU |
Malaysia | MY | 500 mW (27 dBm) | 2402 - 2482 | SL_WIFI_REGION_EU |
Australia | AU | 4000 mW (36 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU |
Taiwan | TW | 30 dBm | 2400 - 2483.5 | SL_WIFI_REGION_EU |
Thailand | TH | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU |
Mexico | MX | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU |
Vietnam | VN | 20 dBm | 2402 - 2482 | SL_WIFI_REGION_EU |
Indonesia | ID | 500mW (27 dBm) | 2400 - 2483.5 | SL_WIFI_REGION_EU |
China | CN | 20 dBm | 2400 - 2483.5 | CN |
Factory default region
IGNORE_REGION#
#define IGNORE_REGIONValue:
SL_WIFI_IGNORE_REGION
Do not update region code during initialization.
SL_SI91X_WIFI_CLIENT_VAP_ID#
#define SL_SI91X_WIFI_CLIENT_VAP_IDValue:
SL_WIFI_CLIENT_VAP_ID
Si91x Wi-Fi VAP ID.
Wi-Fi Client VAP ID
SL_SI91X_WIFI_AP_VAP_ID#
#define SL_SI91X_WIFI_AP_VAP_IDValue:
SL_WIFI_AP_VAP_ID
Wi-Fi Access point VAP ID.
SL_SI91X_WIFI_CLIENT_VAP_ID_1#
#define SL_SI91X_WIFI_CLIENT_VAP_ID_1Value:
SL_WIFI_CLIENT_VAP_ID_1
Wi-Fi Client 1 VAP ID.
SL_SI91X_WIFI_AP_VAP_ID_1#
#define SL_SI91X_WIFI_AP_VAP_ID_1Value:
SL_WIFI_AP_VAP_ID_1
Wi-Fi Access point 1 VAP ID.
SL_SI91X_AUTHENTICATION_ASSOCIATION_TIMEOUT#
#define SL_SI91X_AUTHENTICATION_ASSOCIATION_TIMEOUTValue:
SL_WIFI_AUTHENTICATION_ASSOCIATION_TIMEOUT
Si91x Timeout types Used for setting association and authentication timeout request in milliseconds.
SL_SI91X_CHANNEL_ACTIVE_SCAN_TIMEOUT#
#define SL_SI91X_CHANNEL_ACTIVE_SCAN_TIMEOUTValue:
SL_WIFI_CHANNEL_ACTIVE_SCAN_TIMEOUT
Used for setting dwell time per channel in milliseconds during active scan.
SL_SI91X_KEEP_ALIVE_TIMEOUT#
#define SL_SI91X_KEEP_ALIVE_TIMEOUTValue:
SL_WIFI_KEEP_ALIVE_TIMEOUT
Used for setting WLAN keep alive time in seconds.
SL_SI91X_CHANNEL_PASSIVE_SCAN_TIMEOUT#
#define SL_SI91X_CHANNEL_PASSIVE_SCAN_TIMEOUTValue:
SL_WIFI_CHANNEL_PASSIVE_SCAN_TIMEOUT
Used for setting dwell time per channel in milliseconds during passive scan.
HIGH_PERFORMANCE#
#define HIGH_PERFORMANCEValue:
SL_WIFI_SYSTEM_HIGH_PERFORMANCE
Si91x performance profile.
Power save is disabled and throughput is maximum.
ASSOCIATED_POWER_SAVE#
#define ASSOCIATED_POWER_SAVEValue:
SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE
Low power profile when the device is associated with an AP (MAX PSP).
ASSOCIATED_POWER_SAVE_LOW_LATENCY#
#define ASSOCIATED_POWER_SAVE_LOW_LATENCYValue:
SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE_LOW_LATENCY
Low power profile when the device is associated with an AP (FAST PSP). If SL_WIFI_ENABLE_ENHANCED_MAX_PSP bit is set in config_feature_bit_map, then this mode enables the Enhanced Max PSP feature.
DEEP_SLEEP_WITHOUT_RAM_RETENTION#
#define DEEP_SLEEP_WITHOUT_RAM_RETENTIONValue:
SL_WIFI_SYSTEM_DEEP_SLEEP_WITHOUT_RAM_RETENTION
Deep Sleep without RAM retention when the device is not associated with AP.
DEEP_SLEEP_WITH_RAM_RETENTION#
#define DEEP_SLEEP_WITH_RAM_RETENTIONValue:
SL_WIFI_SYSTEM_DEEP_SLEEP_WITH_RAM_RETENTION
Deep Sleep with RAM retention when the device is not associated with AP.
SL_SI91X_CLIENT_MODE#
#define SL_SI91X_CLIENT_MODEValue:
SL_WIFI_CLIENT_MODE
Wi-Fi personal client mode.
SL_SI91X_ENTERPRISE_CLIENT_MODE#
#define SL_SI91X_ENTERPRISE_CLIENT_MODEValue:
SL_WIFI_ENTERPRISE_CLIENT_MODE
Wi-Fi enterprise client mode.
SL_SI91X_ACCESS_POINT_MODE#
#define SL_SI91X_ACCESS_POINT_MODEValue:
SL_WIFI_ACCESS_POINT_MODE
Wi-Fi access point mode.
SL_SI91X_TRANSCEIVER_MODE#
#define SL_SI91X_TRANSCEIVER_MODEValue:
SL_WIFI_TRANSCEIVER_MODE
Wi-Fi transceiver mode.
SL_SI91X_TRANSMIT_TEST_MODE#
#define SL_SI91X_TRANSMIT_TEST_MODEValue:
SL_WIFI_TRANSMIT_TEST_MODE
Wi-Fi transmit test mode.
SL_SI91X_CONCURRENT_MODE#
#define SL_SI91X_CONCURRENT_MODEValue:
SL_WIFI_CONCURRENT_MODE
Wi-Fi concurrent mode.
__FORCE_OPERATION_ENUM_16BIT#
#define __FORCE_OPERATION_ENUM_16BITValue:
__SL_WIFI_FORCE_OPERATION_ENUM_16BIT
Force the enumeration to be 16-bit.
SL_SI91X_WLAN_ONLY_MODE#
#define SL_SI91X_WLAN_ONLY_MODEValue:
SL_WIFI_SYSTEM_WLAN_ONLY_MODE
Wireless local area network (WLAN) only mode.
SL_SI91X_WLAN_MODE#
#define SL_SI91X_WLAN_MODEValue:
SL_WIFI_SYSTEM_WLAN_MODE
WLAN mode (not currently supported)
SL_SI91X_BLUETOOTH_MODE#
#define SL_SI91X_BLUETOOTH_MODEValue:
SL_WIFI_SYSTEM_BLUETOOTH_MODE
Bluetooth only mode (not currently supported)
SL_SI91X_WLAN_BLUETOOTH_MODE#
#define SL_SI91X_WLAN_BLUETOOTH_MODEValue:
SL_WIFI_SYSTEM_WLAN_BLUETOOTH_MODE
WLAN and Bluetooth mode (not currently supported)
SL_SI91X_DUAL_MODE#
#define SL_SI91X_DUAL_MODEValue:
SL_WIFI_SYSTEM_DUAL_MODE
Dual mode (not currently supported)
SL_SI91X_WLAN_DUAL_MODE#
#define SL_SI91X_WLAN_DUAL_MODEValue:
SL_WIFI_SYSTEM_WLAN_DUAL_MODE
WLAN dual mode (not currently supported)
SL_SI91X_BLE_MODE#
#define SL_SI91X_BLE_MODEValue:
SL_WIFI_SYSTEM_BLE_MODE
Bluetooth Low Energy (BLE) only mode, used when power save mode is not needed.
SL_SI91X_WLAN_BLE_MODE#
#define SL_SI91X_WLAN_BLE_MODEValue:
SL_WIFI_SYSTEM_WLAN_BLE_MODE
WLAN and BLE mode.
__FORCE_COEX_ENUM_16BIT#
#define __FORCE_COEX_ENUM_16BITValue:
__SL_WIFI_FORCE_COEX_ENUM_16BIT
Force the enumeration to be 16-bit.