Omar Chebib bb9aa806f7 panic: handlers can now be placed in flash 4 anni fa
..
esp32 cd79f3907d gpio: Disable USB JTAG when setting pins 18 and 19 as GPIOs on ESP32C3 4 anni fa
esp32c3 ec01a66557 Merge branch 'feature/esp32c3_memprot_test3' into 'master' 4 anni fa
esp32s2 ec01a66557 Merge branch 'feature/esp32c3_memprot_test3' into 'master' 4 anni fa
esp32s3 7e06a60c0d Merge branch 'refactor/no_dac_on_esp32s3' into 'master' 4 anni fa
include 1f29036ead Merge branch 'feat/c3_driver_api_cleanup' into 'master' 4 anni fa
test 27a9cf861e driver: Add esp32c3 drivers (except ADC/DAC) and update tests 5 anni fa
CMakeLists.txt 75dfd970b4 dac: added DAC support macro 4 anni fa
README.md 5baf124219 docs: update readme aftering extracting hal document from soc document 5 anni fa
adc_hal.c cc6bfcd9ac adc: apply adc power API to adc driver 4 anni fa
aes_hal.c 51169b0e0c AES/SHA: use GDMA driver instead of LL 5 anni fa
component.mk cd79f3907d gpio: Disable USB JTAG when setting pins 18 and 19 as GPIOs on ESP32C3 4 anni fa
cpu_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
dac_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 anni fa
ds_hal.c e532a29288 [Peripheral/Security] DS peripheral driver 5 anni fa
gdma_hal.c e6d23a35ec gdma: dynamic alloc DMA channels 5 anni fa
gpio_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
i2c_hal.c 753a929525 global: fix sign-compare warnings 5 anni fa
i2c_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component 5 anni fa
i2s_hal.c 58c3f6a421 hal: explicitly include soc_caps.h 5 anni fa
interrupt_controller_hal.c e361498a2a intr_alloc: re-enable unit test 5 anni fa
lcd_hal.c d0be56b8fe lcd: add LL driver for esp32-s3 4 anni fa
ledc_hal.c 58c3f6a421 hal: explicitly include soc_caps.h 5 anni fa
ledc_hal_iram.c 5425ef4ee4 hal: extract hal component from soc component 5 anni fa
linker.lf bb9aa806f7 panic: handlers can now be placed in flash 4 anni fa
mcpwm_hal.c f5ca47c0fc mcpwm: rename macros related to soc capbility 4 anni fa
mpu_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
pcnt_hal.c 5425ef4ee4 hal: extract hal component from soc component 5 anni fa
rmt_hal.c 7b37158ede rmt: distinguish group and channel in HAL layer 5 anni fa
rtc_io_hal.c 58c3f6a421 hal: explicitly include soc_caps.h 5 anni fa
sdio_slave_hal.c d6f4d99d93 core system: Fix warnings in compilation when assertions are disabled 5 anni fa
sha_hal.c 51169b0e0c AES/SHA: use GDMA driver instead of LL 5 anni fa
sigmadelta_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
soc_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
spi_flash_hal.c 9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 4 anni fa
spi_flash_hal_common.inc 9905da46e0 spi_flash: Add auto suspend mode on esp32c3 5 anni fa
spi_flash_hal_gpspi.c f3e79ca166 spi_flash(c3): add boya chip support for suspend feature 5 anni fa
spi_flash_hal_iram.c 9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 4 anni fa
spi_hal.c c438ad5d72 spi: apply gdma allocator to SPI 5 anni fa
spi_hal_iram.c c438ad5d72 spi: apply gdma allocator to SPI 5 anni fa
spi_slave_hal.c c438ad5d72 spi: apply gdma allocator to SPI 5 anni fa
spi_slave_hal_iram.c c438ad5d72 spi: apply gdma allocator to SPI 5 anni fa
spi_slave_hd_hal.c 8d90d3072c spi_slave_hd: refactor the hal append api to remove the spinlock 5 anni fa
timer_hal.c 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 anni fa
touch_sensor_hal.c 58c3f6a421 hal: explicitly include soc_caps.h 5 anni fa
twai_hal.c 2f58060921 TWAI: FIFO overrun handling and errata workarounds 4 anni fa
twai_hal_iram.c 2f58060921 TWAI: FIFO overrun handling and errata workarounds 4 anni fa
uart_hal.c 05a4a8d864 uart: seperate sclk and baudrate setting 5 anni fa
uart_hal_iram.c 753a929525 global: fix sign-compare warnings 5 anni fa
wdt_hal_iram.c 7c08be5771 hal: Add initial ESP32-C3 support 5 anni fa

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.