esp-idf/components/esp_hw_support
morris 4ee4158a8f Merge branch 'bugfix/async_memcpy_dst_align_check' into 'master'
fix(async_memcpy): destination alignment check against cache line size

Closes IDF-7494

See merge request espressif/esp-idf!25359
2023-08-16 12:57:19 +08:00
..
dma fix(async_memcpy): destination alignment check against cache line size 2023-08-15 17:40:17 +08:00
include docs(esp32p4): added building docs for ESP32-P4 2023-08-16 10:13:47 +08:00
port docs(esp32p4): added building docs for ESP32-P4 2023-08-16 10:13:47 +08:00
test_apps fix(async_memcpy): destination alignment check against cache line size 2023-08-15 17:40:17 +08:00
.build-test-rules.yml refactor(esp_hw_support): Move rtc_8md256 and rtc_power_modes test apps to esp_hw_support 2023-08-09 14:57:57 +08:00
adc_share_hw_ctrl.c change(header): modify p4 headers issues from check_header_py 2023-08-04 14:13:59 +02:00
clk_ctrl_os.c esp_clk_tree: Rename clk_tree_xxx to esp_clk_tree_xxx, add compilation warning to clk_tree.h 2023-04-25 14:12:06 +08:00
CMakeLists.txt feat(esp32p4): introduced new target esp32p4, supported hello_world 2023-08-09 19:33:25 +08:00
cpu.c feat(spinlock): added spinlock base support on p4 2023-07-25 05:59:10 +00: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_dpa_protection.c crypto: add support for DPA protection configuration in C6/H2 2023-06-08 11:09:23 +05:30
esp_ds.c esp32h4: remove esp32h4 target from peripherals 2023-04-20 15:19:45 +08:00
esp_etm.c driver: minor code clean up to pass coverity scan test 2023-06-10 16:21:12 +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 esp_hw_support: Update memory ptr location/property checks 2023-04-17 10:42:04 +05:30
hw_random.c bugfix: remove the workaround implemented in MR 22773 about the lp_timer 2023-06-26 21:05:16 +08:00
intr_alloc.c feat(system): add an error log and a hint on failed interrupt alloc 2023-07-19 16:47:41 +02:00
Kconfig feat(openthread): add sleep debug message 2023-07-31 17:01:37 +08:00
linker.lf refactor(sar): build sar_periph_ctrl related files by chip 2023-08-09 19:33:36 +08:00
lp_periph_ctrl.c uart: Support LP_UART port with UART driver on esp32c6 2023-06-16 07:31:40 +00:00
mac_addr.c mac_addr(C6 and H2): Fix byte order of MAC_EXT and change format of IEEE802154 MAC 2023-06-08 23:11:32 +08:00
modem_clock.c fix(esp_hw_support): manage i2c_ana_mst clock witch modem clock driver 2023-08-04 10:39:43 +08:00
mspi_timing_by_mspi_delay.c mspi: added timing tuning start, and success log 2023-06-12 11:44:24 +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 mspi: refactor timing tuning driver to make it compatible with p4 2023-05-04 17:05:35 +08:00
periph_ctrl.c feat(esp32p4): introduced new target esp32p4, supported hello_world 2023-08-09 19:33:25 +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 change(esp32p4): update rtc interrupt registration todo list 2023-08-09 19:33:36 +08:00
rtc_wdt.c esp_hw_support: Removes efuse dependency 2022-11-25 19:27:33 +08:00
sar_periph_ctrl_common.c temperature_sensor: Add new interface and reference counts so that phy and driver can use together 2023-05-17 17:40:59 +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 fix(esp_pm): fix PM_SLP_IRAM_OPT/PM_RTOS_IDLE_OPT feature 2023-07-14 21:21:19 +08:00
sleep_cpu_asm.S Power Management: support CPU powered down in light sleep for esp32h2 2023-06-26 20:57:55 +08:00
sleep_cpu.c fix: wait spi bus idle before hold CS pin 2023-07-14 20:12:59 +08: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 fix(esp_pm): fix PM_SLP_IRAM_OPT/PM_RTOS_IDLE_OPT feature 2023-07-14 21:21:19 +08:00
sleep_modes.c feat(pm/deepsleep): Support EXT1_WAKEUP_MODE_PER_PIN 2023-08-09 19:46:25 +08:00
sleep_retention.c ble : remove extra retention cnt upon deinit temporarily 2023-07-14 10:49:17 +08:00
sleep_system_peripheral.c fix(esp_pm): fix PM_SLP_IRAM_OPT/PM_RTOS_IDLE_OPT feature 2023-07-14 21:21:19 +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 {
    }