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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 disclaims 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 PJRC Teensy 1.x/2.x boards.
  33  *  \copydetails Group_LEDs_TEENSY
  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_TEENSY2 TEENSY2
  41  *  \brief Board specific LED driver header for the PJRC Teensy 2 boards.
  42  *
  43  *  See \ref Group_LEDs_TEENSY for more details.
  44  */
  45
  46 /** \ingroup Group_LEDs
  47  *  \defgroup Group_LEDs_TEENSY TEENSY
  48  *  \brief Board specific LED driver header for the PJRC Teensy 1.x/2.x boards.
  49  *
  50  *  \note For version 2 Teensy boards, compile with <code>BOARD = TEENSY2</code>.
  51  *
  52  *  Board specific LED driver header for the PJRC Teensy boards (http://www.pjrc.com/teensy/index.html).
  53  *
  54  *  <b>TEENSY</b>:
  55  *  <table>
  56  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  57  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.6</td></tr>
  58  *  </table>
  59  *
  60  *  <b>TEENSY2</b>:
  61  *  <table>
  62  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  63  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTD.6</td></tr>
  64  *  </table>
  65  *
  66  *  @{
  67  */
  68
  69 #ifndef __LEDS_TEENSY_H__
  70 #define __LEDS_TEENSY_H__
  71
  72         /* Includes: */
  73                 #include "../../../../Common/Common.h"
  74
  75         /* Enable C linkage for C++ Compilers: */
  76                 #if defined(__cplusplus)
  77                         extern "C" {
  78                 #endif
  79
  80         /* Preprocessor Checks: */
  81                 #if !defined(__INCLUDE_FROM_LEDS_H)
  82                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  83                 #endif
  84
  85         /* Public Interface - May be used in end-application: */
  86                 /* Macros: */
  87                         /** LED mask for the first LED on the board. */
  88                         #define LEDS_LED1        (1 << 6)
  89
  90                         /** LED mask for all the LEDs on the board. */
  91                         #define LEDS_ALL_LEDS    LEDS_LED1
  92
  93                         /** LED mask for 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_ALL_LEDS;
 101
 102                                 #if (BOARD == BOARD_TEENSY2)
 103                                 PORTD &= ~LEDS_ALL_LEDS;
 104                                 #else
 105                                 PORTD |=  LEDS_ALL_LEDS;
 106                                 #endif
 107                         }
 108
 109                         static inline void LEDs_Disable(void)
 110                         {
 111                                 DDRD  &= ~LEDS_ALL_LEDS;
 112                                 PORTD &= ~LEDS_ALL_LEDS;
 113                         }
 114
 115                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 116                         {
 117                                 #if (BOARD == BOARD_TEENSY2)
 118                                 PORTD |=  LEDMask;
 119                                 #else
 120                                 PORTD &= ~LEDMask;
 121                                 #endif
 122                         }
 123
 124                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 125                         {
 126                                 #if (BOARD == BOARD_TEENSY2)
 127                                 PORTD &= ~LEDMask;
 128                                 #else
 129                                 PORTD |=  LEDMask;
 130                                 #endif
 131                         }
 132
 133                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 134                         {
 135                                 #if (BOARD == BOARD_TEENSY2)
 136                                 PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);
 137                                 #else
 138                                 PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);
 139                                 #endif
 140                         }
 141
 142                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 143                                                            const uint8_t ActiveMask)
 144                         {
 145                                 #if (BOARD == BOARD_TEENSY2)
 146                                 PORTD = ((PORTD & ~LEDMask) | ActiveMask);
 147                                 #else
 148                                 PORTD = ((PORTD | LEDMask) & ~ActiveMask);
 149                                 #endif
 150                         }
 151
 152                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 153                         {
 154                                 PIND  = LEDMask;
 155                         }
 156
 157                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 158                         static inline uint8_t LEDs_GetLEDs(void)
 159                         {
 160                                 #if (BOARD == BOARD_TEENSY2)
 161                                 return (PORTD & LEDS_ALL_LEDS);
 162                                 #else
 163                                 return (~PORTD & LEDS_ALL_LEDS);
 164                                 #endif
 165                         }
 166                 #endif
 167
 168         /* Disable C linkage for C++ Compilers: */
 169                 #if defined(__cplusplus)
 170                         }
 171                 #endif
 172
 173 #endif
 174
 175 /** @} */
 176