From af61a3e6b64b08179c12036b6ab621dfeaf7d2a5 Mon Sep 17 00:00:00 2001 From: armando Date: Mon, 22 Dec 2025 18:20:00 +0800 Subject: [PATCH] fix(sdmmc): fixed header structure not shown in doc issue --- docs/doxygen/Doxyfile | 4 ++++ docs/doxygen/Doxyfile_esp32p4 | 2 -- docs/en/api-reference/peripherals/sdmmc_host.rst | 8 ++++++-- docs/en/api-reference/storage/sdmmc.rst | 2 ++ docs/zh_CN/api-reference/peripherals/sdmmc_host.rst | 8 ++++++-- docs/zh_CN/api-reference/storage/sdmmc.rst | 2 ++ 6 files changed, 20 insertions(+), 6 deletions(-) diff --git a/docs/doxygen/Doxyfile b/docs/doxygen/Doxyfile index a81b73bb74..ebf51a92b2 100644 --- a/docs/doxygen/Doxyfile +++ b/docs/doxygen/Doxyfile @@ -271,6 +271,7 @@ INPUT = \ $(PROJECT_PATH)/components/hal/include/hal/efuse_hal.h \ $(PROJECT_PATH)/components/hal/include/hal/eth_types.h \ $(PROJECT_PATH)/components/hal/include/hal/lp_core_types.h \ + $(PROJECT_PATH)/components/hal/include/hal/sd_types.h \ $(PROJECT_PATH)/components/hal/include/hal/uhci_types.h \ $(PROJECT_PATH)/components/heap/include/esp_heap_caps_init.h \ $(PROJECT_PATH)/components/heap/include/esp_heap_caps.h \ @@ -310,6 +311,9 @@ INPUT = \ $(PROJECT_PATH)/components/protocomm/include/transports/protocomm_httpd.h \ $(PROJECT_PATH)/components/protocomm/include/crypto/srp6a/esp_srp.h \ $(PROJECT_PATH)/components/pthread/include/esp_pthread.h \ + $(PROJECT_PATH)/components/sdmmc/include/sd_protocol_types.h \ + $(PROJECT_PATH)/components/sdmmc/include/sd_pwr_ctrl.h \ + $(PROJECT_PATH)/components/sdmmc/include/sd_pwr_ctrl_by_on_chip_ldo.h \ $(PROJECT_PATH)/components/sdmmc/include/sdmmc_cmd.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/adc_channel.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/clk_tree_defs.h \ diff --git a/docs/doxygen/Doxyfile_esp32p4 b/docs/doxygen/Doxyfile_esp32p4 index bf64bf8cb7..7e3d14a9fd 100644 --- a/docs/doxygen/Doxyfile_esp32p4 +++ b/docs/doxygen/Doxyfile_esp32p4 @@ -55,6 +55,4 @@ INPUT += \ $(PROJECT_PATH)/components/esp_lcd/dsi/include/esp_lcd_mipi_dsi.h \ $(PROJECT_PATH)/components/esp_lcd/rgb/include/esp_lcd_panel_rgb.h \ $(PROJECT_PATH)/components/soc/$(IDF_TARGET)/include/soc/bitscrambler_peri_select.h \ - $(PROJECT_PATH)/components/sdmmc/include/sd_pwr_ctrl.h \ - $(PROJECT_PATH)/components/sdmmc/include/sd_pwr_ctrl_by_on_chip_ldo.h \ $(PROJECT_PATH)/components/ulp/lp_core/shared/include/ulp_lp_core_lp_uart_shared.h \ diff --git a/docs/en/api-reference/peripherals/sdmmc_host.rst b/docs/en/api-reference/peripherals/sdmmc_host.rst index 64160b824a..76ea45e2df 100644 --- a/docs/en/api-reference/peripherals/sdmmc_host.rst +++ b/docs/en/api-reference/peripherals/sdmmc_host.rst @@ -176,8 +176,8 @@ To configure the bus width, set the ``width`` field of :cpp:class:`sdmmc_slot_co If the design does require higher speed SD modes (which only work at 1.8V IO levels), there are two options available: - - Use the on-chip programmable LDO. In this case, connect the desired LDO output channel to VDDPST_5 (SD_VREF) pin. Call :cpp:func:`sd_pwr_ctrl_new_on_chip_ldo` to initialize the SD power control driver, then set :cpp:class:`sdmmc_host_t::pwr_ctrl_handle` to the resulting handle. - - Use an external programmable LDO. Likewise, connect the LDO output to the VDDPST_5 (SD_VREF) pin. Then implement a custom `sd_pwr_ctrl` driver to control your LDO. Finally, assign :cpp:class:`sdmmc_host_t::pwr_ctrl_handle` to the handle of your driver instance. + - Use the on-chip programmable LDO. In this case, connect the desired LDO output channel to VDDPST_5 (SD_VREF) pin. Call :cpp:func:`sd_pwr_ctrl_new_on_chip_ldo` to initialize the SD power control driver, then set :cpp:member:`sdmmc_host_t::pwr_ctrl_handle` to the resulting handle. + - Use an external programmable LDO. Likewise, connect the LDO output to the VDDPST_5 (SD_VREF) pin. Then implement a custom `sd_pwr_ctrl` driver to control your LDO. Finally, assign :cpp:member:`sdmmc_host_t::pwr_ctrl_handle` to the handle of your driver instance. DDR Mode for eMMC Chips @@ -209,3 +209,7 @@ API Reference ------------- .. include-build-file:: inc/sdmmc_host.inc + +.. include-build-file:: inc/sd_pwr_ctrl.inc + +.. include-build-file:: inc/sd_pwr_ctrl_by_on_chip_ldo.inc diff --git a/docs/en/api-reference/storage/sdmmc.rst b/docs/en/api-reference/storage/sdmmc.rst index f90ba43625..1902d072fe 100644 --- a/docs/en/api-reference/storage/sdmmc.rst +++ b/docs/en/api-reference/storage/sdmmc.rst @@ -130,4 +130,6 @@ API Reference .. include-build-file:: inc/sdmmc_cmd.inc +.. include-build-file:: inc/sd_protocol_types.inc + .. include-build-file:: inc/sdmmc_types.inc diff --git a/docs/zh_CN/api-reference/peripherals/sdmmc_host.rst b/docs/zh_CN/api-reference/peripherals/sdmmc_host.rst index 53e81d8ab7..4fcf9a5b29 100644 --- a/docs/zh_CN/api-reference/peripherals/sdmmc_host.rst +++ b/docs/zh_CN/api-reference/peripherals/sdmmc_host.rst @@ -176,8 +176,8 @@ SDMMC 主机驱动支持以下速率模式： 如果设计需要更高速度的 SD 模式（仅在 1.8 V IO 电平下工作），则有两种可选方案： - - 使用片上可编程 LDO。将所需的 LDO 输出通道连接到 VDDPST_5 (SD_VREF) 管脚上，并调用 :cpp:func:`sd_pwr_ctrl_new_on_chip_ldo` 来初始化 SD 电源控制驱动。最后，将 :cpp:class:`sdmmc_host_t::pwr_ctl_handle` 设置为生成句柄。 - - 使用外部可编程 LDO。同样，将 LDO 输出连接到 VDDPST_5 (SD_VREF) 管脚，并自定义 `sd_pwr_ctrl` 驱动程序来控制 LDO。最后，将 :cpp:class:`sdmmc_host_t::pwr_ctrl_handle` 分配给驱动程序实例句柄。 + - 使用片上可编程 LDO。将所需的 LDO 输出通道连接到 VDDPST_5 (SD_VREF) 管脚上，并调用 :cpp:func:`sd_pwr_ctrl_new_on_chip_ldo` 来初始化 SD 电源控制驱动。最后，将 :cpp:member:`sdmmc_host_t::pwr_ctl_handle` 设置为生成句柄。 + - 使用外部可编程 LDO。同样，将 LDO 输出连接到 VDDPST_5 (SD_VREF) 管脚，并自定义 `sd_pwr_ctrl` 驱动程序来控制 LDO。最后，将 :cpp:member:`sdmmc_host_t::pwr_ctrl_handle` 分配给驱动程序实例句柄。 eMMC 芯片的 DDR 模式 @@ -209,3 +209,7 @@ API 参考 ------------- .. include-build-file:: inc/sdmmc_host.inc + +.. include-build-file:: inc/sd_pwr_ctrl.inc + +.. include-build-file:: inc/sd_pwr_ctrl_by_on_chip_ldo.inc diff --git a/docs/zh_CN/api-reference/storage/sdmmc.rst b/docs/zh_CN/api-reference/storage/sdmmc.rst index fa23ff479a..7d4d7b5fcf 100644 --- a/docs/zh_CN/api-reference/storage/sdmmc.rst +++ b/docs/zh_CN/api-reference/storage/sdmmc.rst @@ -130,4 +130,6 @@ API 参考 .. include-build-file:: inc/sdmmc_cmd.inc +.. include-build-file:: inc/sd_protocol_types.inc + .. include-build-file:: inc/sdmmc_types.inc