esp-idf/components/hal
Armando (Dou Yiwen) c7d8b06fd2 Merge branch 'feature/add_esp32p4_esp_rom_support' into 'master'
esp_rom: add esp32p4 esp_rom support

See merge request espressif/esp-idf!24703
2023-07-13 19:08:42 +08:00
..
esp32 fix(uart): Fixed C++ type conversion compile error in uart_ll_get_sclk 2023-07-11 11:18:00 +08:00
esp32c2 Merge branch 'bugfix/fix_uart_ll_compatible_with_cpp' into 'master' 2023-07-12 17:42:18 +08:00
esp32c3 Merge branch 'bugfix/fix_uart_ll_compatible_with_cpp' into 'master' 2023-07-12 17:42:18 +08:00
esp32c6 Merge branch 'bugfix/fix_uart_ll_compatible_with_cpp' into 'master' 2023-07-12 17:42:18 +08:00
esp32h2 Merge branch 'bugfix/fix_uart_ll_compatible_with_cpp' into 'master' 2023-07-12 17:42:18 +08:00
esp32p4 fix(ahb_dma): temporarily disable ahb_dma on p4 2023-07-11 16:59:02 +08:00
esp32s2 fix(uart): Fixed C++ type conversion compile error in uart_ll_get_sclk 2023-07-11 11:18:00 +08:00
esp32s3 Merge branch 'feature/add_new_pkg_and_flash_psram_efuses' into 'master' 2023-07-13 00:57:14 +08:00
include/hal Merge branch 'feature/esp_gdma_ops' into 'master' 2023-07-11 10:40:42 +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 esp32h2: add build test 2023-01-17 10:29:04 +08:00
test_apps/crypto hal: minor fixes needed in the crypto hal test app 2023-06-01 11:37:36 +05:30
adc_hal_common.c adc_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08:00
adc_hal.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
adc_oneshot_hal.c adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
aes_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
apm_hal.c apm: added support for APM on esp32c6 2023-02-10 08:18:07 +00:00
brownout_hal.c brownout: Disable the hardware BOD when BOD interrupt is enabled 2023-04-21 10:22:59 +08:00
cache_hal.c feat(esp32p4): added hal support 2023-07-10 16:11:47 +08:00
CMakeLists.txt Merge branch 'feature/esp_gdma_ops' into 'master' 2023-07-11 10:40:42 +08:00
ds_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
ecc_hal.c esp32h2: Add support for ECC hardware accelerator 2023-03-13 16:39:46 +05:30
ecdsa_hal.c ecdsa: Support multiple ECDSA keys 2023-04-07 14:55:21 +05:30
efuse_hal.c adc_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08:00
emac_hal.c driver: minor code clean up to pass coverity scan test 2023-06-10 16:21:12 +08:00
etm_hal.c etm: added etm channel allocator 2022-11-23 15:31:33 +08:00
gdma_hal_ahb_v1.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
gdma_hal_ahb_v2.c feat(esp_gdma): adapt the gdma driver to ahb-dma and axi-dma 2023-07-10 13:45:57 +08:00
gdma_hal_axi.c feat(esp_gdma): adapt the gdma driver to ahb-dma and axi-dma 2023-07-10 13:45:57 +08:00
gdma_hal_top.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
gpio_hal.c gpio: h2 support input hysteresis filter 2023-02-20 19:34:48 +08:00
hmac_hal.c hmac_hal: Merge hmac hal layer for different into one 2022-11-24 16:04:26 +05:30
i2c_hal_iram.c I2C: Refactor i2c hal and ll 2022-09-01 15:53:59 +08:00
i2c_hal.c I2C: Fix issue that pointer would be NULL if calls i2c_param first, 2023-01-09 10:18:03 +08:00
i2s_hal.c i2s: fixed i2s_ll compiling failure under C++ evironment 2023-06-23 11:41:43 +08:00
Kconfig spi: change linker file let spi hal able to out from iram 2023-04-21 18:58:36 +08:00
lcd_hal.c rgb_lcd: workaround pclk polarity bug by setting mo>=2 2022-07-21 13:06:09 +00:00
ledc_hal_iram.c ledc: Add an all-in-one HAL function to set fade parameters, and refactor ledc_ll_get_max_duty function 2023-04-21 16:40:54 +08:00
ledc_hal.c ledc: Add an all-in-one HAL function to set fade parameters, and refactor ledc_ll_get_max_duty function 2023-04-21 16:40:54 +08:00
linker.lf refactor(gpio):add gpio linker.lf to control the placement of driver and hal 2023-07-11 20:44:36 +08:00
lp_timer_hal.c Power Management: move lp_timer_hal.c to upper hal layer for esp32h2 and esp32c6 2023-06-26 21:05:16 +08:00
mcpwm_hal.c mcpwm: clean up hal driver and add doc 2022-06-02 15:01:18 +08:00
mmu_hal.c feat(esp32p4): added hal support 2023-07-10 16:11:47 +08:00
mpi_hal.c bignum: refactored the hardware abstraction of the mpi peripheral 2023-04-24 16:15:11 +05:30
mpu_hal.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
parlio_hal.c driver: add parallel IO TX driver 2023-03-01 00:43:14 +00:00
pcnt_hal.c pulse_cnt: new driver for PCNT peripheral 2022-03-03 22:38:32 +08:00
README.md docs: update readme aftering extracting hal document from soc document 2020-09-23 11:47:23 +08:00
rmt_hal.c rmt: support esp32c6 2022-09-17 04:56:49 +00:00
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 sdio_slave: fix strict aliasing violation for sdio_ringbuf_recv() 2023-01-19 13:21:27 +07:00
sdkconfig.rename HAL: fix kconfig HAL_ASSERTION typo 2022-06-13 16:19:28 +08:00
sdm_hal.c sdm: clean up soc/hal/ll code 2022-07-20 14:59:50 +08:00
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_common.inc spi_flash: 2nd stage for supporting flash suspend. (1). Support more esp chips (2). Improve real-time performance (3). Making timing more stable (4) Add documents 2023-05-11 20:10:30 +08:00
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_flash: 2nd stage for supporting flash suspend. (1). Support more esp chips (2). Improve real-time performance (3). Making timing more stable (4) Add documents 2023-05-11 20:10:30 +08:00
spi_flash_hal.c spi_flash: 2nd stage for supporting flash suspend. (1). Support more esp chips (2). Improve real-time performance (3). Making timing more stable (4) Add documents 2023-05-11 20:10:30 +08:00
spi_hal_iram.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
spi_hal.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
spi_slave_hal_iram.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
spi_slave_hal.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
spi_slave_hd_hal.c feat(esp_gdma): add hal interface for common operations 2023-07-10 13:45:57 +08:00
systimer_hal.c systimer: support etm event 2022-11-23 15:32:34 +08:00
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_iram.c twai: bringup on esp32c6 2022-11-04 17:40:29 +08:00
twai_hal.c twai: Add errata workaround for listen only mode 2023-02-23 12:50:06 +08:00
uart_hal_iram.c fix(hal): check the public header files and fix violations 2023-07-05 17:33:32 +08:00
uart_hal.c uart: Support LP_UART port with UART driver on esp32c6 2023-06-16 07:31:40 +00:00
usb_dwc_hal.c hal: Fix USB DWC HAL host channel halt race condition 2022-12-06 18:08:54 +08:00
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 usb: Add usb_phy driver to support operations on USB PHY 2021-09-13 12:39:56 +08:00
wdt_hal_iram.c wdt: refactor wdt codes to use unified type 2023-02-15 12:08:55 +08:00
xt_wdt_hal.c WDT: Add support for XTAL32K Watchdog timer 2021-09-02 09:09:00 +08:00

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.