LUFA/Drivers/Board/RZUSBSTICK/LEDs.h

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