xref: /netbsd-src/sys/arch/evbarm/mpcsa/mpcsa_leds.c (revision dd3ee07da436799d8de85f3055253118b76bf345)
1 /*	$Id: mpcsa_leds.c,v 1.9 2022/01/19 05:21:44 thorpej Exp $	*/
2 /*	$NetBSD: mpcsa_leds.c,v 1.9 2022/01/19 05:21:44 thorpej Exp $	*/
3 
4 /*
5  * Copyright (c) 2007 Embedtronics Oy. All rights reserved.
6  *
7  * Based on arch/arm/ep93xx/epgpio.c,
8  * Copyright (c) 2005 HAMAJIMA Katsuomi. All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  */
31 
32 #include <sys/cdefs.h>
33 __KERNEL_RCSID(0, "$NetBSD: mpcsa_leds.c,v 1.9 2022/01/19 05:21:44 thorpej Exp $");
34 
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/device.h>
39 #include <sys/lock.h>
40 #include <sys/gpio.h>
41 #include <dev/spi/spivar.h>
42 #include <dev/gpio/gpiovar.h>
43 #include <evbarm/mpcsa/mpcsa_leds_var.h>
44 #include <evbarm/mpcsa/mpcsa_io.h>
45 #include "gpio.h"
46 #if NGPIO > 0
47 #include <sys/gpio.h>
48 #endif
49 #include "locators.h"
50 
51 #ifdef MPCSA_LEDS_DEBUG
52 int mpcsa_leds_debug = MPCSA_LEDS_DEBUG;
53 #define DPRINTFN(n,x)		if (mpcsa_leds_debug>(n)) printf x;
54 #else
55 #define DPRINTFN(n,x)
56 #endif
57 
58 #define	MPCSA_LEDS_NPINS		16
59 #define	LEDS_UPDATE_INTERVAL		100	/* update interval in milliseconds */
60 
61 enum {
62   LMODE_NORMAL,					/* normal mode */
63   LMODE_COMM,					/* communication mode */
64   LMODE_BLINK					/* blink mode */
65 };
66 
67 typedef struct led_state {
68 	int			l_mode;		/* current command */
69 	union {
70 		struct {
71 			int	l_conn_cnt;	/* connection count */
72 			int	l_comm_cnt;	/* comm/pkt count */
73 		};
74 		struct {
75 			int	l_blink_int;	/* blink interval */
76 			int	l_blink_cnt;	/* blink counter */
77 		};
78 	};
79 } led_state_t;
80 
81 struct mpcsa_leds_softc {
82 	struct spi_handle	*sc_sh;
83 
84 #if NGPIO > 0
85 	struct gpio_chipset_tag	sc_gpio_chipset;
86 	gpio_pin_t		sc_pins[MPCSA_LEDS_NPINS];
87 #endif
88 
89 	callout_t		sc_c;
90 	led_state_t		sc_leds[MPCSA_LEDS_NPINS];
91 	uint16_t		sc_pinstate;
92 
93 	struct spi_chunk	sc_spi_chunk;
94 	struct spi_transfer	sc_spi_transfer;
95 };
96 
97 static int mpcsa_leds_match(device_t , cfdata_t , void *);
98 static void mpcsa_leds_attach(device_t , device_t , void *);
99 static void mpcsa_leds_timer(void *aux);
100 
101 #if NGPIO > 0
102 static int mpcsa_ledsbus_print(void *, const char *);
103 static int mpcsa_leds_pin_read(void *, int);
104 static void mpcsa_leds_pin_write(void *, int, int);
105 static void mpcsa_leds_pin_ctl(void *, int, int);
106 #endif
107 
108 #if 0
109 static int mpcsa_leds_search(device_t , cfdata_t , const int *, void *);
110 static int mpcsa_leds_print(void *, const char *);
111 #endif
112 
113 CFATTACH_DECL_NEW(mpcsa_leds, sizeof(struct mpcsa_leds_softc),
114 	      mpcsa_leds_match, mpcsa_leds_attach, NULL, NULL);
115 
116 static struct mpcsa_leds_softc *mpcsa_leds_sc;
117 
118 static int
119 mpcsa_leds_match(device_t parent, cfdata_t match, void *aux)
120 {
121 
122 	if (strcmp(match->cf_name, "mpcsa_leds"))
123 		return 0;
124 
125 	return 2;
126 }
127 
128 static void
129 mpcsa_leds_attach(device_t parent, device_t self, void *aux)
130 {
131 	struct mpcsa_leds_softc *sc = device_private(self);
132 	struct spi_attach_args *sa = aux;
133 #if NGPIO > 0
134 	struct gpiobus_attach_args gba;
135 #endif
136 	int n;
137 	int error;
138 
139 	aprint_naive(": output buffer\n");
140 	aprint_normal(": 74HC595 or compatible shift register(s)\n");
141 
142 	error = spi_configure(self, sa->sa_handle, SPI_MODE_0, 10000000);
143 	if (error) {
144 		return;
145 	}
146 
147 	sc->sc_sh = sa->sa_handle;
148 	sc->sc_pinstate = 0xffff;
149 	callout_init(&sc->sc_c, 0);
150 
151 #if NGPIO > 0
152 	/* initialize and attach gpio(4) */
153 	for (n = 0; n < MPCSA_LEDS_NPINS; n++) {
154 		sc->sc_pins[n].pin_num = n;
155 		sc->sc_pins[n].pin_caps = (GPIO_PIN_OUTPUT
156 					   | GPIO_PIN_PUSHPULL);
157 		sc->sc_pins[n].pin_flags = GPIO_PIN_OUTPUT | GPIO_PIN_LOW;
158 	}
159 
160 	sc->sc_gpio_chipset.gp_cookie = sc;
161 	sc->sc_gpio_chipset.gp_pin_read = mpcsa_leds_pin_read;
162 	sc->sc_gpio_chipset.gp_pin_write = mpcsa_leds_pin_write;
163 	sc->sc_gpio_chipset.gp_pin_ctl = mpcsa_leds_pin_ctl;
164 	gba.gba_gc = &sc->sc_gpio_chipset;
165 	gba.gba_pins = sc->sc_pins;
166 	gba.gba_npins = MPCSA_LEDS_NPINS;
167 	config_found(self, &gba, mpcsa_ledsbus_print, CFARGS_NONE);
168 #endif
169 
170 	/* attach device */
171 //	config_search_ia(mpcsa_leds_search, self, "mpcsa_leds", mpcsa_leds_print);
172 
173 	/* update leds ten times a second or so */
174 	mpcsa_leds_sc = sc; // @@@@
175 	sc->sc_spi_transfer.st_flags = SPI_F_DONE;
176 	callout_reset(&sc->sc_c, mstohz(LEDS_UPDATE_INTERVAL), mpcsa_leds_timer, sc);
177 
178 	mpcsa_blink_led(LED_HB, 500);
179 }
180 
181 
182 
183 
184 #if NGPIO > 0
185 static int
186 mpcsa_ledsbus_print(void *aux, const char *name)
187 {
188 	gpiobus_print(aux, name);
189 	return (UNCONF);
190 }
191 
192 
193 static int
194 mpcsa_leds_pin_read(void *arg, int pin)
195 {
196 	struct mpcsa_leds_softc *sc = arg;
197 	pin %= MPCSA_LEDS_NPINS;
198 	return (sc->sc_pinstate & htobe16(1U << pin)) ? 1 : 0;
199 }
200 
201 static void
202 mpcsa_leds_pin_write(void *arg, int pin, int val)
203 {
204 	struct mpcsa_leds_softc *sc = arg;
205 	int s;
206 
207 	pin %= MPCSA_LEDS_NPINS;
208 	if (!sc->sc_pins[pin].pin_caps)
209 		return;
210 
211 	s = splserial();
212 	if (val)
213 		sc->sc_pinstate |= htobe16(1U << pin);
214 	else
215 		sc->sc_pinstate &= htobe16(~(1U << pin));
216 	splx(s);
217 
218 	if (spi_send(sc->sc_sh, 2, (const void *)&sc->sc_pinstate) != 0) {
219 		// @@@ do what? @@@
220 	}
221 }
222 
223 
224 static void
225 mpcsa_leds_pin_ctl(void *arg, int pin, int flags)
226 {
227 	struct mpcsa_leds_softc *sc = arg;
228 
229 	pin %= MPCSA_LEDS_NPINS;
230 	if (!sc->sc_pins[pin].pin_caps)
231 		return;
232 
233 	// hmm, I think there's nothing to do
234 }
235 #endif
236 
237 static void mpcsa_leds_timer(void *aux)
238 {
239 	int n, s;
240 	struct mpcsa_leds_softc *sc = aux;
241 	uint16_t pins;
242 
243 	callout_schedule(&sc->sc_c, mstohz(LEDS_UPDATE_INTERVAL));
244 
245 	s = splserial();
246 	if (!(sc->sc_spi_transfer.st_flags & SPI_F_DONE)) {
247 		splx(s);
248 		return;
249 	}
250 
251 
252 	pins = be16toh(sc->sc_pinstate);
253 
254 	for (n = 0; n < MPCSA_LEDS_NPINS; n++) {
255 		switch (sc->sc_leds[n].l_mode) {
256 		default:
257 			continue;
258 
259 		case LMODE_COMM:
260 			if (sc->sc_leds[n].l_comm_cnt > 0) {
261 				if (sc->sc_leds[n].l_comm_cnt < INFINITE_BLINK)
262 					sc->sc_leds[n].l_comm_cnt--;
263 				else
264 					sc->sc_leds[n].l_comm_cnt ^= 1;
265 			}
266 			if ((sc->sc_leds[n].l_conn_cnt > 0) ^ (sc->sc_leds[n].l_comm_cnt & 1))
267 				pins &= ~(1U << n);
268 			else
269 				pins |= (1U << n);
270 			break;
271 
272 		case LMODE_BLINK:
273 			if (--sc->sc_leds[n].l_blink_cnt <= 0) {
274 				pins ^= (1U << n);
275 				sc->sc_leds[n].l_blink_cnt = sc->sc_leds[n].l_blink_int;
276 			}
277 			break;
278 		}
279 	}
280 
281 	HTOBE16(pins);
282 	sc->sc_pinstate = pins;
283 	splx(s);
284 
285 	spi_transfer_init(&sc->sc_spi_transfer);
286 	spi_chunk_init(&sc->sc_spi_chunk, 2, (const void *)&sc->sc_pinstate, NULL);
287 	spi_transfer_add(&sc->sc_spi_transfer, &sc->sc_spi_chunk);
288 	if (spi_transfer(sc->sc_sh, &sc->sc_spi_transfer) != 0) {
289 		/* an error occurred! */
290 	}
291 }
292 
293 void mpcsa_comm_led(int num, int count)
294 {
295 	struct mpcsa_leds_softc *sc = mpcsa_leds_sc;
296 	if (!sc || num < 1 || num > MPCSA_LEDS_NPINS) {
297 		return;
298 	}
299 	num--;
300 	count *= 2;
301 	int s = splserial();
302 	if (sc->sc_leds[num].l_mode != LMODE_COMM) {
303 		sc->sc_leds[num].l_mode = LMODE_COMM;
304 		sc->sc_leds[num].l_conn_cnt = 0;
305 		sc->sc_leds[num].l_comm_cnt = 0;
306 	}
307 	if (sc->sc_leds[num].l_comm_cnt < (count * 2 - 1))
308 		sc->sc_leds[num].l_comm_cnt += count;
309 	else if ((count * 2) < sc->sc_leds[num].l_comm_cnt)
310 		sc->sc_leds[num].l_comm_cnt = count * 2 - 2 - (sc->sc_leds[num].l_comm_cnt % 2);
311 	splx(s);
312 }
313 
314 void mpcsa_conn_led(int num, int ok)
315 {
316 	struct mpcsa_leds_softc *sc = mpcsa_leds_sc;
317 	if (!sc || num < 1 || num > MPCSA_LEDS_NPINS)
318 		return;
319 	num--;
320 	int s = splserial();
321 	if (sc->sc_leds[num].l_mode != LMODE_COMM) {
322 		sc->sc_leds[num].l_mode = LMODE_COMM;
323 		sc->sc_leds[num].l_conn_cnt = 0;
324 		sc->sc_leds[num].l_comm_cnt = 0;
325 	}
326 	if (ok)
327 		sc->sc_leds[num].l_conn_cnt++;
328 	else
329 		sc->sc_leds[num].l_conn_cnt--;
330 	splx(s);
331 }
332 
333 void mpcsa_blink_led(int num, int interval)
334 {
335 	struct mpcsa_leds_softc *sc = mpcsa_leds_sc;
336 	if (!sc || num < 1 || num > MPCSA_LEDS_NPINS) {
337 		return;
338 	}
339 	interval = (interval + LEDS_UPDATE_INTERVAL + 1) / LEDS_UPDATE_INTERVAL;
340 	num--;
341 	int s = splserial();
342 	if (sc->sc_leds[num].l_mode != LMODE_COMM) {
343 		sc->sc_leds[num].l_mode = LMODE_BLINK;
344 		sc->sc_leds[num].l_blink_cnt = interval;
345 	}
346 	sc->sc_leds[num].l_blink_int = interval;
347 	splx(s);
348 }
349