blackbeard420/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf synced 2025-03-09 17:19:09 -04:00
Code Issues Projects Releases Wiki Activity

docs: Fix gpio_dump_io_configuration typo in docs

Browse Source 
The mentioned `gpio_dump_all_io_configuration` function doesn't exist,
the correct function is `gpio_dump_io_configuration`.

Merges https://github.com/espressif/esp-idf/pull/15031
This commit is contained in:
Alex Bethel 2024-12-14 13:01:08 -07:00 committed by Song Ruo Jing
parent 131330034a
commit 441effd499
2 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/en/api-reference/peripherals/gpio.rst
View File

@ -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.

2
docs/zh_CN/api-reference/peripherals/gpio.rst
View File

@ -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，强烈建议不要重新配置这些管脚用于其他功能。