esp-idf/components/hal
Armando 486c765a93 adc: remove adc_hal_conf.h
Macros inside adc_hal_conf.h are moved to adc_ll.h
2023-02-23 11:48:31 +08:00
..
esp32 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp32c2 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp32c3 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp32c6 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp32h2 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp32h4 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp32s2 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
esp32s3 adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
include/hal esp_adc: support selecting clock source for oneshot driver 2023-02-23 11:48:31 +08:00
platform_port/include/hal
test
CMakeLists.txt esp_adc: support h2 oneshot mode and continuous mode 2023-02-23 11:48:31 +08:00
Kconfig
README.md
adc_hal.c adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
adc_hal_common.c esp_adc: support h2 oneshot mode and continuous mode 2023-02-23 11:48:31 +08:00
adc_oneshot_hal.c adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
aes_hal.c
apm_hal.c apm: added support for APM on esp32c6 2023-02-10 08:18:07 +00:00
brownout_hal.c
cache_hal.c mmu: mmu_hal_check_valid_ext_vaddr_region 2023-02-17 13:04:55 +08:00
ds_hal.c
ecc_hal.c
efuse_hal.c
emac_hal.c
etm_hal.c
gdma_hal.c
gpio_hal.c gpio: h2 support input hysteresis filter 2023-02-20 19:34:48 +08:00
hmac_hal.c
i2c_hal.c
i2c_hal_iram.c
i2s_hal.c
lcd_hal.c
ledc_hal.c
ledc_hal_iram.c
linker.lf
mcpwm_hal.c
mmu_hal.c mmu: mmu_hal_check_valid_ext_vaddr_region 2023-02-17 13:04:55 +08:00
mpu_hal.c
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 wdt: refactor wdt codes to use unified type 2023-02-15 12:08:55 +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.