esp-idf/components/esp_hw_support
Wang Tao e43ded7ed5 Merge branch 'feat/support_esp32c2_eco4' into 'master'
feat(wifi):support esp32c2 chip version 2.0 wifi

Closes WIFI-6637、IDF-10216、WIFI-6669

See merge request espressif/esp-idf!32511
2024-09-04 16:28:25 +08:00
..
debug_probe feat(debug_probe): added debug probe hal driver 2024-07-29 15:23:18 +08:00
deprecated feat(gdma): set burst size and return alignment constraint 2024-05-24 22:43:55 +08:00
dma Merge branch 'feature/esp32c5mp_light_sleep_support_stage_2' into 'master' 2024-08-29 19:32:05 +08:00
include Merge branch 'bugfix/intr_alloc_rom_handler' into 'master' 2024-08-30 10:50:49 +08:00
ldo feat(ldo): add config to let hardware control the ldo output 2024-08-13 14:50:38 +08:00
lowpower refactor(esp_hw_support): refactor sleep clock, split it to support multiple targets 2024-08-28 10:44:08 +08:00
port Merge branch 'feat/support_esp32c2_eco4' into 'master' 2024-09-04 16:28:25 +08:00
test_apps ci(esp32c61): enable c61 generic target test 2024-09-02 19:26:12 +08:00
adc_share_hw_ctrl.c feat(adc): add ADC func clock enable function on C5,C6,H2 2024-07-13 14:06:57 +08:00
clk_ctrl_os.c feat(ldo): add config to let hardware control the ldo output 2024-08-13 14:50:38 +08:00
CMakeLists.txt refactor(esp_hw_support): refactor sleep clock, split it to support multiple targets 2024-08-28 10:44:08 +08:00
cpu.c feat(hal): Adds hal funcs for cpu.c 2024-04-11 13:07:04 +03:00
esp_clk.c feat(clk): Add basic clock support for esp32c5 mp 2024-06-26 14:26:34 +08:00
esp_clock_output.c fix(esp_hw_support): fix warnings found by GNU static analyzer 2024-06-18 14:25:37 +08:00
esp_etm.c feat(etm): add core driver support for esp32-p4 2023-08-23 15:11:56 +08:00
esp_gpio_reserve.c feat(gpio): reserve gpio output atomically 2024-03-09 10:33:58 +08:00
esp_memory_utils.c esp_hw_support: Update memory ptr location/property checks 2023-04-17 10:42:04 +05:30
hw_random.c feat(esp_hw_support): brought up RNG on ESP32-P4 2024-04-01 07:09:11 +05:30
intr_alloc.c fix(esp_hw_support): allow allocating interrupts with handlers in ROM with IRAM attribute 2024-08-29 14:21:43 +08:00
Kconfig feat(pm): support sleep_gpio for esp32c5 2024-08-28 10:44:08 +08:00
linker.lf Merge branch 'bugfix/fix_none_iram_code_before_xip_psram' into 'master' 2024-06-26 20:47:10 +08:00
mac_addr.c feat(esp_hw_support): Adds MAC support for esp32p4 2024-03-29 01:44:39 +08:00
mipi_csi_share_hw_ctrl.c feat(isp): added isp driver framework and isp af driver 2024-04-01 09:30:07 +08:00
modem_clock.c change(pm): remove rc32k for esp32c5 2024-08-28 10:44:09 +08:00
mspi_timing_by_dqs.c change(flash): rename spi_timing_is_tuned to spi_flash_timing_is_tuned 2024-01-10 11:52:28 +08:00
mspi_timing_by_dqs.h feat(psram): support 200mhz psram, experimental feature for now 2024-01-10 11:52:28 +08:00
mspi_timing_by_mspi_delay.c feat(spiram): Add temperature support for psram adjustment on esp32c5 2024-07-25 13:48:41 +08:00
mspi_timing_by_mspi_delay.h feat(spiram): Add temperature support for psram adjustment on esp32c5 2024-07-25 13:48:41 +08:00
mspi_timing_tuning.c fix(pm): mspi cannot access flash when pd pll source 2024-08-28 10:44:08 +08:00
periph_ctrl.c feat(pm): support modem clock for esp32c61 2024-08-13 11:03:21 +08:00
README.md feat(dw_gdma): channel allocator driver 2023-12-12 03:35:05 +00:00
regi2c_ctrl.c fix(regi2c): wrong ADC_CALI_PD_WORKAROUND on c6, h2 2023-07-06 17:54:31 +08:00
revision.c soc: Move revision MAX/MIN static assert to esp_hw_support 2023-07-13 12:37:35 +02:00
rtc_module.c feat(ulp): remove ulp related C61 code 2024-08-27 17:23:19 +08:00
rtc_wdt.c fix(wdt): move non-auto generated wdt values to ll 2023-09-05 11:52:34 +08:00
sar_periph_ctrl_common.c fix(tsens): 300us delay in phy cause extra power consumption 2024-01-10 09:46:02 +08:00
sdkconfig.rename kconfig: also parse target specific sdkconfig.rename.TARGET files 2022-01-31 11:36:08 +08:00
sdkconfig.rename.esp32 change(esp_hw_support/sleep): rename ESP_SLEEP_DEEP_SLEEP_WAKEUP_DELAY 2023-12-18 19:56:56 +08:00
sdkconfig.rename.esp32c3 soc: moved kconfig options out of the target component. 2022-04-21 12:09:43 +08:00
sdkconfig.rename.esp32s2 kconfig: move remaining kconfig options out of target component 2022-05-23 17:57:45 +08:00
sdkconfig.rename.esp32s3 change(esp_hw_support/sleep): rename ESP_SLEEP_DEEP_SLEEP_WAKEUP_DELAY 2023-12-18 19:56:56 +08:00
sleep_console.c refactor(hal/usj): Add USB PHY related functions to USJ LL 2024-03-18 19:23:42 +08:00
sleep_event.c change(pm): Change sleep callback implement 2023-10-23 08:13:47 +00:00
sleep_gpio.c fix(esp_hw_support): fix mmu memory powered down issue by software backup and restore mmu table content 2024-08-28 10:44:08 +08:00
sleep_modem.c change(esp_hw_support): modify system and modem clock to support modem domain power down 2024-03-29 16:13:52 +08:00
sleep_modes.c fix(mspi): collect mspi iomux pin macro from iomux_reg.h to spi_pins.h 2024-09-03 13:55:00 +08:00
sleep_retention.c fix(esp_hw_support): fix the issue of regdma wait node to immediately return to done caused by regdma wait mode comparator 2024-08-28 10:44:08 +08:00
sleep_system_peripheral.c feat(esp_hw_support): support top domain powered down during sleep for esp32c5 2024-08-28 10:44:08 +08:00
sleep_wake_stub.c refactor(rtc): move soc/rtc.h from soc to esp_hw_support component 2024-01-25 19:15:33 +08:00
spi_bus_lock.c refactor(spi): moved spi hw sharing func to hw support 2023-11-20 12:07:54 +08:00
spi_share_hw_ctrl.c refactor(spi): moved spi hw sharing func to hw support 2023-11-20 12:07:54 +08:00

esp_hw_support (G1 component)

This component contains hardware-related operations for supporting the system. These operations are one level above that of hal in that:

  1. it uses system services such as memory allocation, logging, scheduling
  2. it may be multi-step operations involving/affecting multiple parts of the SoC
  3. it offers a service for other components vary from multiple layers (G1, G2 and G3) of ESP-IDF

Implementations that don't fit other components cleanly, but are not worth creating a new component for (yet) may also be placed here as long as they don't pull dependencies other than the core system components.

Event-Task Service (esp_etm)

esp_etm driver design

esp_etm driver is divided into two parts:

  • The core driver, which focuses on ETM channel allocation and offers APIs to connect the channel with ETM tasks and ETM events that come from other peripherals.
  • Peripheral side extensions, e.g. GPTimer support generating different kinds of ETM events, and accept multiple ETM tasks. These extensions are implemented in the peripheral driver, and can be located in different components. Usually, the task and event extensions will simply inherit the interface that defined in the core driver.

See the following class diagram, we take the GPIO and GPTimer as the example to illustrate the architecture of esp_etm driver.

classDiagram
    esp_etm_channel_t "1" --> "1" esp_etm_event_t : Has
    esp_etm_channel_t "1" --> "1" esp_etm_task_t : Has
    class esp_etm_channel_t {
        -int chan_id
        -esp_etm_event_t event
        -esp_etm_task_t task
        +enable() esp_err_t
        +disable() esp_err_t
        +connect(event, task) esp_err_t
        +dump() esp_err_t
    }

    class esp_etm_event_t {
        <<interface>>
        #int event_id
        #etm_trigger_peripheral_t trig_periph
        #del() esp_err_t
    }

    class esp_etm_task_t {
        <<interface>>
        #int task_id
        #etm_trigger_peripheral_t trig_periph
        #del() esp_err_t
    }

    gpio_etm_event_t --|> esp_etm_event_t : Inheritance
    class gpio_etm_event_t {
        -int chan_id
        +bind_gpio(gpio_num_t gpio) esp_err_t
    }

    gpio_etm_task_t --|> esp_etm_task_t : Inheritance
    class gpio_etm_task_t {
        -int chan_id
        +add_gpio(gpio_num) esp_err_t
        +rm_gpio(gpio_num) esp_err_t
    }

    gptimer_t "1" --> "1..*" gptimer_etm_event_t : Has
    gptimer_t "1" --> "1..*" gptimer_etm_task_t : Has
    class gptimer_t {
        -gptimer_etm_event_t[] events
        -gptimer_etm_task_t[] tasks
    }

    gptimer_etm_event_t --|> esp_etm_event_t : Inheritance
    class gptimer_etm_event_t {
    }

    gptimer_etm_task_t --|> esp_etm_task_t : Inheritance
    class gptimer_etm_task_t {
    }

DMA Service

With the increasing demand, the hardware design of DMA is changing along the way. At first, each peripheral has a dedicated DMA controller. Later, a centralized DMA controller is introduced, which is called GDMA in the software.

There may be multiple GDMA instances on a chip, some is attached to the AHB bus and some is attached to the AXI bus. But their functionalities are almost the same.

Some high-performance peripherals, such as MIPI, require DMA to provide more functions, such as hardware handshake mechanism, address growth mode, out-of-order transmission and so on. Therefore, a new DMA controller, called DW_GDMA was born. The prefix DW is taken from DesignWare.

Please note that the specific DMA controller to be used for peripherals is determined by the specific chip. It is possible that, on chip A, SPI works with AHB GDMA, while on chip B, SPI works with AXI GDMA.