esp-idf/components/esp_hw_support
Wu Zheng Hui ee05082e35 Merge branch 'feature/support_esp32h2_modem_clock' into 'master'
esp32h2: support modem clock driver

Closes IDF-7088

See merge request espressif/esp-idf!22880
2023-03-29 16:49:26 +08:00
..
dma gdma: fix potential unaligned cache writeback issue 2023-02-28 10:42:22 +08:00
include Merge branch 'bugfix/memprot_cleanup_iram_attr' into 'master' 2023-03-28 10:18:22 +08:00
port Merge branch 'bugfix/memprot_cleanup_iram_attr' into 'master' 2023-03-28 10:18:22 +08:00
test_apps ci: update driver tests to use run_all_single_board_cases() 2023-03-28 17:05:50 +08:00
.build-test-rules.yml ci: move linux host tests to test app folder 2023-03-27 17:41:44 +08:00
adc_share_hw_ctrl.c adc: remove adc_hal_conf.h 2023-02-23 11:48:31 +08:00
clk_ctrl_os.c clk_tree: Add a general API to get the frequency of different clocks 2023-01-17 11:30:24 +08:00
CMakeLists.txt gpio: support runtime preserve 2023-03-17 11:59:49 +08:00
cpu.c esp_hw_support: Move cpu protection in port files 2023-03-09 11:37:29 +05:30
esp_clk.c clk_tree: Add basic clock support for esp32h2 2023-02-20 17:15:02 +08:00
esp_ds.c esp32h2: enable DS peripheral support in driver and test application 2023-02-13 10:27:15 +05:30
esp_etm.c etm: added etm channel allocator 2022-11-23 15:31:33 +08:00
esp_gpio_reserve.c gpio: support runtime preserve 2023-03-17 11:59:49 +08:00
esp_hmac.c Add esp_hmac.c file 2022-10-27 11:08:01 +05:30
esp_memory_utils.c mmu: driver framework, for vaddr maintenance 2022-08-26 17:59:06 +08:00
hw_random.c hal: Deprecate interrupt_controller_hal.h, cpu_hal.h and cpu_ll.h interfaces 2022-07-22 00:06:06 +08:00
intr_alloc.c esp32c2: support rtc time feature depend on rtc memory, since c2 does not have rtc memory 2023-02-02 20:25:59 +08:00
Kconfig rtc_sleep: workaround systimer stall issue during lightsleep on ESP32C3 2023-03-15 20:33:03 +08:00
linker.lf gpio: support runtime preserve 2023-03-17 11:59:49 +08:00
mac_addr.c efuse: fix esp_read_mac on esp32h2 2023-03-01 14:14:30 +08:00
modem_clock.c workaround: bypass clock power_domain maintaining since esp32h2 sleep is not supported 2023-03-29 13:23:32 +08:00
mspi_timing_config.h mspi: make mspi_timing_tuning.h available for all supported targets 2023-03-09 10:38:32 +00:00
mspi_timing_tuning.c mspi: make mspi_timing_tuning.h available for all supported targets 2023-03-09 10:38:32 +00:00
periph_ctrl.c esp_hw_support: Fix check for SOC_MODEM_CLOCK_IS_INDEPENDENT definition 2023-03-16 01:50:22 +08:00
README.md doc: add api reference for etm driver 2022-11-23 15:32:34 +08:00
regi2c_ctrl.c Add regi2c enable/disable reference count 2022-06-23 15:36:44 +08:00
rtc_module.c ESP32H2: Introduce new chip target esp32h2, hello_world example supported 2022-12-29 12:29:14 +08:00
rtc_wdt.c esp_hw_support: Removes efuse dependency 2022-11-25 19:27:33 +08:00
sdkconfig.rename kconfig: also parse target specific sdkconfig.rename.TARGET files 2022-01-31 11:36:08 +08:00
sdkconfig.rename.esp32 kconfig: refactor xtal freq kconfig to common configuration item 2022-08-05 19:12:29 +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 kconfig: move remaining kconfig options out of target component 2022-05-23 17:57:45 +08:00
sleep_clock.c modem clock: enable all clock enable of wifi module when PMU switch to ACTIVE from sleep state 2023-03-07 16:19:39 +08:00
sleep_cpu_asm.S cpu retention: software cpu retention support for esp32c6 2023-01-31 22:12:54 +08:00
sleep_cpu.c Power Management: refactor the configuration of each module in sleep mode 2023-03-04 00:17:40 +08:00
sleep_gpio.c esp32c6: bringup deepsleep examples 2023-03-02 15:06:05 +08:00
sleep_modem.c bugfix: set I2C_MST_SEL_160M always be 1 2023-03-17 19:45:56 +08:00
sleep_modes.c feature: add deep sleep prepare callback hook 2023-03-17 19:45:56 +08:00
sleep_retention.c bugfix: no need to do retention in deepsleep 2023-03-17 19:45:56 +08:00
sleep_system_peripheral.c bugfix: add SPI_MEM_MMU_POWER_CTRL_REG to REGDMA_SPIMEM_LINK 2023-03-06 13:41:36 +08:00
sleep_wake_stub.c bugfix: workaround for CPU stuck due to DBUS request blocking when fetching unaligned instructions in LP_RAM 2023-03-02 18:10:10 +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 {
    }