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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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_TurnOnLEDs(const uint8_t LEDMask)
 108                         {
 109                                 #if (BOARD == BOARD_USB2AX)
 110                                 PORTC &= ~LEDMask;
 111                                 #else
 112                                 PORTD &= ~LEDMask;
 113                                 #endif
 114                         }
 115
 116                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 117                         {
 118                                 #if (BOARD == BOARD_USB2AX)
 119                                 PORTC |= LEDMask;
 120                                 #else
 121                                 PORTD |= LEDMask;
 122                                 #endif
 123                         }
 124
 125                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 126                         {
 127                                 #if (BOARD == BOARD_USB2AX)
 128                                 PORTC = ((PORTC | LEDS_ALL_LEDS) & ~LEDMask);
 129                                 #else
 130                                 PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);
 131                                 #endif
 132                         }
 133
 134                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 135                                                            const uint8_t ActiveMask)
 136                         {
 137                                 #if (BOARD == BOARD_USB2AX)
 138                                 PORTC = ((PORTC | LEDMask) & ~ActiveMask);
 139                                 #else
 140                                 PORTD = ((PORTD | LEDMask) & ~ActiveMask);
 141                                 #endif
 142                         }
 143
 144                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 145                         {
 146                                 #if (BOARD == BOARD_USB2AX)
 147                                 PORTC ^= LEDMask;
 148                                 #else
 149                                 PORTD ^= LEDMask;
 150                                 #endif
 151                         }
 152
 153                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 154                         static inline uint8_t LEDs_GetLEDs(void)
 155                         {
 156                                 #if (BOARD == BOARD_USB2AX)
 157                                 return (~PORTC & LEDS_ALL_LEDS);
 158                                 #else
 159                                 return (~PORTD & LEDS_ALL_LEDS);
 160                                 #endif
 161                         }
 162                 #endif
 163
 164         /* Disable C linkage for C++ Compilers: */
 165                 #if defined(__cplusplus)
 166                         }
 167                 #endif
 168
 169 #endif
 170
 171 /** @} */
 172
 173