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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2017.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2017  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 Adafruit U4 Breakout board.
  33  *  \copydetails Group_LEDs_ADAFRUITU4
  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_ADAFRUITU4 ADAFRUITU4
  41  *  \brief Board specific LED driver header for the Adafruit U4 Breakout board.
  42  *
  43  *  Board specific LED driver header for the Adafruit U4 Breakout board (http://ladyada.net/products/atmega32u4breakout).
  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>Green</td><td>General Indicator</td><td>High</td><td>PORTE.6</td></tr>
  48  *  </table>
  49  *
  50  *  @{
  51  */
  52
  53 #ifndef __LEDS_ADAFRUITU4_H__
  54 #define __LEDS_ADAFRUITU4_H__
  55
  56         /* Includes: */
  57                 #include "../../../../Common/Common.h"
  58
  59         /* Enable C linkage for C++ Compilers: */
  60                 #if defined(__cplusplus)
  61                         extern "C" {
  62                 #endif
  63
  64         /* Preprocessor Checks: */
  65                 #if !defined(__INCLUDE_FROM_LEDS_H)
  66                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  67                 #endif
  68
  69         /* Public Interface - May be used in end-application: */
  70                 /* Macros: */
  71                         /** LED mask for the first LED on the board. */
  72                         #define LEDS_LED1        (1 << 6)
  73
  74                         /** LED mask for all the LEDs on the board. */
  75                         #define LEDS_ALL_LEDS    LEDS_LED1
  76
  77                         /** LED mask for the none of the board LEDs. */
  78                         #define LEDS_NO_LEDS     0
  79
  80                 /* Inline Functions: */
  81                 #if !defined(__DOXYGEN__)
  82                         static inline void LEDs_Init(void)
  83                         {
  84                                 DDRE  |=  LEDS_ALL_LEDS;
  85                                 PORTE &= ~LEDS_ALL_LEDS;
  86                 }
  87
  88                         static inline void LEDs_Disable(void)
  89                         {
  90                                 DDRE  &= ~LEDS_ALL_LEDS;
  91                                 PORTE &= ~LEDS_ALL_LEDS;
  92                 }
  93
  94                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
  95                         {
  96                                 PORTE |= LEDMask;
  97                         }
  98
  99                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 100                         {
 101                                 PORTE &= ~LEDMask;
 102                         }
 103
 104                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 105                         {
 106                                 PORTE  = ((PORTE & ~LEDS_ALL_LEDS) | LEDMask);
 107                         }
 108
 109                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 110                                                            const uint8_t ActiveMask)
 111                         {
 112                                 PORTE  = ((PORTE & ~LEDMask) | ActiveMask);
 113                         }
 114
 115                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 116                         {
 117                                 PINE   = LEDMask;
 118                         }
 119
 120                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 121                         static inline uint8_t LEDs_GetLEDs(void)
 122                         {
 123                                 return (PORTE & LEDS_ALL_LEDS);
 124                         }
 125                 #endif
 126
 127         /* Disable C linkage for C++ Compilers: */
 128                 #if defined(__cplusplus)
 129                         }
 130                 #endif
 131
 132 #endif
 133
 134 /** @} */
 135