esp-idf/components/hal
Michael (XIAO Xufeng) 8409485b22 Merge branch 'doc/fix_misleading_of_mcpwm_capture_enable_doc' into 'master'
driver/mcpwm: fix the misleading of mcpwm_capture_enable parameters

Closes IDFGH-3000

See merge request espressif/esp-idf!13497
2021-05-16 15:15:26 +00:00
..
esp32 driver/mcpwm: fix the misleading of mcpwm_capture_enable parameters 2021-05-13 12:23:19 +08:00
esp32c3 gdma: separate tx/rx channel interrupt 2021-05-06 15:06:37 +08:00
esp32s2 touch_sensor: fix esp32s2 touch sensor default power source 2021-05-08 11:09:17 +08:00
esp32s3 Merge branch 'doc/fix_misleading_of_mcpwm_capture_enable_doc' into 'master' 2021-05-16 15:15:26 +00:00
include/hal driver/ledc: support invert channel output 2021-05-11 11:54:16 +08:00
test driver: Add esp32c3 drivers (except ADC/DAC) and update tests 2020-12-23 09:53:24 +11:00
adc_hal.c gdma: separate tx/rx channel interrupt 2021-05-06 15:06:37 +08:00
aes_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
CMakeLists.txt soc/hal: add tinyusb support esp32s3 2021-05-06 16:20:54 +08:00
component.mk soc/hal: add tinyusb support esp32s3 2021-05-06 16:20:54 +08:00
cpu_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
dac_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ds_hal.c esp_ds: move timeout mechanism to driver layer 2021-04-22 21:07:35 +08:00
gdma_hal.c gdma: dynamic alloc DMA channels 2021-01-13 10:52:27 +08:00
gpio_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
i2c_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
i2c_hal.c global: fix sign-compare warnings 2021-01-12 14:05:08 +08:00
i2s_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
interrupt_controller_hal.c intr_alloc: re-enable unit test 2021-02-02 20:25:50 +08:00
lcd_hal.c lcd: add LL driver for esp32-s3 2021-03-13 22:31:30 +08:00
ledc_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ledc_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
linker.lf spi_flash: refactoring flash encryption into new api 2021-04-25 17:09:25 +08:00
mcpwm_hal.c mcpwm: rename macros related to soc capbility 2021-03-16 21:53:59 +08:00
mpu_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
pcnt_hal.c hal: extract hal component from soc component 2020-09-01 13:25: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: distinguish group and channel in HAL layer 2021-02-25 12:42:23 +08:00
rtc_io_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
sdio_slave_hal.c Fix ignored return value. 2021-05-05 15:34:24 +02:00
sha_hal.c AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
sigmadelta_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
soc_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00: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: Add auto suspend mode on esp32c3 2021-01-25 11:14:02 +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 spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 13:42:49 +08:00
spi_flash_hal.c spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 13:42:49 +08:00
spi_hal_iram.c spi: apply gdma allocator to SPI 2021-02-22 07:06:05 +00:00
spi_hal.c spi: apply gdma allocator to SPI 2021-02-22 07:06:05 +00:00
spi_slave_hal_iram.c spi: apply gdma allocator to SPI 2021-02-22 07:06:05 +00: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_slave_hd: refactor the hal append api to remove the spinlock 2021-02-24 12:01:31 +08:00
systimer_hal.c systimer: optimise esp_timer_get_time 2021-04-26 11:54:02 +08:00
timer_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
touch_sensor_hal.c hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
twai_hal_iram.c TWAI: FIFO overrun handling and errata workarounds 2021-03-30 14:17:31 +08:00
twai_hal.c TWAI: FIFO overrun handling and errata workarounds 2021-03-30 14:17:31 +08:00
uart_hal_iram.c global: fix sign-compare warnings 2021-01-12 14:05:08 +08:00
uart_hal.c uart: seperate sclk and baudrate setting 2020-11-24 19:12:52 +08:00
usb_hal.c soc/hal: add tinyusb support esp32s3 2021-05-06 16:20:54 +08:00
wdt_hal_iram.c hal: Add initial ESP32-C3 support 2020-11-30 15:23:15 +11: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.