feat(esp_common): update esp_common

1. add Kconfig file and rename old global macro
2. move some independent files to esp_common

Author: donghengqaz

components/bootloader/subproject/CMakeLists.txt

@@ -18,7 +18,7 @@ endif()
 set(COMPONENTS bootloader esptool_py partition_table esp8266 bootloader_support log spi_flash main)
 set(BOOTLOADER_BUILD 1)
 include("${IDF_PATH}/tools/cmake/project.cmake")
-set(common_req log)
+set(common_req log esp_common)
 if(LEGACY_INCLUDE_COMMON_HEADERS)
     list(APPEND common_req soc)
 endif()

components/bootloader/subproject/Makefile

@@ -16,6 +16,7 @@ CXXFLAGS =
 
 #We cannot include the esp8266 component directly but we need its includes.
 CFLAGS += -I $(IDF_PATH)/components/esp8266/include -I $(IDF_PATH)/components/util/include
+CFLAGS += -I $(IDF_PATH)/components/esp_common/include
 
 # The bootloader pseudo-component is also included in this build, for its Kconfig.projbuild to be included.
 #

components/bootloader_support/src/bootloader_init.c

@@ -568,7 +568,7 @@ static void update_flash_config(const esp_image_header_t* pfhdr);
 
 static void uart_console_configure(void)
 {
-#if CONFIG_UART0_SWAP_IO
+#if CONFIG_ESP_UART0_SWAP_IO
     while (READ_PERI_REG(UART_STATUS(0)) & (UART_TXFIFO_CNT << UART_TXFIFO_CNT_S));
 
     PIN_FUNC_SELECT(PERIPHS_IO_MUX_MTCK_U, FUNC_UART0_CTS);
@@ -578,25 +578,25 @@ static void uart_console_configure(void)
     SET_PERI_REG_MASK(UART_SWAP_REG, 0x4);
 #endif
 
-#if CONFIG_CONSOLE_UART_NUM == 1
+#if CONFIG_ESP_CONSOLE_UART_NUM == 1
     PIN_FUNC_SELECT(PERIPHS_IO_MUX_GPIO2_U, FUNC_U1TXD_BK);
 
-    CLEAR_PERI_REG_MASK(UART_CONF1(CONFIG_CONSOLE_UART_NUM), UART_RX_FLOW_EN);
-    CLEAR_PERI_REG_MASK(UART_CONF0(CONFIG_CONSOLE_UART_NUM), UART_TX_FLOW_EN);
+    CLEAR_PERI_REG_MASK(UART_CONF1(CONFIG_ESP_CONSOLE_UART_NUM), UART_RX_FLOW_EN);
+    CLEAR_PERI_REG_MASK(UART_CONF0(CONFIG_ESP_CONSOLE_UART_NUM), UART_TX_FLOW_EN);
 
-    WRITE_PERI_REG(UART_CONF0(CONFIG_CONSOLE_UART_NUM),
+    WRITE_PERI_REG(UART_CONF0(CONFIG_ESP_CONSOLE_UART_NUM),
                    0                // None parity
                    | (1 << 4)       // 1-bit stop
                    | (3 << 2)       // 8-bit data
                    | 0              // None flow control
                    | 0);            // None Inverse
 
-    SET_PERI_REG_MASK(UART_CONF0(CONFIG_CONSOLE_UART_NUM), UART_RXFIFO_RST | UART_TXFIFO_RST);
-    CLEAR_PERI_REG_MASK(UART_CONF0(CONFIG_CONSOLE_UART_NUM), UART_RXFIFO_RST | UART_TXFIFO_RST);
+    SET_PERI_REG_MASK(UART_CONF0(CONFIG_ESP_CONSOLE_UART_NUM), UART_RXFIFO_RST | UART_TXFIFO_RST);
+    CLEAR_PERI_REG_MASK(UART_CONF0(CONFIG_ESP_CONSOLE_UART_NUM), UART_RXFIFO_RST | UART_TXFIFO_RST);
 #endif
 
-#ifdef CONFIG_CONSOLE_UART_BAUDRATE
-    uart_div_modify(CONFIG_CONSOLE_UART_NUM, BOOTLOADER_CONSOLE_CLK_FREQ / CONFIG_CONSOLE_UART_BAUDRATE);
+#ifdef CONFIG_ESP_CONSOLE_UART_BAUDRATE
+    uart_div_modify(CONFIG_ESP_CONSOLE_UART_NUM, BOOTLOADER_CONSOLE_CLK_FREQ / CONFIG_ESP_CONSOLE_UART_BAUDRATE);
 #endif
 }
 

components/esp8266/CMakeLists.txt

@@ -25,7 +25,6 @@ else()
         "source/chip_boot.c"
         "source/backtrace.c"
         "source/esp_sleep.c"
-        "source/esp_err_to_name.c"
         "source/esp_timer.c"
         "source/esp_wifi_os_adapter.c"
         "source/esp_wifi.c"
@@ -54,6 +53,7 @@ else()
 
     set(include_dirs "include" "include/driver")
 
+    set(requires "esp_common")
     set(priv_requires "wpa_supplicant" "log" "spi_flash" "tcpip_adapter" "esp_ringbuf" "bootloader_support" "nvs_flash" "util")
     set(fragments linker.lf ld/esp8266_fragments.lf ld/esp8266_bss_fragments.lf)
 

components/esp8266/Kconfig

@@ -94,67 +94,12 @@ config SOC_IRAM_SIZE
     default 0x8000 if SOC_FULL_ICACHE
     default 0xC000 if !SOC_FULL_ICACHE
 
-choice CONSOLE_UART
-    prompt "UART for console output"
-    default CONSOLE_UART_DEFAULT
-    help
-        Select whether to use UART for console output (through stdout and stderr).
-
-        - Default is to use UART0.
-        - If "Custom" is selected, UART0 or UART1 can be chosen.
-        - If "None" is selected, there will be no console output on any UART.
-
-config CONSOLE_UART_DEFAULT
-    bool "Default: UART0"
-config CONSOLE_UART_CUSTOM
-    bool "Custom"
-config CONSOLE_UART_NONE
-    bool "None"
-endchoice
-
-choice CONSOLE_UART_NUM
-    prompt "UART peripheral to use for console output (0-1)"
-    depends on CONSOLE_UART_CUSTOM
-    default CONSOLE_UART_CUSTOM_NUM_0
-    help
-        Configrate output console UART for "ets_printf", "printf", "ESP_LOGX" and so on.
-
-config CONSOLE_UART_CUSTOM_NUM_0
-    bool "UART0"
-config CONSOLE_UART_CUSTOM_NUM_1
-    bool "UART1"
-endchoice
-
-config CONSOLE_UART_NUM
-    int
-    default 0 if CONSOLE_UART_DEFAULT || CONSOLE_UART_NONE
-    default 0 if CONSOLE_UART_CUSTOM_NUM_0
-    default 1 if CONSOLE_UART_CUSTOM_NUM_1
-
-config CONSOLE_UART_BAUDRATE
-    int "UART console baud rate"
-    depends on CONSOLE_UART_DEFAULT || CONSOLE_UART_CUSTOM
-    default 74880
-    range 1200 4000000
-
-config UART0_SWAP_IO
-    bool "Swap UART0 I/O pins"
-    default n
-    help
-        Enable this option, UART0's I/O pins are swaped: TXD <-> RTS, RTX <-> CTS.
-
 config DISABLE_ROM_UART_PRINT
     bool "Disable ROM UART print"
     default n
     help
         "Disable main part of ROM UART print when rom bootloader process."
 
-config PANIC_FULL_STACK
-    bool "Output full stack data of task"
-    default n
-    help
-        Output full stack data of task although some stack space is not used.
-
 choice ESP_PANIC
     prompt "Panic handler behaviour"
     default ESP_PANIC_PRINT_REBOOT
@@ -189,51 +134,6 @@ config ESP_PANIC_GDBSTUB
         The UART's baudrate should be 115200 or others which can be recognized by xtensa GDB.
 endchoice
 
-config MAIN_TASK_STACK_SIZE
-    int "Main task stack size"
-    default 3584
-    help
-        Configure the "main task" stack size. This is the stack of the task
-        which calls app_main(). If app_main() returns then this task is deleted
-        and its stack memory is freed.
-
-config TASK_WDT
-    bool "Initialize Task Watchdog Timer on startup"
-    default y
-    help
-        The Task Watchdog Timer can be used to make sure individual tasks are still
-        running. Enabling this option will cause the Task Watchdog Timer to be
-        initialized automatically at startup. The Task Watchdog timer can be 
-        initialized after startup as well.
-
-config TASK_WDT_PANIC
-    bool "Invoke panic handler on Task Watchdog timeout"
-    default y
-    help
-        If this option is enabled, the Task Watchdog Timer will be configured to
-        trigger the panic handler when it times out. And it may cost some time.
-
-choice TASK_WDT_TIMEOUT_S
-    prompt "Task Watchdog timeout period (seconds)"
-    default TASK_WDT_TIMEOUT_15N
-    help
-        Timeout period configuration for the Task Watchdog Timer in seconds.
-        This is also configurable at run time.
-
-config TASK_WDT_TIMEOUT_13N
-    bool "6.5536s"
-config TASK_WDT_TIMEOUT_14N
-    bool "13.1072s"
-config TASK_WDT_TIMEOUT_15N
-    bool "26.2144s"
-endchoice
-
-config TASK_WDT_TIMEOUT_S
-    int
-    default 13 if TASK_WDT_TIMEOUT_13N
-    default 14 if TASK_WDT_TIMEOUT_14N
-    default 15 if TASK_WDT_TIMEOUT_15N
-
 config RESET_REASON
     bool "Enable reset reason"
     default y
@@ -249,12 +149,6 @@ config WIFI_PPT_TASKSTACK_SIZE
         which calls promiscuous callback function. So if user's function is
         complex, the stack must be set larger.
 
-config EVENT_LOOP_STACK_SIZE
-    int "Event loop stack size"
-    default 2048
-    help
-        Configure the Event loop task stack size per application.
-
 config ESP8266_CORE_GLOBAL_DATA_LINK_IRAM
     bool "Link libcore.a internal global data to IRAM"
     default y
@@ -307,16 +201,6 @@ config ESP8266_BOOT_COPY_APP
         Enable this option, when it is that "OTA1" application is to run after update by OTA,
         bootloader will copy "OTA1" application to "OTA0" partition and run "OTA0".
 
-config ESP_ERR_TO_NAME_LOOKUP
-    bool "Enable lookup of error code strings"
-    default "y"
-    help
-        Functions esp_err_to_name() and esp_err_to_name_r() return string
-        representations of error codes from a pre-generated lookup table.
-        This option can be used to turn off the use of the look-up table in
-        order to save memory but this comes at the price of sacrificing
-        distinguishable (meaningful) output string representations.
-
     choice ESP8266_TIME_SYSCALL
         prompt "Timers used for gettimeofday function"
         default ESP8266_TIME_SYSCALL_USE_FRC1

components/esp8266/Makefile.projbuild

@@ -42,7 +42,7 @@ ESP8266_COMPONENT_PATH := $(COMPONENT_PATH)
 
 $(PHY_INIT_DATA_OBJ): $(ESP8266_COMPONENT_PATH)/include/internal/phy_init_data.h $(BUILD_DIR_BASE)/include/sdkconfig.h
 	$(summary) CC $(notdir $@)
-	printf "#include \"internal/phy_init_data.h\"\n" | $(CC) -I $(BUILD_DIR_BASE)/include -I $(ESP8266_COMPONENT_PATH) -I $(ESP8266_COMPONENT_PATH)/include -c -o $@ -xc -
+	printf "#include \"internal/phy_init_data.h\"\n" | $(CC) -I $(BUILD_DIR_BASE)/include -I $(ESP8266_COMPONENT_PATH) -I $(ESP8266_COMPONENT_PATH)/include -I $(ESP8266_COMPONENT_PATH)/../esp_common/include -c -o $@ -xc -
 
 $(PHY_INIT_DATA_BIN): $(PHY_INIT_DATA_OBJ)
 	$(summary) BIN $(notdir $@)

components/esp8266/include/esp_event_loop.h

@@ -23,7 +23,7 @@
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
 
-#define EVENT_LOOP_STACKSIZE CONFIG_EVENT_LOOP_STACK_SIZE
+#define EVENT_LOOP_STACKSIZE CONFIG_ESP_SYSTEM_EVENT_TASK_STACK_SIZE
 
 #ifdef __cplusplus
 extern "C" {

components/esp8266/sdkconfig.rename

@@ -0,0 +1,17 @@
+# sdkconfig replacement configurations for deprecated options formatted as
+# CONFIG_DEPRECATED_OPTION CONFIG_NEW_OPTION
+
+CONFIG_MAIN_TASK_STACK_SIZE             CONFIG_ESP_MAIN_TASK_STACK_SIZE
+CONFIG_CONSOLE_UART                     CONFIG_ESP_CONSOLE_UART
+CONFIG_CONSOLE_UART_DEFAULT             CONFIG_ESP_CONSOLE_UART_DEFAULT
+CONFIG_CONSOLE_UART_CUSTOM              CONFIG_ESP_CONSOLE_UART_CUSTOM
+CONFIG_CONSOLE_UART_NONE                CONFIG_ESP_CONSOLE_UART_NONE
+CONFIG_CONSOLE_UART_NUM                 CONFIG_ESP_CONSOLE_UART_NUM
+CONFIG_CONSOLE_UART_CUSTOM_NUM_0        CONFIG_ESP_CONSOLE_UART_CUSTOM_NUM_0
+CONFIG_CONSOLE_UART_CUSTOM_NUM_1        CONFIG_ESP_CONSOLE_UART_CUSTOM_NUM_1
+CONFIG_CONSOLE_UART_BAUDRATE            CONFIG_ESP_CONSOLE_UART_BAUDRATE
+CONFIG_UART0_SWAP_IO                    CONFIG_ESP_UART0_SWAP_IO
+
+CONFIG_TASK_WDT                         CONFIG_ESP_TASK_WDT
+CONFIG_TASK_WDT_PANIC                   CONFIG_ESP_TASK_WDT_PANIC
+CONFIG_TASK_WDT_TIMEOUT_S               CONFIG_ESP_TASK_WDT_TIMEOUT_S

components/esp8266/source/ets_printf.c

@@ -24,17 +24,17 @@
 #include "esp8266/uart_register.h"
 #include "esp8266/rom_functions.h"
 
-#ifndef CONFIG_CONSOLE_UART_NONE
+#ifndef CONFIG_ESP_CONSOLE_UART_NONE
 static void uart_putc(int c)
 {
     while (1) {
-        uint32_t fifo_cnt = READ_PERI_REG(UART_STATUS(CONFIG_CONSOLE_UART_NUM)) & (UART_TXFIFO_CNT << UART_TXFIFO_CNT_S);
+        uint32_t fifo_cnt = READ_PERI_REG(UART_STATUS(CONFIG_ESP_CONSOLE_UART_NUM)) & (UART_TXFIFO_CNT << UART_TXFIFO_CNT_S);
 
         if ((fifo_cnt >> UART_TXFIFO_CNT_S & UART_TXFIFO_CNT) < 126)
             break;
     }
 
-    WRITE_PERI_REG(UART_FIFO(CONFIG_CONSOLE_UART_NUM) , c);
+    WRITE_PERI_REG(UART_FIFO(CONFIG_ESP_CONSOLE_UART_NUM) , c);
 }
 #else
 #define uart_putc(_c) { }

components/esp8266/source/phy_init.c

@@ -72,8 +72,8 @@ esp_err_t esp_phy_rf_init(const esp_phy_init_data_t* init_data, esp_phy_calibrat
     esp_err_t status = ESP_OK;
     uint8_t sta_mac[6];
     uint8_t *local_init_data = calloc(1, 256);
-#ifdef CONFIG_CONSOLE_UART_BAUDRATE
-    const uint32_t uart_baudrate = CONFIG_CONSOLE_UART_BAUDRATE;
+#ifdef CONFIG_ESP_CONSOLE_UART_BAUDRATE
+    const uint32_t uart_baudrate = CONFIG_ESP_CONSOLE_UART_BAUDRATE;
 #else
     const uint32_t uart_baudrate = 74880; // ROM default baudrate
 #endif

components/esp8266/source/startup.c

@@ -33,6 +33,7 @@
 
 #include "FreeRTOS.h"
 #include "task.h"
+#include "esp_task.h"
 
 #ifndef CONFIG_NEWLIB_LIBRARY_CUSTOMER
 #include "esp_newlib.h"
@@ -93,7 +94,7 @@ static void user_init_entry(void *param)
     esp_reset_reason_init();
 #endif
 
-#ifdef CONFIG_TASK_WDT
+#ifdef CONFIG_ESP_TASK_WDT
     esp_task_wdt_init();
 #endif
 
@@ -175,7 +176,7 @@ void call_start_cpu(size_t start_addr)
     esp_newlib_init();
 #endif
 
-    assert(xTaskCreate(user_init_entry, "uiT", CONFIG_MAIN_TASK_STACK_SIZE, NULL, configMAX_PRIORITIES, NULL) == pdPASS);
+    assert(xTaskCreate(user_init_entry, "uiT", ESP_TASK_MAIN_STACK, NULL, configMAX_PRIORITIES, NULL) == pdPASS);
 
     vTaskStartScheduler();
 }

components/esp8266/source/task_wdt.c

@@ -23,7 +23,7 @@
 
 static const char *TAG = "wdt";
 
-#ifdef CONFIG_TASK_WDT_PANIC
+#ifdef CONFIG_ESP_TASK_WDT_PANIC
 /**
   * @brief  Task watch dog interrupt function and it should do panic
   */
@@ -43,7 +43,7 @@ esp_err_t esp_task_wdt_init(void)
 {
     CLEAR_WDT_REG_MASK(WDT_CTL_ADDRESS, BIT0);
 
-#ifdef CONFIG_TASK_WDT_PANIC
+#ifdef CONFIG_ESP_TASK_WDT_PANIC
     const uint32_t panic_time_param = 11;
 
     // Just for soft restart
@@ -59,9 +59,9 @@ esp_err_t esp_task_wdt_init(void)
     const uint32_t panic_time_param = 1;
 #endif
 
-    ESP_LOGD(TAG, "task watch dog trigger time parameter is %u", CONFIG_TASK_WDT_TIMEOUT_S);
+    ESP_LOGD(TAG, "task watch dog trigger time parameter is %u", CONFIG_ESP_TASK_WDT_TIMEOUT_S);
 
-    WDT_REG_WRITE(WDT_OP_ADDRESS, CONFIG_TASK_WDT_TIMEOUT_S);   // 2^n * 0.8ms, mask 0xf, n = 13 -> (2^13 = 8192) * 0.8 * 0.001 = 6.5536
+    WDT_REG_WRITE(WDT_OP_ADDRESS, CONFIG_ESP_TASK_WDT_TIMEOUT_S);   // 2^n * 0.8ms, mask 0xf, n = 13 -> (2^13 = 8192) * 0.8 * 0.001 = 6.5536
     WDT_REG_WRITE(WDT_OP_ND_ADDRESS, panic_time_param);         // 2^n * 0.8ms, mask 0xf, n = 11 -> (2^11 = 2048) * 0.8 * 0.001 = 1.6384
 
     SET_PERI_REG_BITS(PERIPHS_WDT_BASEADDR + WDT_CTL_ADDRESS, WDT_CTL_RSTLEN_MASK, 7 << WDT_CTL_RSTLEN_LSB, 0);

components/esp_common/CMakeLists.txt

@@ -4,8 +4,9 @@ if(BOOTLOADER_BUILD)
     set_property(TARGET ${COMPONENT_LIB} APPEND PROPERTY INTERFACE_LINK_LIBRARIES "-Wl,--gc-sections")
 else()
     # Regular app build
-    idf_component_register(SRCS "src/stack_check.c"
-                        INCLUDE_DIRS include)
+    idf_component_register(SRCS "src/stack_check.c" "src/esp_err_to_name.c"
+                        INCLUDE_DIRS include
+                        PRIV_REQUIRES "tcpip_adapter")
 
     set_source_files_properties(
         "src/stack_check.c"