tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Board/AVR8/USB2AX/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaims all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *  \brief Board specific LED driver header for the Xevelabs USB2AX.
  33  *  \copydetails Group_LEDs_USB2AX
  34  *
  35  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  36  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  37  */
  38
  39 /** \ingroup Group_LEDs
  40  *  \defgroup Group_LEDs_USB2AX_V31 USB2AX_V31
  41  *  \brief Board specific LED driver header for the Xevelabs USB2AX revision 3.1.
  42  *
  43  *  See \ref Group_LEDs_USB2AX for more details.
  44  */
  45
  46 /** \ingroup Group_LEDs
  47  *  \defgroup Group_LEDs_USB2AX_V3 USB2AX_V3
  48  *  \brief Board specific LED driver header for the Xevelabs USB2AX revision 3.
  49  *
  50  *  See \ref Group_LEDs_USB2AX for more details.
  51  */
  52
  53 /** \ingroup Group_LEDs
  54  *  \defgroup Group_LEDs_USB2AX USB2AX
  55  *  \brief Board specific LED driver header for the Xevelabs USB2AX revisions 1 and 2.
  56  *
  57  *  \note For version 3 USB2AX boards, compile with <code>BOARD = USB2AX_V3</code> and for version 3.1, with <code>BOARD = USB2AX_V31</code>.
  58  *
  59  *  Board specific LED driver header for the Xevelabs USB2AX (http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX).
  60  *
  61  *  <b>USB2AX</b>:
  62  *  <table>
  63  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  64  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTC.6</td></tr>
  65  *  </table>
  66  *
  67  *  <b>USB2AX_V3</b>:
  68  *  <table>
  69  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  70  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.1</td></tr>
  71  *  </table>
  72  *
  73  *  <b>USB2AX_V31</b>:
  74  *  <table>
  75  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  76  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.5</td></tr>
  77  *    <tr><td>LEDS_LED2</td><td>Red</td><td>General Indicator</td><td>High</td><td>PORTD.6</td></tr>
  78  *  </table>
  79  *
  80  *  @{
  81  */
  82
  83 #ifndef __LEDS_USB2AX_H__
  84 #define __LEDS_USB2AX_H__
  85
  86         /* Includes: */
  87                 #include "../../../../Common/Common.h"
  88
  89         /* Enable C linkage for C++ Compilers: */
  90                 #if defined(__cplusplus)
  91                         extern "C" {
  92                 #endif
  93
  94         /* Preprocessor Checks: */
  95                 #if !defined(__INCLUDE_FROM_LEDS_H)
  96                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  97                 #endif
  98
  99         /* Private Interface - For use in library only: */
 100         #if !defined(__DOXYGEN__)
 101                 /* Macros: */
 102                         #if (BOARD == BOARD_USB2AX_V31)
 103                 #define USB2AX_LEDS_LED1   (1 << 5)
 104                 #define USB2AX_LEDS_LED2   (1 << 6)
 105             #elif (BOARD == BOARD_USB2AX_V3)
 106                                 #define USB2AX_LEDS_LED1   (1 << 1)
 107                 #define USB2AX_LEDS_LED2   0
 108                         #else
 109                                 #define USB2AX_LEDS_LED1   (1 << 6)
 110                 #define USB2AX_LEDS_LED2   0
 111                         #endif
 112         #endif
 113
 114         /* Public Interface - May be used in end-application: */
 115                 /* Macros: */
 116                         /** LED mask for the first LED on the board. */
 117                         #define LEDS_LED1        USB2AX_LEDS_LED1
 118
 119                         /** LED mask for the second LED on the board. */
 120                         #define LEDS_LED2        USB2AX_LEDS_LED2
 121
 122                         /** LED mask for all the LEDs on the board. */
 123                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2)
 124
 125                         /** LED mask for none of the board LEDs. */
 126                         #define LEDS_NO_LEDS     0
 127
 128                 /* Inline Functions: */
 129                 #if !defined(__DOXYGEN__)
 130                         static inline void LEDs_Init(void)
 131                         {
 132                                 #if (BOARD == BOARD_USB2AX)
 133                                 DDRC  |=  LEDS_ALL_LEDS;
 134                                 PORTC &= ~LEDS_ALL_LEDS;
 135                                 #else
 136                                 DDRD  |=  LEDS_ALL_LEDS;
 137                                 PORTD &= ~LEDS_ALL_LEDS;
 138                                 #endif
 139                         }
 140
 141                         static inline void LEDs_Disable(void)
 142                         {
 143                                 #if (BOARD == BOARD_USB2AX)
 144                                 DDRC  &= ~LEDS_ALL_LEDS;
 145                                 PORTC &= ~LEDS_ALL_LEDS;
 146                                 #else
 147                                 DDRD  &= ~LEDS_ALL_LEDS;
 148                                 PORTD &= ~LEDS_ALL_LEDS;
 149                                 #endif
 150                         }
 151
 152                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 153                         {
 154                                 #if (BOARD == BOARD_USB2AX)
 155                                 PORTC |= LEDMask;
 156                                 #else
 157                                 PORTD |= LEDMask;
 158                                 #endif
 159                         }
 160
 161                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 162                         {
 163                                 #if (BOARD == BOARD_USB2AX)
 164                                 PORTC &= ~LEDMask;
 165                                 #else
 166                                 PORTD &= ~LEDMask;
 167                                 #endif
 168                         }
 169
 170                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 171                         {
 172                                 #if (BOARD == BOARD_USB2AX)
 173                                 PORTC = ((PORTC & ~LEDS_ALL_LEDS) | LEDMask);
 174                                 #else
 175                                 PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);
 176                                 #endif
 177                         }
 178
 179                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 180                                                            const uint8_t ActiveMask)
 181                         {
 182                                 #if (BOARD == BOARD_USB2AX)
 183                                 PORTC = ((PORTC & ~LEDMask) | ActiveMask);
 184                                 #else
 185                                 PORTD = ((PORTD & ~LEDMask) | ActiveMask);
 186                                 #endif
 187                         }
 188
 189                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 190                         {
 191                                 #if (BOARD == BOARD_USB2AX)
 192                                 PINC  = LEDMask;
 193                                 #else
 194                                 PIND  = LEDMask;
 195                                 #endif
 196                         }
 197
 198                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 199                         static inline uint8_t LEDs_GetLEDs(void)
 200                         {
 201                                 #if (BOARD == BOARD_USB2AX)
 202                                 return (PORTC & LEDS_ALL_LEDS);
 203                                 #else
 204                                 return (PORTD & LEDS_ALL_LEDS);
 205                                 #endif
 206                         }
 207                 #endif
 208
 209         /* Disable C linkage for C++ Compilers: */
 210                 #if defined(__cplusplus)
 211                         }
 212                 #endif
 213
 214 #endif
 215
 216 /** @} */
 217
 218