xref: /freebsd/usr.sbin/gpioctl/gpioctl.8 (revision d752f0f69de80ecb93e4d64e8353218edbdbdccf)
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.\" 4. 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 March 7, 2015
31.Dt GPIOCTL 1
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.Cm -t
44.Ar pin
45.Nm
46.Op Fl f Ar ctldev
47.Cm -c
48.Ar pin
49.Ar flag
50.Op flag ...
51.Nm
52.Op Fl f Ar ctldev
53.Cm -n
54.Ar pin
55.Ar pin-name
56.Nm
57.Op Cm -f Ar ctldev
58.Ar pin
59.Ar [0|1]
60.Sh DESCRIPTION
61The
62.Nm
63utility could be used to manage GPIO pins from userland and list available pins.
64.Pp
65The options are as follows:
66.Bl -tag -width ".Fl f Ar ctldev"
67.It Fl c Ar pin Ar flag Op flag ...
68Configure pin by setting provided flags. The following flags are currently defined:
69.Bl -tag -offset indent -width ".Cm PULSE"
70.It Cm IN
71Input pin
72.It Cm OUT
73Output pin
74.It Cm OD
75Open drain pin
76.It Cm PP
77Push pull pin
78.It Cm TS
79Tristate pin
80.It Cm PU
81Pull-up pin
82.It Cm PD
83Pull-down pin
84.It Cm II
85Inverted input pin
86.It Cm IO
87Inverted output pin
88.El
89.It Fl f Ar ctldev
90GPIO controller device to use
91If not specified, defaults to
92.Pa /dev/gpioc0
93.It Fl l
94list available pins
95.It Fl n Ar pin Ar pin-name
96set the name used to describe the pin
97.It Fl t Ar pin
98toggle value of provided pin number
99.It Fl v
100be verbose: for each listed pin print current configuration
101.El
102.Sh EXAMPLES
103.Bl -bullet
104.It
105List pins available on GPIO controller defined by device /dev/gpioc0
106.Pp
107gpioctl -f /dev/gpioc0 -l
108.It
109Set the value of pin 12 to 1
110.Pp
111gpioctl -f /dev/gpioc0 12 1
112.It
113Configure pin 12 to be input pin
114.Pp
115gpioctl -f /dev/gpioc0 -c 12 IN
116.El
117.Sh SEE ALSO
118.Xr gpio 4 ,
119.Xr gpioiic 4 ,
120.Xr gpioled 4
121.Sh HISTORY
122The
123.Nm
124utility appeared in
125.Fx 9.0 .
126.Sh AUTHORS
127.An -nosplit
128The
129.Nm
130utility and this manual page were written by
131.An Oleksandr Tymoshenko Aq Mt gonzo@freebsd.org .
132