Constants#

This section provides a reference to Si91x Device Management constants.

Modules#

Boot Configuration Feature Bitmaps

Default Device Configuration

Load Image Types

NWP Firmware Image Numbers

TLS Flags

Firmware upgrade flags

HTTP Flags

Join Feature Bitmap

DTIM Alignment Types

Enumerations#

enum
SL_SI91X_ASSERTION_TYPE_LMAC = 0
SL_SI91X_ASSERTION_TYPE_SME = 1
SL_SI91X_ASSERTION_TYPE_UMAC = 2
SL_SI91X_ASSERTION_TYPE_NETX = 4
SL_SI91X_ASSERTION_TYPE_CA = 8
SL_SI91X_ASSERTION_TYPE_ALL = 15
}

Assertion type must be in the range of 0 to 15 (both included)

enum
SL_SI91X_ASSERTION_LEVEL_MIN = 0
SL_SI91X_ASSERTION_LEVEL_SP = 1
SL_SI91X_ASSERTION_LEVEL_REC = 2
SL_SI91X_ASSERTION_LEVEL_INFO = 4
SL_SI91X_ASSERTION_LEVEL_MAX = 15
}

Assertion level must be in the range of 0 to 15 (both included)

enum
SL_SI91X_TAKE_M4_64K = 1
SL_SI91X_GET_IPMU_PROGRAMMING_VALUES = 2
SL_SI91X_READ_TA_REGISTER = 3
SL_SI91X_WRITE_TA_REGISTER = 4
SL_SI91X_ENABLE_XTAL = 5
SL_SI91X_WRITE_TO_COMMON_FLASH = 6
SL_SI91X_ENABLE_SIDE_BAND = 7
SL_SI91X_READ_FROM_COMMON_FLASH = 8
}

Managing interactions between the Trusted Application (TA) and the M4 core.

enum
SL_SI91X_AUTHENTICATION_ASSOCIATION_TIMEOUT = 0
SL_SI91X_CHANNEL_ACTIVE_SCAN_TIMEOUT
SL_SI91X_KEEP_ALIVE_TIMEOUT
SL_SI91X_CHANNEL_PASSIVE_SCAN_TIMEOUT
}

Si91x Timeout types.

enum
SL_SI91X_READ_NWP_DEBUG_PORT_STATUS = 9
SL_SI91X_READ_MCU_DEBUG_PORT_STATUS = 10
}

Si91x read status types.

enum
SL_SI91X_EFUSE_MFG_SW_VERSION = 0
SL_SI91X_EFUSE_PTE_CRC = 1
}

Si91x efuse data index.

Typedefs#

typedef sl_wifi_ap_keepalive_type_t

Si91x specific keepalive types.

typedef sl_wifi_band_mode_t

Si91x band mode.

typedef sl_wifi_region_code_t

sl_si91x_region_code_t

typedef sl_wifi_vap_id_t

Si91x Wi-Fi VAP ID.

typedef sl_wifi_system_performance_profile_t

Si91x performance profile.

typedef sl_wifi_operation_mode_t

Enumeration of Wi-Fi operation modes for the Si91x wireless device.

typedef sl_wifi_system_coex_mode_t

Si91x wireless co-existence mode.

Macros#

#define
SL_SI91X_AP_KEEP_ALIVE_DISABLE SL_WIFI_AP_KEEP_ALIVE_DISABLE

Si91x specific keepalive types.

#define
SL_SI91X_AP_DEAUTH_BASED_KEEP_ALIVE SL_WIFI_AP_DEAUTH_BASED_KEEP_ALIVE

AP performs keepalive functionality based on the RX packets received from its stations.

#define
SL_SI91X_AP_NULL_BASED_KEEP_ALIVE SL_WIFI_AP_NULL_BASED_KEEP_ALIVE

AP performs keepalive functionality by sending a NULL DATA packet to the station.

#define
SL_SI91X_WIFI_BAND_2_4GHZ SL_WIFI_BAND_MODE_2_4GHZ

Si91x band mode.

#define
SL_SI91X_WIFI_BAND_5GHZ SL_WIFI_BAND_MODE_5GHZ

5 GHz Wi-Fi band (not currently supported)

#define
SL_SI91X_WIFI_DUAL_BAND SL_WIFI_DUAL_BAND_MODE

Both 2.4 GHz and 5 GHZ WiFi band (not currently supported)

#define
DEFAULT_REGION SL_WIFI_DEFAULT_REGION

Si91x region code.

#define
US SL_WIFI_REGION_US

United States.

#define
EU SL_WIFI_REGION_EU

European Union.

#define
JP SL_WIFI_REGION_JP

Japan.

#define
WORLD_DOMAIN SL_WIFI_REGION_WORLD_DOMAIN

World domain.

#define
KR SL_WIFI_REGION_KR

Korea.

#define
SG SL_WIFI_REGION_SG

Singapore (not currently supported)

#define
CN SL_WIFI_REGION_CN

China.

#define
IGNORE_REGION SL_WIFI_IGNORE_REGION

Do not update region code during initialization.

#define
SL_SI91X_WIFI_CLIENT_VAP_ID SL_WIFI_CLIENT_VAP_ID

Si91x Wi-Fi VAP ID.

#define
SL_SI91X_WIFI_AP_VAP_ID SL_WIFI_AP_VAP_ID

Wi-Fi Access point VAP ID.

#define
SL_SI91X_WIFI_CLIENT_VAP_ID_1 SL_WIFI_CLIENT_VAP_ID_1

Wi-Fi Client 1 VAP ID.

#define
SL_SI91X_WIFI_AP_VAP_ID_1 SL_WIFI_AP_VAP_ID_1

Wi-Fi Access point 1 VAP ID.

#define
HIGH_PERFORMANCE SL_WIFI_SYSTEM_HIGH_PERFORMANCE

Si91x performance profile.

#define
ASSOCIATED_POWER_SAVE SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE

Low power profile when the device is associated with an AP (MAX PSP).

#define
ASSOCIATED_POWER_SAVE_LOW_LATENCY SL_WIFI_SYSTEM_ASSOCIATED_POWER_SAVE_LOW_LATENCY

Low power profile when the device is associated with an AP (FAST PSP).

#define
DEEP_SLEEP_WITHOUT_RAM_RETENTION SL_WIFI_SYSTEM_DEEP_SLEEP_WITHOUT_RAM_RETENTION

Deep Sleep without RAM retention when the device is not associated with AP.

#define
DEEP_SLEEP_WITH_RAM_RETENTION SL_WIFI_SYSTEM_DEEP_SLEEP_WITH_RAM_RETENTION

Deep Sleep with RAM retention when the device is not associated with AP.

#define
SL_SI91X_CLIENT_MODE SL_WIFI_CLIENT_MODE

Wi-Fi personal client mode.

#define
SL_SI91X_ENTERPRISE_CLIENT_MODE SL_WIFI_ENTERPRISE_CLIENT_MODE

Wi-Fi enterprise client mode.

#define
SL_SI91X_ACCESS_POINT_MODE SL_WIFI_ACCESS_POINT_MODE

Wi-Fi access point mode.

#define
SL_SI91X_TRANSCEIVER_MODE SL_WIFI_TRANSCEIVER_MODE

Wi-Fi transceiver mode.

#define
SL_SI91X_TRANSMIT_TEST_MODE SL_WIFI_TRANSMIT_TEST_MODE

Wi-Fi transmit test mode.

#define
SL_SI91X_CONCURRENT_MODE SL_WIFI_CONCURRENT_MODE

Wi-Fi concurrent mode.

#define
__FORCE_OPERATION_ENUM_16BIT __SL_WIFI_FORCE_OPERATION_ENUM_16BIT

Force the enumeration to be 16-bit.

#define
SL_SI91X_WLAN_ONLY_MODE SL_WIFI_SYSTEM_WLAN_ONLY_MODE

Wireless local area network (WLAN) only mode.

#define
SL_SI91X_WLAN_MODE SL_WIFI_SYSTEM_WLAN_MODE

WLAN mode (not currently supported)

#define
SL_SI91X_BLUETOOTH_MODE SL_WIFI_SYSTEM_BLUETOOTH_MODE

Bluetooth only mode (not currently supported)

#define
SL_SI91X_WLAN_BLUETOOTH_MODE SL_WIFI_SYSTEM_WLAN_BLUETOOTH_MODE

WLAN and Bluetooth mode (not currently supported)

#define
SL_SI91X_DUAL_MODE SL_WIFI_SYSTEM_DUAL_MODE

Dual mode (not currently supported)

#define
SL_SI91X_WLAN_DUAL_MODE SL_WIFI_SYSTEM_WLAN_DUAL_MODE

WLAN dual mode (not currently supported)

#define
SL_SI91X_BLE_MODE SL_WIFI_SYSTEM_BLE_MODE

Bluetooth Low Energy (BLE) only mode, used when power save mode is not needed.

#define
SL_SI91X_WLAN_BLE_MODE SL_WIFI_SYSTEM_WLAN_BLE_MODE

WLAN and BLE mode.

#define
__FORCE_COEX_ENUM_16BIT __SL_WIFI_FORCE_COEX_ENUM_16BIT

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

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_timeout_type_t#

sl_si91x_timeout_type_t

Si91x Timeout types.

Enumerator
SL_SI91X_AUTHENTICATION_ASSOCIATION_TIMEOUT

Used for setting association and authentication timeout request in milliseconds.

SL_SI91X_CHANNEL_ACTIVE_SCAN_TIMEOUT

Used for setting dwell time per channel in milliseconds during active scan.

SL_SI91X_KEEP_ALIVE_TIMEOUT

Used for setting WLAN keep alive time in seconds.

SL_SI91X_CHANNEL_PASSIVE_SCAN_TIMEOUT

Used for setting dwell time per channel in milliseconds during passive scan.


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_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_si91x_band_mode_t

Si91x band mode.

Note

  • Only 2.4 GHz is currently supported.


sl_si91x_region_code_t#

sl_si91x_region_code_t

sl_si91x_region_code_t


sl_si91x_vap_id_t#

sl_si91x_vap_id_t

Si91x Wi-Fi VAP ID.


sl_si91x_performance_profile_t#

typedef sl_wifi_system_performance_profile_t 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_si91x_coex_mode_t

Si91x wireless co-existence mode.

Note

  • Only BLE, WLAN, and WLAN + BLE modes are supported.