esp-idf/components/hal
Marius Vikhammer 6cc871d793 Merge branch 'feature/ulp_riscv_adc' into 'master'
ulp-riscv: add support for using ADC as well as an example show-casing it.

Closes IDFGH-7564 and IDF-1714

See merge request espressif/esp-idf!18767
2022-07-11 12:30:31 +08:00
..
esp32 Merge branch 'feature/efuse_rev_major_minor' into 'master' 2022-07-07 11:48:54 +08:00
esp32c2 Merge branch 'feature/efuse_rev_major_minor' into 'master' 2022-07-07 11:48:54 +08:00
esp32c3 Merge branch 'bugfix/reset_ble_hw_on_inititalization' into 'master' 2022-07-08 16:21:41 +08:00
esp32h2 Merge branch 'feature/efuse_rev_major_minor' into 'master' 2022-07-07 11:48:54 +08:00
esp32s2 Merge branch 'feature/efuse_rev_major_minor' into 'master' 2022-07-07 11:48:54 +08:00
esp32s3 Merge branch 'bugfix/reset_ble_hw_on_inititalization' into 'master' 2022-07-08 16:21:41 +08:00
include/hal Merge branch 'feature/efuse_rev_major_minor' into 'master' 2022-07-07 11:48:54 +08:00
platform_port/include/hal ulp-riscv: add support for using ADC as well as an example show-casing it. 2022-07-11 09:31:22 +08:00
test
CMakeLists.txt esp32h2: Enable ECC accelerator 2022-06-23 12:59:13 +05:30
Kconfig HAL: fix kconfig HAL_ASSERTION typo 2022-06-13 16:19:28 +08:00
README.md
adc_hal.c i2s: update documents for driver-NG 2022-06-15 10:30:04 +08:00
adc_hal_common.c
aes_hal.c
cache_hal.c
dac_hal.c
ds_hal.c
ecc_hal.c
efuse_hal.c efuse: Adds major and minor versions and others 2022-07-05 14:38:27 +08:00
emac_hal.c
gdma_hal.c
gpio_hal.c
i2c_hal.c
i2c_hal_iram.c
i2s_hal.c i2s: update documents for driver-NG 2022-06-15 10:30:04 +08:00
lcd_hal.c rgb_lcd: support fractional clock divisor 2022-06-14 02:20:47 +00:00
ledc_hal.c
ledc_hal_iram.c
linker.lf hal: Route CPU and Interrupt Controller HAL/LL to esp_cpu calls 2022-06-14 14:40:03 +08:00
mcpwm_hal.c
mmu_hal.c mmu: fix wrong mmu entry id issue 2022-06-28 14:17:44 +08:00
mpu_hal.c
pcnt_hal.c
rmt_hal.c
rtc_io_hal.c
sdio_slave_hal.c
sdkconfig.rename HAL: fix kconfig HAL_ASSERTION typo 2022-06-13 16:19:28 +08:00
sha_hal.c
sigmadelta_hal.c
spi_flash_encrypt_hal_iram.c
spi_flash_hal.c G0: RISC-V targets have now an independent G0 layer 2022-06-14 15:00:53 +08:00
spi_flash_hal_common.inc spi_flash: remove back-compatible with caller function of S3Beta ROM 2022-06-14 11:25:30 +08:00
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_hal.c
usb_phy_hal.c
usbh_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.