esp-idf/components/hal
morris eb7ccbd174 hal: added analog comparator's LL driver 2023-03-17 11:38:32 +08:00
..
esp32 uart: add low level func for uart to set err wr mask 2023-03-09 10:28:33 +08:00
esp32c2 esp32c2/ecc: Remove support for inverse multiplication 2023-03-13 16:39:46 +05:30
esp32c3 uart: add low level func for uart to set err wr mask 2023-03-09 10:28:33 +08:00
esp32c6 esp32c6/ecc: Remove inverse multiplication mode 2023-03-13 16:39:46 +05:30
esp32h2 hal: added analog comparator's LL driver 2023-03-17 11:38:32 +08:00
esp32h4 uart: add low level func for uart to set err wr mask 2023-03-09 10:28:33 +08:00
esp32s2 uart: add low level func for uart to set err wr mask 2023-03-09 10:28:33 +08:00
esp32s3 mspi: make mspi_timing_tuning.h available for all supported targets 2023-03-09 10:38:32 +00:00
include/hal hal: added analog comparator's LL driver 2023-03-17 11:38:32 +08:00
platform_port/include/hal
test
test_apps/ecc hal/test_apps: Add no-os ecc test app 2023-03-13 16:39:46 +05:30
.build-test-rules.yml hal/test_apps: Add no-os ecc test app 2023-03-13 16:39:46 +05:30
CMakeLists.txt hal: added analog comparator's LL driver 2023-03-17 11:38:32 +08:00
Kconfig
README.md
adc_hal.c
adc_hal_common.c
adc_oneshot_hal.c
aes_hal.c
analog_cmpr_hal.c hal: added analog comparator's LL driver 2023-03-17 11:38:32 +08:00
apm_hal.c
brownout_hal.c
cache_hal.c esp_mm: cache_msync API 2023-02-28 10:42:22 +08:00
ds_hal.c
ecc_hal.c esp32h2: Add support for ECC hardware accelerator 2023-03-13 16:39:46 +05:30
efuse_hal.c
emac_hal.c
etm_hal.c
gdma_hal.c
gpio_hal.c
hmac_hal.c
i2c_hal.c
i2c_hal_iram.c
i2s_hal.c
lcd_hal.c
ledc_hal.c ledc: Support gamma curve fade feature on esp32c6 and esp32h2 2023-03-10 12:42:46 +08:00
ledc_hal_iram.c ledc: Support gamma curve fade feature on esp32c6 and esp32h2 2023-03-10 12:42:46 +08:00
linker.lf
mcpwm_hal.c
mmu_hal.c mmu: hal function to init, and hal function to unmap all 2023-03-15 10:59:20 +08:00
mpu_hal.c
parlio_hal.c driver: add parallel IO TX driver 2023-03-01 00:43:14 +00:00
pcnt_hal.c
rmt_hal.c
rtc_io_hal.c
sdio_slave_hal.c
sdkconfig.rename
sdm_hal.c
sha_hal.c
spi_flash_encrypt_hal_iram.c
spi_flash_hal.c
spi_flash_hal_common.inc
spi_flash_hal_gpspi.c
spi_flash_hal_iram.c
spi_hal.c
spi_hal_iram.c
spi_slave_hal.c
spi_slave_hal_iram.c
spi_slave_hd_hal.c
systimer_hal.c
timer_hal.c
timer_hal_iram.c
touch_sensor_hal.c
twai_hal.c
twai_hal_iram.c
uart_hal.c
uart_hal_iram.c
usb_dwc_hal.c
usb_hal.c
usb_phy_hal.c
wdt_hal_iram.c
xt_wdt_hal.c

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.