protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/DUCE/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 DorkbotPDX Duce.\r
  33  *  \copydetails Group_LEDs_DUCE\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_DUCE DUCE\r
  41  *  \brief Board specific LED driver header for the DorkbotPDX Duce.\r
  42  *\r
  43  *  Board specific LED driver header for the DorkbotPDX Duce (http://dorkbotpdx.org/wiki/duce).\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>Red</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTC.4</td></tr>\r
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTC.5</td></tr>\r
  49  *    <tr><td>LEDS_LED3</td><td>Red</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTC.6</td></tr>\r
  50  *    <tr><td>LEDS_LED4</td><td>Green</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTC.7</td></tr>\r
  51  *  </table>\r
  52  *\r
  53  *  @{\r
  54  */\r
  55 \r
  56 #ifndef __LEDS_DUCE_H__\r
  57 #define __LEDS_DUCE_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         /* Public Interface - May be used in end-application: */\r
  73                 /* Macros: */\r
  74                         /** LED mask for the first LED on the board. */\r
  75                         #define LEDS_LED1        (1 << 4)\r
  76 \r
  77                         /** LED mask for the second LED on the board. */\r
  78                         #define LEDS_LED2        (1 << 5)\r
  79 \r
  80                         /** LED mask for the third LED on the board. */\r
  81                         #define LEDS_LED3        (1 << 6)\r
  82 \r
  83                         /** LED mask for the fourth LED on the board. */\r
  84                         #define LEDS_LED4        (1 << 7)\r
  85 \r
  86                         /** LED mask for all the LEDs on the board. */\r
  87                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)\r
  88 \r
  89                         /** LED mask for none of the board LEDs. */\r
  90                         #define LEDS_NO_LEDS     0\r
  91 \r
  92                 /* Inline Functions: */\r
  93                 #if !defined(__DOXYGEN__)\r
  94                         static inline void LEDs_Init(void)\r
  95                         {\r
  96                                 DDRC  |=  LEDS_ALL_LEDS;\r
  97                                 PORTC &= ~LEDS_ALL_LEDS;\r
  98                         }\r
  99 \r
 100                         static inline void LEDs_Disable(void)\r
 101                         {\r
 102                                 DDRC  &= ~LEDS_ALL_LEDS;\r
 103                                 PORTC &= ~LEDS_ALL_LEDS;\r
 104                         }\r
 105 \r
 106                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
 107                         {\r
 108                                 PORTC |= LEDMask;\r
 109                         }\r
 110 \r
 111                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
 112                         {\r
 113                                 PORTC &= ~LEDMask;\r
 114                         }\r
 115 \r
 116                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
 117                         {\r
 118                                 PORTC = ((PORTC & ~LEDS_ALL_LEDS) | LEDMask);\r
 119                         }\r
 120 \r
 121                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,\r
 122                                                            const uint8_t ActiveMask)\r
 123                         {\r
 124                                 PORTC = ((PORTC & ~LEDMask) | ActiveMask);\r
 125                         }\r
 126 \r
 127                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
 128                         {\r
 129                                 PINC  = LEDMask;\r
 130                         }\r
 131 \r
 132                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 133                         static inline uint8_t LEDs_GetLEDs(void)\r
 134                         {\r
 135                                 return (PORTC & LEDS_ALL_LEDS);\r
 136                         }\r
 137                 #endif\r
 138 \r
 139         /* Disable C linkage for C++ Compilers: */\r
 140                 #if defined(__cplusplus)\r
 141                         }\r
 142                 #endif\r
 143 \r
 144 #endif\r
 145 \r
 146 /** @} */\r
 147 \r