alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-25 01:37:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add an example for the function gpio_dump_io_configuration()

Browse Source
This commit is contained in:
Linda
2024-02-04 12:57:43 +08:00
parent adc49dfed7
commit 2c8975b2a7
2 changed files with 26 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -10,7 +10,13 @@ GPIO Summary
:start-after: gpio-summary
:end-before: ---
GPIO driver offers a dump function :cpp:func:`gpio_dump_io_configuration` to show the configurations of the IOs at the moment, such as pull-up / pull-down, input / output enable, pin mapping etc. Below is an example dump:
GPIO driver offers a dump function :cpp:func:`gpio_dump_io_configuration` to show the current configurations of IOs, such as pull-up/pull-down, input/output enable, pin mapping, etc. Below is an example of how to dump the configuration of GPIO4, GPIO18, and GPIO26:
::
gpio_dump_io_configuration(stdout, (1ULL << 4) | (1ULL << 18) | (1ULL << 26));
The dump will be like this:
::
@@ -37,6 +43,12 @@ GPIO driver offers a dump function :cpp:func:`gpio_dump_io_configuration` to sho
=================IO DUMP End==================
In addition, if you would like to dump the configurations of all IOs, you can use:
::
gpio_dump_all_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 ``soc/gpio_sig_map.h`` file. The word ``**RESERVED**`` indicates the IO is occupied by either FLASH or PSRAM. It is strongly not recommended to reconfigure them for other application purposes.
.. only:: SOC_RTCIO_INPUT_OUTPUT_SUPPORTED