esp-idf/components/hal
morris 9516e80f61 Merge branch 'bugfix/wakeup_io_hold_unhold_in_sleep_v4.4' into 'release/v4.4'
gpio: Fix deep sleep wakeup IOs unable to unhold after wakeup (v4.4)

See merge request espressif/esp-idf!22670
2023-04-21 10:51:05 +08:00
..
esp32 Merge branch 'bugfix/wakeup_io_hold_unhold_in_sleep_v4.4' into 'release/v4.4' 2023-04-21 10:51:05 +08:00
esp32c3 Merge branch 'bugfix/wakeup_io_hold_unhold_in_sleep_v4.4' into 'release/v4.4' 2023-04-21 10:51:05 +08:00
esp32h2 Merge branch 'bugfix/wakeup_io_hold_unhold_in_sleep_v4.4' into 'release/v4.4' 2023-04-21 10:51:05 +08:00
esp32s2 Merge branch 'bugfix/wakeup_io_hold_unhold_in_sleep_v4.4' into 'release/v4.4' 2023-04-21 10:51:05 +08:00
esp32s3 Merge branch 'bugfix/wakeup_io_hold_unhold_in_sleep_v4.4' into 'release/v4.4' 2023-04-21 10:51:05 +08:00
include/hal Merge branch 'bugfix/wakeup_io_hold_unhold_in_sleep_v4.4' into 'release/v4.4' 2023-04-21 10:51:05 +08:00
platform_port/include/hal C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-12-05 18:16:08 +08:00
test driver: Add esp32c3 drivers (except ADC/DAC) and update tests 2020-12-23 09:53:24 +11:00
adc_hal.c adc: fix esp32 continuous mode sampling freq issue 2022-07-20 16:43:38 +08:00
aes_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
CMakeLists.txt Merge branch 'feature/usb_host_feature_and_refactor_backports_v4.4' into 'release/v4.4' 2023-02-07 17:54:35 +08:00
component.mk usb_host: Rename struct/ll/hal files to use "usb_dwc" prefix 2022-12-13 21:36:00 +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 efuse: Fix load_efuses_from_flash when FE is on 2023-03-29 16:18:54 +08:00
emac_hal.c esp_eth: EMAC start/stop optimization 2022-03-10 10:15:34 +01: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 I2C: put some interrupt used functions into IRAM, 2022-12-01 16:20:56 +08:00
i2c_hal.c I2C: put some interrupt used functions into IRAM, 2022-12-01 16:20:56 +08:00
i2s_hal.c i2s: fixed I2S_mono_stereo_loopback_test (v4.4) 2023-04-07 11:17:07 +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 rgb_lcd: workaround pclk polarity bug by setting mo>=2 2022-09-27 13:22:18 +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 2022-02-10 16:54:00 +08:00
linker.lf hal: fix CONFIG_TWAI_ISR_IN_IRAM not taking effect for C3/H2 2022-09-21 08:35:54 +00: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: 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: 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 spi_flash: remove back-compatible with caller function of S3Beta ROM 2022-06-14 19:30:59 +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 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_master:support octal mode for esp32s2 and esp32s3 2021-08-19 16:40:22 +08:00
spi_hal.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
spi_slave_hal_iram.c spi: limit esp32 dma workaround only on esp32 2022-12-01 20:57:09 +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 hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
timer_hal.c driver: fix timer driver initialization sequence to not trigger interrupt immediately 2021-09-16 19:45:33 +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 20:26:53 +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_dwc_hal.c hal: Fix USB DWC HAL host channel halt race condition 2022-12-13 22:27:54 +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 esp32h2: update driver/hal/soc components to support esp32h2 2021-07-01 19:53:11 +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.