protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/MICROPENDOUS/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 Micropendous-32U2.\r
  33  *  \copydetails Group_LEDs_MICROPENDOUS_32U2\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_MICROPENDOUS_REV1 MICROPENDOUS_REV1\r
  41  *  \brief Board specific LED driver header for the Micropendous Arduino-like Revision 1 (https://code.google.com/p/micropendous/wiki/Micropendous).\r
  42  *\r
  43  *  See \ref Group_LEDs_MICROPENDOUS_32U2 for more details.\r
  44  */\r
  45 \r
  46 /** \ingroup Group_LEDs\r
  47  *  \defgroup Group_LEDs_MICROPENDOUS_REV2 MICROPENDOUS_REV2\r
  48  *  \brief Board specific LED driver header for the Micropendous Arduino-like Revision 2 (https://code.google.com/p/micropendous/wiki/Micropendous).\r
  49  *\r
  50  *  See \ref Group_LEDs_MICROPENDOUS_32U2 for more details.\r
  51  */\r
  52 \r
  53 /** \ingroup Group_LEDs\r
  54  *  \defgroup Group_LEDs_MICROPENDOUS_32U2 MICROPENDOUS_32U2\r
  55  *  \brief Board specific LED driver header for the Micropendous-32U2.\r
  56  *\r
  57  *  Board specific LED driver header for the Micropendous 32U2 (https://code.google.com/p/micropendous/wiki/Micropendous_32U2).\r
  58  *\r
  59  *  <b>BOARD_MICROPENDOUS_32U2</b>:\r
  60  *  <table>\r
  61  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  62  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.6</td></tr>\r
  63  *  </table>\r
  64  *\r
  65  *  <b>Other Revisions</b>:\r
  66  *  <table>\r
  67  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  68  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTB.1</td></tr>\r
  69  *  </table>\r
  70  *\r
  71  *  @{\r
  72  */\r
  73 \r
  74 #ifndef __LEDS_MICROPENDOUS_H__\r
  75 #define __LEDS_MICROPENDOUS_H__\r
  76 \r
  77         /* Includes: */\r
  78                 #include "../../../../Common/Common.h"\r
  79 \r
  80         /* Enable C linkage for C++ Compilers: */\r
  81                 #if defined(__cplusplus)\r
  82                         extern "C" {\r
  83                 #endif\r
  84 \r
  85         /* Preprocessor Checks: */\r
  86                 #if !defined(__INCLUDE_FROM_LEDS_H)\r
  87                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
  88                 #endif\r
  89 \r
  90         /* Private Interface - For use in library only: */\r
  91         #if !defined(__DOXYGEN__)\r
  92                 #if (BOARD == BOARD_MICROPENDOUS_32U2)\r
  93                         #define _BOARD_LED1_MASK                (1 << 6)\r
  94                         #define _BOARD_LED_PORTLETTER           D\r
  95                 #elif (BOARD == BOARD_MICROPENDOUS_REV1)\r
  96                         #define _BOARD_LED1_MASK                (1 << 1)\r
  97                         #define _BOARD_LED_PORTLETTER           B\r
  98                 #elif (BOARD == BOARD_MICROPENDOUS_REV2)\r
  99                         #define _BOARD_LED1_MASK                (1 << 1)\r
 100                         #define _BOARD_LED_PORTLETTER           B\r
 101                 #endif\r
 102                 \r
 103                 #define _BOARD_LED_CONCAT2(Reg, Letter)     Reg ## Letter\r
 104                 #define _BOARD_LED_CONCAT(Reg, Letter)      _BOARD_LED_CONCAT2(Reg, Letter)\r
 105 \r
 106                 #define _BOARD_LED_PORT                     _BOARD_LED_CONCAT(PORT, _BOARD_LED_PORTLETTER)\r
 107                 #define _BOARD_LED_PIN                      _BOARD_LED_CONCAT(PIN,  _BOARD_LED_PORTLETTER)\r
 108                 #define _BOARD_LED_DDR                      _BOARD_LED_CONCAT(DDR,  _BOARD_LED_PORTLETTER)\r
 109         #endif\r
 110 \r
 111         /* Public Interface - May be used in end-application: */\r
 112                 /* Macros: */\r
 113                         /** LED mask for the first LED on the board. */\r
 114                         #define LEDS_LED1        _BOARD_LED1_MASK\r
 115 \r
 116                         /** LED mask for all the LEDs on the board. */\r
 117                         #define LEDS_ALL_LEDS    LEDS_LED1\r
 118 \r
 119                         /** LED mask for the none of the board LEDs. */\r
 120                         #define LEDS_NO_LEDS     0\r
 121 \r
 122                 /* Inline Functions: */\r
 123                 #if !defined(__DOXYGEN__)\r
 124                         static inline void LEDs_Init(void)\r
 125                         {\r
 126                                 _BOARD_LED_DDR  |=  LEDS_ALL_LEDS;\r
 127                                 _BOARD_LED_PORT &= ~LEDS_ALL_LEDS;\r
 128                         }\r
 129 \r
 130                         static inline void LEDs_Disable(void)\r
 131                         {\r
 132                                 _BOARD_LED_DDR  &= ~LEDS_ALL_LEDS;\r
 133                                 _BOARD_LED_PORT &= ~LEDS_ALL_LEDS;\r
 134                         }\r
 135 \r
 136                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
 137                         {\r
 138                                 _BOARD_LED_PORT |= LEDMask;\r
 139                         }\r
 140 \r
 141                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
 142                         {\r
 143                                 _BOARD_LED_PORT &= ~LEDMask;\r
 144                         }\r
 145 \r
 146                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
 147                         {\r
 148                                 _BOARD_LED_PORT = ((_BOARD_LED_PORT & ~LEDS_ALL_LEDS) | LEDMask);\r
 149                         }\r
 150 \r
 151                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,\r
 152                                                            const uint8_t ActiveMask)\r
 153                         {\r
 154                                 _BOARD_LED_PORT = ((_BOARD_LED_PORT & ~LEDMask) | ActiveMask);\r
 155                         }\r
 156 \r
 157                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
 158                         {\r
 159                                 _BOARD_LED_PIN  = LEDMask;\r
 160                         }\r
 161 \r
 162                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 163                         static inline uint8_t LEDs_GetLEDs(void)\r
 164                         {\r
 165                                 return (_BOARD_LED_PORT & LEDS_ALL_LEDS);\r
 166                         }\r
 167                 #endif\r
 168 \r
 169         /* Disable C linkage for C++ Compilers: */\r
 170                 #if defined(__cplusplus)\r
 171                         }\r
 172                 #endif\r
 173 \r
 174 #endif\r
 175 \r
 176 /** @} */\r
 177 \r