protocol/lufa/LUFA-120730/LUFA/Drivers/Board/AVR8/XPLAIN/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 original Atmel XPLAIN.\r
  33  *  \copydetails Group_LEDs_XPLAIN\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_XPLAIN_REV1 XPLAIN_REV1\r
  41  *  \brief Board specific LED driver header for the original Atmel XPLAIN, revision 1.\r
  42  *\r
  43  *  See \ref Group_LEDs_XPLAIN for more details.\r
  44  */\r
  45 \r
  46 /** \ingroup Group_LEDs\r
  47  *  \defgroup Group_LEDs_XPLAIN XPLAIN\r
  48  *  \brief Board specific LED driver header for the original Atmel XPLAIN.\r
  49  *\r
  50  *  Board specific LED driver header for the Atmel XPLAIN.\r
  51  *\r
  52  *  <table>\r
  53  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  54  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTB.6</td></tr>\r
  55  *  </table>\r
  56  *\r
  57  *  @{\r
  58  */\r
  59 \r
  60 #ifndef __LEDS_XPLAIN_H__\r
  61 #define __LEDS_XPLAIN_H__\r
  62 \r
  63         /* Includes: */\r
  64                 #include "../../../../Common/Common.h"\r
  65 \r
  66         /* Enable C linkage for C++ Compilers: */\r
  67                 #if defined(__cplusplus)\r
  68                         extern "C" {\r
  69                 #endif\r
  70 \r
  71         /* Preprocessor Checks: */\r
  72                 #if !defined(__INCLUDE_FROM_LEDS_H)\r
  73                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
  74                 #endif\r
  75 \r
  76         /* Public Interface - May be used in end-application: */\r
  77                 /* Macros: */\r
  78                         /** LED mask for the first LED on the board. */\r
  79                         #define LEDS_LED1        (1 << 6)\r
  80 \r
  81                         /** LED mask for all the LEDs on the board. */\r
  82                         #define LEDS_ALL_LEDS    LEDS_LED1\r
  83 \r
  84                         /** LED mask for none of the board LEDs. */\r
  85                         #define LEDS_NO_LEDS     0\r
  86 \r
  87                 /* Inline Functions: */\r
  88                 #if !defined(__DOXYGEN__)\r
  89                         static inline void LEDs_Init(void)\r
  90                         {\r
  91                                 DDRB  |= LEDS_ALL_LEDS;\r
  92                                 PORTB |= LEDS_ALL_LEDS;\r
  93                         }\r
  94 \r
  95                         static inline void LEDs_Disable(void)\r
  96                         {\r
  97                                 DDRB  &= ~LEDS_ALL_LEDS;\r
  98                                 PORTB &= ~LEDS_ALL_LEDS;\r
  99                         }\r
 100 \r
 101                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
 102                         {\r
 103                                 PORTB &= ~LEDMask;\r
 104                         }\r
 105 \r
 106                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
 107                         {\r
 108                                 PORTB |= LEDMask;\r
 109                         }\r
 110 \r
 111                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
 112                         {\r
 113                                 PORTB = ((PORTB | LEDS_ALL_LEDS) & ~LEDMask);\r
 114                         }\r
 115 \r
 116                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,\r
 117                                                            const uint8_t ActiveMask)\r
 118                         {\r
 119                                 PORTB = ((PORTB | LEDMask) & ~ActiveMask);\r
 120                         }\r
 121 \r
 122                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
 123                         {\r
 124                                 PINB  = LEDMask;\r
 125                         }\r
 126 \r
 127                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 128                         static inline uint8_t LEDs_GetLEDs(void)\r
 129                         {\r
 130                                 return (~PORTB & LEDS_ALL_LEDS);\r
 131                         }\r
 132                 #endif\r
 133 \r
 134         /* Disable C linkage for C++ Compilers: */\r
 135                 #if defined(__cplusplus)\r
 136                         }\r
 137                 #endif\r
 138 \r
 139 #endif\r
 140 \r
 141 /** @} */\r
 142 \r