esp-idf/components/hal
Michael (XIAO Xufeng) c4310fb0db Merge branch 'feature/add_h2_beta2_target_support' into 'master'
esp32h2: Add support for esp32h2 beta2 version

Closes IDF-4230

See merge request espressif/esp-idf!15630
2021-11-26 03:56:01 +00:00
..
esp32 Merge branch 'bugfix/ledc_auto_clk_refactor' into 'master' 2021-11-12 03:21:46 +00:00
esp32c3 LEDC: divisor calculation will now be rounded up when necessary 2021-11-11 12:21:22 +08:00
esp32h2 esp32h2: update reg and struct for beta2 2021-11-24 12:34:17 +08:00
esp32s2 LEDC: divisor calculation will now be rounded up when necessary 2021-11-11 12:21:22 +08:00
esp32s3 LEDC: divisor calculation will now be rounded up when necessary 2021-11-11 12:21:22 +08:00
esp8684 LEDC: improved support for ESP32-C3 and refactored divisor calculation 2021-11-11 12:21:15 +08:00
include/hal netif: added ESP-NETIF L2 TAP interface 2021-11-23 11:17:22 +01:00
platform_port/include/hal
test Build & config: Remove leftover files from the unsupported "make" build system 2021-11-11 15:32:36 +01:00
CMakeLists.txt ESP8684: add freertos, hal, esp_system support 2021-11-06 17:33:44 +08:00
Kconfig
README.md
adc_hal.c ESP8684: add freertos, hal, esp_system support 2021-11-06 17:33:44 +08:00
aes_hal.c
cpu_hal.c
dac_hal.c
ds_hal.c
emac_hal.c
gdma_hal.c gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
gpio_hal.c
i2c_hal.c
i2c_hal_iram.c
i2s_hal.c
interrupt_controller_hal.c
lcd_hal.c
ledc_hal.c LEDC: improved support for ESP32-C3 and refactored divisor calculation 2021-11-11 12:21:15 +08:00
ledc_hal_iram.c
linker.lf ESP8684: add freertos, hal, esp_system support 2021-11-06 17:33:44 +08:00
mcpwm_hal.c
mpu_hal.c
pcnt_hal.c
rmt_hal.c
rtc_io_hal.c
sdio_slave_hal.c
sha_hal.c
sigmadelta_hal.c
soc_hal.c
spi_flash_encrypt_hal_iram.c
spi_flash_hal.c
spi_flash_hal_common.inc
spi_flash_hal_gpspi.c
spi_flash_hal_iram.c ESP8684: add freertos, hal, esp_system support 2021-11-06 17:33:44 +08:00
spi_hal.c
spi_hal_iram.c
spi_slave_hal.c
spi_slave_hal_iram.c
spi_slave_hd_hal.c
systimer_hal.c ESP8684: add freertos, hal, esp_system support 2021-11-06 17:33:44 +08:00
timer_hal.c
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
usbh_hal.c
wdt_hal_iram.c ESP8684: add freertos, hal, esp_system support 2021-11-06 17:33:44 +08:00
xt_wdt_hal.c

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.