Modules#

si91x_load_image_types

si91x_tls_defines

si91x_http_client_defines

si91x_response_handling_flags

si91x_feature_bit_map

si91x_tcp_ip_feature_bit_map

si91x_custom_feature_bit_map

si91x_extended_custom_feature_bit_map

si91x_extended_tcp_ip_feature_bit_map

si91x_bt_feature_bit_map

si91x_ble_feature_bit_map

si91x_extended_ble_custom_feature_bit_map

si91x_config_feature_bit_map

si91x_burn_target_options

si91x_calibration_flags

si91x_dtim_alignment_types

Constants#

This section provides a reference to Si91x Driver constants.

#

enum
sl_si91x_command_type_t {
SI91X_COMMON_CMD = 0
SI91X_WLAN_CMD = 1
SI91X_NETWORK_CMD = 2
SI91X_SOCKET_CMD = 3
SI91X_BT_CMD = 4
SI91X_CMD_MAX
}
enum
sl_si91x_queue_type_t {
SI91X_COMMON_CMD_QUEUE = 0
SI91X_WLAN_CMD_QUEUE = 1
SI91X_NETWORK_CMD_QUEUE = 2
SI91X_SOCKET_CMD_QUEUE = 3
SI91X_BT_CMD_QUEUE = 4
SI91X_COMMON_RESPONSE_QUEUE = 5
SI91X_WLAN_RESPONSE_QUEUE = 6
SI91X_NETWORK_RESPONSE_QUEUE = 7
SI91X_SOCKET_RESPONSE_QUEUE = 8
SI91X_BT_RESPONSE_QUEUE = 9
SI91X_WLAN_EVENT_QUEUE = 10
SI91X_NETWORK_EVENT_QUEUE = 11
CCP_M4_TA_RX_QUEUE = 12
SI91X_QUEUE_MAX
}

Si91x queue types.

enum
sl_si91x_band_mode_t {
SL_SI91X_WIFI_BAND_2_4GHZ = 0
SL_SI91X_WIFI_BAND_5GHZ = 1
SL_SI91X_WIFI_DUAL_BAND = 2
}

Si91x band mode.

enum
sl_si91x_region_code_t {
DEFAULT_REGION
US
EU
JP
WORLD_DOMAIN
KR
SG
}

Si91x region code.

Enumerations#

enum
sl_si91x_operation_mode_t {
SL_SI91X_CLIENT_MODE = 0
SL_SI91X_ENTERPRISE_CLIENT_MODE = 2
SL_SI91X_ACCESS_POINT_MODE = 6
SL_SI91X_TRANSMIT_TEST_MODE = 8
SL_SI91X_CONCURRENT_MODE = 9
__FORCE_OPERATION_ENUM_16BIT = 0xFFFF
}

Si91x operation mode.

enum
sl_si91x_coex_mode_t {
SL_SI91X_WLAN_ONLY_MODE = 0
SL_SI91X_WLAN_MODE = 1
SL_SI91X_BLUETOOTH_MODE = 4
SL_SI91X_WLAN_BLUETOOTH_MODE = 5
SL_SI91X_DUAL_MODE = 8
SL_SI91X_WLAN_DUAL_MODE = 9
SL_SI91X_BLE_MODE = 12
SL_SI91X_WLAN_BLE_MODE = 13
__FORCE_COEX_ENUM_16BIT = 0xFFFF
}

Si91x coex mode.

enum
sl_performance_profile_t {
HIGH_PERFORMANCE
ASSOCIATED_POWER_SAVE
ASSOCIATED_POWER_SAVE_LOW_LATENCY
STANDBY_POWER_SAVE
STANDBY_POWER_SAVE_WITH_RAM_RETENTION
}

Performance profile.

Variables#

const sl_wifi_device_configuration_t
sl_wifi_default_enterprise_client_configuration

Default Wi-Fi enterprise client configuration.

const sl_wifi_device_configuration_t
sl_wifi_default_concurrent_configuration

Default Wi-Fi concurrent (AP + STATION) configuration.

const sl_wifi_device_configuration_t
sl_wifi_transmit_test_configuration

Default Wi-Fi transmit configuration.

Functions#

void
si91x_default_event_handler(uint32_t event, void *data, void *arg)

Si91x default event handler. This is to be used if user wants use default callback framework provided by library.

sl_si91x_command_type_t#

sl_si91x_command_type_t

Si91x command types

Enumerator
SI91X_COMMON_CMD

SI91X Common Command.

SI91X_WLAN_CMD

SI91X Wireless LAN Command.

SI91X_NETWORK_CMD

SI91X Network Command.

SI91X_SOCKET_CMD

SI91X Socket Command.

SI91X_BT_CMD

SI91X Bluetooth Command.

SI91X_CMD_MAX

SI91X Maximum Command value.


sl_si91x_queue_type_t#

sl_si91x_queue_type_t

Si91x queue types.

Enumerator
SI91X_COMMON_CMD_QUEUE

SI91X common Command queue.

SI91X_WLAN_CMD_QUEUE

SI91X Wireless LAN Command queue.

SI91X_NETWORK_CMD_QUEUE

SI91X Network Command queue.

SI91X_SOCKET_CMD_QUEUE

SI91X Socket Command queue.

SI91X_BT_CMD_QUEUE

SI91X Bluetooth Command queue.

SI91X_COMMON_RESPONSE_QUEUE

SI91X common Command response queue.

SI91X_WLAN_RESPONSE_QUEUE

SI91X Wireless LAN Command response queue.

SI91X_NETWORK_RESPONSE_QUEUE

SI91X Network Command response queue.

SI91X_SOCKET_RESPONSE_QUEUE

SI91X Socket Command response queue.

SI91X_BT_RESPONSE_QUEUE

SI91X Bluetooth Command response queue.

SI91X_WLAN_EVENT_QUEUE

SI91X Wireless LAN Asynchronous response queue.

SI91X_NETWORK_EVENT_QUEUE

SI91X Network Asynchronous response queue.

CCP_M4_TA_RX_QUEUE

SI91X M4 Receive queue.

SI91X_QUEUE_MAX

SI91X Maximum queue type.


sl_si91x_band_mode_t#

sl_si91x_band_mode_t

Si91x band mode.

Enumerator
SL_SI91X_WIFI_BAND_2_4GHZ

2.4GHz WiFi band

SL_SI91X_WIFI_BAND_5GHZ

5GHz WiFi band

SL_SI91X_WIFI_DUAL_BAND

both 2.4GHz and 5GHZ WiFi band


sl_si91x_region_code_t#

sl_si91x_region_code_t

Si91x region code.

Enumerator
DEFAULT_REGION

Factory default region.

US

United States.

EU

European Union.

JP

Japan.

WORLD_DOMAIN

World wide domain.

KR

Korea.

SG

Singapore.


Enumeration Documentation#

sl_si91x_operation_mode_t#

sl_si91x_operation_mode_t

Si91x operation mode.

Note

  • Bits 28 - 31 are reserved

Enumerator
SL_SI91X_CLIENT_MODE

WiFi Personal Client mode.

SL_SI91X_ENTERPRISE_CLIENT_MODE

WiFi Enterprise Client mode.

SL_SI91X_ACCESS_POINT_MODE

WiFi Access Point mode.

SL_SI91X_TRANSMIT_TEST_MODE

WiFi Transit Test mode.

SL_SI91X_CONCURRENT_MODE

WiFi Concurrent mode.

__FORCE_OPERATION_ENUM_16BIT

sl_si91x_coex_mode_t#

sl_si91x_coex_mode_t

Si91x coex mode.

Enumerator
SL_SI91X_WLAN_ONLY_MODE

WLAN Only Mode.

SL_SI91X_WLAN_MODE

WLAN Mode.

SL_SI91X_BLUETOOTH_MODE

Bluetooth Only Mode.

SL_SI91X_WLAN_BLUETOOTH_MODE

WLAN and Bluetooth Mode.

SL_SI91X_DUAL_MODE

Dual Mode.

SL_SI91X_WLAN_DUAL_MODE

Wlan Dual Mode.

SL_SI91X_BLE_MODE

Bluetooth Low energy only mode.

SL_SI91X_WLAN_BLE_MODE

WLAN and Bluetooth Low energy Mode.

__FORCE_COEX_ENUM_16BIT

sl_performance_profile_t#

sl_performance_profile_t

Performance profile.

Enumerator
HIGH_PERFORMANCE

Power save is disabled and throughput is maximum.

ASSOCIATED_POWER_SAVE

Power save mode when module is associated with either AP or station.

ASSOCIATED_POWER_SAVE_LOW_LATENCY

Power save mode when module is associated with either AP or station, with higher throughput than ASSOCIATED_POWER_SAVE. This is not supported for BT/BLE.

STANDBY_POWER_SAVE

Power save mode when module is not associated with either AP or station, ram is not retained in this mode.

STANDBY_POWER_SAVE_WITH_RAM_RETENTION

Power save mode when module is not associated with either AP or station, ram is retained in this mode.


Variable Documentation#

sl_wifi_default_client_configuration#

const sl_wifi_device_configuration_t sl_wifi_default_client_configuration

Default Wi-Fi client configuration.


sl_wifi_default_enterprise_client_configuration#

const sl_wifi_device_configuration_t sl_wifi_default_enterprise_client_configuration

Default Wi-Fi enterprise client configuration.


sl_wifi_default_ap_configuration#

const sl_wifi_device_configuration_t sl_wifi_default_ap_configuration

Default Wi-Fi ap configuration.


sl_wifi_default_concurrent_configuration#

const sl_wifi_device_configuration_t sl_wifi_default_concurrent_configuration

Default Wi-Fi concurrent (AP + STATION) configuration.


sl_wifi_transmit_test_configuration#

const sl_wifi_device_configuration_t sl_wifi_transmit_test_configuration

Default Wi-Fi transmit configuration.


Function Documentation#

si91x_default_event_handler#

void si91x_default_event_handler (uint32_t event, void * data, void * arg)

Si91x default event handler. This is to be used if user wants use default callback framework provided by library.

Parameters
TypeDirectionArgument NameDescription
uint32_tN/Aevent
void *N/Adata
void *N/Aarg