esp-idf/components/hal
Wan Lei dccc31e9e4 Merge branch 'refactor/remove_apb_ctrl_reg' into 'master'
sysreg: deprecate apb_ctrl related reg

Closes DOC-5139

See merge request espressif/esp-idf!24135
2023-06-15 14:57:32 +08:00
..
esp32 ledc:add option to put LEDC function into IRAM 2023-06-14 18:12:01 +08:00
esp32c2 ledc:add option to put LEDC function into IRAM 2023-06-14 18:12:01 +08:00
esp32c3 ledc:add option to put LEDC function into IRAM 2023-06-14 18:12:01 +08:00
esp32c6 ledc:add option to put LEDC function into IRAM 2023-06-14 18:12:01 +08:00
esp32h2 ledc:add option to put LEDC function into IRAM 2023-06-14 18:12:01 +08:00
esp32p4 esp32p4: introduce the target 2023-06-13 15:16:11 +08:00
esp32s2 ledc:add option to put LEDC function into IRAM 2023-06-14 18:12:01 +08:00
esp32s3 Merge branch 'refactor/remove_apb_ctrl_reg' into 'master' 2023-06-15 14:57:32 +08:00
include/hal adc: port gh pr to current adc continuous mode driver 2023-06-05 14:25:53 +08:00
platform_port/include/hal
test
test_apps/crypto hal: minor fixes needed in the crypto hal test app 2023-06-01 11:37:36 +05:30
CMakeLists.txt esp_hw_support/bootloader: made ESP32-C6 and ESP32-H2 RNG available 2023-05-23 18:14:51 +08:00
Kconfig spi: change linker file let spi hal able to out from iram 2023-04-21 18:58:36 +08:00
README.md
adc_hal.c adc: port gh pr to current adc continuous mode driver 2023-06-05 14:25:53 +08:00
adc_hal_common.c adc_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08:00
adc_oneshot_hal.c
aes_hal.c
apm_hal.c
brownout_hal.c brownout: Disable the hardware BOD when BOD interrupt is enabled 2023-04-21 10:22:59 +08:00
cache_hal.c
ds_hal.c
ecc_hal.c
ecdsa_hal.c
efuse_hal.c adc_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08:00
emac_hal.c driver: minor code clean up to pass coverity scan test 2023-06-10 16:21:12 +08:00
etm_hal.c
gdma_hal.c
gpio_hal.c
hmac_hal.c
i2c_hal.c
i2c_hal_iram.c
i2s_hal.c i2s_tdm: fixed half sample bit calculation 2023-05-09 17:51:33 +08:00
lcd_hal.c
ledc_hal.c ledc: Add an all-in-one HAL function to set fade parameters, and refactor ledc_ll_get_max_duty function 2023-04-21 16:40:54 +08:00
ledc_hal_iram.c ledc: Add an all-in-one HAL function to set fade parameters, and refactor ledc_ll_get_max_duty function 2023-04-21 16:40:54 +08:00
linker.lf core-system: changed CONFIG_COMPILER_OPTIMIZATION_DEFAULT to CONFIG_COMPILER_OPTIMIZATION_DEBUG 2023-06-02 15:16:50 +08:00
mcpwm_hal.c
mmu_hal.c
mpi_hal.c bignum: refactored the hardware abstraction of the mpi peripheral 2023-04-24 16:15:11 +05:30
mpu_hal.c
parlio_hal.c
pcnt_hal.c
rmt_hal.c
rtc_io_hal.c
sdio_slave_hal.c
sdkconfig.rename
sdm_hal.c
sha_hal.c
spi_flash_encrypt_hal_iram.c
spi_flash_hal.c spi_flash: 2nd stage for supporting flash suspend. (1). Support more esp chips (2). Improve real-time performance (3). Making timing more stable (4) Add documents 2023-05-11 20:10:30 +08:00
spi_flash_hal_common.inc spi_flash: 2nd stage for supporting flash suspend. (1). Support more esp chips (2). Improve real-time performance (3). Making timing more stable (4) Add documents 2023-05-11 20:10:30 +08:00
spi_flash_hal_gpspi.c
spi_flash_hal_iram.c spi_flash: 2nd stage for supporting flash suspend. (1). Support more esp chips (2). Improve real-time performance (3). Making timing more stable (4) Add documents 2023-05-11 20:10:30 +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
timer_hal.c
timer_hal_iram.c
touch_sensor_hal.c
twai_hal.c
twai_hal_iram.c
uart_hal.c
uart_hal_iram.c
usb_dwc_hal.c
usb_hal.c
usb_phy_hal.c
wdt_hal_iram.c
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.