esp-idf/components/hal
morris 8d0df0a19f Merge branch 'bugfix/rmt_calarify_mem_block_symbols_v5.0' into 'release/v5.0'
Bugfix/rmt calarify mem block symbols (v5.0)

See merge request espressif/esp-idf!23000
2023-05-11 10:27:13 +08:00
..
esp32 Merge branch 'bugfix/fix_uart_tx_done_hardware_concurrency_v5.0' into 'release/v5.0' 2023-03-23 15:29:33 +08:00
esp32c2 Merge branch 'bugfix/fix_uart_tx_done_hardware_concurrency_v5.0' into 'release/v5.0' 2023-03-23 15:29:33 +08:00
esp32c3 Merge branch 'bugfix/fix_uart_tx_done_hardware_concurrency_v5.0' into 'release/v5.0' 2023-03-23 15:29:33 +08:00
esp32h2 Merge branch 'bugfix/fix_uart_tx_done_hardware_concurrency_v5.0' into 'release/v5.0' 2023-03-23 15:29:33 +08:00
esp32s2 Merge branch 'bugfix/fix_uart_tx_done_hardware_concurrency_v5.0' into 'release/v5.0' 2023-03-23 15:29:33 +08:00
esp32s3 Merge branch 'bugfix/fix_uart_tx_done_hardware_concurrency_v5.0' into 'release/v5.0' 2023-03-23 15:29:33 +08:00
include/hal Merge branch 'bugfix/rmt_calarify_mem_block_symbols_v5.0' into 'release/v5.0' 2023-05-11 10:27:13 +08:00
platform_port/include/hal C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-19 15:06:15 +01:00
test build system: re-add -Wno-format as private flag for some components 2022-08-03 16:42:47 +04:00
adc_hal_common.c esp_adc: support adc calibration on esp32c2 2023-02-20 10:34:34 +08:00
adc_hal.c esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
adc_oneshot_hal.c esp_adc: add a kconfig to disable dac on certain adc IOs 2022-08-23 10:48:18 +08:00
aes_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
cache_hal.c cache/mmu: implememnt cache and mmu hal APIs in bootloader 2022-03-11 22:43:11 +08:00
CMakeLists.txt usb_host: Rename struct/ll/hal files to use "usb_dwc" prefix 2023-01-09 17:47:42 +08:00
dac_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ds_hal.c esp_ds: move timeout mechanism to driver layer 2021-04-22 21:07:35 +08:00
ecc_hal.c esp32c2/hal: Added ECC HAL layer 2022-03-08 14:05:23 +00:00
efuse_hal.c efuse: Fix load_efuses_from_flash when FE is on 2023-03-29 14:58:50 +08:00
emac_hal.c esp_eth: receive buffer allocation optimization 2022-12-09 11:43:19 +00:00
gdma_hal.c gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
gpio_hal.c gpio: Fix HAL bad bit shift operation on gpio_num_t reported from coverity 2022-07-15 16:51:25 +08:00
i2c_hal_iram.c I2C: put some interrupt used functions into IRAM, 2022-12-02 15:13:51 +08:00
i2c_hal.c I2C: put some interrupt used functions into IRAM, 2022-12-02 15:13:51 +08:00
i2s_hal.c i2s: add slot sequence table 2022-07-21 15:52:39 +08:00
Kconfig esp_rom: patch systimer driver for esp32c2 2022-07-25 16:08:52 +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 hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ledc_hal.c ledc: Provide support for esp32c2 and esp32h2 2022-04-14 08:15:14 +00:00
linker.lf adc: skip linking static functions when not COMPILER_OPTIMIZATION_DEFAULT 2022-12-02 15:42:40 +00:00
mcpwm_hal.c mcpwm: clean up hal driver and add doc 2022-06-02 15:01:18 +08:00
mmu_hal.c mmu: fix wrong mmu end check 2022-07-27 10:22:09 +00:00
mpu_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +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 driver_ng: implement new rmt driver 2022-05-07 10:34:50 +00:00
rtc_io_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
sdio_slave_hal.c sdio_slave: fix strict aliasing violation for sdio_ringbuf_recv() 2023-02-16 13:48:58 +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: remove back-compatible with caller function of S3Beta ROM 2022-06-14 11:25:30 +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 i2c: support esp32h2 2022-02-23 15:19:37 +08:00
spi_flash_hal.c G0: RISC-V targets have now an independent G0 layer 2022-06-14 15:00:53 +08:00
spi_hal_iram.c spi: support spi on 8684 2022-01-12 11:30:29 +08:00
spi_hal.c hal: Remove dependency on log component 2022-04-18 10:35:01 +08:00
spi_slave_hal_iram.c spi: limit esp32 dma workaround only on esp32 2022-12-05 12:10:45 +08:00
spi_slave_hal.c spi: apply gdma allocator to SPI 2021-02-22 07:06:05 +00:00
spi_slave_hd_hal.c spi: Remove Slave TX/RX set bitlen not effective for ESP32-S2/C3/S3 2021-06-28 18:58:59 -03:00
systimer_hal.c systimer: refactor hal to accomodate more xtal choices 2022-07-25 16:08:52 +08:00
timer_hal_iram.c gptimer: new driver for previous timer group 2022-01-07 14:44:50 +08:00
timer_hal.c gptimer: new driver for previous timer group 2022-01-07 14:44:50 +08:00
touch_sensor_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
twai_hal_iram.c TWAI: FIFO overrun handling and errata workarounds 2021-03-30 14:17:31 +08:00
twai_hal.c twai: Add errata workaround for listen only mode 2023-02-24 19:26:22 +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-22 14:28:12 +08:00
usb_dwc_hal.c hal: Fix USB DWC HAL host channel halt race condition 2023-01-09 17:55:48 +08:00
usb_hal.c soc/hal: add tinyusb support esp32s3 2021-05-06 16:20:54 +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 config: removed references to non-existing kconfig options 2022-03-15 18:32:22 +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.