alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

refactor(wifi): Add deprecated attribute for WiFi multiple antennas api

Browse Source
This commit is contained in:
alanmaxwell 2023-10-18 20:32:16 +08:00
parent 92e76a3434
commit 0f73cf50fb
3 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
components/esp_wifi/include/esp_wifi.h
View File

@ -1149,7 +1149,7 @@ esp_err_t esp_wifi_set_csi(bool en);
* - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init
* - ESP_ERR_INVALID_ARG: Invalid argument, e.g. parameter is NULL, invalid GPIO number etc
*/
esp_err_t esp_wifi_set_ant_gpio(const wifi_ant_gpio_config_t *config);
esp_err_t esp_wifi_set_ant_gpio(const wifi_ant_gpio_config_t *config) __attribute__((deprecated("Please use esp_phy_set_ant_gpio instead")));
/**
* @brief Get current antenna GPIO configuration
@ -1161,7 +1161,7 @@ esp_err_t esp_wifi_set_ant_gpio(const wifi_ant_gpio_config_t *config);
* - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init
* - ESP_ERR_INVALID_ARG: invalid argument, e.g. parameter is NULL
*/
esp_err_t esp_wifi_get_ant_gpio(wifi_ant_gpio_config_t *config);
esp_err_t esp_wifi_get_ant_gpio(wifi_ant_gpio_config_t *config) __attribute__((deprecated("Please use esp_phy_get_ant_gpio instead")));
/**
@ -1174,7 +1174,7 @@ esp_err_t esp_wifi_get_ant_gpio(wifi_ant_gpio_config_t *config);
* - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init
* - ESP_ERR_INVALID_ARG: Invalid argument, e.g. parameter is NULL, invalid antenna mode or invalid GPIO number
*/
esp_err_t esp_wifi_set_ant(const wifi_ant_config_t *config);
esp_err_t esp_wifi_set_ant(const wifi_ant_config_t *config) __attribute__((deprecated("Please use esp_phy_set_ant instead")));
/**
* @brief Get current antenna configuration
@ -1186,7 +1186,7 @@ esp_err_t esp_wifi_set_ant(const wifi_ant_config_t *config);
* - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by esp_wifi_init
* - ESP_ERR_INVALID_ARG: invalid argument, e.g. parameter is NULL
*/
esp_err_t esp_wifi_get_ant(wifi_ant_config_t *config);
esp_err_t esp_wifi_get_ant(wifi_ant_config_t *config) __attribute__((deprecated("Please use esp_phy_get_ant instead")));
/**
* @brief Get the TSF time

5
docs/en/migration-guides/release-5.x/5.2/wifi.rst
View File

@ -21,3 +21,8 @@ For the event WIFI_EVENT_STA_DISCONNECTED, the original reason code WIFI_REASON_
- REASON_NO_AP_FOUND_W_COMPATIBLE_SECURITY
For details, please refer to :ref:`esp_wifi_reason_code`.
WiFi Multiple Antennas
----------------------
WiFi multiple antennas api will be deprecated. Please use newer APIs from `esp_phy.h`.

4
docs/zh_CN/migration-guides/release-5.x/5.2/wifi.rst
View File

@ -8,3 +8,7 @@ Wi-Fi 企业级安全
------------------------
在 `esp_wpa2.h` 中定义的 API 已弃用，请使用来自 `esp_eap_client.h` 的新 API。
Wi-Fi 多天线
------------------------
Wi-Fi 多天线相关的 API 将要被弃用，请使用来自 `esp_phy.h` 的新 API。