gpioled.c revision 331722 
1/*-
2 * Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: stable/11/sys/dev/gpio/gpioled.c 331722 2018-03-29 02:50:57Z eadler $");
29
30#include "opt_platform.h"
31
32#include <sys/param.h>
33#include <sys/systm.h>
34#include <sys/bus.h>
35#include <sys/gpio.h>
36#include <sys/kernel.h>
37#include <sys/lock.h>
38#include <sys/malloc.h>
39#include <sys/module.h>
40#include <sys/mutex.h>
41
42#include <dev/gpio/gpiobusvar.h>
43#include <dev/led/led.h>
44
45#include "gpiobus_if.h"
46
47/*
48 * Only one pin for led
49 */
50#define	GPIOLED_PIN	0
51
52#define	GPIOLED_LOCK(_sc)		mtx_lock(&(_sc)->sc_mtx)
53#define	GPIOLED_UNLOCK(_sc)		mtx_unlock(&(_sc)->sc_mtx)
54#define	GPIOLED_LOCK_INIT(_sc)		mtx_init(&(_sc)->sc_mtx,	\
55    device_get_nameunit((_sc)->sc_dev), "gpioled", MTX_DEF)
56#define	GPIOLED_LOCK_DESTROY(_sc)	mtx_destroy(&(_sc)->sc_mtx)
57
58struct gpioled_softc
59{
60	device_t	sc_dev;
61	device_t	sc_busdev;
62	struct mtx	sc_mtx;
63	struct cdev	*sc_leddev;
64};
65
66static void gpioled_control(void *, int);
67static int gpioled_probe(device_t);
68static int gpioled_attach(device_t);
69static int gpioled_detach(device_t);
70
71static void
72gpioled_control(void *priv, int onoff)
73{
74	struct gpioled_softc *sc;
75
76	sc = (struct gpioled_softc *)priv;
77	GPIOLED_LOCK(sc);
78	if (GPIOBUS_PIN_SETFLAGS(sc->sc_busdev, sc->sc_dev, GPIOLED_PIN,
79	    GPIO_PIN_OUTPUT) == 0) {
80		GPIOBUS_PIN_SET(sc->sc_busdev, sc->sc_dev, GPIOLED_PIN,
81		    onoff ? GPIO_PIN_HIGH : GPIO_PIN_LOW);
82	}
83	GPIOLED_UNLOCK(sc);
84}
85
86static int
87gpioled_probe(device_t dev)
88{
89	device_set_desc(dev, "GPIO led");
90
91	return (BUS_PROBE_DEFAULT);
92}
93
94static int
95gpioled_attach(device_t dev)
96{
97	struct gpioled_softc *sc;
98	int state;
99	const char *name;
100
101	sc = device_get_softc(dev);
102	sc->sc_dev = dev;
103	sc->sc_busdev = device_get_parent(dev);
104	GPIOLED_LOCK_INIT(sc);
105
106	state = 0;
107
108	if (resource_string_value(device_get_name(dev),
109	    device_get_unit(dev), "name", &name))
110		name = NULL;
111
112	sc->sc_leddev = led_create_state(gpioled_control, sc, name ? name :
113	    device_get_nameunit(dev), state);
114
115	return (0);
116}
117
118static int
119gpioled_detach(device_t dev)
120{
121	struct gpioled_softc *sc;
122
123	sc = device_get_softc(dev);
124	if (sc->sc_leddev) {
125		led_destroy(sc->sc_leddev);
126		sc->sc_leddev = NULL;
127	}
128	GPIOLED_LOCK_DESTROY(sc);
129	return (0);
130}
131
132static devclass_t gpioled_devclass;
133
134static device_method_t gpioled_methods[] = {
135	/* Device interface */
136	DEVMETHOD(device_probe,		gpioled_probe),
137	DEVMETHOD(device_attach,	gpioled_attach),
138	DEVMETHOD(device_detach,	gpioled_detach),
139
140	DEVMETHOD_END
141};
142
143static driver_t gpioled_driver = {
144	"gpioled",
145	gpioled_methods,
146	sizeof(struct gpioled_softc),
147};
148
149DRIVER_MODULE(gpioled, gpiobus, gpioled_driver, gpioled_devclass, 0, 0);
150MODULE_DEPEND(gpioled, gpiobus, 1, 1, 1);
151