esp-idf/components/hal/include/hal
2022-05-20 16:46:27 +08:00
..
adc_hal_common.h adc: create common adc hal layer 2022-05-07 19:20:44 +08:00
adc_hal.h adc: create common adc hal layer 2022-05-07 19:20:44 +08:00
adc_types_private.h adc: create common adc hal layer 2022-05-07 19:20:44 +08:00
adc_types.h docs: fix all doxygen warnings 2022-05-12 14:50:03 +08:00
aes_hal.h AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
aes_types.h AES: refactor and add HAL layer 2020-12-10 09:04:47 +00:00
brownout_hal.h soc: combine xxx_caps.h into one soc_caps.h 2020-10-17 16:10:15 +08:00
cache_hal.h cache/mmu: implememnt cache and mmu hal APIs in bootloader 2022-03-11 22:43:11 +08:00
cache_types.h cache/mmu: implememnt cache and mmu hal APIs in bootloader 2022-03-11 22:43:11 +08:00
cpu_hal.h vfs: add support for semihosting on ESP32-C3 2022-01-14 17:29:03 +01:00
cpu_types.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
dac_hal.h hal: added HAL_ASSERT 2021-06-22 11:28:01 +08:00
dac_types.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
dma_types.h gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
ds_hal.h Digital Signature support for S3 2021-09-02 11:59:24 +05:30
ecc_hal.h esp32c2/hal: Added ECC HAL layer 2022-03-08 14:05:23 +00:00
ecc_types.h esp32c2/hal: Added ECC HAL layer 2022-03-08 14:05:23 +00:00
efuse_hal.h soc: Adds efuse hal 2022-02-24 22:20:09 +08:00
emac_hal.h esp_netif: remove dependency of L2 TAP Interface from netif_lwip 2022-04-08 16:40:29 +02:00
esp_flash_err.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
eth_types.h esp_eth: Update esp32's EMAC API to decouple driver and vendor config 2022-02-14 16:17:29 +00:00
gdma_hal.h gdma: support IRAM interrupt 2021-11-08 16:14:51 +08:00
gpio_hal.h esp32h2: support GPIO peripheral, IO_MUX, GPIO matrix. 2022-03-04 11:25:05 +08:00
gpio_types.h esp32h2: support GPIO peripheral, IO_MUX, GPIO matrix. 2022-03-04 11:25:05 +08:00
i2c_hal.h i2c: support esp32c2 2022-02-23 15:19:37 +08:00
i2c_types.h driver: remove deprecated code 2022-05-19 11:31:53 +08:00
i2s_hal.h i2s: extract std/pdm/tdm modes 2022-03-22 10:14:45 +08:00
i2s_pdm.h i2s: extract std/pdm/tdm modes 2022-03-22 10:14:45 +08:00
i2s_std.h i2s: fix only right case 2022-04-23 07:38:45 +00:00
i2s_tdm.h i2s: extract std/pdm/tdm modes 2022-03-22 10:14:45 +08:00
i2s_types_priv.h i2s: fix only right case 2022-04-23 07:38:45 +00:00
i2s_types.h i2s: fix bug of switching mono/stereo mode by 'i2s_set_clk' on c3/s3 2022-03-02 03:34:25 +00:00
interrupt_controller_hal.h [hal]: cleaned up interrupt mask functions 2021-04-06 11:54:13 +08:00
interrupt_controller_types.h interrupt: added INTC FLEXIBLE capabillity to esp32c3 CPU caps 2021-01-05 15:39:46 +08:00
lcd_hal.h lcd: unify callback prototype 2021-10-02 14:23:31 +08:00
lcd_types.h clk_tree: prework of introducing clk subsystem control 2022-04-11 12:09:06 +08:00
ledc_hal.h ledc: Provide support for esp32c2 and esp32h2 2022-04-14 08:15:14 +00:00
ledc_types.h ledc: Provide support for esp32c2 and esp32h2 2022-04-14 08:15:14 +00:00
mcpwm_hal.h mcpwm: refactor driver 2021-06-09 12:27:01 +08:00
mcpwm_types.h mcpwm: update hal and soc naming 2021-07-26 22:32:45 +08:00
memprot_types.h System/Security: Memprot API unified (ESP32C3) 2021-12-21 01:50:36 +01:00
mmu_hal.h cache/mmu: implememnt cache and mmu hal APIs in bootloader 2022-03-11 22:43:11 +08:00
mmu_types.h flash mmap: abstract R/W MMU table instead of reg access 2022-05-20 16:46:27 +08:00
mpu_hal.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
mpu_types.h hal: explicitly include soc_caps.h 2021-01-07 10:13:17 +08:00
pcnt_hal.h pulse_cnt: new driver for PCNT peripheral 2022-03-03 22:38:32 +08:00
pcnt_types.h pulse_cnt: new driver for PCNT peripheral 2022-03-03 22:38:32 +08:00
readme.md hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
rmt_hal.h driver_ng: implement new rmt driver 2022-05-07 10:34:50 +00:00
rmt_types.h driver_ng: implement new rmt driver 2022-05-07 10:34:50 +00:00
rtc_hal.h esp_hw_‎support/sleep: ‎fix cannot lightsleep again after a wakeup from ULP 2022-05-12 17:57:08 +08:00
rtc_io_hal.h esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
rtc_io_types.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdio_slave_hal.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdio_slave_ll.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sdio_slave_types.h soc: don't expose unstable soc header files in public api 2022-01-06 23:10:22 +08:00
sha_hal.h AES/SHA: use GDMA driver instead of LL 2021-01-19 11:02:51 +08:00
sha_types.h esp8684: rename target to esp32c2 2022-01-19 11:08:57 +08:00
sigmadelta_hal.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
sigmadelta_types.h soc: don't expose unstable soc header files in public api 2022-01-06 23:10:22 +08:00
soc_hal.h [freertos] Silence sign-conversion warning 2021-01-14 10:54:15 +11:00
spi_flash_encrypt_hal.h spi_flash: refactoring flash encryption into new api 2021-04-25 17:09:25 +08:00
spi_flash_hal.h spi_flash: refactor the spi_flash clock configuration, and add support for esp32c2 2022-04-26 15:22:37 +08:00
spi_flash_types.h spi_flash: refactor the spi_flash clock configuration, and add support for esp32c2 2022-04-26 15:22:37 +08:00
spi_hal.h spi: support spi on 8684 2022-01-12 11:30:29 +08:00
spi_slave_hal.h spi: remove HSPI macro on esp32c3 and esp32s3 2021-04-06 13:42:49 +08:00
spi_slave_hd_hal.h spi_slv_hd: add hal_trans_finish comments for clarifying risk 2021-02-24 12:01:31 +08:00
spi_types.h spi: support spi on 8684 2022-01-12 11:30:29 +08:00
systimer_hal.h systimer: strip hal driver 2021-04-22 21:08:39 +08:00
systimer_types.h systimer: update soc data 2021-04-22 21:07:35 +08:00
temperature_sensor_types.h clk_tree: prework of introducing clk subsystem control 2022-04-11 12:09:06 +08:00
timer_hal.h gptimer: clean up hal and ll for driver-ng 2021-10-20 18:40:08 +08:00
timer_types.h clk_tree: added default clock source for peripheral 2022-04-14 15:44:56 +08:00
touch_sensor_hal.h Whitespace: Automated whitespace fixes (large commit) 2020-11-11 07:36:35 +00:00
touch_sensor_types.h soc: don't expose unstable soc header files in public api 2022-01-06 23:10:22 +08:00
twai_hal.h twai: Fix twai_ll_parse_frame_buffer() typo 2022-04-22 15:25:39 +08:00
twai_types.h TWAI: Fix incorrect configuration initializers for low speed bit rates 2021-07-19 14:27:39 +08:00
uart_hal.h uart: Provide support for esp32c2 and esp32h2 2022-03-02 11:29:13 +08:00
uart_types.h driver: remove deprecated code 2022-05-19 11:31:53 +08:00
uhci_types.h examples: added support of ESP32-S3 chip in controller_hci_uart example 2021-08-26 14:24:32 +08:00
usb_hal.h hal: extract hal component from soc component 2020-09-01 13:25:32 +08:00
usb_phy_hal.h usb: Add usb_phy driver to support operations on USB PHY 2021-09-13 12:39:56 +08:00
usb_phy_types.h usb: Add usb_phy driver to support operations on USB PHY 2021-09-13 12:39:56 +08:00
usb_types_private.h Add USB Host Library 2021-08-24 23:28:00 +08:00
usbh_hal.h usb: Hub Driver Update and Refactor 2022-01-06 15:11:13 +08:00
usbh_ll.h usb: USB Host stack uses USB PHY driver 2022-01-06 15:09:39 +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
xt_wdt_hal.h WDT: Add support for XTAL32K Watchdog timer 2021-09-02 09:09:00 +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.