LUFA/Drivers/Board/XMEGA/A3BU_XPLAINED/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2013.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2013  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 XMEGA A3BU Xplained.
  33  *  \copydetails Group_LEDs_A3BU_XPLAINED
  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_A3BU_XPLAINED A3BU_XPLAINED
  41  *  \brief Board specific LED driver header for the Atmel XMEGA A3BU Xplained.
  42  *
  43  *  Board specific LED driver header for the Atmel XMEGA A3BU Xplained.
  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>Yellow</td><td>LED0 LED</td><td>Low</td><td>PORTR.0</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Yellow</td><td>LED1 LED</td><td>Low</td><td>PORTR.1</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Red</td><td>Status Bicolour Red LED</td><td>Low</td><td>PORTD.4</td></tr>
  50  *    <tr><td>LEDS_LED4</td><td>Green</td><td>Status Bicolour Green LED</td><td>High</td><td>PORTD.5</td></tr>
  51  *  </table>
  52  *
  53  *  @{
  54  */
  55
  56 #ifndef __LEDS_A3BU_XPLAINED_H__
  57 #define __LEDS_A3BU_XPLAINED_H__
  58
  59         /* Includes: */
  60                 #include <avr/io.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         /* Private Interface - For use in library only: */
  73         #if !defined(__DOXYGEN__)
  74                 /* Macros: */
  75                         #define LEDS_PORTR_LEDS       (LEDS_LED1 | LEDS_LED2)
  76                         #define LEDS_PORTD_LEDS       (LEDS_LED3 | LEDS_LED4)
  77         #endif
  78
  79         /* Public Interface - May be used in end-application: */
  80                 /* Macros: */
  81                         /** LED mask for the first LED on the board. */
  82                         #define LEDS_LED1        (1 << 0)
  83
  84                         /** LED mask for the second LED on the board. */
  85                         #define LEDS_LED2        (1 << 1)
  86
  87                         /** LED mask for the third LED on the board. */
  88                         #define LEDS_LED3        (1 << 4)
  89
  90                         /** LED mask for the fourth LED on the board. */
  91                         #define LEDS_LED4        (1 << 5)
  92
  93                         /** LED mask for all the LEDs on the board. */
  94                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  95
  96                         /** LED mask for none of the board LEDs. */
  97                         #define LEDS_NO_LEDS     0
  98
  99                 /* Inline Functions: */
 100                 #if !defined(__DOXYGEN__)
 101                         static inline void LEDs_Init(void)
 102                         {
 103                                 PORTR.DIRSET    = LEDS_PORTR_LEDS;
 104                                 PORTR.OUTCLR    = LEDS_PORTR_LEDS;
 105
 106                                 PORTCFG.MPCMASK = LEDS_PORTR_LEDS;
 107                                 PORTR.PIN0CTRL  = PORT_INVEN_bm;
 108
 109                                 PORTD.DIRSET    = LEDS_PORTD_LEDS;
 110                                 PORTD.OUTCLR    = LEDS_PORTD_LEDS;
 111
 112                                 PORTD.PIN4CTRL  = PORT_INVEN_bm;
 113                         }
 114
 115                         static inline void LEDs_Disable(void)
 116                         {
 117                                 PORTR.DIRCLR    = LEDS_PORTR_LEDS;
 118                                 PORTR.OUTCLR    = LEDS_PORTR_LEDS;
 119
 120                                 PORTCFG.MPCMASK = 0;
 121                                 PORTR.PIN0CTRL  = LEDS_PORTR_LEDS;
 122
 123                                 PORTD.DIRCLR    = LEDS_PORTD_LEDS;
 124                                 PORTD.OUTCLR    = LEDS_PORTD_LEDS;
 125
 126                                 PORTD.PIN4CTRL  = 0;
 127                         }
 128
 129                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 130                         {
 131                                 PORTR_OUTSET = LEDMask & LEDS_PORTR_LEDS;
 132                                 PORTD_OUTSET = LEDMask & LEDS_PORTD_LEDS;
 133                         }
 134
 135                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 136                         {
 137                                 PORTR_OUTCLR = LEDMask & LEDS_PORTR_LEDS;
 138                                 PORTD_OUTCLR = LEDMask & LEDS_PORTD_LEDS;
 139                         }
 140
 141                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 142                         {
 143                                 PORTR_OUTCLR = LEDS_PORTR_LEDS;
 144                                 PORTD_OUTCLR = LEDS_PORTD_LEDS;
 145
 146                                 PORTR_OUTSET = (LEDMask & LEDS_PORTR_LEDS);
 147                                 PORTD_OUTSET = (LEDMask & LEDS_PORTD_LEDS);
 148                         }
 149
 150                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 151                                                            const uint8_t ActiveMask)
 152                         {
 153                                 PORTR_OUTCLR = (LEDMask & LEDS_PORTR_LEDS);
 154                                 PORTD_OUTCLR = (LEDMask & LEDS_PORTD_LEDS);
 155
 156                                 PORTR_OUTSET = (ActiveMask & LEDS_PORTR_LEDS);
 157                                 PORTD_OUTSET = (ActiveMask & LEDS_PORTD_LEDS);
 158                         }
 159
 160                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 161                         {
 162                                 PORTR_OUTTGL = (LEDMask & LEDS_PORTR_LEDS);
 163                                 PORTD_OUTTGL = (LEDMask & LEDS_PORTD_LEDS);
 164                         }
 165
 166                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 167                         static inline uint8_t LEDs_GetLEDs(void)
 168                         {
 169                                 return ((PORTR_OUT & LEDS_PORTR_LEDS) | (PORTD_OUT & LEDS_PORTD_LEDS));
 170                         }
 171                 #endif
 172
 173         /* Disable C linkage for C++ Compilers: */
 174                 #if defined(__cplusplus)
 175                         }
 176                 #endif
 177
 178 #endif
 179
 180 /** @} */
 181