protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/UDIP/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 Linnix UDIP.\r
  33  *  \copydetails Group_LEDs_UDIP\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_UDIP UDIP\r
  41  *  \brief Board specific LED driver header for the Linnix UDIP.\r
  42  *\r
  43  *  Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).\r
  44  *\r
  45  *  <table>\r
  46  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  47  *    <tr><td>LEDS_LED1</td><td>Green</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTB.6</td></tr>\r
  48  *    <tr><td>LEDS_LED2</td><td>Red</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTB.5</td></tr>\r
  49  *    <tr><td>LEDS_LED3</td><td>Green</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTD.5</td></tr>\r
  50  *    <tr><td>LEDS_LED4</td><td>Red</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTD.4</td></tr>\r
  51  *  </table>\r
  52  *\r
  53  *  @{\r
  54  */\r
  55 \r
  56 #ifndef __LEDS_UDIP_H__\r
  57 #define __LEDS_UDIP_H__\r
  58 \r
  59         /* Includes: */\r
  60                 #include "../../../../Common/Common.h"\r
  61 \r
  62         /* Enable C linkage for C++ Compilers: */\r
  63                 #if defined(__cplusplus)\r
  64                         extern "C" {\r
  65                 #endif\r
  66 \r
  67         /* Preprocessor Checks: */\r
  68                 #if !defined(__INCLUDE_FROM_LEDS_H)\r
  69                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
  70                 #endif\r
  71 \r
  72         /* Private Interface - For use in library only: */\r
  73         #if !defined(__DOXYGEN__)\r
  74                 /* Macros: */\r
  75                         #define LEDS_PORTB_LEDS       (LEDS_LED1 | LEDS_LED2)\r
  76                         #define LEDS_PORTD_LEDS       (LEDS_LED3 | LEDS_LED4)\r
  77 \r
  78                         #define LEDS_PORTD_MASK_SHIFT 1\r
  79         #endif\r
  80 \r
  81         /* Public Interface - May be used in end-application: */\r
  82                 /* Macros: */\r
  83                         /** LED mask for the first LED on the board. */\r
  84                         #define LEDS_LED1        (1 << 6)\r
  85 \r
  86                         /** LED mask for the second LED on the board. */\r
  87                         #define LEDS_LED2        (1 << 5)\r
  88 \r
  89                         /** LED mask for the third LED on the board. */\r
  90                         #define LEDS_LED3        ((1 << 5) >> LEDS_PORTD_MASK_SHIFT)\r
  91 \r
  92                         /** LED mask for the fourth LED on the board. */\r
  93                         #define LEDS_LED4        ((1 << 4) >> LEDS_PORTD_MASK_SHIFT)\r
  94 \r
  95                         /** LED mask for all the LEDs on the board. */\r
  96                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)\r
  97 \r
  98                         /** LED mask for none of the board LEDs. */\r
  99                         #define LEDS_NO_LEDS     0\r
 100 \r
 101                 /* Inline Functions: */\r
 102                 #if !defined(__DOXYGEN__)\r
 103                         static inline void LEDs_Init(void)\r
 104                         {\r
 105                                 DDRB |= LEDS_PORTB_LEDS;\r
 106                                 DDRD |= (LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT);\r
 107                         }\r
 108 \r
 109                         static inline void LEDs_Disable(void)\r
 110                         {\r
 111                                 DDRB &= ~LEDS_PORTB_LEDS;\r
 112                                 DDRD &= ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT);\r
 113                         }\r
 114 \r
 115                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
 116                         {\r
 117                                 PORTB |= (LEDMask & LEDS_PORTB_LEDS);\r
 118                                 PORTD |= ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
 119                         }\r
 120 \r
 121                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
 122                         {\r
 123                                 PORTB &= ~(LEDMask & LEDS_PORTB_LEDS);\r
 124                                 PORTD &= ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
 125                         }\r
 126 \r
 127                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
 128                         {\r
 129                                 PORTB = (PORTB & ~LEDS_PORTB_LEDS) | (LEDMask & LEDS_PORTB_LEDS);\r
 130                                 PORTD = (PORTD & ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT)) |\r
 131                                         ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
 132                         }\r
 133 \r
 134                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,\r
 135                                                            const uint8_t ActiveMask)\r
 136                         {\r
 137                                 PORTB = (PORTB & ~(LEDMask & LEDS_PORTB_LEDS)) | (ActiveMask & LEDS_PORTB_LEDS);\r
 138                                 PORTD = (PORTD & ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT)) |\r
 139                                         ((ActiveMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
 140                         }\r
 141 \r
 142                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
 143                         {\r
 144                                 PINB  = (LEDMask & LEDS_PORTB_LEDS);\r
 145                                 PIND  = ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
 146                         }\r
 147 \r
 148                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 149                         static inline uint8_t LEDs_GetLEDs(void)\r
 150                         {\r
 151                                 return ((PORTB & LEDS_PORTB_LEDS) | ((PORTD & LEDS_PORTD_LEDS) >> LEDS_PORTD_MASK_SHIFT));\r
 152                         }\r
 153                 #endif\r
 154 \r
 155         /* Disable C linkage for C++ Compilers: */\r
 156                 #if defined(__cplusplus)\r
 157                         }\r
 158                 #endif\r
 159 \r
 160 #endif\r
 161 \r
 162 /** @} */\r
 163 \r