Radio#
Functions#
Get the maximum Wi-Fi transmit power.
Set the maximum Wi-Fi transmit power.
Set the Wi-Fi antenna for an interface.
Get the Wi-Fi antenna for an interface.
Get the current channel for the given Wi-Fi interface.
Set the channel for the given Wi-Fi Access Point interface.
Set the Wi-Fi transmit rate for the given 802.11 protocol on the specified Wi-Fi interface.
Get the Wi-Fi transmit rate for the given 802.11 protocol on the specified Wi-Fi interface.
Set the Wi-Fi client interface listen interval.
Get the Wi-Fi client listen interval.
Assign the user configurable channel gain values in different regions to the module from user.
Configure the 11ax params.This is a blocking API.
Function Documentation#
sl_wifi_get_max_tx_power#
sl_status_t sl_wifi_get_max_tx_power (sl_wifi_interface_t interface, sl_wifi_max_tx_power_t * max_tx_power)
Get the maximum Wi-Fi transmit power.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[out] | max_tx_power | A variable that contains current maximum transmit power as identified by by sl_wifi_max_tx_power_t. |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
This function gets the transmit power for a particular radio interface: SL_WIFI_2_4GHZ_INTERFACE or SL_WIFI_5GHZ_INTERFACE.
177
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_set_max_tx_power#
sl_status_t sl_wifi_set_max_tx_power (sl_wifi_interface_t interface, sl_wifi_max_tx_power_t max_tx_power)
Set the maximum Wi-Fi transmit power.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[in] | max_tx_power | Max transmission power as identified by sl_wifi_max_tx_power_t |
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
This function sets the transmit power for a particular radio interface: SL_WIFI_2_4GHZ_INTERFACE or SL_WIFI_5GHZ_INTERFACE. Eg: Setting transmit power for client interface at 2.4GHz will also set transmit power of the AP interface at 2.4GHz.
The effective transmit power is subject to regional and device limitations. If the specified transmit power exceeds the maximum supported value for that region, the transmission will occur at the maximum supported transmit power.
195
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_set_antenna#
sl_status_t sl_wifi_set_antenna (sl_wifi_interface_t interface, sl_wifi_antenna_t antenna)
Set the Wi-Fi antenna for an interface.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[in] | antenna | Antenna to select as identified by sl_wifi_antenna_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
210
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_get_antenna#
sl_status_t sl_wifi_get_antenna (sl_wifi_interface_t interface, sl_wifi_antenna_t * antenna)
Get the Wi-Fi antenna for an interface.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[out] | antenna | sl_wifi_antenna_t object that contains current antenna selection. |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
225
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_get_channel#
sl_status_t sl_wifi_get_channel (sl_wifi_interface_t interface, sl_wifi_channel_t * channel)
Get the current channel for the given Wi-Fi interface.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[out] | channel | sl_wifi_channel_t object that contains current channel information. |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
240
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_set_channel#
sl_status_t sl_wifi_set_channel (sl_wifi_interface_t interface, sl_wifi_channel_t channel)
Set the channel for the given Wi-Fi Access Point interface.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[in] | channel | Channel as identified by sl_wifi_channel_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
255
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_set_transmit_rate#
sl_status_t sl_wifi_set_transmit_rate (sl_wifi_interface_t interface, sl_wifi_rate_protocol_t rate_protocol, sl_wifi_rate_t mask)
Set the Wi-Fi transmit rate for the given 802.11 protocol on the specified Wi-Fi interface.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[in] | rate_protocol | 802.11 protocol as identified by sl_wifi_rate_protocol_t |
[in] | mask | Data rate as identified by sl_wifi_rate_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
272
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_get_transmit_rate#
sl_status_t sl_wifi_get_transmit_rate (sl_wifi_interface_t interface, sl_wifi_rate_protocol_t * rate_protocol, sl_wifi_rate_t * mask)
Get the Wi-Fi transmit rate for the given 802.11 protocol on the specified Wi-Fi interface.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[out] | rate_protocol | 802.11 protocol as identified by sl_wifi_rate_protocol_t |
[out] | mask | Data rate as identified by sl_wifi_rate_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
291
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_set_listen_interval#
sl_status_t sl_wifi_set_listen_interval (sl_wifi_interface_t interface, sl_wifi_listen_interval_t listen_interval)
Set the Wi-Fi client interface listen interval.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[in] | listen_interval | sl_wifi_listen_interval_t object |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
By default listen interval is set 1000 millisecs. User can call this API to overwrite the value. Si91X implementation allows this API ONLY to be called before calling sl_wifi_connect(), sl_wifi_start_ap(), sl_wifi_start_wps()
311
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_get_listen_interval#
sl_status_t sl_wifi_get_listen_interval (sl_wifi_interface_t interface, sl_wifi_listen_interval_t * listen_interval)
Get the Wi-Fi client listen interval.
[in] | interface | Wi-Fi interface as identified by sl_wifi_interface_t |
[out] | listen_interval | sl_wifi_listen_interval_t object that will contain the current listen interval. |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
By default, the listen interval is set to 1000 millisecs.
328
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_update_gain_table#
sl_status_t sl_wifi_update_gain_table (uint8_t band, uint8_t bandwidth, uint8_t * payload, uint16_t payload_len)
Assign the user configurable channel gain values in different regions to the module from user.
[in] | band | 1 - 2.4GHz, 2 - 5GHz |
[in] | bandwidth | 0 - 20 MHz, 1 - 40 MHz |
[in] | payload | Pass channel gain values for different regions in a given array format. |
[in] | payload_len | Max payload length (table size) in 2.4GHz is 128 bytes and in 5GHz is 64 bytes. |
Pre-conditions:
This method is used for overwriting default gain tables that are present in firmware.
Pre-conditions:
Customer can load all the three gain tables (i.e., 2.4GHz-20Mhz, 5GHz-20Mhz, 5GHz-40Mhz) one the after other by changing band and bandwidth values.
Pre-conditions:
This is a blocking API.
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
Note
This frame must be used only by customers who have done FCC/ETSI/TELEC/KCC certification with their own antenna. Silicon Labs is not liable for inappropriate usage of this frame that may result in violation of FCC/ETSI/TELEC/KCC or any certifications.
Internally, firmware maintains two tables: Worldwide table & Region-based table. Worldwide table is populated by the firmware with max power values that the chip can transmit and meet target specs like EVM. Region-based table has a default gain value set.
When certifying with user antenna, the Region has to be set to Worldwide and sweep the power from 0 to 21 dBm. Arrive at a max power level that will pass certifications, especially band-edge.
The FCC/ETSI/TELEC/KCC max power level should be loaded in an end-to-end mode via WLAN User Gain table. This has to be called done for every boot-up as this information is not saved inside the flash. Region-based user gain table sent by the application is copied onto the Region-based table. SoC uses this table in FCC/ETSI/TELEC/KCC to limit the power and to not violate the allowed limits.
For Worldwide region, the firmware uses the Worldwide table for Tx. For other regions (FCC/ETSI/TELEC/KCC), the firmware uses the min value out of the Worldwide & Region-based table for Tx. Also, there will be part to part variation across the chips. Offsets that are estimated during the flow of manufacture will be applied as correction factor during normal mode of operation.
In a 2.4 Ghz band, 40 Mhz is not supported.
365
of file components/protocol/wifi/inc/sl_wifi.h
sl_wifi_set_11ax_config#
sl_status_t sl_wifi_set_11ax_config (uint8_t guard_interval)
Configure the 11ax params.This is a blocking API.
[in] | guard_interval | Period of time delta between two packets in wireless transmission. Valid values : 0 - 3 (0 = 8us, 1 = 16us, 2 = 32us, 3 = 64us). |
Pre-conditions:
This API should be called before sl_wifi_connect
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/4.1/common/api/group-status for details.
378
of file components/protocol/wifi/inc/sl_wifi.h