Opermode Parameters#

In rsi_wireless_init() API, configured feature bitmaps are internally processed and sent to firmware. Default configurations (for reference) are available in rsi_wlan_common_config.h. Based on the features required for a specific example, modify the rsi_wlan_config.h provided in the respective example folder. The following configuration parameters are used to configure feature bitmaps.

RSI_FEATURE_BIT_MAP#

This bitmap is used to enable the following WLAN features.


feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`feature_bit_map[0]`	`FEAT_SECURITY_OPEN`	Open mode feature	Disable	Enable	Supported in client mode
`feature_bit_map[1]`	`FEAT_SECURITY_PSK`	PSK security	Disable	Enable	Supported in client mode
`feature_bit_map[2]`	`FEAT_AGGREGATION`	Aggregation	Disable	Enable
`feature_bit_map[3]`	`FEAT_LP_GPIO_BASED_HANDSHAKE`	LP GPIO hand shake	Disable	Enable
`feature_bit_map[4]`	`FEAT_ULP_GPIO_BASED_HANDSHAKE`	ULP GPIO hand shake	Disable	Enable
`feature_bit_map[5]`	`FEAT_DEV_TO_HOST_ULP_GPIO_1`	Reserved	Reserved	Reserved
`feature_bit_map[6]`	`FEAT_RF_SUPPY_VOL_3_3_VOLT`	Reserved	Reserved	Reserved
`feature_bit_map[7]`	`FEAT_WPS_DISABLE`	WPS support	Enable	Disable
`feature_bit_map[8]`	`FEAT_EAP_LEAP_IN_COEX`	To support EAP/LEAP in Wi-Fi + BT Coex mode	Disable	Enable
`feature_bit_map[9]`	`FEAT_HIDE_PSK_CREDENTIALS`	To hide PSK, PMK and EAP credentials from the user	Disable	Enable
`feature_bit_map[10:31]`	-	Reserved. Should be set to `0`

Note!feature_bit_map[0], feature_bit_map[1] are valid only in Wi-Fi Client mode.

RSI_TCP_IP_FEATURE_BIT_MAP#

To enable TCP/IP related features.


tcp_ip_feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`tcp_ip_feature_bit_map[0]`	`TCP_IP_FEAT_BYPASS`	TCP/IP bypass	Disable	Enable
`tcp_ip_feature_bit_map[1]`	`TCP_IP_FEAT_HTTP_SERVER`	HTTP server	Disable	Enable
`tcp_ip_feature_bit_map[2]`	`TCP_IP_FEAT_DHCPV4_CLIENT`	DHCPv4 client	Disable	Enable
`tcp_ip_feature_bit_map[3]`	`TCP_IP_FEAT_DHCPV6_CLIENT`	DHCPv6 client	Disable	Enable
`tcp_ip_feature_bit_map[4]`	`TCP_IP_FEAT_DHCPV4_SERVER`	DHCPv4 server	Disable	Enable
`tcp_ip_feature_bit_map[5]`	`TCP_IP_FEAT_DHCPV6_SERVER`	DHCPv6 server	Disable	Enable
`tcp_ip_feature_bit_map[6]`	`TCP_IP_FEAT_JSON_OBJECTS`	Dynamic update of web pages (JSON objects)	Disable	Enable
`tcp_ip_feature_bit_map[7]`	`TCP_IP_FEAT_HTTP_CLIENT`	HTTP client	Disable	Enable
`tcp_ip_feature_bit_map[8]`	`TCP_IP_FEAT_DNS_CLIENT`	DNS client	Disable	Enable
`tcp_ip_feature_bit_map[9]`	`TCP_IP_FEAT_SNMP_AGENT`	SNMP agent	Disable	Enable
`tcp_ip_feature_bit_map[10]`	`TCP_IP_FEAT_SSL`	SSL/TLS	Disable	Enable
`tcp_ip_feature_bit_map[11]`	`TCP_IP_FEAT_ICMP`	PING from device (ICMP)	Disable	Enable
`tcp_ip_feature_bit_map[12]`	`TCP_IP_FEAT_HTTPS_SERVER`	HTTPS Server	Disable	Enable	Only supported in opermode `0`
`tcp_ip_feature_bit_map[13]`	-	Set to `0`
`tcp_ip_feature_bit_map[14]`	`TCP_IP_FEAT_SEND_CONFIGS_TO_HOST`	To send configuration details to host on submitting configurations on wireless configuration page	Disable	Enable
`tcp_ip_feature_bit_map[15]`	`TCP_IP_FEAT_FTP_CLIENT`	FTP client	Disable	Enable
`tcp_ip_feature_bit_map[16]`	`TCP_IP_FEAT_SNTP_CLIENT`	SNTP client	Disable	Enable
`tcp_ip_feature_bit_map[17]`	`TCP_IP_FEAT_IPV6`	IPv6 mode	Disable	Enable	IPv6 will also get enabled if DHCP v6 client/DHCP v6 server is enabled irrespective of `tcp_ip_feature_bit_map[17]`
`tcp_ip_feature_bit_map[18]`	`TCP_IP_FEAT_RAW_DATA`	RAW Socket feature	Disable	Enable	This feature is supported only in AP mode. `TCP_BYPASS` feature should be disabled for this feature to be supported. If any packet from host with frame type `0x1` is received by firmware, the packet will be sent on air without TCP/IP stack processing. ARP and broadcast packets (other than DHCP packets) which are coming on air will be sent to host
`tcp_ip_feature_bit_map[19]`	`TCP_IP_FEAT_MDNSD`	To MDNS and DNS-SD	Disable	Enable
`tcp_ip_feature_bit_map[20]`	`TCP_IP_FEAT_SMTP_CLIENT`	SMTP client	Disable	Enable
`tcp_ip_feature_bit_map[21:24]`	`TCP_IP_TOTAL_SOCKETS_1 TCP_IP_TOTAL_SOCKETS_2 TCP_IP_TOTAL_SOCKETS_3 TCP_IP_TOTAL_SOCKETS_4 TCP_IP_TOTAL_SOCKETS_5 TCP_IP_TOTAL_SOCKETS_6 TCP_IP_TOTAL_SOCKETS_7 TCP_IP_TOTAL_SOCKETS_8 TCP_IP_TOTAL_SOCKETS_9 TCP_IP_TOTAL_SOCKETS_10`	To select no of sockets
`tcp_ip_feature_bit_map[25]`	`TCP_IP_FEAT_SINGLE_SSL_SOCKET`	Single SSL/TLS socket	Disable	Enable
`tcp_ip_feature_bit_map[26]`	`TCP_IP_FEAT_LOAD_PUBLIC_PRIVATE_CERTS`	Private & Public certificate	Disable	Enable	If Secure handshake is with CA-certificate alone , then disable loading private and public keys and erase these certificates from the flash using load_cert API. Or if Secure handshake is needed for verification of Private and Public keys , then enable loading of private and public keys.
`tcp_ip_feature_bit_map[27]`	`TCP_IP_FEAT_LOAD_CERTS_INTO_RAM`	SSL/TLS certificate on to the RAM	Disable	Enable
`tcp_ip_feature_bit_map[28]`	Not defined	TCP-IP data packet Dump on UART2	Disable	Enable
`tcp_ip_feature_bit_map[29]`	`TCP_IP_FEAT_POP3_CLIENT`	POP3 client	Disable	Enable
`tcp_ip_feature_bit_map[30]`	`TCP_IP_FEAT_OTAF`	Enable OTAF (Over-the-Air Firmware) update.	Disable	Enable
`tcp_ip_feature_bit_map[31]`	`TCP_IP_FEAT_EXTENSION_VALID`	`tcp_ip_ext_feature_bitmap` validity	Disable	Enable

Note! A feature selection spreadsheet is provided in the WiSeConnect SDK. The device supports the selected combination of features only if it is feasible as per WiSeConnect_TCPIP_Feature_Selection_vx.x.x.xlsx.

RSI_CUSTOM_FEATURE_BIT_MAP#

This bitmap is used to enable following custom features.


custom_feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`custom_feature_bit_map[0]`	-	Reserved			Set to `0`
`custom_feature_bit_map[1]`	-	Reserved			Set to `0`
`custom_feature_bit_map[2]`	`CUSTOM_FEAT_DISABLE_GATEWAY_IN_RSI_AP`	If this bit is set to `1`, the DHCP server behavior changes when the device is in AP mode. The DHCP server, when it assigns IP addresses to the client nodes, does not send out a Gateway address, and sends only the assigned IP and Subnet values to the client. It is highly recommended to keep this value at '0' as the changed behavior is required in only very specialized use cases and not in normal AP functionality. The default value of this bit is '0'.
`custom_feature_bit_map[3]`	-	Reserved			Set to `0`
`custom_feature_bit_map[4]`	`CUSTOM_FEAT_SOC_CLK_CONFIG_160MHZ`	To run NWP (Network Processor) at Higher clock frequency (160 MHz)	Disable	Enable	Need to set pll_mode to `1` in feature frame command
`custom_feature_bit_map[5]`	`CUSTOM_FEAT_AP_IN_HIDDEN_MODE`	Hidden SSID in AP mode	Disable	Enable
`custom_feature_bit_map[6]`	`CUSTOM_FEAT_DNS_SERVER_IN_DHCP_OFFER`	DNS server IP address in DHCP offer response in AP mode.	Disable	Enable
`custom_feature_bit_map[7]`	-	Reserved			Set to `0`
`custom_feature_bit_map[8]`	`CUSTOM_FEAT_DFS_CHANNEL_SUPPORT`	DFS channel passive scan support	Disable	Enable	it's mandatory to set region before scanning DFS channel.
`custom_feature_bit_map[10]`	`CUSTOM_FEAT_ASYNC_CONNECTION_STATUS`	Asynchronous messages to host to indicate the device state.	Disable	Enable
`custom_feature_bit_map[11]`	`CUSTOM_FEAT_WAKE_ON_WIRELESS`	Packet pending wake on wireless indication in UART mode	Disable	Enable
`custom_feature_bit_map[12]`	`CUSTOM_FEAT_ENABLE_AP_BLACKLIST`	Bypass AP Blacklist in client mode	Disable	Enable	By default client maintains AP blacklist internally to avoid some access points. To bypass AP blacklist feature in client mode during roaming or rejoin, this feature should be enabled.
`custom_feature_bit_map[17]`	`CUSTOM_FEAT_ROAM_WITH_DEAUTH_OR_NULLDATA`	To select between de-authentication or null data (with power management bit set) based roaming.Depending on selected method station, it will send de-auth or Null data to the connected AP when roaming from connected AP to the newly selected AP.	Disable	Enable
`custom_feature_bit_map[18]`	-	Reserved			Set to `0`
`custom_feature_bit_map[19]`	-	Reserved			Set to `0`
`custom_feature_bit_map[20]`	`CUSTOM_FEAT_TRIGGER_AUTO_CONFIG`	Trigger Auto Configuration	Disable	Enable
`custom_feature_bit_map[21]`	-	Reserved			Set to `0`
`custom_feature_bit_map[22]`	`CUSTOM_FEAT_LIMIT_PACKETS_PER_STA`	Used to enable per station power save packet buffer limit in AP mode.When enabled, only two packets per station will be buffered when station is in power save	Disable	Enable
`custom_feature_bit_map[23]`	`CUSTOM_FEAT_HTTP_HTTPS_AUTH`	HTTP/HTTPs authentication	Disable	Enable
`custom_feature_bit_map[24]`	`CUSTOM_FEAT_SOC_CLK_CONFIG_120MHZ`	To run the network processor on the device at a Higher clock frequency (120 MHz)	Disable	Enable	Need to set pll_mode to `1` in feature frame command
`custom_feature_bit_map[25]`	`CUSTOM_FEAT_HTTP_SERVER_CRED_TO_HOST`	HTTP server credentials to host in get configuration command	Disable	Enable
`custom_feature_bit_map[26]`	`CUSTOM_FEAT_REJECT_CONNECT_REQ_IMMEDIATELY`	To accept or reject new connection request when maximum clients are connected in case of LTCP.	Disable	Enable	By default this bit value is zero. When `BIT[26] = 0`: For a LTCP socket when maximum clients are connected if a new connection request is received, then this connection request will not be rejected. Instead device will maintain this connection request in LTCP pending list. This request will be served when any of the connected client is disconnected. When `BIT[26] = 1`: For a LTCP socket when maximum clients are connected if a new connection request is received, then this connection request will be rejected immediately. Device will not maintain this connection request in LTCP pending list.
`custom_feature_bit_map[27]`	`CUSTOM_FEAT_DUAL_BAND_ROAM_VCSAFD`	Dual band roaming and vcsafd feature	Disable	Enable
`custom_feature_bit_map[28]`	`CUSTOM_FEAT_RTC_FROM_HOST`	Real time clock from host	Disable	Enable
`custom_feature_bit_map[29]`	`CUSTOM_FEAT_BT_IAP`	IAP support in BT mode	Disable	Enable
`custom_feature_bit_map[30]`	-	Reserved			Set to `0`
`custom_feature_bit_map[31]`	`FEAT_CUSTOM_FEAT_EXTENTION_VALID`	ext_custom_feat_bitmap validity	Disable	Enable

RSI_EXT_CUSTOM_FEATURE_BIT_MAP#

This feature bitmap is an extension of custom_feature_bit_map and is valid only if custom_feature_bit_map[31] = 1. This enables the following features.


ext_custom_feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`ext_custom_feature_bit_map[0]`	Not defined	Antenna diversity feature.	Disable	Enable
`ext_custom_feature_bit_map[1]`	`EXT_FEAT_RSA_KEY_WITH_4096_SUPPORT`	Reserves memory for EAP certificates with 4096 bit RSA keys.	Disable	Enable	This bit is required to be set for 4096 bit RSA key support. This bit does not denote feature enable/disable, i.e., eap connection with 4096 key certs may establish even though this bit is disabled if memory is available due to any reason. If key size is 4096 bit, device will use software routine for exponentiation, so connection time will increase.
`ext_custom_feature_bit_map[2]`	-	Reserved
`ext_custom_feature_bit_map[3]`	`EXT_FEAT_SSL_CERT_WITH_4096_KEY_SUPPORT`	SSL/TLS certificate with 4096 bit key support	Disable	Enable
`ext_custom_feature_bit_map[4]`	`EXT_FEAT_AP_BROADCAST_PKT_SND_B4_DTIM`	This bit is applicable only in AP and concurrent AP mode. If this bit is set, the device will send broadcast data (if any) immediately without waiting for DTIM.	Disable (AP sends broadcast packet at DTIM only.)	Enable (Enable sending broadcast without waiting for DTIM)	If this bit is enable then connected client who is in power save may miss the packet.
`ext_custom_feature_bit_map[5]`	`EXT_FEAT_FCC_LOW_PWR`	Pre authentication Support.	Disable	Enable
`ext_custom_feature_bit_map[6]`	-	Reserved
`ext_custom_feature_bit_map[7:8]`	-	Reserved
`ext_custom_feature_bit_map[9]`	`EXT_HTTP_SKIP_DEFAULT_LEADING_CHARACTER`	`EXT_HTTP_SKIP_DEFAULT_LEADING_CHARACTER`. To skip default leading character ("\") in resource name
`ext_custom_feature_bit_map[10]`	-	Reserved
`ext_custom_feature_bit_map[11]`	`EXT_FEAT_ENABLE_11R_OTA`	802.11R Over the Air Roaming Support	Disable	Enable	1. Resource Request Support is not Present. 2. If both BIT[11] and BIT[16] are not enabled then it will select as Legacy Roaming.
`ext_custom_feature_bit_map[12]`	`EXT_FEAT_IEEE_80211J`	802.11J support.	Disable	Enable	If this bit is enable, set region command is mandatory with setting it to Japan region and band value must be 1 (5GHz).
`ext_custom_feature_bit_map[13]`	`EXT_FEAT_IEEE_80211W`	802.11W support.	Disable	Enable	This bit must be set for enabling WPA3 Personal Mode and WPA3 Personal Transition mode.
`ext_custom_feature_bit_map[14]`	`EXT_FEAT_SSL_VERSIONS_SUPPORT`	TLS Multiple versions Support in SSL.	Disable	Enable
`ext_custom_feature_bit_map[15]`	`EXT_FEAT_16th_STATION_IN_AP_MODE`	Support 16 Stations in AP Mode.			If this bit is enable then 16 stations can connect in AP mode otherwise Maximum of 8 stations can connect.
`ext_custom_feature_bit_map[16]`	`EXT_FEAT_ENABLE_11R_ODS`	802.11R Over the Distributed System Roaming Support			1. Resource Request Support is not Present. 2. If both BIT[11] and BIT[16] are not enabled then it will select as Legacy Roaming.
`ext_custom_feature_bit_map[17:18]`	-	Reserved
`ext_custom_feature_bit_map[19]`	`EXT_FEAT_LOW_POWER_MODE`	Low power mode in GPIO based or M4 based ULP power save			EXT_FEAT_LOW_POWER_MODE is not supported for 1.3 version chipset.
`ext_custom_feature_bit_map[20:21]`	`EXT_FEAT_320K_MODE EXT_FEAT_256K_MODE BIT EXT_FEAT_384K_MODE`	Default memory configuration (RAM) is 192KB. User can set these bits to change the memory configuration as below: 384k memory configuration is applicable only in WiSeConnect product mode.
`ext_custom_feature_bit_map[22:23]`	`EXT_FEAT_XTAL_CLK_ENABLE`	To configure sleep clock source selection, either crystal clock or RC clock		If `BIT[23] = 1` and `BIT[22] = 0` in ext_custom_feature_bit_map, then user has to use `UULP_GPIO_0` for sleep indication to host.
`ext_custom_feature_bit_map[24]`	`EXT_FEAT_HOMEKIT_WAC_ENABLED`	Reserved
`ext_custom_feature_bit_map[25]`	`EXT_FEAT_1P8V_SUPPORT`	To enable 1.8v supply for TA	Disable	Enable
`ext_custom_feature_bit_map[26]`	Not defined	To enable 3.3v supply for TA	Disable	Enable
`ext_custom_feature_bit_map[27]`	`EXT_FEAT_UART_SEL_FOR_DEBUG_PRINTS`	To select UART port for the device network Processor debug prints	Disable (Enable debug prints on `UART2`)	Enable (Enable debug prints on `UART1` and is applicable only if Host Interface is not UART)	By default all the debug prints from device network processor will be coming on UART2 if this bit is not enabled. `UART1` pins are mapped to the following pins w.r.t to the device network processor. User needs to ensure that these pins are not used in MCU applications in SoC mode to avoid conflicts of pins usage based on the requirement. This bit is valid only if `BIT[28]` in ext_custom_feature_bit_map is set to `0`. `UART1-TX: GPIO_9 UART1-RX: GPIO_8 UART2-TX: GPIO_6 UART2-RX: GPIO_10` There is no functionality on rx pins for debug prints.
`ext_custom_feature_bit_map[28]`	`EXT_FEAT_DISABLE_DEBUG_PRINTS`	UART debug prints from device network processor	Disable (Enable debug prints)	Enable (Disable debug prints on either `UART1` or `UART2`)
`ext_custom_feature_bit_map[29:30]`	-	Reserved
`ext_custom_feature_bit_map[31]`	Not defined	BT and BLE Feature_Bit_Map validity	Disable	Enable

RSI_EXT_TCPIP_FEATURE_BITMAP#


ext_tcp_ip_feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`ext_tcp_ip_feature_bit_map[1]`	`EXT_TCP_FEAT_DHCP_OPT77`	DHCP USER CLASS	Disable	Enable
`ext_tcp_ip_feature_bit_map[2]`	`EXT_TCP_IP_HTTP_SERVER_BYPASS`	HTTP server root path bypass	Disable	Enable
`ext_tcp_ip_feature_bit_map[3]`	`EXT_TCP_IP_BI_DIR_ACK_UPDATE`	Correcting the ACK sequence number in the TCP packet retransmission path	Disable	Enable	Need to enable this bit if user wants to run the bi-directional data transfer.
`ext_tcp_ip_feature_bit_map[4]`	`EXT_TCP_IP_WINDOW_DIV`	To enable TCP ACK division factor feature	Disable	Enable
`ext_tcp_ip_feature_bit_map[5]`	`EXT_TCP_IP_CERT_BYPASS`	Reserved.
`ext_tcp_ip_feature_bit_map[6]`	`EXT_TCP_IP_SSL_16K_RECORD`	Support for SSL/TLS 16K record size	Disable	Enable
`ext_tcp_ip_feature_bit_map[7]`	`EXT_TCP_IP_DNS_CLIENT_BYPASS`	To enable DNS_CLIENT_BYPASS by host	Disable	Enable
`ext_tcp_ip_feature_bit_map[8]`	`EXT_TCP_IP_WINDOW_SCALING`	To enable TCP window scaling feature	Disable	Enable	If this feature is not enabled, then the maximum possible rx window size is 64 KB. If user wants to use more than 64KB window size, `tcp_rx_window_size_cap` in rsi_socket_config() is used to increase the window size.
`ext_tcp_ip_feature_bit_map[9]`	`EXT_TCP_IP_DUAL_MODE_ENABLE`	To enable Dual Mode feature	Disable	Enable	Enabling this feature allows to use both bypass and non bypass modes simultaneously.
`ext_tcp_ip_feature_bit_map[10]`	`EXT_TCP_IP_ETH_WIFI_BRIDGE`	To enable Ethernet wifi bridge feature	Disable	Enable
`ext_tcp_ip_feature_bit_map[11]`	`EXT_DYNAMIC_COEX_MEMORY`	To enable the dynamic coex memory	Disable	Enable	To enable or disable the coex and update TCP RX window accordingly.
`ext_tcp_ip_feature_bit_map[12:15]`	`EXT_TCP_IP_TOTAL_SELECTS_1 EXT_TCP_IP_TOTAL_SELECTS_2 EXT_TCP_IP_TOTAL_SELECTS_3 EXT_TCP_IP_TOTAL_SELECTS_4 EXT_TCP_IP_TOTAL_SELECTS_5 EXT_TCP_IP_TOTAL_SELECTS_6 EXT_TCP_IP_TOTAL_SELECTS_7 EXT_TCP_IP_TOTAL_SELECTS_8 EXT_TCP_IP_TOTAL_SELECTS_9 EXT_TCP_IP_TOTAL_SELECTS_10`	Configures the number of selects	Disable	Enable
`ext_tcp_ip_feature_bit_map[16]`	`EXT_TCP_IP_WAIT_FOR_SOCKET_CLOSE`	To enable socket wait close	Disable	Enable	If it is set socket will not be closed until the shutdown is called from host. Refer to rsi_shutdown(). It is recommended to enable this bit when using TCP sockets.
`ext_tcp_ip_feature_bit_map[17]`	`EXT_EMB_MQTT_ENABLE`	To enable MQTT feature	Disable	Enable	If user wants to use AT command for MQTT, enable this bit in the Opermode Command
`ext_tcp_ip_feature_bit_map[18]`	`EXT_TCP_IP_FEAT_SSL_HIGH_PERFORMANCE`	To enable HTTP OTAF Feature	Disable	Enable	To do firmware upgrade with HTTP this bit should be enabled
`ext_tcp_ip_feature_bit_map[19:28]`	-	Reserved
`ext_tcp_ip_feature_bit_map[29]`	`EXT_TCP_IP_FEAT_SSL_THREE_SOCKETS`	Enable three SSL/TLS sockets	Disable	Enable	Set `tcp_ip_feature_bit_map[31]` and `ext_tcp_ip_feature_bit_map[29]` to open 3 TLS sockets
`ext_tcp_ip_feature_bit_map[30]`	`EXT_TCP_IP_FEAT_SSL_MEMORY_CLOUD`	To configure additional memory for SSL/TLS connection typically to a cloud server	Disable	Enable	If user connects to a cloud server using two SSL/TLS connections then it is required to set this bit to avoid 0xD2 error
`ext_tcp_ip_feature_bit_map[31]`	`CONFIG_FEAT_EXTENTION_VALID`	config_feature_bit_map validity	Disable	Enable

Note!

The three SSL/TLS socket feature is only supported in Opermode WLAN.
The total number of TLS sockets opened includes sockets opened by the host application and internal sockets.

RSI_BT_FEATURE_BITMAP#

This bitmap is valid only if BIT[31] of extended custom feature bit map is set to 1.


bt_feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`bt_feature_bit_map[0]`	`BT_BDR_MODE_ENABLE`	BT Mode Enable	Disable	Enable	If this Bit sets, then our Controller will sends/receives the packets in 1Mbps mode. Else, Controller will be operatable in both BR/EDR mode
`bt_feature_bit_map[1]`	`BT_BDR_MODE_LP_CHAIN_ENABLE`	BT Mode LP Chain Enable	Disable	Enable
`bt_feature_bit_map[2]`	`BT_PWR_CTRL`	BT Power Control Disable	Enable	Disable	To make Fixed/Adaptive Power
`bt_feature_bit_map[3:7]`	Not defined	Reserved
`bt_feature_bit_map[8]`	`BT_EDR_3MBPS_DISABLE`	BT EDR 3Mbps Feature Disable	Enable	Disable	3Mbps Disable means using 2Mbps DataRate
`bt_feature_bit_map[9]`	`BT_EDR_2MBPS_DISABLE`	BT EDR 2Mbps Feature Disable	Enable	Disable	2Mbps Disable means using 3Mbps DataRate
`bt_feature_bit_map[10]`	`BT_5_SLOT_PACKETS_DISABLE`	BT 5 Slot Packet Feature Disable	Enable	Disable	Disabling 5 Slot Packets
`bt_feature_bit_map[11]`	`BT_3_SLOT_PACKETS_DISABLE`	BT 3 Slot Packet Feature Disable	Enable	Disable	Disabling 3 Slot Packets
`bt_feature_bit_map[12]`	Not defined	Noise Figure Feature	Disable	Enable	Note! This feature is not supported in the current release
`bt_feature_bit_map[13]`	Not defined	SNIFF Feature Disable	Enable	Disable	Note! This feature is not supported in the current release
`bt_feature_bit_map[14]`	`TA_BASED_ENCODER_ENABLE`	TA based encoder	Disable	Enable	To Enable/Disable SBC Encoder in Firmware. Note! This feature is not supported in the current release
`bt_feature_bit_map[15]`	Not defined	HFP profile bit enable	Disable	Enable	Note! This feature is not supported in the current release
`bt_feature_bit_map[16:19]`	Not defined	Reserved for future use
`bt_feature_bit_map[20:22]`	Not defined	number of secondaries supported by BT			Maximum no of bt secondaries: 1
`bt_feature_bit_map[23]`	`A2DP_PROFILE_ENABLE`	A2DP profile bit enable	Disable	Enable
`bt_feature_bit_map[24]`	`A2DP_SOURCE_ROLE_ENABLE`	A2DP profile role selection	Disable	Enable
`bt_feature_bit_map[25]`	`A2DP_ACCELERATOR_MODE_ENABLE`	A2DP accelerated mode selection	Disable	Enable	Note! This feature is not supported in the current release
`bt_feature_bit_map[26]`	Not defined	A2DP i2s mode selection	Disable	Enable	Note! This feature is not supported in the current release
`bt_feature_bit_map[27]`	`BT_BLE_CP_BUFF_SIZE`	enable Buffer Alignment for Test Mode	Disable	Enable	To get 512 bytes from common pool, need to enable this, else 320 bytes will be fixed
`bt_feature_bit_map[28]`	Not defined	Reserved
`bt_feature_bit_map[29]`	Not defined	Att Over Classic Enable	Disable	Enable	Note! This feature is not supported in the current release
`bt_feature_bit_map[30]`	`BT_RF_TYPE\ilinebr </td> <td class="markdownTableBodyLeft"> RF Type selection\ilinebr </td> <td class="markdownTableBodyLeft"> Disable\ilinebr </td> <td class="markdownTableBodyLeft"> Enable\ilinebr </td> <td class="markdownTableBodyLeft"> Enable to use Internal Antenna and Disable to use External Antenna\ilinebr </td> </tr> <tr class="markdownTableRowOdd"> <td class="markdownTableBodyLeft">`bt_feature_bit_map[31]`\ilinebr </td> <td class="markdownTableBodyLeft">`ENABLE_BLE_PROTOCOL`	ble_feature_bit_map is valid only when this bit is set	Disable	Enable

RSI_BLE_FEATURE_BIT_MAP#

This bitmap is valid only if BIT[31] of bt_feature_bit_map is set.


ble_feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`ble_feature_bit_map[0:7]`	`RSI_BLE_MAX_NBR_ATT_REC`	BLE nbr of attributes,			Maximum No of BLE attributes = 80, refer NOTE given below for more info
`ble_feature_bit_map[8:11]`	`RSI_BLE_MAX_NBR_ATT_SERV`	BLE number of GATT services			Maximum no services - 10, refer NOTE given below for more info
`ble_feature_bit_map[12:15]`	`RSI_BLE_MAX_NBR_SLAVES`	BLE number of peripherals			Maximum No of BLE peripherals = 8, refer NOTE given below for more info
`ble_feature_bit_map[16:23]`	`RSI_BLE_PWR_INX`	BLE Tx power index			Give 31 as BLE Tx power index (eg: 31<<16) This variable is used to select the BLE tx power index value. The following are the possible values. Default Value for BLE Tx Power Index is 31 Range for the BLE Tx Power Index is 1 to 75 (0, 32 index is invalid) 1 - 31 BLE -0DBM Mode 33 - 63 BLE- 10DBM Mode 64- 75 BLE - HP Mode.
`ble_feature_bit_map[24:26]`	`RSI_BLE_PWR_SAVE_OPTIONS`	BLE powersave options `BLE_DISABLE_DUTY_CYCLING(0) BLE_DUTY_CYCLING BIT(24) BLR_DUTY_CYCLING BIT(25) BLE_4X_PWR_SAVE_MODE BIT(26)`			Default `BLE_DISABLE_DUTY_CYCLING`Note! This feature is not supported in the current release
`ble_feature_bit_map[27:28]`	`RSI_BLE_MAX_NBR_MASTERS`	Number of Masters			Maximum number of BLE Masters = 2. refer to the note below for more info.
`ble_feature_bit_map[29]`	`RSI_BLE_GATT_ASYNC_ENABLE`	GATT SYNC BIT	Disable	Enable	Default Disabled Expectation of GATT Async Bit Enable: Response structure will be filled in the Event and Event will come later. Not in sync with response for query command.
`ble_feature_bit_map[30]`	Not defined	Reserved	Disable	Enable
`ble_feature_bit_map[31]`	Not defined	ble_custom_ext_feature_bit_map is valid only when this bit is set	Disable	Enable

RSI_BLE_CUSTOM_EXT_FEATURE_BIT_MAP#

This bitmap is valid only if BIT[31] of ble_feature_bit_map map is set.


ble_custom_ext_feature_bit_map	Macro defined in SAPI	Functionality	Set to `0`	Set to `1`	Additional Notes
`ble_custom_ext_feature_bit_map[0:4]`	`RSI_BLE_NUM_CONN_EVENTS`	BLE number of Connection Events			Describes the number of buffers need to be allocated for BLE on the opermode. By default each role (central/peripheral) will be allocated with 1 buffer for the notify/write command We increase the buffer capacity for the notify/write cmds to achive the best throughput. See rsi_ble_set_wo_resp_notify_buf_info() to set more buffers for the notify/write commands
`ble_custom_ext_feature_bit_map[5:12]`	`RSI_BLE_NUM_REC_BYTES`	BLE number of record size in bytes (n)			Note!`n*16 : (n=60, Default 1024 bytes(1K))`
`ble_custom_ext_feature_bit_map[13]`	`RSI_BLE_GATT_INIT`	`GATT INIT`			0 - GATT Init in Firmware i.e both the GAP service and GATT service will be maintained by Firmware 1 - Gatt Init in Host i.e GAP service and GATT service should be created by the APP/Host/User and the ATT transactions like read, write, notify and indicate shall be handled by the APP/Host/User. Default Gatt Init in Firmware
`ble_custom_ext_feature_bit_map[14]`	`RSI_BLE_INDICATE_CONFIRMATION_FROM_HOST`	Indication response from APP	Disable	Enable	Default Disabled Note! As per ATT protocol for every indication received from the server should be acknowledged (indication response) by the Client. If this bit is disabled then firmware will send the acknowledgment(indication response) and if the bit is enabled then APP/Host/User needs to send the acknowledgment(indication response).
`ble_custom_ext_feature_bit_map[15]`	`RSI_BLE_MTU_EXCHANGE_FROM_HOST`	MTU Exchange request initiation from APP	Disable	Enable	Default Disabled. If this bit is disabled, the firmware will initiate the MTU request to the remote device on the successful connection. And if Peer initiates MTU exchange Request then firmware will send Exchange MTU Response in reply to a received Exchange MTU Request. If this bit enabled then APP/Host/User need to initiate the MTU request by using the rsi_ble_mtu_exchange_event API. And if Peer initiates MTU exchange Request then APP/Host/User shall send Exchange MTU Response in reply to a received Exchange MTU Request using rsi_ble_mtu_exchange_resp API
`ble_custom_ext_feature_bit_map[16]`	`RSI_BLE_SET_SCAN_RESP_DATA_FROM_HOST`	Set SCAN Resp Data from APP	Disable	Enable	Default Disabled . Device will maintain some default scan reponse data and will be used in the scan_response controller frame. By enabling this bit we can make the defalut data as Null(empty).
`ble_custom_ext_feature_bit_map[17]`	`RSI_BLE_DISABLE_CODED_PHY_FROM_HOST`	Disable Coded PHY from APP	Disable	Enable	Default Disabled. Device will support the LE-coded phy feature (i.e LR - 125kbps and 500kbps) by default. If this bit is enabled, the device will not the support of the LE-coded phy rates.
`ble_custom_ext_feature_bit_map[18:31]`	Not defined	Reserved

Note! If bt_feature_bit_map[31] = 1:

User can enter maximum of 8 BLE peripherals.
User can enter maximum of 2 BLE centrals.
Maximum of 10 services in total can exist out of which two services namely GAP and GATT are added by default. So if this bitmap has value 10 user can add upto 8 services.
Maximum of 80 attributes in total can exist out of which ten attributes of GAP and GATT are added by default. So if this bitmap has value 80 user can add upto 70 attributes.
RSI_BLE_NUM_CONN_EVENTS >= RSI_BLE_MAX_NBR_SLAVES + RSI_BLE_MAX_NBR_MASTERS.

If bt_feature_bit_map[31] = 0:

Default number of BLE peripherals supported is 3.
Default number of BLE centrals supported is 1.
Maximum of 5 services in total can exist out of which two services namely GAP and GATT are added by default. So user can add upto 3 services.
Maximum of 20 attributes in total can exist out of which ten attributes of GAP and GATT are added by default. So user can add upto 10 attributes.

RSI_CONFIG_FEATURE_BITMAP#

This bitmap is valid only if ext_tcp_ip_feature_bit_map[31] is set.


config_feature_bit_map	Macro defined in SAPI	Functionality	Set to 0	Set to 1	Note and info
`config_feature_bit_map[0]`	`RSI_FEAT_SLEEP_GPIO_SEL_BITMAP`	To select wakeup indication to host. If it is disabled `UULP_GPIO_3` is used as a wakeup indication to host. If it is enabled `UULP_GPIO_0` is used as a wakeup indication to host.	Disable	Enable
`config_feature_bit_map[5:2]`	`RSI_FEAT_DVS_SEL_CONFIG_1 RSI_FEAT_DVS_SEL_CONFIG_2 RSI_FEAT_DVS_SEL_CONFIG_3 RSI_FEAT_DVS_SEL_CONFIG_4`			These bits are used for dynamic voltage selection
`config_feature_bit_map[9:6]`	`RSI_EXTERNAL_PMU_GOOD_TIME_100us RSI_EXTERNAL_PMU_GOOD_TIME_200us RSI_EXTERNAL_PMU_GOOD_TIME_300us RSI_EXTERNAL_PMU_GOOD_TIME_400us RSI_EXTERNAL_PMU_GOOD_TIME_500us RSI_EXTERNAL_PMU_GOOD_TIME_600us RSI_EXTERNAL_PMU_GOOD_TIME_700us RSI_EXTERNAL_PMU_GOOD_TIME_800us RSI_EXTERNAL_PMU_GOOD_TIME_900us RSI_EXTERNAL_PMU_GOOD_TIME_1000us RSI_EXTERNAL_PMU_GOOD_TIME_1100us RSI_EXTERNAL_PMU_GOOD_TIME_1200us RSI_EXTERNAL_PMU_GOOD_TIME_1300us RSI_EXTERNAL_PMU_GOOD_TIME_1400us RSI_EXTERNAL_PMU_GOOD_TIME_1500us`			These bits are used to select external PMU good time.1 to 15 means 100usec to 1500usec (in 100usec granularity)
`config_feature_bit_map[11:10]`	`RSI_FEAT_EXTERNAL_LDO_SEL BIT RSI_FEAT_EXTERNAL_LDO_VOL`			These bits are used for External LDO selection External PMU : 1.In case of External PMU, User has to set EXTERNAL_PMU_GOOD_TIME_CONFIGURATION value to external PMU good time, If this is zero then it indicates using Internal PMU. 2. Incase of External PMU 1.0v or 1.05v, User has to set both the bits config_feature_bit_map[11] & config_feature_bit_map[10].
`config_feature_bit_map[13:12]`	Not defined			If these bits are not set, then by default UULP_GPIO_0 will be used.
`config_feature_bit_map[14]`	`RSI_FEAT_EAP_TLS_V1P0`	To select EAP TLS 1.0 version	Disable	Enable
`config_feature_bit_map[15]`	`RSI_FEAT_EAP_TLS_V1P2`	To select EAP TLS 1.2 version	Disable	Enable
`config_feature_bit_map[16]`	Not defined	Active high or low interrupt mode selection for wake on wireless operation If it is disabled active low interrupt is used in wake on wireless operation. If it is enabled active high interrupt is used in wake on wireless operation.	Disable	Enable
`config_feature_bit_map[17]`	`FEAT_CONC_STA_AP_DYN_SWITCH_SEL`	Reserved
`config_feature_bit_map[18]`	`ULP_GPIO9_FOR_UART2_TX`	To select `ULP_GPIO_9` as `UART2` port for device network processor debug prints	Disable	Enable	If this bit is not set, then by default `UART2-TX GPIO_6` will be used.
`config_feature_bit_map[19]`	`RSI_FEAT_DISABLE_MCS_5_6_7_DATARATES`	To disable `MCS-5,6,7` data rates	Disable	Enable
`config_feature_bit_map[20]`	`RSI_FEAT_DISABLE_SHORT_GI`	To disable Short-GI	Disable	Enable
`config_feature_bit_map[21]`	`PTA_3WIRE_EN`	To enable PTA-3WIRE	Disable	Enable	Should be set to enable and use the PTA 3 wire feature followed by available configurations
`config_feature_bit_map[23:22]`	`PTA_3WIRE_CONFIG_SEL`	To choose PTA-3WIRE config1 config2 config3	Configurability options for config selection among 1,2 & 3	0 kept reserved for future. 3wire used at dut as ULP_GPIO_0(Grant pin driven by dut), ULP_GPIO_1(Request i/p pin for dut) and ULP_GPIO_6(Priority i/p pin for dut)
`config_feature_bit_map[25:24]`	`RSI_XTAL_GOODTIME_1000us RSI_XTAL_GOODTIME_2000us RSI_XTAL_GOODTIME_3000us RSI_XTAL_GOODTIME_600us`	Configurability options for 40 MHz XTAL good time in us.		These bits are used to select XTAL good time. These changes are available from Release 2.3.0 onwards. Release prior to 2.3.0 these config_feature_bitmap[31:17] are reserved. Its only applicable for customers using chip not the device. Contact Support for more details Default value is 1000 us.
`config_feature_bit_map[26]`	`ENABLE_ENHANCED_MAX_PSP`	To enable Enhanced Max PSP	Disable	Enable	Enabling this and setting psp_type to Fast PSP will enable Enhanced Max PSP.
`config_feature_bit_map[31:27]`	-	Reserved for LMAC

Note! 32KHz external clock connection and power save pins

From May 2019, the 32KHz external clock and the power save pins connections changed. To keep software compatibility between initial designs and new designs, there are currently 2 options for connecting the 32KHz external clock and the power save pins:

Option 1 External 32KHz clock connection pins : XTAL_32KHZ_P & XTAL_32KHZ_N Power Save connection pins : HOST_BYP_ULP_WAKEUP & UULP_VBAT_GPIO_3

Option 2 External 32KHz clock connection pin : UULP_VBAT_GPIO_3 Power Save connection pins : HOST_BYP_ULP_WAKEUP & UULP_VBAT_GPIO_0

Option 2 must be used for External 32KHz external clock and Power save connections in new designs.

Other Configuration Parameters#

Scan Parameters#


Macro	Usage
`RSI_SCAN_CHANNEL_BIT_MAP_2_4`	To select channels in 2.4GHz band for selective channel scan. This macro is valid only if channel 0 is selected in rsi_wlan_scan API.
`RSI_SCAN_CHANNEL_BIT_MAP_5`	To select channels in 5GHz band to do selective channel scan. This macro is valid only if channel 0 is selected in rsi_wlan_scan API.
`RSI_SCAN_FEAT_BITMAP`	`RSI_ENABLE_QUICK_SCAN` - If enabled, module scans for the AP given in scan API and posts the scan results immediately to the host after finding the access point. This bit is valid only if specific channel and ssid to scan is given.`RSI_SCAN_RESULTS_TO_HOST` - if enabled additional scan results are given to host, but after getting scan results host has to issue another scan request with this bit disabled before join.

AP Mode Parameters#


Macro	Usage
`RSI_AP_KEEP_ALIVE_ENABLE`	To Enable keep alive functionality in AP mode.
`RSI_AP_KEEP_ALIVE_TYPE`	`RSI_NULL_BASED_KEEP_ALIVE` – To perform keep alive by sending Null data packet to stations `RSI_DEAUTH_BASED_KEEP_ALIVE` – To perform keep alive based on packets received from stations within time out.
`RSI_AP_KEEP_ALIVE_PERIOD`	To configure keep alive period.
`RSI_MAX_STATIONS_SUPPORT`	To configure maximum stations supported.

US Domain Regulations#


Rule No	Band	First Channel	#channels	Last Channel	Max power in dBm	Scan type
1	2.4GHz	1	11	11	27	Active
2	5GHz	36	4	48	16	Active
3	5GHz	52	4	64	23	Passive
4	5GHz	100	5	116	23	Passive
5	5GHz	132	3	140	23	Passive
6	5GHz	149	5	165	29	Active

Europe Domain Regulations#


Rule No	Band	First Channel	#channels	Last Channel	Max power in dBm	Scan type
1	2.4GHz	1	13	13	20	Active
2	5GHz	36	4	48	23	Active
3	5GHz	52	4	64	23	Passive
4	5GHz	100	10	140	30	Passive

Japan Domain Regulations#


Rule No	Band	First Channel	#channels	Last Channel	Max power in dBm	Scan type
1	2.4GHz	1	13	13	20	Active
2	5GHz	36	4	48	20	Active
3	5GHz	52	4	64	20	Passive
4	5GHz	100	10	140	30	Passive

Korea Domain Regulations#


Rule No	Band	First Channel	#channels	Last Channel	Max power in dBm	Scan type
1	2.4GHz	1	13	13	20	Active
2	5GHz	36	4	48	20	Active
3	5GHz	52	4	64	20	Passive
4	5GHz	100	11	140	30	Passive
5	5GHz	149	5	165	30	Active

Set Region Parameters#


Macro	Usage
`RSI_SET_REGION_SUPPORT`	Enable to send set region command during Wi-Fi client connection.
`RSI_SET_REGION_FROM_USER_OR_BEACON`	1 - region configurations taken from user. 0 - region configurations taken from beacon.
`RSI_REGION_CODE`	0 - Default Region domain 1 - `US` 2 - `EUROPE` 3 - `JAPAN` 4 - `WORLDWIDE`

Note!

For RS9116AC0 and RS9116AC1 module as STA :-
- Region configuration from user is not allowed.
- In 2.4GHz, USA is configuerd as default country domain and in addition to this, channels 12 and 13 are passively scanned.
- Country inforamtion is updated as per connecting AP's beacon before authentication.
- Upon disconnection with the AP, STA will switch to USA domain along with channels 12 and 13 are passively scanned.
- While doing passive scan (channel 12 and 13) if any beacon is found in that channel STA will switch to active scan.

- If there is no country IE in the beacon of the AP to which STA is going to connect, STA will switch to USA/EU country based on the channel in which the AP exists. For example if the AP in channel between 1 to 11, STA will configure to USA else if the current channel number is 12 or 13 STA will be configured to EU.#

Set Region AP Parameters#


Macro	Usage
`RSI_SET_REGION_AP_SUPPORT`	Enable to send set region AP command during AP start.
`RSI_SET_REGION_AP_FROM_USER`	1 - region configurations taken from user. 0 - region configurations taken from firmware.
`RSI_COUNTRY_CODE`	Country code which is supposed to be in Upper case. If the first parameter is 1, the second parameter should be one of the these 'US','EU','JP' country codes

Note!

If the country code's length is two characters, then the 3rd character should be a <space>.
For RS9116AC0/RS9116AC1 module as AP:-
- Region configuration from user is not allowed.
- USA is configured as default country.

- In concurrent mode, country domain is configured to that of AP's country domain to which the STA has connected.#

Rejoin Parameters#


Macro	Usage
`RSI_REJOIN_PARAMS_SUPPORT`	Enable to send rejoin parameters command during Wi-Fi client connection.
`RSI_REJOIN_MAX_RETRY`	To set number of retries to be attempted.Note: If this macro is 0, rejoin is retried infinite times.
`RSI_REJOIN_SCAN_INTERVAL`	To set periodicity of rejoin attempt.
`RSI_REJOIN_BEACON_MISSED_COUNT`	To set the number of beacons missed before triggering rejoin process.
`RSI_REJOIN_FIRST_TIME_RETRY`	`ENABLE` or `DISABLE` retry for the first time join failure.

BG Scan Parameters#


Macro	Usage
`RSI_BG_SCAN_SUPPORT`	Enable to send BG scan command after Wi-Fi client connection.
`RSI_BG_SCAN_ENABLE`	To enable or disable BG Scan.
`RSI_INSTANT_BG`	Enable or disable instant BG scan.
`RSI_BG_SCAN_THRESHOLD`	This is the threshold in dBm to trigger the BG scan.
`RSI_RSSI_TOLERANCE_THRESHOLD`	This is the minimum difference between the last RSSI of connected AP and the current RSSI of connected AP to trigger a BG scan irrespective of BG scan periodicity. Here, last `RSSI` is the `RSSI` calculated at the last beacon received and current RSSI is the RSSI calculated at current beacon received.
`RSI_BG_SCAN_PERIODICITY`	To set the periodicity of BG scan in seconds.
`RSI_ACTIVE_SCAN_DURATION`	This is the active scan duration per channel in milli seconds.
`RSI_PASSIVE_SCAN_DURATION`	This is the passive scan duration per DFS channel in 5GHz in milli seconds.
`RSI_MULTIPROBE`	If it is 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).

Roaming Parameters#


Macro	Usage
`RSI_ROAMING_SUPPORT`	Enable to send roaming command after Wi-Fi client connection.
`RSI_ROAMING_THRESHOLD`	If connected AP, `RSSI` falls below this then module will search for new AP from background scanned list.
`RSI_ROAMING_HYSTERISIS`	If module found new AP with same configuration (SSID, Security etc) and if (connected_AP_RSSI – Selected_AP_RSSI ) is greater than `RSI_ROAMING_HYSTERISIS` then it will try to roam to the new selected AP.

Note!

WLAN - RS9116 supports Wi-Fi L2 roaming.
Selection of 'sending de authentication' or 'informing Power save' to the connected AP while roaming can be done by CUSTOM_FEAT_ROAM_WITH_DEAUTH_OR_NULLDATA flag in RSI_CUSTOM_FEATURE_BIT_MAP bitmap. By default de authentication will be sent.

HT capabilities#


Macro	Usage
`RSI_MODE_11N_ENABLE`	Enable to send Ht capabilities command during AP start.
`RSI_HT_CAPS_BIT_MAP`	Bit map corresponding to high throughput capabilities. ht_caps_bit_map[10:15]: All set to '0' ht_caps_bit_map[8:9]:Rx STBC support 00- Rx `STBC` support disabled 01- Rx `STBC` support enabled ht_caps_bit_map[6:7]: Set to '0' ht_caps_bit_map[5]: short GI for 20Mhz support 0- short GI for 20Mhz support disabled 1- short GI for 20Mhz support enabled ht_caps_bit_map[4]: Green field support 0 -Green field support disabled 1 -Green field support enabled ht_caps_bit_map[0:3]:Set to '0'

Enterprise Mode Parameters#


Macro	Usage
`RSI_EAP_METHOD`	Should be one among `TLS`, `TTLS`, `FAST` or `PEAP`. It should be `ASCII` character string.
`RSI_EAP_INNER_METHOD`	This field is valid only in `TTLS/PEAP`. In case of `TTLS/PEAP`, the supported inner methods are `MSCHAP/MSCHAPV2`. In case of `TLS/FAST`, it should be fixed to `MSCHAPV2`.

Join Parameters#


Macro	Usage
`RSI_POWER_LEVEL`	This fixes the Transmit Power level of the module. This value can be set as follows: 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
`RSI_JOIN_FEAT_BIT_MAP`	BIT[0]: To enable b/g only mode in station mode, host has to set this bit. 0 – b/g/n mode enabled in station mode. 1 – b/g only mode enabled in station mode BIT[1]: To take listen interval from join command. 0 – Listen interval invalid 1 – Listen interval valid BIT[2]: To enable/disable quick join feature. 1 - To enable quick join feature. 0 - To disable quick join feature. BIT[3]: Set this bit enable CCXV2 extension for client to work with cisco APs. BIT[4]: Host sets this bit to join an AP based on BSSID. BIT[5]: Host sets this bit to enable Management Frame Protection Capable feature. BIT[6]: Set this bit to enable Management Frame Protection Required feature. BIT[7]: To configure listen interval from rsi_wlan_power_save_with_listen_interval SAPI.
`RSI_LISTEN_INTERVAL`	This is valid only if BIT (1) in join_feature_bit_map is set. This value is given in Time units (1024 microsecond). This parameter is used to configure maximum sleep duration in power save.
`RSI_DATA_RATE`	To select Auto or Fixed data rate. Recommended to use Auto rate. `RSI_DATA_RATE_AUTO`: Auto rate

Curve IDs Supported#


Curve ID	Description	Support
15	secp160k1	Yes
16	secp160r1	Yes
17	secp160r2	Yes
18	secp192k1	Yes
19	secp192r1	Yes
20	secp224k1	Yes
21	secp224r1	Yes
22	secp256k1	Yes
23	secp256r1	Yes
24	secp384r1	Yes
25	secp521r1	Yes
26	brainpoolP256r1	Yes
27	brainpoolP384r1	Yes
28	brainpoolP512r1	Yes

Power Save Parameters#


Macro	Usage
`RSI_HAND_SHAKE_TYPE`	To set handshake type of power mode `MSG_BASED`/`GPIO_BASED`
`RSI_SELECT_LP_OR_ULP_MODE`	0 - `LP`, 1- `ULP` mode with `RAM` retention and 2 - `ULP` without `RAM` retention
`RSI_DTIM_ALIGNED_TYPE`	set `DTIM` alignment required 0 - module wakes up at beacon which is just before or equal to listen_interval. 1 - module wakes up at `DTIM` beacon which is just before or equal to listen_interval.
`RSI_MONITOR_INTERVAL`	Monitor interval for the `FAST PSP` mode. Default is 50 ms, and this parameter is valid for `FAST PSP` only.
`RSI_WMM_PS_ENABLE`	To set wmm enable or disable.
`RSI_WMM_PS_TYPE`	To set wmm type 0 - `TX BASED` 1 - `PERIODIC`
`RSI_WMM_PS_WAKE_INTERVAL`	To set wmm wake up interval.
`RSI_WMM_PS_UAPSD_BITMAP`	To set wmm `UAPSD` bitmap
`RSI_NUM_OF_DTIM_SKIP`	If this macro is n then module will wake up at (n+1)th `DTIM`.

Configure 10 TCP Sockets when Device is in AP mode#


Macro	Usage
`HIGH_PERFORMANCE_ENABLE`	To make `RSI_ENABLE` or `RSI_DISABLE` high performance sockets.
`TOTAL_SOCKETS`	To Set total number of Sockets - `TCP_TX + TCP_RX + UDP_TX + UDP_RX` 10 - To Open 10 Sockets in total
`TOTAL_TCP_SOCKETS`	To Set total `TCP` Sockets - `TCP_TX + TCP_RX` 10 - To open 10 `TCP` Sockets
`TOTAL_UDP_SOCKETS`	To Set total `UDP` Sockets 0 - Disable 1 - Enable
`TCP_TX_ONLY_SOCKETS`	To Set total `TCP TX` only Sockets - `TCP TX`
`TCP_RX_ONLY_SOCKETS`	To Set `TCP RX` only Sockets - `TCP RX` 10 - To Open 10 `TCP_RX` sockets
`UDP_TX_ONLY_SOCKETS`	To Set `UDP TX` only Sockets - `UDP TX` 0 - Disable 1 - Enable
`UDP_RX_ONLY_SOCKETS`	To Set `UDP RX` only Sockets - `UDP RX` 0 - Disable 1 - Enable
`TCP_RX_HIGH_PERFORMANCE_SOCKETS`	To Set `TCP_RX` high performance Sockets 10 - To open 10 `TCP_RX_HIGH_PERFORMANCE_SOCKETS`
`TCP_RX_WINDOW_SIZE_CAP`	To Set `TCP RX` window size 10 - To make the `TCP RX` window size to 10
`TCP_RX_WINDOW_DIV_FACTOR`	To Set `TCP_RX` window division factor 10 - To make `TCP RX` window division factor to 10
`RSI_NUMBER_OF_LTCP_SOCKETS`	To Set the number of `LTCP` sockets 10 - To open 10 `LTCP` sockets
`RSI_NUMBER_OF_SOCKETS`	Default number of Sockets supported. Set this to, 10 + `RSI_NUMBER_OF_LTCP_SOCKETS`

IP Parameters#


Macro	Usage
`RSI_DHCP_HOST_NAME`	Define this macro in config file to set DHCP client host name - A 31-byte string

Chip Version#

User can get the chip version using the rsi_mem_rd API by reading one byte of data at the address 0x04000437 into the buffer pointed by *buf. rsi_mem_rd(0x04000437, 1, buf)


Chip version	Read data
1.3	0x13
1.4	0x14
1.5	0x15