freebsd-skq/usr.sbin/gpioctl/gpioctl.8

.\" Copyright (c) 1980, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd November 7, 2013
.Dt GPIOCTL 1
.Os
.Sh NAME
.Nm gpioctl
.Nd GPIO control utility
.Sh SYNOPSIS
.Nm
.Cm -l
.Op Fl f Ar ctldev
.Op Fl v
.Nm
.Cm -t
.Op Fl f Ar ctldev
.Ar pin
.Nm
.Cm -c
.Op Fl f Ar ctldev
.Ar pin
.Ar flag
.Op flag ...
.Nm
.Op Cm -f Ar ctldev
.Ar pin
.Ar [0|1]
.Sh DESCRIPTION
The
.Nm
utility could be used to manage GPIO pins from userland and list available pins.
.Pp
The options are as follows:
.Bl -tag -width ".Fl f Ar ctldev"
.It Fl c Ar pin Ar flag Op flag ...
Configure pin by setting provided flags. The following flags are currently defined:
.Bl -tag -offset indent -width ".Cm PULSE"
.It Cm IN
Input pin
.It Cm OUT
Output pin
.It Cm OD
Open drain pin
.It Cm PP
Push pull pin
.It Cm TS
Tristate pin
.It Cm PU
Pull-up pin
.It Cm PD
Pull-down pin
.It Cm II
Inverted input pin
.It Cm IO
Inverted output pin
.El
.It Fl f Ar ctldev
GPIO controller device to use
If not specified, defaults to
.Pa /dev/gpioc0
.It Fl l
list available pins
.It Fl t Ar pin
toggle value of provided pin number
.It Fl v
be verbose: for each listed pin print current configuration
.El
.Sh EXAMPLES
.Bl -bullet
.It
List pins available on GPIO controller defined by device /dev/gpioc0
.Pp
gpioctl -f /dev/gpioc0 -l
.It
Set the value of pin 12 to 1
.Pp
gpioctl -f /dev/gpioc0 12 1
.It
Configure pin 12 to be input pin
.Pp
gpioctl -f /dev/gpioc0 -c 12 IN
.El
.Sh SEE ALSO
.Xr gpio 4
.Xr gpioiic 4
.Xr gpioled 4
.Sh HISTORY
The
.Nm
utility appeared in
.Fx 9.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
utility and this manual page were written by
.An Oleksandr Tymoshenko
.Aq gonzo@freebsd.org
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.\" Copyright (c) 1980, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" $FreeBSD$`
			`.\"`
Adds gpioiic.4 and gpioled.4 man pages. Moves some of the information that was previously available on gpio.4 to their respectives pages. Add the cross references on gpioctl.8. Approved by: adrian (mentor) 2013-11-12 12:44:59 +00:00			`.Dd November 7, 2013`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Dt GPIOCTL 1`
			`.Os`
			`.Sh NAME`
			`.Nm gpioctl`
			`.Nd GPIO control utility`
			`.Sh SYNOPSIS`
			`.Nm`
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days 2012-03-29 05:02:12 +00:00			`.Cm -l`
Assume that the -f argument is /dev/gpioc0 if it is not passed. hrs@ provided this verison of the patch and showed me where all the needed changes were to be made outside of gpioctl.c Approved by: re (hrs) MFC after: 2 weeks 2013-09-17 11:48:47 +00:00			`.Op Fl f Ar ctldev`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Op Fl v`
			`.Nm`
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days 2012-03-29 05:02:12 +00:00			`.Cm -t`
Assume that the -f argument is /dev/gpioc0 if it is not passed. hrs@ provided this verison of the patch and showed me where all the needed changes were to be made outside of gpioctl.c Approved by: re (hrs) MFC after: 2 weeks 2013-09-17 11:48:47 +00:00			`.Op Fl f Ar ctldev`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Ar pin`
			`.Nm`
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days 2012-03-29 05:02:12 +00:00			`.Cm -c`
Assume that the -f argument is /dev/gpioc0 if it is not passed. hrs@ provided this verison of the patch and showed me where all the needed changes were to be made outside of gpioctl.c Approved by: re (hrs) MFC after: 2 weeks 2013-09-17 11:48:47 +00:00			`.Op Fl f Ar ctldev`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Ar pin`
Remove trailing whitespace per mdoc lint warning Disussed with: gavin No objection from: doc Approved by: joel MFC after: 3 days 2012-03-29 05:02:12 +00:00			`.Ar flag`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Op flag ...`
			`.Nm`
Assume that the -f argument is /dev/gpioc0 if it is not passed. hrs@ provided this verison of the patch and showed me where all the needed changes were to be made outside of gpioctl.c Approved by: re (hrs) MFC after: 2 weeks 2013-09-17 11:48:47 +00:00			`.Op Cm -f Ar ctldev`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Ar pin`
			`.Ar [0\|1]`
			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`utility could be used to manage GPIO pins from userland and list available pins.`
			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width ".Fl f Ar ctldev"`
			`.It Fl c Ar pin Ar flag Op flag ...`
			`Configure pin by setting provided flags. The following flags are currently defined:`
			`.Bl -tag -offset indent -width ".Cm PULSE"`
			`.It Cm IN`
			`Input pin`
			`.It Cm OUT`
			`Output pin`
			`.It Cm OD`
			`Open drain pin`
			`.It Cm PP`
			`Push pull pin`
			`.It Cm TS`
			`Tristate pin`
			`.It Cm PU`
			`Pull-up pin`
			`.It Cm PD`
			`Pull-down pin`
			`.It Cm II`
			`Inverted input pin`
			`.It Cm IO`
			`Inverted output pin`
			`.El`
			`.It Fl f Ar ctldev`
			`GPIO controller device to use`
Assume that the -f argument is /dev/gpioc0 if it is not passed. hrs@ provided this verison of the patch and showed me where all the needed changes were to be made outside of gpioctl.c Approved by: re (hrs) MFC after: 2 weeks 2013-09-17 11:48:47 +00:00			`If not specified, defaults to`
			`.Pa /dev/gpioc0`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.It Fl l`
			`list available pins`
			`.It Fl t Ar pin`
			`toggle value of provided pin number`
			`.It Fl v`
			`be verbose: for each listed pin print current configuration`
			`.El`
			`.Sh EXAMPLES`
			`.Bl -bullet`
			`.It`
Document the device name change from gpioctl to gpioc in the man page. PR: docs/157075 Submitted by: brix Reviewed by: gonzo 2011-05-25 20:25:13 +00:00			`List pins available on GPIO controller defined by device /dev/gpioc0`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Pp`
Document the device name change from gpioctl to gpioc in the man page. PR: docs/157075 Submitted by: brix Reviewed by: gonzo 2011-05-25 20:25:13 +00:00			`gpioctl -f /dev/gpioc0 -l`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.It`
			`Set the value of pin 12 to 1`
			`.Pp`
Document the device name change from gpioctl to gpioc in the man page. PR: docs/157075 Submitted by: brix Reviewed by: gonzo 2011-05-25 20:25:13 +00:00			`gpioctl -f /dev/gpioc0 12 1`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.It`
			`Configure pin 12 to be input pin`
			`.Pp`
Document the device name change from gpioctl to gpioc in the man page. PR: docs/157075 Submitted by: brix Reviewed by: gonzo 2011-05-25 20:25:13 +00:00			`gpioctl -f /dev/gpioc0 -c 12 IN`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.El`
Add gpio(4) man page to attempt to document the current hints based setup of pin outputs, functions and setup. Add cross reference in gpioctl(8) for people to find. This is by no means complete and really only covers gpioled(4) and the Atheros based systems who expose a few extra hints at boot time. This should be updated by developers who know more about this system than I and viewed as the beginning of documentation, not the end. Reviewed by: adrian Approved by: re (joel) MFC after: 2 weeks 2013-09-13 19:55:40 +00:00			`.Sh SEE ALSO`
			`.Xr gpio 4`
Adds gpioiic.4 and gpioled.4 man pages. Moves some of the information that was previously available on gpio.4 to their respectives pages. Add the cross references on gpioctl.8. Approved by: adrian (mentor) 2013-11-12 12:44:59 +00:00			`.Xr gpioiic 4`
			`.Xr gpioled 4`
Add gpioctl(8). Utility for configuring/accessing GPIO pins 2010-09-28 03:28:20 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`utility appeared in`
			`.Fx 9.0 .`
			`.Sh AUTHORS`
			`.An -nosplit`
			`The`
			`.Nm`
			`utility and this manual page were written by`
			`.An Oleksandr Tymoshenko`
			`.Aq gonzo@freebsd.org`