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

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