From a2f07b08062019862b80519ec38d82c4b4c0c539 Mon Sep 17 00:00:00 2001
From: morris <maoshengrong@espressif.com>
Date: Fri, 15 Mar 2019 17:44:27 +0800
Subject: [PATCH] move common include files from esp32 into esp_common

---
 components/app_trace/gcov/gcov_rtio.c         |  2 +-
 .../bootloader/subproject/CMakeLists.txt      |  4 +-
 components/bootloader/subproject/Makefile     |  3 +-
 components/driver/CMakeLists.txt              |  1 -
 components/esp32/cpu_start.c                  |  4 +-
 components/esp32/gdbstub.c                    |  2 +-
 components/esp32/panic.c                      |  2 +-
 components/esp32/pm_esp32.c                   |  2 +-
 components/esp_common/CMakeLists.txt          | 44 +++++++++++--------
 .../include/esp_assert.h                      |  0
 .../{esp32 => esp_common}/include/esp_err.h   |  0
 .../include/esp_int_wdt.h                     |  0
 .../include/esp_interface.h                   |  0
 .../{esp32 => esp_common}/include/esp_pm.h    |  0
 .../include/esp_private/crosscore_int.h}      |  0
 .../include/esp_private/dbg_stubs.h}          |  0
 .../include/esp_private/gdbstub.h}            |  0
 .../include/esp_system.h                      |  0
 .../{esp32 => esp_common}/include/esp_task.h  |  0
 .../include/esp_task_wdt.h                    |  0
 .../{esp32 => esp_common}/include/esp_timer.h |  0
 .../{esp32 => esp_common}/include/esp_types.h |  0
 components/esp_common/src/dbg_stubs.c         |  2 +-
 .../fatfs/test_fatfs_host/Makefile.files      |  1 +
 .../freertos/include/freertos/portmacro.h     |  2 +-
 components/freertos/port.c                    |  2 +-
 components/spi_flash/sim/Makefile.files       |  1 +
 components/spi_flash/sim/stubs/Makefile.files |  3 +-
 .../spiffs/test_spiffs_host/Makefile.files    |  1 +
 .../test_wl_host/Makefile.files               |  1 +
 docs/Doxyfile                                 | 14 +++---
 tools/cmake/idf_functions.cmake               |  2 +-
 32 files changed, 53 insertions(+), 40 deletions(-)
 rename components/{esp32 => esp_common}/include/esp_assert.h (100%)
 rename components/{esp32 => esp_common}/include/esp_err.h (100%)
 rename components/{esp32 => esp_common}/include/esp_int_wdt.h (100%)
 rename components/{esp32 => esp_common}/include/esp_interface.h (100%)
 rename components/{esp32 => esp_common}/include/esp_pm.h (100%)
 rename components/{esp32/include/esp_crosscore_int.h => esp_common/include/esp_private/crosscore_int.h} (100%)
 rename components/{esp32/include/esp_dbg_stubs.h => esp_common/include/esp_private/dbg_stubs.h} (100%)
 rename components/{esp32/include/esp_gdbstub.h => esp_common/include/esp_private/gdbstub.h} (100%)
 rename components/{esp32 => esp_common}/include/esp_system.h (100%)
 rename components/{esp32 => esp_common}/include/esp_task.h (100%)
 rename components/{esp32 => esp_common}/include/esp_task_wdt.h (100%)
 rename components/{esp32 => esp_common}/include/esp_timer.h (100%)
 rename components/{esp32 => esp_common}/include/esp_types.h (100%)

diff --git a/components/app_trace/gcov/gcov_rtio.c b/components/app_trace/gcov/gcov_rtio.c
index 49598ddcc5..7798890c1c 100644
--- a/components/app_trace/gcov/gcov_rtio.c
+++ b/components/app_trace/gcov/gcov_rtio.c
@@ -21,7 +21,7 @@
 #include "soc/timer_group_struct.h"
 #include "soc/timer_group_reg.h"
 #include "esp_app_trace.h"
-#include "esp_dbg_stubs.h"
+#include "esp_private/dbg_stubs.h"
 
 #if CONFIG_ESP32_GCOV_ENABLE
 
diff --git a/components/bootloader/subproject/CMakeLists.txt b/components/bootloader/subproject/CMakeLists.txt
index c7a605c6cd..e116b28bb5 100644
--- a/components/bootloader/subproject/CMakeLists.txt
+++ b/components/bootloader/subproject/CMakeLists.txt
@@ -10,11 +10,11 @@ if(NOT IDF_PATH)
         "in by the parent build process.")
 endif()
 
-set(COMPONENTS bootloader esptool_py esp32 partition_table soc bootloader_support log spi_flash micro-ecc soc main efuse)
+set(COMPONENTS bootloader esptool_py esp32 partition_table soc bootloader_support log spi_flash micro-ecc main efuse)
 set(BOOTLOADER_BUILD 1)
 add_definitions(-DBOOTLOADER_BUILD=1)
 
-set(COMPONENT_REQUIRES_COMMON esp_rom log esp32 soc)
+set(COMPONENT_REQUIRES_COMMON log esp32 soc esp_rom esp_common)
 
 include("${IDF_PATH}/tools/cmake/project.cmake")
 project(bootloader)
diff --git a/components/bootloader/subproject/Makefile b/components/bootloader/subproject/Makefile
index 727c8f05d8..ce95942844 100644
--- a/components/bootloader/subproject/Makefile
+++ b/components/bootloader/subproject/Makefile
@@ -14,9 +14,10 @@ COMPONENTS := esptool_py bootloader_support log spi_flash micro-ecc soc main efu
 CFLAGS =
 CXXFLAGS =
 
-#We cannot include the esp32 and esp_rom component directly but we need their includes.
+#We cannot include the esp32, esp_rom, esp_common component directly but we need their includes.
 CFLAGS += -I $(IDF_PATH)/components/esp32/include
 CFLAGS += -I $(IDF_PATH)/components/esp_rom/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.
 #
diff --git a/components/driver/CMakeLists.txt b/components/driver/CMakeLists.txt
index 13cfd703c4..e4e17b33e2 100644
--- a/components/driver/CMakeLists.txt
+++ b/components/driver/CMakeLists.txt
@@ -22,7 +22,6 @@ set(COMPONENT_SRCS "can.c"
                    "uart.c")
 set(COMPONENT_ADD_INCLUDEDIRS "include")
 set(COMPONENT_PRIV_INCLUDEDIRS "include/driver")
-
 set(COMPONENT_REQUIRES esp_ringbuf)
 
 register_component()
diff --git a/components/esp32/cpu_start.c b/components/esp32/cpu_start.c
index b9411abcb1..83a4915b72 100644
--- a/components/esp32/cpu_start.c
+++ b/components/esp32/cpu_start.c
@@ -48,8 +48,8 @@
 #include "esp_event.h"
 #include "esp_spi_flash.h"
 #include "esp_ipc.h"
-#include "esp_crosscore_int.h"
 #include "esp32/dport_access.h"
+#include "esp_private/crosscore_int.h"
 #include "esp_log.h"
 #include "esp_vfs_dev.h"
 #include "esp_newlib.h"
@@ -63,7 +63,7 @@
 #include "esp_panic.h"
 #include "esp_core_dump.h"
 #include "esp_app_trace.h"
-#include "esp_dbg_stubs.h"
+#include "esp_private/dbg_stubs.h"
 #include "esp_efuse.h"
 #include "esp32/spiram.h"
 #include "esp_clk_internal.h"
diff --git a/components/esp32/gdbstub.c b/components/esp32/gdbstub.c
index e514222098..3bc5423fe1 100644
--- a/components/esp32/gdbstub.c
+++ b/components/esp32/gdbstub.c
@@ -22,7 +22,7 @@
 #include "esp32/rom/ets_sys.h"
 #include "soc/uart_reg.h"
 #include "soc/io_mux_reg.h"
-#include "esp_gdbstub.h"
+#include "esp_private/gdbstub.h"
 #include "esp_panic.h"
 #include "driver/gpio.h"
 #include "freertos/FreeRTOS.h"
diff --git a/components/esp32/panic.c b/components/esp32/panic.c
index 71996d1d8a..5924a1f972 100644
--- a/components/esp32/panic.c
+++ b/components/esp32/panic.c
@@ -32,7 +32,7 @@
 #include "soc/rtc.h"
 #include "soc/rtc_wdt.h"
 
-#include "esp_gdbstub.h"
+#include "esp_private/gdbstub.h"
 #include "esp_panic.h"
 #include "esp_attr.h"
 #include "esp_err.h"
diff --git a/components/esp32/pm_esp32.c b/components/esp32/pm_esp32.c
index f84ca843f5..9a6feaa5a5 100644
--- a/components/esp32/pm_esp32.c
+++ b/components/esp32/pm_esp32.c
@@ -21,8 +21,8 @@
 #include "esp_err.h"
 #include "esp_pm.h"
 #include "esp_log.h"
-#include "esp_crosscore_int.h"
 #include "esp32/clk.h"
+#include "esp_private/crosscore_int.h"
 
 #include "soc/rtc.h"
 
diff --git a/components/esp_common/CMakeLists.txt b/components/esp_common/CMakeLists.txt
index 1d49ff32e7..88dfee3c31 100644
--- a/components/esp_common/CMakeLists.txt
+++ b/components/esp_common/CMakeLists.txt
@@ -1,19 +1,27 @@
-set(COMPONENT_SRCS
-    "src/dbg_stubs.c"
-    "src/esp_err_to_name.c"
-    "src/esp_timer.c"
-    "src/ets_timer_legacy.c"
-    "src/pm_locks.c"
-    "src/stack_check.c")
-set(COMPONENT_ADD_INCLUDEDIRS "include")
-set(COMPONENT_PRIV_INCLUDEDIRS)
-set(COMPONENT_REQUIRES)
-# dbg_stubs.c needs eri.h from xtensa-debug-module
-set(COMPONENT_PRIV_REQUIRES "xtensa-debug-module")
-register_component()
-
-set_source_files_properties(
-    "src/stack_check.c"
-    PROPERTIES COMPILE_FLAGS
-    -fno-stack-protector)
+if(BOOTLOADER_BUILD)
+    # For bootloader, all we need from esp_common is headers
+    set(COMPONENT_ADD_INCLUDEDIRS include)
+    set(COMPONENT_REQUIRES ${IDF_COMPONENTS})
+    set(COMPONENT_SRCS )
+    register_component()
+else()
+    # Regular app build
+    set(COMPONENT_SRCS
+        "src/dbg_stubs.c"
+        "src/esp_err_to_name.c"
+        "src/esp_timer.c"
+        "src/ets_timer_legacy.c"
+        "src/pm_locks.c"
+        "src/stack_check.c")
+    set(COMPONENT_ADD_INCLUDEDIRS "include")
+    set(COMPONENT_PRIV_INCLUDEDIRS)
+    set(COMPONENT_REQUIRES)
+    # dbg_stubs.c needs eri.h from xtensa-debug-module
+    set(COMPONENT_PRIV_REQUIRES "xtensa-debug-module")
+    register_component()
 
+    set_source_files_properties(
+        "src/stack_check.c"
+        PROPERTIES COMPILE_FLAGS
+        -fno-stack-protector)
+endif()
diff --git a/components/esp32/include/esp_assert.h b/components/esp_common/include/esp_assert.h
similarity index 100%
rename from components/esp32/include/esp_assert.h
rename to components/esp_common/include/esp_assert.h
diff --git a/components/esp32/include/esp_err.h b/components/esp_common/include/esp_err.h
similarity index 100%
rename from components/esp32/include/esp_err.h
rename to components/esp_common/include/esp_err.h
diff --git a/components/esp32/include/esp_int_wdt.h b/components/esp_common/include/esp_int_wdt.h
similarity index 100%
rename from components/esp32/include/esp_int_wdt.h
rename to components/esp_common/include/esp_int_wdt.h
diff --git a/components/esp32/include/esp_interface.h b/components/esp_common/include/esp_interface.h
similarity index 100%
rename from components/esp32/include/esp_interface.h
rename to components/esp_common/include/esp_interface.h
diff --git a/components/esp32/include/esp_pm.h b/components/esp_common/include/esp_pm.h
similarity index 100%
rename from components/esp32/include/esp_pm.h
rename to components/esp_common/include/esp_pm.h
diff --git a/components/esp32/include/esp_crosscore_int.h b/components/esp_common/include/esp_private/crosscore_int.h
similarity index 100%
rename from components/esp32/include/esp_crosscore_int.h
rename to components/esp_common/include/esp_private/crosscore_int.h
diff --git a/components/esp32/include/esp_dbg_stubs.h b/components/esp_common/include/esp_private/dbg_stubs.h
similarity index 100%
rename from components/esp32/include/esp_dbg_stubs.h
rename to components/esp_common/include/esp_private/dbg_stubs.h
diff --git a/components/esp32/include/esp_gdbstub.h b/components/esp_common/include/esp_private/gdbstub.h
similarity index 100%
rename from components/esp32/include/esp_gdbstub.h
rename to components/esp_common/include/esp_private/gdbstub.h
diff --git a/components/esp32/include/esp_system.h b/components/esp_common/include/esp_system.h
similarity index 100%
rename from components/esp32/include/esp_system.h
rename to components/esp_common/include/esp_system.h
diff --git a/components/esp32/include/esp_task.h b/components/esp_common/include/esp_task.h
similarity index 100%
rename from components/esp32/include/esp_task.h
rename to components/esp_common/include/esp_task.h
diff --git a/components/esp32/include/esp_task_wdt.h b/components/esp_common/include/esp_task_wdt.h
similarity index 100%
rename from components/esp32/include/esp_task_wdt.h
rename to components/esp_common/include/esp_task_wdt.h
diff --git a/components/esp32/include/esp_timer.h b/components/esp_common/include/esp_timer.h
similarity index 100%
rename from components/esp32/include/esp_timer.h
rename to components/esp_common/include/esp_timer.h
diff --git a/components/esp32/include/esp_types.h b/components/esp_common/include/esp_types.h
similarity index 100%
rename from components/esp32/include/esp_types.h
rename to components/esp_common/include/esp_types.h
diff --git a/components/esp_common/src/dbg_stubs.c b/components/esp_common/src/dbg_stubs.c
index 51e9749b06..3def85c3f7 100644
--- a/components/esp_common/src/dbg_stubs.c
+++ b/components/esp_common/src/dbg_stubs.c
@@ -18,7 +18,7 @@
 
 #include "eri.h"
 #include "xtensa-debug-module.h"
-#include "esp_dbg_stubs.h"
+#include "esp_private/dbg_stubs.h"
 #include "esp_attr.h"
 
 #if CONFIG_ESP32_DEBUG_STUBS_ENABLE
diff --git a/components/fatfs/test_fatfs_host/Makefile.files b/components/fatfs/test_fatfs_host/Makefile.files
index 7356568d80..a619c26228 100644
--- a/components/fatfs/test_fatfs_host/Makefile.files
+++ b/components/fatfs/test_fatfs_host/Makefile.files
@@ -24,6 +24,7 @@ INCLUDE_DIRS := \
 	esp_rom/include \
 	soc/esp32/include \
 	esp32/include \
+	esp_common/include \
 	bootloader_support/include \
 	app_update/include \
 	spi_flash/include \
diff --git a/components/freertos/include/freertos/portmacro.h b/components/freertos/include/freertos/portmacro.h
index adeb3bb009..cbd4cc50ab 100644
--- a/components/freertos/include/freertos/portmacro.h
+++ b/components/freertos/include/freertos/portmacro.h
@@ -78,7 +78,7 @@ extern "C" {
 #include <xtensa/config/core.h>
 #include <xtensa/config/system.h>	/* required for XSHAL_CLIB */
 #include <xtensa/xtruntime.h>
-#include "esp_crosscore_int.h"
+#include "esp_private/crosscore_int.h"
 #include "esp_timer.h"              /* required for FreeRTOS run time stats */
 
 
diff --git a/components/freertos/port.c b/components/freertos/port.c
index 4b6b7c0936..5cd46c7c71 100644
--- a/components/freertos/port.c
+++ b/components/freertos/port.c
@@ -105,7 +105,7 @@
 
 #include "esp_panic.h"
 #include "esp_heap_caps.h"
-#include "esp_crosscore_int.h"
+#include "esp_private/crosscore_int.h"
 
 #include "esp_intr_alloc.h"
 #include "esp_log.h"
diff --git a/components/spi_flash/sim/Makefile.files b/components/spi_flash/sim/Makefile.files
index 3532607455..653b61d99b 100644
--- a/components/spi_flash/sim/Makefile.files
+++ b/components/spi_flash/sim/Makefile.files
@@ -23,6 +23,7 @@ INCLUDE_DIRS := \
 	) \
 	$(addprefix ../../../components/, \
 	esp_rom/include \
+	esp_common/include \
 	soc/esp32/include \
 	esp32/include \
 	bootloader_support/include \
diff --git a/components/spi_flash/sim/stubs/Makefile.files b/components/spi_flash/sim/stubs/Makefile.files
index c3d004ae39..d987631beb 100644
--- a/components/spi_flash/sim/stubs/Makefile.files
+++ b/components/spi_flash/sim/stubs/Makefile.files
@@ -4,7 +4,7 @@ SOURCE_FILES := \
 	newlib/lock.c \
 	esp32/crc.cpp \
 	esp32/esp_random.c \
-	bootloader_support/src/bootloader_common.c 
+	bootloader_support/src/bootloader_common.c
 
 INCLUDE_DIRS := \
 	../include \
@@ -18,6 +18,7 @@ INCLUDE_DIRS := \
 	sdmmc/include \
 	vfs/include \
 	$(addprefix ../../../../components/, \
+	esp_common/include \
 	soc/esp32/include \
 	esp32/include \
 	bootloader_support/include \
diff --git a/components/spiffs/test_spiffs_host/Makefile.files b/components/spiffs/test_spiffs_host/Makefile.files
index ba612fca59..27d2b9dff6 100644
--- a/components/spiffs/test_spiffs_host/Makefile.files
+++ b/components/spiffs/test_spiffs_host/Makefile.files
@@ -25,6 +25,7 @@ INCLUDE_DIRS := \
 	) \
 	$(addprefix ../../../components/, \
 	esp_rom/include \
+	esp_common/include \
 	soc/esp32/include \
 	esp32/include \
 	bootloader_support/include \
diff --git a/components/wear_levelling/test_wl_host/Makefile.files b/components/wear_levelling/test_wl_host/Makefile.files
index 009e1be7a9..5b0cbc9d26 100644
--- a/components/wear_levelling/test_wl_host/Makefile.files
+++ b/components/wear_levelling/test_wl_host/Makefile.files
@@ -24,6 +24,7 @@ INCLUDE_DIRS := \
 	) \
 	$(addprefix ../../../components/, \
 	esp_rom/include \
+	esp_common/include \
 	soc/esp32/include \
 	esp32/include \
 	bootloader_support/include \
diff --git a/docs/Doxyfile b/docs/Doxyfile
index 21c19fa4ce..aa3096bad4 100644
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -158,8 +158,8 @@ INPUT = \
     ../../components/esp32/include/esp_intr_alloc.h \
     ## Watchdogs
     ## NOTE: for two lines below header_file.inc is not used
-    ../../components/esp32/include/esp_int_wdt.h \
-    ../../components/esp32/include/esp_task_wdt.h \
+    ../../components/esp_common/include/esp_int_wdt.h \
+    ../../components/esp_common/include/esp_task_wdt.h \
     ## Hooks
     ../../components/esp32/include/esp_freertos_hooks.h \
     ## Inter-Processor Call
@@ -174,7 +174,7 @@ INPUT = \
     ../../components/log/include/esp_log.h \
     ## Base MAC address
     ## NOTE: for line below header_file.inc is not used
-    ../../components/esp32/include/esp_system.h \
+    ../../components/esp_common/include/esp_system.h \
     ##
     ## ULP Coprocessor - API Guides
     ##
@@ -185,10 +185,10 @@ INPUT = \
     ##
     ../../components/app_trace/include/esp_app_trace.h \
     ### Power management
-    ../../components/esp32/include/esp_pm.h \
+    ../../components/esp_common/include/esp_pm.h \
     ../../components/esp32/include/esp32/pm.h \
     ### esp_timer, High Resolution Timer
-    ../../components/esp32/include/esp_timer.h \
+    ../../components/esp_common/include/esp_timer.h \
     ### esp_event, Event Loop Library
     ../../components/esp_event/include/esp_event.h \
     ../../components/esp_event/include/esp_event_base.h \
@@ -207,9 +207,9 @@ INPUT = \
     ### Ringbuffer
     ../../components/esp_ringbuf/include/freertos/ringbuf.h \
     ### Helper functions for error codes
-    ../../components/esp32/include/esp_err.h \
+    ../../components/esp_common/include/esp_err.h \
     ### System APIs
-    ../../components/esp32/include/esp_system.h \
+    ../../components/esp_common/include/esp_system.h \
     ### Modbus controller component header file
     ../../components/freemodbus/modbus_controller/mbcontroller.h
 
diff --git a/tools/cmake/idf_functions.cmake b/tools/cmake/idf_functions.cmake
index 01035a0b17..c2e694e43a 100644
--- a/tools/cmake/idf_functions.cmake
+++ b/tools/cmake/idf_functions.cmake
@@ -58,7 +58,7 @@ macro(idf_set_variables)
 
     set_default(IDF_COMPONENT_DIRS "${IDF_EXTRA_COMPONENT_DIRS} ${IDF_PATH}/components")
     set_default(IDF_COMPONENTS "")
-    set_default(IDF_COMPONENT_REQUIRES_COMMON "cxx ${IDF_TARGET} newlib freertos heap log soc")
+    set_default(IDF_COMPONENT_REQUIRES_COMMON "cxx ${IDF_TARGET} newlib freertos heap log soc esp_rom esp_common")
 
     set(IDF_PROJECT_PATH "${CMAKE_SOURCE_DIR}")