esp-idf/components/esp_hw_support
Song Ruo Jing 0e759c6deb Merge branch 'refactor/esp_driver_uart' into 'master'
refactor(uart): make uart driver as component

Closes IDF-8384

See merge request espressif/esp-idf!27333
2023-12-18 19:16:34 +08:00
..
dma Merge branch 'refactor/async_mcp_non_cacheable_descriptor' into 'master' 2023-12-15 18:30:54 +08:00
include Merge branch 'feature/esp32p4_base_ldo_support' into 'master' 2023-12-15 12:31:17 +08:00
ldo feature(ldo): ldo driver 2023-12-14 12:46:51 +08:00
port Merge branch 'bugfix/put_extra_link_retention_in_iram' into 'master' 2023-12-14 10:28:34 +08:00
test_apps Merge branch 'refactor/esp_driver_uart' into 'master' 2023-12-18 19:16:34 +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 fix: remove wno format in esp_hw_support component 2023-09-18 02:43:41 +00:00
clkout_channel.h refactor(emac): use clock_output driver for configuring RMII reference clock 2023-10-31 14:24:48 +08:00
CMakeLists.txt feature(ldo): ldo driver 2023-12-14 12:46:51 +08:00
cpu.c fix(riscv): supports 1 byte and larger than 64byte range watchpoint setting 2023-11-16 18:11:57 +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 refactor(emac): use clock_output driver for configuring RMII reference clock 2023-10-31 14:24:48 +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 feat(ds): use RCC atomic block to enable/reset the DS peripheral 2023-10-11 14:59:04 +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(intr): always allocate memory from internal ram 2023-09-22 15:13:35 +08:00
Kconfig feat(dw_gdma): channel allocator driver 2023-12-12 03:35:05 +00:00
linker.lf fix(esp_hw_support): fix lightsleep current leakage on usb-phy controlled pad 2023-11-11 13:00:55 +08:00
mac_addr.c feat(mac): Add a configuration to set custom MAC as base MAC 2023-12-06 10:46:22 +08:00
modem_clock.c fix(esp_hw_support): fix ble on esp32c6eco1 depends on wifipwr clock domain 2023-12-07 14:02:04 +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-09 14:17:54 +08:00
README.md feat(dw_gdma): channel allocator driver 2023-12-12 03:35:05 +00: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(temperature_snesor): Put clock gate enable/disable in to sar_periph_ctrl together 2023-09-21 12:19:12 +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 refactor(startup): implement registration of core init functions 2023-11-27 10:20:51 +01:00
sleep_console.c fix(esp_hw_support): fix lightsleep current leakage on usb-phy controlled pad 2023-11-11 13:00:55 +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-13 16:32:25 +08:00
sleep_event.c change(pm): Change sleep callback implement 2023-10-23 08:13:47 +00:00
sleep_gpio.c refactor(startup): implement registration of core init functions 2023-11-27 10:20:51 +01:00
sleep_modem.c fix(pm): place extra link opt in iram 2023-12-04 14:46:42 +08:00
sleep_modes.c Merge branch 'bugfix/fix_esp32h2_system_retention_restore' into 'master' 2023-12-11 11:01:55 +08:00
sleep_retention.c fix(pm): place extra link opt in iram 2023-12-04 14:46:42 +08:00
sleep_system_peripheral.c refactor(startup): implement registration of core init functions 2023-11-27 10:20:51 +01:00
sleep_wake_stub.c esp32h4: remove esp32h4 target from peripherals 2023-04-20 15:19:45 +08:00
spi_bus_lock.c refactor(spi): moved spi hw sharing func to hw support 2023-11-20 12:07:54 +08:00
spi_share_hw_ctrl.c refactor(spi): moved spi hw sharing func to hw support 2023-11-20 12:07:54 +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 {
    }

DMA Service

With the increasing demand, the hardware design of DMA is changing along the way. At first, each peripheral has a dedicated DMA controller. Later, a centralized DMA controller is introduced, which is called GDMA in the software.

There may be multiple GDMA instances on a chip, some is attached to the AHB bus and some is attached to the AXI bus. But their functionalities are almost the same.

Some high-performance peripherals, such as MIPI, require DMA to provide more functions, such as hardware handshake mechanism, address growth mode, out-of-order transmission and so on. Therefore, a new DMA controller, called DW_GDMA was born. The prefix DW is taken from DesignWare.

Please note that the specific DMA controller to be used for peripherals is determined by the specific chip. It is possible that, on chip A, SPI works with AHB GDMA, while on chip B, SPI works with AXI GDMA.