esp-idf/components/hal
Wan Lei 1265a2db9d Merge branch 'refactor/add_missing_include_path_for_soc_struct_files' into 'master'
Fix check_public_headers violations for soc component

Closes IDF-5397

See merge request espressif/esp-idf!19158
2022-08-01 10:14:04 +08:00
..
esp32 Merge branch 'bugfix/fix_wrong_mmu_end_addr_check' into 'master' 2022-07-28 12:00:35 +08:00
esp32c2 mmu: fix wrong mmu end check 2022-07-27 10:22:09 +00:00
esp32c3 mmu: fix wrong mmu end check 2022-07-27 10:22:09 +00:00
esp32h2 mmu: fix wrong mmu end check 2022-07-27 10:22:09 +00:00
esp32s2 soc: fix register header files not self-contain 2022-07-29 11:18:06 +08:00
esp32s3 mmu: fix wrong mmu end check 2022-07-27 10:22:09 +00:00
include/hal Clean IRAM and DRAM address space conversion macros 2022-07-29 17:07:39 +08:00
platform_port/include/hal Merge branch 'feature/c2_systimer_26mhz' into 'master' 2022-07-11 16:17:25 +08:00
test ci: partially enable ut tests for esp32c2 2022-06-02 14:23:35 +08:00
CMakeLists.txt sdm: clean up soc/hal/ll code 2022-07-20 14:59:50 +08:00
Kconfig esp_rom: patch systimer driver for esp32c2 2022-07-25 16:08:52 +08:00
README.md
adc_hal.c esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
adc_hal_common.c esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
adc_oneshot_hal.c esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
aes_hal.c
cache_hal.c cache/mmu: implememnt cache and mmu hal APIs in bootloader 2022-03-11 22:43:11 +08:00
dac_hal.c
ds_hal.c
ecc_hal.c esp32c2/hal: Added ECC HAL layer 2022-03-08 14:05:23 +00:00
efuse_hal.c efuse: Adds major and minor versions and others 2022-07-05 14:38:27 +08:00
emac_hal.c esp_netif: remove dependency of L2 TAP Interface from netif_lwip 2022-04-08 16:40:29 +02: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.c I2C: Fullfill the I2C clock tree, and support 26M XTAL on ESP32-C2 2022-07-19 11:41:42 +08:00
i2c_hal_iram.c i2c: Correct hal functions iram placement and remove IRAM_ATTR for i2c_hw_fsm_reset 2022-02-28 15:44:35 +08:00
i2s_hal.c i2s: add slot sequence table 2022-07-21 15:52:39 +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.c ledc: Provide support for esp32c2 and esp32h2 2022-04-14 08:15:14 +00:00
ledc_hal_iram.c
linker.lf esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08: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
pcnt_hal.c pulse_cnt: new driver for PCNT peripheral 2022-03-03 22:38:32 +08:00
rmt_hal.c driver_ng: implement new rmt driver 2022-05-07 10:34:50 +00:00
rtc_io_hal.c
sdio_slave_hal.c hal: explicit initialization 2022-05-30 12:57:52 +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
spi_flash_encrypt_hal_iram.c
spi_flash_hal.c G0: RISC-V targets have now an independent G0 layer 2022-06-14 15:00:53 +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_hal_iram.c i2c: support esp32h2 2022-02-23 15:19:37 +08:00
spi_hal.c hal: Remove dependency on log component 2022-04-18 10:35:01 +08:00
spi_hal_iram.c spi: support spi on 8684 2022-01-12 11:30:29 +08:00
spi_slave_hal.c
spi_slave_hal_iram.c
spi_slave_hd_hal.c
systimer_hal.c systimer: refactor hal to accomodate more xtal choices 2022-07-25 16:08:52 +08:00
timer_hal.c gptimer: new driver for previous timer group 2022-01-07 14:44:50 +08:00
timer_hal_iram.c gptimer: new driver for previous timer group 2022-01-07 14:44:50 +08:00
touch_sensor_hal.c
twai_hal.c
twai_hal_iram.c
uart_hal.c uart: add default source clock for all targets 2022-05-09 11:26:30 +08:00
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: USB Host stack uses USB PHY driver 2022-01-06 15:09:39 +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

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.