esp-idf/components/hal
Michael (XIAO Xufeng) 8b86834a72 Merge branch 'bugfix/gpio_pin_num_fix_v4.4' into 'release/v4.4'
gpio: Fix some gpio pin num errors on esp32s2 and esp32c3 (backport v4.4)

See merge request espressif/esp-idf!16594
2022-02-10 10:21:52 +00:00
..
esp32 adc: support adc dma driver on all chips 2021-12-23 17:13:46 +08:00
esp32c3 Merge branch 'bugfix/gpio_pin_num_fix_v4.4' into 'release/v4.4' 2022-02-10 10:21:52 +00:00
esp32h2 Merge branch 'feature/gdma_iram_interrupt_v4.4' into 'release/v4.4' 2021-12-23 12:50:22 +00:00
esp32s2 Merge branch 'bugfix/fix_spi_cs_hold_time_issue_v4.4' into 'release/v4.4' 2022-02-10 09:12:15 +00:00
esp32s3 spi_master: fix spi cs_ena_posttrans issue 2022-02-07 12:19:51 +08:00
include/hal Merge branch 'bugfix/gpio_pin_num_fix_v4.4' into 'release/v4.4' 2022-02-10 10:21:52 +00:00
platform_port/include/hal HAL: Fix Force U32 macros for C++ typeof() 2021-09-07 11:23:06 +08:00
test
CMakeLists.txt adc: support adc dma driver on all chips 2021-12-23 17:13:46 +08:00
Kconfig
README.md
adc_hal.c adc: support adc dma driver on all chips 2021-12-23 17:13:46 +08:00
aes_hal.c
component.mk usb: Add usb_phy driver to support operations on USB PHY 2021-09-13 12:39:56 +08:00
cpu_hal.c
dac_hal.c
ds_hal.c
emac_hal.c Fixed ESP32 EMAC driver `insufficient TX buffer size` which could followed esp_eth_stop and esp_eth_start sequence 2021-12-21 14:04:55 +01:00
gdma_hal.c
gpio_hal.c
i2c_hal.c
i2c_hal_iram.c
i2s_hal.c i2s: fix mclk stopped when setting clock 2022-02-07 15:27:35 +08:00
interrupt_controller_hal.c
lcd_hal.c lcd: unify callback prototype 2021-10-02 14:23:31 +08:00
ledc_hal.c
ledc_hal_iram.c
linker.lf
mcpwm_hal.c
mpu_hal.c
pcnt_hal.c
rmt_hal.c
rtc_io_hal.c
sdio_slave_hal.c hal: remove usages of esp_log in HAL 2021-09-01 13:58:47 +08:00
sha_hal.c
sigmadelta_hal.c
soc_hal.c
spi_flash_encrypt_hal_iram.c
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_flash_hal_common.inc esp_flash: add opi flash support in esp_flash chip driver, for MXIC 2021-09-07 14:44:40 +08:00
spi_flash_hal_gpspi.c
spi_flash_hal_iram.c
spi_hal.c
spi_hal_iram.c
spi_slave_hal.c
spi_slave_hal_iram.c
spi_slave_hd_hal.c
systimer_hal.c
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
twai_hal.c
twai_hal_iram.c
uart_hal.c
uart_hal_iram.c
usb_hal.c
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: Fix how the HCD handles sudden disconnection 2021-11-11 16:25:01 +08:00
wdt_hal_iram.c
xt_wdt_hal.c WDT: Add support for XTAL32K Watchdog timer 2021-09-02 09:09:00 +08:00

README.md

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.