Power and Performance#
Functions#
Set Wi-Fi performance profile.
Set Wi-Fi performance profile.
Get Wi-Fi performance profile.
Get Wi-Fi performance profile.
Function Documentation#
sl_wifi_set_performance_profile#
sl_status_t sl_wifi_set_performance_profile (const sl_wifi_performance_profile_t * profile)
Set Wi-Fi performance profile.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const sl_wifi_performance_profile_t * | [in] | profile | Wi-Fi performance profile as indicated by sl_wifi_performance_profile_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.
Note
For SI91x chips Enhanced MAX PSP is supported when profile is set to ASSOCIATED_POWER_SAVE_LOW_LATENCY and SL_SI91X_ENABLE_ENHANCED_MAX_PSP bit is enabled in config feature bitmap
Moving forward, this API will be deprecated. Instead, use the sl_wifi_set_performance_profile_v2 API. This is retained for backward compatibility.
For further more details on connected and non-connected mode please refer https://www.silabs.com/documents/public/application-notes/an1430-siwx917-soc-low-power.pdf.
sl_wifi_set_performance_profile_v2#
sl_status_t sl_wifi_set_performance_profile_v2 (const sl_wifi_performance_profile_v2_t * profile)
Set Wi-Fi performance profile.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| const sl_wifi_performance_profile_v2_t * | [in] | profile | Wi-Fi performance profile as indicated by sl_wifi_performance_profile_v2_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.
Note
For SI91x chips Enhanced MAX PSP is supported when profile is set to ASSOCIATED_POWER_SAVE_LOW_LATENCY and SL_SI91X_ENABLE_ENHANCED_MAX_PSP bit is enabled in config feature bitmap
This v2 API is defined due to a new configuration member beacon_miss_ignore_limit added to the structure sl_wifi_performance_profile_v2_t. Default value for beacon_miss_ignore_limit is 1. Recommended max value is 10. Higher value may cause interop issues.
For further more details on connected and non-connected mode please refer https://www.silabs.com/documents/public/application-notes/an1430-siwx917-soc-low-power.pdf.
sl_wifi_get_performance_profile#
sl_status_t sl_wifi_get_performance_profile (sl_wifi_performance_profile_t * profile)
Get Wi-Fi performance profile.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_wifi_performance_profile_t * | [out] | profile | Wi-Fi performance profile as indicated by sl_wifi_performance_profile_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.
Note
Moving forward, this API will be deprecated. Instead, use the sl_wifi_get_performance_profile_v2 API. This is retained for backward compatibility.
sl_wifi_get_performance_profile_v2#
sl_status_t sl_wifi_get_performance_profile_v2 (sl_wifi_performance_profile_v2_t * profile)
Get Wi-Fi performance profile.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| sl_wifi_performance_profile_v2_t * | [out] | profile | Wi-Fi performance profile as indicated by sl_wifi_performance_profile_v2_t |
Pre-conditions:
sl_wifi_init should be called before this API.
Returns
sl_status_t. See https://docs.silabs.com/gecko-platform/latest/platform-common/status for details.