alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 10:46:02 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity
2b374ab7b8
esp-idf/components/hal
History
Martin Vychodil 497b730e8f * memprot support for RTC_SLOW 
* API upgrade
JIRA IDF-1636
2020-10-08 11:19:23 +08:00
..
esp32 esp_flash: fix the incorrect check_idle logic in LL and chip_driver 2020-10-02 05:34:36 +00:00
esp32s2 * memprot support for RTC_SLOW 2020-10-08 11:19:23 +08:00
esp32s3 esp_flash: fix the incorrect check_idle logic in LL and chip_driver 2020-10-02 05:34:36 +00:00
include/hal Merge branch 'feature/intr_alloc' into 'master' 2020-09-30 07:44:12 +08:00
test soc: move mpu_hal test to hal component 2020-09-23 02:53:03 +00:00
adc_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
CMakeLists.txt intr_alloc: split interrupt allocator into common-code and platform-code 2020-09-30 07:44:12 +08:00
component.mk hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
cpu_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
dac_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
gpio_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
i2c_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
i2c_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
i2s_hal.c Driver(I2S): Fix I2S PDM clock incorrect issue when using APLL. 2020-09-07 08:08:22 +00:00
interrupt_controller_hal.c intr_alloc: split interrupt allocator into common-code and platform-code 2020-09-30 07:44:12 +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: extract hal component from soc component 2020-09-01 13:25:32 +08:00
linker.lf hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
mcpwm_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
mpu_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08: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 hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
rtc_io_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
sdio_slave_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
sigmadelta_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
soc_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
spi_flash_hal_common.inc hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
spi_flash_hal_gpspi.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
spi_flash_hal_iram.c spi_flash:bringup some flash supports for esp32s3 2020-09-22 15:15:03 +08:00
spi_flash_hal.c spi_flash: fix initialization failure when ex_flash with psram on 2020-09-25 10:22:24 +08:00
spi_hal_iram.c spi: fix build fail issue when target is esp32s3 2020-09-24 10:51:23 +08:00
spi_hal.c spi: fix build fail issue when target is esp32s3 2020-09-24 10:51:23 +08:00
spi_slave_hal_iram.c spi: fix build fail issue when target is esp32s3 2020-09-24 10:51:23 +08:00
spi_slave_hal.c spi: fix build fail issue when target is esp32s3 2020-09-24 10:51:23 +08:00
spi_slave_hd_hal.c spi: fix build fail issue when target is esp32s3 2020-09-24 10:51:23 +08:00
timer_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
touch_sensor_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
twai_hal.c TWAI: Track HW state in HAL 2020-09-02 13:03:41 +08:00
uart_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
uart_hal.c hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
wdt_hal_iram.c hal: extract hal component from soc component 2020-09-01 13:25:32 +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.