diff --git a/components/esp_wifi/include/esp_wifi.h b/components/esp_wifi/include/esp_wifi.h index b076b11b97..6e084bb195 100644 --- a/components/esp_wifi/include/esp_wifi.h +++ b/components/esp_wifi/include/esp_wifi.h @@ -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 diff --git a/docs/en/migration-guides/release-5.x/5.2/wifi.rst b/docs/en/migration-guides/release-5.x/5.2/wifi.rst index 3e006d0be0..6340d95c0c 100644 --- a/docs/en/migration-guides/release-5.x/5.2/wifi.rst +++ b/docs/en/migration-guides/release-5.x/5.2/wifi.rst @@ -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`. diff --git a/docs/zh_CN/migration-guides/release-5.x/5.2/wifi.rst b/docs/zh_CN/migration-guides/release-5.x/5.2/wifi.rst index 249dab8a34..213fa0b5ae 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.2/wifi.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.2/wifi.rst @@ -8,3 +8,7 @@ Wi-Fi 企业级安全 ------------------------ 在 `esp_wpa2.h` 中定义的 API 已弃用,请使用来自 `esp_eap_client.h` 的新 API。 + +Wi-Fi 多天线 +------------------------ +Wi-Fi 多天线相关的 API 将要被弃用,请使用来自 `esp_phy.h` 的新 API。