LUFA/Drivers/Board/UNO/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2011.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2011  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  *
  34  *  Board specific LED driver header for the Arduino Uno (http://arduino.cc/en/Main/ArduinoBoardUno).
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  37  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  38  */
  39
  40 /** \ingroup Group_LEDs
  41  *  @defgroup Group_LEDs_UNO UNO
  42  *
  43  *  Board specific LED driver header for the Arduino Uno (http://arduino.cc/en/Main/ArduinoBoardUno).
  44  *
  45  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  46  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  47  *
  48  *  @{
  49  */
  50
  51 #ifndef __LEDS_UNO_H__
  52 #define __LEDS_UNO_H__
  53
  54         /* Includes: */
  55                 #include <avr/io.h>
  56
  57         /* Enable C linkage for C++ Compilers: */
  58                 #if defined(__cplusplus)
  59                         extern "C" {
  60                 #endif
  61
  62         /* Preprocessor Checks: */
  63                 #if !defined(INCLUDE_FROM_LEDS_H)
  64                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  65                 #endif
  66
  67         /* Public Interface - May be used in end-application: */
  68                 /* Macros: */
  69                         /** LED mask for the first LED on the board. */
  70                         #define LEDS_LED1        (1 << 4)
  71
  72                         /** LED mask for the second LED on the board. */
  73                         #define LEDS_LED2        (1 << 5)
  74
  75                         /** LED mask for all the LEDs on the board. */
  76                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2)
  77
  78                         /** LED mask for none of the board LEDs. */
  79                         #define LEDS_NO_LEDS     0
  80
  81                 /* Inline Functions: */
  82                 #if !defined(__DOXYGEN__)
  83                         static inline void LEDs_Init(void)
  84                         {
  85                                 DDRD  |= LEDS_ALL_LEDS;
  86                                 PORTD |= LEDS_ALL_LEDS;
  87                         }
  88
  89                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
  90                         {
  91                                 PORTD &= ~LEDMask;
  92                         }
  93
  94                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
  95                         {
  96                                 PORTD |= LEDMask;
  97                         }
  98
  99                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 100                         {
 101                                 PORTD = ((PORTD | LEDS_ALL_LEDS) & ~LEDMask);
 102                         }
 103
 104                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 105                                                            const uint8_t ActiveMask)
 106                         {
 107                                 PORTD = ((PORTD | LEDMask) & ~ActiveMask);
 108                         }
 109
 110                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 111                         {
 112                                 PORTD ^= LEDMask;
 113                         }
 114
 115                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 116                         static inline uint8_t LEDs_GetLEDs(void)
 117                         {
 118                                 return (PORTD & LEDS_ALL_LEDS);
 119                         }
 120                 #endif
 121
 122         /* Disable C linkage for C++ Compilers: */
 123                 #if defined(__cplusplus)
 124                         }
 125                 #endif
 126
 127 #endif
 128
 129 /** @} */
 130