Public Attributes#
Bitmap of enabled WLAN features. Refer feature_bit_map.
Bitmap of enabled TCP/IP related features. Refer tcp_ip_feature_bit_map.
Bitmap of enabled custom features. Refer custom custom_feature_bit_map.
Reserved 1.
Reserved 2.
Reserved 3.
Channel number to be scanned in auto join mode. Refer to the PER Mode command section for the supported channels in 2.4GHz and 5 GHz band.
Static IP configured in the device in auto-join or auto-create mode. For auto-join mode, this is valid when dhcp_enable is 0.
Subnet mask,this is valid only if dhcp_enable is 0.
Default gateway, this is valid only if dhcp_enable is 0.
This parameter gives the EAP inner method configured for the device/EAP Client.
User ID in enterprise security mode.
GO Intent Value 0-15 for P2P GO or client, 16 for Soft AP.
PMK key.
AP Configuration information.
WiFi MAC address of the device (6 bytes).
Reserved 4.
Prefix length of IPv6 address.
IPv6 address of device.
IPv6 address of default router (gateway).
Threshold in dBm to trigger the bgscan. After bgscan periodicity, If connected AP RSSI falls below this then bgscan will be triggered.
Time period in seconds to trigger bgscan if RSSI of connected AP is greater than the given bgscan_threshold. Default value is 10 second.
This is active scan duration in ms. The recommended value is 20ms for quicker Background scan operation and uninterrupted throughput.
This is passive scan duration in ms. During a passive scan, if any beacon is received in a channel, then the recommended value for this parameter will be 100ms.
If set to one then module will send two probe request one with specific SSID provided during join command and other with NULL ssid (to scan all the access points)
Used to validate the given scan channel bitmaps. If magic code is 0x4321, then only the scan channel bitmaps are considered as valid.
Channel bitmap for scanning in set of selective channels in 2.4 GHz band.
Channel bitmap for scanning in set of selective channels in 5 GHz band.
This magic code is used to validate the roaming parameters stored in the flash memory. This is not configurable, 0x4321 indicating stored roam parameters are valid.
Roaming parameters stored in the module.
This magic code is used to validate the rejoin parameters stored in the flash memory. If magic code is 0x4321, then rejoin params considered as valid.
reserved_5
A validation flag, (0x4321) indicating stored multicast parameters are valid.
There are two bytes in the command which represent 2 parts. Lower order byte represents the command type and higher order byte is the hash value (6 Bits) generated from the desired multicast mac address (48 Bits) using hash function. Refer to mcast_bitmap_frame.
A validation flag, (0x4321) indicating stored powermode parameters are valid.
Gives the features enabled in Extended custom feature bitmap.
Password to decrypt an encrypted private key used in EAP authentication.
HT (High Throughput) capabilities parameters.
ht_caps_magic_word – Fixed to 0x4321, used to validate the saved stored config info
fast_psp_enable temporarily disables power save during data transfers and re-enables it after a monitor interval of inactivity.
Time in milliseconds to keep device in wakeup state for each Tx or Rx traffic sent or received respectively. Default value for this is 50 ms.
Magic word of request time out. Is fixed to 0x4321 in TA side.
Timeout value used with timeout_bitmap to get timeout durations.
DHCPv4 mode enable or disable.
IPv4 address of the device in AP mode.
Sub-net mask.
Default gateway for the AP in AP mode.
DHCP mode (has to be zero) for AP in IPv6.
prefix length of IPv6 address in AP mode.
IPv6 address of device in AP mode.
IPv6 address of default router in AP mode.
Exteneded TCP/IP feature bitmap.
HTTP server username.
HTTP server password.
Public Attribute Documentation#
cfg_enable#
uint8_t cfg_enable
Configuration enable/disable for auto-join or auto-create modes
0x00 - Auto-join/create modes disabled (primary configuration)
0x01 - Auto-join/create modes enabled (primary configuration)
0x03 - Auto-join/create modes disabled (secondary configuration, not supported in SAPI)
0x04 - Auto-join/create modes enabled (secondary configuration, not supported in SAPI)
opermode#
uint8_t opermode[4]
WiFi operating mode configuration
0 - Client/Station mode
1 - Wi-Fi Direct/P2P mode (not supported)
2 - Enterprise Client mode with EAP
6 - Access Point mode
8 - Transmit test mode
9 - Concurrent mode
tcp_ip_feature_bit_map#
uint8_t tcp_ip_feature_bit_map[4]
Bitmap of enabled TCP/IP related features. Refer tcp_ip_feature_bit_map.
custom_feature_bit_map#
uint8_t custom_feature_bit_map[4]
Bitmap of enabled custom features. Refer custom custom_feature_bit_map.
band#
uint8_t band
Operating band 0x00 - device configured to operate in 2.4 GHz - 0x01 - device configured to operate in 5 GHz
0x02 - Dual band(2.4 GHz and 5GHz). Dual band is valid in station mode
scan_feature_bitmap#
uint8_t scan_feature_bitmap
Scan feature bitmap for scan behavior
BIT[0]: Quick scan feature (1 - To enable quick scan feature, 0 - To disable quick scan feature).
BIT[1-7]: Reserved
join_ssid#
uint8_t join_ssid[RSI_SSID_LEN]
SSID of the AP for auto-join mode (34-byte buffer, null-terminated string).
If actual length < 32 bytes, 0x00 filler bytes appended to make the buffer length 34 bytes.
uRate#
uint8_t uRate
Data rate configured in the module.
0=Auto, 1-4=802.11b rates (1,2,5.5,11 Mbps), 5-12=802.11g rates (6,9,12,18,24,36,48,54 Mbps),
13-20=802.11n MCS rates (MCS0-MCS7). Values > 20 are rejected.
If 802.11b disabled and rate < 5 provided, defaults to 6 Mbps.
uTxPower#
uint8_t uTxPower
Tx power to be configured in the device.
At 2.4GHz: 0 – Low power (7 +/- 1) dBm 1 – Medium power (10 +/- 1)dBm 2 – High power (18 +/- 2)dBm
At 5 GHz: 0 – Low power (5 +/- 1) dBm 1 – Medium power (7 +/- 1) dBm 2 – High power (12 +/- 2) dBm
scan_ssid_len#
uint8_t scan_ssid_len
Length of SSID in scan_ssid array (uint8_t, range 0-32).
0 = Broadcast scan (scan all APs), 1-32 = Directed scan (scan for specific SSID).
csec_mode#
uint8_t csec_mode
Security mode used to connect to an Access Point in auto-join mode
0 – Open mode
1 – WPA security
2 – WPA2 Security
3 – WEP security
4 – Enterprise WPA security
5 – Enterprise WPA2 security
6 – WPA/WPA2 mixed security
7 – WPA3 Personal Mode Security
8 – WPA3 Personal Transition Mode Security
psk#
uint8_t psk[RSI_PSK_LEN]
Pre-shared key of the access point to which module wants to associate in auto-join
Filler bytes of 0x00 are added to make it 64 bytes if the original PSK is less than 64 bytes
scan_ssid#
uint8_t scan_ssid[RSI_SSID_LEN]
SSID for directed scan operations (34 byte buffer).
If the actual length is not 32 bytes, 0x00 filler bytes are appended to make the length 34 bytes.
If scan_ssid_len = 0, broadcast scan is performed.
If scan_ssid_len > 0, only APs matching this SSID are scanned.
Stored as binary data (may not be null-terminated).
scan_cnum#
uint8_t scan_cnum
Channel number to be scanned in auto join mode. Refer to the PER Mode command section for the supported channels in 2.4GHz and 5 GHz band.
dhcp_enable#
uint8_t dhcp_enable
Controls how the device gets its IPv4 address in auto‑join mode
0x00 - DHCP client is disabled in device (auto-join mode)
0x01 - DHCP client is enabled in device (auto-join mode)
ip#
uint8_t ip[IP_ADDRESS_SZ]
Static IP configured in the device in auto-join or auto-create mode. For auto-join mode, this is valid when dhcp_enable is 0.
eap_method#
uint8_t eap_method[32]
EAP method string for Enterprise security mode (32-byte null-terminated ASCII).
Valid values: "TLS", "TTLS", "PEAP", "FAST", "LEAP".
inner_method#
uint8_t inner_method[32]
This parameter gives the EAP inner method configured for the device/EAP Client.
passwd#
uint8_t passwd[128]
The password configured for the user identity on the RADIUS server for enterprise authentication.
Filler bytes of 0x00 are used to make the length 128 bytes, of the original length is less than 128 bytes.
device_name#
uint8_t device_name[64]
Name of the GO device, meant only for P2P.
Note: P2P is not supported
operating_channel#
uint8_t operating_channel[2]
The channel on which the device operates after becoming a Group Owner (GO) in P2P Note: P2P is not supported
ssid_postfix#
uint8_t ssid_postfix[64]
Postfix data to add to the SSID in Wi-Fi Direct (P2P) mode
This data will be added to the end of the SSID after the DIRECT-<random two octets> prefix.
Note: P2P is not supported
antenna_select#
uint8_t antenna_select[2]
Selected antenna
0 - Built‑in / inbuilt antenna selected
1 - UFL connector (external antenna) selected
wep_key#
rsi_wepkey wep_key
WEP key in the module to connect to an AP with WEP security.
There are two modes in which a WEP key can be set in an Access Point- WEP (hex) mode and WEP (ASCII) mode. The module supports WEP (hex) mode only.
dhcp6_enable#
uint8_t dhcp6_enable[2]
0x00 – Indicates that the device uses static IPv6 address provided by the user
0x01 – Indicates that the device uses IPv6 address either derived using SLAAC method or DHCPv6 process based on the DHCPv6 server configuration.
tcp_stack_used#
uint8_t tcp_stack_used
Shows which TCP stack is used, this is a bitmap.
BIT(0)- If set indicates IPv4 Stack is in use
BIT(1) – If set indicates IPv6 Stack is in use
bgscan_magic_code#
uint8_t bgscan_magic_code[2]
This magic code is used to validate the bgscan parameter present in flash memory. It is not configurable.
(0x4321) indicates stored bg scan parameters are valid
bgscan_threshold#
uint8_t bgscan_threshold[2]
Threshold in dBm to trigger the bgscan. After bgscan periodicity, If connected AP RSSI falls below this then bgscan will be triggered.
rssi_tolerance_threshold#
uint8_t rssi_tolerance_threshold[2]
This is difference of last RSSI of connected AP and current RSSI of connected AP.
Here last RSSI is the RSSI calculated at the last beacon received and current RSSI is the RSSI calculated at current beacon received.
If this difference is more than rssi_tolerance_threshold then bgscan will be triggered irrespective of periodicity.
bgscan_periodicity#
uint8_t bgscan_periodicity[2]
Time period in seconds to trigger bgscan if RSSI of connected AP is greater than the given bgscan_threshold. Default value is 10 second.
active_scan_duration#
uint8_t active_scan_duration[2]
This is active scan duration in ms. The recommended value is 20ms for quicker Background scan operation and uninterrupted throughput.
passive_scan_duration#
uint8_t passive_scan_duration[2]
This is passive scan duration in ms. During a passive scan, if any beacon is received in a channel, then the recommended value for this parameter will be 100ms.
multi_probe#
uint8_t multi_probe
If set to one then module will send two probe request one with specific SSID provided during join command and other with NULL ssid (to scan all the access points)
chan_bitmap_magic_code#
uint8_t chan_bitmap_magic_code[2]
Used to validate the given scan channel bitmaps. If magic code is 0x4321, then only the scan channel bitmaps are considered as valid.
scan_chan_bitmap_stored_2_4_GHz#
uint8_t scan_chan_bitmap_stored_2_4_GHz[4]
Channel bitmap for scanning in set of selective channels in 2.4 GHz band.
scan_chan_bitmap_stored_5_GHz#
uint8_t scan_chan_bitmap_stored_5_GHz[4]
Channel bitmap for scanning in set of selective channels in 5 GHz band.
roam_magic_code#
uint8_t roam_magic_code[2]
This magic code is used to validate the roaming parameters stored in the flash memory. This is not configurable, 0x4321 indicating stored roam parameters are valid.
rejoin_magic_code#
uint8_t rejoin_magic_code[2]
This magic code is used to validate the rejoin parameters stored in the flash memory. If magic code is 0x4321, then rejoin params considered as valid.
rejoin_param_stored#
rsi_rejoin_params_t rejoin_param_stored
rejoin_param_stored stores user configured rejoin parameters.
This is updated from the user input and will be configured to the TA using RSI_WLAN_RSP_USER_STORE_CFG command.
We can configure values like rsi_max_try – max rejoin try count rsi_scan_interval, rsi_beacon_missed_count
region_request_from_host#
uint8_t region_request_from_host
If this variable is 1, region of the device is set either in auto join or auto create mode based on the opermode.
0 – Disable set region in Auto create or Auto join mode
1 – Enable set region in Auto create or Auto join mode
rsi_region_code_from_host#
uint8_t rsi_region_code_from_host
Enable/Disable set region code from user.
If opermode is 0 or 2:
0 - Disable. Use the region information from beacon (country IE)
1 - Enable. Use the region information from user command
If opermode is 6:
0 - Disable. Get the region information based on region code from internal memory
region_code#
uint8_t region_code
If the region code is given as 0, US domain is considered by default and device is configured according to the US domain regulations.
1 - US domain
2 - Europe domain
3 - Japan Domain
4 -Rest of world
5 - Korea Domain
multicast_magic_code#
uint8_t multicast_magic_code[2]
A validation flag, (0x4321) indicating stored multicast parameters are valid.
multicast_bitmap#
uint8_t multicast_bitmap[2]
There are two bytes in the command which represent 2 parts. Lower order byte represents the command type and higher order byte is the hash value (6 Bits) generated from the desired multicast mac address (48 Bits) using hash function. Refer to mcast_bitmap_frame.
powermode_magic_code#
uint8_t powermode_magic_code[2]
A validation flag, (0x4321) indicating stored powermode parameters are valid.
powermode#
uint8_t powermode
powermode variable configures the powersave mode of the device.
Below are the configurable powersave values on 9116.
2 - Connected Powersave.
8 - Unconnected power save with RAM Retention
10 - Unconnected power save mode without RAM Retention
ulp_mode#
uint8_t ulp_mode
1 - Low power mode.
2 - Ultra low power mode with RAM retention.
3 - Ultra low power mode without RAM retention.
Refer section Powersave operation for detail description about powersave operation.
wmm_ps_magic_code#
uint8_t wmm_ps_magic_code[2]
This magic code is used to validate the WMM powersave parameters stored in the flash memory.(0x4321) indicating stored parameters are valid Note: WMM PS is not supported
wmm_ps_enable#
uint8_t wmm_ps_enable
To enable or disable WMM PS
0 - Disable, 1 - Enable Note: WMM PS is not supported
wmm_ps_wakeup_interval#
uint8_t wmm_ps_wakeup_interval[4]
Wakeup interval in milliseconds. Note: WMM PS is not supported
wmm_ps_uapsd_bitmap#
uint8_t wmm_ps_uapsd_bitmap
0 to 15 possible values.
wmm_ps_uapsd_bitmap[0] Access category: Voice
wmm_ps_uapsd_bitmap[1] Access category: Video
wmm_ps_uapsd_bitmap[2] Access category: background
wmm_ps_uapsd_bitmap[3] Access category: Best effort U-APSD
wmm_ps_uapsd_bitmap[4:7] All set to 0 / Don't care Note: WMM PS is not supported
listen_interval#
uint8_t listen_interval[4]
This is valid only if BIT(1) in join_feature_bitmap is set. This value is given in Time units (1024 microseconds).
This parameter gives the listen interval configured in power save mode
listen_interval_dtim#
uint8_t listen_interval_dtim
This parameter is valid only if BIT(1) is set in the join_feature_bitmap and valid listen interval is given in join command.
If this parameter is set, the device computes the desired sleep duration based on listen interval (from join command) and its wakeup align with Beacon or DTIM Beacon (based on this parameter).
0 - device wakes up before nearest Beacon that does not exceed the specified listen interval time.
1 - device wakes up before nearest DTIM Beacon that does not exceed the specified listen interval time.
ext_custom_feature_bit_map#
uint8_t ext_custom_feature_bit_map[4]
Gives the features enabled in Extended custom feature bitmap.
private_key_password#
uint8_t private_key_password[82]
Password to decrypt an encrypted private key used in EAP authentication.
join_bssid#
uint8_t join_bssid[6]
BSSID for BSSID-based join feature (6 bytes)
This is connected AP MAC address when BSSID-based join is enabled and used during auto-config restore to automatically reconnect.
join_feature_bitmap#
uint8_t join_feature_bitmap
BIT[0] - To enable b/g only mode in station mode
BIT[1] - To take listen interval from join command
BIT[2] - To enable quick join feature
BIT[3] - To enable CCXV2 feature
BIT[4] - To connect to AP based on BSSID
BIT[5] - Management Frame Protection Capable only(802.11W)
BIT[6] - Management Frame Protection required(802.11W)
BIT[7] - listen interval from power save command
ht_caps_magic_word#
uint8_t ht_caps_magic_word[2]
ht_caps_magic_word – Fixed to 0x4321, used to validate the saved stored config info
fast_psp_enable#
uint8_t fast_psp_enable
fast_psp_enable temporarily disables power save during data transfers and re-enables it after a monitor interval of inactivity.
monitor_interval#
uint8_t monitor_interval[2]
Time in milliseconds to keep device in wakeup state for each Tx or Rx traffic sent or received respectively. Default value for this is 50 ms.
request_timeout_magic_word#
uint8_t request_timeout_magic_word[2]
Magic word of request time out. Is fixed to 0x4321 in TA side.
timeout_value#
uint8_t timeout_value[2]
Timeout value used with timeout_bitmap to get timeout durations.
timeout_bitmap#
uint8_t timeout_bitmap[4]
bitmap[0] - timeout for association and authentication request in ms.
bitmap[1] - each channel active scan time in ms
bitmap[2] - WLAN keep alive timeout in seconds
bitmap[3] - Passive scan dwell time in ms
bitmap[31-4] - Reserved (not used)
http_credentials_avail#
uint8_t http_credentials_avail
HTTP server credentials availability indicator.
This field indicates the source of HTTP server authentication credentials (username/password).
0 - No HTTP credentials available (default)
1 - HTTP credentials available in runtime (stored in TCP/IP control block)
2 - HTTP credentials stored in saved configuration (flash memory)