esp-idf/components/hal
jingli 2b8c43df69 hal/gpio_ll: fix digital gpio can not enable hold during deep sleep when force_unhold set(32/s2/s3) 2022-10-11 12:11:36 +08:00
..
esp32 hal/gpio_ll: fix digital gpio can not enable hold during deep sleep when force_unhold set(32/s2/s3) 2022-10-11 12:11:36 +08:00
esp32c2 hal/gpio_ll: fix digital gpio can not disable hold during deep sleep 2022-10-11 12:11:36 +08:00
esp32c3 hal/gpio_ll: fix digital gpio can not disable hold during deep sleep 2022-10-11 12:11:36 +08:00
esp32c6 esp32c6: add minimal ci support 2022-09-26 20:32:13 +08:00
esp32h2 rmt: support esp32c6 2022-09-17 04:56:49 +00:00
esp32s2 hal/gpio_ll: fix digital gpio can not enable hold during deep sleep when force_unhold set(32/s2/s3) 2022-10-11 12:11:36 +08:00
esp32s3 hal/gpio_ll: fix digital gpio can not enable hold during deep sleep when force_unhold set(32/s2/s3) 2022-10-11 12:11:36 +08:00
include/hal esp_hw_support/sleep: fix current leakage when hold digital io during deep sleep 2022-10-11 12:11:28 +08:00
platform_port/include/hal
test
CMakeLists.txt usb_host: Rename struct/ll/hal files to use "usb_dwc" prefix 2022-09-16 16:45:26 +08:00
Kconfig
README.md
adc_hal.c
adc_hal_common.c
adc_oneshot_hal.c esp_adc: add a kconfig to disable dac on certain adc IOs 2022-08-22 18:04:55 +08:00
aes_hal.c
cache_hal.c esp32c6: add hal support 2022-09-01 12:37:51 +08:00
dac_hal.c
ds_hal.c
ecc_hal.c
efuse_hal.c
emac_hal.c
gdma_hal.c
gpio_hal.c
i2c_hal.c I2C: Refactor i2c hal and ll 2022-09-01 15:53:59 +08:00
i2c_hal_iram.c I2C: Refactor i2c hal and ll 2022-09-01 15:53:59 +08:00
i2s_hal.c
lcd_hal.c
ledc_hal.c
ledc_hal_iram.c
linker.lf soc_caps: Introduce SOC_LEDC_SUPPORTED and SOC_I2C_SUPPORTED caps to IDF 2022-08-31 20:43:22 +08:00
mcpwm_hal.c
mmu_hal.c esp32c6: add hal support 2022-09-01 12:37:51 +08:00
mpu_hal.c
pcnt_hal.c
rmt_hal.c rmt: support esp32c6 2022-09-17 04:56:49 +00:00
rtc_io_hal.c
sdio_slave_hal.c sdio_slave: allow disabling highspeed mode 2022-09-27 18:38:35 +08:00
sdkconfig.rename
sdm_hal.c
sha_hal.c
spi_flash_encrypt_hal_iram.c
spi_flash_hal.c esp32c6: add hal support 2022-09-01 12:37:51 +08:00
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 gptimer: bringup driver on esp32c6 2022-09-13 10:50:58 +08:00
timer_hal_iram.c gptimer: add API to get captured count value 2022-08-25 17:55:19 +08:00
touch_sensor_hal.c
twai_hal.c
twai_hal_iram.c
uart_hal.c
uart_hal_iram.c
usb_dwc_hal.c usb_host: Rename struct/ll/hal symbols to use "usb_dwc" prefix 2022-09-16 16:45:26 +08:00
usb_hal.c
usb_phy_hal.c
wdt_hal_iram.c esp32c6: add hal support 2022-09-01 12:37:51 +08:00
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.