esp-idf/components/hal
Angus Gratton 629b4270b4 Merge branch 'feature/c3_mbedtls_merge' into 'master'
mbedtls: merge changes from C3 to master

Closes IDF-2544 and IDF-2114

See merge request espressif/esp-idf!11718
2020-12-29 12:37:08 +08:00
..
esp32 driver: Add esp32c3 ADC driver 2020-12-23 09:53:24 +11:00
esp32c3 mbedtls: merge changes from C3 2020-12-29 10:56:13 +08:00
esp32s2 Add USB Host registers and types and LL layer 2020-12-24 19:43:42 +08:00
esp32s3 driver: Add esp32c3 ADC driver 2020-12-23 09:53:24 +11:00
include/hal Add USB Host registers and types and LL layer 2020-12-24 19:43:42 +08:00
test driver: Add esp32c3 drivers (except ADC/DAC) and update tests 2020-12-23 09:53:24 +11:00
adc_hal.c driver: Add adc_digi single conversion mode 2020-12-23 09:53:24 +11:00
aes_hal.c mbedtls: merge changes from C3 2020-12-29 10:56:13 +08:00
CMakeLists.txt esp_flash: add support for external flash on C3 2020-12-22 13:31:04 +08:00
component.mk Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00: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
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 i2c: Add supports on esp32s3 2020-11-12 11:32:45 +08:00
i2s_hal.c bugfix(adc): missing ranges of ADC codes in ESP32 2020-10-12 07:41:03 +00:00
interrupt_controller_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
ledc_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
ledc_hal.c soc: updates caps usage 2020-10-17 16:10:17 +08:00
linker.lf TWAI: ISR runs when cache is disabled 2020-10-10 14:19:32 +08:00
mcpwm_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00: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: split TX and RX in LL driver 2020-11-05 19:00:55 +08:00
rtc_io_hal.c hal: Add initial ESP32-C3 support 2020-11-30 15:23:15 +11:00
sdio_slave_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sha_hal.c driver: Add esp32c3 drivers (except ADC/DAC) and update tests 2020-12-23 09:53:24 +11: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_hal_common.inc spi_flash: Add ESP32-C3 support 2020-12-17 15:34:13 +11:00
spi_flash_hal_gpspi.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
spi_flash_hal_iram.c spi_flash: Add ESP32-C3 support 2020-12-17 15:34:13 +11:00
spi_flash_hal.c hal: Add initial ESP32-C3 support 2020-11-30 15:23:15 +11:00
spi_hal_iram.c hal: Add initial ESP32-C3 support 2020-11-30 15:23:15 +11:00
spi_hal.c hal: Add initial ESP32-C3 support 2020-11-30 15:23:15 +11:00
spi_slave_hal_iram.c hal: Add initial ESP32-C3 support 2020-11-30 15:23:15 +11:00
spi_slave_hal.c spi: esp32s3 bringup for spi 2020-10-26 11:28:34 +08:00
spi_slave_hd_hal.c hal: Add initial ESP32-C3 support 2020-11-30 15:23:15 +11:00
timer_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
touch_sensor_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
twai_hal_iram.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
twai_hal.c Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
uart_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
uart_hal.c uart: seperate sclk and baudrate setting 2020-11-24 19:12:52 +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.