Constants#

This section provides a reference to Wi-Fi API constants.

Enumerations#

enum
SL_WIFI_OPEN = 0
SL_WIFI_WPA = 1
SL_WIFI_WPA2 = 2
SL_WIFI_WEP = 3
SL_WIFI_WPA_ENTERPRISE = 4
SL_WIFI_WPA2_ENTERPRISE = 5
SL_WIFI_WPA_WPA2_MIXED = 6
SL_WIFI_WPA3 = 7
SL_WIFI_WPA3_TRANSITION = 8
SL_WIFI_SECURITY_UNKNOWN = 0xFFFF
}

Wi-Fi security.

enum
SL_WIFI_NO_ENCRYPTION
SL_WIFI_WEP_ENCRYPTION
SL_WIFI_TKIP_ENCRYPTION
SL_WIFI_CCMP_ENCRYPTION
SL_WIFI_EAP_TLS_ENCRYPTION
SL_WIFI_EAP_TTLS_ENCRYPTION
SL_WIFI_EAP_FAST_ENCRYPTION
SL_WIFI_PEAP_MSCHAPV2_ENCRYPTION
}

Wi-Fi encryption method.

enum
SL_WIFI_PSK_CREDENTIAL = 0
SL_WIFI_PMK_CREDENTIAL
SL_WIFI_WEP_CREDENTIAL
SL_WIFI_EAP_CREDENTIAL
}

Wi-Fi Credential.

enum
SL_WIFI_ANTENNA_1
SL_WIFI_ANTENNA_2
SL_WIFI_ANTENNA_AUTO
SL_WIFI_ANTENNA_EXTERNAL
SL_WIFI_ANTENNA_INTERNAL
}

Wi-Fi antenna selections.

enum
SL_WIFI_CLIENT_2_4GHZ_INTERFACE_INDEX = 0
SL_WIFI_AP_2_4GHZ_INTERFACE_INDEX
SL_WIFI_CLIENT_5GHZ_INTERFACE_INDEX
SL_WIFI_AP_5GHZ_INTERFACE_INDEX
SL_WIFI_MAX_INTERFACE_INDEX
}

Wi-Fi interface index enumeration.

enum
SL_WIFI_INVALID_INTERFACE = 0
SL_WIFI_CLIENT_INTERFACE = (1 << 0)
SL_WIFI_AP_INTERFACE = (1 << 1)
SL_WIFI_2_4GHZ_INTERFACE = (1 << 2)
SL_WIFI_5GHZ_INTERFACE = (1 << 3)
SL_WIFI_CLIENT_2_4GHZ_INTERFACE = SL_WIFI_CLIENT_INTERFACE | SL_WIFI_2_4GHZ_INTERFACE
SL_WIFI_AP_2_4GHZ_INTERFACE = SL_WIFI_AP_INTERFACE | SL_WIFI_2_4GHZ_INTERFACE
SL_WIFI_CLIENT_5GHZ_INTERFACE = SL_WIFI_CLIENT_INTERFACE | SL_WIFI_5GHZ_INTERFACE
SL_WIFI_AP_5GHZ_INTERFACE = SL_WIFI_AP_INTERFACE | SL_WIFI_5GHZ_INTERFACE
SL_WIFI_ALL_INTERFACES = SL_WIFI_CLIENT_INTERFACE | SL_WIFI_AP_INTERFACE | SL_WIFI_2_4GHZ_INTERFACE | SL_WIFI_5GHZ_INTERFACE
}

Wi-Fi interface enumeration.

enum
SL_WIFI_DEAUTH
SL_WIFI_DEAUTH_UNSPECIFIED
}

Enumeration of de-authentication reasons from an access point.

enum
SL_WIFI_REGION_AUSTRALIA
SL_WIFI_REGION_FRANCE
SL_WIFI_REGION_EUROPEAN_UNION
SL_WIFI_REGION_JAPAN
SL_WIFI_REGION_UNITED_STATES
}

W-Fi regulatory region.

enum
SL_WIFI_RATE_PROTOCOL_B_ONLY
SL_WIFI_RATE_PROTOCOL_G_ONLY
SL_WIFI_RATE_PROTOCOL_N_ONLY
SL_WIFI_RATE_PROTOCOL_AC_ONLY
SL_WIFI_RATE_PROTOCOL_AX_ONLY
SL_WIFI_RATE_PROTOCOL_AUTO
}

Wi-Fi rate protocols.

enum
SL_WIFI_SCAN_TYPE_ACTIVE = 0x00
SL_WIFI_SCAN_TYPE_PASSIVE = 0x01
SL_WIFI_SCAN_TYPE_PROHIBITED_CHANNELS = 0x04
SL_WIFI_SCAN_TYPE_ADV_SCAN = 0X08
}

Wi-Fi scan types.

enum
SL_WIFI_AUTO_RATE = 0
SL_WIFI_RATE_11B_1
SL_WIFI_RATE_11B_MIN = SL_WIFI_RATE_11B_1
SL_WIFI_RATE_11B_2
SL_WIFI_RATE_11B_5_5
SL_WIFI_RATE_11B_11
SL_WIFI_RATE_11B_MAX = SL_WIFI_RATE_11B_11
SL_WIFI_RATE_11G_6
SL_WIFI_RATE_11G_MIN = SL_WIFI_RATE_11G_6
SL_WIFI_RATE_11G_9
SL_WIFI_RATE_11G_12
SL_WIFI_RATE_11G_18
SL_WIFI_RATE_11G_24
SL_WIFI_RATE_11G_36
SL_WIFI_RATE_11G_48
SL_WIFI_RATE_11G_54
SL_WIFI_RATE_11G_MAX = SL_WIFI_RATE_11G_54
SL_WIFI_RATE_11N_MCS0
SL_WIFI_RATE_11N_MIN = SL_WIFI_RATE_11N_MCS0
SL_WIFI_RATE_11N_MCS1
SL_WIFI_RATE_11N_MCS2
SL_WIFI_RATE_11N_MCS3
SL_WIFI_RATE_11N_MCS4
SL_WIFI_RATE_11N_MCS5
SL_WIFI_RATE_11N_MCS6
SL_WIFI_RATE_11N_MCS7
SL_WIFI_RATE_11N_MAX = SL_WIFI_RATE_11N_MCS7
SL_WIFI_RATE_11AX_MCS0
SL_WIFI_RATE_11AX_MIN = SL_WIFI_RATE_11AX_MCS0
SL_WIFI_RATE_11AX_MCS1
SL_WIFI_RATE_11AX_MCS2
SL_WIFI_RATE_11AX_MCS3
SL_WIFI_RATE_11AX_MCS4
SL_WIFI_RATE_11AX_MCS5
SL_WIFI_RATE_11AX_MCS6
SL_WIFI_RATE_11AX_MCS7
SL_WIFI_RATE_11AX_MAX = SL_WIFI_RATE_11AX_MCS7
SL_WIFI_RATE_INVALID = 0xFF
}

Wi-Fi transfer rates.

enum
SL_WIFI_BSS_TYPE_INFRASTRUCTURE = 0
SL_WIFI_BSS_TYPE_ADHOC = 1
SL_WIFI_BSS_TYPE_ANY = 2
SL_WIFI_BSS_TYPE_UNKNOWN = 0xFF
}

Wi-Fi BSS type.

enum
SL_WIFI_AUTO_BAND = 0
SL_WIFI_BAND_900MHZ = 1
SL_WIFI_BAND_2_4GHZ = 2
SL_WIFI_BAND_5GHZ = 3
SL_WIFI_BAND_6GHZ = 4
SL_WIFI_BAND_60GHZ = 5
}

Wi-Fi radio band.

enum
SL_WIFI_AUTO_BANDWIDTH = 0
SL_WIFI_BANDWIDTH_10MHz = 0
SL_WIFI_BANDWIDTH_20MHz = 1
SL_WIFI_BANDWIDTH_40MHz = 2
SL_WIFI_BANDWIDTH_80MHz = 3
SL_WIFI_BANDWIDTH_160MHz = 4
}
enum
SL_WIFI_NO_JOIN_OPTION = 0
SL_WIFI_JOIN_WITH_NO_CSA = (1 << 0)
SL_WIFI_JOIN_WITH_SCAN = (1 << 1)
}

Option flags for client interfaces.

enum
SL_WIFI_HIDDEN_SSID = (1 << 0)
}

Option flags for AP interfaces.

enum
SL_WIFI_LISTEN_INTERVAL_TIME_UNIT_BEACON
SL_WIFI_LISTEN_INTERVAL_TIME_UNIT_DTIM
}

Listen interval time units.

enum
SL_WIFI_WPS_PIN_MODE
SL_WIFI_WPS_PUSH_BUTTON_MODE
}

Wi-Fi WPS mode.

enum
SL_WIFI_SCAN_RESULT_EVENTS
SL_WIFI_JOIN_EVENTS
SL_WIFI_RX_PACKET_EVENTS
SL_WIFI_COMMAND_RESPONSE_EVENTS
SL_WIFI_STATS_RESPONSE_EVENTS
SL_WIFI_HTTP_OTA_FW_UPDATE_EVENTS
SL_WIFI_NETWORK_DOWN_EVENTS
SL_WIFI_NETWORK_UP_EVENTS
SL_WIFI_CLIENT_CONNECTED_EVENTS
SL_WIFI_TWT_RESPONSE_EVENTS
SL_WIFI_CLIENT_DISCONNECTED_EVENTS
SL_WIFI_EVENT_GROUP_COUNT
SL_WIFI_EVENT_FAIL_INDICATION_EVENTS = (1 << 31)
}

Wi-Fi event group.

enum
SL_WIFI_SCAN_RESULT_EVENT = SL_WIFI_SCAN_RESULT_EVENTS
SL_WIFI_JOIN_EVENT = SL_WIFI_JOIN_EVENTS
SL_WIFI_RX_PACKET_EVENT = SL_WIFI_RX_PACKET_EVENTS
SL_WIFI_COMMAND_RESPONSE_EVENT = SL_WIFI_COMMAND_RESPONSE_EVENTS
SL_WIFI_STATS_RESPONSE_EVENT = SL_WIFI_STATS_RESPONSE_EVENTS
SL_WIFI_HTTP_OTA_FW_UPDATE_EVENT = SL_WIFI_HTTP_OTA_FW_UPDATE_EVENTS
SL_WIFI_NETWORK_DOWN_EVENT = SL_WIFI_NETWORK_DOWN_EVENTS
SL_WIFI_NETWORK_UP_EVENT = SL_WIFI_NETWORK_UP_EVENTS
SL_WIFI_CLIENT_CONNECTED_EVENT = SL_WIFI_CLIENT_CONNECTED_EVENTS
SL_WIFI_TWT_RESPONSE_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS
SL_WIFI_CLIENT_DISCONNECTED_EVENT = SL_WIFI_CLIENT_DISCONNECTED_EVENTS
SL_WIFI_TWT_UNSOLICITED_SESSION_SUCCESS_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (1 << 16)
SL_WIFI_TWT_AP_REJECTED_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (4 << 16)
SL_WIFI_TWT_OUT_OF_TOLERANCE_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (5 << 16)
SL_WIFI_TWT_RESPONSE_NOT_MATCHED_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (6 << 16)
SL_WIFI_TWT_UNSUPPORTED_RESPONSE_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (10 << 16)
SL_WIFI_TWT_TEARDOWN_SUCCESS_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (11 << 16)
SL_WIFI_TWT_AP_TEARDOWN_SUCCESS_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (12 << 16)
SL_WIFI_TWT_FAIL_MAX_RETRIES_REACHED_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (15 << 16)
SL_WIFI_TWT_INACTIVE_DUE_TO_ROAMING_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (16 << 16)
SL_WIFI_TWT_INACTIVE_DUE_TO_DISCONNECT_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (17 << 16)
SL_WIFI_TWT_INACTIVE_NO_AP_SUPPORT_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (18 << 16)
SL_WIFI_RESCHEDULE_TWT_SUCCESS_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (19 << 16)
SL_WIFI_TWT_INFO_FRAME_EXCHANGE_FAILED_EVENT = SL_WIFI_TWT_RESPONSE_EVENTS | (20 << 16)
SL_WIFI_TWT_EVENTS_END = SL_WIFI_TWT_RESPONSE_EVENTS | (21 << 16)
SL_WIFI_STATS_EVENT = SL_WIFI_STATS_RESPONSE_EVENTS | (1 << 16)
SL_WIFI_STATS_AYSNC_EVENT = SL_WIFI_STATS_RESPONSE_EVENTS | (2 << 16)
SL_WIFI_STATS_ADVANCE_EVENT = SL_WIFI_STATS_RESPONSE_EVENTS | (3 << 16)
SL_WIFI_STATS_TEST_MODE_EVENT = SL_WIFI_STATS_RESPONSE_EVENTS | (4 << 16)
SL_WIFI_STATS_MODULE_STATE_EVENT = SL_WIFI_STATS_RESPONSE_EVENTS | (5 << 16)
SL_WIFI_EVENT_FAIL_INDICATION = (1 << 31)
SL_WIFI_INVALID_EVENT = 0xFFFFFFFF
}

Wi-Fi events.

enum
SL_WIFI_SUSPEND_INDEFINITELY
SL_WIFI_SUSPEND_FOR_DURATION
SL_WIFI_RESUME_IMMEDIATELY
}

Enumeration defining actions related to Target Wake Time (TWT).

enum
SL_WIFI_DATA_RATE_1 = 0
SL_WIFI_DATA_RATE_2 = 2
SL_WIFI_DATA_RATE_5_5 = 4
SL_WIFI_DATA_RATE_11 = 6
SL_WIFI_DATA_RATE_6 = 139
SL_WIFI_DATA_RATE_9 = 143
SL_WIFI_DATA_RATE_12 = 138
SL_WIFI_DATA_RATE_18 = 142
SL_WIFI_DATA_RATE_24 = 137
SL_WIFI_DATA_RATE_36 = 141
SL_WIFI_DATA_RATE_48 = 136
SL_WIFI_DATA_RATE_54 = 140
SL_WIFI_DATA_RATE_MCS0 = 256
SL_WIFI_DATA_RATE_MCS1 = 257
SL_WIFI_DATA_RATE_MCS2 = 258
SL_WIFI_DATA_RATE_MCS3 = 259
SL_WIFI_DATA_RATE_MCS4 = 260
SL_WIFI_DATA_RATE_MCS5 = 261
SL_WIFI_DATA_RATE_MCS6 = 262
SL_WIFI_DATA_RATE_MCS7 = 263
SL_WIFI_DATA_RATE_MCS7_SG = 775
}

Macros#

#define

Max number of Access points that can be scanned.

#define

Max number of stations when module is running in access point mode.

#define

Max Length of Wi-Fi PSK credential.

#define

Max Length of Wi-Fi PMK credential.

#define

Max length of Key in WEP security.

#define

Max number of keys for WEP security.

#define

Max Length of User Name in enterprise security.

#define

Max Length of password in enterprise security.

#define

Max Length of certificate key in enterprise security.

#define

Select Internal Antenna for Wi-Fi.

#define

Select External Antenna for Wi-Fi.

#define
SL_WIFI_DEFAULT_INTERFACE sl_wifi_get_default_interface()

Default Wi-Fi interface macro.

#define

Max Wi-Fi roaming trigger interval.

#define

Auto detect channel.

#define

API input checks.

#define

Interface input checks.

Enumeration Documentation#

sl_wifi_security_t#

sl_wifi_security_t

Wi-Fi security.

Note

  • WPA3 Transition mode not currently supported while running as an Access Point.

Enumerator
SL_WIFI_OPEN

Wi-Fi Open security type.

SL_WIFI_WPA

Wi-Fi WPA security type.

SL_WIFI_WPA2

Wi-Fi WPA2 security type.

SL_WIFI_WEP

Wi-Fi WEP security type.

SL_WIFI_WPA_ENTERPRISE

Wi-Fi WPA Enterprise security type.

SL_WIFI_WPA2_ENTERPRISE

Wi-Fi WPA2 Enterprise security type.

SL_WIFI_WPA_WPA2_MIXED

Wi-Fi WPA/WPA2 Mixed security type.

SL_WIFI_WPA3

Wi-Fi WPA3 security type.

SL_WIFI_WPA3_TRANSITION

Wi-Fi WPA3 Transition security type (not currently supported in AP mode)

SL_WIFI_SECURITY_UNKNOWN

Wi-Fi Unknown Security type.


Definition at line 58 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_encryption_t#

sl_wifi_encryption_t

Wi-Fi encryption method.

Note

  • Some encryption types not currently supported in station (STA) mode.

Enumerator
SL_WIFI_NO_ENCRYPTION

Wi-Fi with No Encryption (not currently supported in STA mode)

SL_WIFI_WEP_ENCRYPTION

Wi-Fi with WEP Encryption (not currently supported in STA mode)

SL_WIFI_TKIP_ENCRYPTION

Wi-Fi with TKIP Encryption (not currently supported in STA mode)

SL_WIFI_CCMP_ENCRYPTION

Wi-Fi with CCMP Encryption (not currently supported in STA mode)

SL_WIFI_EAP_TLS_ENCRYPTION

Wi-Fi with Enterprise TLS Encryption.

SL_WIFI_EAP_TTLS_ENCRYPTION

Wi-Fi with Enterprise TTLS Encryption.

SL_WIFI_EAP_FAST_ENCRYPTION

Wi-Fi with Enterprise FAST Encryption.

SL_WIFI_PEAP_MSCHAPV2_ENCRYPTION

Wi-Fi with Enterprise PEAP Encryption.


Definition at line 74 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_credential_type_t#

sl_wifi_credential_type_t

Wi-Fi Credential.

Enumerator
SL_WIFI_PSK_CREDENTIAL

Wi-Fi Personal Credential.

SL_WIFI_PMK_CREDENTIAL

Wi-Fi Pairwise master key.

SL_WIFI_WEP_CREDENTIAL

Wi-Fi WEP Credential.

SL_WIFI_EAP_CREDENTIAL

Wi-Fi Enterprise client Credential.


Definition at line 86 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_antenna_t#

sl_wifi_antenna_t

Wi-Fi antenna selections.

Note

  • Only internal antenna currently supported.

Enumerator
SL_WIFI_ANTENNA_1

Wi-Fi Radio Antenna 1 (not currently supported)

SL_WIFI_ANTENNA_2

Wi-Fi Radio Antenna 2 (not currently supported)

SL_WIFI_ANTENNA_AUTO

Wi-Fi Radio Antenna Auto Selection (not currently supported)

SL_WIFI_ANTENNA_EXTERNAL

Wi-Fi Radio External Antenna (not currently supported)

SL_WIFI_ANTENNA_INTERNAL

Wi-Fi Radio Internal Antenna.


Definition at line 95 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_interface_index_t#

sl_wifi_interface_index_t

Wi-Fi interface index enumeration.

Note

  • 5 GHz interfaces not currently supported.

Enumerator
SL_WIFI_CLIENT_2_4GHZ_INTERFACE_INDEX

Wi-Fi client on 2.4GHz interface.

SL_WIFI_AP_2_4GHZ_INTERFACE_INDEX

Wi-Fi access point on 2.4GHz interface.

SL_WIFI_CLIENT_5GHZ_INTERFACE_INDEX

Wi-Fi client on 5GHz interface (not currently supported)

SL_WIFI_AP_5GHZ_INTERFACE_INDEX

Wi-Fi access point on 5GHz interface (not currently supported)

SL_WIFI_MAX_INTERFACE_INDEX

Used for internally by SDK.


Definition at line 104 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_interface_t#

sl_wifi_interface_t

Wi-Fi interface enumeration.

Enumerator
SL_WIFI_INVALID_INTERFACE

Invalid interface.

SL_WIFI_CLIENT_INTERFACE

Wi-Fi client interface.

SL_WIFI_AP_INTERFACE

Wi-Fi access point interface.

SL_WIFI_2_4GHZ_INTERFACE

2.4GHz radio interface

SL_WIFI_5GHZ_INTERFACE

5GHz radio interface

SL_WIFI_CLIENT_2_4GHZ_INTERFACE

Wi-Fi client interface on 2.4GHz radio.

SL_WIFI_AP_2_4GHZ_INTERFACE

Wi-Fi access point interface on 2.4GHz radio.

SL_WIFI_CLIENT_5GHZ_INTERFACE

Wi-Fi client interface on 5GHz radio.

SL_WIFI_AP_5GHZ_INTERFACE

Wi-Fi access point interface on 5GHz radio.

SL_WIFI_ALL_INTERFACES

All available Wi-Fi interfaces.


Definition at line 113 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_deauth_reason_t#

sl_wifi_deauth_reason_t

Enumeration of de-authentication reasons from an access point.

Enumerator
SL_WIFI_DEAUTH

De-Authentication from radius server.

SL_WIFI_DEAUTH_UNSPECIFIED

Unspecified de-authentication reason.


Definition at line 136 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_regulatory_region_t#

sl_wifi_regulatory_region_t

W-Fi regulatory region.

Note

  • Australia and France regions not currently supported.

Enumerator
SL_WIFI_REGION_AUSTRALIA

Wi-Fi Region Australia (not currently supported)

SL_WIFI_REGION_FRANCE

Wi-Fi Region France (not currently supported)

SL_WIFI_REGION_EUROPEAN_UNION

Wi-Fi Region European Union.

SL_WIFI_REGION_JAPAN

Wi-Fi Region Japan.

SL_WIFI_REGION_UNITED_STATES

Wi-Fi Region United States.


Definition at line 143 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_rate_protocol_t#

sl_wifi_rate_protocol_t

Wi-Fi rate protocols.

Note

  • Recommended value for default behavior is SL_WIFI_RATE_PROTOCOL_AUTO

  • 802.11ac not currently supported.

Enumerator
SL_WIFI_RATE_PROTOCOL_B_ONLY

802.11b rates only (rates go here)

SL_WIFI_RATE_PROTOCOL_G_ONLY

802.11g rates only (rates go here)

SL_WIFI_RATE_PROTOCOL_N_ONLY

802.11n rates only (rates go here)

SL_WIFI_RATE_PROTOCOL_AC_ONLY

802.11ac rates only (rates go here) (not currently supported)

SL_WIFI_RATE_PROTOCOL_AX_ONLY

802.11ax rates only (rates go here)

SL_WIFI_RATE_PROTOCOL_AUTO

Automatic rate selection.


Definition at line 156 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_scan_type_t#

sl_wifi_scan_type_t

Wi-Fi scan types.

Enumerator
SL_WIFI_SCAN_TYPE_ACTIVE

Active scan. Transmit probe requests and listen for responses.

SL_WIFI_SCAN_TYPE_PASSIVE

Passive scan. No active transmissions, listen for AP beacons and probe responses.

SL_WIFI_SCAN_TYPE_PROHIBITED_CHANNELS

Scan channels prohibited by regulatory region.

SL_WIFI_SCAN_TYPE_ADV_SCAN

Advance scanning of Access Points, when module is in connected state.


Definition at line 166 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_rate_t#

sl_wifi_rate_t

Wi-Fi transfer rates.

Enumerator
SL_WIFI_AUTO_RATE

Wi-Fi Auto transfer rate.

SL_WIFI_RATE_11B_1

Wi-Fi 1 Mbps transfer rate for 802.11b.

SL_WIFI_RATE_11B_MIN

Wi-Fi Minimum transfer rate for 802.11b.

SL_WIFI_RATE_11B_2

Wi-Fi 2 Mbps transfer rate for 802.11b.

SL_WIFI_RATE_11B_5_5

Wi-Fi 5.5 Mbps transfer rate for 802.11b.

SL_WIFI_RATE_11B_11

Wi-Fi 11 Mbps transfer rate for 802.11b.

SL_WIFI_RATE_11B_MAX

Wi-Fi Maximum transfer rate for 802.11b.

SL_WIFI_RATE_11G_6

Wi-Fi 6 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_MIN

Wi-Fi Minimum transfer rate for 802.11g.

SL_WIFI_RATE_11G_9

Wi-Fi 9 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_12

Wi-Fi 12 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_18

Wi-Fi 18 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_24

Wi-Fi 24 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_36

Wi-Fi 36 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_48

Wi-Fi 48 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_54

Wi-Fi 54 Mbps transfer rate for 802.11g.

SL_WIFI_RATE_11G_MAX

Wi-Fi Maximum transfer rate for 802.11g.

SL_WIFI_RATE_11N_MCS0

Wi-Fi MCS index 0 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MIN

Wi-Fi Minimum transfer rate for 802.11n.

SL_WIFI_RATE_11N_MCS1

Wi-Fi MCS index 1 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MCS2

Wi-Fi MCS index 2 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MCS3

Wi-Fi MCS index 3 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MCS4

Wi-Fi MCS index 4 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MCS5

Wi-Fi MCS index 5 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MCS6

Wi-Fi MCS index 6 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MCS7

Wi-Fi MCS index 7 transfer rate for 802.11n.

SL_WIFI_RATE_11N_MAX

Wi-Fi Maximum transfer rate for 802.11n.

SL_WIFI_RATE_11AX_MCS0

Wi-Fi MCS index 0 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MIN

Wi-Fi Minimum transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MCS1

Wi-Fi MCS index 1 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MCS2

Wi-Fi MCS index 2 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MCS3

Wi-Fi MCS index 3 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MCS4

Wi-Fi MCS index 4 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MCS5

Wi-Fi MCS index 5 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MCS6

Wi-Fi MCS index 6 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MCS7

Wi-Fi MCS index 7 transfer rate for 802.11ax.

SL_WIFI_RATE_11AX_MAX

Wi-Fi Maximum transfer rate for 802.11ax.

SL_WIFI_RATE_INVALID

Wi-Fi Invalid transfer rate.


Definition at line 175 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_bss_type_t#

sl_wifi_bss_type_t

Wi-Fi BSS type.

Enumerator
SL_WIFI_BSS_TYPE_INFRASTRUCTURE

Wi-Fi BSS Type Infrastructure.

SL_WIFI_BSS_TYPE_ADHOC

Wi-Fi BSS Type ADHOC.

SL_WIFI_BSS_TYPE_ANY

Wi-Fi BSS Type ANY.

SL_WIFI_BSS_TYPE_UNKNOWN

Wi-Fi BSS Type Unknown.


Definition at line 222 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_band_t#

sl_wifi_band_t

Wi-Fi radio band.

Note

  • Only 2.4 GHz currently supported.

Enumerator
SL_WIFI_AUTO_BAND

Wi-Fi Band Auto.

SL_WIFI_BAND_900MHZ

Wi-Fi Band 900Mhz (not currently supported)

SL_WIFI_BAND_2_4GHZ

Wi-Fi Band 2.4Ghz.

SL_WIFI_BAND_5GHZ

Wi-Fi Band 5Ghz (not currently supported)

SL_WIFI_BAND_6GHZ

Wi-Fi Band 6Ghz (not currently supported)

SL_WIFI_BAND_60GHZ

Wi-Fi Band 60Ghz (not currently supported)


Definition at line 231 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_bandwidth_t#

sl_wifi_bandwidth_t

Note

  • Only 20 MHz currently supported.

Enumerator
SL_WIFI_AUTO_BANDWIDTH

Wi-Fi Bandwidth Auto.

SL_WIFI_BANDWIDTH_10MHz

Wi-Fi Bandwidth 10Mhz (not currently supported)

SL_WIFI_BANDWIDTH_20MHz

Wi-Fi Bandwidth 20Mhz.

SL_WIFI_BANDWIDTH_40MHz

Wi-Fi Bandwidth 40Mhz (not currently supported)

SL_WIFI_BANDWIDTH_80MHz

Wi-Fi Bandwidth 80Mhz (not currently supported)

SL_WIFI_BANDWIDTH_160MHz

Wi-Fi Bandwidth 160Mhz (not currently supported)


Definition at line 241 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_client_flag_t#

sl_wifi_client_flag_t

Option flags for client interfaces.

Enumerator
SL_WIFI_NO_JOIN_OPTION

Wi-Fi Client Join with no flags.

SL_WIFI_JOIN_WITH_NO_CSA

Wi-Fi Client Join with no CSA.

SL_WIFI_JOIN_WITH_SCAN

Wi-Fi Client Join with Scan.


Definition at line 251 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_ap_flag_t#

sl_wifi_ap_flag_t

Option flags for AP interfaces.

Enumerator
SL_WIFI_HIDDEN_SSID

Hide SSID of the AP.


Definition at line 258 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_listen_interval_time_unit_t#

sl_wifi_listen_interval_time_unit_t

Listen interval time units.

Enumerator
SL_WIFI_LISTEN_INTERVAL_TIME_UNIT_BEACON

Time units specified in beacon periods.

SL_WIFI_LISTEN_INTERVAL_TIME_UNIT_DTIM

Time units specified in DTIM periods.


Definition at line 263 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_wps_mode_t#

sl_wifi_wps_mode_t

Wi-Fi WPS mode.

Enumerator
SL_WIFI_WPS_PIN_MODE

WPS pin mode.

SL_WIFI_WPS_PUSH_BUTTON_MODE

WPS push button mode.


Definition at line 269 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_event_group_t#

sl_wifi_event_group_t

Wi-Fi event group.

Enumerator
SL_WIFI_SCAN_RESULT_EVENTS

Event group for Wi-Fi scan results.

SL_WIFI_JOIN_EVENTS

Event group for Wi-Fi join status.

SL_WIFI_RX_PACKET_EVENTS

Event group for Wi-Fi received packet. This feature is not supported in current release.

SL_WIFI_COMMAND_RESPONSE_EVENTS

Event group for Wi-Fi command response. This feature is not supported in current release.

SL_WIFI_STATS_RESPONSE_EVENTS

Event group for Wi-Fi statistics response.

SL_WIFI_HTTP_OTA_FW_UPDATE_EVENTS

Event group for Wi-Fi OTA firmware update status via HTTP.

SL_WIFI_NETWORK_DOWN_EVENTS

Event group for Wi-Fi network down. This feature is not supported in current release.

SL_WIFI_NETWORK_UP_EVENTS

Event group for Wi-Fi network up. This feature is not supported in current release.

SL_WIFI_CLIENT_CONNECTED_EVENTS

Event group for Wi-Fi client connected status.

SL_WIFI_TWT_RESPONSE_EVENTS

Event group for Wi-Fi TWT response.

SL_WIFI_CLIENT_DISCONNECTED_EVENTS

Event group for Wi-Fi client disconnection status.

SL_WIFI_EVENT_GROUP_COUNT

Event group for Wi-Fi maximum default group count. Used internally by SDK.

SL_WIFI_EVENT_FAIL_INDICATION_EVENTS

Event group for Wi-Fi fail indication.


Definition at line 275 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_event_t#

sl_wifi_event_t

Wi-Fi events.

Note

  • Each event group has a matching event.

  • Each event group may be a source of multiple different events.

Enumerator
SL_WIFI_SCAN_RESULT_EVENT

Event for Wi-Fi scan result. Data would be of type of sl_wifi_scan_result_t.

SL_WIFI_JOIN_EVENT

Event for Wi-Fi join status. Data would be of type string.

SL_WIFI_RX_PACKET_EVENT

Event for Wi-Fi received packet. This feature is not supported in current release.

SL_WIFI_COMMAND_RESPONSE_EVENT

Event for Wi-Fi command response. This feature is not supported in current release.

SL_WIFI_STATS_RESPONSE_EVENT

Event for Wi-Fi statistics response. Data would be NULL.

SL_WIFI_HTTP_OTA_FW_UPDATE_EVENT

Event for Wi-Fi OTA firmware update status via HTTP. Data would be NULL.

SL_WIFI_NETWORK_DOWN_EVENT

Event for Wi-Fi network down. This feature is not supported in current release.

SL_WIFI_NETWORK_UP_EVENT

Event for Wi-Fi network up. This feature is not supported in current release.

SL_WIFI_CLIENT_CONNECTED_EVENT

Event for Wi-Fi client connected status. Data would be of type sl_mac_address_t.

SL_WIFI_TWT_RESPONSE_EVENT

Event for Wi-Fi TWT response. Data would be NULL.

SL_WIFI_CLIENT_DISCONNECTED_EVENT

Event for Wi-Fi client disconnection status. Data would of type sl_mac_address_t.

SL_WIFI_TWT_UNSOLICITED_SESSION_SUCCESS_EVENT

Event for TWT unsolicited session success. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_AP_REJECTED_EVENT

Event for TWT AP rejection. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_OUT_OF_TOLERANCE_EVENT

Event for TWT out of tolerance. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_RESPONSE_NOT_MATCHED_EVENT

Event for TWT response not matched. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_UNSUPPORTED_RESPONSE_EVENT

Event for TWT unsupported response. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_TEARDOWN_SUCCESS_EVENT

Event for TWT teardown success. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_AP_TEARDOWN_SUCCESS_EVENT

Event for TWT AP teardown success. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_FAIL_MAX_RETRIES_REACHED_EVENT

Event for TWT maximum retries reached. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_INACTIVE_DUE_TO_ROAMING_EVENT

Event for TWT inactive due to roaming. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_INACTIVE_DUE_TO_DISCONNECT_EVENT

Event for TWT inactive due to disconnect. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_INACTIVE_NO_AP_SUPPORT_EVENT

Event for TWT inactive due to no AP support. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_RESCHEDULE_TWT_SUCCESS_EVENT

Event for TWT suspend resume success. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_INFO_FRAME_EXCHANGE_FAILED_EVENT

Event for TWT info frame exchange failure. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_TWT_EVENTS_END

Event for TWT event end. Data would be of type sl_si91x_twt_response_t.

SL_WIFI_STATS_EVENT

Event for Wi-Fi statistics. This feature is not supported in current release.

SL_WIFI_STATS_AYSNC_EVENT

Event for Wi-Fi asynchronous statistics. Data would be of type sl_si91x_async_stats_response_t

SL_WIFI_STATS_ADVANCE_EVENT

Event for Wi-Fi advance statistics. Data would be of type sl_si91x_advance_stats_response_t

SL_WIFI_STATS_TEST_MODE_EVENT

Event for Wi-Fi test mode statistics. This feature is not supported in current release.

SL_WIFI_STATS_MODULE_STATE_EVENT

Event for Wi-Fi module state statistics. Data would be of type sl_si91x_module_state_stats_response_t

SL_WIFI_EVENT_FAIL_INDICATION

Event for Wi-Fi event failure indication.

SL_WIFI_INVALID_EVENT

Invalid Wi-Fi event. Data would be NULL.


Definition at line 294 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_reschedule_twt_action_t#

sl_wifi_reschedule_twt_action_t

Enumeration defining actions related to Target Wake Time (TWT).

Enumerator
SL_WIFI_SUSPEND_INDEFINITELY

Indicates the suspension of TWT for an indefinite period, effectively disabling TWT functionality until explicitly resumed.

SL_WIFI_SUSPEND_FOR_DURATION

Specifies that TWT should be suspended for a specified duration of time, after which it can automatically resume.

SL_WIFI_RESUME_IMMEDIATELY

Signifies an immediate resumption of TWT, allowing devices to continue adhering to TWT schedules.


Definition at line 385 of file components/protocol/wifi/inc/sl_wifi_constants.h

sl_wifi_data_rate_t#

sl_wifi_data_rate_t
Enumerator
SL_WIFI_DATA_RATE_1

Wi-Fi 1 Mbps transfer rate.

SL_WIFI_DATA_RATE_2

Wi-Fi 2 Mbps transfer rate.

SL_WIFI_DATA_RATE_5_5

Wi-Fi 5.5 Mbps transfer rate.

SL_WIFI_DATA_RATE_11

Wi-Fi 11 Mbps transfer rate.

SL_WIFI_DATA_RATE_6

Wi-Fi 6 Mbps transfer rate.

SL_WIFI_DATA_RATE_9

Wi-Fi 9 Mbps transfer rate.

SL_WIFI_DATA_RATE_12

Wi-Fi 12 Mbps transfer rate.

SL_WIFI_DATA_RATE_18

Wi-Fi 18 Mbps transfer rate.

SL_WIFI_DATA_RATE_24

Wi-Fi 24 Mbps transfer rate.

SL_WIFI_DATA_RATE_36

Wi-Fi 36 Mbps transfer rate.

SL_WIFI_DATA_RATE_48

Wif-Fi 48 Mbps transfer rate.

SL_WIFI_DATA_RATE_54

Wi-Fi 54 Mbps transfer rate.

SL_WIFI_DATA_RATE_MCS0

Wi-Fi MCS index 0 transfer rate.

SL_WIFI_DATA_RATE_MCS1

Wi-Fi MCS index 1 transfer rate.

SL_WIFI_DATA_RATE_MCS2

Wi-Fi MCS index 2 transfer rate.

SL_WIFI_DATA_RATE_MCS3

Wi-Fi MCS index 3 transfer rate.

SL_WIFI_DATA_RATE_MCS4

Wi-Fi MCS index 4 transfer rate.

SL_WIFI_DATA_RATE_MCS5

Wi-Fi MCS index 5 transfer rate.

SL_WIFI_DATA_RATE_MCS6

Wi-Fi MCS index 6 transfer rate.

SL_WIFI_DATA_RATE_MCS7

Wi-Fi MCS index 7 transfer rate.

SL_WIFI_DATA_RATE_MCS7_SG

Definition at line 391 of file components/protocol/wifi/inc/sl_wifi_constants.h

Macro Definition Documentation#

SL_WIFI_MAX_SCANNED_AP#

#define SL_WIFI_MAX_SCANNED_AP
Value:
11

Max number of Access points that can be scanned.


Definition at line 18 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_MAX_CLIENT_COUNT#

#define SL_WIFI_MAX_CLIENT_COUNT
Value:
16

Max number of stations when module is running in access point mode.


Definition at line 21 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_MAX_PSK_LENGTH#

#define SL_WIFI_MAX_PSK_LENGTH
Value:
32

Max Length of Wi-Fi PSK credential.


Definition at line 24 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_MAX_PMK_LENGTH#

#define SL_WIFI_MAX_PMK_LENGTH
Value:
64

Max Length of Wi-Fi PMK credential.


Definition at line 27 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_WEP_KEY_LENGTH#

#define SL_WIFI_WEP_KEY_LENGTH
Value:
32

Max length of Key in WEP security.


Definition at line 30 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_WEP_KEY_COUNT#

#define SL_WIFI_WEP_KEY_COUNT
Value:
4

Max number of keys for WEP security.


Definition at line 33 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_EAP_USER_NAME_LENGTH#

#define SL_WIFI_EAP_USER_NAME_LENGTH
Value:
64

Max Length of User Name in enterprise security.


Definition at line 36 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_EAP_PASSWORD_LENGTH#

#define SL_WIFI_EAP_PASSWORD_LENGTH
Value:
128

Max Length of password in enterprise security.


Definition at line 39 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_EAP_CERTIFICATE_KEY_LENGTH#

#define SL_WIFI_EAP_CERTIFICATE_KEY_LENGTH
Value:
80

Max Length of certificate key in enterprise security.


Definition at line 42 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_SELECT_INTERNAL_ANTENNA#

#define SL_WIFI_SELECT_INTERNAL_ANTENNA
Value:
0

Select Internal Antenna for Wi-Fi.


Definition at line 45 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_SELECT_EXTERNAL_ANTENNA#

#define SL_WIFI_SELECT_EXTERNAL_ANTENNA
Value:
1

Select External Antenna for Wi-Fi.


Definition at line 48 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_DEFAULT_INTERFACE#

#define SL_WIFI_DEFAULT_INTERFACE
Value:
sl_wifi_get_default_interface()

Default Wi-Fi interface macro.


Definition at line 51 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_NEVER_ROAM#

#define SL_WIFI_NEVER_ROAM
Value:
0x7FFFFFFF

Max Wi-Fi roaming trigger interval.


Definition at line 54 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_AUTO_CHANNEL#

#define SL_WIFI_AUTO_CHANNEL
Value:
0

Auto detect channel.


Definition at line 416 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_ARGS_CHECK_NULL_POINTER#

#define SL_WIFI_ARGS_CHECK_NULL_POINTER
Value:
{ \
if (ptr == NULL) { \
return SL_STATUS_NULL_POINTER; \
} \
}

API input checks.


Definition at line 419 of file components/protocol/wifi/inc/sl_wifi_constants.h

SL_WIFI_ARGS_CHECK_INVALID_INTERFACE#

#define SL_WIFI_ARGS_CHECK_INVALID_INTERFACE
Value:
{ \
if (!((interface == SL_WIFI_CLIENT_INTERFACE) || (interface == SL_WIFI_CLIENT_INTERFACE) \
|| (interface == SL_WIFI_AP_INTERFACE) || (interface == SL_WIFI_2_4GHZ_INTERFACE))) { \
return SL_STATUS_WIFI_UNKNOWN_INTERFACE; \
} \
}

Interface input checks.


Definition at line 427 of file components/protocol/wifi/inc/sl_wifi_constants.h