Michael (XIAO Xufeng) 9a394e1aa0 Merge branch 'feature/spi_bringup_esp32s3' into 'master' 5 tahun lalu
..
esp32 f7e91ef6c1 spi: esp32s3 bringup for spi 5 tahun lalu
esp32s2 9a394e1aa0 Merge branch 'feature/spi_bringup_esp32s3' into 'master' 5 tahun lalu
esp32s3 9a394e1aa0 Merge branch 'feature/spi_bringup_esp32s3' into 'master' 5 tahun lalu
include 0aa9ee5b24 esp32s3: delete duplicate esp32s3 5 tahun lalu
test 01d9aa8070 soc: move mpu_hal test to hal component 5 tahun lalu
CMakeLists.txt f7e91ef6c1 spi: esp32s3 bringup for spi 5 tahun lalu
README.md 5baf124219 docs: update readme aftering extracting hal document from soc document 5 tahun lalu
adc_hal.c 647dea9395 soc: combine xxx_caps.h into one soc_caps.h 5 tahun lalu
component.mk 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
cpu_hal.c 647dea9395 soc: combine xxx_caps.h into one soc_caps.h 5 tahun lalu
dac_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
gpio_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
i2c_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
i2c_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
i2s_hal.c 9cd5e6f8c9 bugfix(adc): missing ranges of ADC codes in ESP32 5 tahun lalu
interrupt_controller_hal.c 2e826b7a8f intr_alloc: split interrupt allocator into common-code and platform-code 5 tahun lalu
ledc_hal.c 1966f00f0b soc: updates caps usage 5 tahun lalu
ledc_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
linker.lf 4c57f50fe4 TWAI: ISR runs when cache is disabled 5 tahun lalu
mcpwm_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
mpu_hal.c 647dea9395 soc: combine xxx_caps.h into one soc_caps.h 5 tahun lalu
pcnt_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
rmt_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
rtc_io_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
sdio_slave_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
sha_hal.c 949fb8e63a SHA: add HAL layer and refactor driver 5 tahun lalu
sigmadelta_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
soc_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
spi_flash_hal.c 647dea9395 soc: combine xxx_caps.h into one soc_caps.h 5 tahun lalu
spi_flash_hal_common.inc 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
spi_flash_hal_gpspi.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
spi_flash_hal_iram.c d7e50c6457 spi_flash:bringup some flash supports for esp32s3 5 tahun lalu
spi_hal.c f7e91ef6c1 spi: esp32s3 bringup for spi 5 tahun lalu
spi_hal_iram.c f7e91ef6c1 spi: esp32s3 bringup for spi 5 tahun lalu
spi_slave_hal.c f7e91ef6c1 spi: esp32s3 bringup for spi 5 tahun lalu
spi_slave_hal_iram.c f7e91ef6c1 spi: esp32s3 bringup for spi 5 tahun lalu
spi_slave_hd_hal.c f7e91ef6c1 spi: esp32s3 bringup for spi 5 tahun lalu
timer_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
touch_sensor_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
twai_hal.c 1966f00f0b soc: updates caps usage 5 tahun lalu
twai_hal_iram.c 4c57f50fe4 TWAI: ISR runs when cache is disabled 5 tahun lalu
uart_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
uart_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu
wdt_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component 5 tahun lalu

README.md

hal

The hal component provides hardware abstraction and implementation for targets supported by ESP-IDF.

include/hal

/include/hal contains header files which provides a hardware-agnostic interface to the SoC. The interface consists of function declarations and abstracted types that other, higher level components can make use of in order to have code portable to all targets ESP-IDF supports.

It contains an abstraction layer for ineracting with/driving the hardware found in the SoC such as the peripherals and 'core' hardware such as the CPU, MPU, caches, etc. It contains for the abstracted types. The abstraction design is actually two levels -- often somtimes xxx_hal.h includes a lower-level header from a xxx_ll.h, which resides in the implementation. More on this abstraction design in the hal/include/hal's Readme

target/include

Provides the implementation of the hardware-agnostic interface in the abstraction. Target-specific subdirectories exist for wildly different implementations among targets; while code that are common/very similar might be placed in the top-level of /<target>/include, using some amount of conditional preprocessors. It is up to the developers' discretion on which strategy to use. Code usually reside in source files with same names to header files whose interfaces they implement, ex. xxx_hal.c for xxx_hal.h.

As mentioned previously, the lower-level abstraction header xxx_ll.h resides in this directory, since they contain hardware-specific details. However, what these can do is provide some abstraction among implementations, so that more code can be moved to the common, non-target-specific subdirectories.

This can also contain target-specific extensions to the HAL headers. These target-specific HAL headers have the same name and include the abstraction layer HAL header via include_next. These extensions might add more function declarations or override some things using macro magic.