morris 869bed1bb5 soc: don't expose unstable soc header files in public api 4 年 前
..
adc_hal.h 4dc0d6b2fe adc: support adc dma driver on all chips 4 年 前
adc_types.h 4dc0d6b2fe adc: support adc dma driver on all chips 4 年 前
aes_hal.h 51169b0e0c AES/SHA: use GDMA driver instead of LL 5 年 前
aes_types.h 457ce080ae AES: refactor and add HAL layer 5 年 前
brownout_hal.h 647dea9395 soc: combine xxx_caps.h into one soc_caps.h 5 年 前
cpu_hal.h bb9cd84cdc debug_stubs: Refactor and add support for RISCV 4 年 前
cpu_types.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
dac_hal.h 9afdf54748 hal: added HAL_ASSERT 4 年 前
dac_types.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
dma_types.h 83d16aa00c gdma: support IRAM interrupt 4 年 前
ds_hal.h f80d6f8c21 Digital Signature support for S3 4 年 前
emac_hal.h 1150a11c56 Fixed ESP32 EMAC driver `insufficient TX buffer size` which could followed esp_eth_stop and esp_eth_start sequence 4 年 前
esp_flash_err.h 5425ef4ee4 hal: extract hal component from soc component 5 年 前
eth_types.h 3a7a67f174 netif: added ESP-NETIF L2 TAP interface 4 年 前
gdma_hal.h 83d16aa00c gdma: support IRAM interrupt 4 年 前
gpio_hal.h 869bed1bb5 soc: don't expose unstable soc header files in public api 4 年 前
gpio_types.h 869bed1bb5 soc: don't expose unstable soc header files in public api 4 年 前
i2c_hal.h 2575c0d49f i2c: fix I2C slave clock source selection 4 年 前
i2c_types.h 82e4a2431a i2c: removed unsupported features on different targets 4 年 前
i2s_hal.h 7264c0e59a i2s_rec_example: add support for esp32s3 4 年 前
i2s_types.h 4f28b33bbc apll: add lock for apll 4 年 前
interrupt_controller_hal.h b23c9142d5 [hal]: cleaned up interrupt mask functions 4 年 前
interrupt_controller_types.h 5d316ac142 interrupt: added INTC FLEXIBLE capabillity to esp32c3 CPU caps 5 年 前
lcd_hal.h e09e39c94f lcd: unify callback prototype 4 年 前
lcd_types.h 89e37837d0 lcd: rgb pclk idle default to low 4 年 前
ledc_hal.h b2f390df01 hal: update link to HAL readme.md 5 年 前
ledc_types.h aa2ca7dd94 LEDC: improved support for ESP32-C3 and refactored divisor calculation 4 年 前
mcpwm_hal.h d4fe219c49 mcpwm: refactor driver 4 年 前
mcpwm_types.h 88c87bfe56 mcpwm: update hal and soc naming 4 年 前
memprot_types.h dd938eb952 System/Security: Memprot API unified (ESP32C3) 4 年 前
mpu_hal.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
mpu_types.h 58c3f6a421 hal: explicitly include soc_caps.h 5 年 前
pcnt_hal.h 56760c9669 pcnt: refactor hal driver 4 年 前
pcnt_types.h 56760c9669 pcnt: refactor hal driver 4 年 前
readme.md 5425ef4ee4 hal: extract hal component from soc component 5 年 前
rmt_hal.h 8cdcb4e291 rmt: move RMT item definition from soc to driver 4 年 前
rmt_types.h 8e483e34a8 rmt: restructure rmt_signal_conn_t 4 年 前
rtc_hal.h 869bed1bb5 soc: don't expose unstable soc header files in public api 4 年 前
rtc_io_hal.h 09487761cf ESP8684: add freertos, hal, esp_system support 4 年 前
rtc_io_types.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
sdio_slave_hal.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
sdio_slave_ll.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
sdio_slave_types.h 869bed1bb5 soc: don't expose unstable soc header files in public api 4 年 前
sha_hal.h 51169b0e0c AES/SHA: use GDMA driver instead of LL 5 年 前
sha_types.h 09487761cf ESP8684: add freertos, hal, esp_system support 4 年 前
sigmadelta_hal.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
sigmadelta_types.h 869bed1bb5 soc: don't expose unstable soc header files in public api 4 年 前
soc_hal.h ff2d9fd96c [freertos] Silence sign-conversion warning 5 年 前
spi_flash_encrypt_hal.h 0d81edb174 spi_flash: refactoring flash encryption into new api 4 年 前
spi_flash_hal.h 6c0aebe279 esp_flash: add opi flash support in esp_flash chip driver, for MXIC 4 年 前
spi_flash_types.h 6c0aebe279 esp_flash: add opi flash support in esp_flash chip driver, for MXIC 4 年 前
spi_hal.h 8143832041 spi_master:support octal mode for esp32s2 and esp32s3 4 年 前
spi_slave_hal.h 9b9ea71ff9 spi: remove HSPI macro on esp32c3 and esp32s3 4 年 前
spi_slave_hd_hal.h 346dea206e spi_slv_hd: add hal_trans_finish comments for clarifying risk 5 年 前
spi_types.h 7efb01846f [cxx]: simple spi master class 4 年 前
systimer_hal.h ec898b771e systimer: strip hal driver 4 年 前
systimer_types.h 7c1e1c9e2d systimer: update soc data 4 年 前
timer_hal.h e2275b1f63 gptimer: clean up hal and ll for driver-ng 4 年 前
timer_types.h 2c810f8451 timer: save alarm value in driver layer 4 年 前
touch_sensor_hal.h 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) 5 年 前
touch_sensor_types.h 869bed1bb5 soc: don't expose unstable soc header files in public api 4 年 前
twai_hal.h 2f58060921 TWAI: FIFO overrun handling and errata workarounds 4 年 前
twai_types.h d604bf05af TWAI: Fix incorrect configuration initializers for low speed bit rates 4 年 前
uart_hal.h 6317f5b481 add uart core reset in uart_module_enable() 4 年 前
uart_types.h fb8b905539 uart: add uart support on esp32s3 5 年 前
uhci_types.h c053ef0541 examples: added support of ESP32-S3 chip in controller_hci_uart example 4 年 前
usb_hal.h 5425ef4ee4 hal: extract hal component from soc component 5 年 前
usb_phy_hal.h 1fcd639224 usb: Add usb_phy driver to support operations on USB PHY 4 年 前
usb_phy_types.h 1fcd639224 usb: Add usb_phy driver to support operations on USB PHY 4 年 前
usb_types_private.h accbaee57c Add USB Host Library 4 年 前
usbh_hal.h 1aad12468a usb: Hub Driver Update and Refactor 4 年 前
usbh_ll.h 854127a57c usb: USB Host stack uses USB PHY driver 4 年 前
wdt_hal.h 647dea9395 soc: combine xxx_caps.h into one soc_caps.h 5 年 前
wdt_types.h 5425ef4ee4 hal: extract hal component from soc component 5 年 前
xt_wdt_hal.h 4869b3cd4a WDT: Add support for XTAL32K Watchdog timer 4 年 前

readme.md

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.