1/*-
2 * Copyright (c) 2012 Robert N. M. Watson
3 * All rights reserved.
4 *
5 * This software was developed by SRI International and the University of
6 * Cambridge Computer Laboratory under DARPA/AFRL contract (FA8750-10-C-0237)
7 * ("CTSRD"), as part of the DARPA CRASH research programme.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 *    notice, this list of conditions and the following disclaimer in the
16 *    documentation and/or other materials provided with the distribution.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD$
31 */
32
33#ifndef _DEV_TERASIC_DE4LED_H_
34#define	_DEV_TERASIC_DE4LED_H_
35
36#define	TERASIC_DE4LED_NUMLEDS	8
37struct terasic_de4led_softc {
38	device_t	 tdl_dev;
39	int		 tdl_unit;
40	struct resource	*tdl_res;
41	int		 tdl_rid;
42	struct mtx	 tdl_lock;
43	uint8_t		 tdl_bits;
44	struct cdev	*tdl_leds[TERASIC_DE4LED_NUMLEDS];
45};
46
47#define	TERASIC_DE4LED_LOCK(sc)		mtx_lock(&(sc)->tdl_lock)
48#define	TERASIC_DE4LED_LOCK_ASSERT(sc)	mtx_assert(&(sc)->tdl_lock, MA_OWNED)
49#define	TERASIC_DE4LED_LOCK_DESTROY(sc)	mtx_destroy(&(sc)->tdl_lock)
50#define	TERASIC_DE4LED_LOCK_INIT(sc)	mtx_init(&(sc)->tdl_lock,	\
51					    "terasic_de4led", NULL, MTX_DEF)
52#define	TERASIC_DE4LED_UNLOCK(sc)	mtx_unlock(&(sc)->tdl_lock)
53
54/*
55 * Setting and clearing LEDs.  tdl_bits is in the bit order preferred for I/O.
56 * The LED elements are labelled 1..8 on the DE-4, so bit 0 is LED 1, and so
57 * on.
58 */
59#define	TERASIC_DE4LED_CLEARBAR(sc) do {				\
60	(sc)->tdl_bits = 0;						\
61} while (0)
62#define	TERASIC_DE4LED_SETLED(sc, led, onoff) do {			\
63	(sc)->tdl_bits &= ~(1 << (led));				\
64	(sc)->tdl_bits |= ((onoff != 0) ? 1 : 0) << (led);		\
65} while (0)
66
67/*
68 * Only one offset matters for this device -- 0.
69 */
70#define	TERASIC_DE4LED_OFF_LED		0
71
72void	terasic_de4led_attach(struct terasic_de4led_softc *sc);
73void	terasic_de4led_detach(struct terasic_de4led_softc *sc);
74
75extern devclass_t	terasic_de4led_devclass;
76
77#endif /* _DEV_TERASIC_DE4LED_H_ */
78