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