protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/BUMBLEB/LEDs.h

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