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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2018.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2018  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 Micropendous series boards.
  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  *  <b>BOARD_MICROPENDOUS_32U2</b>:
  60  *  <table>
  61  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  62  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTD.6</td></tr>
  63  *  </table>
  64  *
  65  *  <b>Other Revisions</b>:
  66  *  <table>
  67  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>
  68  *    <tr><td>LEDS_LED1</td><td>Green</td><td>General Indicator</td><td>High</td><td>PORTB.1</td></tr>
  69  *  </table>
  70  *
  71  *  @{
  72  */
  73
  74 #ifndef __LEDS_MICROPENDOUS_H__
  75 #define __LEDS_MICROPENDOUS_H__
  76
  77         /* Includes: */
  78                 #include "../../../../Common/Common.h"
  79
  80         /* Enable C linkage for C++ Compilers: */
  81                 #if defined(__cplusplus)
  82                         extern "C" {
  83                 #endif
  84
  85         /* Preprocessor Checks: */
  86                 #if !defined(__INCLUDE_FROM_LEDS_H)
  87                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  88                 #endif
  89
  90         /* Private Interface - For use in library only: */
  91         #if !defined(__DOXYGEN__)
  92                 #if (BOARD == BOARD_MICROPENDOUS_32U2)
  93                         #define _BOARD_LED1_MASK                (1 << 6)
  94                         #define _BOARD_LED_PORTLETTER           D
  95                 #elif (BOARD == BOARD_MICROPENDOUS_REV1)
  96                         #define _BOARD_LED1_MASK                (1 << 1)
  97                         #define _BOARD_LED_PORTLETTER           B
  98                 #elif (BOARD == BOARD_MICROPENDOUS_REV2)
  99                         #define _BOARD_LED1_MASK                (1 << 1)
 100                         #define _BOARD_LED_PORTLETTER           B
 101                 #endif
 102
 103                 #define _BOARD_LED_PORT                     CONCAT_EXPANDED(PORT, _BOARD_LED_PORTLETTER)
 104                 #define _BOARD_LED_PIN                      CONCAT_EXPANDED(PIN,  _BOARD_LED_PORTLETTER)
 105                 #define _BOARD_LED_DDR                      CONCAT_EXPANDED(DDR,  _BOARD_LED_PORTLETTER)
 106         #endif
 107
 108         /* Public Interface - May be used in end-application: */
 109                 /* Macros: */
 110                         /** LED mask for the first LED on the board. */
 111                         #define LEDS_LED1        _BOARD_LED1_MASK
 112
 113                         /** LED mask for all the LEDs on the board. */
 114                         #define LEDS_ALL_LEDS    LEDS_LED1
 115
 116                         /** LED mask for the none of the board LEDs. */
 117                         #define LEDS_NO_LEDS     0
 118
 119                 /* Inline Functions: */
 120                 #if !defined(__DOXYGEN__)
 121                         static inline void LEDs_Init(void)
 122                         {
 123                                 _BOARD_LED_DDR  |=  LEDS_ALL_LEDS;
 124                                 _BOARD_LED_PORT &= ~LEDS_ALL_LEDS;
 125                         }
 126
 127                         static inline void LEDs_Disable(void)
 128                         {
 129                                 _BOARD_LED_DDR  &= ~LEDS_ALL_LEDS;
 130                                 _BOARD_LED_PORT &= ~LEDS_ALL_LEDS;
 131                         }
 132
 133                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 134                         {
 135                                 _BOARD_LED_PORT |= LEDMask;
 136                         }
 137
 138                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 139                         {
 140                                 _BOARD_LED_PORT &= ~LEDMask;
 141                         }
 142
 143                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 144                         {
 145                                 _BOARD_LED_PORT = ((_BOARD_LED_PORT & ~LEDS_ALL_LEDS) | LEDMask);
 146                         }
 147
 148                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 149                                                            const uint8_t ActiveMask)
 150                         {
 151                                 _BOARD_LED_PORT = ((_BOARD_LED_PORT & ~LEDMask) | ActiveMask);
 152                         }
 153
 154                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 155                         {
 156                                 _BOARD_LED_PIN  = LEDMask;
 157                         }
 158
 159                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 160                         static inline uint8_t LEDs_GetLEDs(void)
 161                         {
 162                                 return (_BOARD_LED_PORT & LEDS_ALL_LEDS);
 163                         }
 164                 #endif
 165
 166         /* Disable C linkage for C++ Compilers: */
 167                 #if defined(__cplusplus)
 168                         }
 169                 #endif
 170
 171 #endif
 172
 173 /** @} */
 174