doc/usage/pinmux.rst

   1 .. SPDX-License-Identifier: GPL-2.0+:
   2
   3 pinmux command
   4 ==============
   5
   6 Synopsis
   7 --------
   8
   9 ::
  10
  11     pinmux list
  12     pinmux dev [pincontroller-name]
  13     pinmux status [-a | pin-name]
  14
  15 Description
  16 -----------
  17
  18 The pinmux command is used to show the pin-controller muxing.
  19
  20 The 'pinmux list' command diplays the available pin-controller.
  21
  22 The 'pinmux dev' command selects the pin-controller for next commands.
  23
  24     pincontroller-name
  25         name of the pin-controller to select
  26
  27 The 'pinmux status' command displays the pin muxing information.
  28
  29     \-a
  30         display pin muxing of all pin-controllers.
  31     pin-name
  32         name of the pin to display
  33
  34 Example
  35 -------
  36
  37 ::
  38
  39     => pinmux list
  40     | Device                        | Driver                        | Parent
  41     | pinctrl-gpio                  | sandbox_pinctrl_gpio          | root_driver
  42     | pinctrl                       | sandbox_pinctrl               | root_driver
  43     =>
  44     => pinmux dev pinctrl
  45     dev: pinctrl
  46     =>
  47     => pinmux status
  48     P0        : UART TX.
  49     P1        : UART RX.
  50     P2        : I2S SCK.
  51     P3        : I2S SD.
  52     P4        : I2S WS.
  53     P5        : GPIO0 bias-pull-up input-disable.
  54     P6        : GPIO1 drive-open-drain.
  55     P7        : GPIO2 bias-pull-down input-enable.
  56     P8        : GPIO3 bias-disable.
  57     =>
  58     => pinmux status P0
  59     P0        : UART TX.
  60     =>
  61     => pinmux status -a
  62     --------------------------
  63     pinctrl-gpio:
  64     a0        : gpio input .
  65     a1        : gpio input .
  66     a2        : gpio input .
  67     a3        : gpio input .
  68     a4        : gpio input .
  69     a5        : gpio output .
  70     a6        : gpio output .
  71     a7        : gpio input .
  72     a8        : gpio input .
  73     a9        : gpio input .
  74     --------------------------
  75     pinctrl:
  76     P0        : UART TX.
  77     P1        : UART RX.
  78     P2        : I2S SCK.
  79     P3        : I2S SD.
  80     P4        : I2S WS.
  81     P5        : GPIO0 bias-pull-up input-disable.
  82     P6        : GPIO1 drive-open-drain.
  83     P7        : GPIO2 bias-pull-down input-enable.
  84     P8        : GPIO3 bias-disable.
  85
  86 Configuration
  87 -------------
  88
  89 The pinmux command is only available if CONFIG_CMD_PINMUX=y.
  90
  91 Return value
  92 ------------
  93
  94 The return value $? is set to 0 (true) if the command succeded and to 1 (false)
  95 otherwise.