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