Skip to content

Commit

Permalink
docs/pinctrl: document debugfs files
Browse files Browse the repository at this point in the history
Document debugfs directories and files created for pinctrl subsystem.

Suggested-by: Andy Shevchenko <[email protected]>
Reviewed-by: Andy Shevchenko <[email protected]>
Reviewed-by: Tony Lindgren <[email protected]>
Signed-off-by: Drew Fustini <[email protected]>
Link: https://lore.kernel.org/r/[email protected]
Signed-off-by: Linus Walleij <[email protected]>
  • Loading branch information
pdp7 authored and linusw committed Mar 10, 2021
1 parent 5513b41 commit 1ae6478
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions Documentation/driver-api/pin-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1428,3 +1428,40 @@ on the pins defined by group B::
The above has to be done from process context. The reservation of the pins
will be done when the state is activated, so in effect one specific pin
can be used by different functions at different times on a running system.


Debugfs files
=============
These files are created in ``/sys/kernel/debug/pinctrl``:

- ``pinctrl-devices``: prints each pin controller device along with columns to
indicate support for pinmux and pinconf

- ``pinctrl-handles``: prints each configured pin controller handle and the
corresponding pinmux maps

- ``pinctrl-maps``: print all pinctrl maps

A sub-directory is created inside of ``/sys/kernel/debug/pinctrl`` for each pin
controller device containing these files:

- ``pins``: prints a line for each pin registered on the pin controller. The
pinctrl driver may add additional information such as register contents.

- ``gpio-ranges``: print ranges that map gpio lines to pins on the controller

- ``pingroups``: print all pin groups registered on the pin controller

- ``pinconf-pins``: print pin config settings for each pin

- ``pinconf-groups``: print pin config settings per pin group

- ``pinmux-functions``: print each pin function along with the pin groups that
map to the pin function

- ``pinmux-pins``: iterate through all pins and print mux owner, gpio owner
and if the pin is a hog

- ``pinmux-select``: write to this file to activate a pin function for a group::

echo "<group-name function-name>" > pinmux-select

0 comments on commit 1ae6478

Please sign in to comment.