esp-idf/components/hal
Angus Gratton c2c0e4de3b Merge branch 'feature/s3_wdt_bringup' into 'master'
TIMG and WDT bringup for S3

Closes IDF-1881, IDF-3229, IDF-3301, and IDF-3274

See merge request espressif/esp-idf!13957
2021-07-09 04:43:41 +00:00
..
esp32 Merge branch 'feature/i2c_add_static_buffer_transfers' into 'master' 2021-07-02 14:00:03 +00:00
esp32c3 Merge branch 'feature/esp32c3_usbjtag_console_blocking' into 'master' 2021-07-05 07:57:19 +00:00
esp32h2 esp32h2: add some more fixes and TODOs 2021-07-01 20:36:39 +08:00
esp32s2 Merge branch 'feature/i2c_add_static_buffer_transfers' into 'master' 2021-07-02 14:00:03 +00:00
esp32s3 timer group: add timer group and WDT support for ESP32S3 2021-07-06 16:21:43 +08:00
include/hal esp_eth: Change clock mode setting 2021-07-08 14:27:31 +02:00
platform_port/include/hal hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
test driver: Add esp32c3 drivers (except ADC/DAC) and update tests 2020-12-23 09:53:24 +11:00
adc_hal.c esp32h2: update driver/hal/soc components to support esp32h2 2021-07-01 19:53:11 +08:00
aes_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
CMakeLists.txt esp32h2: update driver/hal/soc components to support esp32h2 2021-07-01 19:53:11 +08:00
component.mk Merge branch 'refactor/emac_hal' into 'master' 2021-06-22 15:34:51 +00: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
emac_hal.c hal/emac_hal: refactord emac_hal 2021-06-16 09:48:21 +08:00
gdma_hal.c gdma: dynamic alloc DMA channels 2021-01-13 10:52:27 +08:00
gpio_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
i2c_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
i2c_hal.c global: fix sign-compare warnings 2021-01-12 14:05:08 +08:00
i2s_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08: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: add LL driver for esp32-s3 2021-03-13 22:31:30 +08:00
ledc_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ledc_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
linker.lf esp32h2: update driver/hal/soc components to support esp32h2 2021-07-01 19:53:11 +08: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 hal: extract hal component from soc component 2020-09-01 13:25: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: clean up LL driver 2021-06-22 15:29:11 +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: added HAL_ASSERT 2021-06-22 11:28:01 +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 hal: added HAL_ASSERT 2021-06-22 11:28:01 +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: update driver/hal/soc components to support esp32h2 2021-07-01 19:53:11 +08:00
spi_flash_hal.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
spi_hal_iram.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
spi_hal.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
spi_slave_hal_iram.c spi: apply gdma allocator to SPI 2021-02-22 07:06:05 +00:00
spi_slave_hal.c spi: apply gdma allocator to SPI 2021-02-22 07:06:05 +00:00
spi_slave_hd_hal.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
systimer_hal.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
timer_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +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: 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
usbh_hal.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
wdt_hal_iram.c esp32h2: update driver/hal/soc components to support esp32h2 2021-07-01 19:53:11 +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.