LUFA/Drivers/Board/AVR8/RZUSBSTICK/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 Atmel RZUSBSTICK.
  33  *  \copydetails Group_LEDs_RZUSBSTICK
  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_RZUSBSTICK RZUSBSTICK
  41  *  \brief Board specific LED driver header for the Atmel RZUSBSTICK.
  42  *
  43  *  Board specific LED driver header for the Atmel RZUSBSTICK.
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __LEDS_RZUSBSTICK_H__
  49 #define __LEDS_RZUSBSTICK_H__
  50
  51         /* Includes: */
  52                 #include "../../../../Common/Common.h"
  53
  54         /* Enable C linkage for C++ Compilers: */
  55                 #if defined(__cplusplus)
  56                         extern "C" {
  57                 #endif
  58
  59         /* Preprocessor Checks: */
  60                 #if !defined(__INCLUDE_FROM_LEDS_H)
  61                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  62                 #endif
  63
  64         /* Private Interface - For use in library only: */
  65         #if !defined(__DOXYGEN__)
  66                 /* Macros: */
  67                         #define LEDS_PORTD_LEDS       (LEDS_LED1 | LEDS_LED2)
  68                         #define LEDS_PORTE_LEDS       (LEDS_LED3 | LEDS_LED4)
  69
  70                         #define LEDS_PORTE_MASK_SHIFT 4
  71         #endif
  72
  73         /* Public Interface - May be used in end-application: */
  74                 /* Macros: */
  75                         /** LED mask for the first LED on the board. */
  76                         #define LEDS_LED1        (1 << 7)
  77
  78                         /** LED mask for the second LED on the board. */
  79                         #define LEDS_LED2        (1 << 5)
  80
  81                         /** LED mask for the third LED on the board. */
  82                         #define LEDS_LED3        ((1 << 6) >> LEDS_PORTE_MASK_SHIFT)
  83
  84                         /** LED mask for the fourth LED on the board. */
  85                         #define LEDS_LED4        ((1 << 7) >> LEDS_PORTE_MASK_SHIFT)
  86
  87                         /** LED mask for all the LEDs on the board. */
  88                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  89
  90                         /** LED mask for none of the board LEDs. */
  91                         #define LEDS_NO_LEDS     0
  92
  93                 /* Inline Functions: */
  94                 #if !defined(__DOXYGEN__)
  95                         static inline void LEDs_Init(void)
  96                         {
  97                                 DDRD  |=  LEDS_PORTD_LEDS;
  98                                 PORTD &= ~LEDS_LED1;
  99                                 PORTD |=  LEDS_LED2;
 100
 101                                 DDRE  |=  (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 102                                 PORTE |=  (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 103                         }
 104
 105                         static inline void LEDs_Disable(void)
 106                         {
 107                                 DDRD  &= ~LEDS_PORTD_LEDS;
 108                                 PORTD &= ~LEDS_PORTD_LEDS;
 109
 110                                 DDRE  &= ~(LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 111                                 PORTE &= ~(LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 112                         }
 113
 114                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 115                         {
 116                                 PORTD |=  (LEDMask & LEDS_LED1);
 117                                 PORTD &= ~(LEDMask & LEDS_LED2);
 118                                 PORTE &= ~((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 119                         }
 120
 121                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 122                         {
 123                                 PORTD &= ~(LEDMask & LEDS_LED1);
 124                                 PORTD |=  (LEDMask & LEDS_LED2);
 125                                 PORTE |=  ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 126                         }
 127
 128                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 129                         {
 130                                 PORTD = (((PORTD & ~LEDS_LED1) |  (LEDMask & LEDS_LED1)) |
 131                                          ((PORTD |  LEDS_LED2) & ~(LEDMask & LEDS_LED2)));
 132                                 PORTE = ((PORTE | (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT)) &
 133                                         ~((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT));
 134                         }
 135
 136                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 137                                                            const uint8_t ActiveMask)
 138                         {
 139                                 PORTD = (((PORTD & ~(LEDMask & LEDS_LED1)) |  (ActiveMask & LEDS_LED1)) |
 140                                          ((PORTD |  (LEDMask & LEDS_LED2)) & ~(ActiveMask & LEDS_LED2)));
 141                                 PORTE = ((PORTE | ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT)) &
 142                                         ~((ActiveMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT));
 143                         }
 144
 145                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 146                         {
 147                                 PORTD ^= (LEDMask & LEDS_PORTD_LEDS);
 148                                 PORTE ^= ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 149                         }
 150
 151                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 152                         static inline uint8_t LEDs_GetLEDs(void)
 153                         {
 154                                 return (((PORTD & LEDS_LED1) | (~PORTD & LEDS_LED2)) |
 155                                         ((~PORTE & (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT)) >> LEDS_PORTE_MASK_SHIFT));
 156                         }
 157                 #endif
 158
 159         /* Disable C linkage for C++ Compilers: */
 160                 #if defined(__cplusplus)
 161                         }
 162                 #endif
 163
 164 #endif
 165
 166 /** @} */
 167