esp-idf/components/esp_hw_support
Jakob Hasse 006e675656 Merge branch 'bugfix/extern_c_decl' into 'master'
esp_hw_support: Added extern "C" declaration

Closes IDF-2860

See merge request espressif/esp-idf!24217
2023-06-14 23:23:37 +08:00
..
dma gdma: support on_recv_done callback 2023-06-07 11:38:32 +08:00
include Merge branch 'bugfix/extern_c_decl' into 'master' 2023-06-14 23:23:37 +08:00
port Merge branch 'feat/kconfig_c3_v1.0_dev' into 'master' 2023-06-14 15:03:50 +08:00
test_apps Merge branch 'refactor/mspi_timing_tuning_compatible_on_all_chips' into 'master' 2023-05-08 10:27:29 +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_cali: supported channel compensation of adc calibration on esp32c6 2023-05-23 22:44:25 +08: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 crypto: add support for DPA protection configuration in C6/H2 2023-06-08 11:09:23 +05:30
cpu.c esp_hw_support: Move cpu protection in port files 2023-03-09 11:37:29 +05:30
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 esp_hw_support: decrease RNG read frequency on C6 and H2 2023-05-30 19:16:53 +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 crypto: add support for DPA protection configuration in C6/H2 2023-06-08 11:09:23 +05:30
linker.lf bugfix: fix some flash funcs called in sleep wakeup process 2023-05-31 17:56:46 +08: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 esp_wifi: itwt add setup timeout timer to track response frame 2023-06-02 21:10:32 +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 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
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 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 bugfix: fix wrong RvCoreCriticalSleepFrame ptr value after wake restore 2023-04-07 18:55:44 +08:00
sleep_cpu.c bugfix: treat too short sleep duration as sleep reject by software 2023-05-29 16:35:03 +08:00
sleep_gpio.c esp32c6: bringup deepsleep examples 2023-03-02 15:06:05 +08:00
sleep_modem.c fix the issue of failure of receiving beacons in modem state caused by enabling light sleep in wifi min/max modem sleep mode 2023-04-07 05:57:15 +00:00
sleep_modes.c Merge branch 'bugfix/support_esp326_xtal_xpd' into 'master' 2023-06-12 11:28:59 +08:00
sleep_retention.c sleep retention: implement the extra linked list retention for modules with retention clock bugs 2023-05-06 14:58:00 +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 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 {
    }