refactor(soc): create soc include folders

This commit is contained in:
laokaiyao 2024-09-05 16:25:22 +08:00 committed by Kevin (Lao Kaiyao)
parent f0a2091e4d
commit 65f49c6a7b
12 changed files with 11 additions and 1 deletions

View File

@ -14,9 +14,15 @@ endif()
set(includes "include" "${target_folder}") set(includes "include" "${target_folder}")
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${target_folder}/include") if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${target_folder}/include")
# miscellaneous headers, like definitions, man-made register headers, wrappers, etc.
list(APPEND includes "${target_folder}/include") list(APPEND includes "${target_folder}/include")
endif() endif()
if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${target_folder}/register")
# register headers that generated by script from CSV
list(APPEND includes "${target_folder}/register")
endif()
if(target STREQUAL "esp32") if(target STREQUAL "esp32")
list(APPEND srcs "${target_folder}/dport_access.c") list(APPEND srcs "${target_folder}/dport_access.c")
endif() endif()

View File

@ -7,4 +7,8 @@ The `soc` component provides hardware description for targets supported by ESP-I
- `xxx_channel.h` - definitions for hardware with multiple channels - `xxx_channel.h` - definitions for hardware with multiple channels
- `xxx_caps.h` - features/capabilities of the hardware - `xxx_caps.h` - features/capabilities of the hardware
- `xxx_pins.h` - pin definitions - `xxx_pins.h` - pin definitions
- `xxx_periph.h/*.c` - includes all headers related to a peripheral; declaration and definition of IO mapping for that hardware - `xxx_periph.h/*.c` - includes all headers related to a peripheral; declaration and definition of IO mapping for that hardware
Specially, the `xxx_reg.h` and `xxx_struct.h` headers that generated by script are under `register/soc` folder. Please DO NOT **add** other manual coded files under this folder.
For other soc headers that are used as wrapper, definition, signaling, mapping or manual coded registers, please add them under `include/soc` folder.