tmk_core/protocol/lufa/LUFA-git/LUFA/Drivers/Board/AVR8/MICRO/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2014.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2014  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 Arduino Micro board.
  33  *  \copydetails Group_LEDs_MICRO
  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_MICRO MICRO
  41  *  \brief Board specific LED driver header for the Arduino Micro board.
  42  *
  43  *  Board specific LED driver header for the Arduino Micro board (http://arduino.cc/en/Main/arduinoBoardMicro).
  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>Yellow</td><td>RX</td><td>High</td><td>PORTB.0</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Yellow</td><td>TX</td><td>High</td><td>PORTD.5</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTC.7</td></tr>
  50  *  </table>
  51  *
  52  *  @{
  53  */
  54
  55 #ifndef __LEDS_MICRO_H__
  56 #define __LEDS_MICRO_H__
  57
  58         /* Includes: */
  59                 #include "../../../../Common/Common.h"
  60
  61         /* Enable C linkage for C++ Compilers: */
  62                 #if defined(__cplusplus)
  63                         extern "C" {
  64                 #endif
  65
  66         /* Preprocessor Checks: */
  67                 #if !defined(__INCLUDE_FROM_LEDS_H)
  68                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  69                 #endif
  70
  71         /* Private Interface - For use in library only: */
  72         #if !defined(__DOXYGEN__)
  73                 /* Macros: */
  74                         #define LEDS_PORTB_LEDS       (LEDS_LED1)
  75                         #define LEDS_PORTD_LEDS       (LEDS_LED2)
  76                         #define LEDS_PORTC_LEDS       (LEDS_LED3)
  77         #endif
  78
  79         /* Public Interface - May be used in end-application: */
  80                 /* Macros: */
  81                         /** LED mask for the first LED on the board. */
  82                         #define LEDS_LED1        (1 << 0)
  83
  84                         /** LED mask for the second LED on the board. */
  85                         #define LEDS_LED2        (1 << 5)
  86
  87                         /** LED mask for the third LED on the board. */
  88                         #define LEDS_LED3        (1 << 7)
  89
  90                         /** LED mask for all the LEDs on the board. */
  91                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3)
  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                                 DDRB  |=  LEDS_PORTB_LEDS;
 101                                 PORTB &= ~LEDS_PORTB_LEDS;
 102                                 DDRD  |=  LEDS_PORTD_LEDS;
 103                                 PORTD &= ~LEDS_PORTD_LEDS;
 104                                 DDRC  |=  LEDS_PORTC_LEDS;
 105                                 PORTC &= ~LEDS_PORTC_LEDS;
 106                         }
 107
 108                         static inline void LEDs_Disable(void)
 109                         {
 110                                 DDRB  &= ~LEDS_PORTB_LEDS;
 111                                 PORTB &= ~LEDS_PORTB_LEDS;
 112                                 DDRD  &= ~LEDS_PORTD_LEDS;
 113                                 PORTD &= ~LEDS_PORTD_LEDS;
 114                                 DDRC  &= ~LEDS_PORTC_LEDS;
 115                                 PORTC &= ~LEDS_PORTC_LEDS;
 116                         }
 117
 118                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 119                         {
 120                                 PORTB |=  (LEDMask & LEDS_PORTB_LEDS);
 121                                 PORTD |=  (LEDMask & LEDS_PORTD_LEDS);
 122                                 PORTC |=  (LEDMask & LEDS_PORTC_LEDS);
 123                         }
 124
 125                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 126                         {
 127                                 PORTB &= ~(LEDMask & LEDS_PORTB_LEDS);
 128                                 PORTD &= ~(LEDMask & LEDS_PORTD_LEDS);
 129                                 PORTC &= ~(LEDMask & LEDS_PORTC_LEDS);
 130                         }
 131
 132                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 133                         {
 134                                 PORTB = ((PORTB & ~LEDS_PORTB_LEDS) | (LEDMask & LEDS_PORTB_LEDS));
 135                                 PORTD = ((PORTD & ~LEDS_PORTD_LEDS) | (LEDMask & LEDS_PORTD_LEDS));
 136                                 PORTC = ((PORTC & ~LEDS_PORTC_LEDS) | (LEDMask & LEDS_PORTC_LEDS));
 137                         }
 138
 139                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 140                                                            const uint8_t ActiveMask)
 141                         {
 142                                 PORTB = ((PORTB & ~(LEDMask & LEDS_PORTB_LEDS)) | (ActiveMask & LEDS_PORTB_LEDS));
 143                                 PORTD = ((PORTD & ~(LEDMask & LEDS_PORTD_LEDS)) | (ActiveMask & LEDS_PORTD_LEDS));
 144                                 PORTC = ((PORTC & ~(LEDMask & LEDS_PORTC_LEDS)) | (ActiveMask & LEDS_PORTC_LEDS));
 145                         }
 146
 147                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 148                         {
 149                                 PORTB ^= (LEDMask & LEDS_PORTB_LEDS);
 150                                 PORTD ^= (LEDMask & LEDS_PORTD_LEDS);
 151                                 PORTC ^= (LEDMask & LEDS_PORTC_LEDS);
 152                         }
 153
 154                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 155                         static inline uint8_t LEDs_GetLEDs(void)
 156                         {
 157                                 return ((PORTB & LEDS_PORTB_LEDS) | (PORTD & LEDS_PORTD_LEDS) | (PORTC & LEDS_PORTC_LEDS));
 158                         }
 159                 #endif
 160
 161         /* Disable C linkage for C++ Compilers: */
 162                 #if defined(__cplusplus)
 163                         }
 164                 #endif
 165
 166 #endif
 167
 168 /** @} */
 169