LUFA/Drivers/Board/AVR8/USB2AX/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2012.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2012  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 disclaim 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 Paranoid Studio 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_V3 USB2AX_V3
  41  *  \brief Board specific LED driver header for the Paranoid Studio USB2AX revision 3.
  42  *
  43  *  See \ref Group_LEDs_USB2AX for more details.
  44  */
  45
  46 /** \ingroup Group_LEDs
  47  *  \defgroup Group_LEDs_USB2AX USB2AX
  48  *  \brief Board specific LED driver header for the Paranoid Studio USB2AX.
  49  *
  50  *  \note For version 3 USB2AX boards, compile with <code>BOARD = USB2AX_V3</code>.
  51  *
  52  *  Board specific LED driver header for the Paranoid Studio USB2AX (http://paranoidstudio.assembla.com/wiki/show/paranoidstudio/USB2AX).
  53  *
  54  *  @{
  55  */
  56
  57 #ifndef __LEDS_USB2AX_H__
  58 #define __LEDS_USB2AX_H__
  59
  60         /* Includes: */
  61                 #include "../../../../Common/Common.h"
  62
  63         /* Enable C linkage for C++ Compilers: */
  64                 #if defined(__cplusplus)
  65                         extern "C" {
  66                 #endif
  67
  68         /* Preprocessor Checks: */
  69                 #if !defined(__INCLUDE_FROM_LEDS_H)
  70                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  71                 #endif
  72
  73         /* Private Interface - For use in library only: */
  74         #if !defined(__DOXYGEN__)
  75                 /* Macros: */
  76                         #if (BOARD == BOARD_USB2AX)
  77                                 #define USB2AX_LEDS_LED1   (1 << 6)
  78                         #else
  79                                 #define USB2AX_LEDS_LED1   (1 << 1)
  80                         #endif
  81         #endif
  82
  83         /* Public Interface - May be used in end-application: */
  84                 /* Macros: */
  85                         /** LED mask for the first LED on the board. */
  86                         #define LEDS_LED1        USB2AX_LEDS_LED1
  87
  88                         /** LED mask for all the LEDs on the board. */
  89                         #define LEDS_ALL_LEDS    LEDS_LED1
  90
  91                         /** LED mask for none of the board LEDs. */
  92                         #define LEDS_NO_LEDS     0
  93
  94                 /* Inline Functions: */
  95                 #if !defined(__DOXYGEN__)
  96                         static inline void LEDs_Init(void)
  97                         {
  98                                 #if (BOARD == BOARD_USB2AX)
  99                                 DDRC  |= LEDS_ALL_LEDS;
 100                                 PORTC |= LEDS_ALL_LEDS;
 101                                 #else
 102                                 DDRD  |= LEDS_ALL_LEDS;
 103                                 PORTD |= LEDS_ALL_LEDS;
 104                                 #endif
 105                         }
 106
 107                         static inline void LEDs_Disable(void)
 108                         {
 109                                 #if (BOARD == BOARD_USB2AX)
 110                                 DDRC  &= ~LEDS_ALL_LEDS;
 111                                 PORTC &= ~LEDS_ALL_LEDS;
 112                                 #else
 113                                 DDRD  &= ~LEDS_ALL_LEDS;
 114                                 PORTD &= ~LEDS_ALL_LEDS;
 115                                 #endif
 116                         }
 117
 118                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 119                         {
 120                                 #if (BOARD == BOARD_USB2AX)
 121                                 PORTC &= ~LEDMask;
 122                                 #else
 123                                 PORTD &= ~LEDMask;
 124                                 #endif
 125                         }
 126
 127                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 128                         {
 129                                 #if (BOARD == BOARD_USB2AX)
 130                                 PORTC |= LEDMask;
 131                                 #else
 132                                 PORTD |= LEDMask;
 133                                 #endif
 134                         }
 135
 136                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 137                         {
 138                                 #if (BOARD == BOARD_USB2AX)
 139                                 PORTC = ((PORTC | LEDS_ALL_LEDS) & ~LEDMask);
 140                                 #else
 141                                 PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);
 142                                 #endif
 143                         }
 144
 145                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 146                                                            const uint8_t ActiveMask)
 147                         {
 148                                 #if (BOARD == BOARD_USB2AX)
 149                                 PORTC = ((PORTC | LEDMask) & ~ActiveMask);
 150                                 #else
 151                                 PORTD = ((PORTD | LEDMask) & ~ActiveMask);
 152                                 #endif
 153                         }
 154
 155                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 156                         {
 157                                 #if (BOARD == BOARD_USB2AX)
 158                                 PORTC ^= LEDMask;
 159                                 #else
 160                                 PORTD ^= LEDMask;
 161                                 #endif
 162                         }
 163
 164                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 165                         static inline uint8_t LEDs_GetLEDs(void)
 166                         {
 167                                 #if (BOARD == BOARD_USB2AX)
 168                                 return (~PORTC & LEDS_ALL_LEDS);
 169                                 #else
 170                                 return (~PORTD & LEDS_ALL_LEDS);
 171                                 #endif
 172                         }
 173                 #endif
 174
 175         /* Disable C linkage for C++ Compilers: */
 176                 #if defined(__cplusplus)
 177                         }
 178                 #endif
 179
 180 #endif
 181
 182 /** @} */
 183
 184