LUFA/Drivers/Board/AVR8/MICROPENDOUS/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 Micropendous-32U2.
  33  *  \copydetails Group_LEDs_MICROPENDOUS_32U2
  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_MICROPENDOUS_REV1 MICROPENDOUS_REV1
  41  *  \brief Board specific LED driver header for the Micropendous Arduino-like Revision 1 (https://code.google.com/p/micropendous/wiki/Micropendous).
  42  *
  43  *  See \ref Group_LEDs_MICROPENDOUS_32U2 for more details.
  44  */
  45
  46 /** \ingroup Group_LEDs
  47  *  \defgroup Group_LEDs_MICROPENDOUS_REV2 MICROPENDOUS_REV2
  48  *  \brief Board specific LED driver header for the Micropendous Arduino-like Revision 2 (https://code.google.com/p/micropendous/wiki/Micropendous).
  49  *
  50  *  See \ref Group_LEDs_MICROPENDOUS_32U2 for more details.
  51  */
  52
  53 /** \ingroup Group_LEDs
  54  *  \defgroup Group_LEDs_MICROPENDOUS_32U2 MICROPENDOUS_32U2
  55  *  \brief Board specific LED driver header for the Micropendous 32U2.
  56  *
  57  *  Board specific LED driver header for the Micropendous 32U2 (https://code.google.com/p/micropendous/wiki/Micropendous_32U2).
  58  *
  59  *  @{
  60  */
  61
  62 #ifndef __LEDS_MICROPENDOUS_H__
  63 #define __LEDS_MICROPENDOUS_H__
  64
  65         /* Includes: */
  66                 #include "../../../../Common/Common.h"
  67
  68         /* Enable C linkage for C++ Compilers: */
  69                 #if defined(__cplusplus)
  70                         extern "C" {
  71                 #endif
  72
  73         /* Preprocessor Checks: */
  74                 #if !defined(__INCLUDE_FROM_LEDS_H)
  75                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  76                 #endif
  77
  78         /* Private Interface - For use in library only: */
  79         #if !defined(__DOXYGEN__)
  80                 #if (BOARD == BOARD_MICROPENDOUS_32U2)
  81                         #define _BOARD_LED1_MASK                (1 << 6)
  82                         #define _BOARD_LED_PORTLETTER           D
  83                 #elif (BOARD == BOARD_MICROPENDOUS_REV1)
  84                         #define _BOARD_LED1_MASK                (1 << 1)
  85                         #define _BOARD_LED_PORTLETTER           B
  86                 #elif (BOARD == BOARD_MICROPENDOUS_REV2)
  87                         #define _BOARD_LED1_MASK                (1 << 1)
  88                         #define _BOARD_LED_PORTLETTER           B
  89                 #endif
  90
  91                 #define _BOARD_LED_CONCAT2(Reg, Letter)     Reg ## Letter
  92                 #define _BOARD_LED_CONCAT(Reg, Letter)      _BOARD_LED_CONCAT2(Reg, Letter)
  93
  94                 #define _BOARD_LED_PORT                     _BOARD_LED_CONCAT(PORT, _BOARD_LED_PORTLETTER)
  95                 #define _BOARD_LED_DDR                      _BOARD_LED_CONCAT(DDR,  _BOARD_LED_PORTLETTER)
  96         #endif
  97
  98         /* Public Interface - May be used in end-application: */
  99                 /* Macros: */
 100                         /** LED mask for the first LED on the board. */
 101                         #define LEDS_LED1        _BOARD_LED1_MASK
 102
 103                         /** LED mask for all the LEDs on the board. */
 104                         #define LEDS_ALL_LEDS    LEDS_LED1
 105
 106                         /** LED mask for the none of the board LEDs. */
 107                         #define LEDS_NO_LEDS     0
 108
 109                 /* Inline Functions: */
 110                 #if !defined(__DOXYGEN__)
 111                         static inline void LEDs_Init(void)
 112                         {
 113                                 _BOARD_LED_DDR  |=  LEDS_ALL_LEDS;
 114                                 _BOARD_LED_PORT &= ~LEDS_ALL_LEDS;
 115                         }
 116
 117                         static inline void LEDs_Disable(void)
 118                         {
 119                                 _BOARD_LED_DDR  &= ~LEDS_ALL_LEDS;
 120                                 _BOARD_LED_PORT &= ~LEDS_ALL_LEDS;
 121                         }
 122
 123                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 124                         {
 125                                 _BOARD_LED_PORT |= LEDMask;
 126                         }
 127
 128                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 129                         {
 130                                 _BOARD_LED_PORT &= ~LEDMask;
 131                         }
 132
 133                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 134                         {
 135                                 _BOARD_LED_PORT = ((PORTF & ~LEDS_ALL_LEDS) | LEDMask);
 136                         }
 137
 138                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 139                                                            const uint8_t ActiveMask)
 140                         {
 141                                 _BOARD_LED_PORT = ((PORTF & ~LEDMask) | ActiveMask);
 142                         }
 143
 144                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 145                         {
 146                                 _BOARD_LED_PORT ^= LEDMask;
 147                         }
 148
 149                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 150                         static inline uint8_t LEDs_GetLEDs(void)
 151                         {
 152                                 return (_BOARD_LED_PORT & LEDS_ALL_LEDS);
 153                         }
 154                 #endif
 155
 156         /* Disable C linkage for C++ Compilers: */
 157                 #if defined(__cplusplus)
 158                         }
 159                 #endif
 160
 161 #endif
 162
 163 /** @} */
 164