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