LUFA/Drivers/Board/AVR8/TEENSY/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 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  *  @{
  55  */
  56
  57 #ifndef __LEDS_TEENSY_H__
  58 #define __LEDS_TEENSY_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         /* 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 << 6)
  77
  78                         /** LED mask for all the LEDs on the board. */
  79                         #define LEDS_ALL_LEDS    LEDS_LED1
  80
  81                         /** LED mask for none of the board LEDs. */
  82                         #define LEDS_NO_LEDS     0
  83
  84                 /* Inline Functions: */
  85                 #if !defined(__DOXYGEN__)
  86                         static inline void LEDs_Init(void)
  87                         {
  88                                 DDRD  |= LEDS_ALL_LEDS;
  89
  90                                 #if (BOARD == BOARD_TEENSY2)
  91                                 PORTD &= ~LEDS_ALL_LEDS;
  92                                 #else
  93                                 PORTD |=  LEDS_ALL_LEDS;
  94                                 #endif
  95                         }
  96
  97                         static inline void LEDs_Disable(void)
  98                         {
  99                                 DDRD  &= ~LEDS_ALL_LEDS;
 100                                 PORTD &= ~LEDS_ALL_LEDS;
 101                         }
 102
 103                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 104                         {
 105                                 #if (BOARD == BOARD_TEENSY2)
 106                                 PORTD |=  LEDMask;
 107                                 #else
 108                                 PORTD &= ~LEDMask;
 109                                 #endif
 110                         }
 111
 112                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 113                         {
 114                                 #if (BOARD == BOARD_TEENSY2)
 115                                 PORTD &= ~LEDMask;
 116                                 #else
 117                                 PORTD |=  LEDMask;
 118                                 #endif
 119                         }
 120
 121                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 122                         {
 123                                 #if (BOARD == BOARD_TEENSY2)
 124                                 PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);
 125                                 #else
 126                                 PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);
 127                                 #endif
 128                         }
 129
 130                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 131                                                            const uint8_t ActiveMask)
 132                         {
 133                                 #if (BOARD == BOARD_TEENSY2)
 134                                 PORTD = ((PORTD & ~LEDMask) | ActiveMask);
 135                                 #else
 136                                 PORTD = ((PORTD | LEDMask) & ~ActiveMask);
 137                                 #endif
 138                         }
 139
 140                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 141                         {
 142                                 PORTD ^= LEDMask;
 143                         }
 144
 145                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 146                         static inline uint8_t LEDs_GetLEDs(void)
 147                         {
 148                                 #if (BOARD == BOARD_TEENSY2)
 149                                 return (PORTD & LEDS_ALL_LEDS);
 150                                 #else
 151                                 return (~PORTD & LEDS_ALL_LEDS);
 152                                 #endif
 153                         }
 154                 #endif
 155
 156         /* Disable C linkage for C++ Compilers: */
 157                 #if defined(__cplusplus)
 158                         }
 159                 #endif
 160
 161 #endif
 162
 163 /** @} */
 164