LUFA/Drivers/Board/AVR8/UNO/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 Arduino Uno.
  33  *  \copydetails Group_LEDs_UNO
  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_UNO UNO
  41  *  \brief Board specific LED driver header for the Arduino Uno.
  42  *
  43  *  Board specific LED driver header for the Arduino Uno (http://arduino.cc/en/Main/ArduinoBoardUno).
  44  *
  45  *  @{
  46  */
  47
  48 #ifndef __LEDS_UNO_H__
  49 #define __LEDS_UNO_H__
  50
  51         /* Includes: */
  52                 #include "../../../../Common/Common.h"
  53
  54         /* Enable C linkage for C++ Compilers: */
  55                 #if defined(__cplusplus)
  56                         extern "C" {
  57                 #endif
  58
  59         /* Preprocessor Checks: */
  60                 #if !defined(__INCLUDE_FROM_LEDS_H)
  61                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  62                 #endif
  63
  64         /* Public Interface - May be used in end-application: */
  65                 /* Macros: */
  66                         /** LED mask for the first LED on the board. */
  67                         #define LEDS_LED1        (1 << 4)
  68
  69                         /** LED mask for the second LED on the board. */
  70                         #define LEDS_LED2        (1 << 5)
  71
  72                         /** LED mask for all the LEDs on the board. */
  73                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2)
  74
  75                         /** LED mask for none of the board LEDs. */
  76                         #define LEDS_NO_LEDS     0
  77
  78                 /* Inline Functions: */
  79                 #if !defined(__DOXYGEN__)
  80                         static inline void LEDs_Init(void)
  81                         {
  82                                 DDRD  |= LEDS_ALL_LEDS;
  83                                 PORTD |= LEDS_ALL_LEDS;
  84                         }
  85
  86                         static inline void LEDs_Disable(void)
  87                         {
  88                                 DDRD  &= ~LEDS_ALL_LEDS;
  89                                 PORTD &= ~LEDS_ALL_LEDS;
  90                         }
  91
  92                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
  93                         {
  94                                 PORTD &= ~LEDMask;
  95                         }
  96
  97                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
  98                         {
  99                                 PORTD |= LEDMask;
 100                         }
 101
 102                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 103                         {
 104                                 PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);
 105                         }
 106
 107                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 108                                                            const uint8_t ActiveMask)
 109                         {
 110                                 PORTD = ((PORTD | LEDMask) & ~ActiveMask);
 111                         }
 112
 113                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 114                         {
 115                                 PORTD ^= LEDMask;
 116                         }
 117
 118                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 119                         static inline uint8_t LEDs_GetLEDs(void)
 120                         {
 121                                 return (PORTD & LEDS_ALL_LEDS);
 122                         }
 123                 #endif
 124
 125         /* Disable C linkage for C++ Compilers: */
 126                 #if defined(__cplusplus)
 127                         }
 128                 #endif
 129
 130 #endif
 131
 132 /** @} */
 133