From f27cd67c002b189a4fb26a6a4867eeb65ec0b3ed Mon Sep 17 00:00:00 2001 From: laokaiyao Date: Tue, 31 Jan 2023 14:36:21 +0800 Subject: [PATCH] driver: pack peripherals --- components/driver/CMakeLists.txt | 198 +++++++++++------- .../{ => dac}/include/driver/dac_continuous.h | 0 .../{ => dac}/include/driver/dac_cosine.h | 0 .../{ => dac}/include/driver/dac_oneshot.h | 0 .../{ => dac}/include/driver/dac_types.h | 2 +- .../{ => gpio}/include/driver/dedic_gpio.h | 0 .../driver/{ => gpio}/include/driver/gpio.h | 0 .../{ => gpio}/include/driver/gpio_etm.h | 2 +- .../{ => gpio}/include/driver/gpio_filter.h | 2 +- .../driver/{ => gpio}/include/driver/rtc_io.h | 0 .../{ => gptimer}/include/driver/gptimer.h | 2 +- .../include/driver/gptimer_etm.h | 2 +- .../include/driver/gptimer_types.h | 2 +- components/driver/{ => i2c}/i2c.c | 0 .../driver/{ => i2c}/include/driver/i2c.h | 0 .../{ => i2s}/include/driver/i2s_common.h | 0 .../driver/{ => i2s}/include/driver/i2s_pdm.h | 2 +- .../driver/{ => i2s}/include/driver/i2s_std.h | 2 +- .../driver/{ => i2s}/include/driver/i2s_tdm.h | 2 +- .../{ => i2s}/include/driver/i2s_types.h | 0 .../driver/{ => ledc}/include/driver/ledc.h | 0 components/driver/{ => ledc}/ledc.c | 0 .../{ => mcpwm}/include/driver/mcpwm_cap.h | 2 +- .../{ => mcpwm}/include/driver/mcpwm_cmpr.h | 2 +- .../{ => mcpwm}/include/driver/mcpwm_fault.h | 2 +- .../{ => mcpwm}/include/driver/mcpwm_gen.h | 0 .../{ => mcpwm}/include/driver/mcpwm_oper.h | 2 +- .../include/driver/mcpwm_prelude.h | 2 +- .../{ => mcpwm}/include/driver/mcpwm_sync.h | 2 +- .../{ => mcpwm}/include/driver/mcpwm_timer.h | 2 +- .../{ => mcpwm}/include/driver/mcpwm_types.h | 2 +- .../{ => pcnt}/include/driver/pulse_cnt.h | 2 +- components/driver/{ => pcnt}/pulse_cnt.c | 0 .../{ => rmt}/include/driver/rmt_common.h | 0 .../{ => rmt}/include/driver/rmt_encoder.h | 0 .../driver/{ => rmt}/include/driver/rmt_rx.h | 2 +- .../driver/{ => rmt}/include/driver/rmt_tx.h | 2 +- .../{ => rmt}/include/driver/rmt_types.h | 2 +- .../include/driver/sdio_slave.h | 0 .../driver/{ => sdio_slave}/sdio_slave.c | 0 .../{ => sdmmc}/include/driver/sdmmc_defs.h | 0 .../{ => sdmmc}/include/driver/sdmmc_host.h | 0 .../{ => sdmmc}/include/driver/sdmmc_types.h | 0 components/driver/{ => sdmmc}/sdmmc_host.c | 0 components/driver/{ => sdmmc}/sdmmc_private.h | 0 .../driver/{ => sdmmc}/sdmmc_transaction.c | 0 .../{ => sigma_delta}/include/driver/sdm.h | 0 components/driver/{ => sigma_delta}/sdm.c | 0 .../driver/{ => spi/gpspi}/spi_common.c | 0 .../driver/{ => spi/gpspi}/spi_master.c | 0 components/driver/{ => spi/gpspi}/spi_slave.c | 0 .../driver/{ => spi/gpspi}/spi_slave_hd.c | 0 .../{ => spi}/include/driver/intr_types.h | 0 .../{ => spi}/include/driver/sdspi_host.h | 2 +- .../{ => spi}/include/driver/spi_common.h | 2 +- .../{ => spi}/include/driver/spi_master.h | 0 .../{ => spi}/include/driver/spi_slave.h | 0 .../{ => spi}/include/driver/spi_slave_hd.h | 0 components/driver/{ => spi/sdspi}/sdspi_crc.c | 0 components/driver/{ => spi/sdspi}/sdspi_crc.h | 0 .../driver/{ => spi/sdspi}/sdspi_host.c | 0 .../driver/{ => spi/sdspi}/sdspi_private.h | 0 .../{ => spi/sdspi}/sdspi_transaction.c | 0 components/driver/{ => spi}/spi_bus_lock.c | 0 .../include/driver/temperature_sensor.h | 0 .../temperature_sensor.c | 2 +- .../esp32/include/driver/touch_sensor.h | 0 .../{ => touch_sensor}/esp32/touch_sensor.c | 0 .../esp32s2/include/driver/touch_sensor.h | 0 .../{ => touch_sensor}/esp32s2/touch_sensor.c | 0 .../esp32s3/include/driver/touch_sensor.h | 0 .../{ => touch_sensor}/esp32s3/touch_sensor.c | 0 .../include/driver/touch_pad.h | 0 .../include/driver/touch_sensor_common.h | 0 .../{ => touch_sensor}/touch_sensor_common.c | 0 .../driver/{ => twai}/include/driver/twai.h | 0 components/driver/{ => twai}/twai.c | 0 .../driver/{ => uart}/include/driver/uart.h | 0 .../{ => uart}/include/driver/uart_select.h | 0 components/driver/{ => uart}/uart.c | 0 .../include/driver/usb_serial_jtag.h | 0 .../{ => usb_serial_jtag}/usb_serial_jtag.c | 0 .../soc/esp32/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32/include/soc/soc_caps.h | 1 + .../esp32c2/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32c2/include/soc/soc_caps.h | 1 + .../esp32c3/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32c3/include/soc/soc_caps.h | 1 + .../esp32c6/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32c6/include/soc/soc_caps.h | 1 + .../esp32h2/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32h2/include/soc/soc_caps.h | 1 + .../esp32h4/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32h4/include/soc/soc_caps.h | 1 + .../esp32s2/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32s2/include/soc/soc_caps.h | 1 + .../esp32s3/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32s3/include/soc/soc_caps.h | 1 + docs/doxygen/Doxyfile | 92 ++++---- docs/doxygen/Doxyfile_esp32 | 2 +- docs/doxygen/Doxyfile_esp32s2 | 2 +- docs/doxygen/Doxyfile_esp32s3 | 2 +- .../jtag-debugging/debugging-examples.rst | 2 +- docs/en/api-reference/peripherals/dac.rst | 2 +- docs/en/api-reference/peripherals/i2c.rst | 4 +- docs/en/api-reference/peripherals/i2s.rst | 10 +- docs/en/api-reference/peripherals/mcpwm.rst | 2 +- docs/en/api-reference/peripherals/rmt.rst | 2 +- docs/en/api-reference/storage/sdmmc.rst | 2 +- docs/en/contribute/documenting-code.rst | 2 +- .../release-5.x/5.0/peripherals.rst | 8 +- .../jtag-debugging/debugging-examples.rst | 2 +- docs/zh_CN/api-reference/peripherals/i2c.rst | 4 +- docs/zh_CN/api-reference/storage/sdmmc.rst | 2 +- .../release-5.x/5.0/peripherals.rst | 8 +- tools/ci/check_copyright_config.yaml | 2 +- 116 files changed, 262 insertions(+), 174 deletions(-) rename components/driver/{ => dac}/include/driver/dac_continuous.h (100%) rename components/driver/{ => dac}/include/driver/dac_cosine.h (100%) rename components/driver/{ => dac}/include/driver/dac_oneshot.h (100%) rename components/driver/{ => dac}/include/driver/dac_types.h (94%) rename components/driver/{ => gpio}/include/driver/dedic_gpio.h (100%) rename components/driver/{ => gpio}/include/driver/gpio.h (100%) rename components/driver/{ => gpio}/include/driver/gpio_etm.h (98%) rename components/driver/{ => gpio}/include/driver/gpio_filter.h (98%) rename components/driver/{ => gpio}/include/driver/rtc_io.h (100%) rename components/driver/{ => gptimer}/include/driver/gptimer.h (99%) rename components/driver/{ => gptimer}/include/driver/gptimer_etm.h (96%) rename components/driver/{ => gptimer}/include/driver/gptimer_types.h (92%) rename components/driver/{ => i2c}/i2c.c (100%) rename components/driver/{ => i2c}/include/driver/i2c.h (100%) rename components/driver/{ => i2s}/include/driver/i2s_common.h (100%) rename components/driver/{ => i2s}/include/driver/i2s_pdm.h (99%) rename components/driver/{ => i2s}/include/driver/i2s_std.h (99%) rename components/driver/{ => i2s}/include/driver/i2s_tdm.h (99%) rename components/driver/{ => i2s}/include/driver/i2s_types.h (100%) rename components/driver/{ => ledc}/include/driver/ledc.h (100%) rename components/driver/{ => ledc}/ledc.c (100%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_cap.h (99%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_cmpr.h (98%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_fault.h (98%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_gen.h (100%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_oper.h (98%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_prelude.h (87%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_sync.h (98%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_timer.h (98%) rename components/driver/{ => mcpwm}/include/driver/mcpwm_types.h (98%) rename components/driver/{ => pcnt}/include/driver/pulse_cnt.h (99%) rename components/driver/{ => pcnt}/pulse_cnt.c (100%) rename components/driver/{ => rmt}/include/driver/rmt_common.h (100%) rename components/driver/{ => rmt}/include/driver/rmt_encoder.h (100%) rename components/driver/{ => rmt}/include/driver/rmt_rx.h (98%) rename components/driver/{ => rmt}/include/driver/rmt_tx.h (99%) rename components/driver/{ => rmt}/include/driver/rmt_types.h (97%) rename components/driver/{ => sdio_slave}/include/driver/sdio_slave.h (100%) rename components/driver/{ => sdio_slave}/sdio_slave.c (100%) rename components/driver/{ => sdmmc}/include/driver/sdmmc_defs.h (100%) rename components/driver/{ => sdmmc}/include/driver/sdmmc_host.h (100%) rename components/driver/{ => sdmmc}/include/driver/sdmmc_types.h (100%) rename components/driver/{ => sdmmc}/sdmmc_host.c (100%) rename components/driver/{ => sdmmc}/sdmmc_private.h (100%) rename components/driver/{ => sdmmc}/sdmmc_transaction.c (100%) rename components/driver/{ => sigma_delta}/include/driver/sdm.h (100%) rename components/driver/{ => sigma_delta}/sdm.c (100%) rename components/driver/{ => spi/gpspi}/spi_common.c (100%) rename components/driver/{ => spi/gpspi}/spi_master.c (100%) rename components/driver/{ => spi/gpspi}/spi_slave.c (100%) rename components/driver/{ => spi/gpspi}/spi_slave_hd.c (100%) rename components/driver/{ => spi}/include/driver/intr_types.h (100%) rename components/driver/{ => spi}/include/driver/sdspi_host.h (99%) rename components/driver/{ => spi}/include/driver/spi_common.h (99%) rename components/driver/{ => spi}/include/driver/spi_master.h (100%) rename components/driver/{ => spi}/include/driver/spi_slave.h (100%) rename components/driver/{ => spi}/include/driver/spi_slave_hd.h (100%) rename components/driver/{ => spi/sdspi}/sdspi_crc.c (100%) rename components/driver/{ => spi/sdspi}/sdspi_crc.h (100%) rename components/driver/{ => spi/sdspi}/sdspi_host.c (100%) rename components/driver/{ => spi/sdspi}/sdspi_private.h (100%) rename components/driver/{ => spi/sdspi}/sdspi_transaction.c (100%) rename components/driver/{ => spi}/spi_bus_lock.c (100%) rename components/driver/{ => temperature_sensor}/include/driver/temperature_sensor.h (100%) rename components/driver/{ => temperature_sensor}/temperature_sensor.c (99%) rename components/driver/{ => touch_sensor}/esp32/include/driver/touch_sensor.h (100%) rename components/driver/{ => touch_sensor}/esp32/touch_sensor.c (100%) rename components/driver/{ => touch_sensor}/esp32s2/include/driver/touch_sensor.h (100%) rename components/driver/{ => touch_sensor}/esp32s2/touch_sensor.c (100%) rename components/driver/{ => touch_sensor}/esp32s3/include/driver/touch_sensor.h (100%) rename components/driver/{ => touch_sensor}/esp32s3/touch_sensor.c (100%) rename components/driver/{ => touch_sensor}/include/driver/touch_pad.h (100%) rename components/driver/{ => touch_sensor}/include/driver/touch_sensor_common.h (100%) rename components/driver/{ => touch_sensor}/touch_sensor_common.c (100%) rename components/driver/{ => twai}/include/driver/twai.h (100%) rename components/driver/{ => twai}/twai.c (100%) rename components/driver/{ => uart}/include/driver/uart.h (100%) rename components/driver/{ => uart}/include/driver/uart_select.h (100%) rename components/driver/{ => uart}/uart.c (100%) rename components/driver/{ => usb_serial_jtag}/include/driver/usb_serial_jtag.h (100%) rename components/driver/{ => usb_serial_jtag}/usb_serial_jtag.c (100%) diff --git a/components/driver/CMakeLists.txt b/components/driver/CMakeLists.txt index 15012d18ba..abaa4315da 100644 --- a/components/driver/CMakeLists.txt +++ b/components/driver/CMakeLists.txt @@ -1,33 +1,35 @@ idf_build_get_property(target IDF_TARGET) +# Always compiled source files set(srcs "gpio/gpio.c" - "gpio/rtc_io.c" "gpio/gpio_glitch_filter_ops.c" - "spi_bus_lock.c" - "uart.c") + "gpio/rtc_io.c" + "spi/spi_bus_lock.c") -set(includes "include" "deprecated") -if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/${target}/include") - list(APPEND includes "${target}/include") -endif() - -if(CONFIG_SOC_LEDC_SUPPORTED) - list(APPEND srcs "ledc.c") -endif() - -if(CONFIG_SOC_GPTIMER_SUPPORTED) - list(APPEND srcs "gptimer/gptimer.c" "deprecated/timer_legacy.c") -endif() - -if(CONFIG_SOC_TIMER_SUPPORT_ETM) - list(APPEND srcs "gptimer/gptimer_etm.c") -endif() - -if(CONFIG_SOC_I2C_SUPPORTED) - list(APPEND srcs "i2c.c") -endif() +# Always included headers +set(includes "include" + "deprecated" + "dac/include" + "gpio/include" + "gptimer/include" + "i2c/include" + "i2s/include" + "ledc/include" + "mcpwm/include" + "pcnt/include" + "rmt/include" + "sdio_slave/include" + "sdmmc/include" + "sigma_delta/include" + "spi/include" + "temperature_sensor/include" + "touch_sensor/include" + "twai/include" + "uart/include" + "usb_serial_jtag/include") +# ADC related source files (dprecated) if(CONFIG_SOC_ADC_SUPPORTED) list(APPEND srcs "deprecated/adc_legacy.c") endif() @@ -36,18 +38,18 @@ if(CONFIG_SOC_ADC_DMA_SUPPORTED) list(APPEND srcs "deprecated/adc_dma_legacy.c") endif() -if(CONFIG_SOC_MCPWM_SUPPORTED) - list(APPEND srcs "mcpwm/mcpwm_cap.c" - "mcpwm/mcpwm_cmpr.c" - "mcpwm/mcpwm_com.c" - "mcpwm/mcpwm_fault.c" - "mcpwm/mcpwm_gen.c" - "mcpwm/mcpwm_oper.c" - "mcpwm/mcpwm_sync.c" - "mcpwm/mcpwm_timer.c" - "deprecated/mcpwm_legacy.c") +# DAC related source files +if(CONFIG_SOC_DAC_SUPPORTED) + list(APPEND srcs "dac/dac_oneshot.c" + "dac/dac_cosine.c" + "dac/dac_continuous.c" + "dac/dac_common.c" + "dac/${target}/dac_dma.c" + "deprecated/dac_common_legacy.c" + "deprecated/${target}/dac_legacy.c") endif() +# GPIO related source files if(CONFIG_SOC_DEDICATED_GPIO_SUPPORTED) list(APPEND srcs "gpio/dedic_gpio.c") endif() @@ -60,26 +62,26 @@ if(CONFIG_SOC_GPIO_FLEX_GLITCH_FILTER_NUM GREATER 0) list(APPEND srcs "gpio/gpio_flex_glitch_filter.c") endif() -if(CONFIG_SOC_SDM_SUPPORTED) - list(APPEND srcs "sdm.c" "deprecated/sigma_delta_legacy.c") -endif() - -if(CONFIG_SOC_RMT_SUPPORTED) - list(APPEND srcs "rmt/rmt_common.c" "rmt/rmt_encoder.c" "rmt/rmt_rx.c" "rmt/rmt_tx.c" "deprecated/rmt_legacy.c") -endif() - -if(CONFIG_SOC_PCNT_SUPPORTED) - list(APPEND srcs "pulse_cnt.c" "deprecated/pcnt_legacy.c") -endif() - if(CONFIG_SOC_GPIO_SUPPORT_ETM) list(APPEND srcs "gpio/gpio_etm.c") endif() -if(CONFIG_SOC_SDMMC_HOST_SUPPORTED) - list(APPEND srcs "sdmmc_transaction.c" "sdmmc_host.c") +# GPTimer related source files +if(CONFIG_SOC_GPTIMER_SUPPORTED) + list(APPEND srcs "gptimer/gptimer.c" + "deprecated/timer_legacy.c") endif() +if(CONFIG_SOC_TIMER_SUPPORT_ETM) + list(APPEND srcs "gptimer/gptimer_etm.c") +endif() + +# I2C related source files +if(CONFIG_SOC_I2C_SUPPORTED) + list(APPEND srcs "i2c/i2c.c") +endif() + +# I2S related source files if(CONFIG_SOC_I2S_SUPPORTED) list(APPEND srcs "i2s/i2s_common.c" "i2s/i2s_std.c" @@ -92,52 +94,99 @@ if(CONFIG_SOC_I2S_SUPPORTED) endif() endif() -if(CONFIG_SOC_TEMP_SENSOR_SUPPORTED) - list(APPEND srcs "temperature_sensor.c" - "deprecated/rtc_temperature_legacy.c") +# LEDC related source files +if(CONFIG_SOC_LEDC_SUPPORTED) + list(APPEND srcs "ledc/ledc.c") endif() -if(CONFIG_SOC_TWAI_SUPPORTED) - list(APPEND srcs "twai.c") +# MCPWM related source files +if(CONFIG_SOC_MCPWM_SUPPORTED) + list(APPEND srcs "mcpwm/mcpwm_cap.c" + "mcpwm/mcpwm_cmpr.c" + "mcpwm/mcpwm_com.c" + "mcpwm/mcpwm_fault.c" + "mcpwm/mcpwm_gen.c" + "mcpwm/mcpwm_oper.c" + "mcpwm/mcpwm_sync.c" + "mcpwm/mcpwm_timer.c" + "deprecated/mcpwm_legacy.c") endif() -if(CONFIG_SOC_USB_SERIAL_JTAG_SUPPORTED) - list(APPEND srcs "usb_serial_jtag.c") +# PCNT related source files +if(CONFIG_SOC_PCNT_SUPPORTED) + list(APPEND srcs "pcnt/pulse_cnt.c" + "deprecated/pcnt_legacy.c") endif() +# RMT related source files +if(CONFIG_SOC_RMT_SUPPORTED) + list(APPEND srcs "rmt/rmt_common.c" + "rmt/rmt_encoder.c" + "rmt/rmt_rx.c" + "rmt/rmt_tx.c" + "deprecated/rmt_legacy.c") +endif() + +# SDIO Slave related source files +if(CONFIG_SOC_SDIO_SLAVE_SUPPORTED) + list(APPEND srcs "sdio_slave/sdio_slave.c") +endif() + +# SDMMC related source files +if(CONFIG_SOC_SDMMC_HOST_SUPPORTED) + list(APPEND srcs "sdmmc/sdmmc_transaction.c" + "sdmmc/sdmmc_host.c") +endif() + +# Sigma-Delta Modulation related source files +if(CONFIG_SOC_SDM_SUPPORTED) + list(APPEND srcs "sigma_delta/sdm.c" + "deprecated/sigma_delta_legacy.c") +endif() + +# SPI related source files if(CONFIG_SOC_GPSPI_SUPPORTED) - list(APPEND srcs - "spi_common.c" - "spi_master.c" - "spi_slave.c" - "sdspi_crc.c" - "sdspi_host.c" - "sdspi_transaction.c") + list(APPEND srcs "spi/gpspi/spi_common.c" + "spi/gpspi/spi_master.c" + "spi/gpspi/spi_slave.c" + "spi/sdspi/sdspi_crc.c" + "spi/sdspi/sdspi_host.c" + "spi/sdspi/sdspi_transaction.c") endif() if(CONFIG_SOC_SPI_SUPPORT_SLAVE_HD_VER2) - list(APPEND srcs "spi_slave_hd.c") + list(APPEND srcs "spi/gpspi/spi_slave_hd.c") endif() +# Temperature Sensor related source files +if(CONFIG_SOC_TEMP_SENSOR_SUPPORTED) + list(APPEND srcs "temperature_sensor/temperature_sensor.c" + "deprecated/rtc_temperature_legacy.c") +endif() + +# Touch Sensor related source files if(CONFIG_SOC_TOUCH_SENSOR_SUPPORTED) - list(APPEND srcs "touch_sensor_common.c" - "${target}/touch_sensor.c") + list(APPEND srcs "touch_sensor/touch_sensor_common.c" + "touch_sensor/${target}/touch_sensor.c") + list(APPEND includes "touch_sensor/${target}/include") endif() -if(CONFIG_SOC_SDIO_SLAVE_SUPPORTED) - list(APPEND srcs "sdio_slave.c") +# TWAI related source files +if(CONFIG_SOC_TWAI_SUPPORTED) + list(APPEND srcs "twai/twai.c") endif() -if(CONFIG_SOC_DAC_SUPPORTED) - list(APPEND srcs "dac/dac_oneshot.c" - "dac/dac_cosine.c" - "dac/dac_continuous.c" - "dac/dac_common.c" - "dac/${target}/dac_dma.c" - "deprecated/dac_common_legacy.c" - "deprecated/${target}/dac_legacy.c") +# UART related source files +if(CONFIG_SOC_UART_SUPPORTED) + list(APPEND srcs "uart/uart.c") endif() +# USB Serial JTAG related source files +if(CONFIG_SOC_USB_SERIAL_JTAG_SUPPORTED) + list(APPEND srcs "usb_serial_jtag/usb_serial_jtag.c") +endif() + +# Other source files if(${target} STREQUAL "esp32") list(APPEND srcs "deprecated/adc_i2s_deprecated.c") endif() @@ -151,7 +200,6 @@ else() # Can be removed together with legacy drivers) idf_component_register(SRCS "${srcs}" INCLUDE_DIRS ${includes} - PRIV_INCLUDE_DIRS "include/driver" PRIV_REQUIRES efuse esp_timer REQUIRES esp_pm esp_ringbuf freertos soc hal esp_hw_support LDFRAGMENTS linker.lf) diff --git a/components/driver/include/driver/dac_continuous.h b/components/driver/dac/include/driver/dac_continuous.h similarity index 100% rename from components/driver/include/driver/dac_continuous.h rename to components/driver/dac/include/driver/dac_continuous.h diff --git a/components/driver/include/driver/dac_cosine.h b/components/driver/dac/include/driver/dac_cosine.h similarity index 100% rename from components/driver/include/driver/dac_cosine.h rename to components/driver/dac/include/driver/dac_cosine.h diff --git a/components/driver/include/driver/dac_oneshot.h b/components/driver/dac/include/driver/dac_oneshot.h similarity index 100% rename from components/driver/include/driver/dac_oneshot.h rename to components/driver/dac/include/driver/dac_oneshot.h diff --git a/components/driver/include/driver/dac_types.h b/components/driver/dac/include/driver/dac_types.h similarity index 94% rename from components/driver/include/driver/dac_types.h rename to components/driver/dac/include/driver/dac_types.h index cf67399823..bc54334f46 100644 --- a/components/driver/include/driver/dac_types.h +++ b/components/driver/dac/include/driver/dac_types.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/dedic_gpio.h b/components/driver/gpio/include/driver/dedic_gpio.h similarity index 100% rename from components/driver/include/driver/dedic_gpio.h rename to components/driver/gpio/include/driver/dedic_gpio.h diff --git a/components/driver/include/driver/gpio.h b/components/driver/gpio/include/driver/gpio.h similarity index 100% rename from components/driver/include/driver/gpio.h rename to components/driver/gpio/include/driver/gpio.h diff --git a/components/driver/include/driver/gpio_etm.h b/components/driver/gpio/include/driver/gpio_etm.h similarity index 98% rename from components/driver/include/driver/gpio_etm.h rename to components/driver/gpio/include/driver/gpio_etm.h index e7acf722d5..e7d4b0b7ad 100644 --- a/components/driver/include/driver/gpio_etm.h +++ b/components/driver/gpio/include/driver/gpio_etm.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/gpio_filter.h b/components/driver/gpio/include/driver/gpio_filter.h similarity index 98% rename from components/driver/include/driver/gpio_filter.h rename to components/driver/gpio/include/driver/gpio_filter.h index 1225084d76..229abede62 100644 --- a/components/driver/include/driver/gpio_filter.h +++ b/components/driver/gpio/include/driver/gpio_filter.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/rtc_io.h b/components/driver/gpio/include/driver/rtc_io.h similarity index 100% rename from components/driver/include/driver/rtc_io.h rename to components/driver/gpio/include/driver/rtc_io.h diff --git a/components/driver/include/driver/gptimer.h b/components/driver/gptimer/include/driver/gptimer.h similarity index 99% rename from components/driver/include/driver/gptimer.h rename to components/driver/gptimer/include/driver/gptimer.h index 31a761a891..954b7f619a 100644 --- a/components/driver/include/driver/gptimer.h +++ b/components/driver/gptimer/include/driver/gptimer.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/gptimer_etm.h b/components/driver/gptimer/include/driver/gptimer_etm.h similarity index 96% rename from components/driver/include/driver/gptimer_etm.h rename to components/driver/gptimer/include/driver/gptimer_etm.h index 136dd0d0f0..d6debe9612 100644 --- a/components/driver/include/driver/gptimer_etm.h +++ b/components/driver/gptimer/include/driver/gptimer_etm.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/gptimer_types.h b/components/driver/gptimer/include/driver/gptimer_types.h similarity index 92% rename from components/driver/include/driver/gptimer_types.h rename to components/driver/gptimer/include/driver/gptimer_types.h index 4339e96275..8fc188d828 100644 --- a/components/driver/include/driver/gptimer_types.h +++ b/components/driver/gptimer/include/driver/gptimer_types.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/i2c.c b/components/driver/i2c/i2c.c similarity index 100% rename from components/driver/i2c.c rename to components/driver/i2c/i2c.c diff --git a/components/driver/include/driver/i2c.h b/components/driver/i2c/include/driver/i2c.h similarity index 100% rename from components/driver/include/driver/i2c.h rename to components/driver/i2c/include/driver/i2c.h diff --git a/components/driver/include/driver/i2s_common.h b/components/driver/i2s/include/driver/i2s_common.h similarity index 100% rename from components/driver/include/driver/i2s_common.h rename to components/driver/i2s/include/driver/i2s_common.h diff --git a/components/driver/include/driver/i2s_pdm.h b/components/driver/i2s/include/driver/i2s_pdm.h similarity index 99% rename from components/driver/include/driver/i2s_pdm.h rename to components/driver/i2s/include/driver/i2s_pdm.h index bf714b8efb..29107e8e1c 100644 --- a/components/driver/include/driver/i2s_pdm.h +++ b/components/driver/i2s/include/driver/i2s_pdm.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/i2s_std.h b/components/driver/i2s/include/driver/i2s_std.h similarity index 99% rename from components/driver/include/driver/i2s_std.h rename to components/driver/i2s/include/driver/i2s_std.h index 300691db4d..1080019e96 100644 --- a/components/driver/include/driver/i2s_std.h +++ b/components/driver/i2s/include/driver/i2s_std.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/i2s_tdm.h b/components/driver/i2s/include/driver/i2s_tdm.h similarity index 99% rename from components/driver/include/driver/i2s_tdm.h rename to components/driver/i2s/include/driver/i2s_tdm.h index 41c1e2ef67..759473eead 100644 --- a/components/driver/include/driver/i2s_tdm.h +++ b/components/driver/i2s/include/driver/i2s_tdm.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/i2s_types.h b/components/driver/i2s/include/driver/i2s_types.h similarity index 100% rename from components/driver/include/driver/i2s_types.h rename to components/driver/i2s/include/driver/i2s_types.h diff --git a/components/driver/include/driver/ledc.h b/components/driver/ledc/include/driver/ledc.h similarity index 100% rename from components/driver/include/driver/ledc.h rename to components/driver/ledc/include/driver/ledc.h diff --git a/components/driver/ledc.c b/components/driver/ledc/ledc.c similarity index 100% rename from components/driver/ledc.c rename to components/driver/ledc/ledc.c diff --git a/components/driver/include/driver/mcpwm_cap.h b/components/driver/mcpwm/include/driver/mcpwm_cap.h similarity index 99% rename from components/driver/include/driver/mcpwm_cap.h rename to components/driver/mcpwm/include/driver/mcpwm_cap.h index f8c545f5c6..709d97c478 100644 --- a/components/driver/include/driver/mcpwm_cap.h +++ b/components/driver/mcpwm/include/driver/mcpwm_cap.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/mcpwm_cmpr.h b/components/driver/mcpwm/include/driver/mcpwm_cmpr.h similarity index 98% rename from components/driver/include/driver/mcpwm_cmpr.h rename to components/driver/mcpwm/include/driver/mcpwm_cmpr.h index 8ebae75736..dc68df6d17 100644 --- a/components/driver/include/driver/mcpwm_cmpr.h +++ b/components/driver/mcpwm/include/driver/mcpwm_cmpr.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/mcpwm_fault.h b/components/driver/mcpwm/include/driver/mcpwm_fault.h similarity index 98% rename from components/driver/include/driver/mcpwm_fault.h rename to components/driver/mcpwm/include/driver/mcpwm_fault.h index e9833c4996..d97f40df33 100644 --- a/components/driver/include/driver/mcpwm_fault.h +++ b/components/driver/mcpwm/include/driver/mcpwm_fault.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/mcpwm_gen.h b/components/driver/mcpwm/include/driver/mcpwm_gen.h similarity index 100% rename from components/driver/include/driver/mcpwm_gen.h rename to components/driver/mcpwm/include/driver/mcpwm_gen.h diff --git a/components/driver/include/driver/mcpwm_oper.h b/components/driver/mcpwm/include/driver/mcpwm_oper.h similarity index 98% rename from components/driver/include/driver/mcpwm_oper.h rename to components/driver/mcpwm/include/driver/mcpwm_oper.h index 75a531f2c3..d3b2a1d69b 100644 --- a/components/driver/include/driver/mcpwm_oper.h +++ b/components/driver/mcpwm/include/driver/mcpwm_oper.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/mcpwm_prelude.h b/components/driver/mcpwm/include/driver/mcpwm_prelude.h similarity index 87% rename from components/driver/include/driver/mcpwm_prelude.h rename to components/driver/mcpwm/include/driver/mcpwm_prelude.h index fd460ece38..d143d0f545 100644 --- a/components/driver/include/driver/mcpwm_prelude.h +++ b/components/driver/mcpwm/include/driver/mcpwm_prelude.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/mcpwm_sync.h b/components/driver/mcpwm/include/driver/mcpwm_sync.h similarity index 98% rename from components/driver/include/driver/mcpwm_sync.h rename to components/driver/mcpwm/include/driver/mcpwm_sync.h index 7f691e9fa6..ac4c8e204b 100644 --- a/components/driver/include/driver/mcpwm_sync.h +++ b/components/driver/mcpwm/include/driver/mcpwm_sync.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/mcpwm_timer.h b/components/driver/mcpwm/include/driver/mcpwm_timer.h similarity index 98% rename from components/driver/include/driver/mcpwm_timer.h rename to components/driver/mcpwm/include/driver/mcpwm_timer.h index 1cb1d6d8cf..33ec450d8e 100644 --- a/components/driver/include/driver/mcpwm_timer.h +++ b/components/driver/mcpwm/include/driver/mcpwm_timer.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/mcpwm_types.h b/components/driver/mcpwm/include/driver/mcpwm_types.h similarity index 98% rename from components/driver/include/driver/mcpwm_types.h rename to components/driver/mcpwm/include/driver/mcpwm_types.h index fcd736ae3e..7fd894e7c2 100644 --- a/components/driver/include/driver/mcpwm_types.h +++ b/components/driver/mcpwm/include/driver/mcpwm_types.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/pulse_cnt.h b/components/driver/pcnt/include/driver/pulse_cnt.h similarity index 99% rename from components/driver/include/driver/pulse_cnt.h rename to components/driver/pcnt/include/driver/pulse_cnt.h index 833c5dadbf..8766e42de4 100644 --- a/components/driver/include/driver/pulse_cnt.h +++ b/components/driver/pcnt/include/driver/pulse_cnt.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/pulse_cnt.c b/components/driver/pcnt/pulse_cnt.c similarity index 100% rename from components/driver/pulse_cnt.c rename to components/driver/pcnt/pulse_cnt.c diff --git a/components/driver/include/driver/rmt_common.h b/components/driver/rmt/include/driver/rmt_common.h similarity index 100% rename from components/driver/include/driver/rmt_common.h rename to components/driver/rmt/include/driver/rmt_common.h diff --git a/components/driver/include/driver/rmt_encoder.h b/components/driver/rmt/include/driver/rmt_encoder.h similarity index 100% rename from components/driver/include/driver/rmt_encoder.h rename to components/driver/rmt/include/driver/rmt_encoder.h diff --git a/components/driver/include/driver/rmt_rx.h b/components/driver/rmt/include/driver/rmt_rx.h similarity index 98% rename from components/driver/include/driver/rmt_rx.h rename to components/driver/rmt/include/driver/rmt_rx.h index d8ebd6ecc1..c750a59a73 100644 --- a/components/driver/include/driver/rmt_rx.h +++ b/components/driver/rmt/include/driver/rmt_rx.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/rmt_tx.h b/components/driver/rmt/include/driver/rmt_tx.h similarity index 99% rename from components/driver/include/driver/rmt_tx.h rename to components/driver/rmt/include/driver/rmt_tx.h index 9ee39456a5..83b1cef392 100644 --- a/components/driver/include/driver/rmt_tx.h +++ b/components/driver/rmt/include/driver/rmt_tx.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/rmt_types.h b/components/driver/rmt/include/driver/rmt_types.h similarity index 97% rename from components/driver/include/driver/rmt_types.h rename to components/driver/rmt/include/driver/rmt_types.h index 3dac8138fd..3ba13d7932 100644 --- a/components/driver/include/driver/rmt_types.h +++ b/components/driver/rmt/include/driver/rmt_types.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/include/driver/sdio_slave.h b/components/driver/sdio_slave/include/driver/sdio_slave.h similarity index 100% rename from components/driver/include/driver/sdio_slave.h rename to components/driver/sdio_slave/include/driver/sdio_slave.h diff --git a/components/driver/sdio_slave.c b/components/driver/sdio_slave/sdio_slave.c similarity index 100% rename from components/driver/sdio_slave.c rename to components/driver/sdio_slave/sdio_slave.c diff --git a/components/driver/include/driver/sdmmc_defs.h b/components/driver/sdmmc/include/driver/sdmmc_defs.h similarity index 100% rename from components/driver/include/driver/sdmmc_defs.h rename to components/driver/sdmmc/include/driver/sdmmc_defs.h diff --git a/components/driver/include/driver/sdmmc_host.h b/components/driver/sdmmc/include/driver/sdmmc_host.h similarity index 100% rename from components/driver/include/driver/sdmmc_host.h rename to components/driver/sdmmc/include/driver/sdmmc_host.h diff --git a/components/driver/include/driver/sdmmc_types.h b/components/driver/sdmmc/include/driver/sdmmc_types.h similarity index 100% rename from components/driver/include/driver/sdmmc_types.h rename to components/driver/sdmmc/include/driver/sdmmc_types.h diff --git a/components/driver/sdmmc_host.c b/components/driver/sdmmc/sdmmc_host.c similarity index 100% rename from components/driver/sdmmc_host.c rename to components/driver/sdmmc/sdmmc_host.c diff --git a/components/driver/sdmmc_private.h b/components/driver/sdmmc/sdmmc_private.h similarity index 100% rename from components/driver/sdmmc_private.h rename to components/driver/sdmmc/sdmmc_private.h diff --git a/components/driver/sdmmc_transaction.c b/components/driver/sdmmc/sdmmc_transaction.c similarity index 100% rename from components/driver/sdmmc_transaction.c rename to components/driver/sdmmc/sdmmc_transaction.c diff --git a/components/driver/include/driver/sdm.h b/components/driver/sigma_delta/include/driver/sdm.h similarity index 100% rename from components/driver/include/driver/sdm.h rename to components/driver/sigma_delta/include/driver/sdm.h diff --git a/components/driver/sdm.c b/components/driver/sigma_delta/sdm.c similarity index 100% rename from components/driver/sdm.c rename to components/driver/sigma_delta/sdm.c diff --git a/components/driver/spi_common.c b/components/driver/spi/gpspi/spi_common.c similarity index 100% rename from components/driver/spi_common.c rename to components/driver/spi/gpspi/spi_common.c diff --git a/components/driver/spi_master.c b/components/driver/spi/gpspi/spi_master.c similarity index 100% rename from components/driver/spi_master.c rename to components/driver/spi/gpspi/spi_master.c diff --git a/components/driver/spi_slave.c b/components/driver/spi/gpspi/spi_slave.c similarity index 100% rename from components/driver/spi_slave.c rename to components/driver/spi/gpspi/spi_slave.c diff --git a/components/driver/spi_slave_hd.c b/components/driver/spi/gpspi/spi_slave_hd.c similarity index 100% rename from components/driver/spi_slave_hd.c rename to components/driver/spi/gpspi/spi_slave_hd.c diff --git a/components/driver/include/driver/intr_types.h b/components/driver/spi/include/driver/intr_types.h similarity index 100% rename from components/driver/include/driver/intr_types.h rename to components/driver/spi/include/driver/intr_types.h diff --git a/components/driver/include/driver/sdspi_host.h b/components/driver/spi/include/driver/sdspi_host.h similarity index 99% rename from components/driver/include/driver/sdspi_host.h rename to components/driver/spi/include/driver/sdspi_host.h index 6025b4f2e3..3b127fbfef 100644 --- a/components/driver/include/driver/sdspi_host.h +++ b/components/driver/spi/include/driver/sdspi_host.h @@ -9,7 +9,7 @@ #include #include #include "esp_err.h" -#include "sdmmc_types.h" +#include "driver/sdmmc_types.h" #include "driver/gpio.h" #include "driver/spi_master.h" diff --git a/components/driver/include/driver/spi_common.h b/components/driver/spi/include/driver/spi_common.h similarity index 99% rename from components/driver/include/driver/spi_common.h rename to components/driver/spi/include/driver/spi_common.h index 17bb7576f3..764b885359 100644 --- a/components/driver/include/driver/spi_common.h +++ b/components/driver/spi/include/driver/spi_common.h @@ -11,7 +11,7 @@ #include "sdkconfig.h" #include "esp_err.h" #include "esp_ipc.h" -#include "intr_types.h" +#include "driver/intr_types.h" #include "hal/spi_types.h" #ifdef __cplusplus diff --git a/components/driver/include/driver/spi_master.h b/components/driver/spi/include/driver/spi_master.h similarity index 100% rename from components/driver/include/driver/spi_master.h rename to components/driver/spi/include/driver/spi_master.h diff --git a/components/driver/include/driver/spi_slave.h b/components/driver/spi/include/driver/spi_slave.h similarity index 100% rename from components/driver/include/driver/spi_slave.h rename to components/driver/spi/include/driver/spi_slave.h diff --git a/components/driver/include/driver/spi_slave_hd.h b/components/driver/spi/include/driver/spi_slave_hd.h similarity index 100% rename from components/driver/include/driver/spi_slave_hd.h rename to components/driver/spi/include/driver/spi_slave_hd.h diff --git a/components/driver/sdspi_crc.c b/components/driver/spi/sdspi/sdspi_crc.c similarity index 100% rename from components/driver/sdspi_crc.c rename to components/driver/spi/sdspi/sdspi_crc.c diff --git a/components/driver/sdspi_crc.h b/components/driver/spi/sdspi/sdspi_crc.h similarity index 100% rename from components/driver/sdspi_crc.h rename to components/driver/spi/sdspi/sdspi_crc.h diff --git a/components/driver/sdspi_host.c b/components/driver/spi/sdspi/sdspi_host.c similarity index 100% rename from components/driver/sdspi_host.c rename to components/driver/spi/sdspi/sdspi_host.c diff --git a/components/driver/sdspi_private.h b/components/driver/spi/sdspi/sdspi_private.h similarity index 100% rename from components/driver/sdspi_private.h rename to components/driver/spi/sdspi/sdspi_private.h diff --git a/components/driver/sdspi_transaction.c b/components/driver/spi/sdspi/sdspi_transaction.c similarity index 100% rename from components/driver/sdspi_transaction.c rename to components/driver/spi/sdspi/sdspi_transaction.c diff --git a/components/driver/spi_bus_lock.c b/components/driver/spi/spi_bus_lock.c similarity index 100% rename from components/driver/spi_bus_lock.c rename to components/driver/spi/spi_bus_lock.c diff --git a/components/driver/include/driver/temperature_sensor.h b/components/driver/temperature_sensor/include/driver/temperature_sensor.h similarity index 100% rename from components/driver/include/driver/temperature_sensor.h rename to components/driver/temperature_sensor/include/driver/temperature_sensor.h diff --git a/components/driver/temperature_sensor.c b/components/driver/temperature_sensor/temperature_sensor.c similarity index 99% rename from components/driver/temperature_sensor.c rename to components/driver/temperature_sensor/temperature_sensor.c index c0e0d9629a..44a199f035 100644 --- a/components/driver/temperature_sensor.c +++ b/components/driver/temperature_sensor/temperature_sensor.c @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ diff --git a/components/driver/esp32/include/driver/touch_sensor.h b/components/driver/touch_sensor/esp32/include/driver/touch_sensor.h similarity index 100% rename from components/driver/esp32/include/driver/touch_sensor.h rename to components/driver/touch_sensor/esp32/include/driver/touch_sensor.h diff --git a/components/driver/esp32/touch_sensor.c b/components/driver/touch_sensor/esp32/touch_sensor.c similarity index 100% rename from components/driver/esp32/touch_sensor.c rename to components/driver/touch_sensor/esp32/touch_sensor.c diff --git a/components/driver/esp32s2/include/driver/touch_sensor.h b/components/driver/touch_sensor/esp32s2/include/driver/touch_sensor.h similarity index 100% rename from components/driver/esp32s2/include/driver/touch_sensor.h rename to components/driver/touch_sensor/esp32s2/include/driver/touch_sensor.h diff --git a/components/driver/esp32s2/touch_sensor.c b/components/driver/touch_sensor/esp32s2/touch_sensor.c similarity index 100% rename from components/driver/esp32s2/touch_sensor.c rename to components/driver/touch_sensor/esp32s2/touch_sensor.c diff --git a/components/driver/esp32s3/include/driver/touch_sensor.h b/components/driver/touch_sensor/esp32s3/include/driver/touch_sensor.h similarity index 100% rename from components/driver/esp32s3/include/driver/touch_sensor.h rename to components/driver/touch_sensor/esp32s3/include/driver/touch_sensor.h diff --git a/components/driver/esp32s3/touch_sensor.c b/components/driver/touch_sensor/esp32s3/touch_sensor.c similarity index 100% rename from components/driver/esp32s3/touch_sensor.c rename to components/driver/touch_sensor/esp32s3/touch_sensor.c diff --git a/components/driver/include/driver/touch_pad.h b/components/driver/touch_sensor/include/driver/touch_pad.h similarity index 100% rename from components/driver/include/driver/touch_pad.h rename to components/driver/touch_sensor/include/driver/touch_pad.h diff --git a/components/driver/include/driver/touch_sensor_common.h b/components/driver/touch_sensor/include/driver/touch_sensor_common.h similarity index 100% rename from components/driver/include/driver/touch_sensor_common.h rename to components/driver/touch_sensor/include/driver/touch_sensor_common.h diff --git a/components/driver/touch_sensor_common.c b/components/driver/touch_sensor/touch_sensor_common.c similarity index 100% rename from components/driver/touch_sensor_common.c rename to components/driver/touch_sensor/touch_sensor_common.c diff --git a/components/driver/include/driver/twai.h b/components/driver/twai/include/driver/twai.h similarity index 100% rename from components/driver/include/driver/twai.h rename to components/driver/twai/include/driver/twai.h diff --git a/components/driver/twai.c b/components/driver/twai/twai.c similarity index 100% rename from components/driver/twai.c rename to components/driver/twai/twai.c diff --git a/components/driver/include/driver/uart.h b/components/driver/uart/include/driver/uart.h similarity index 100% rename from components/driver/include/driver/uart.h rename to components/driver/uart/include/driver/uart.h diff --git a/components/driver/include/driver/uart_select.h b/components/driver/uart/include/driver/uart_select.h similarity index 100% rename from components/driver/include/driver/uart_select.h rename to components/driver/uart/include/driver/uart_select.h diff --git a/components/driver/uart.c b/components/driver/uart/uart.c similarity index 100% rename from components/driver/uart.c rename to components/driver/uart/uart.c diff --git a/components/driver/include/driver/usb_serial_jtag.h b/components/driver/usb_serial_jtag/include/driver/usb_serial_jtag.h similarity index 100% rename from components/driver/include/driver/usb_serial_jtag.h rename to components/driver/usb_serial_jtag/include/driver/usb_serial_jtag.h diff --git a/components/driver/usb_serial_jtag.c b/components/driver/usb_serial_jtag/usb_serial_jtag.c similarity index 100% rename from components/driver/usb_serial_jtag.c rename to components/driver/usb_serial_jtag/usb_serial_jtag.c diff --git a/components/soc/esp32/include/soc/Kconfig.soc_caps.in b/components/soc/esp32/include/soc/Kconfig.soc_caps.in index 7d015b5064..09f8bf39d4 100644 --- a/components/soc/esp32/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32/include/soc/Kconfig.soc_caps.in @@ -27,6 +27,10 @@ config SOC_DAC_SUPPORTED bool default y +config SOC_UART_SUPPORTED + bool + default y + config SOC_MCPWM_SUPPORTED bool default y diff --git a/components/soc/esp32/include/soc/soc_caps.h b/components/soc/esp32/include/soc/soc_caps.h index ccabb3b234..295a8b48a4 100644 --- a/components/soc/esp32/include/soc/soc_caps.h +++ b/components/soc/esp32/include/soc/soc_caps.h @@ -66,6 +66,7 @@ #define SOC_ADC_SUPPORTED 1 #define SOC_DAC_SUPPORTED 1 +#define SOC_UART_SUPPORTED 1 #define SOC_MCPWM_SUPPORTED 1 #define SOC_GPTIMER_SUPPORTED 1 #define SOC_SDMMC_HOST_SUPPORTED 1 diff --git a/components/soc/esp32c2/include/soc/Kconfig.soc_caps.in b/components/soc/esp32c2/include/soc/Kconfig.soc_caps.in index 63a076c011..c8bdeb8aba 100644 --- a/components/soc/esp32c2/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32c2/include/soc/Kconfig.soc_caps.in @@ -11,6 +11,10 @@ config SOC_DEDICATED_GPIO_SUPPORTED bool default y +config SOC_UART_SUPPORTED + bool + default y + config SOC_GDMA_SUPPORTED bool default y diff --git a/components/soc/esp32c2/include/soc/soc_caps.h b/components/soc/esp32c2/include/soc/soc_caps.h index a7fdb1db60..e2baa10623 100644 --- a/components/soc/esp32c2/include/soc/soc_caps.h +++ b/components/soc/esp32c2/include/soc/soc_caps.h @@ -27,6 +27,7 @@ /*-------------------------- COMMON CAPS ---------------------------------------*/ #define SOC_ADC_SUPPORTED 1 #define SOC_DEDICATED_GPIO_SUPPORTED 1 +#define SOC_UART_SUPPORTED 1 #define SOC_GDMA_SUPPORTED 1 #define SOC_GPTIMER_SUPPORTED 1 #define SOC_BT_SUPPORTED 1 diff --git a/components/soc/esp32c3/include/soc/Kconfig.soc_caps.in b/components/soc/esp32c3/include/soc/Kconfig.soc_caps.in index ec92b0171e..8befab9582 100644 --- a/components/soc/esp32c3/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32c3/include/soc/Kconfig.soc_caps.in @@ -11,6 +11,10 @@ config SOC_DEDICATED_GPIO_SUPPORTED bool default y +config SOC_UART_SUPPORTED + bool + default y + config SOC_GDMA_SUPPORTED bool default y diff --git a/components/soc/esp32c3/include/soc/soc_caps.h b/components/soc/esp32c3/include/soc/soc_caps.h index eb5d1ef03e..32c29d55e0 100644 --- a/components/soc/esp32c3/include/soc/soc_caps.h +++ b/components/soc/esp32c3/include/soc/soc_caps.h @@ -27,6 +27,7 @@ /*-------------------------- COMMON CAPS ---------------------------------------*/ #define SOC_ADC_SUPPORTED 1 #define SOC_DEDICATED_GPIO_SUPPORTED 1 +#define SOC_UART_SUPPORTED 1 #define SOC_GDMA_SUPPORTED 1 #define SOC_GPTIMER_SUPPORTED 1 #define SOC_TWAI_SUPPORTED 1 diff --git a/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in b/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in index c7781b8e8d..4c65c92976 100644 --- a/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in @@ -11,6 +11,10 @@ config SOC_DEDICATED_GPIO_SUPPORTED bool default y +config SOC_UART_SUPPORTED + bool + default y + config SOC_GDMA_SUPPORTED bool default y diff --git a/components/soc/esp32c6/include/soc/soc_caps.h b/components/soc/esp32c6/include/soc/soc_caps.h index d1dd2a4cd9..a4cb0720ac 100644 --- a/components/soc/esp32c6/include/soc/soc_caps.h +++ b/components/soc/esp32c6/include/soc/soc_caps.h @@ -27,6 +27,7 @@ /*-------------------------- COMMON CAPS ---------------------------------------*/ #define SOC_ADC_SUPPORTED 1 #define SOC_DEDICATED_GPIO_SUPPORTED 1 +#define SOC_UART_SUPPORTED 1 #define SOC_GDMA_SUPPORTED 1 #define SOC_GPTIMER_SUPPORTED 1 #define SOC_PCNT_SUPPORTED 1 diff --git a/components/soc/esp32h2/include/soc/Kconfig.soc_caps.in b/components/soc/esp32h2/include/soc/Kconfig.soc_caps.in index af214b680b..646ed4ec1a 100644 --- a/components/soc/esp32h2/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32h2/include/soc/Kconfig.soc_caps.in @@ -3,6 +3,10 @@ # using gen_soc_caps_kconfig.py, do not edit manually ##################################################### +config SOC_UART_SUPPORTED + bool + default y + config SOC_GDMA_SUPPORTED bool default y diff --git a/components/soc/esp32h2/include/soc/soc_caps.h b/components/soc/esp32h2/include/soc/soc_caps.h index 73f6d15a5b..4fbce986ec 100644 --- a/components/soc/esp32h2/include/soc/soc_caps.h +++ b/components/soc/esp32h2/include/soc/soc_caps.h @@ -27,6 +27,7 @@ /*-------------------------- COMMON CAPS ---------------------------------------*/ // #define SOC_ADC_SUPPORTED 1 // TODO: IDF-6214 // #define SOC_DEDICATED_GPIO_SUPPORTED 1 // TODO: IDF-6241 +#define SOC_UART_SUPPORTED 1 #define SOC_GDMA_SUPPORTED 1 #define SOC_ASYNC_MEMCPY_SUPPORTED 1 #define SOC_PCNT_SUPPORTED 1 diff --git a/components/soc/esp32h4/include/soc/Kconfig.soc_caps.in b/components/soc/esp32h4/include/soc/Kconfig.soc_caps.in index 42a39983f9..a09386b646 100644 --- a/components/soc/esp32h4/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32h4/include/soc/Kconfig.soc_caps.in @@ -11,6 +11,10 @@ config SOC_DEDICATED_GPIO_SUPPORTED bool default y +config SOC_UART_SUPPORTED + bool + default y + config SOC_GDMA_SUPPORTED bool default y diff --git a/components/soc/esp32h4/include/soc/soc_caps.h b/components/soc/esp32h4/include/soc/soc_caps.h index 735093c2ef..0f4d3b1ec3 100644 --- a/components/soc/esp32h4/include/soc/soc_caps.h +++ b/components/soc/esp32h4/include/soc/soc_caps.h @@ -35,6 +35,7 @@ /*-------------------------- COMMON CAPS ---------------------------------------*/ #define SOC_ADC_SUPPORTED 1 #define SOC_DEDICATED_GPIO_SUPPORTED 1 +#define SOC_UART_SUPPORTED 1 #define SOC_GDMA_SUPPORTED 1 #define SOC_GPTIMER_SUPPORTED 1 #define SOC_BT_SUPPORTED 1 diff --git a/components/soc/esp32s2/include/soc/Kconfig.soc_caps.in b/components/soc/esp32s2/include/soc/Kconfig.soc_caps.in index fc7d0175c0..eb3d012485 100644 --- a/components/soc/esp32s2/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32s2/include/soc/Kconfig.soc_caps.in @@ -11,6 +11,10 @@ config SOC_DAC_SUPPORTED bool default y +config SOC_UART_SUPPORTED + bool + default y + config SOC_TWAI_SUPPORTED bool default y diff --git a/components/soc/esp32s2/include/soc/soc_caps.h b/components/soc/esp32s2/include/soc/soc_caps.h index 2f89ba8101..e86100526f 100644 --- a/components/soc/esp32s2/include/soc/soc_caps.h +++ b/components/soc/esp32s2/include/soc/soc_caps.h @@ -41,6 +41,7 @@ /*-------------------------- COMMON CAPS ---------------------------------------*/ #define SOC_ADC_SUPPORTED 1 #define SOC_DAC_SUPPORTED 1 +#define SOC_UART_SUPPORTED 1 #define SOC_TWAI_SUPPORTED 1 #define SOC_CP_DMA_SUPPORTED 1 #define SOC_DEDICATED_GPIO_SUPPORTED 1 diff --git a/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in b/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in index f145a7e9ec..165f2b9b5c 100644 --- a/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32s3/include/soc/Kconfig.soc_caps.in @@ -27,6 +27,10 @@ config SOC_ADC_SUPPORTED bool default y +config SOC_UART_SUPPORTED + bool + default y + config SOC_PCNT_SUPPORTED bool default y diff --git a/components/soc/esp32s3/include/soc/soc_caps.h b/components/soc/esp32s3/include/soc/soc_caps.h index a0af8c3e9d..d97429814f 100644 --- a/components/soc/esp32s3/include/soc/soc_caps.h +++ b/components/soc/esp32s3/include/soc/soc_caps.h @@ -26,6 +26,7 @@ /*-------------------------- COMMON CAPS ---------------------------------------*/ #define SOC_ADC_SUPPORTED 1 +#define SOC_UART_SUPPORTED 1 #define SOC_PCNT_SUPPORTED 1 #define SOC_WIFI_SUPPORTED 1 #define SOC_TWAI_SUPPORTED 1 diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index 0e8f57d89a..d48a77d466 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -61,52 +61,52 @@ INPUT = \ $(PROJECT_PATH)/components/bt/host/nimble/esp-hci/include/esp_nimble_hci.h \ $(PROJECT_PATH)/components/bt/include/esp32/include/esp_bt.h \ $(PROJECT_PATH)/components/console/esp_console.h \ - $(PROJECT_PATH)/components/driver/include/driver/dac_continuous.h \ - $(PROJECT_PATH)/components/driver/include/driver/dac_cosine.h \ - $(PROJECT_PATH)/components/driver/include/driver/dac_oneshot.h \ - $(PROJECT_PATH)/components/driver/include/driver/dac_types.h \ - $(PROJECT_PATH)/components/driver/include/driver/dedic_gpio.h \ - $(PROJECT_PATH)/components/driver/include/driver/gpio.h \ - $(PROJECT_PATH)/components/driver/include/driver/gpio_etm.h \ - $(PROJECT_PATH)/components/driver/include/driver/gpio_filter.h \ - $(PROJECT_PATH)/components/driver/include/driver/gptimer.h \ - $(PROJECT_PATH)/components/driver/include/driver/gptimer_etm.h \ - $(PROJECT_PATH)/components/driver/include/driver/gptimer_types.h \ - $(PROJECT_PATH)/components/driver/include/driver/i2c.h \ - $(PROJECT_PATH)/components/driver/include/driver/i2s_common.h \ - $(PROJECT_PATH)/components/driver/include/driver/i2s_pdm.h \ - $(PROJECT_PATH)/components/driver/include/driver/i2s_std.h \ - $(PROJECT_PATH)/components/driver/include/driver/i2s_tdm.h \ - $(PROJECT_PATH)/components/driver/include/driver/i2s_types.h \ - $(PROJECT_PATH)/components/driver/include/driver/ledc.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_cap.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_cmpr.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_fault.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_gen.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_oper.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_sync.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_timer.h \ - $(PROJECT_PATH)/components/driver/include/driver/mcpwm_types.h \ - $(PROJECT_PATH)/components/driver/include/driver/pulse_cnt.h \ - $(PROJECT_PATH)/components/driver/include/driver/rmt_common.h \ - $(PROJECT_PATH)/components/driver/include/driver/rmt_encoder.h \ - $(PROJECT_PATH)/components/driver/include/driver/rmt_rx.h \ - $(PROJECT_PATH)/components/driver/include/driver/rmt_tx.h \ - $(PROJECT_PATH)/components/driver/include/driver/rmt_types.h \ - $(PROJECT_PATH)/components/driver/include/driver/rtc_io.h \ - $(PROJECT_PATH)/components/driver/include/driver/sdio_slave.h \ - $(PROJECT_PATH)/components/driver/include/driver/sdm.h \ - $(PROJECT_PATH)/components/driver/include/driver/sdmmc_host.h \ - $(PROJECT_PATH)/components/driver/include/driver/sdmmc_types.h \ - $(PROJECT_PATH)/components/driver/include/driver/sdspi_host.h \ - $(PROJECT_PATH)/components/driver/include/driver/spi_common.h \ - $(PROJECT_PATH)/components/driver/include/driver/spi_master.h \ - $(PROJECT_PATH)/components/driver/include/driver/spi_slave_hd.h \ - $(PROJECT_PATH)/components/driver/include/driver/spi_slave.h \ - $(PROJECT_PATH)/components/driver/include/driver/temperature_sensor.h \ - $(PROJECT_PATH)/components/driver/include/driver/touch_sensor_common.h \ - $(PROJECT_PATH)/components/driver/include/driver/twai.h \ - $(PROJECT_PATH)/components/driver/include/driver/uart.h \ + $(PROJECT_PATH)/components/driver/dac/include/driver/dac_continuous.h \ + $(PROJECT_PATH)/components/driver/dac/include/driver/dac_cosine.h \ + $(PROJECT_PATH)/components/driver/dac/include/driver/dac_oneshot.h \ + $(PROJECT_PATH)/components/driver/dac/include/driver/dac_types.h \ + $(PROJECT_PATH)/components/driver/gpio/include/driver/dedic_gpio.h \ + $(PROJECT_PATH)/components/driver/gpio/include/driver/gpio.h \ + $(PROJECT_PATH)/components/driver/gpio/include/driver/gpio_etm.h \ + $(PROJECT_PATH)/components/driver/gpio/include/driver/gpio_filter.h \ + $(PROJECT_PATH)/components/driver/gpio/include/driver/rtc_io.h \ + $(PROJECT_PATH)/components/driver/gptimer/include/driver/gptimer.h \ + $(PROJECT_PATH)/components/driver/gptimer/include/driver/gptimer_etm.h \ + $(PROJECT_PATH)/components/driver/gptimer/include/driver/gptimer_types.h \ + $(PROJECT_PATH)/components/driver/i2c/include/driver/i2c.h \ + $(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_common.h \ + $(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_pdm.h \ + $(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_std.h \ + $(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_tdm.h \ + $(PROJECT_PATH)/components/driver/i2s/include/driver/i2s_types.h \ + $(PROJECT_PATH)/components/driver/ledc/include/driver/ledc.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_cap.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_cmpr.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_fault.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_gen.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_oper.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_sync.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_timer.h \ + $(PROJECT_PATH)/components/driver/mcpwm/include/driver/mcpwm_types.h \ + $(PROJECT_PATH)/components/driver/pcnt/include/driver/pulse_cnt.h \ + $(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_common.h \ + $(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_encoder.h \ + $(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_rx.h \ + $(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_tx.h \ + $(PROJECT_PATH)/components/driver/rmt/include/driver/rmt_types.h \ + $(PROJECT_PATH)/components/driver/sdio_slave/include/driver/sdio_slave.h \ + $(PROJECT_PATH)/components/driver/sigma_delta/include/driver/sdm.h \ + $(PROJECT_PATH)/components/driver/sdmmc/include/driver/sdmmc_host.h \ + $(PROJECT_PATH)/components/driver/sdmmc/include/driver/sdmmc_types.h \ + $(PROJECT_PATH)/components/driver/spi/include/driver/sdspi_host.h \ + $(PROJECT_PATH)/components/driver/spi/include/driver/spi_common.h \ + $(PROJECT_PATH)/components/driver/spi/include/driver/spi_master.h \ + $(PROJECT_PATH)/components/driver/spi/include/driver/spi_slave_hd.h \ + $(PROJECT_PATH)/components/driver/spi/include/driver/spi_slave.h \ + $(PROJECT_PATH)/components/driver/temperature_sensor/include/driver/temperature_sensor.h \ + $(PROJECT_PATH)/components/driver/touch_sensor/include/driver/touch_sensor_common.h \ + $(PROJECT_PATH)/components/driver/twai/include/driver/twai.h \ + $(PROJECT_PATH)/components/driver/uart/include/driver/uart.h \ $(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_sdio.h \ $(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl_spi.h \ $(PROJECT_PATH)/components/driver/test_apps/components/esp_serial_slave_link/include/esp_serial_slave_link/essl.h \ diff --git a/docs/doxygen/Doxyfile_esp32 b/docs/doxygen/Doxyfile_esp32 index b936c38e58..b0ee24c591 100644 --- a/docs/doxygen/Doxyfile_esp32 +++ b/docs/doxygen/Doxyfile_esp32 @@ -1,5 +1,5 @@ INPUT += \ - $(PROJECT_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \ + $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \ $(PROJECT_PATH)/components/esp_psram/include/esp32/himem.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \ diff --git a/docs/doxygen/Doxyfile_esp32s2 b/docs/doxygen/Doxyfile_esp32s2 index d39742c189..c2a49134a2 100644 --- a/docs/doxygen/Doxyfile_esp32s2 +++ b/docs/doxygen/Doxyfile_esp32s2 @@ -1,5 +1,5 @@ INPUT += \ - $(PROJECT_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \ + $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/dac_channel.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/rtc_io_channel.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ diff --git a/docs/doxygen/Doxyfile_esp32s3 b/docs/doxygen/Doxyfile_esp32s3 index 11eb02f9be..6177ef00be 100644 --- a/docs/doxygen/Doxyfile_esp32s3 +++ b/docs/doxygen/Doxyfile_esp32s3 @@ -1,5 +1,5 @@ INPUT += \ - $(PROJECT_PATH)/components/driver/$(IDF_TARGET)/include/driver/touch_sensor.h \ + $(PROJECT_PATH)/components/driver/touch_sensor/$(IDF_TARGET)/include/driver/touch_sensor.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/touch_sensor_channel.h \ $(PROJECT_PATH)/components/ulp/ulp_common/include/$(IDF_TARGET)/ulp_common_defs.h \ $(PROJECT_PATH)/components/ulp/ulp_fsm/include/$(IDF_TARGET)/ulp.h \ diff --git a/docs/en/api-guides/jtag-debugging/debugging-examples.rst b/docs/en/api-guides/jtag-debugging/debugging-examples.rst index 3390b20a6f..61fb3cf165 100644 --- a/docs/en/api-guides/jtag-debugging/debugging-examples.rst +++ b/docs/en/api-guides/jtag-debugging/debugging-examples.rst @@ -495,7 +495,7 @@ If you enter ``s`` instead, then debugger will step inside subroutine calls:: Target halted. PRO_CPU: PC=0x400DB74B (active) APP_CPU: PC=0x400D1128 Target halted. PRO_CPU: PC=0x400DC04C (active) APP_CPU: PC=0x400D1128 Target halted. PRO_CPU: PC=0x400DC04F (active) APP_CPU: PC=0x400D1128 - gpio_set_level (gpio_num=GPIO_NUM_4, level=0) at /home/user-name/esp/esp-idf/components/driver/./gpio.c:183 + gpio_set_level (gpio_num=GPIO_NUM_4, level=0) at /home/user-name/esp/esp-idf/components/driver/gpio/gpio.c:183 183 GPIO_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "GPIO output gpio_num error", ESP_ERR_INVALID_ARG); (gdb) diff --git a/docs/en/api-reference/peripherals/dac.rst b/docs/en/api-reference/peripherals/dac.rst index dd97f383d8..202e8882e2 100644 --- a/docs/en/api-reference/peripherals/dac.rst +++ b/docs/en/api-reference/peripherals/dac.rst @@ -137,5 +137,5 @@ API Reference .. include-build-file:: inc/dac_oneshot.inc .. include-build-file:: inc/dac_cosine.inc .. include-build-file:: inc/dac_continuous.inc -.. include-build-file:: inc/components/driver/include/driver/dac_types.inc +.. include-build-file:: inc/components/driver/dac/include/driver/dac_types.inc .. include-build-file:: inc/components/hal/include/hal/dac_types.inc diff --git a/docs/en/api-reference/peripherals/i2c.rst b/docs/en/api-reference/peripherals/i2c.rst index dca3d3a5f0..b53b153de3 100644 --- a/docs/en/api-reference/peripherals/i2c.rst +++ b/docs/en/api-reference/peripherals/i2c.rst @@ -366,7 +366,7 @@ All these parameters can be changed to user-defined values by calling dedicated Each of the above functions has a *_get_* counterpart to check the currently set value. For example, to check the I2C timeout value, call :cpp:func:`i2c_get_timeout`. -To check the default parameter values which are set during the driver configuration process, please refer to the file :component_file:`driver/i2c.c` and look for defines with the suffix ``_DEFAULT``. +To check the default parameter values which are set during the driver configuration process, please refer to the file :component_file:`driver/i2c/i2c.c` and look for defines with the suffix ``_DEFAULT``. You can also select different pins for SDA and SCL signals and alter the configuration of pull-ups with the function :cpp:func:`i2c_set_pin`. If you want to modify already entered values, use the function :cpp:func:`i2c_param_config`. @@ -380,7 +380,7 @@ You can also select different pins for SDA and SCL signals and alter the configu Error Handling ^^^^^^^^^^^^^^ -The majority of I2C driver functions either return ``ESP_OK`` on successful completion or a specific error code on failure. It is a good practice to always check the returned values and implement error handling. The driver also prints out log messages that contain error details, e.g., when checking the validity of entered configuration. For details please refer to the file :component_file:`driver/i2c.c` and look for defines with the suffix ``_ERR_STR``. +The majority of I2C driver functions either return ``ESP_OK`` on successful completion or a specific error code on failure. It is a good practice to always check the returned values and implement error handling. The driver also prints out log messages that contain error details, e.g., when checking the validity of entered configuration. For details please refer to the file :component_file:`driver/i2c/i2c.c` and look for defines with the suffix ``_ERR_STR``. Use dedicated interrupts to capture communication failures. For instance, if a slave stretches the clock for too long while preparing the data to send back to master, the interrupt ``I2C_TIME_OUT_INT`` will be triggered. For detailed information, see :ref:`i2c-api-interrupt-handling`. diff --git a/docs/en/api-reference/peripherals/i2s.rst b/docs/en/api-reference/peripherals/i2s.rst index 61eaa67160..dffb906c42 100644 --- a/docs/en/api-reference/peripherals/i2s.rst +++ b/docs/en/api-reference/peripherals/i2s.rst @@ -291,7 +291,7 @@ The clock config helper macro is: - :c:macro:`I2S_STD_CLK_DEFAULT_CONFIG` Please refer to :ref:`i2s-api-reference-i2s_std` for STD API information. -And for more details, please refer to :component_file:`driver/include/driver/i2s_std.h`. +And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_std.h`. STD TX Mode ~~~~~~~~~~~ @@ -548,7 +548,7 @@ Here is the table of the data that received in the buffer with different :cpp:me - :c:macro:`I2S_PDM_TX_CLK_DEFAULT_CONFIG` Please refer to :ref:`i2s-api-reference-i2s_pdm` for PDM TX API information. - And for more details, please refer to :component_file:`driver/include/driver/i2s_pdm.h`. + And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_pdm.h`. The PDM data width is fixed to 16-bit, when the data in a ``int16_t`` writing buffer are: @@ -645,7 +645,7 @@ Here is the table of the data that received in the buffer with different :cpp:me - :c:macro:`I2S_PDM_RX_CLK_DEFAULT_CONFIG` Please refer to :ref:`i2s-api-reference-i2s_pdm` for PDM RX API information. - And for more details, please refer to :component_file:`driver/include/driver/i2s_pdm.h`. + And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_pdm.h`. The PDM data width is fixed to 16-bit, when the data on the line (The PDM format on the line is transferred to PCM format for easier comprehension) are: @@ -732,7 +732,7 @@ Here is the table of the data that received in the buffer with different :cpp:me - :c:macro:`I2S_TDM_CLK_DEFAULT_CONFIG` Please refer to :ref:`i2s-api-reference-i2s_tdm` for TDM API information. - And for more details, please refer to :component_file:`driver/include/driver/i2s_tdm.h`. + And for more details, please refer to :component_file:`driver/i2s/include/driver/i2s_tdm.h`. .. note:: @@ -1069,5 +1069,5 @@ I2S Driver I2S Types ^^^^^^^^^ -.. include-build-file:: inc/components/driver/include/driver/i2s_types.inc +.. include-build-file:: inc/components/driver/i2s/include/driver/i2s_types.inc .. include-build-file:: inc/components/hal/include/hal/i2s_types.inc diff --git a/docs/en/api-reference/peripherals/mcpwm.rst b/docs/en/api-reference/peripherals/mcpwm.rst index 01aafe6632..131e95da2d 100644 --- a/docs/en/api-reference/peripherals/mcpwm.rst +++ b/docs/en/api-reference/peripherals/mcpwm.rst @@ -881,7 +881,7 @@ API Reference .. include-build-file:: inc/mcpwm_fault.inc .. include-build-file:: inc/mcpwm_sync.inc .. include-build-file:: inc/mcpwm_cap.inc -.. include-build-file:: inc/components/driver/include/driver/mcpwm_types.inc +.. include-build-file:: inc/components/driver/mcpwm/include/driver/mcpwm_types.inc .. include-build-file:: inc/components/hal/include/hal/mcpwm_types.inc diff --git a/docs/en/api-reference/peripherals/rmt.rst b/docs/en/api-reference/peripherals/rmt.rst index df2dd1b67f..86379d32b0 100644 --- a/docs/en/api-reference/peripherals/rmt.rst +++ b/docs/en/api-reference/peripherals/rmt.rst @@ -527,7 +527,7 @@ API Reference .. include-build-file:: inc/rmt_rx.inc .. include-build-file:: inc/rmt_common.inc .. include-build-file:: inc/rmt_encoder.inc -.. include-build-file:: inc/components/driver/include/driver/rmt_types.inc +.. include-build-file:: inc/components/driver/rmt/include/driver/rmt_types.inc .. include-build-file:: inc/components/hal/include/hal/rmt_types.inc diff --git a/docs/en/api-reference/storage/sdmmc.rst b/docs/en/api-reference/storage/sdmmc.rst index e901291063..722aee845d 100644 --- a/docs/en/api-reference/storage/sdmmc.rst +++ b/docs/en/api-reference/storage/sdmmc.rst @@ -8,7 +8,7 @@ Overview The SD/SDIO/MMC driver currently supports SD memory, SDIO cards, and eMMC chips. This is a protocol level driver built on top of SDMMC and SD SPI host drivers. -SDMMC and SD SPI host drivers (:component_file:`driver/include/driver/sdmmc_host.h` and :component_file:`driver/include/driver/sdspi_host.h`) provide API functions for: +SDMMC and SD SPI host drivers (:component_file:`driver/sdmmc/include/driver/sdmmc_host.h` and :component_file:`driver/spi/include/driver/sdspi_host.h`) provide API functions for: - Sending commands to slave devices - Sending and receiving data diff --git a/docs/en/contribute/documenting-code.rst b/docs/en/contribute/documenting-code.rst index 1276baa3ac..4e9f0c1325 100644 --- a/docs/en/contribute/documenting-code.rst +++ b/docs/en/contribute/documenting-code.rst @@ -123,7 +123,7 @@ When writing codes, please follow the guidelines below: For practical example see :component_file:`nvs_flash/include/nvs.h`. -4. You may want to go even further and skip some code like repetitive defines or enumerations. In such case, enclose the code within ``/** @cond */`` and ``/** @endcond */`` commands. Example of such implementation is provided in :component_file:`driver/include/driver/gpio.h`. +4. You may want to go even further and skip some code like repetitive defines or enumerations. In such case, enclose the code within ``/** @cond */`` and ``/** @endcond */`` commands. Example of such implementation is provided in :component_file:`driver/gpio/include/driver/gpio.h`. 5. Use markdown to make your documentation even more readable. You will add headers, links, tables and more. :: diff --git a/docs/en/migration-guides/release-5.x/5.0/peripherals.rst b/docs/en/migration-guides/release-5.x/5.0/peripherals.rst index 75fc3cb8ed..352550fc49 100644 --- a/docs/en/migration-guides/release-5.x/5.0/peripherals.rst +++ b/docs/en/migration-guides/release-5.x/5.0/peripherals.rst @@ -455,7 +455,7 @@ LCD I2S driver ---------- - The I2S driver has been redesigned (see :doc:`I2S Driver <../../../api-reference/peripherals/i2s>`), which aims to rectify the shortcomings of the driver that were exposed when supporting all the new features of ESP32-C3 & ESP32-S3. The new driver's APIs are available by including corresponding I2S mode's header files :component_file:`driver/include/driver/i2s_std.h`, :component_file:`driver/include/driver/i2s_pdm.h`, or :component_file:`driver/include/driver/i2s_tdm.h`. + The I2S driver has been redesigned (see :doc:`I2S Driver <../../../api-reference/peripherals/i2s>`), which aims to rectify the shortcomings of the driver that were exposed when supporting all the new features of ESP32-C3 & ESP32-S3. The new driver's APIs are available by including corresponding I2S mode's header files :component_file:`driver/i2s/include/driver/i2s_std.h`, :component_file:`driver/i2s/include/driver/i2s_pdm.h`, or :component_file:`driver/i2s/include/driver/i2s_tdm.h`. Meanwhile, the old driver's APIs in :component_file:`driver/deprecated/driver/i2s.h` are still supported for backward compatibility. But there will be warnings if users keep using the old APIs in their projects, these warnings can be suppressed by the Kconfig option :ref:`CONFIG_I2S_SUPPRESS_DEPRECATE_WARN`. @@ -485,9 +485,9 @@ LCD I2S communication modes are categorized into the following three modes. Note that: - - **Standard mode**: Standard mode always has two slots, it can support Philips, MSB, and PCM (short frame sync) formats. Please refer to :component_file:`driver/include/driver/i2s_std.h` for more details. - - **PDM mode**: PDM mode only supports two slots with 16-bit data width, but the configurations of PDM TX and PDM RX are slightly different. For PDM TX, the sample rate can be set by :cpp:member:`i2s_pdm_tx_clk_config_t::sample_rate`, and its clock frequency depends on the up-sampling configuration. For PDM RX, the sample rate can be set by :cpp:member:`i2s_pdm_rx_clk_config_t::sample_rate`, and its clock frequency depends on the down-sampling configuration. Please refer to :component_file:`driver/include/driver/i2s_pdm.h` for details. - - **TDM mode**: TDM mode can support up to 16 slots. It can work in Philips, MSB, PCM (short frame sync), and PCM (long frame sync) formats. Please refer to :component_file:`driver/include/driver/i2s_tdm.h` for details. + - **Standard mode**: Standard mode always has two slots, it can support Philips, MSB, and PCM (short frame sync) formats. Please refer to :component_file:`driver/i2s/include/driver/i2s_std.h` for more details. + - **PDM mode**: PDM mode only supports two slots with 16-bit data width, but the configurations of PDM TX and PDM RX are slightly different. For PDM TX, the sample rate can be set by :cpp:member:`i2s_pdm_tx_clk_config_t::sample_rate`, and its clock frequency depends on the up-sampling configuration. For PDM RX, the sample rate can be set by :cpp:member:`i2s_pdm_rx_clk_config_t::sample_rate`, and its clock frequency depends on the down-sampling configuration. Please refer to :component_file:`driver/i2s/include/driver/i2s_pdm.h` for details. + - **TDM mode**: TDM mode can support up to 16 slots. It can work in Philips, MSB, PCM (short frame sync), and PCM (long frame sync) formats. Please refer to :component_file:`driver/i2s/include/driver/i2s_tdm.h` for details. When allocating a new channel in a specific mode, users should initialize that channel by its corresponding function. It is strongly recommended to use the helper macros to generate the default configurations in case the default values are changed in the future. diff --git a/docs/zh_CN/api-guides/jtag-debugging/debugging-examples.rst b/docs/zh_CN/api-guides/jtag-debugging/debugging-examples.rst index 3a6fb757a7..68993c9216 100644 --- a/docs/zh_CN/api-guides/jtag-debugging/debugging-examples.rst +++ b/docs/zh_CN/api-guides/jtag-debugging/debugging-examples.rst @@ -495,7 +495,7 @@ Target halted. PRO_CPU: PC=0x400DB74B (active) APP_CPU: PC=0x400D1128 Target halted. PRO_CPU: PC=0x400DC04C (active) APP_CPU: PC=0x400D1128 Target halted. PRO_CPU: PC=0x400DC04F (active) APP_CPU: PC=0x400D1128 - gpio_set_level (gpio_num=GPIO_NUM_4, level=0) at /home/user-name/esp/esp-idf/components/driver/./gpio.c:183 + gpio_set_level (gpio_num=GPIO_NUM_4, level=0) at /home/user-name/esp/esp-idf/components/driver/gpio/gpio.c:183 183 GPIO_CHECK(GPIO_IS_VALID_OUTPUT_GPIO(gpio_num), "GPIO output gpio_num error", ESP_ERR_INVALID_ARG); (gdb) diff --git a/docs/zh_CN/api-reference/peripherals/i2c.rst b/docs/zh_CN/api-reference/peripherals/i2c.rst index 17d770c968..e5b1f507cf 100644 --- a/docs/zh_CN/api-reference/peripherals/i2c.rst +++ b/docs/zh_CN/api-reference/peripherals/i2c.rst @@ -366,7 +366,7 @@ I2C 驱动程序管理在 I2C 总线上设备的通信,该驱动程序具备 上述每个函数都有一个 *_get_* 对应项来检查当前设置的值。例如,调用 :cpp:func:`i2c_get_timeout` 来检查 I2C 超时值。 -要检查在驱动程序配置过程中设置的参数默认值,请参考文件 :component_file:`driver/i2c.c` 并查找带有后缀 ``_DEFAULT`` 的定义。 +要检查在驱动程序配置过程中设置的参数默认值,请参考文件 :component_file:`driver/i2c/i2c.c` 并查找带有后缀 ``_DEFAULT`` 的定义。 通过函数 :cpp:func:`i2c_set_pin` 可以为 SDA 和 SCL 信号选择不同的管脚并改变上拉配置。如果要修改已经输入的值,请使用函数 :cpp:func:`i2c_param_config`。 @@ -380,7 +380,7 @@ I2C 驱动程序管理在 I2C 总线上设备的通信,该驱动程序具备 错误处理 ^^^^^^^^^^ -大多数 I2C 驱动程序的函数在成功完成时会返回 ``ESP_OK`` ,或在失败时会返回特定的错误代码。实时检查返回的值并进行错误处理是一种好习惯。驱动程序也会打印日志消息,其中包含错误说明,例如检查输入配置的正确性。有关详细信息,请参考文件 :component_file:`driver/i2c.c` 并用后缀 ``_ERR_STR`` 查找定义。 +大多数 I2C 驱动程序的函数在成功完成时会返回 ``ESP_OK`` ,或在失败时会返回特定的错误代码。实时检查返回的值并进行错误处理是一种好习惯。驱动程序也会打印日志消息,其中包含错误说明,例如检查输入配置的正确性。有关详细信息,请参考文件 :component_file:`driver/i2c/i2c.c` 并用后缀 ``_ERR_STR`` 查找定义。 使用专用中断来捕获通信故障。例如,如果从机将数据发送回主机耗费太长时间,会触发 ``I2C_TIME_OUT_INT`` 中断。详细信息请参考 :ref:`i2c-api-interrupt-handling`。 diff --git a/docs/zh_CN/api-reference/storage/sdmmc.rst b/docs/zh_CN/api-reference/storage/sdmmc.rst index 416a28a5ae..211a78d723 100644 --- a/docs/zh_CN/api-reference/storage/sdmmc.rst +++ b/docs/zh_CN/api-reference/storage/sdmmc.rst @@ -8,7 +8,7 @@ SD/SDIO/MMC 驱动程序 SD/SDIO/MMC 驱动是一种基于 SDMMC 和 SD SPI 主机驱动的协议级驱动程序,目前已支持 SD 存储器、SDIO 卡和 eMMC 芯片。 -SDMMC 主机驱动和 SD SPI 主机驱动(:component_file:`driver/include/driver/sdmmc_host.h` 和 :component_file:`driver/include/driver/sdspi_host.h`)为以下功能提供 API: +SDMMC 主机驱动和 SD SPI 主机驱动(:component_file:`driver/sdmmc/include/driver/sdmmc_host.h` 和 :component_file:`driver/spi/include/driver/sdspi_host.h`)为以下功能提供 API: - 发送命令至从设备 - 接收和发送数据 diff --git a/docs/zh_CN/migration-guides/release-5.x/5.0/peripherals.rst b/docs/zh_CN/migration-guides/release-5.x/5.0/peripherals.rst index ed3569de68..837a2cc9b6 100644 --- a/docs/zh_CN/migration-guides/release-5.x/5.0/peripherals.rst +++ b/docs/zh_CN/migration-guides/release-5.x/5.0/peripherals.rst @@ -455,7 +455,7 @@ LCD I2S 驱动 ----------------------- - 旧版 I2S 驱动在支持 ESP32-C3 和 ESP32-S3 新功能时暴露了很多缺点,为解决这些缺点,I2S 驱动已更新(请参考:doc:`I2S Driver <../../../api-reference/peripherals/i2s>`)。用户可以通过引用不同 I2S 模式对应的头文件来使用新版驱动的 API,如 :component_file:`driver/include/driver/i2s_std.h`, :component_file:`driver/include/driver/i2s_pdm.h` 以及 :component_file:`driver/include/driver/i2s_tdm.h`。 + 旧版 I2S 驱动在支持 ESP32-C3 和 ESP32-S3 新功能时暴露了很多缺点,为解决这些缺点,I2S 驱动已更新(请参考:doc:`I2S Driver <../../../api-reference/peripherals/i2s>`)。用户可以通过引用不同 I2S 模式对应的头文件来使用新版驱动的 API,如 :component_file:`driver/i2s/include/driver/i2s_std.h`, :component_file:`driver/i2s/include/driver/i2s_pdm.h` 以及 :component_file:`driver/i2s/include/driver/i2s_tdm.h`。 为保证前向兼容,旧版驱动的 API 仍然在 :component_file:`driver/deprecated/driver/i2s.h` 中可用。但使用旧版 API 会触发编译警告,该警告可通过配置 Kconfig 选项 :ref:`CONFIG_I2S_SUPPRESS_DEPRECATE_WARN` 来关闭。 @@ -485,9 +485,9 @@ LCD I2S 通信模式包括以下三种模式,请注意: - - **标准模式**:标准模式通常包括两个声道,支持 Philips,MSB 和 PCM(短帧同步)格式,详见 :component_file:`driver/include/driver/i2s_std.h`。 - - **PDM模式**:PDM 模式仅支持两个声道,16 bit 数据位宽,但是 PDM TX 和 PDM RX 的配置略有不同。对于 PDM TX,采样率可通过 :cpp:member:`i2s_pdm_tx_clk_config_t::sample_rate` 进行设置,其时钟频率取决于上采样的配置。对于 PDM RX,采样率可通过 :cpp:member:`i2s_pdm_rx_clk_config_t::sample_rate` 进行设置,其时钟频率取决于下采样的配置,详见 :component_file:`driver/include/driver/i2s_pdm.h`。 - - **TDM 模式**:TDM 模式可支持高达 16 声道,该模式可工作在 Philips,MSB,PCM(短帧同步)和PCM(长帧同步)格式下,详见 :component_file:`driver/include/driver/i2s_tdm.h`。 + - **标准模式**:标准模式通常包括两个声道,支持 Philips,MSB 和 PCM(短帧同步)格式,详见 :component_file:`driver/i2s/include/driver/i2s_std.h`。 + - **PDM模式**:PDM 模式仅支持两个声道,16 bit 数据位宽,但是 PDM TX 和 PDM RX 的配置略有不同。对于 PDM TX,采样率可通过 :cpp:member:`i2s_pdm_tx_clk_config_t::sample_rate` 进行设置,其时钟频率取决于上采样的配置。对于 PDM RX,采样率可通过 :cpp:member:`i2s_pdm_rx_clk_config_t::sample_rate` 进行设置,其时钟频率取决于下采样的配置,详见 :component_file:`driver/i2s/include/driver/i2s_pdm.h`。 + - **TDM 模式**:TDM 模式可支持高达 16 声道,该模式可工作在 Philips,MSB,PCM(短帧同步)和PCM(长帧同步)格式下,详见 :component_file:`driver/i2s/include/driver/i2s_tdm.h`。 在某个模式下分配新通道时,必须通过相应的函数初始化这个通道。我们强烈建议使用辅助宏来生成默认配置,以避免默认值被改动。 diff --git a/tools/ci/check_copyright_config.yaml b/tools/ci/check_copyright_config.yaml index 947efe9651..1432a2662a 100644 --- a/tools/ci/check_copyright_config.yaml +++ b/tools/ci/check_copyright_config.yaml @@ -121,7 +121,7 @@ spiffs: sdmmc: include: - - 'components/driver/include/driver/' + - 'components/driver/sdmmc/include/driver/' - 'components/sdmmc/' allowed_licenses: - Apache-2.0