d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
e3f7dbda44
freebsd-skq/usr.sbin/gpioctl/gpioctl.8

171 lines
3.8 KiB
Groff
Raw Normal View History

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.
Renumber copyright clause 4 Renumber cluase 4 to 3, per what everybody else did when BSD granted them permission to remove clause 3. My insistance on keeping the same numbering for legal reasons is too pedantic, so give up on that point. Submitted by: Jan Schaumann <jschauma@stevens.edu> Pull Request: https://github.com/freebsd/freebsd/pull/96
2017-02-28 23:42:47 +00:00
.\" 3. Neither the name of the University nor the names of its contributors
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
.\" 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$
.\"
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
.Dd March 11, 2016
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
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 a new ioctl to allow the setting of GPIO pin names. When a gpiobus child is added, use its name to identify the mapped pin names. Make the respective changes to libgpio. Add a new '-n' flag to gpioctl(8) to set the pin name. Differential Revision: https://reviews.freebsd.org/D2002 Reviewed by: rpaulo Requested by: many
2015-03-08 00:47:50 +00:00
.Cm -l
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
.Op Fl v
.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 Fl f Ar ctldev
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
.Op Fl pN
Add a new ioctl to allow the setting of GPIO pin names. When a gpiobus child is added, use its name to identify the mapped pin names. Make the respective changes to libgpio. Add a new '-n' flag to gpioctl(8) to set the pin name. Differential Revision: https://reviews.freebsd.org/D2002 Reviewed by: rpaulo Requested by: many
2015-03-08 00:47:50 +00:00
.Cm -t
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
.Ar pin
.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 Fl f Ar ctldev
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
.Op Fl pN
Add a new ioctl to allow the setting of GPIO pin names. When a gpiobus child is added, use its name to identify the mapped pin names. Make the respective changes to libgpio. Add a new '-n' flag to gpioctl(8) to set the pin name. Differential Revision: https://reviews.freebsd.org/D2002 Reviewed by: rpaulo Requested by: many
2015-03-08 00:47:50 +00:00
.Cm -c
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
Add a new ioctl to allow the setting of GPIO pin names. When a gpiobus child is added, use its name to identify the mapped pin names. Make the respective changes to libgpio. Add a new '-n' flag to gpioctl(8) to set the pin name. Differential Revision: https://reviews.freebsd.org/D2002 Reviewed by: rpaulo Requested by: many
2015-03-08 00:47:50 +00:00
.Op Fl f Ar ctldev
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
.Op Fl pN
Add a new ioctl to allow the setting of GPIO pin names. When a gpiobus child is added, use its name to identify the mapped pin names. Make the respective changes to libgpio. Add a new '-n' flag to gpioctl(8) to set the pin name. Differential Revision: https://reviews.freebsd.org/D2002 Reviewed by: rpaulo Requested by: many
2015-03-08 00:47:50 +00:00
.Cm -n
.Ar pin
.Ar pin-name
.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
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
.Op Fl pN
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
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
The
.Pa pin
argument can either be a
.Pa pin-number
or a
.Pa pin-name .
If it is a number and a pin has this number as its name and you did not use
.Fl N
or
.Fl p
, then
.Nm
exits.
.Pp
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
The options are as follows:
.Bl -tag -width ".Fl f Ar ctldev"
.It Fl c Ar pin Ar flag Op flag ...
Put the new sentence on a new line. Found with igor.
2015-03-08 21:11:08 +00:00
Configure pin by setting provided flags.
The following flags are currently defined:
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
.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
Add a new ioctl to allow the setting of GPIO pin names. When a gpiobus child is added, use its name to identify the mapped pin names. Make the respective changes to libgpio. Add a new '-n' flag to gpioctl(8) to set the pin name. Differential Revision: https://reviews.freebsd.org/D2002 Reviewed by: rpaulo Requested by: many
2015-03-08 00:47:50 +00:00
.It Fl n Ar pin Ar pin-name
set the name used to describe the pin
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
.It Fl t Ar pin
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
toggle value of provided pin
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
.It Fl v
be verbose: for each listed pin print current configuration
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
.It Fl p
Force
.Pa pin
to be interpreted as a pin number
.It Fl N
Force
.Pa pin
to be interpreted as a pin name
Add gpioctl(8). Utility for configuring/accessing GPIO pins
2010-09-28 03:28:20 +00:00
.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
Make it possible for operations to refer to GPIO pins by name - Try to guess what is provided as a pin spec for -t or for get/set operation: number or name. Fails in case of ambiguity. - Add -p and -N switches to force pin specification interpretation: -p forces spec to be pin number, -N forces it to be name Submitted by: Emmanuel Vadot <manu@bidouilliste.com> Differential Revision: https://reviews.freebsd.org/D5201
2016-03-11 21:05:16 +00:00
.It
Set the name of pin 12 to test
.Pp
gpioctl -f /dev/gpioc0 -n 12 test
.It
Toggle the value the pin named test
.Pp
gpioctl -f /dev/gpioc0 -t test
.It
Toggle the value of pin number 12 even if another pin has the name 12
.Pp
gpioctl -f /dev/gpioc0 -pt 12
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
mdoc: sort SEE ALSO.
2014-12-26 21:56:23 +00:00
.Xr gpio 4 ,
.Xr gpioiic 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 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
use .Mt to mark up email addresses consistently (part2) PR: 191174 Submitted by: Franco Fichtner <franco@lastsummer.de>
2014-06-20 09:57:27 +00:00
.An Oleksandr Tymoshenko Aq Mt gonzo@freebsd.org .
Reference in New Issue Copy Permalink