usr.sbin/gpioctl/gpioctl.8

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd June 6, 2018
  31 .Dt GPIOCTL 8
  32 .Os
  33 .Sh NAME
  34 .Nm gpioctl
  35 .Nd GPIO control utility
  36 .Sh SYNOPSIS
  37 .Nm
  38 .Op Fl f Ar ctldev
  39 .Cm -l
  40 .Op Fl v
  41 .Nm
  42 .Op Fl f Ar ctldev
  43 .Op Fl pN
  44 .Cm -t
  45 .Ar pin
  46 .Nm
  47 .Op Fl f Ar ctldev
  48 .Op Fl pN
  49 .Cm -c
  50 .Ar pin
  51 .Ar flag
  52 .Op flag ...
  53 .Nm
  54 .Op Fl f Ar ctldev
  55 .Op Fl pN
  56 .Cm -n
  57 .Ar pin
  58 .Ar pin-name
  59 .Nm
  60 .Op Cm -f Ar ctldev
  61 .Op Fl pN
  62 .Ar pin
  63 .Ar [0|1]
  64 .Sh DESCRIPTION
  65 The
  66 .Nm
  67 utility could be used to manage GPIO pins from userland and list available pins.
  68 .Pp
  69 The
  70 .Pa pin
  71 argument can either be a
  72 .Pa pin-number
  73 or a
  74 .Pa pin-name .
  75 If it is a number and a pin has this number as its name and you did not use
  76 .Fl N
  77 or
  78 .Fl p
  79 , then
  80 .Nm
  81 exits.
  82 .Pp
  83 The options are as follows:
  84 .Bl -tag -width ".Fl f Ar ctldev"
  85 .It Fl c Ar pin Ar flag Op flag ...
  86 Configure pin by setting provided flags.
  87 The following flags are currently defined:
  88 .Bl -tag -offset indent -width ".Cm PULSE"
  89 .It Cm IN
  90 Input pin
  91 .It Cm OUT
  92 Output pin
  93 .It Cm OD
  94 Open drain pin
  95 .It Cm PP
  96 Push pull pin
  97 .It Cm TS
  98 Tristate pin
  99 .It Cm PU
 100 Pull-up pin
 101 .It Cm PD
 102 Pull-down pin
 103 .It Cm II
 104 Inverted input pin
 105 .It Cm IO
 106 Inverted output pin
 107 .El
 108 .It Fl f Ar ctldev
 109 GPIO controller device to use
 110 If not specified, defaults to
 111 .Pa /dev/gpioc0
 112 .It Fl l
 113 list available pins
 114 .It Fl n Ar pin Ar pin-name
 115 set the name used to describe the pin
 116 .It Fl t Ar pin
 117 toggle value of provided pin
 118 .It Fl v
 119 be verbose: for each listed pin print current configuration
 120 .It Fl p
 121 Force
 122 .Pa pin
 123 to be interpreted as a pin number
 124 .It Fl N
 125 Force
 126 .Pa pin
 127 to be interpreted as a pin name
 128 .El
 129 .Sh EXAMPLES
 130 .Bl -bullet
 131 .It
 132 List pins available on GPIO controller defined by device /dev/gpioc0
 133 .Pp
 134 gpioctl -f /dev/gpioc0 -l
 135 .It
 136 Set the value of pin 12 to 1
 137 .Pp
 138 gpioctl -f /dev/gpioc0 12 1
 139 .It
 140 Configure pin 12 to be input pin
 141 .Pp
 142 gpioctl -f /dev/gpioc0 -c 12 IN
 143 .It
 144 Set the name of pin 12 to test
 145 .Pp
 146 gpioctl -f /dev/gpioc0 -n 12 test
 147 .It
 148 Toggle the value the pin named test
 149 .Pp
 150 gpioctl -f /dev/gpioc0 -t test
 151 .It
 152 Toggle the value of pin number 12 even if another pin has the name 12
 153 .Pp
 154 gpioctl -f /dev/gpioc0 -pt 12
 155 .El
 156 .Sh SEE ALSO
 157 .Xr gpio 4 ,
 158 .Xr gpioiic 4 ,
 159 .Xr gpioled 4
 160 .Sh HISTORY
 161 The
 162 .Nm
 163 utility appeared in
 164 .Fx 9.0 .
 165 .Sh AUTHORS
 166 .An -nosplit
 167 The
 168 .Nm
 169 utility and this manual page were written by
 170 .An Oleksandr Tymoshenko Aq Mt gonzo@freebsd.org .