xref: /netbsd-src/sys/dev/gpio/gpiosim.c (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /* $NetBSD: gpiosim.c,v 1.16 2014/02/25 18:30:09 pooka Exp $ */
2 /*      $OpenBSD: gpiosim.c,v 1.1 2008/11/23 18:46:49 mbalmer Exp $	*/
3 
4 /*
5  * Copyright (c) 2007 - 2011, 2013 Marc Balmer <marc@msys.ch>
6  * All rights reserved.
7  *
8  * Permission to use, copy, modify, and distribute this software for any
9  * purpose with or without fee is hereby granted, provided that the above
10  * copyright notice and this permission notice appear in all copies.
11  *
12  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
13  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
14  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
15  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
16  * WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN
17  * AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
18  * OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
19  */
20 
21 /* 64 bit wide GPIO simulator  */
22 
23 #include <sys/param.h>
24 #include <sys/systm.h>
25 #include <sys/device.h>
26 #include <sys/gpio.h>
27 #include <sys/malloc.h>
28 #include <sys/module.h>
29 #include <sys/sysctl.h>
30 #include <sys/ioccom.h>
31 #include <dev/gpio/gpiovar.h>
32 
33 #define	GPIOSIM_NPINS	64
34 
35 struct gpiosim_softc {
36 	device_t		sc_dev;
37 	device_t		sc_gdev;	/* gpio that attaches here */
38 	uint64_t		sc_state;
39 	struct gpio_chipset_tag	sc_gpio_gc;
40 	gpio_pin_t		sc_gpio_pins[GPIOSIM_NPINS];
41 
42 	struct sysctllog	*sc_log;
43 };
44 
45 static int	gpiosim_match(device_t, cfdata_t, void *);
46 void		gpiosimattach(int);
47 static void	gpiosim_attach(device_t, device_t, void *);
48 static int	gpiosim_detach(device_t, int);
49 static int	gpiosim_sysctl(SYSCTLFN_PROTO);
50 
51 static int	gpiosim_pin_read(void *, int);
52 static void	gpiosim_pin_write(void *, int, int);
53 static void	gpiosim_pin_ctl(void *, int, int);
54 
55 CFATTACH_DECL_NEW(gpiosim, sizeof(struct gpiosim_softc), gpiosim_match,
56     gpiosim_attach, gpiosim_detach, NULL);
57 
58 extern struct cfdriver gpiosim_cd;
59 
60 static int
61 gpiosim_match(device_t parent, cfdata_t match, void *aux)
62 {
63 	return 1;
64 }
65 
66 void
67 gpiosimattach(int num)
68 {
69 	cfdata_t cf;
70 	int n, err;
71 
72 	err = config_cfattach_attach(gpiosim_cd.cd_name, &gpiosim_ca);
73 	if (err)
74 		printf("%s: unable to register cfattach\n", gpiosim_cd.cd_name);
75 
76 	for (n = 0; n < num; n++) {
77 		cf = malloc(sizeof(*cf), M_DEVBUF, M_WAITOK);
78 		cf->cf_name = "gpiosim";
79 		cf->cf_atname = "gpiosim";
80 		cf->cf_unit = n;
81 		cf->cf_fstate = FSTATE_NOTFOUND;
82 		config_attach_pseudo(cf);
83 	}
84 }
85 
86 static void
87 gpiosim_attach(device_t parent, device_t self, void *aux)
88 {
89 	struct gpiosim_softc *sc = device_private(self);
90 	struct gpiobus_attach_args gba;
91 	const struct sysctlnode *node;
92 	int i;
93 
94 	sc->sc_dev = self;
95 
96 	printf("%s", device_xname(sc->sc_dev));
97 
98 	/* initialize pin array */
99 	for (i = 0; i < GPIOSIM_NPINS; i++) {
100 		sc->sc_gpio_pins[i].pin_num = i;
101 		sc->sc_gpio_pins[i].pin_caps = GPIO_PIN_INPUT |
102 		    GPIO_PIN_OUTPUT | GPIO_PIN_OPENDRAIN |
103 		    GPIO_PIN_PULLUP | GPIO_PIN_PULLDOWN |
104 		    GPIO_PIN_INVIN | GPIO_PIN_INVOUT;
105 
106 		/* read initial state */
107 		sc->sc_gpio_pins[i].pin_flags = GPIO_PIN_INPUT;
108 	}
109 	sc->sc_state = 0;
110 
111 	/* create controller tag */
112 	sc->sc_gpio_gc.gp_cookie = sc;
113 	sc->sc_gpio_gc.gp_pin_read = gpiosim_pin_read;
114 	sc->sc_gpio_gc.gp_pin_write = gpiosim_pin_write;
115 	sc->sc_gpio_gc.gp_pin_ctl = gpiosim_pin_ctl;
116 
117 	/* gba.gba_name = "gpio"; */
118 	gba.gba_gc = &sc->sc_gpio_gc;
119 	gba.gba_pins = sc->sc_gpio_pins;
120 	gba.gba_npins = GPIOSIM_NPINS;
121 
122 	pmf_device_register(self, NULL, NULL);
123 
124         sysctl_createv(&sc->sc_log, 0, NULL, &node,
125             0,
126             CTLTYPE_NODE, device_xname(sc->sc_dev),
127             SYSCTL_DESCR("GPIO simulator"),
128             NULL, 0, NULL, 0,
129             CTL_HW, CTL_CREATE, CTL_EOL);
130 
131         if (node == NULL) {
132 		printf(": can't create sysctl node\n");
133                 return;
134 	}
135 
136         sysctl_createv(&sc->sc_log, 0, &node, NULL,
137             CTLFLAG_READWRITE,
138             CTLTYPE_QUAD, "value",
139             SYSCTL_DESCR("Current GPIO simulator value"),
140             gpiosim_sysctl, 0, (void *)sc, 0,
141 	    CTL_CREATE, CTL_EOL);
142 
143 	printf(": simulating %d pins\n", GPIOSIM_NPINS);
144 	sc->sc_gdev = config_found_ia(self, "gpiobus", &gba, gpiobus_print);
145 }
146 
147 static int
148 gpiosim_detach(device_t self, int flags)
149 {
150 	struct gpiosim_softc *sc = device_private(self);
151 
152 	/* Detach the gpio driver that attached here */
153 	if (sc->sc_gdev != NULL)
154 		config_detach(sc->sc_gdev, 0);
155 
156 	pmf_device_deregister(self);
157 	if (sc->sc_log != NULL) {
158 		sysctl_teardown(&sc->sc_log);
159 		sc->sc_log = NULL;
160 	}
161 	return 0;
162 }
163 
164 static int
165 gpiosim_sysctl(SYSCTLFN_ARGS)
166 {
167 	struct sysctlnode node;
168 	struct gpiosim_softc *sc;
169 	uint64_t val, error;
170 
171 	node = *rnode;
172 	sc = node.sysctl_data;
173 
174 	node.sysctl_data = &val;
175 
176 	val = sc->sc_state;
177 	error = sysctl_lookup(SYSCTLFN_CALL(&node));
178 	if (error || newp == NULL)
179 		return error;
180 
181 	sc->sc_state = val;
182 	return 0;
183 }
184 
185 static int
186 gpiosim_pin_read(void *arg, int pin)
187 {
188 	struct gpiosim_softc *sc = arg;
189 
190 	if (sc->sc_state & (1LL << pin))
191 		return GPIO_PIN_HIGH;
192 	else
193 		return GPIO_PIN_LOW;
194 }
195 
196 static void
197 gpiosim_pin_write(void *arg, int pin, int value)
198 {
199 	struct gpiosim_softc *sc = arg;
200 
201 	if (value == 0)
202 		sc->sc_state &= ~(1LL << pin);
203 	else
204 		sc->sc_state |= (1LL << pin);
205 }
206 
207 static void
208 gpiosim_pin_ctl(void *arg, int pin, int flags)
209 {
210 	struct gpiosim_softc *sc = arg;
211 
212 	sc->sc_gpio_pins[pin].pin_flags = flags;
213 }
214 
215 MODULE(MODULE_CLASS_DRIVER, gpiosim, "gpio");
216 
217 #ifdef _MODULE
218 static const struct cfiattrdata gpiobus_iattrdata = {
219 	"gpiobus", 0, { { NULL, NULL, 0 },}
220 };
221 static const struct cfiattrdata *const gpiosim_attrs[] = {
222 	&gpiobus_iattrdata, NULL
223 };
224 CFDRIVER_DECL(gpiosim, DV_DULL, gpiosim_attrs);
225 extern struct cfattach gpiosim_ca;
226 static int gpiosimloc[] = {
227 	-1,
228 	-1,
229 	-1
230 };
231 static struct cfdata gpiosim_cfdata[] = {
232 	{
233 		.cf_name = "gpiosim",
234 		.cf_atname = "gpiosim",
235 		.cf_unit = 0,
236 		.cf_fstate = FSTATE_STAR,
237 		.cf_loc = gpiosimloc,
238 		.cf_flags = 0,
239 		.cf_pspec = NULL,
240 	},
241 	{ NULL, NULL, 0, FSTATE_NOTFOUND, NULL, 0, NULL }
242 };
243 #endif
244 
245 static int
246 gpiosim_modcmd(modcmd_t cmd, void *opaque)
247 {
248 #ifdef _MODULE
249 	int error = 0;
250 #endif
251 	switch (cmd) {
252 	case MODULE_CMD_INIT:
253 #ifdef _MODULE
254 		error = config_cfdriver_attach(&gpiosim_cd);
255 		if (error)
256 			return error;
257 
258 		error = config_cfattach_attach(gpiosim_cd.cd_name,
259 		    &gpiosim_ca);
260 		if (error) {
261 			config_cfdriver_detach(&gpiosim_cd);
262 			aprint_error("%s: unable to register cfattach\n",
263 			    gpiosim_cd.cd_name);
264 			return error;
265 		}
266 		error = config_cfdata_attach(gpiosim_cfdata, 1);
267 		if (error) {
268 			config_cfattach_detach(gpiosim_cd.cd_name,
269 			    &gpiosim_ca);
270 			config_cfdriver_detach(&gpiosim_cd);
271 			aprint_error("%s: unable to register cfdata\n",
272 			    gpiosim_cd.cd_name);
273 			return error;
274 		}
275 		config_attach_pseudo(gpiosim_cfdata);
276 #endif
277 		return 0;
278 	case MODULE_CMD_FINI:
279 #ifdef _MODULE
280 		error = config_cfdata_detach(gpiosim_cfdata);
281 		if (error)
282 			return error;
283 
284 		config_cfattach_detach(gpiosim_cd.cd_name, &gpiosim_ca);
285 		config_cfdriver_detach(&gpiosim_cd);
286 #endif
287 		return 0;
288 	case MODULE_CMD_AUTOUNLOAD:
289 		/* no auto-unload */
290 		return EBUSY;
291 	default:
292 		return ENOTTY;
293 	}
294 }
295