xref: /netbsd-src/share/man/man5/gpio.conf.5 (revision 84213c7105cbf0d9881d2995b5f025e657685380)
1.\"        $NetBSD: gpio.conf.5,v 1.3 2022/04/30 13:48:09 brad Exp $
2.\"
3.\" Copyright (c) 2009 Marc Balmer <marc@msys.ch>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd August 1, 2009
27.Dt GPIO.CONF 5
28.Os
29.Sh NAME
30.Nm gpio.conf
31.Nd GPIO config file
32.Sh DESCRIPTION
33The
34.Nm
35file is read by the
36.Pa gpio
37rc.d script during system start-up and shutdown,
38and is intended for configuring GPIO pins.
39.Ss FILE FORMAT
40Lines starting with a hash
41.Pq Sq #
42and empty lines are ignored.
43If a line starts with
44.Sq \&! ,
45the rest of line will get evaluated as shell script fragment.
46All other lines are passed to
47.Xr gpioctl 8 .
48.Sh FILES
49.Bl -tag -width XXetcXgpioXconfXX
50.It Pa /etc/gpio.conf
51The
52.Nm
53configuration file resides in
54.Pa /etc .
55.It Pa /etc/rc.d/gpio
56.Xr rc.d 8
57script that parses
58.Nm .
59.El
60.Sh EXAMPLES
61In this example, if the
62.Pa /etc/gpio.conf
63config file is present pin 1 of
64.Pa /dev/gpio0
65is set as output and named "error_led".
66.Bd -literal -offset indent
67# Program pin 1 of /dev/gpio0 as output and name it "error_led"
68gpio0 1 set out error_led
69.Ed
70.Sh SEE ALSO
71.Xr gpioctl 8 ,
72.Xr rc 8
73