xref: /freebsd/usr.sbin/gpioctl/gpioctl.8 (revision 2008043f386721d58158e37e0d7e50df8095942d)
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.Dd June 6, 2018
29.Dt GPIOCTL 8
30.Os
31.Sh NAME
32.Nm gpioctl
33.Nd GPIO control utility
34.Sh SYNOPSIS
35.Nm
36.Op Fl f Ar ctldev
37.Cm -l
38.Op Fl v
39.Nm
40.Op Fl f Ar ctldev
41.Op Fl pN
42.Cm -t
43.Ar pin
44.Nm
45.Op Fl f Ar ctldev
46.Op Fl pN
47.Cm -c
48.Ar pin
49.Ar flag
50.Op flag ...
51.Nm
52.Op Fl f Ar ctldev
53.Op Fl pN
54.Cm -n
55.Ar pin
56.Ar pin-name
57.Nm
58.Op Cm -f Ar ctldev
59.Op Fl pN
60.Ar pin
61.Ar [0|1]
62.Sh DESCRIPTION
63The
64.Nm
65utility could be used to manage GPIO pins from userland and list available pins.
66.Pp
67The
68.Pa pin
69argument can either be a
70.Pa pin-number
71or a
72.Pa pin-name .
73If it is a number and a pin has this number as its name and you did not use
74.Fl N
75or
76.Fl p
77, then
78.Nm
79exits.
80.Pp
81The options are as follows:
82.Bl -tag -width ".Fl f Ar ctldev"
83.It Fl c Ar pin Ar flag Op flag ...
84Configure pin by setting provided flags.
85The following flags are currently defined:
86.Bl -tag -offset indent -width ".Cm PULSE"
87.It Cm IN
88Input pin
89.It Cm OUT
90Output pin
91.It Cm OD
92Open drain pin
93.It Cm PP
94Push pull pin
95.It Cm TS
96Tristate pin
97.It Cm PU
98Pull-up pin
99.It Cm PD
100Pull-down pin
101.It Cm II
102Inverted input pin
103.It Cm IO
104Inverted output pin
105.El
106.It Fl f Ar ctldev
107GPIO controller device to use
108If not specified, defaults to
109.Pa /dev/gpioc0
110.It Fl l
111list available pins
112.It Fl n Ar pin Ar pin-name
113set the name used to describe the pin
114.It Fl t Ar pin
115toggle value of provided pin
116.It Fl v
117be verbose: for each listed pin print current configuration
118.It Fl p
119Force
120.Pa pin
121to be interpreted as a pin number
122.It Fl N
123Force
124.Pa pin
125to be interpreted as a pin name
126.El
127.Sh EXAMPLES
128.Bl -bullet
129.It
130List pins available on GPIO controller defined by device /dev/gpioc0
131.Pp
132gpioctl -f /dev/gpioc0 -l
133.It
134Set the value of pin 12 to 1
135.Pp
136gpioctl -f /dev/gpioc0 12 1
137.It
138Configure pin 12 to be input pin
139.Pp
140gpioctl -f /dev/gpioc0 -c 12 IN
141.It
142Set the name of pin 12 to test
143.Pp
144gpioctl -f /dev/gpioc0 -n 12 test
145.It
146Toggle the value the pin named test
147.Pp
148gpioctl -f /dev/gpioc0 -t test
149.It
150Toggle the value of pin number 12 even if another pin has the name 12
151.Pp
152gpioctl -f /dev/gpioc0 -pt 12
153.El
154.Sh SEE ALSO
155.Xr gpio 4 ,
156.Xr gpioiic 4 ,
157.Xr gpioled 4
158.Sh HISTORY
159The
160.Nm
161utility appeared in
162.Fx 9.0 .
163.Sh AUTHORS
164.An -nosplit
165The
166.Nm
167utility and this manual page were written by
168.An Oleksandr Tymoshenko Aq Mt gonzo@freebsd.org .
169