Merge branch 'bugfix/fixes_from_github' into 'master'

fixes for github issues This MR includes commits from several Github PRs, as well some fixes for issues reported on Github and on the forum. - compile PHY-related code only when WiFi is enabled - fix macOS setup instructions - fix some of the Sphinx warnings - update docs index, improve structure of the readme- - wifi: fix typos, rename ESP_ERR_WIFI_NOT_START to ESP_ERR_WIFI_NOT_STARTED - sdmmc: fix explanation of flash voltage regulator configuration efuses - sdmmc: change idx num of example - fix i2c_get_period name - fix esp_log_level_set function name in docs See merge request !420
2025-08-08 20:21:04 +00:00 · 2017-01-16 10:26:58 +08:00
parent 27711b7c22 ea19838d3a
commit 72da7aa53b
20 changed files with 106 additions and 90 deletions
--- a/components/esp32/component.mk
+++ b/components/esp32/component.mk
@@ -3,8 +3,15 @@
 #

 COMPONENT_SRCDIRS := . hwcrypto
+LIBS := core rtc phy
+ifdef CONFIG_BT_ENABLED
+LIBS += coexist
+endif
+ifdef CONFIG_WIFI_ENABLED
+LIBS += net80211 pp wpa smartconfig coexist wps wpa2
+endif

-LIBS := core net80211 phy rtc pp wpa smartconfig coexist wps wpa2
+LIBS := $(sort $(LIBS))  # de-duplicate, we can handle different orders here

 LINKER_SCRIPTS += esp32.common.ld esp32.rom.ld esp32.peripherals.ld

--- a/components/esp32/cpu_start.c
+++ b/components/esp32/cpu_start.c
@@ -71,9 +71,11 @@ static bool app_cpu_started = false;
 #endif //!CONFIG_FREERTOS_UNICORE

 static void do_global_ctors(void);
-static void do_phy_init();
 static void main_task(void* args);
 extern void app_main(void);
+#if CONFIG_ESP32_PHY_AUTO_INIT
+static void do_phy_init();
+#endif

 extern int _bss_start;
 extern int _bss_end;
@@ -264,6 +266,7 @@ static void main_task(void* args)
    vTaskDelete(NULL);
 }

+#if CONFIG_ESP32_PHY_AUTO_INIT
 static void do_phy_init()
 {
    esp_phy_calibration_mode_t calibration_mode = PHY_RF_CAL_PARTIAL;
@@ -297,3 +300,5 @@ static void do_phy_init()
    esp_phy_release_init_data(init_data);
    free(cal_data); // PHY maintains a copy of calibration data, so we can free this
 }
+#endif //CONFIG_ESP32_PHY_AUTO_INIT
+
--- a/components/esp32/include/esp_wifi.h
+++ b/components/esp32/include/esp_wifi.h
@@ -62,6 +62,7 @@
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
 #include "rom/queue.h"
+#include "sdkconfig.h"
 #include "esp_err.h"
 #include "esp_wifi_types.h"
 #include "esp_event.h"
@@ -76,8 +77,8 @@ extern "C" {
 #define ESP_ERR_WIFI_ARG         ESP_ERR_INVALID_ARG       /*!< Invalid argument */
 #define ESP_ERR_WIFI_NOT_SUPPORT ESP_ERR_NOT_SUPPORTED     /*!< Indicates that API is not supported yet */

-#define ESP_ERR_WIFI_NOT_INIT    (ESP_ERR_WIFI_BASE + 1)   /*!< WiFi driver is not installed by esp_wifi_init */
-#define ESP_ERR_WIFI_NOT_START   (ESP_ERR_WIFI_BASE + 2)   /*!< WiFi driver is not started by esp_wifi_start */
+#define ESP_ERR_WIFI_NOT_INIT    (ESP_ERR_WIFI_BASE + 1)   /*!< WiFi driver was not installed by esp_wifi_init */
+#define ESP_ERR_WIFI_NOT_STARTED (ESP_ERR_WIFI_BASE + 2)   /*!< WiFi driver was not started by esp_wifi_start */
 #define ESP_ERR_WIFI_IF          (ESP_ERR_WIFI_BASE + 3)   /*!< WiFi interface error */
 #define ESP_ERR_WIFI_MODE        (ESP_ERR_WIFI_BASE + 4)   /*!< WiFi mode error */
 #define ESP_ERR_WIFI_STATE       (ESP_ERR_WIFI_BASE + 5)   /*!< WiFi internal state error */
@@ -85,7 +86,7 @@ extern "C" {
 #define ESP_ERR_WIFI_NVS         (ESP_ERR_WIFI_BASE + 7)   /*!< WiFi internal NVS module error */
 #define ESP_ERR_WIFI_MAC         (ESP_ERR_WIFI_BASE + 8)   /*!< MAC address is invalid */
 #define ESP_ERR_WIFI_SSID        (ESP_ERR_WIFI_BASE + 9)   /*!< SSID is invalid */
-#define ESP_ERR_WIFI_PASSWORD    (ESP_ERR_WIFI_BASE + 10)  /*!< Passord is invalid */
+#define ESP_ERR_WIFI_PASSWORD    (ESP_ERR_WIFI_BASE + 10)  /*!< Password is invalid */
 #define ESP_ERR_WIFI_TIMEOUT     (ESP_ERR_WIFI_BASE + 11)  /*!< Timeout error */
 #define ESP_ERR_WIFI_WAKE_FAIL   (ESP_ERR_WIFI_BASE + 12)  /*!< WiFi is in sleep state(RF closed) and wakeup fail */

@@ -97,11 +98,14 @@ typedef struct {
    uint32_t rx_buf_num;  /**< WiFi RX buffer number */
 } wifi_init_config_t;

-
+#ifdef CONFIG_WIFI_ENABLED
 #define WIFI_INIT_CONFIG_DEFAULT() { \
    .event_handler = &esp_event_send, \
    .rx_buf_num = CONFIG_ESP32_WIFI_RX_BUFFER_NUM, \
 };
+#else
+#define WIFI_INIT_CONFIG_DEFAULT #error Wifi is disabled in config, WIFI_INIT_CONFIG_DEFAULT will not work
+#endif

 /**
  * @brief  Init WiFi
@@ -222,8 +226,8 @@ esp_err_t esp_wifi_connect(void);
  *
  * @return
  *    - ESP_OK: succeed
-  *    - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
-  *    - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+  *    - ESP_ERR_WIFI_NOT_INIT: WiFi was not initialized by eps_wifi_init
+  *    - ESP_ERR_WIFI_NOT_STARTED: WiFi was not started by esp_wifi_start
  *    - ESP_ERR_WIFI_FAIL: other WiFi internal errors
  */
 esp_err_t esp_wifi_disconnect(void);
@@ -246,7 +250,7 @@ esp_err_t esp_wifi_clear_fast_connect(void);
  * @return
  *    - ESP_OK: succeed
  *    - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
-  *    - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+  *    - ESP_ERR_WIFI_NOT_STARTED: WiFi was not started by esp_wifi_start
  *    - ESP_ERR_WIFI_ARG: invalid argument
  *    - ESP_ERR_WIFI_MODE: WiFi mode is wrong
  */
@@ -266,7 +270,7 @@ esp_err_t esp_wifi_deauth_sta(uint16_t aid);
  * @return
  *    - ESP_OK: succeed
  *    - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
-  *    - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+  *    - ESP_ERR_WIFI_NOT_STARTED: WiFi was not started by esp_wifi_start
  *    - ESP_ERR_WIFI_TIMEOUT: blocking scan is timeout
  *    - others: refer to error code in esp_err.h
  */
@@ -278,7 +282,7 @@ esp_err_t esp_wifi_scan_start(wifi_scan_config_t *config, bool block);
  * @return
  *    - ESP_OK: succeed
  *    - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
-  *    - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+  *    - ESP_ERR_WIFI_NOT_STARTED: WiFi is not started by esp_wifi_start
  */
 esp_err_t esp_wifi_scan_stop(void);

@@ -292,7 +296,7 @@ esp_err_t esp_wifi_scan_stop(void);
  * @return
  *    - ESP_OK: succeed
  *    - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
-  *    - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+  *    - ESP_ERR_WIFI_NOT_STARTED: WiFi is not started by esp_wifi_start
  *    - ESP_ERR_WIFI_ARG: invalid argument
  */
 esp_err_t esp_wifi_scan_get_ap_num(uint16_t *number);
@@ -307,7 +311,7 @@ esp_err_t esp_wifi_scan_get_ap_num(uint16_t *number);
  * @return
  *    - ESP_OK: succeed
  *    - ESP_ERR_WIFI_NOT_INIT: WiFi is not initialized by eps_wifi_init
-  *    - ESP_ERR_WIFI_NOT_START: WiFi is not started by esp_wifi_start
+  *    - ESP_ERR_WIFI_NOT_STARTED: WiFi is not started by esp_wifi_start
  *    - ESP_ERR_WIFI_ARG: invalid argument
  *    - ESP_ERR_WIFI_NO_MEM: out of memory
  */
--- a/components/esp32/phy_init.c
+++ b/components/esp32/phy_init.c
@@ -23,10 +23,12 @@
 #include "esp_err.h"
 #include "esp_phy_init.h"
 #include "esp_system.h"
-#include "phy.h"
 #include "esp_log.h"
 #include "nvs.h"
 #include "sdkconfig.h"
+
+#ifdef CONFIG_WIFI_ENABLED
+#include "phy.h"
 #include "phy_init_data.h"

 static const char* TAG = "phy_init";
@@ -219,6 +221,4 @@ static esp_err_t store_cal_data_to_nvs_handle(nvs_handle handle,
    return err;
 }

-void register_chipv7_phy_stub()
-{
-}
+#endif // CONFIG_WIFI_ENABLED
--- a/components/esp32/system_api.c
+++ b/components/esp32/system_api.c
@@ -17,6 +17,7 @@
 #include "esp_wifi.h"
 #include "esp_wifi_internal.h"
 #include "esp_log.h"
+#include "sdkconfig.h"
 #include "rom/efuse.h"
 #include "rom/cache.h"
 #include "rom/uart.h"
@@ -74,7 +75,9 @@ esp_err_t system_efuse_read_mac(uint8_t mac[6]) __attribute__((alias("esp_efuse_

 void IRAM_ATTR esp_restart(void)
 {
+#ifdef CONFIG_WIFI_ENABLED
    esp_wifi_stop();
+#endif

    // Disable scheduler on this core.
    vTaskSuspendAll();