esp-idf/components/hal
Michael (XIAO Xufeng) b8e103bb6b Merge branch 'bugfix/wafer_version_minor_s3' into 'master'
esp32s3: fixed bug chip v0.0 detected as vX.8

See merge request espressif/esp-idf!21350
2022-12-01 19:08:51 +08:00
..
esp32 C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT 2022-11-21 16:18:08 +08:00
esp32c2 esp_hw_support: Removes efuse dependency 2022-11-25 19:27:33 +08:00
esp32c3 esp_hw_support: Removes efuse dependency 2022-11-25 19:27:33 +08:00
esp32c6 uart: support examples and tests on esp32c6 2022-11-24 16:07:24 +08:00
esp32h2 ESP32-H2: Introduce new target for ESP32H2 2022-11-23 14:38:05 +08:00
esp32h4 hmac_hal: Merge hmac hal layer for different into one 2022-11-24 16:04:26 +05:30
esp32s2 esp_hw_support: Removes efuse dependency 2022-11-25 19:27:33 +08:00
esp32s3 Merge branch 'bugfix/wafer_version_minor_s3' into 'master' 2022-12-01 19:08:51 +08:00
include/hal hmac_hal: Merge hmac hal layer for different into one 2022-11-24 16:04:26 +05:30
platform_port/include/hal all: Replaces memset/memcpy with hal_mem.. funcs where were used -Wstringop-overread, -Wstringop-overflow, -Warray-bounds 2022-11-30 19:22:41 +08:00
test ci: Disable all currently failed target tests for esp32c6 2022-11-28 12:09:08 +08:00
adc_hal_common.c esp_adc: support adc calibration on esp32c2 2022-10-13 21:03:51 +08:00
adc_hal.c esp_adc: new esp_adc component and adc drivers 2022-07-15 18:31:00 +08:00
adc_oneshot_hal.c dac: optimize the dma stratege 2022-10-25 17:14:59 +08:00
aes_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
cache_hal.c esp32h2: renaming esp32h2 to esp32h4 2022-11-08 17:05:33 +08:00
CMakeLists.txt hmac_hal: Merge hmac hal layer for different into one 2022-11-24 16:04:26 +05:30
ds_hal.c esp_ds: move timeout mechanism to driver layer 2021-04-22 21:07:35 +08:00
ecc_hal.c esp32c2/hal: Added ECC HAL layer 2022-03-08 14:05:23 +00:00
efuse_hal.c all: Apply new version logic (major * 100 + minor) 2022-11-03 08:36:23 +00:00
emac_hal.c esp_eth: receive buffer allocation optimization 2022-11-15 10:44:12 +00:00
etm_hal.c etm: added etm channel allocator 2022-11-23 15:31:33 +08: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
hmac_hal.c hmac_hal: Merge hmac hal layer for different into one 2022-11-24 16:04:26 +05:30
i2c_hal_iram.c I2C: Refactor i2c hal and ll 2022-09-01 15:53:59 +08:00
i2c_hal.c I2C: Add i2c support for ESP32C6 2022-11-07 14:12:53 +08:00
i2s_hal.c i2s: support 4 line pdm rx on esp32s3 2022-11-04 15:46:34 +08:00
Kconfig esp_rom: patch systimer driver for esp32c2 2022-07-25 16:08:52 +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_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ledc_hal.c ledc: Provide support for esp32c2 and esp32h2 2022-04-14 08:15:14 +00:00
linker.lf soc_caps: Introduce SOC_LEDC_SUPPORTED and SOC_I2C_SUPPORTED caps to IDF 2022-08-31 20:43:22 +08:00
mcpwm_hal.c mcpwm: clean up hal driver and add doc 2022-06-02 15:01:18 +08:00
mmu_hal.c esp32h2: renaming esp32h2 to esp32h4 2022-11-08 17:05:33 +08:00
mpu_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
pcnt_hal.c pulse_cnt: new driver for PCNT peripheral 2022-03-03 22:38: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: support esp32c6 2022-09-17 04:56:49 +00:00
rtc_io_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
sdio_slave_hal.c sdio_slave: allow disabling highspeed mode 2022-09-27 18:38:35 +08: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 AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08: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: bringup for esp32c6 2022-11-09 12:50:46 +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: renaming esp32h2 to esp32h4 2022-11-08 17:05:33 +08:00
spi_flash_hal.c spi_flash: bringup for esp32c6 2022-11-09 12:50:46 +08:00
spi_hal_iram.c spi: support spi on 8684 2022-01-12 11:30:29 +08:00
spi_hal.c hal: Remove dependency on log component 2022-04-18 10:35:01 +08:00
spi_slave_hal_iram.c spi: limit esp32 dma workaround only on esp32 2022-11-14 16:01:48 +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 systimer: support etm event 2022-11-23 15:32:34 +08:00
timer_hal_iram.c gptimer: add API to get captured count value 2022-08-25 17:55:19 +08:00
timer_hal.c gptimer: bringup driver on esp32c6 2022-09-13 10:50:58 +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: bringup on esp32c6 2022-11-04 17:40:29 +08:00
twai_hal.c twai: bringup on esp32c6 2022-11-04 17:40:29 +08:00
uart_hal_iram.c global: fix sign-compare warnings 2021-01-12 14:05:08 +08:00
uart_hal.c uart: move frequency of clock sources out of HAL 2022-08-15 18:55:43 +00:00
usb_dwc_hal.c usb_host: Rename struct/ll/hal symbols to use "usb_dwc" prefix 2022-09-16 16:45:26 +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 esp32c6: add hal support 2022-09-01 12:37:51 +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.