protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/USB2AX/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 Paranoid Studio USB2AX.\r
  33  *  \copydetails Group_LEDs_USB2AX\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_USB2AX_V3 USB2AX_V3\r
  41  *  \brief Board specific LED driver header for the Paranoid Studio USB2AX revision 3.\r
  42  *\r
  43  *  See \ref Group_LEDs_USB2AX for more details.\r
  44  */\r
  45 \r
  46 /** \ingroup Group_LEDs\r
  47  *  \defgroup Group_LEDs_USB2AX USB2AX\r
  48  *  \brief Board specific LED driver header for the Paranoid Studio USB2AX.\r
  49  *\r
  50  *  \note For version 3 USB2AX boards, compile with <code>BOARD = USB2AX_V3</code>.\r
  51  *\r
  52  *  Board specific LED driver header for the Paranoid Studio USB2AX (http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX).\r
  53  *\r
  54  *  <b>USB2AX</b>:\r
  55  *  <table>\r
  56  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  57  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTC.6</td></tr>\r
  58  *  </table>\r
  59  *\r
  60  *  <b>USB2AX_V3</b>:\r
  61  *  <table>\r
  62  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  63  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.1</td></tr>\r
  64  *  </table>\r
  65  *\r
  66  *  @{\r
  67  */\r
  68 \r
  69 #ifndef __LEDS_USB2AX_H__\r
  70 #define __LEDS_USB2AX_H__\r
  71 \r
  72         /* Includes: */\r
  73                 #include "../../../../Common/Common.h"\r
  74 \r
  75         /* Enable C linkage for C++ Compilers: */\r
  76                 #if defined(__cplusplus)\r
  77                         extern "C" {\r
  78                 #endif\r
  79 \r
  80         /* Preprocessor Checks: */\r
  81                 #if !defined(__INCLUDE_FROM_LEDS_H)\r
  82                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
  83                 #endif\r
  84 \r
  85         /* Private Interface - For use in library only: */\r
  86         #if !defined(__DOXYGEN__)\r
  87                 /* Macros: */\r
  88                         #if (BOARD == BOARD_USB2AX)\r
  89                                 #define USB2AX_LEDS_LED1   (1 << 6)\r
  90                         #else\r
  91                                 #define USB2AX_LEDS_LED1   (1 << 1)                     \r
  92                         #endif\r
  93         #endif\r
  94 \r
  95         /* Public Interface - May be used in end-application: */\r
  96                 /* Macros: */\r
  97                         /** LED mask for the first LED on the board. */\r
  98                         #define LEDS_LED1        USB2AX_LEDS_LED1\r
  99 \r
 100                         /** LED mask for all the LEDs on the board. */\r
 101                         #define LEDS_ALL_LEDS    LEDS_LED1\r
 102 \r
 103                         /** LED mask for none of the board LEDs. */\r
 104                         #define LEDS_NO_LEDS     0\r
 105 \r
 106                 /* Inline Functions: */\r
 107                 #if !defined(__DOXYGEN__)\r
 108                         static inline void LEDs_Init(void)\r
 109                         {\r
 110                                 #if (BOARD == BOARD_USB2AX)\r
 111                                 DDRC  |=  LEDS_ALL_LEDS;\r
 112                                 PORTC &= ~LEDS_ALL_LEDS;                                \r
 113                                 #else\r
 114                                 DDRD  |=  LEDS_ALL_LEDS;\r
 115                                 PORTD &= ~LEDS_ALL_LEDS;                                \r
 116                                 #endif                          \r
 117                         }\r
 118 \r
 119                         static inline void LEDs_Disable(void)\r
 120                         {\r
 121                                 #if (BOARD == BOARD_USB2AX)\r
 122                                 DDRC  &= ~LEDS_ALL_LEDS;\r
 123                                 PORTC &= ~LEDS_ALL_LEDS;                                \r
 124                                 #else\r
 125                                 DDRD  &= ~LEDS_ALL_LEDS;\r
 126                                 PORTD &= ~LEDS_ALL_LEDS;                                \r
 127                                 #endif                          \r
 128                         }\r
 129 \r
 130                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
 131                         {\r
 132                                 #if (BOARD == BOARD_USB2AX)\r
 133                                 PORTC |= LEDMask;                               \r
 134                                 #else\r
 135                                 PORTD |= LEDMask;\r
 136                                 #endif\r
 137                         }\r
 138 \r
 139                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
 140                         {\r
 141                                 #if (BOARD == BOARD_USB2AX)\r
 142                                 PORTC &= ~LEDMask;\r
 143                                 #else\r
 144                                 PORTD &= ~LEDMask;\r
 145                                 #endif\r
 146                         }\r
 147 \r
 148                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
 149                         {\r
 150                                 #if (BOARD == BOARD_USB2AX)\r
 151                                 PORTC = ((PORTC & ~LEDS_ALL_LEDS) | LEDMask);                           \r
 152                                 #else\r
 153                                 PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);\r
 154                                 #endif\r
 155                         }\r
 156 \r
 157                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,\r
 158                                                            const uint8_t ActiveMask)\r
 159                         {\r
 160                                 #if (BOARD == BOARD_USB2AX)\r
 161                                 PORTC = ((PORTC & ~LEDMask) | ActiveMask);                              \r
 162                                 #else\r
 163                                 PORTD = ((PORTD & ~LEDMask) | ActiveMask);\r
 164                                 #endif\r
 165                         }\r
 166 \r
 167                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
 168                         {\r
 169                                 #if (BOARD == BOARD_USB2AX)\r
 170                                 PINC  = LEDMask;                                \r
 171                                 #else\r
 172                                 PIND  = LEDMask;\r
 173                                 #endif\r
 174                         }\r
 175 \r
 176                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 177                         static inline uint8_t LEDs_GetLEDs(void)\r
 178                         {\r
 179                                 #if (BOARD == BOARD_USB2AX)\r
 180                                 return (PORTC & LEDS_ALL_LEDS);                         \r
 181                                 #else\r
 182                                 return (PORTD & LEDS_ALL_LEDS);\r
 183                                 #endif\r
 184                         }\r
 185                 #endif\r
 186 \r
 187         /* Disable C linkage for C++ Compilers: */\r
 188                 #if defined(__cplusplus)\r
 189                         }\r
 190                 #endif\r
 191 \r
 192 #endif\r
 193 \r
 194 /** @} */\r
 195 \r
 196 \r