esp-idf/components/esp_hw_support
Armando (Dou Yiwen) 30a535db18 Merge branch 'refactor/move_mspi_timing_tuning_to_esp_hw_support' into 'master'
mspi: move timing tuning to esp_hw_support

Closes IDF-6470

See merge request espressif/esp-idf!21912
2023-01-06 18:47:07 +08:00
..
dma etm: update etm event task new API 2022-12-07 15:43:20 +08:00
host_test/host_test_linux linux target: add support for building esp_hw_support, soc and hal components for linux target 2022-12-09 13:59:39 +08:00
include mspi: move timing tuning to esp_hw_support 2023-01-06 14:41:20 +08:00
port mspi: move timing tuning to esp_hw_support 2023-01-06 14:41:20 +08:00
test_apps esp-hw-support: fix interrupt allocation tests on esp32c2 2023-01-02 08:30:20 +01:00
.build-test-rules.yml linux target: add support for building esp_hw_support, soc and hal components for linux target 2022-12-09 13:59:39 +08:00
adc_share_hw_ctrl.c adc: esp32s2: fix unit to offset calculation 2022-09-06 20:35:39 +08:00
clk_ctrl_os.c ledc: Add basic support for esp32c6 2022-12-07 18:40:50 +08:00
CMakeLists.txt mspi: move timing tuning to esp_hw_support 2023-01-06 14:41:20 +08:00
cpu.c esp_hw_support: allow writing in IRAM when CONFIG_ESP_SYSTEM_PMP_IDRAM_SPLIT is not set for esp32C2 2023-01-02 08:41:16 +01:00
esp_clk.c clk_tree: Add basic clock support for esp32c6 2022-12-13 19:18:34 +08:00
esp_ds.c esp_hw_support: Merge esp_ds.c file for different targets into one 2022-11-24 16:03:30 +05:30
esp_etm.c etm: added etm channel allocator 2022-11-23 15:31:33 +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 intr_alloc: fixed freed interrupt sources not being able to be allocated again with different flags 2022-11-04 06:39:00 +00:00
Kconfig esp_hw_support(esp32): If the MAC_FACTORY CRC check fails, then esp_efuse_mac_get_default returns INVALID_CRC instead of abort 2022-12-29 05:23:18 +08:00
linker.lf mspi: move timing tuning to esp_hw_support 2023-01-06 14:41:20 +08:00
mac_addr.c esp_hw_support(esp32): If the MAC_FACTORY CRC check fails, then esp_efuse_mac_get_default returns INVALID_CRC instead of abort 2022-12-29 05:23:18 +08:00
modem_clock.c modem clock(driver): implemented the modem clock driver for esp32c6 2022-12-27 21:31:59 +08:00
mspi_timing_tuning.c mspi: move timing tuning to esp_hw_support 2023-01-06 14:41:20 +08:00
periph_ctrl.c soc: add ieee8020154_only cap for esp32hx 2022-12-28 16:15:58 +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_gpio.c ESP32H2: Introduce new chip target esp32h2, hello_world example supported 2022-12-29 12:29:14 +08:00
sleep_mac_bb.c light sleep: separate sleep wifi/bt mac bb function 2021-08-23 10:25:04 +08:00
sleep_modes.c CI: fix fast template app due to function unused. 2022-12-30 15:25:12 +08:00
sleep_retention.c bugfix: malloc retention buffer with MALLOC_CAP_RETENTION caps 2022-08-03 20:07:43 +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 {
    }