OVMS3-idf/components/soc/include/hal
Angus Gratton a9854f7085 Merge branch 'feature/rmt_clock_support_ref_tick' into 'master'
rmt: support ref tick && refactor unit test && re-enable unit test on ESP32-S2

Closes IDFGH-1715

See merge request espressif/esp-idf!7614
2020-03-06 15:03:52 +08:00
..
adc_hal.h bugfix(i2s): fix adc output invert issue 2020-02-17 17:15:01 +08:00
adc_types.h refactor the adc driver 2019-11-22 15:42:16 +08:00
brownout_hal.h esp32, esp32s2beta: move brownout.c to esp_common 2020-01-23 13:44:19 +01:00
can_hal.h can: Refactor CAN to use HAL and LowLevel layers 2020-01-09 16:13:51 +08:00
can_types.h can: Refactor CAN to use HAL and LowLevel layers 2020-01-09 16:13:51 +08:00
cpu_hal.h soc: remove param checking in cpu related abstractions 2020-02-27 07:15:15 +05:00
cpu_types.h soc: create abstraction for cpu related operations 2020-02-27 07:14:19 +05:00
dac_hal.h dac: refactor driver add hal 2019-11-22 11:44:46 +08:00
dac_types.h global: rename esp32s2beta to esp32s2 2020-01-22 12:14:38 +08:00
esp_flash_err.h Fix error code collision and CI check 2019-08-29 08:14:08 +00:00
gpio_hal.h bugfix(gpio):fix esp32 s2 rtc io issue 2019-11-27 17:18:20 +08:00
gpio_types.h global: rename esp32s2beta to esp32s2 2020-01-22 12:14:38 +08:00
hal_defs.h mcpwm: add HAL layer support 2019-11-25 00:36:30 +08:00
i2c_hal.h bugfix(i2c): fix I2C driver breaking change issue. 2019-12-04 15:51:36 +08:00
i2c_types.h docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
i2s_hal.h bugfix(i2s): Updated ESP32-S2 ADC DAC support 2020-03-03 12:59:30 +08:00
i2s_types.h bugfix(i2s): Updated ESP32-S2 ADC DAC support 2020-03-03 12:59:30 +08:00
ledc_hal.h feat(ledc): refactor ledc driver 2019-11-21 16:25:22 +08:00
ledc_types.h Merge branch 'bugfix/ledc_driver_enums' into 'master' 2020-01-10 15:34:43 +08:00
mcpwm_hal.h mcpwm: add HAL layer support 2019-11-25 00:36:30 +08:00
mcpwm_types.h mcpwm: add HAL layer support 2019-11-25 00:36:30 +08:00
mpu_hal.h soc: remove param checking in cpu related abstractions 2020-02-27 07:15:15 +05:00
mpu_types.h soc: create abstraction for cpu related operations 2020-02-27 07:14:19 +05:00
pcnt_hal.h refactor(pcnt): add hal pcnt driver 2019-11-18 14:35:46 +08:00
pcnt_types.h bugfix(pcnt): fix driver ut pcnt 2020-02-26 16:52:53 +08:00
readme.md spi_slave: add HAL support 2019-05-20 07:34:34 +00:00
rmt_hal.h rmt: add HAL layer 2019-11-20 10:54:21 +08:00
rmt_types.h rmt: support REF_TICK as channel clock source 2020-03-03 20:14:46 +08:00
rtc_io_hal.h rtcio: add hal for driver 2019-11-21 10:40:49 +08:00
rtc_io_types.h rtcio: add hal for driver 2019-11-21 10:40:49 +08:00
sdio_slave_hal.h sdio_slave: support HAL layer 2019-12-13 18:33:15 +08:00
sdio_slave_ll.h sdio_slave: support HAL layer 2019-12-13 18:33:15 +08:00
sdio_slave_types.h sdio_slave: support HAL layer 2019-12-13 18:33:15 +08:00
sigmadelta_hal.h refactor(sigmadelta): add hal sigmadelta driver 2019-11-21 11:53:07 +08:00
sigmadelta_types.h refactor(sigmadelta): add hal sigmadelta driver 2019-11-21 11:53:07 +08:00
soc_hal.h soc: remove param checking in cpu related abstractions 2020-02-27 07:15:15 +05:00
spi_flash_hal.h ble_mesh_wifi_coexist example: Disable Wi-Fi RX IRAM optimisation 2019-11-28 09:20:00 +08:00
spi_flash_types.h soc: separate abstraction, description and implementation 2020-02-11 14:30:42 +05:00
spi_hal.h spi: multichip support 2019-06-22 19:08:47 +08:00
spi_slave_hal.h spi: multichip support 2019-06-22 19:08:47 +08:00
spi_types.h spi: support esp32s2 2020-01-26 17:24:12 +08:00
timer_hal.h bugfix(timer): add a macro to control making the XTAL related functions 2019-11-26 12:39:46 +00:00
timer_types.h bugfix(timer): add a macro to control making the XTAL related functions 2019-11-26 12:39:46 +00:00
touch_sensor_hal.h ci: solve public headers errors 2020-02-11 14:30:42 +05:00
touch_sensor_types.h docs: Resolve doxygen & Sphinx warnings 2020-02-07 16:37:45 +11:00
uart_hal.h add simplified API to set UART threshold values for RX FIFO full and TX FIFO empty 2019-12-16 20:26:04 +00:00
uart_types.h driver(uart): fix uart_set_line_inverse breaking change issue 2020-02-24 11:36:31 +08:00
usb_hal.h soc: add USB peripheral register definitions, hal level, reg map, etc 2020-02-10 08:33:39 +00: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.