esp-idf/components/hal
morris 442a798083 Merge branch 'feat/add_example_usj_v5.1' into 'release/v5.1'
change(usb_serial_jtag): Add example for usb serial jtag echo (backport v5.1)

See merge request espressif/esp-idf!30020
2024-05-11 22:37:34 +08:00
..
esp32 fix(uart): Fix mismatch wakeup rising edges required with the threshold configured 2024-04-24 17:21:37 +08:00
esp32c2 fix(uart): Fix mismatch wakeup rising edges required with the threshold configured 2024-04-24 17:21:37 +08:00
esp32c3 Merge branch 'feat/add_example_usj_v5.1' into 'release/v5.1' 2024-05-11 22:37:34 +08:00
esp32c6 Merge branch 'feat/add_example_usj_v5.1' into 'release/v5.1' 2024-05-11 22:37:34 +08:00
esp32h2 Merge branch 'feat/add_example_usj_v5.1' into 'release/v5.1' 2024-05-11 22:37:34 +08:00
esp32s2 Merge branch 'refactor/usb_remove_unused_files_v5.1' into 'release/v5.1' 2024-05-11 22:36:18 +08:00
esp32s3 Merge branch 'feat/add_example_usj_v5.1' into 'release/v5.1' 2024-05-11 22:37:34 +08:00
include/hal Merge branch 'refactor/usb_remove_unused_files_v5.1' into 'release/v5.1' 2024-05-11 22:36:18 +08:00
platform_port/include/hal fix(hal): Fix incorrect behavior of hal_memcpy 2023-11-03 15:49:35 +08:00
test esp32h2: add build test 2023-01-17 10:29:04 +08:00
test_apps/ecc hal/test_apps: Add no-os ecc test app 2023-03-13 16:39:46 +05:30
.build-test-rules.yml hal/test_apps: Add no-os ecc test app 2023-03-13 16:39:46 +05:30
adc_hal_common.c adc_cali: supported channel compensation of adc calibration on esp32c6 2023-07-05 12:48:11 +08:00
adc_hal.c fix(adc): workaround to fix adc continuous get less results on c3 2024-02-21 13:54:29 +08:00
adc_oneshot_hal.c fix(adc): fix h2 adc oneshot read zero and add delay after getting done signal v5.1 2023-11-17 02:16:21 +00:00
aes_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
apm_hal.c apm: added support for APM on esp32c6 2023-02-10 08:18:07 +00:00
brownout_hal.c fix(bod): Reset brownout in configuration to avoid RF cannot be enabled again 2023-12-07 10:33:58 +08:00
cache_hal.c cache: refactor cache_utils into cache_hal instade 2023-07-31 14:52:03 +08:00
CMakeLists.txt refactor(hal): Remove usb_hal and usb_ll 2024-03-22 15:21:51 +08:00
ds_hal.c esp_ds: move timeout mechanism to driver layer 2021-04-22 21:07:35 +08:00
ecc_hal.c esp32h2: Add support for ECC hardware accelerator 2023-03-13 16:39:46 +05:30
ecdsa_hal.c feat(hal/ecdsa): Add HAL API for operation successful check 2024-04-12 11:14:10 +05:30
efuse_hal.c feat(pmu): set fix voltage to different mode for esp32h2 2024-01-26 11:39:16 +08:00
emac_hal.c esp_eth: possible start/stop issue fixed 2023-02-03 10:48:39 +01:00
etm_hal.c etm: added etm channel allocator 2022-11-23 15:31:33 +08:00
gdma_hal.c gdma: support IRAM interrupt 2021-11-08 16:14:51 +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-26 15:42:36 +08:00
Kconfig spi: change linker file let spi hal able to out from iram 2023-04-26 11:15:30 +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: Support gamma curve fade feature on esp32c6 and esp32h2 2023-03-10 12:42:46 +08:00
ledc_hal.c ledc: Support gamma curve fade feature on esp32c6 and esp32h2 2023-03-10 12:42:46 +08:00
linker.lf change(pm): put pmu_hal to iram 2024-01-16 14:01:22 +08:00
lp_timer_hal.c Power Management: move lp_timer_hal.c to upper hal layer for esp32h2 and esp32c6 2023-07-11 14:52:46 +08:00
mcpwm_hal.c mcpwm: clean up hal driver and add doc 2022-06-02 15:01:18 +08:00
mmu_hal.c mmu: hal function to init, and hal function to unmap all 2023-03-15 10:59:20 +08:00
mpu_hal.c
parlio_hal.c fix(parlio_tx): fix wrong dma descriptor setup 2023-09-27 14:53:53 +08:00
pcnt_hal.c pulse_cnt: new driver for PCNT peripheral 2022-03-03 22:38:32 +08:00
README.md
rmt_hal.c rmt: support esp32c6 2022-09-17 04:56:49 +00:00
rtc_io_hal.c change(driver/rtcio): Describe RTCIO CAPS with more accurate note 2023-08-03 16:46:55 +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 AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
spi_flash_encrypt_hal_iram.c spi_flash: refactoring flash encryption into new api 2021-04-25 17:09:25 +08:00
spi_flash_hal_common.inc spi_flash: bringup for esp32c6 2022-11-09 12:50:46 +08:00
spi_flash_hal_gpspi.c spi_flash(c3): add boya chip support for suspend feature 2021-01-25 11:14:06 +08:00
spi_flash_hal_iram.c esp32h2: renaming esp32h2 to esp32h4 2022-11-08 17:05:33 +08:00
spi_flash_hal.c spi_flash: bringup for esp32c6 2022-11-09 12:50:46 +08:00
spi_hal_iram.c fix(all): unify default mosi level to low on all targets 2023-07-26 20:34:25 +08:00
spi_hal.c fix(spi): fixed undesired touching to DMA 2023-10-31 15:52:26 +08:00
spi_slave_hal_iram.c fix(all): unify default mosi level to low on all targets 2023-07-26 20:34:25 +08:00
spi_slave_hal.c fix(spi): fixed undesired touching to DMA 2023-10-31 15:52:26 +08:00
spi_slave_hd_hal.c fix(spi): fixed undesired touching to DMA 2023-10-31 15:52:26 +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-08-14 02:31:16 +00:00
touch_sensor_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +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 global: fix sign-compare warnings 2021-01-12 14:05:08 +08:00
uart_hal.c uart: move frequency of clock sources out of HAL 2022-08-15 18:55:43 +00:00
usb_dwc_hal.c feat(usb/host): Update ISOC scheduler for HS endpoints 2024-03-04 09:59:50 +01:00
usb_fsls_phy_hal.c refactor(hal/usb): Rename usb_fsls_phy API to match header/source names 2024-02-28 16:09:52 +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.