Michael (XIAO Xufeng) b5d2e9478b Merge branch 'bugfix/spi_ll_intr_bits' into 'master' vor 4 Jahren
..
esp32 850de61e34 Fixed error in "touch_ll_get_sleep_time" function for ESP32 vor 4 Jahren
esp32c3 c1b3d77dcf spi: Fix wrong target register for interrupt disable vor 4 Jahren
esp32s2 46020fe13a usb/hal/soc: initial copy of usbh support from esp32s2 vor 4 Jahren
esp32s3 c1b3d77dcf spi: Fix wrong target register for interrupt disable vor 4 Jahren
include 46020fe13a usb/hal/soc: initial copy of usbh support from esp32s2 vor 4 Jahren
test 27a9cf861e driver: Add esp32c3 drivers (except ADC/DAC) and update tests vor 5 Jahren
CMakeLists.txt 46020fe13a usb/hal/soc: initial copy of usbh support from esp32s2 vor 4 Jahren
README.md 5baf124219 docs: update readme aftering extracting hal document from soc document vor 5 Jahren
adc_hal.c 6e981af406 gdma: separate tx/rx channel interrupt vor 4 Jahren
aes_hal.c 51169b0e0c AES/SHA: use GDMA driver instead of LL vor 5 Jahren
component.mk 46020fe13a usb/hal/soc: initial copy of usbh support from esp32s2 vor 4 Jahren
cpu_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) vor 5 Jahren
dac_hal.c 5425ef4ee4 hal: extract hal component from soc component vor 5 Jahren
ds_hal.c 7eb9ecb4f6 esp_ds: move timeout mechanism to driver layer vor 4 Jahren
gdma_hal.c e6d23a35ec gdma: dynamic alloc DMA channels vor 5 Jahren
gpio_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) vor 5 Jahren
i2c_hal.c 753a929525 global: fix sign-compare warnings vor 5 Jahren
i2c_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component vor 5 Jahren
i2s_hal.c 58c3f6a421 hal: explicitly include soc_caps.h vor 5 Jahren
interrupt_controller_hal.c e361498a2a intr_alloc: re-enable unit test vor 5 Jahren
lcd_hal.c d0be56b8fe lcd: add LL driver for esp32-s3 vor 4 Jahren
ledc_hal.c 58c3f6a421 hal: explicitly include soc_caps.h vor 5 Jahren
ledc_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component vor 5 Jahren
linker.lf 0d81edb174 spi_flash: refactoring flash encryption into new api vor 4 Jahren
mcpwm_hal.c f5ca47c0fc mcpwm: rename macros related to soc capbility vor 4 Jahren
mpu_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) vor 5 Jahren
pcnt_hal.c 5425ef4ee4 hal: extract hal component from soc component vor 5 Jahren
rmt_hal.c 7b37158ede rmt: distinguish group and channel in HAL layer vor 5 Jahren
rtc_io_hal.c 58c3f6a421 hal: explicitly include soc_caps.h vor 5 Jahren
sdio_slave_hal.c c8b697a114 Fix ignored return value. vor 4 Jahren
sha_hal.c 51169b0e0c AES/SHA: use GDMA driver instead of LL vor 5 Jahren
sigmadelta_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) vor 5 Jahren
soc_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) vor 5 Jahren
spi_flash_encrypt_hal_iram.c 0d81edb174 spi_flash: refactoring flash encryption into new api vor 4 Jahren
spi_flash_hal.c 9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 vor 4 Jahren
spi_flash_hal_common.inc 9905da46e0 spi_flash: Add auto suspend mode on esp32c3 vor 5 Jahren
spi_flash_hal_gpspi.c f3e79ca166 spi_flash(c3): add boya chip support for suspend feature vor 5 Jahren
spi_flash_hal_iram.c 9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 vor 4 Jahren
spi_hal.c c438ad5d72 spi: apply gdma allocator to SPI vor 5 Jahren
spi_hal_iram.c c438ad5d72 spi: apply gdma allocator to SPI vor 5 Jahren
spi_slave_hal.c c438ad5d72 spi: apply gdma allocator to SPI vor 5 Jahren
spi_slave_hal_iram.c c438ad5d72 spi: apply gdma allocator to SPI vor 5 Jahren
spi_slave_hd_hal.c 8d90d3072c spi_slave_hd: refactor the hal append api to remove the spinlock vor 5 Jahren
systimer_hal.c 988c88a6b1 systimer: optimise esp_timer_get_time vor 4 Jahren
timer_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) vor 5 Jahren
touch_sensor_hal.c 58c3f6a421 hal: explicitly include soc_caps.h vor 5 Jahren
twai_hal.c 2f58060921 TWAI: FIFO overrun handling and errata workarounds vor 4 Jahren
twai_hal_iram.c 2f58060921 TWAI: FIFO overrun handling and errata workarounds vor 4 Jahren
uart_hal.c 05a4a8d864 uart: seperate sclk and baudrate setting vor 5 Jahren
uart_hal_iram.c 753a929525 global: fix sign-compare warnings vor 5 Jahren
usb_hal.c ea6710ce98 soc/hal: add tinyusb support esp32s3 vor 4 Jahren
usbh_hal.c 46020fe13a usb/hal/soc: initial copy of usbh support from esp32s2 vor 4 Jahren
wdt_hal_iram.c 7c08be5771 hal: Add initial ESP32-C3 support vor 5 Jahren

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.