LUFA/Drivers/Board/AVR8/XPLAIN/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 original Atmel XPLAIN.
  33  *  \copydetails Group_LEDs_XPLAIN
  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_XPLAIN_REV1 XPLAIN_REV1
  41  *  \brief Board specific LED driver header for the original Atmel XPLAIN, revision 1.
  42  *
  43  *  See \ref Group_LEDs_XPLAIN for more details.
  44  */
  45
  46 /** \ingroup Group_LEDs
  47  *  \defgroup Group_LEDs_XPLAIN XPLAIN
  48  *  \brief Board specific LED driver header for the original Atmel XPLAIN.
  49  *
  50  *  Board specific LED driver header for the Atmel XPLAIN.
  51  *
  52  *  <table>
  53  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  54  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>Low</td><td>PORTB.6</td></tr>
  55  *  </table>
  56  *
  57  *  @{
  58  */
  59
  60 #ifndef __LEDS_XPLAIN_H__
  61 #define __LEDS_XPLAIN_H__
  62
  63         /* Includes: */
  64                 #include "../../../../Common/Common.h"
  65
  66         /* Enable C linkage for C++ Compilers: */
  67                 #if defined(__cplusplus)
  68                         extern "C" {
  69                 #endif
  70
  71         /* Preprocessor Checks: */
  72                 #if !defined(__INCLUDE_FROM_LEDS_H)
  73                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  74                 #endif
  75
  76         /* Public Interface - May be used in end-application: */
  77                 /* Macros: */
  78                         /** LED mask for the first LED on the board. */
  79                         #define LEDS_LED1        (1 << 6)
  80
  81                         /** LED mask for all the LEDs on the board. */
  82                         #define LEDS_ALL_LEDS    LEDS_LED1
  83
  84                         /** LED mask for none of the board LEDs. */
  85                         #define LEDS_NO_LEDS     0
  86
  87                 /* Inline Functions: */
  88                 #if !defined(__DOXYGEN__)
  89                         static inline void LEDs_Init(void)
  90                         {
  91                                 DDRB  |= LEDS_ALL_LEDS;
  92                                 PORTB |= LEDS_ALL_LEDS;
  93                         }
  94
  95                         static inline void LEDs_Disable(void)
  96                         {
  97                                 DDRB  &= ~LEDS_ALL_LEDS;
  98                                 PORTB &= ~LEDS_ALL_LEDS;
  99                         }
 100
 101                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 102                         {
 103                                 PORTB &= ~LEDMask;
 104                         }
 105
 106                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 107                         {
 108                                 PORTB |= LEDMask;
 109                         }
 110
 111                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 112                         {
 113                                 PORTB = ((PORTB | LEDS_ALL_LEDS) & ~LEDMask);
 114                         }
 115
 116                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 117                                                            const uint8_t ActiveMask)
 118                         {
 119                                 PORTB = ((PORTB | LEDMask) & ~ActiveMask);
 120                         }
 121
 122                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 123                         {
 124                                 PINB  = LEDMask;
 125                         }
 126
 127                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 128                         static inline uint8_t LEDs_GetLEDs(void)
 129                         {
 130                                 return (~PORTB & LEDS_ALL_LEDS);
 131                         }
 132                 #endif
 133
 134         /* Disable C linkage for C++ Compilers: */
 135                 #if defined(__cplusplus)
 136                         }
 137                 #endif
 138
 139 #endif
 140
 141 /** @} */
 142