protocol/lufa/LUFA-git/LUFA/Drivers/Board/AVR8/USBKEY/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 Atmel USBKEY.
  33  *  \copydetails Group_LEDs_USBKEY
  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_USBKEY USBKEY
  41  *  \brief Board specific LED driver header for the Atmel USBKEY.
  42  *
  43  *  Board specific LED driver header for the Atmel USBKEY.
  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>Red</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTD.4</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>Bicolor Indicator 1</td><td>High</td><td>PORTD.5</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Red</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTD.6</td></tr>
  50  *    <tr><td>LEDS_LED4</td><td>Green</td><td>Bicolor Indicator 2</td><td>High</td><td>PORTD.7</td></tr>
  51  *  </table>
  52  *
  53  *  @{
  54  */
  55
  56 #ifndef __LEDS_USBKEY_H__
  57 #define __LEDS_USBKEY_H__
  58
  59         /* Includes: */
  60                 #include "../../../../Common/Common.h"
  61
  62         /* Enable C linkage for C++ Compilers: */
  63                 #if defined(__cplusplus)
  64                         extern "C" {
  65                 #endif
  66
  67         /* Preprocessor Checks: */
  68                 #if !defined(__INCLUDE_FROM_LEDS_H)
  69                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  70                 #endif
  71
  72         /* Public Interface - May be used in end-application: */
  73                 /* Macros: */
  74                         /** LED mask for the first LED on the board. */
  75                         #define LEDS_LED1        (1 << 4)
  76
  77                         /** LED mask for the second LED on the board. */
  78                         #define LEDS_LED2        (1 << 5)
  79
  80                         /** LED mask for the third LED on the board. */
  81                         #define LEDS_LED3        (1 << 7)
  82
  83                         /** LED mask for the fourth LED on the board. */
  84                         #define LEDS_LED4        (1 << 6)
  85
  86                         /** LED mask for all the LEDs on the board. */
  87                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  88
  89                         /** LED mask for none of the board LEDs. */
  90                         #define LEDS_NO_LEDS     0
  91
  92                 /* Inline Functions: */
  93                 #if !defined(__DOXYGEN__)
  94                         static inline void LEDs_Init(void)
  95                         {
  96                                 DDRD  |=  LEDS_ALL_LEDS;
  97                                 PORTD &= ~LEDS_ALL_LEDS;
  98                         }
  99
 100                         static inline void LEDs_Disable(void)
 101                         {
 102                                 DDRD  &= ~LEDS_ALL_LEDS;
 103                                 PORTD &= ~LEDS_ALL_LEDS;
 104                         }
 105
 106                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 107                         {
 108                                 PORTD |= LEDMask;
 109                         }
 110
 111                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 112                         {
 113                                 PORTD &= ~LEDMask;
 114                         }
 115
 116                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 117                         {
 118                                 PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);
 119                         }
 120
 121                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 122                                                            const uint8_t ActiveMask)
 123                         {
 124                                 PORTD = ((PORTD & ~LEDMask) | ActiveMask);
 125                         }
 126
 127                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 128                         {
 129                                 PIND  = LEDMask;
 130                         }
 131
 132                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 133                         static inline uint8_t LEDs_GetLEDs(void)
 134                         {
 135                                 return (PORTD & LEDS_ALL_LEDS);
 136                         }
 137                 #endif
 138
 139         /* Disable C linkage for C++ Compilers: */
 140                 #if defined(__cplusplus)
 141                         }
 142                 #endif
 143
 144 #endif
 145
 146 /** @} */
 147