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