protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/TEENSY/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 PJRC Teensy 1.x/2.x boards.\r
  33  *  \copydetails Group_LEDs_TEENSY\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_TEENSY2 TEENSY2\r
  41  *  \brief Board specific LED driver header for the PJRC Teensy 2 boards.\r
  42  *\r
  43  *  See \ref Group_LEDs_TEENSY for more details.\r
  44  */\r
  45 \r
  46 /** \ingroup Group_LEDs\r
  47  *  \defgroup Group_LEDs_TEENSY TEENSY\r
  48  *  \brief Board specific LED driver header for the PJRC Teensy 1.x/2.x boards.\r
  49  *\r
  50  *  \note For version 2 Teensy boards, compile with <code>BOARD = TEENSY2</code>.\r
  51  *\r
  52  *  Board specific LED driver header for the PJRC Teensy boards (http://www.pjrc.com/teensy/index.html).\r
  53  *\r
  54  *  <b>TEENSY</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>PORTD.6</td></tr>\r
  58  *  </table>\r
  59  *\r
  60  *  <b>TEENSY2</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>Low</td><td>PORTD.6</td></tr>\r
  64  *  </table>\r
  65  *\r
  66  *  @{\r
  67  */\r
  68 \r
  69 #ifndef __LEDS_TEENSY_H__\r
  70 #define __LEDS_TEENSY_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         /* Public Interface - May be used in end-application: */\r
  86                 /* Macros: */\r
  87                         /** LED mask for the first LED on the board. */\r
  88                         #define LEDS_LED1        (1 << 6)\r
  89 \r
  90                         /** LED mask for all the LEDs on the board. */\r
  91                         #define LEDS_ALL_LEDS    LEDS_LED1\r
  92 \r
  93                         /** LED mask for none of the board LEDs. */\r
  94                         #define LEDS_NO_LEDS     0\r
  95 \r
  96                 /* Inline Functions: */\r
  97                 #if !defined(__DOXYGEN__)\r
  98                         static inline void LEDs_Init(void)\r
  99                         {\r
 100                                 DDRD  |= LEDS_ALL_LEDS;\r
 101 \r
 102                                 #if (BOARD == BOARD_TEENSY2)\r
 103                                 PORTD &= ~LEDS_ALL_LEDS;\r
 104                                 #else\r
 105                                 PORTD |=  LEDS_ALL_LEDS;\r
 106                                 #endif\r
 107                         }\r
 108 \r
 109                         static inline void LEDs_Disable(void)\r
 110                         {\r
 111                                 DDRD  &= ~LEDS_ALL_LEDS;\r
 112                                 PORTD &= ~LEDS_ALL_LEDS;\r
 113                         }\r
 114 \r
 115                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
 116                         {\r
 117                                 #if (BOARD == BOARD_TEENSY2)\r
 118                                 PORTD |=  LEDMask;\r
 119                                 #else\r
 120                                 PORTD &= ~LEDMask;\r
 121                                 #endif\r
 122                         }\r
 123 \r
 124                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
 125                         {\r
 126                                 #if (BOARD == BOARD_TEENSY2)\r
 127                                 PORTD &= ~LEDMask;\r
 128                                 #else\r
 129                                 PORTD |=  LEDMask;\r
 130                                 #endif\r
 131                         }\r
 132 \r
 133                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
 134                         {\r
 135                                 #if (BOARD == BOARD_TEENSY2)\r
 136                                 PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);\r
 137                                 #else\r
 138                                 PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);\r
 139                                 #endif\r
 140                         }\r
 141 \r
 142                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,\r
 143                                                            const uint8_t ActiveMask)\r
 144                         {\r
 145                                 #if (BOARD == BOARD_TEENSY2)\r
 146                                 PORTD = ((PORTD & ~LEDMask) | ActiveMask);\r
 147                                 #else\r
 148                                 PORTD = ((PORTD | LEDMask) & ~ActiveMask);\r
 149                                 #endif\r
 150                         }\r
 151 \r
 152                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
 153                         {\r
 154                                 PIND  = LEDMask;\r
 155                         }\r
 156 \r
 157                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 158                         static inline uint8_t LEDs_GetLEDs(void)\r
 159                         {\r
 160                                 #if (BOARD == BOARD_TEENSY2)\r
 161                                 return (PORTD & LEDS_ALL_LEDS);\r
 162                                 #else\r
 163                                 return (~PORTD & LEDS_ALL_LEDS);\r
 164                                 #endif\r
 165                         }\r
 166                 #endif\r
 167 \r
 168         /* Disable C linkage for C++ Compilers: */\r
 169                 #if defined(__cplusplus)\r
 170                         }\r
 171                 #endif\r
 172 \r
 173 #endif\r
 174 \r
 175 /** @} */\r
 176 \r