mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00

History

Chen Jichang c240a1f46b feat(MCPWM): Add mcpwm carrier clk source The MCPWM carrier is part of the operator and can work independently without the MCPWM timer being enabled. This commit add the MCPWM carrier clk source.		2023-08-25 17:34:58 +08:00
..
adc_hal_common.h	esp_adc: new esp_adc component and adc drivers	2022-07-15 18:31:00 +08:00
adc_hal.h	adc: port gh pr to current adc continuous mode driver	2023-07-12 16:41:24 +08:00
adc_oneshot_hal.h	esp_adc: support selecting clock source for oneshot driver	2023-02-23 11:48:31 +08:00
adc_types_private.h	esp32h4: remove esp32h4 target from peripherals	2023-04-26 18:53:10 +08:00
adc_types.h	esp32h4: remove esp32h4 target from peripherals	2023-04-26 18:53:10 +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
apm_hal.h	apm: added support for APM on esp32c6	2023-02-10 08:18:07 +00:00
apm_types.h	apm: added support for APM on esp32c6	2023-02-10 08:18:07 +00:00
brownout_hal.h	BOD: Bringup for ESP32C6	2023-01-10 10:37:30 +08:00
cache_hal.h	cache: refactor cache_utils into cache_hal instade	2023-07-31 14:52:03 +08:00
cache_types.h	cache/mmu: implememnt cache and mmu hal APIs in bootloader	2022-03-11 22:43:11 +08:00
clk_tree_hal.h	clk_tree: Add a general API to get the frequency of different clocks	2023-01-17 11:30:24 +08:00
dac_types.h	dac: optimize the dma stratege	2022-10-25 17:14:59 +08:00
dma_types.h	adc: fix adc continuous driver conv_frame_size not bigger than 4092 issue	2023-07-12 16:41:11 +08:00
ds_hal.h	Digital Signature support for S3	2021-09-02 11:59:24 +05:30
ecc_hal.h	esp32h2: Add support for ECC hardware accelerator	2023-03-13 16:39:46 +05:30
ecc_types.h	esp32h2: Add support for ECC hardware accelerator	2023-03-13 16:39:46 +05:30
ecdsa_hal.h	ecdsa: Support multiple ECDSA keys	2023-04-30 11:47:35 +05:30
ecdsa_types.h	esp32h2: Add support for ECDSA peripheral	2023-03-24 10:43:40 +05:30
efuse_hal.h	adc_cali: supported channel compensation of adc calibration on esp32c6	2023-07-05 12:48:11 +08:00
emac_hal.h	Merge branch 'feature/emac_buff' into 'master'	2022-11-24 00:48:19 +08: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
etm_hal.h	etm: added etm channel allocator	2022-11-23 15:31:33 +08:00
gdma_hal.h	gdma: support IRAM interrupt	2021-11-08 16:14:51 +08:00
gdma_types.h	driver: add parallel IO TX driver	2023-03-01 00:43:14 +00:00
glitch_filter_types.h	glitch_filter: support derive clock source form IO MUX	2022-12-29 14:46:16 +08:00
gpio_hal.h	gpio: Fix io hold functionality on esp32c6 and esp32h2	2023-03-02 18:10:10 +08:00
gpio_types.h	esp32h4: remove esp32h4 target from peripherals	2023-04-26 18:53:10 +08:00
hmac_hal.h	hmac_hal: Merge hmac hal layer for different into one	2022-11-24 16:04:26 +05:30
i2c_hal.h	I2C: Add i2c support for ESP32C6	2022-11-07 14:12:53 +08:00
i2c_types.h	lp-i2c: Added support for LP I2C peripheral to LP core	2023-05-19 07:33:01 +02:00
i2s_hal.h	i2s: fixed i2s_ll compiling failure under C++ evironment	2023-06-26 15:42:36 +08:00
i2s_types.h	i2s: support 4 line pdm rx on esp32s3	2022-11-04 15:46:34 +08:00
ieee802154_common_ll.h	ieee802154: support driver opensrc	2023-04-27 11:27:57 +08:00
lcd_hal.h	rgb_lcd: workaround pclk polarity bug by setting mo>=2	2022-07-21 13:06:09 +00:00
lcd_types.h	rgb_lcd: support yuv converter	2022-08-17 06:33:06 +00:00
ledc_hal.h	ledc: Support gamma curve fade feature on esp32c6 and esp32h2	2023-03-10 12:42:46 +08:00
ledc_types.h	ledc: Add support for esp32h2; Refactor ledc driver clock source selection related code	2023-01-30 19:19:34 +08:00
lp_timer_hal.h	Power Management: move lp_timer_hal.c to upper hal layer for esp32h2 and esp32c6	2023-07-11 14:52:46 +08:00
lp_timer_types.h	lp_timer: add hal-layer codes for esp32c6	2023-01-31 22:12:27 +08:00
mcpwm_hal.h	mcpwm: clean up hal driver and add doc	2022-06-02 15:01:18 +08:00
mcpwm_types.h	feat(MCPWM): Add mcpwm carrier clk source	2023-08-25 17:34:58 +08:00
memprot_types.h	Clean IRAM and DRAM address space conversion macros	2022-07-29 17:07:39 +08:00
mmu_hal.h	mmu: hal function to init, and hal function to unmap all	2023-03-15 10:59:20 +08:00
mmu_types.h	mmu: mmu_hal_check_valid_ext_vaddr_region	2023-02-17 13:04:55 +08:00
modem_clock_hal.h	modem clock: provide a protected wifipwr clock enable/disable interface to fix the bug of selecting xtal as the low power clock source for ble	2023-07-14 11:07:34 +08:00
modem_clock_types.h	modem clock(driver): implemented the modem clock driver for esp32c6	2022-12-27 21:31:59 +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
parlio_hal.h	driver: add parallel IO TX driver	2023-03-01 00:43:14 +00:00
parlio_types.h	driver: add parallel IO TX driver	2023-03-01 00:43:14 +00:00
pau_hal.h	Power Management: fix REGDMA clock issue when wake up form light sleep	2023-07-11 12:03:59 +08:00
pau_types.h	pau: implement the pau regdma driver for esp32c6	2023-02-15 10:45:44 +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
pmu_types.h	Power Management: support pu xtal in light sleep for esp32h2	2023-07-11 14:53:15 +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	rmt: use gpio_num_t to define gpio number	2023-03-30 10:30:27 +08:00
rtc_hal.h	esp32c6: bringup deepsleep examples	2023-03-02 15:06:05 +08:00
rtc_io_hal.h	change(driver/rtcio): Describe RTCIO CAPS with more accurate note	2023-08-03 16:46:55 +08:00
rtc_io_types.h	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
sdio_slave_hal.h	sdio: c6 support	2023-01-18 02:34:46 +00:00
sdio_slave_types.h	sdio_slave: allow disabling highspeed mode	2022-09-27 18:38:35 +08:00
sdm_hal.h	sdm: clean up soc/hal/ll code	2022-07-20 14:59:50 +08:00
sdm_types.h	sdm: clean up soc/hal/ll code	2022-07-20 14:59:50 +08:00
sha_hal.h	AES/SHA: use GDMA driver instead of LL	2021-01-19 11:02:51 +08:00
sha_types.h	esp32h4: remove esp32h4 target from peripherals	2023-04-26 18:53:10 +08: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	C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT	2022-11-21 16:18:08 +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_master: add feature spi periph clk source selectable	2023-01-18 15:40:12 +08:00
spi_slave_hal.h	spi: limit esp32 dma workaround only on esp32	2022-11-14 16:01:48 +08:00
spi_slave_hd_hal.h	spi_slave: support spi slave hd append mode on chips other than s2	2023-03-21 11:30:17 +08:00
spi_types.h	spi_master: add feature spi periph clk source selectable	2023-01-18 15:40:12 +08:00
systimer_hal.h	hal: Adds hal/ll func for SYSTIMER to select clock source: XTAL or RC_FAST_CLK	2022-11-22 20:29:19 +08:00
systimer_types.h	C/Cxx: unify static assertions with the macro ESP_STATIC_ASSERT	2022-11-21 16:18:08 +08:00
temperature_sensor_types.h	sdm: clean up soc/hal/ll code	2022-07-20 14:59:50 +08:00
timer_hal.h	gptimer: bringup driver on esp32c6	2022-09-13 10:50:58 +08:00
timer_types.h	gptimer: support etm event and task	2022-11-23 15:31:33 +08:00
touch_sensor_hal.h	rtc_clk: Clean up some clock related enum and macro in soc/rtc.h, replace with new ones in	2022-05-24 22:59:41 +08: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: bringup on esp32c6	2022-11-04 17:40:29 +08:00
twai_types.h	Fix initialization macros for twai_timing_config_t not setting .clk_src and .brp	2023-06-07 01:45:26 +00:00
uart_hal.h	uart: Fix two TX concurrency issues	2023-02-08 14:24:43 +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_dwc_hal.h	usb_host: Rename struct/ll/hal symbols to use "usb_dwc" prefix	2022-09-16 16:45:26 +08:00
usb_dwc_ll.h	usb_host: Rename struct/ll/hal symbols to use "usb_dwc" prefix	2022-09-16 16:45:26 +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
wdt_hal.h	wdt: refactor wdt codes to use unified type	2023-02-15 12:08:55 +08:00
wdt_types.h	wdt: add support for WDTs on C6	2023-01-19 12:58:26 +08:00
xt_wdt_hal.h	WDT: Add support for XTAL32K Watchdog timer	2021-09-02 09:09:00 +08:00

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.