esp-idf/components/esp_hw_support
Wu Zheng Hui f3b95059f9 Merge branch 'bugfix/fix_sleep_cache_safe_assertion' into 'master'
fix(esp_hw_support): fix cache safe check function

See merge request espressif/esp-idf!29246
2024-02-28 10:50:52 +08:00
..
dma feat(dw_gdma): support change link list item connection 2024-02-27 17:49:04 +08:00
include feat(freertos): Introduced new Kconfig option CONFIG_FREERTOS_NUMBER_OF_CORES 2024-02-09 09:11:28 +01:00
ldo feat(esp_eth): Added support of internal EMAC for ESP32P4 2024-01-16 14:29:25 +01:00
port Merge branch 'c6_auto_dbias_master_hsq' into 'master' 2024-02-22 19:12:28 +08:00
test_apps fix(esp_hw_support): Fix esp_intr_free when taks has no core affinity 2024-02-21 14:54:32 +08:00
adc_share_hw_ctrl.c fix(tsens,adc): Fix issue that disable adc will make temperature sensor crash, 2024-01-05 12:10:30 +08:00
clk_ctrl_os.c feat(esp_eth): Added support of internal EMAC for ESP32P4 2024-01-16 14:29:25 +01:00
clkout_channel.h refactor(emac): use clock_output driver for configuring RMII reference clock 2023-10-31 14:24:48 +08:00
CMakeLists.txt feat(clk): preliminary clock tree support for ESP32C5 2024-02-07 14:38:15 +08:00
cpu.c fix(hw_support): fix esp32p4 cpu stall/unstall 2024-01-15 23:25:07 +08:00
esp_clk.c feat(clk): add basic clock support for esp32p4 2023-12-29 00:37:26 +08:00
esp_clock_output.c refactor(emac): use clock_output driver for configuring RMII reference clock 2023-10-31 14:24:48 +08:00
esp_dpa_protection.c crypto: add support for DPA protection configuration in C6/H2 2023-06-08 11:09:23 +05:30
esp_ds.c feat(esp32c5): add system related supports 2024-01-02 11:17:11 +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 gpio: support runtime preserve 2023-03-17 11:59:49 +08:00
esp_hmac.c fix(esp_hw_support): fix API esp_hmac_disable_jtag() to disable JTAG 2024-01-03 16:54:11 +08:00
esp_key_mgr.c fix(esp_hw_support): Update key manager support 2024-01-23 10:24:39 +05:30
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_timer): Support systimer for ESP32P4 2023-09-13 19:13:38 +08:00
intr_alloc.c fix(esp_hw_support): Fix esp_intr_free when taks has no core affinity 2024-02-21 14:54:32 +08:00
Kconfig fix(esp_hw_support): fix cache safe check function 2024-02-27 17:29:24 +08:00
linker.lf fix(system): fixed rtc_sleep not being placed in IRAM 2024-02-07 09:47:23 +08:00
mac_addr.c feat(mac): Add a configuration to set custom MAC as base MAC 2023-12-06 10:46:22 +08:00
mipi_csi_share_hw_ctrl.c feat(csi): added csi bridge share control code 2024-01-16 09:57:52 +08:00
modem_clock.c feat(esp32c5): support esp32c5 beta3 48M xtal 2024-01-09 13:11:11 +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 refactor(rtc): move soc/rtc.h from soc to esp_hw_support component 2024-01-25 19:15:33 +08:00
mspi_timing_by_mspi_delay.h feat(psram): support 200mhz psram, experimental feature for now 2024-01-10 11:52:28 +08:00
mspi_timing_tuning.c change(flash): rename spi_timing_is_tuned to spi_flash_timing_is_tuned 2024-01-10 11:52:28 +08:00
periph_ctrl.c change(hal): remove useless code from periph_ll_wifi_bt_module_enable_clk 2023-11-09 14:17:54 +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(esp32c5): add system related supports 2024-01-02 11:17:11 +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_clock.c change(esp_hw_support): collect retention link priority definition 2024-02-02 11:21:44 +08:00
sleep_console.c fix(esp_hw_support): fix lightsleep current leakage on usb-phy controlled pad 2023-11-11 13:00:55 +08:00
sleep_cpu_asm.S feat(esp32c5): add system related supports 2024-01-02 11:17:11 +08:00
sleep_cpu.c feat(esp32c5): add system related supports 2024-01-02 11:17:11 +08:00
sleep_event.c change(pm): Change sleep callback implement 2023-10-23 08:13:47 +00:00
sleep_gpio.c refactor(startup): implement registration of core init functions 2023-11-27 10:20:51 +01:00
sleep_modem.c refactor(esp_hw_support): move regdma structure defination to soc components 2024-01-23 11:51:44 +08:00
sleep_modes.c fix(esp_hw_support): fix cache safe check function 2024-02-27 17:29:24 +08:00
sleep_retention.c feat(pm): support PMU trigger regdma when PU TOP 2024-01-05 16:17:32 +08:00
sleep_system_peripheral.c change(esp_hw_support): collect retention link priority definition 2024-02-02 11:21:44 +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.