esp-idf/components/hal
Michael (XIAO Xufeng) 78165c541e Merge branch 'bugfix/bootloader_uart_custom_gpio' into 'master'
bootloader: fixed the issue custom_uart_gpio doesn't take effect

Closes IDF-4606

See merge request espressif/esp-idf!16910
2022-03-02 02:35:14 +08:00
..
esp32 Merge branch 'feature/efuse_hal' into 'master' 2022-02-28 13:38:43 +08:00
esp32c2 Merge branch 'feature/i2c_support_on_esp8684_esp32h2' into 'master' 2022-02-28 13:59:02 +08:00
esp32c3 remove esp32c3 unsupported efuse field 2022-02-28 19:37:38 +08:00
esp32h2 remove esp32h2 rev1/2 unsupported efuse field 2022-02-28 19:37:43 +08:00
esp32s2 Merge branch 'feature/efuse_hal' into 'master' 2022-02-28 13:38:43 +08:00
esp32s3 Merge branch 'bugfix/bootloader_uart_custom_gpio' into 'master' 2022-03-02 02:35:14 +08:00
include/hal Merge branch 'feature/i2c_support_on_esp8684_esp32h2' into 'master' 2022-02-28 13:59:02 +08:00
platform_port/include/hal HAL: Fix Force U32 macros for C++ typeof() 2021-09-07 11:23:06 +08:00
test Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
adc_hal.c adc: support adc dma driver on all chips 2021-12-16 00:19:15 +00:00
aes_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
CMakeLists.txt soc: Adds efuse hal 2022-02-24 22:20:09 +08:00
cpu_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00: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
efuse_hal.c soc: Adds efuse hal 2022-02-24 22:20:09 +08:00
emac_hal.c Merge branch 'feature/emac_start_stop_test' into 'master' 2022-02-15 13:23:01 +00:00
gdma_hal.c gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
gpio_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
i2c_hal_iram.c i2c: support esp32c2 2022-02-23 15:19:37 +08:00
i2c_hal.c i2c: support esp32c2 2022-02-23 15:19:37 +08:00
i2s_hal.c components: correct abs() use for unsigned and 64-bit arguments 2022-01-29 12:07:16 +07:00
interrupt_controller_hal.c intr_alloc: re-enable unit test 2021-02-02 20:25:50 +08:00
Kconfig hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
lcd_hal.c lcd: unify callback prototype 2021-10-02 14:23:31 +08:00
ledc_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ledc_hal.c LEDC: improved support for ESP32-C3 and refactored divisor calculation 2021-11-11 12:21:15 +08:00
linker.lf hal: fix CONFIG_TWAI_ISR_IN_IRAM not taking effect for C3/H2 2022-01-20 22:24:27 +01:00
mcpwm_hal.c mcpwm: refactor driver 2021-06-09 12:27:01 +08:00
mpu_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
pcnt_hal.c pcnt: refactor hal driver 2021-08-10 17:19:21 +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: move RMT item definition from soc to driver 2022-01-06 21:43:12 +08:00
rtc_io_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
sdio_slave_hal.c hal: remove usages of esp_log in HAL 2021-09-01 13:58:47 +08:00
sha_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
sigmadelta_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
soc_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00: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 build-system: include soc_caps defines into kconfig 2021-12-06 12:37:07 +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 esp_flash: add opi flash support in esp_flash chip driver, for MXIC 2021-09-07 14:44:40 +08:00
spi_hal_iram.c spi: support spi on 8684 2022-01-12 11:30:29 +08:00
spi_hal.c esp_rom: extract int matrix route and cpu ticks getter 2022-02-09 13:52:20 +08:00
spi_slave_hal_iram.c spi: Remove Slave TX/RX set bitlen not effective for ESP32-S2/C3/S3 2021-06-28 18:58:59 -03: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 ESP8684: add freertos, hal, esp_system support 2021-11-06 17:33:44 +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: FIFO overrun handling and errata workarounds 2021-03-30 14:17:31 +08:00
uart_hal_iram.c global: fix sign-compare warnings 2021-01-12 14:05:08 +08:00
uart_hal.c uart: seperate sclk and baudrate setting 2020-11-24 19:12:52 +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
usbh_hal.c usb: USB Host stack uses USB PHY driver 2022-01-06 15:09:39 +08:00
wdt_hal_iram.c esp8684: rename target to esp32c2 2022-01-19 11:08:57 +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.