Skip to content

Commit

Permalink
docs: Fix gpio_dump_io_configuration typo in docs
Browse files Browse the repository at this point in the history
The mentioned `gpio_dump_all_io_configuration` function doesn't exist,
the correct function is `gpio_dump_io_configuration`.
  • Loading branch information
AlexBethel committed Dec 14, 2024
1 parent cb3ac74 commit 30a050e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/en/api-reference/peripherals/gpio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/api-reference/peripherals/gpio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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,强烈建议不要重新配置这些管脚用于其他功能。

Expand Down

0 comments on commit 30a050e

Please sign in to comment.