LUFA/Drivers/Board/AVR8/BUMBLEB/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Board specific LED driver header for the Fletchtronics BUMBLEB.
  33  *  \copydetails Group_LEDs_BUMBLEB
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  36  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  37  */
  38
  39 /** \ingroup Group_LEDs
  40  *  \defgroup Group_LEDs_BUMBLEB BUMBLEB
  41  *  \brief Board specific LED driver header for the Fletchtronics BUMBLEB.
  42  *
  43  *  Board specific LED driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
  44  *  third-party board does not include any on-board peripherals, but does have an officially recommended external
  45  *  peripheral layout for buttons, LEDs and a Joystick.
  46  *
  47  *  <table>
  48  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  49  *    <tr><td>LEDS_LED1</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.4</td></tr>
  50  *    <tr><td>LEDS_LED2</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.5</td></tr>
  51  *    <tr><td>LEDS_LED3</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.6</td></tr>
  52  *    <tr><td>LEDS_LED4</td><td>N/A</td><td>User Supplied</td><td>High</td><td>PORTB.7</td></tr>
  53  *  </table>
  54  *
  55  *  @{
  56  */
  57
  58 #ifndef __LEDS_BUMBLEB_H__
  59 #define __LEDS_BUMBLEB_H__
  60
  61         /* Includes: */
  62                 #include "../../../../Common/Common.h"
  63
  64         /* Enable C linkage for C++ Compilers: */
  65                 #if defined(__cplusplus)
  66                         extern "C" {
  67                 #endif
  68
  69         /* Preprocessor Checks: */
  70                 #if !defined(__INCLUDE_FROM_LEDS_H)
  71                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  72                 #endif
  73
  74         /* Public Interface - May be used in end-application: */
  75                 /* Macros: */
  76                         /** LED mask for the first LED on the board. */
  77                         #define LEDS_LED1        (1 << 4)
  78
  79                         /** LED mask for the second LED on the board. */
  80                         #define LEDS_LED2        (1 << 5)
  81
  82                         /** LED mask for the third LED on the board. */
  83                         #define LEDS_LED3        (1 << 6)
  84
  85                         /** LED mask for the fourth LED on the board. */
  86                         #define LEDS_LED4        (1 << 7)
  87
  88                         /** LED mask for all the LEDs on the board. */
  89                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  90
  91                         /** LED mask for none of the board LEDs. */
  92                         #define LEDS_NO_LEDS     0
  93
  94                 /* Inline Functions: */
  95                 #if !defined(__DOXYGEN__)
  96                         static inline void LEDs_Init(void)
  97                         {
  98                                 DDRB  |=  LEDS_ALL_LEDS;
  99                                 PORTB &= ~LEDS_ALL_LEDS;
 100                         }
 101
 102                         static inline void LEDs_Disable(void)
 103                         {
 104                                 DDRB  &= ~LEDS_ALL_LEDS;
 105                                 PORTB &= ~LEDS_ALL_LEDS;
 106                         }
 107
 108                         static inline void LEDs_TurnOnLEDs(const uint8_t LedMask)
 109                         {
 110                                 PORTB |= LedMask;
 111                         }
 112
 113                         static inline void LEDs_TurnOffLEDs(const uint8_t LedMask)
 114                         {
 115                                 PORTB &= ~LedMask;
 116                         }
 117
 118                         static inline void LEDs_SetAllLEDs(const uint8_t LedMask)
 119                         {
 120                                 PORTB = ((PORTB & ~LEDS_ALL_LEDS) | LedMask);
 121                         }
 122
 123                         static inline void LEDs_ChangeLEDs(const uint8_t LedMask,
 124                                                            const uint8_t ActiveMask)
 125                         {
 126                                 PORTB = ((PORTB & ~LedMask) | ActiveMask);
 127                         }
 128
 129                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 130                         {
 131                                 PINB  = LEDMask;
 132                         }
 133
 134                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 135                         static inline uint8_t LEDs_GetLEDs(void)
 136                         {
 137                                 return (PORTB & LEDS_ALL_LEDS);
 138                         }
 139                 #endif
 140
 141         /* Disable C linkage for C++ Compilers: */
 142                 #if defined(__cplusplus)
 143                         }
 144                 #endif
 145
 146 #endif
 147
 148 /** @} */
 149