esp-idf/components/hal/include/hal
2020-10-19 11:56:18 +08:00
..
adc_hal.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
adc_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
brownout_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
cpu_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
cpu_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
dac_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
dac_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
dma_types.h async memcpy: support async memcopy on esp32s2/s3 2020-09-16 21:30:54 +08:00
esp_flash_err.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
gdma_hal.h async memcpy: support async memcopy on esp32s2/s3 2020-09-16 21:30:54 +08:00
gpio_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
gpio_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
hal_defs.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
i2c_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
i2c_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
i2s_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
i2s_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
interrupt_controller_hal.h intr_alloc: split interrupt allocator into common-code and platform-code 2020-09-30 07:44:12 +08:00
interrupt_controller_types.h intr_alloc: split interrupt allocator into common-code and platform-code 2020-09-30 07:44:12 +08:00
ledc_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
ledc_types.h soc: updates caps usage 2020-10-17 16:10:17 +08:00
mcpwm_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
mcpwm_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
mpu_hal.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
mpu_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
pcnt_hal.h pcnt: add rotary encoder example 2020-10-19 11:56:18 +08:00
pcnt_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
readme.md hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
rmt_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
rmt_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
rtc_hal.h soc: move out rtc_hal to hal component 2020-09-23 02:53:03 +00:00
rtc_io_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
rtc_io_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
sdio_slave_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
sdio_slave_ll.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
sdio_slave_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
sha_types.h SHA: add HAL layer and refactor driver 2020-10-09 08:24:08 +00:00
sigmadelta_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
sigmadelta_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
soc_hal.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
spi_flash_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
spi_flash_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
spi_hal.h soc: updates caps usage 2020-10-17 16:10:17 +08:00
spi_slave_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
spi_slave_hd_hal.h spi: fix build fail issue when target is esp32s3 2020-09-24 10:51:23 +08:00
spi_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
systimer_hal.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
systimer_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
timer_hal.h soc: updates caps usage 2020-10-17 16:10:17 +08:00
timer_types.h soc: updates caps usage 2020-10-17 16:10:17 +08:00
touch_sensor_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
touch_sensor_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
twai_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
twai_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
uart_hal.h hal: update link to HAL readme.md 2020-09-11 15:48:08 +08:00
uart_types.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
usb_hal.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
wdt_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
wdt_types.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00

HAL Layer Readme

The HAL layer is designed to be used by the drivers. We don't guarantee the stability and back-compatibility among versions. The HAL layer may update very frequently with the driver. Please don't use them in the applications or treat them as stable APIs.

The HAL layer consists of two layers: HAL (upper) and Lowlevel(bottom). The HAL layer defines the steps and data required by the peripheral. The lowlevel is a translation layer converting general conceptions to register configurations.

Lowlevel

This layer should be all static inline. The first argument of LL functions is usually a pointer to the beginning address of the peripheral register. Each chip should have its own LL layer. The functions in this layer should be atomic and independent from each other so that the upper layer can change/perform one of the options/operation without touching the others.

HAL

This layer should depend on the operating system as little as possible. It's a wrapping of LL functions, so that the upper layer can combine basic steps into different working ways (polling, non-polling, interrupt, etc.). Without using queues/locks/delay/loop/etc., this layer can be easily port to other os or simulation systems.

To get better performance and better porting ability, contexts are used to hold sustainable data and pass the parameters.

To develop your own driver, it is suggested to copy the HAL layer to your own code and keep them until manual update.