esp-idf/components/hal
morris ad4ab84fd8 Merge branch 'refactor/esp_lcd_linker' into 'master'
refactor(esp_lcd): move hal function placement to the driver layer

See merge request espressif/esp-idf!24617
2023-07-07 14:34:44 +08:00
..
esp32 Merge branch 'feature/gptimer_linker_file' into 'master' 2023-07-06 12:42:47 +08:00
esp32c2 Merge branch 'feature/gptimer_linker_file' into 'master' 2023-07-06 12:42:47 +08:00
esp32c3 Merge branch 'feature/gptimer_linker_file' into 'master' 2023-07-06 12:42:47 +08:00
esp32c6 Merge branch 'feature/gptimer_linker_file' into 'master' 2023-07-06 12:42:47 +08:00
esp32h2 Merge branch 'refactor/rtcio_caps_responsibility' into 'master' 2023-07-07 14:25:47 +08:00
esp32p4
esp32s2 Merge branch 'feature/gptimer_linker_file' into 'master' 2023-07-06 12:42:47 +08:00
esp32s3 Merge branch 'feature/gptimer_linker_file' into 'master' 2023-07-06 12:42:47 +08:00
include/hal Merge branch 'refactor/rtcio_caps_responsibility' into 'master' 2023-07-07 14:25:47 +08:00
platform_port/include/hal fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
test
test_apps/crypto
CMakeLists.txt Merge branch 'feature/add_esp32p4_soc_support_part_3' into 'master' 2023-07-07 11:44:46 +08:00
Kconfig
README.md
adc_hal.c
adc_hal_common.c
adc_oneshot_hal.c
aes_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
apm_hal.c
brownout_hal.c
cache_hal.c
ds_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
ecc_hal.c
ecdsa_hal.c
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_hal_iram.c
linker.lf Merge branch 'refactor/esp_lcd_linker' into 'master' 2023-07-07 14:34:44 +08:00
lp_timer_hal.c
mcpwm_hal.c
mmu_hal.c
mpi_hal.c
mpu_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
parlio_hal.c
pcnt_hal.c
rmt_hal.c
rtc_io_hal.c refactor(driver/rtcio): Re-wrap RTCIO APIs with more accurate soc_caps 2023-07-05 11:47:51 +08:00
sdio_slave_hal.c
sdkconfig.rename
sdm_hal.c
sha_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
spi_flash_encrypt_hal_iram.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
spi_flash_hal.c
spi_flash_hal_common.inc
spi_flash_hal_gpspi.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
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 feat(gptimer): add gptimer linker.lf to control the placement of driver and hal 2023-07-05 12:09:00 +08:00
touch_sensor_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
twai_hal.c
twai_hal_iram.c
uart_hal.c
uart_hal_iram.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
usb_dwc_hal.c
usb_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
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.