xref: /freebsd/share/man/man4/gpioled.4 (revision 8ce07fe72eb5ca0925f192cb74ff8097a81f68c2)
1*8ce07fe7SLuiz Otavio O Souza.\" Copyright (c) 2013, Luiz Otavio O Souza <loos@FreeBSD.org>
2*8ce07fe7SLuiz Otavio O Souza.\" All rights reserved.
3*8ce07fe7SLuiz Otavio O Souza.\"
4*8ce07fe7SLuiz Otavio O Souza.\" Redistribution and use in source and binary forms, with or without
5*8ce07fe7SLuiz Otavio O Souza.\" modification, are permitted provided that the following conditions
6*8ce07fe7SLuiz Otavio O Souza.\" are met:
7*8ce07fe7SLuiz Otavio O Souza.\" 1. Redistributions of source code must retain the above copyright
8*8ce07fe7SLuiz Otavio O Souza.\"    notice, this list of conditions and the following disclaimer.
9*8ce07fe7SLuiz Otavio O Souza.\" 2. Redistributions in binary form must reproduce the above copyright
10*8ce07fe7SLuiz Otavio O Souza.\"    notice, this list of conditions and the following disclaimer in the
11*8ce07fe7SLuiz Otavio O Souza.\"    documentation and/or other materials provided with the distribution.
12*8ce07fe7SLuiz Otavio O Souza.\"
13*8ce07fe7SLuiz Otavio O Souza.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14*8ce07fe7SLuiz Otavio O Souza.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15*8ce07fe7SLuiz Otavio O Souza.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16*8ce07fe7SLuiz Otavio O Souza.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17*8ce07fe7SLuiz Otavio O Souza.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18*8ce07fe7SLuiz Otavio O Souza.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19*8ce07fe7SLuiz Otavio O Souza.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20*8ce07fe7SLuiz Otavio O Souza.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21*8ce07fe7SLuiz Otavio O Souza.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22*8ce07fe7SLuiz Otavio O Souza.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23*8ce07fe7SLuiz Otavio O Souza.\" SUCH DAMAGE.
24*8ce07fe7SLuiz Otavio O Souza.\"
25*8ce07fe7SLuiz Otavio O Souza.\" $FreeBSD$
26*8ce07fe7SLuiz Otavio O Souza.\"
27*8ce07fe7SLuiz Otavio O Souza.Dd November 5, 2013
28*8ce07fe7SLuiz Otavio O Souza.Dt GPIOLED 4
29*8ce07fe7SLuiz Otavio O Souza.Os
30*8ce07fe7SLuiz Otavio O Souza.Sh NAME
31*8ce07fe7SLuiz Otavio O Souza.Nm gpioled
32*8ce07fe7SLuiz Otavio O Souza.Nd GPIO led generic device driver
33*8ce07fe7SLuiz Otavio O Souza.Sh SYNOPSIS
34*8ce07fe7SLuiz Otavio O Souza.Cd "device gpio"
35*8ce07fe7SLuiz Otavio O Souza.Cd "device gpioled"
36*8ce07fe7SLuiz Otavio O Souza.Pp
37*8ce07fe7SLuiz Otavio O SouzaThis driver attaches a
38*8ce07fe7SLuiz Otavio O Souza.Xr led 4
39*8ce07fe7SLuiz Otavio O Souzadevice to a GPIO pin.
40*8ce07fe7SLuiz Otavio O Souza.Sh DESCRIPTION
41*8ce07fe7SLuiz Otavio O SouzaThe
42*8ce07fe7SLuiz Otavio O Souza.Em gpioled
43*8ce07fe7SLuiz Otavio O Souzadriver provides a glue to attach a
44*8ce07fe7SLuiz Otavio O Souza.Xr led 4
45*8ce07fe7SLuiz Otavio O Souzacompatible device to a GPIO pin.
46*8ce07fe7SLuiz Otavio O SouzaEach led on the system has a
47*8ce07fe7SLuiz Otavio O Souza.Pa name
48*8ce07fe7SLuiz Otavio O Souzawhich is used to export a device in
49*8ce07fe7SLuiz Otavio O Souza.Pa /dev/led/<name> .
50*8ce07fe7SLuiz Otavio O SouzaThe GPIO pin can then be controlled by writing to this device as described
51*8ce07fe7SLuiz Otavio O Souzaon
52*8ce07fe7SLuiz Otavio O Souza.Xr led 4 .
53*8ce07fe7SLuiz Otavio O Souza.Pp
54*8ce07fe7SLuiz Otavio O SouzaOn a hint based system, like
55*8ce07fe7SLuiz Otavio O Souza.Li MIPS , these values are configureable for
56*8ce07fe7SLuiz Otavio O Souza.Nm :
57*8ce07fe7SLuiz Otavio O Souza.Bl -tag -width ".Va hint.gpioiic.%d.atXXX"
58*8ce07fe7SLuiz Otavio O Souza.It Va hint.gpioled.%d.at
59*8ce07fe7SLuiz Otavio O SouzaThe gpiobus you are attaching to.
60*8ce07fe7SLuiz Otavio O SouzaNormally assigned to gpiobus0.
61*8ce07fe7SLuiz Otavio O Souza.It Va hint.gpioled.%d.name
62*8ce07fe7SLuiz Otavio O SouzaArbitrary name of device in
63*8ce07fe7SLuiz Otavio O Souza.Pa /dev/led/
64*8ce07fe7SLuiz Otavio O Souzato create for
65*8ce07fe7SLuiz Otavio O Souza.Xr led 4 .
66*8ce07fe7SLuiz Otavio O Souza.It Va hint.gpioled.%d.pins
67*8ce07fe7SLuiz Otavio O SouzaWhich pin on the GPIO interface to map to this instance.
68*8ce07fe7SLuiz Otavio O SouzaPlease note that this mask should only ever have one bit set
69*8ce07fe7SLuiz Otavio O Souza(any others bits - i.e., pins - will be ignored).
70*8ce07fe7SLuiz Otavio O Souza.El
71*8ce07fe7SLuiz Otavio O Souza.Sh SEE ALSO
72*8ce07fe7SLuiz Otavio O Souza.Xr gpio 4 ,
73*8ce07fe7SLuiz Otavio O Souza.Xr led 4 ,
74*8ce07fe7SLuiz Otavio O Souza.Xr gpioiic 4
75*8ce07fe7SLuiz Otavio O Souza.Sh HISTORY
76*8ce07fe7SLuiz Otavio O SouzaThe
77*8ce07fe7SLuiz Otavio O Souza.Nm
78*8ce07fe7SLuiz Otavio O Souzamanual page first appeared in
79*8ce07fe7SLuiz Otavio O Souza.Fx 11.0 .
80*8ce07fe7SLuiz Otavio O Souza.Sh AUTHORS
81*8ce07fe7SLuiz Otavio O SouzaThis
82*8ce07fe7SLuiz Otavio O Souzamanual page was written by
83*8ce07fe7SLuiz Otavio O Souza.An Luiz Otavio O Souza .
84