sys/dev/terasic/de4led/terasic_de4led.h

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