esp-idf/components/esp_hw_support
Jiang Jiang Jian 70f14cc8dd Merge branch 'bugfix/stop_tg_wdt_in_xpd_xtal_lightsleep_v5.2' into 'release/v5.2'
fix(esp_hw_support): stop tg wdt in xpd xtal lightsleep (v5.2)

See merge request espressif/esp-idf!31141
2024-06-05 19:24:12 +08:00
..
dma change(esp_hw_support): use new retention api to implement gdma retention 2024-04-22 12:49:33 +08:00
include Merge branch 'docs/fix_doxygen_1_9_8_failure_v5.2' into 'release/v5.2' 2024-06-04 16:50:42 +08:00
port change(esp_hw_support/sleep): improve esp32c3 systimer stall bug workaround 2024-06-04 21:30:28 +08:00
test_apps fix(gpio_etm): allow one GPIO binds to multiple ETM tasks 2024-04-24 16:01:34 +08:00
adc_share_hw_ctrl.c fix(tsens,adc): Fix issue that disable adc will make temperature sensor crash, 2024-02-21 11:58:26 +08:00
clk_ctrl_os.c fix: remove wno format in esp_hw_support component 2023-09-18 02:43:41 +00:00
CMakeLists.txt refactor(esp_hw_support): changed reserved interrupt functions to be now defined per SoC 2024-05-30 11:49:13 +08:00
cpu.c refactor(esp_hw_support): changed reserved interrupt functions to be now defined per SoC 2024-05-30 11:49:13 +08:00
esp_clk.c esp_hw_support: Fix invalid system time if s_esp_rtc_time_us & s_rtc_last_ticks were moved around 2023-06-08 21:59:21 +08:00
esp_clock_output.c feat(esp_hw_support): support one-to-many signal-gpio mapping output 2023-10-20 14:55:06 +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(ds): use RCC atomic block to enable/reset the DS peripheral 2023-10-11 14:59:04 +05:30
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): update hmac toggle method due to discrepency in ROM code 2024-03-26 13:22:22 +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): clear reserved interrupts that are not applicable for each target 2024-05-30 12:12:44 +08:00
Kconfig change(esp_hw_support/sleep): improve esp32c3 systimer stall bug workaround 2024-06-04 21:30:28 +08:00
linker.lf fix(esp_hw_support): fix lightsleep current leakage on usb-phy controlled pad 2023-11-16 17:18:43 +08:00
mac_addr.c feat(mac): Add a configuration to set custom MAC as base MAC 2023-12-07 14:14:55 +08:00
modem_clock.c fix(wifi): fix the issue where deinit ble in a coexist scenario causes the wifi mac tsf counter to stop 2024-05-21 16:48:48 +08:00
mspi_timing_by_mspi_delay.c spi_flash: fixed issue that enabling HPM-DC by default may cause app unable to restart 2023-10-24 10:38:08 +08:00
mspi_timing_by_mspi_delay.h mspi: refactor timing tuning driver to make it compatible with p4 2023-05-04 17:05:35 +08:00
mspi_timing_config.c mspi: refactor timing tuning driver to make it compatible with p4 2023-05-04 17:05:35 +08:00
mspi_timing_config.h mspi: refactor timing tuning driver to make it compatible with p4 2023-05-04 17:05:35 +08:00
mspi_timing_tuning.c change(cache): swap cache hal arg 'type' and 'level' 2023-09-22 14:19:41 +08:00
periph_ctrl.c change(hal): remove useless code from periph_ll_wifi_bt_module_enable_clk 2023-11-14 19:29:03 +08:00
README.md doc: add api reference for etm driver 2022-11-23 15:32:34 +08: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(freertos): Added changes for multi-core RISC-V port for FreeRTOS 2023-08-22 15:35:15 +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-02-21 11:58:30 +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-27 15:35:00 +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-27 15:35:00 +08:00
sleep_clock.c fix(wifi): fixed the issue of tg0 watchdog reset caused by wifi module retention 2024-05-29 20:48:49 +08:00
sleep_console.c fix(esp_hw_support): fix lightsleep current leakage on usb-phy controlled pad 2023-11-16 17:18:43 +08:00
sleep_cpu_asm.S feat(PowerManagement/lightsleep): Define and export a strong symbol of rv_core_critical_regs_restore 2023-09-20 21:49:57 +08:00
sleep_cpu.c change(esp_pm): improve POWER_DOWN_TAGMEM_IN_LIGHT_SLEEP description 2023-11-16 02:55:06 +00:00
sleep_event.c change(pm): Change sleep callback implement 2023-10-23 08:13:47 +00:00
sleep_gpio.c feat(pm/deepsleep): Support EXT1 wakeup for esp32h2 deep_sleep 2023-07-20 11:43:57 +08:00
sleep_modem.c change(esp_hw_support): modify system and modem clock to support modem domain power down 2024-04-19 14:08:15 +08:00
sleep_modes.c fix(esp_hw_support/sleep): stop TG0/TG1 watchdog if XTAL not power down in lightsleep 2024-06-04 21:30:28 +08:00
sleep_retention.c fix: modify some typos to ensure CI pipeline run pass 2024-04-22 12:49:34 +08:00
sleep_system_peripheral.c change(esp_hw_support): use power down peripheral in light sleep option to determine TOP to off 2024-04-22 12:49:34 +08:00
sleep_wake_stub.c esp32h4: remove esp32h4 target from peripherals 2023-04-20 15:19:45 +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 {
    }