Wi-Fi#
Functions#
Initialize the WLAN control block structure.
Fill the command information and place it in the WLAN TX queue.
Extract file name from the received JSON data.
Process received WLAN commands.
Get WLAN status.
Set the WLAN status.
Post on a waiting semaphore.
Check if any socket command is in waiting state.
Check if any WLAN command is in waiting state.
Receive raw data packet from module.
Handle packet transfer completion.
Clear TX packet, if TX buffer is full.
Check if the common buffer is full.
Wait for WLAN semaphore.
Update the WLAN command state to free state.
Update the WLAN command state to progress state.
Posts all waiting WLAN semaphores. This API is typically used to reset the semaphore states.
Function Documentation#
rsi_wlan_cb_init#
int8_t rsi_wlan_cb_init (rsi_wlan_cb_t * wlan_cb)
Initialize the WLAN control block structure.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_wlan_cb_t * | [in] | wlan_cb | - Pointer to WLAN cb structure |
Returns
0 - Success
Non Zero Value - Failure
rsi_driver_wlan_send_cmd#
int32_t rsi_driver_wlan_send_cmd (rsi_wlan_cmd_request_t cmd, rsi_pkt_t * pkt)
Fill the command information and place it in the WLAN TX queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_wlan_cmd_request_t | [in] | cmd | - Type of the command to send |
| rsi_pkt_t * | [in] | pkt | - Pointer of the packet to send |
Returns
0 - Success
Non Zero Value - Failure
rsi_extract_filename#
uint8_t * rsi_extract_filename (uint8_t * json, uint8_t * buffer)
Extract file name from the received JSON data.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| uint8_t * | [in] | json | - json object data string |
| uint8_t * | [in] | buffer | - contains file name |
Returns
File name extracted
rsi_driver_process_wlan_recv_cmd#
int32_t rsi_driver_process_wlan_recv_cmd (rsi_pkt_t * pkt)
Process received WLAN commands.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_pkt_t * | [in] | pkt | - Pointer to received RX packet |
Returns
0 - Success
Non-Zero Value - Failure
Note
Memory allocation for the pointer is from receive handler, after processing, it will be freed.
rsi_check_wlan_state#
uint32_t rsi_check_wlan_state (void )
Get WLAN status.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
Wlan block status
0 - RSI_WLAN_STATE_NONE
1 - RSI_WLAN_STATE_OPERMODE_DONE
2 - RSI_WLAN_STATE_BAND_DONE
3 - RSI_WLAN_STATE_INIT_DONE
4 - RSI_WLAN_STATE_SCAN_DONE
5 - RSI_WLAN_STATE_CONNECTED
6 - RSI_WLAN_STATE_IP_CONFIG_DONE
7 - RSI_WLAN_STATE_IPV6_CONFIG_DONE
8 - RSI_WLAN_STATE_AUTO_CONFIG_GOING_ON
9 - RSI_WLAN_STATE_AUTO_CONFIG_DONE
10- RSI_WLAN_STATE_AUTO_CONFIG_FAILED
rsi_wlan_set_status#
void rsi_wlan_set_status (int32_t status)
Set the WLAN status.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| int32_t | [in] | status | - Status value to be set |
Returns
void
rsi_post_waiting_semaphore#
int32_t rsi_post_waiting_semaphore (void )
Post on a waiting semaphore.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
0 - Success
Non-Zero Value - Failure
rsi_wlan_check_waiting_socket_cmd#
int32_t rsi_wlan_check_waiting_socket_cmd (void )
Check if any socket command is in waiting state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
0 - No socket command is in waiting state
1 - Socket command is in waiting state
rsi_wlan_check_waiting_wlan_cmd#
int32_t rsi_wlan_check_waiting_wlan_cmd (void )
Check if any WLAN command is in waiting state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
0 - Success
Non-Zero Value - Failure
rsi_wlan_process_raw_data#
void rsi_wlan_process_raw_data (rsi_pkt_t * pkt)
Receive raw data packet from module.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_pkt_t * | [in] | pkt | - pointer to RX pkt |
Returns
Void
Note
Memory allocation for the pointer is from receive handler ,after processing, it will be freed.
rsi_wlan_packet_transfer_done#
void rsi_wlan_packet_transfer_done (rsi_pkt_t * pkt)
Handle packet transfer completion.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_pkt_t * | [in] | pkt | - pointer to packet |
Returns
void
rsi_check_wlan_buffer_full#
void rsi_check_wlan_buffer_full (rsi_pkt_t * pkt)
Clear TX packet, if TX buffer is full.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_pkt_t * | [in] | pkt | - Buffer pointer |
Note
BUFFER_FULL_HANDLING macro should be enabled.
Returns
Void
rsi_check_common_buffer_full#
void rsi_check_common_buffer_full (rsi_pkt_t * pkt)
Check if the common buffer is full.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_pkt_t * | [in] | pkt | - Buffer pointer |
Returns
void
rsi_wait_on_wlan_semaphore#
rsi_error_t rsi_wait_on_wlan_semaphore (rsi_semaphore_handle_t * semaphore, uint32_t timeout_ms)
Wait for WLAN semaphore.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | [in] | semaphore | - Semaphore handle pointer |
| uint32_t | [in] | timeout_ms | - Maximum time to wait to acquire semaphore. |
Returns
0 - Success
Non-Zero Value - Failure
rsi_update_wlan_cmd_state_to_free_state#
void rsi_update_wlan_cmd_state_to_free_state (void )
Update the WLAN command state to free state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
Void
rsi_update_wlan_cmd_state_to_progress_state#
void rsi_update_wlan_cmd_state_to_progress_state (void )
Update the WLAN command state to progress state.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
Void
rsi_post_waiting_wlan_semaphore#
int32_t rsi_post_waiting_wlan_semaphore (void )
Posts all waiting WLAN semaphores. This API is typically used to reset the semaphore states.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | [in] |
Returns
0 - Success
Non-Zero Value - Failure
rsi_call_asynchronous_callback#
void rsi_call_asynchronous_callback ()