From 30a050e9ae2cd4aadfc1ed87530d40642f6ba2cf Mon Sep 17 00:00:00 2001 From: Alex Bethel Date: Sat, 14 Dec 2024 13:01:08 -0700 Subject: [PATCH] docs: Fix `gpio_dump_io_configuration` typo in docs The mentioned `gpio_dump_all_io_configuration` function doesn't exist, the correct function is `gpio_dump_io_configuration`. --- docs/en/api-reference/peripherals/gpio.rst | 2 +- docs/zh_CN/api-reference/peripherals/gpio.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/en/api-reference/peripherals/gpio.rst b/docs/en/api-reference/peripherals/gpio.rst index a56786033e04..38c2ee688d1e 100644 --- a/docs/en/api-reference/peripherals/gpio.rst +++ b/docs/en/api-reference/peripherals/gpio.rst @@ -81,7 +81,7 @@ In addition, if you would like to dump the configurations of all IOs, you can us :: - gpio_dump_all_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK); + gpio_dump_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK); If an IO pin is routed to a peripheral signal through the GPIO matrix, the signal ID printed in the dump information is defined in the :component_file:`soc/{IDF_TARGET_PATH_NAME}/include/soc/gpio_sig_map.h` header file. The word ``**RESERVED**`` indicates the IO is occupied by either SPI flash or PSRAM. It is strongly not recommended to reconfigure them for other application purposes. diff --git a/docs/zh_CN/api-reference/peripherals/gpio.rst b/docs/zh_CN/api-reference/peripherals/gpio.rst index 4fc0489c3d7b..c9732320f5f8 100644 --- a/docs/zh_CN/api-reference/peripherals/gpio.rst +++ b/docs/zh_CN/api-reference/peripherals/gpio.rst @@ -81,7 +81,7 @@ GPIO 驱动提供了一个函数 :cpp:func:`gpio_dump_io_configuration` 用来 :: - gpio_dump_all_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK); + gpio_dump_io_configuration(stdout, SOC_GPIO_VALID_GPIO_MASK); 如果 IO 管脚通过 GPIO 交换矩阵连接到内部外设信号，输出信息打印中的外设信号 ID 定义可以在 :component_file:`soc/{IDF_TARGET_PATH_NAME}/include/soc/gpio_sig_map.h` 头文件中查看。``**RESERVED**`` 字样则表示此 IO 用于连接 SPI flash 或 PSRAM，强烈建议不要重新配置这些管脚用于其他功能。