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