esp-idf/components/hal
Darian Leung 0159c37cf2 usb: Fix LL 8/16 bit register field access
This commit addes the 8/16 bit register field access workarounds to
the DWC_OTG peripheral. This workaround was applied to all other
peripherals in commit 874a720286.
2021-11-02 14:30:58 +08:00
..
esp32 gptimer: clean up hal and ll for driver-ng 2021-10-20 18:40:08 +08:00
esp32c3 i2s: fix ws signal polarity in tdm mode 2021-10-26 11:12:30 +08:00
esp32h2 i2s: fix ws signal polarity in tdm mode 2021-10-26 11:12:30 +08:00
esp32s2 gptimer: clean up hal and ll for driver-ng 2021-10-20 18:40:08 +08:00
esp32s3 Merge branch 'feature/esp32s3_apptrace' into 'master' 2021-10-26 09:50:40 +00:00
include/hal usb: Fix LL 8/16 bit register field access 2021-11-02 14:30:58 +08:00
platform_port/include/hal HAL: Fix Force U32 macros for C++ typeof() 2021-09-07 11:23:06 +08:00
test
CMakeLists.txt usb: Add usb_phy driver to support operations on USB PHY 2021-09-13 12:39:56 +08:00
Kconfig hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
README.md
adc_hal.c adc: support adc self-calibration on esp32s3 2021-09-16 15:17:29 +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 esp_ds: move timeout mechanism to driver layer 2021-04-22 21:07:35 +08:00
emac_hal.c iperfUtility: add udp rx bandwidth scan 2021-09-01 19:11:28 +08:00
gdma_hal.c
gpio_hal.c
i2c_hal.c
i2c_hal_iram.c I2C: Fix i2c write fake timeout and WDT triggered 2021-08-11 13:39:07 +08:00
i2s_hal.c i2s: fix ws signal polarity in tdm mode 2021-10-26 11:12:30 +08:00
interrupt_controller_hal.c intr_alloc: re-enable unit test 2021-02-02 20:25:50 +08:00
lcd_hal.c lcd: unify callback prototype 2021-10-02 14:23:31 +08:00
ledc_hal.c
ledc_hal_iram.c
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
pcnt_hal.c pcnt: refactor hal driver 2021-08-10 17:19:21 +08:00
rmt_hal.c rmt: clean up LL driver 2021-06-22 15:29:11 +08:00
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: refactoring flash encryption into new api 2021-04-25 17:09:25 +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_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 esp32h2: update driver/hal/soc components to support esp32h2 2021-07-01 19:53:11 +08:00
spi_hal.c hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
spi_hal_iram.c spi_master:support octal mode for esp32s2 and esp32s3 2021-08-19 16:40:22 +08:00
spi_slave_hal.c spi: apply gdma allocator to SPI 2021-02-22 07:06:05 +00:00
spi_slave_hal_iram.c spi: Remove Slave TX/RX set bitlen not effective for ESP32-S2/C3/S3 2021-06-28 18:58:59 -03: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 gptimer: clean up hal and ll for driver-ng 2021-10-20 18:40:08 +08:00
touch_sensor_hal.c
twai_hal.c TWAI: FIFO overrun handling and errata workarounds 2021-03-30 14:17:31 +08:00
twai_hal_iram.c TWAI: FIFO overrun handling and errata workarounds 2021-03-30 14:17:31 +08:00
uart_hal.c
uart_hal_iram.c
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
usbh_hal.c Add USB Host Library 2021-08-24 23:28:00 +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

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.