Wi-Fi APIs#

rsi_driver_send_data#

int32_t rsi_driver_send_data (uint32_t sockID, uint8_t * buffer, uint32_t length, struct rsi_sockaddr * destAddr)

Send data packet. This is a blocking API.

Returns

• 0 - Success Negative Value - Failure

rsi_driver_process_recv_data#

int32_t rsi_driver_process_recv_data (rsi_pkt_t * pkt)

This API processes received data packet. This is a non-blocking API.

Returns

• 0 - Success Negative Value - Failure

rsi_nwk_register_callbacks#

int16_t rsi_nwk_register_callbacks (uint32_t callback_id, void(*)(uint8_t command_type, uint32_t status, const uint8_t *buffer, const uint32_t length) callback_handler_ptr, status, buffer, length)

Register the call backs. This is a non-blocking API.

Returns

• 0 - Success Non-Zero Value - Failure -3 Command given in wrong state If call_back_id is greater than the maximum callbacks to register, returns 1

prototypes of the call back functions#

rsi_wlan_radio_init#

int32_t rsi_wlan_radio_init (void )

This API initializes wlan radio parameters and WLAN supplicant parameters. This API returns the WLAN MAC address of the module to the host.

• rsi_wireless_init() API must be called before this rsi_wlan_radio_init() API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is greater than 0 0x0021- Command given in wrong state

Note

• rsi_wlan_radio_init() is used if user wants to configure any other parameters which are supposed to be given before rsi_wlan_scan() or rsi_wlan_scan_async() API

rsi_wlan_filter_broadcast#

int32_t rsi_wlan_filter_broadcast (uint16_t beacon_drop_threshold, uint8_t filter_bcast_in_tim, uint8_t filter_bcast_tim_till_next_cmd)

Program the ignoring broad cast packet threshold levels when station is in powersave mode and is used to achieve low currents in standby associated mode. This is blocking API.

Note

• Validity of this bit is dependent on the filter_bcast_tim_till_next_cmd

Returns

• 0 - Success Non-Zero Value - If return value is less than 0 -2: Invalid parameters -3: Command given in wrong state -4: Buffer not available to serve the command return value is greater than 0 0x0021

rsi_check_state#

int32_t rsi_check_state (int32_t type)

Check the WLAN state.

Returns

• 0 - If in IP config state -20 - If not in IP config state

rsi_sort_scan_results_array_based_on_rssi#

void rsi_sort_scan_results_array_based_on_rssi (struct wpa_scan_results_arr * scan_results_array)

Sort the scan results in 'scan_results_array' in the order of RSSI. Application should call this API to get the scan result in sorted order.

• rsi_wlan_scan_with_bitmap_options() API needs to be called before this API.

Returns

• Void

rsi_wlan_scan_with_bitmap_options#

int32_t rsi_wlan_scan_with_bitmap_options (int8_t * ssid, uint8_t chno, rsi_rsp_scan_t * result, uint32_t length, uint32_t scan_bitmap)

Scan available access points and post scan response to application. Application must call this API to get the scan results. This is a blocking API.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure

rsi_wlan_scan_async_with_bitmap_options#

int32_t rsi_wlan_scan_async_with_bitmap_options (int8_t * ssid, uint8_t chno, uint32_t bitmap, void(*)(uint16_t status, const uint8_t *buffer, const uint16_t length) scan_response_handler, buffer, length, scan_bitmap)

Scan available access points and post scan response to application. Application must call this API to get the scan results. This is a non-blocking API.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure

rsi_wlan_scan#

int32_t rsi_wlan_scan (int8_t * ssid, uint8_t chno, rsi_rsp_scan_t * result, uint32_t length)

Scan the surrounding Wi-Fi networks. This is a blocking API. Invoke rsi_wlan_scan_async(), which is an asynchronous call. Wait on WLAN command semaphore to get the status of the scan results. Return RSI_SUCCESS on success and optionally, a maximum of 11 scan results if rsi_rsp_scan_t parameter is configured. In case of failure, an appropriate error code is returned to the application.

• rsi_wireless_init() API needs to be called before this API.

Channels supported in 2.4 GHz Band#

Channels supported in 5 GHz Band#

Note

• To set various timeouts, user should change the following macros in rsi_wlan_config.h #define RSI_TIMEOUT_SUPPORT RSI_ENABLE #define RSI_TIMEOUT_BIT_MAP 4 #define RSI_TIMEOUT_VALUE 300

  timeout_bitmap	Description
  timeout_bitmap[0]	Set timeout for association and authentication request.timeout_value : timeout value in ms(default 300ms).
  timeout_bitmap[1]	Sets each channel active scan time in ms (default 100ms)
  timeout_bitmap[2]	Used for WLAN keep alive timeout(default value is 30s)
  timeout_bitmap[31-3]	Reserved

Scan structure#

Returns

• Success - RSI_SUCCESSFailure - Non-Zero valuesIf return value is less than 0

      **RSI_ERROR_INVALID_PARAM**                 - Invalid parameters \n
  
  **RSI_ERROR_COMMAND_GIVEN_IN_WRONG_STATE**  - Command given in wrong state \n
  
  **RSI_ERROR_PKT_ALLOCATION_FAILURE**        - Buffer not available to serve the command \n
  
          `Other expected error codes are :` \n
  
      **0x0002, 0x0003, 0x0005, 0x000A, 0x0014, 0x0015, 0x001A, 0x0021,0x0024,0x0025,0x0026,0x002C,0x003c**
  

Note

• Refer to Error Codes section for above error codes description Error Codes.

rsi_wlan_scan_async#

int32_t rsi_wlan_scan_async (int8_t * ssid, uint8_t chno, void(*)(uint16_t status, const uint8_t *buffer, const uint16_t length) scan_response_handler, Buffer, Length)

Scan the surrounding Wi-Fi networks. A scan response handler is registered with it to get the response for scan.This is a non-blocking API.

Note

• If status is Success , the argument buffer passed to scan_response_handler holds scan results in rsi_rsp_scan_t structure format.

• rsi_wireless_init() API needs to be called before this API.

Note

• SSID is a null terminated string.

Channels supported in 2.4 GHz Band#

Channels supported in 5 GHz Band#

Note

• To set various timeouts, user should change the following macros in rsi_wlan_config.h #define RSI_TIMEOUT_SUPPORT RSI_ENABLE #define RSI_TIMEOUT_BIT_MAP 4 #define RSI_TIMEOUT_VALUE 300

Scan Response structure format#

Scan structure#

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -2 - Invalid parameters -3 - Command given in wrong state -4 - Buffer not available to serve the command If return value is greater than 0 0x0002, 0x0003, 0x0005, 0x000A, 0x0014, 0x0015, 0x001A, 0x0021,0x0024,0x0025,0x0026,0x002C,0x003c

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_connect#

int32_t rsi_wlan_connect (int8_t * ssid, rsi_security_mode_t sec_type, void * secret_key)

Connect to the specified Wi-Fi network. This is a blocking API. Call asynch connect to trigger connect call to AP and return RSI_SUCCESS or error in case of failure.

• rsi_wireless_init() API needs to be called before this API.

Note

• To set various timeouts, user should change the following macros in rsi_wlan_config.h #define RSI_TIMEOUT_SUPPORT RSI_ENABLE #define RSI_TIMEOUT_BIT_MAP 4 #define RSI_TIMEOUT_VALUE 300 timeout_bitmap[0] - Set timeout for association and authentication request. timeout_value : timeout value in ms(default 300ms). timeout_bitmap[1] - Sets each channel active scan time in ms (default 100ms) timeout_bitmap[2] - Used for WLAN keep alive timeout(default value is 30s) timeout_bitmap[31-3] - reserved

• To set Rejoin params, user should configure the following macros in rsi_wlan_config.h RSI_REJOIN_PARAMS_SUPPORT : Enable to send rejoin parameters command during Wi-Fi client connection RSI_REJOIN_MAX_RETRY : Number of maximum rejoin retries by module note : If Max retries is 0 , retries infinity times RSI_REJOIN_SCAN_INTERVAL : Periodicity of rejoin attempt RSI_REJOIN_BEACON_MISSED_COUNT : Number of consecutive beacon misses after which modules goes to unconnected state RSI_REJOIN_FIRST_TIME_RETRY : ENABLE - Try to rejoin in the first attempt after join failure. DISABLE - Try to rejoin based on maximum rejoin retries configured. When RSI_REJOIN_PARAMS_SUPPORT is enabled in the rsi_wlan_config.h, this rejoin frame will be sent to the firmware after scan done in the SAPI.

• This API internally handles following commands based on wlan_cb state and sends the next command and finally sends the join command. • Set mac address • Band • Timeout • Init • Set region • WMM parameters • Scan • EAP config • WMM PS parameters • WPS method • Set WEP keys • Host PSK • Rejoin params • Join For example, After calling rsi_wireless_init(), wlan_cb state is updated to opermode done state. So when we call this API, it will execute band, init, scan and join commands. After calling rsi_wlan_disconnect() or else after rejoin failure, wlan_cb state is updated to band done state. So when we call this API, it will execute init, scan and join commands. After calling rsi_wlan_scan()/ rsi_wlan_scan_with_bitmap_options() API, wlan_cb state is updated to scan done state. So when we call this API, it will execute join command directly.

Returns

• Success - RSI_SUCCESS Failure - Non-Zero Value

      `if return value is less than zero :\n
  

RSI_ERROR_INVALID_PARAM - Invalid parameters RSI_ERROR_COMMAND_GIVEN_IN_WRONG_STATE - Command given in wrong state RSI_ERROR_PKT_ALLOCATION_FAILURE - Buffer not available to serve the command `Other expected error code are : 0x0002,0x0003,0x0005,0x0008,0x0009,0x000A,0x000E,0x0014,0x0015,0x0016,0x0019,0x001A,0x001E,0x0020,0x0021,0x0024,0x0025,0x0026,0x0028,0x0039,0x003C,0x0044,0x0045,0x0046,0x0047,0x0048,0x0049,0xFFF8Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_connect_async#

int32_t rsi_wlan_connect_async (int8_t * ssid, rsi_security_mode_t sec_type, void * secret_key, void(*)(uint16_t status, const uint8_t *buffer, const uint16_t length) join_response_handler, Status, Buffer, length)

Connect to the specified Wi-Fi network.A join response handler is registered to get the response for join.. This is a non-blocking API.

• rsi_wireless_init() API needs to be called before this API.

Note

• The module gets a default IP of 192.168.100.76 if it becomes a Group Owner or Access Point in case of IPv4. and gets a default IP of 2001:db8:0:1:0:0:0:120 in case of IPv6.

• To set Rejoin params, user should configure the following macros in rsi_wlan_config.h RSI_REJOIN_PARAMS_SUPPORT : Enable to send rejoin parameters command during Wi-Fi client connection RSI_REJOIN_MAX_RETRY : Number of maximum rejoin retries by module note : If Max retries is 0 , retries infinity times RSI_REJOIN_SCAN_INTERVAL : Periodicity of rejoin attempt RSI_REJOIN_BEACON_MISSED_COUNT : Number of consecutive beacon misses after which modules goes to unconnected state RSI_REJOIN_FIRST_TIME_RETRY : ENABLE - Try to rejoin in the first attempt after join failure. DISABLE - Try to rejoin based on maximum rejoin retries configured. When RSI_REJOIN_PARAMS_SUPPORT is enabled in the rsi_wlan_config.h, this rejoin frame will be sent to the firmware after scan done in the SAPI.

• This API internally handles following commands based on wlan_cb state and sends the next command and finally sends the join command. • Set mac address • Band • Timeout • Init • Set region • WMM parameters • Scan • EAP config • WMM PS parameters • WPS method • Set WEP keys • Host PSK • Rejoin params • Join For example, After calling rsi_wireless_init(), wlan_cb state is updated to opermode done state. So when we call this API, it will execute band, init, scan and join commands. After calling rsi_wlan_disconnect() or else after rejoin failure, wlan_cb state is updated to band done state. So when we call this API, it will execute init, scan and join commands. After calling rsi_wlan_scan()/ rsi_wlan_scan_with_bitmap_options() API, wlan_cb state is updated to scan done state. So when we call this API, it will execute join command directly.

Returns

• 0 - Success Non-Zero - Failure -2 - Invalid parameters -3 - Command given in wrong state -4 - Buffer not availableto serve the command

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_bgscan_profile#

int32_t rsi_wlan_bgscan_profile (uint8_t cmd, rsi_rsp_scan_t * result, uint32_t length)

Get background scan results or stop bgscan. This is a blocking API.

• rsi_wlan_connect() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure -3 - Command given in wrong state -4 - Buffer not availableto serve the command.

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_execute_post_connect_cmds#

int32_t rsi_wlan_execute_post_connect_cmds (void )

Enable scan and roaming after connecting to the Access Point. This is a blocking API.

• rsi_wlan_connect() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -3 - Command given in wrong state -4 - Buffer not available to serve the command If return value is greater than 0 0x0006,0x0021,0x002C,0x004A,0x0025,0x0026

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_wps_push_button_event#

int32_t rsi_wlan_wps_push_button_event (int8_t * ssid)

Start the WPS Push button in AP mode. Must be called after rsi_wlan_ap_start API once it has returned Success. This is a blocking API.

• rsi_wlan_ap_start() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4 - Buffer not available to serve the command If return value is greater than 0 0x0021

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_send_freq_offset#

int32_t rsi_send_freq_offset (int32_t freq_offset_in_khz)

Application to provide feedback of frequency error in KHz. This is a blocking API.

Returns

• 0 - Success Non zero Value - Failure

rsi_calib_write#

int32_t rsi_calib_write (uint8_t target, uint32_t flags, int8_t gain_offset, int32_t xo_ctune)

RF calibration process. This API will command the firmware to update the existing Flash/EFuse calibration data. This is a blocking API.

• rsi_transmit_test_start(), rsi_send_freq_offset() API needs to be called before this API.This API is relevant in PER mode only.

Note

• To recalibrate gain offset after it has been burnt to flash, the user is required to first reset gain offset and then follow the calibration flow. e.g.: rsi_calib_write(BURN_INTO_FLASH,BURN_GAIN_OFFSET,0,0); // which resets gain offset Recalibration is not possible if EFuse is being used instead of flash as calibration data storage

Returns

• 0 - Success Non-Zero Value - Failure

rsi_parse#

int16_t rsi_parse (void * address, uint16_t length, uint8_t * value)

Parse and convert the given value in ASCII to the datatype of a given length.. This is a non-blocking API.

Returns

• 0 - Success Non-Zero Value - Failure

rsi_wlan_wps_generate_pin#

int32_t rsi_wlan_wps_generate_pin (uint8_t * wps_pin, uint16_t length, 8-byte)

Generate WPS pin. This is a blocking API.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4 - Buffer not available to serve the command If return value is greater than 0 0x0021,0x002C,0x0025,0x0037,0x0038

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_wps_enter_pin#

int32_t rsi_wlan_wps_enter_pin (int8_t * wps_pin, Same)

Validate WPS pin entered. This is a blocking API.

• rsi_wlan_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure

rsi_get_random_bytes#

int32_t rsi_get_random_bytes (uint8_t * result, uint32_t length)

Get random bytes from the device. This is a blocking API.

Returns

• 0 - Success Non-Zero Value - Failure

rsi_wlan_disconnect#

int32_t rsi_wlan_disconnect (void )

Disconnect module from the connected access point. This is a blocking API.

• rsi_wlan_connect() API needs to be called before this API.

Returns

• Non-Zero Value - Failure 0 - Success If return value is less than 0 -3 - Command given in wrong state -4 - Buffer not availableto serve the command If return value is greater than 0 0x0006,0x0021,0x002C,0x004A,0x0025,0x0026

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_disconnect_stations#

int32_t rsi_wlan_disconnect_stations (uint8_t * mac_address)

Disconnect the connected stations in AP mode. This is a blocking API.

• rsi_wlan_ap_start() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4 - Buffer not available to serve the command If return value is greater than 0 0x0013, 0x0021, 0x002C, 0x0015

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_config_ipaddress#

int32_t rsi_config_ipaddress (rsi_ip_version_t version, uint8_t mode, uint8_t * ip_addr, uint8_t * mask, uint8_t * gw, uint8_t * ipconfig_rsp, uint16_t length, uint8_t vap_id)

Configure the IP address to the module. This is a blocking API. Send IPconfig command to configure IP address with input parameters (like ipversion, static mode/dhcp mode,vap_id)and return error in case of invalid parameters.

• rsi_wlan_connect() API needs to be called before this API.

Returns

• Success - RSI_SUCCESS Failure - Non-Zero Value RSI_ERROR_INVALID_PARAM - Invalid parametersRSI_ERROR_COMMAND_GIVEN_IN_WRONG_STATE - Command given in wrong state RSI_ERROR_PKT_ALLOCATION_FAILURE - Buffer not available to serve the command

Note

• Refer to Error Codes section for the description of other error codes Error Codes.

rsi_wlan_set_certificate_index#

int32_t rsi_wlan_set_certificate_index (uint8_t certificate_type, uint8_t cert_inx, uint8_t * buffer, uint32_t certificate_length)

Write or erase certificate into module. This is a blocking API.

• rsi_wireless_init() API must be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -2 Invalid Parameters -3 Command given in wrong state -4 Buffer not available to serve the command If return value is greater than 0 0x0015,0x0021,0x0025,0x0026,0x002C

Note

• Index-based certificate loading is valid only for storing certificates on to RAM or flash but not both at the same time. Enable BIT(27) in tcp_ip_feature_bit_map to load SSl certificate into RAM. Enable BIT(31) in tcp_ip_feature_bit_map and BIT (29) in ext_tcp_ip_feature_bit_map to open 3 SSL client sockets. Three SSL client sockets feature supported only in WLAN mode.

rsi_wlan_get_status#

int32_t rsi_wlan_get_status (void )

Check the status (specific error code) of errors encountered during a call to a WLAN API or BSD sockets functions. User can call this API to check the error code.This is a non-blocking API.

Returns

• Return the error code that previously occurred. If no error occurred, return 0.

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_get#

int32_t rsi_wlan_get (rsi_wlan_query_cmd_t cmd_type, uint8_t * response, uint16_t length)

Get the required information based on the type of command. This is a blocking API.

• rsi_wireless_init () API needs to be called before this API. Return WLAN status

Note

• RSI_WLAN_INFO is relevant in both station and AP mode. RSI_SOCKETS_INFO is relevant in both station mode and AP mode. RSI_STATIONS_INFO is relevant in AP mode RSI_GET_WLAN_STATS is relevant in AP and Station mode

Returns

• Non-Zero Value - Failure 0 - Success -3 - Command given in wrong state -4 - Buffer not availableto serve the command -6 - Insufficient input buffer given

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_set#

int32_t rsi_wlan_set (rsi_wlan_set_cmd_t cmd_type, uint8_t * request, uint16_t length)

Request configuration based on the command type. This is a blocking API.

• rsi_wireless_init() API needs to be called before this API. For setting MAC address, call this API immediately after rsi_wireless_init() and before calling any other API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -2 - Invalid parameters -3 - Command given in wrong state -4 - Buffer not available to serve the command If return value is greater than 0 0x0002, 0x0003, 0x0005, 0x000A, 0x0014, 0x0015, 0x001A, 0x0021,0x0024,0x0025,0x0026,0x002C,0x003c

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_buffer_config#

int32_t rsi_wlan_buffer_config (void , dynamic_rx_pool, dynamic_global_pool)

Configure the TX ,RX global buffers ratio. This is a blocking API.

• rsi_wlan_buffer_config() API needs to be called after opermode command only

Returns

• Non-Zero Value - Failure 0 - Success -2 - Invalid parameters -3 - Command given in wrong state -4 - Buffer not availableto serve the command If return value is greater than zero : 0x0021

Note

• Refer to Error Codes section for the description of the above error codes Error Codes Parameters given here are used internally by the API

rsi_wlan_ap_start#

int32_t rsi_wlan_ap_start (int8_t * ssid, uint8_t channel, rsi_security_mode_t security_type, rsi_encryption_mode_t encryption_mode, uint8_t * password, uint16_t beacon_interval, uint8_t dtim_period)

Start the module in access point mode with the given configuration. This is a blocking API.

• rsi_wireless_init() API needs to be called before this API.

The following table maps the channel number to the actual radio frequency in the 2.4 GHz spectrum#

The following table maps the channel number to the actual radio frequency in the 5 GHz spectrum#

Note

• DFS channels are not supported in AP mode.

Returns

• Non-Zero Value - Failure 0 - Success -2 - Invalid parameters -3 - Command given in wrong state -4 - Buffer not availableto serve the command

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_power_save_with_listen_interval#

int32_t rsi_wlan_power_save_with_listen_interval (uint8_t psp_mode, uint8_t psp_type, uint16_t listen_interval)

Set the power save profile in WLAN mode with listen interval-based wakeup. This is a blocking API.

• rsi_wireless_init() API needs to be called before this API.

Note

• Valid only if BIT (7) in join_feature_bit_map is set. This value is given in time units (1024 microsecond). Used to configure sleep duration in power save and should be less than the listen interval configured by RSI_LISTEN_INTERVAL Macro in join command parameters in rsi_wlan_config.h file.

• 1. psp_type is only valid in psp_mode 1 and 2.

• 2. psp_type UAPSD is applicable only if WMM_PS is enabled in rsi_wlan_config.h file.

• 3. In RSI_MAX_PSP mode, Few access points will not aggregate the packets, when power save is enabled from STA. This may cause the drop in throughputs.

• 4. For the power save mode 3, select RSI_SLEEP_MODE_2 in psp_mode and RSI_HAND_SHAKE_TYPE as MSG_BASED in rsi_wlan_config.h file.

• 5. For the power save mode 9, select RSI_SLEEP_MODE_8 in psp_mode and RSI_HAND_SHAKE_TYPE as MSG_BASED in rsi_wlan_config.h file.

• 6. For the deep sleep without ram retention case, select RSI_SLEEP_MODE_10 in psp_mode and RSI_HAND_SHAKE_TYPE as MSG_BASED for msg_based or GPIO_BASED for gpio_based.

• 7. For LP sleep, select RSI_SLEEP_MODE_2 in psp_mode, select RSI_SELECT_LP_OR_ULP_MODE as RSI_LP_MODE and RSI_HAND_SHAKE_TYPE as MSG_BASED/GPIO_BASED in rsi_wlan_config.h file.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -2 - Invalid parameters -3 - Command given in wrong state -4 - Buffer not available to serve the command

rsi_wlan_power_save_profile#

int32_t rsi_wlan_power_save_profile (uint8_t psp_mode, uint8_t psp_type)

Set the power save profile in WLAN mode. This is a blocking API.

• rsi_wireless_init() API needs to be called before this API.

Enhanced max psp#

Enhanced max PSP is recommended. This essentially a MAX PSP mode but switches to Fast PSP mode if AP does not deliver data within 20ms for PS-Poll. To enable this mode, follow procedure below: Add ENABLE_ENHANCED_MAX_PSP (BIT(26)) in RSI_CONFIG_FEATURE_BITMAP Set psp_type to RSI_FAST_PSP (1) Configure Monitor interval by RSI_MONITOR_INTERVAL in rsi_wlan_config.h file. (default value is 50 ms) Note

• 1. psp_type is only valid in psp_mode 1 and 2.

• 2. psp_type UAPSD is applicable only if WMM_PS is enabled in rsi_wlan_config.h file.

• 3. In RSI_MAX_PSP mode, Few Access points won't aggregate the packets, when power save is enabled from STA. This may cause the drop in throughputs.

• 4. For the power save mode 3, select RSI_SLEEP_MODE_2 in psp_mode and RSI_HAND_SHAKE_TYPE as MSG_BASED in rsi_wlan_config.h file.

• 5. For the power save mode 9, select RSI_SLEEP_MODE_8 in psp_mode and RSI_HAND_SHAKE_TYPE as MSG_BASED in rsi_wlan_config.h file.

• 6. For the deep sleep without ram retention case, select RSI_SLEEP_MODE_10 in psp_mode and RSI_HAND_SHAKE_TYPE as MSG_BASED for msg_based or GPIO_BASED for gpio_based.

• 7. For LP sleep, select RSI_SLEEP_MODE_2 in psp_mode, select RSI_SELECT_LP_OR_ULP_MODE as RSI_LP_MODE and RSI_HAND_SHAKE_TYPE as MSG_BASED/GPIO_BASED in rsi_wlan_config.h file.

• Powersave handshake option:

  • When sleep clock source is configured to '32KHz bypass clock on UULP_VBAT_GPIO_3', use UULP_VBAT_GPIO_0 for SLEEP_IND_FROM_DEV set RS9116_SILICON_CHIP_VER in 'RS9116.NB0.WC.GENR.OSI.X.X.X\host\sapis.h' to 'CHIP_VER_1P4_AND_ABOVE'

  • If not using external clock on UULP_VBAT_GPIO_3' as sleep clock source, use UULP_VBAT_GPIO_3 for SLEEP_IND_FROM_DEV set RS9116_SILICON_CHIP_VER in 'RS9116.NB0.WC.GENR.OSI.X.X.X\host\sapis.h' to 'CHIP_VER_1P3'. EXT_FEAT_LOW_POWER_MODE is not supported for 1.3 version chipset(CHIP_VER_1P3).

Power save modes description#

• Power Save Mode 0 In this mode, module is active and power save is disabled. It can be configured any time, while the module is configured in Power Save mode 2 or 8.

• Power save Mode 1 Once the module is configured to power save mode 1, it wakes up periodically based upon the DTIM interval configured in connected AP. In power mode 1, only the RF of the module is in power save while SOC continues to work normally. This command has to be given only when module is in connected state (with the AP). After having configured the module to power save mode, the Host can issue subsequent commands. In power save mode 1 the module can receive data from host at any point of time but it can send/receive the data to/from remote terminal only when it is awake at DTIM intervals.

• Power Save Mode 2 Once the module is configured to power save mode 2, it can be woken up either by the Host or periodically during its sleep-wakeup cycle. Power Save mode 2 is GPIO based. In case of GPIO based mode, whenever host wants to send data to module, it gives wakeup request by asserting UULP GPIO #2. After wakeup, if the module is ready for data transfer, it sends wakeup indication to host by asserting UULP GPIO #3 or UULP GPIO #0. Host is required to wait until module gives wakeup indication before sending any data to the module. After the completion of data transfer, host can give sleep permission to module by de-asserting UULP GPIO #2. After recognizing sleep permission from host, module gives confirmation to host by de-asserting UULP GPIO #3 or UULP GPIO #0 and again goes back to its sleep-wakeup cycle. Module can send received packets or responses to host at any instant of time. No handshake is required on Rx path.

• Power Save mode 3 Power Mode 3 is message based power save. In Power Mode 3, both radio and SOC of RS9116-WiSeConnect are in power save mode. This mode is significant when module is in associated state with AP. Module wakes up periodically upon every DTIM and gives wakeup message ("WKP") to host. Module can not be woken up asynchronously. Every time module intends to go to sleep it sends a sleep request message ("SLP") to the host and expects host to send the acknowledgement message ("ACK"). Host either send acknowledgement ("ACK") or any other pending message. But once ACK is sent, Host should not send any other message unless next wakeup message from module is received. Module shall not go into complete power-save state, if ACK is not received from host for given sleep message. Module can send received packets or responses to host at any instant of time. No handshake is required on Rx path.

• Power Save mode 8 In Power save mode 8, both RF and SOC of the module are in complete power save mode. This mode is significant only when module is in un-connected state. Power Save mode 8 can be GPIO based. In case of GPIO based, host can wakeup the module from power save by asserting UULP GPIO #2. After wakeup, if the module is ready for data transfer, it sends wakeup indication to host by asserting UULP GPIO #3 or UULP GPIO #0. Host is required to wait until module gives wakeup indication before sending any data to the module. After the completion of data transfer, host can give sleep permission to module by de-asserting UULP GPIO #2. After recognizing sleep permission from host, module gives confirmation to host by de-asserting UULP GPIO #3 or UULP GPIO #0 and again goes back to its sleep-wakeup cycle. Module can send received packets or responses to host at any instant of time. No handshake is required on Rx path.

• Power save mode 9 In Power Mode 9 both Radio and SOC of RS9116-WiSeConnect are in complete power save mode. This mode is significant when module is not connected with any AP. Once power mode 9 command is given, the module sends ("SLP") request to host and wait for the ("ACK") from host and goes to sleep when ACK is given by host. Timer starts when power save command is issued and it can be configured by host using rsi_wlan_set_sleep_timer API. If host does not set any sleep time, then the timer is configured for 3sec by default. Upon wakeup module sends a wakeup message to the host and expects host to give ACK before it goes into next sleep cycle. Host either send ACK or any other messages but once ACK is sent no other packet should be sent before receiving next wakeup message. When ulp_mode_enable is set to '2', after waking up from sleep, the module sends WKP FRM SLEEP message to host when RAM retention is not enabled. After receiving WKP FRM SLEEP message, host needs to start giving commands from beginning (opermode) as module's state is not retained. Returns

  • 0 - Success Non-Zero Value - Failure If return value is less than 0 -2 - Invalid parameters -3 - Command given in wrong state -4 - Buffer not available to serve the command If return value is greater than 0 0x0021,0x0025,0x002C,0xFFF8,0x0015,0x0026,0x0052

  Note

  • Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_power_save_disable_and_enable#

int32_t rsi_wlan_power_save_disable_and_enable (uint8_t psp_mode, uint8_t psp_type)

Disable or enable the power save feature. This is a blocking API.

• rsi_wlan_power_save_profile() API needs to be called before this API.

Returns

• Non-Zero Value - Failure 0 - Success

rsi_transmit_test_start#

int32_t rsi_transmit_test_start (uint16_t power, uint32_t rate, uint16_t length, uint16_t mode, uint16_t channel)

Start the transmit test. This is a blocking API.

Note

• This API is relevant in PER mode.

• rsi_wlan_radio_init() API needs to be called before this API.

Note

• 1. User can configure the maximum power level allowed for the given frequncey in the configured region by providing 127 as power level

• 2. User should configure a minimum delay (approx. 10 milliseconds) before and after rsi_transmit_test_start API to observe a stable output at requested dBm level.

Note

• 1. Before starting Continuous Wave mode, user must start Continuous mode with power and channel values that are intended to be used in Continuous Wave mode i.e.

• i. Start Continuous mode with intended power value and channel values - Pass any valid values for rate and length.

• ii. Stop Continuous mode

• iii Start Continuous Wave mode

• 2. If user wants to switch continuous wave mode, first need to stop the per mode and again need to give continous wave mode which user wants to switch.

  Data rate(Mbps)	Value of rate
  1	0
  2	2
  5.5	4
  11	6
  6	139
  9	143
  12	138
  18	142
  24	137
  36	141
  48	136
  54	140
  MCS0	256
  MCS1	257
  MCS2	258
  MCS3	259
  MCS4	260
  MCS5	261
  MCS6	262
  MCS7	263

  The following table maps the channel number to the actual radio frequency in the 2.4 GHz spectrum.

  Channel numbers (2.4GHz)	Center frequencies for 20MHz channel width
  1	2412
  2	2417
  3	2422
  4	2427
  5	2432
  6	2437
  7	2442
  8	2447
  9	2452
  10	2457
  11	2462
  12	2467
  13	2472
  14	2484

• To start transmit test in 12,13,14 channels, configure set region parameters in rsi_wlan_config.h

• The following table maps the channel number to the actual radio frequency in the 5 GHz spectrum for 20MHz channel bandwidth. The channel numbers in 5 GHz range is from 36 to 165.

  Channel Numbers(5GHz)	Center frequencies for 20MHz channel width
  36	5180
  40	5200
  44	5220
  48	5240
  52	5260
  56	5280
  60	5300
  64	5320
  149	5745
  153	5765
  157	5785
  161	5805
  165	5825

Returns

• 0 - Success Non-Zero Value - Failure if less than zero -4 - Buffer not available to serve the command If greater than zero 0x000A, 0x0021, 0x0025, 0x002C

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_transmit_test_stop#

int32_t rsi_transmit_test_stop (void )

Stops the transmit test. This is a blocking API.

Note

• This API is relevant in PER mode.

• rsi_wlan_radio_init() API needs to be called before this API.

Returns

• 0 Successful execution of the command Non Zero Value Failure if return value is less than 0 -4: Buffer not available to serve the command If return value is greater than 0 0x0021, 0x0025, 0x002C

Note

• 1. User should configure a minimum delay (approx. 10 milliseconds) before and after rsi_transmit_test_start API to observe a stable output at requested dBm level.

• 2. Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_receive_stats_start#

int32_t rsi_wlan_receive_stats_start (uint16_t channel)

Get the Transmit (TX) & Receive (RX) packets statistics.When this API is called by the host with valid channel number, the module gives the statistics to the host for every 1 second asynchronously. If wlan_receive_stats_response_handler() is registered through rsi_wlan_register_callbacks(), it's a non blocking, otherwise, a blocking call.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4: Buffer not available to serve the command If return value is greater than 0 0x0021, 0x0025, 0x002c, 0x000A

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_receive_stats_stop#

int32_t rsi_wlan_receive_stats_stop (void )

Stop the Transmit (TX) & Receive(RX) packets statistics. if wlan_receive_stats_response_handler() is registered through rsi_wlan_register_callbacks(), it's non blocking, otherwise, a blocking call.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4: Buffer not available to serve the command If return value is greater than 0 0x0021, 0x0025, 0x002c

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_wfd_start_discovery#

int32_t rsi_wlan_wfd_start_discovery (uint16_t go_intent, int8_t * device_name, uint16_t channel, int8_t * ssid_post_fix, uint8_t * psk, void(*)(uint16_t status, uint8_t *buffer, const uint32_t length) wlan_wfd_discovery_notify_handler, void(*)(uint16_t status, uint8_t *buffer, const uint32_t length) wlan_wfd_connection_request_notify_handler)

Start discovery in wi-fi direct mode.This is a non-blocking API. wlan_wfd_discovery_notify_handler() rsi_wlan_wfd_start_discovery() API is registered through rsi_wlan_register_callbacks(), its non blocking, otherwise blocking call.

• rsi_wireless_init() API needs to be called before this API.

  Parameter	Description
  go_intent	Determine whether the device is intended to form a GO (group owner) or work as a Wi-Fi Direct Peer node.
  Value used in the GO negotiation process, when the module negotiates with another Wi-Fi Direct Node on who would become the Group Owner.
  Valid range of values for this parameter is: 0 to 16. Higher the number, higher is the willingness of the module to become a GO.
  After the module becomes a GO in Wi-Fi Direct mode, it appears as an Access Point to the client devices.
  If the number is between 0 and 15, a GO negotiation takes place. If the value is 16, the module forms an Autonomous GO without negotiating with any other device.
  device_name	Device name for the module. The maximum length of this field is 32 characters and the remaining bytes are filled with 0x00.
  Another Wi-Fi Direct device would see this name when it scans for Wi-Fi Direct nodes.
  channel	Operating channel number. The specified channel is used if the device becomes a GO or Autonomous GO
  ssid_post_fix	Used to add a postfix to the SSID in Wi-Fi Direct GO mode and Autonomous GO mode.
  psk	Passphrase of a maximum length of 63 characters (a null character should be supplied to make it 64 bytes in the structure).
  PSK used if the module becomes a GO owner.
  wlan_wfd_discovery_notify_handler	Asynchronous message sent from module to the host when module finds any Wi-Fi Direct node.
  Parameters involved are status, buffer. & length
  status	Response status. If status is zero, it means that the wfd device response has some device information
  buffer	Response buffer.
  Length	Response buffer length
  wlan_wfd_connection_request_notify_handler	Asynchronous message sent from module to the host when module receives a connection request from any remote Wi-Fi Direct node.
  Parameters involved are status, buffer, & length
  status	Response status. If status is zero, it means that the connection request has come from some device.
  buffer	Response buffer
  length	Response buffer length

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -3 - Command given in wrong state -4 - Buffer not available to serve the command If return value is greater than 0 0x001D, 0x0021, 0x002C, 0x0015

rsi_wlan_wfd_connect#

int32_t rsi_wlan_wfd_connect (int8_t * device_name, void(*)(uint16_t status, const uint8_t *buffer, const uint16_t length) join_response_handler, device_name, join_response_handler, status, buffer, length, <nodetype>)

A join_response_handler() API that connects to the specified Wi-Fi-Direct device.This is a non-blocking API. if join_response_handler() is registered through rsi_wlan_register_callbacks(), it's non blocking, otherwise, a blocking call.

• rsi_wlan_wfd_start_discovery() API needs to be called before this API.

Note

• The module gets a default IP of 192.168.100.76 if it becomes a Group Owner or Access Point in case of IPv4. and gets a default IP of 2001:db8:0:1:0:0:0:120 in case of IPv6.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4 - Buffer not available to serve the command If return value is greater than 0 0x0014, 0x0009, 0x0003, 0x0021, 0x0012c 0x0015

rsi_wlan_send_data#

int32_t rsi_wlan_send_data (uint8_t * buffer, uint32_t length)

Send the raw data in TCP/IP bypass mode. This is a blocking API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -2 - Invalid Parameters -4 - Buffer not available to serve the command If return value is greater than 0 0x0021,0x002C,0x0025

rsi_wlan_ping_async#

int32_t rsi_wlan_ping_async (uint8_t flags, uint8_t * ip_address, uint16_t size, void(*)(uint16_t status, const uint8_t *buffer, const uint16_t length) wlan_ping_response_handler, status, buffer, length)

Send a ping request to the target IP address. If wlan_ping_response_handler() is registered through rsi_wlan_register_callbacks(), it's non blocking, otherwise, a blocking call.

• rsi_config_ipaddress() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -2 - Invalid parameters -4 - Buffer not available to serve the command If return value is greater than 0 0x0015,0xBB21,0xBB4B,0xBB55

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_register_auto_config_rsp_handler#

void rsi_register_auto_config_rsp_handler (void(*)(uint16_t status, uint8_t state) rsi_auto_config_rsp_handler, status, state)

Register auto-configuration response handler.. This is a non-blocking API.

Returns

• Void

rsi_wlan_add_profile#

int32_t rsi_wlan_add_profile (uint32_t type, uint8_t * profile)

Add profile for auto configuration. This is a blocking API.

Note

• This API is not supported in current release.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure -4 - Buffer not availableto serve the command

rsi_wlan_get_state#

uint8_t rsi_wlan_get_state (void )

Get the current WLAN state.. This is a non-blocking API.

Returns

• Return the current WLAN state. WLAN states are as follows: RSI_WLAN_STATE_NONE = 0, RSI_WLAN_STATE_OPERMODE_DONE, RSI_WLAN_STATE_BAND_DONE, RSI_WLAN_STATE_INIT_DONE, RSI_WLAN_STATE_SCAN_DONE, RSI_WLAN_STATE_CONNECTED, RSI_WLAN_STATE_IP_CONFIG_DONE, RSI_WLAN_STATE_IPV6_CONFIG_DONE, RSI_WLAN_STATE_AUTO_CONFIG_GOING_ON, RSI_WLAN_STATE_AUTO_CONFIG_DONE, RSI_WLAN_STATE_AUTO_CONFIG_FAILED

rsi_wlan_get_profile#

int32_t rsi_wlan_get_profile (uint32_t type, rsi_config_profile_t * profile_rsp, uint16_t length)

Get the stored config profile. This is a blocking API.

Note

• This API is not supported in current release.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4 - Buffer not available to serve the command

rsi_fill_config_profile#

uint8_t* rsi_fill_config_profile (uint32_t type, uint8_t * profile_buffer)

Fill the config profile based on the profile type.. This is a non-blocking API.

• rsi_wireless_init() API needs to be called before this API.

Returns

• profile_buffer

rsi_wlan_delete_profile#

int32_t rsi_wlan_delete_profile (uint32_t type)

Delete stored configuration based on profile type. This is a blocking API.

Note

• This API is not supported in current release.

• rsi_wireless_init() API needs to be called before this API.

Returns

• 0 - Success Non-Zero Value - Failure If return value is less than 0 -4 - Buffer not available to serve the command

rsi_wlan_enable_auto_config#

int32_t rsi_wlan_enable_auto_config (uint8_t enable, uint32_t type)

Enable or disable auto-config with respect to profile. This is a blocking API.

• rsi_wlan_set() API needs to be called before this API.

Note

• Possible profile types: // Client profile #define RSI_WLAN_PROFILE_CLIENT 0 // P2P profile #define RSI_WLAN_PROFILE_P2P 1 // EAP profile #define RSI_WLAN_PROFILE_EAP 2 // AP profile #define RSI_WLAN_PROFILE_AP 6 // All profiles #define RSI_WLAN_PROFILE_ALL 0xF

Returns

• 0 - Success Non-Zero Value - Failure -4 - Buffer not available to serve the command

Note

• If user tries to give any other command during autojoin, then user gets error 0x002C. To avoid this, user have to disable auto_join feature and give other commands.

• The parameters of the following APIs are saved when rsi_wlan_enable_auto_config() is called: rsi_wireless_init(), rsi_wlan_scan(), rsi_wlan_scan_with_bitmap_options(), rsi_wlan_connect(), rsi_config_ipaddress(), rsi_wireless_antenna(), rsi_wlan_bgscan_profile(), rsi_radio_caps(), rsi_wlan_ap_start

rsi_wlan_pmk_generate#

int32_t rsi_wlan_pmk_generate (int8_t type, int8_t * psk, int8_t * ssid, uint8_t * pmk, uint16_t length, 32-byte)

Generate PMK if PSK and SSID are provided. This is a blocking API.

• rsi_wlan_connect() API needs to be called before this API.

Returns

• 0 - Successful execution of the command. If TYPE value is 3. Non-Zero Value - Failure If return value is greater than 0 0x0021, 0x0025,0x0026,0x0028,0x002C,0x0039,0x003a, 0x003b

Note

• Refer to Error Codes section for the description of the above error codes Error Codes.

rsi_wlan_set_sleep_timer#

int16_t rsi_wlan_set_sleep_timer (uint16_t sleep_time)

Configure the sleep timer mode of the module to go into sleep during power save operation. This is a blocking API.

• Can be issued any time in case of power save mode 9 (MSG_BASED).

Returns

• 0 - Success Non-Zero Value - Failure

rsi_wlan_register_callbacks#

uint16_t rsi_wlan_register_callbacks (uint32_t callback_id, void(*)(uint16_t status, uint8_t *buffer, const uint32_t length) callback_handler_ptr, status, buffer, length, (void*)callback_handler_ptr)

Register the WLAN callback functions. This is a non-blocking API.

Note

• Refer to Error Codes section for the description of the above error codes Error Codes

Prototypes of the callback functions with given callback id#