protocol/lufa/LUFA-120730/LUFA/Drivers/Board/XMEGA/B1_XPLAINED/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 Atmel XMEGA B1 Xplained.\r
  33  *  \copydetails Group_LEDs_B1_XPLAINED\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_B1_XPLAINED B1_XPLAINED\r
  41  *  \brief Board specific LED driver header for the Atmel XMEGA B1 Xplained.\r
  42  *\r
  43  *  Board specific LED driver header for the Atmel XMEGA B1 Xplained.\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>Yellow</td><td>LED0 LED</td><td>High</td><td>PORTB.4</td></tr>\r
  48  *    <tr><td>LEDS_LED2</td><td>Yellow</td><td>LED1 LED</td><td>High</td><td>PORTB.5</td></tr>\r
  49  *    <tr><td>LEDS_LED3</td><td>Yellow</td><td>LED2 LED</td><td>High</td><td>PORTB.6</td></tr>\r
  50  *    <tr><td>LEDS_LED4</td><td>Yellow</td><td>LED3 LED</td><td>High</td><td>PORTB.7</td></tr>\r
  51  *    <tr><td>LEDS_LED5</td><td>Green</td><td>USB LED</td><td>Low</td><td>PORTE.4</td></tr>\r
  52  *  </table>\r
  53  *\r
  54  *  @{\r
  55  */\r
  56 \r
  57 #ifndef __LEDS_B1_XPLAINED_H__\r
  58 #define __LEDS_B1_XPLAINED_H__\r
  59 \r
  60         /* Includes: */\r
  61                 #include <avr/io.h>\r
  62 \r
  63         /* Enable C linkage for C++ Compilers: */\r
  64                 #if defined(__cplusplus)\r
  65                         extern "C" {\r
  66                 #endif\r
  67 \r
  68         /* Preprocessor Checks: */\r
  69                 #if !defined(__INCLUDE_FROM_LEDS_H)\r
  70                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
  71                 #endif\r
  72 \r
  73         /* Private Interface - For use in library only: */\r
  74         #if !defined(__DOXYGEN__)\r
  75                 /* Macros: */\r
  76                         #define LEDS_PORTB_LEDS        (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)\r
  77                         #define LEDS_PORTE_LEDS        LEDS_LED5\r
  78 \r
  79                         #define LEDS_PORTE_MASK_SHIFT  1\r
  80         #endif\r
  81 \r
  82         /* Public Interface - May be used in end-application: */\r
  83                 /* Macros: */\r
  84                         /** LED mask for the first LED on the board. */\r
  85                         #define LEDS_LED1        (1 << 4)\r
  86 \r
  87                         /** LED mask for the second LED on the board. */\r
  88                         #define LEDS_LED2        (1 << 5)\r
  89 \r
  90                         /** LED mask for the third LED on the board. */\r
  91                         #define LEDS_LED3        (1 << 6)\r
  92 \r
  93                         /** LED mask for the fourth LED on the board. */\r
  94                         #define LEDS_LED4        (1 << 7)\r
  95 \r
  96                         /** LED mask for the fifth LED on the board. */\r
  97                         #define LEDS_LED5       ((1 << 4) >> LEDS_PORTE_MASK_SHIFT)\r
  98 \r
  99                         /** LED mask for all the LEDs on the board. */\r
 100                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4 | LEDS_LED5)\r
 101 \r
 102                         /** LED mask for none of the board LEDs. */\r
 103                         #define LEDS_NO_LEDS     0\r
 104 \r
 105                 /* Inline Functions: */\r
 106                 #if !defined(__DOXYGEN__)\r
 107                         static inline void LEDs_Init(void)\r
 108                         {\r
 109                                 PORTB.DIRSET    = LEDS_PORTB_LEDS;\r
 110                                 PORTB.OUTCLR    = LEDS_PORTB_LEDS;\r
 111 \r
 112                                 PORTCFG.MPCMASK = LEDS_PORTB_LEDS;\r
 113                                 PORTB.PIN0CTRL  = PORT_INVEN_bm;\r
 114 \r
 115                                 PORTE.DIRSET    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
 116                                 PORTE.OUTCLR    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
 117                         }\r
 118 \r
 119                         static inline void LEDs_Disable(void)\r
 120                         {\r
 121                                 PORTB.DIRCLR    = LEDS_PORTB_LEDS;\r
 122                                 PORTB.OUTCLR    = LEDS_PORTB_LEDS;\r
 123                                 \r
 124                                 PORTCFG.MPCMASK = 0;\r
 125                                 PORTB.PIN0CTRL  = LEDS_PORTB_LEDS;\r
 126 \r
 127                                 PORTE.DIRCLR    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
 128                                 PORTE.OUTCLR    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
 129                         }\r
 130 \r
 131                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
 132                         {\r
 133                                 PORTB_OUTSET = (LEDMask & LEDS_PORTB_LEDS);\r
 134                                 PORTE_OUTSET = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
 135                         }\r
 136 \r
 137                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
 138                         {\r
 139                                 PORTB_OUTCLR = (LEDMask & LEDS_PORTB_LEDS);\r
 140                                 PORTE_OUTCLR = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
 141                         }\r
 142 \r
 143                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
 144                         {\r
 145                                 PORTB_OUTCLR = LEDS_PORTB_LEDS;\r
 146                                 PORTE_OUTCLR = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);\r
 147 \r
 148                                 PORTB_OUTSET = (LEDMask & LEDS_PORTB_LEDS);\r
 149                                 PORTE_OUTSET = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
 150                         }\r
 151 \r
 152                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask)\r
 153                         {\r
 154                                 PORTB_OUTCLR =  (LEDMask & LEDS_PORTB_LEDS);\r
 155                                 PORTE_OUTCLR = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
 156                         \r
 157                                 PORTB_OUTSET =  (ActiveMask & LEDS_PORTB_LEDS);\r
 158                                 PORTE_OUTSET = ((ActiveMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
 159                         }\r
 160 \r
 161                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
 162                         {\r
 163                                 PORTB_OUTTGL = (LEDMask & LEDS_PORTB_LEDS);\r
 164                                 PORTE_OUTTGL = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);\r
 165                         }\r
 166 \r
 167                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 168                         static inline uint8_t LEDs_GetLEDs(void)\r
 169                         {\r
 170                                 return ((PORTB_OUT & LEDS_PORTB_LEDS) | (PORTE_OUT & (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT)));\r
 171                         }\r
 172                 #endif\r
 173 \r
 174         /* Disable C linkage for C++ Compilers: */\r
 175                 #if defined(__cplusplus)\r
 176                         }\r
 177                 #endif\r
 178 \r
 179 #endif\r
 180 \r
 181 /** @} */\r
 182 \r