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

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2020.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2020  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 B1 Xplained.
  33  *  \copydetails Group_LEDs_B1_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_B1_XPLAINED B1_XPLAINED
  41  *  \brief Board specific LED driver header for the Atmel XMEGA B1 Xplained.
  42  *
  43  *  Board specific LED driver header for the Atmel XMEGA B1 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>High</td><td>PORTB.4</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Yellow</td><td>LED1 LED</td><td>High</td><td>PORTB.5</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Yellow</td><td>LED2 LED</td><td>High</td><td>PORTB.6</td></tr>
  50  *    <tr><td>LEDS_LED4</td><td>Yellow</td><td>LED3 LED</td><td>High</td><td>PORTB.7</td></tr>
  51  *    <tr><td>LEDS_LED5</td><td>Green</td><td>USB LED</td><td>Low</td><td>PORTE.4</td></tr>
  52  *  </table>
  53  *
  54  *  @{
  55  */
  56
  57 #ifndef __LEDS_B1_XPLAINED_H__
  58 #define __LEDS_B1_XPLAINED_H__
  59
  60         /* Includes: */
  61                 #include <avr/io.h>
  62
  63         /* Enable C linkage for C++ Compilers: */
  64                 #if defined(__cplusplus)
  65                         extern "C" {
  66                 #endif
  67
  68         /* Preprocessor Checks: */
  69                 #if !defined(__INCLUDE_FROM_LEDS_H)
  70                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  71                 #endif
  72
  73         /* Private Interface - For use in library only: */
  74         #if !defined(__DOXYGEN__)
  75                 /* Macros: */
  76                         #define LEDS_PORTB_LEDS        (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  77                         #define LEDS_PORTE_LEDS        LEDS_LED5
  78
  79                         #define LEDS_PORTE_MASK_SHIFT  1
  80         #endif
  81
  82         /* Public Interface - May be used in end-application: */
  83                 /* Macros: */
  84                         /** LED mask for the first LED on the board. */
  85                         #define LEDS_LED1        (1 << 4)
  86
  87                         /** LED mask for the second LED on the board. */
  88                         #define LEDS_LED2        (1 << 5)
  89
  90                         /** LED mask for the third LED on the board. */
  91                         #define LEDS_LED3        (1 << 6)
  92
  93                         /** LED mask for the fourth LED on the board. */
  94                         #define LEDS_LED4        (1 << 7)
  95
  96                         /** LED mask for the fifth LED on the board. */
  97                         #define LEDS_LED5       ((1 << 4) >> LEDS_PORTE_MASK_SHIFT)
  98
  99                         /** LED mask for all the LEDs on the board. */
 100                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4 | LEDS_LED5)
 101
 102                         /** LED mask for none of the board LEDs. */
 103                         #define LEDS_NO_LEDS     0
 104
 105                 /* Inline Functions: */
 106                 #if !defined(__DOXYGEN__)
 107                         static inline void LEDs_Init(void)
 108                         {
 109                                 PORTB.DIRSET    = LEDS_PORTB_LEDS;
 110                                 PORTB.OUTCLR    = LEDS_PORTB_LEDS;
 111
 112                                 PORTCFG.MPCMASK = LEDS_PORTB_LEDS;
 113                                 PORTB.PIN0CTRL  = PORT_INVEN_bm;
 114
 115                                 PORTE.DIRSET    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 116                                 PORTE.OUTCLR    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 117                         }
 118
 119                         static inline void LEDs_Disable(void)
 120                         {
 121                                 PORTB.DIRCLR    = LEDS_PORTB_LEDS;
 122                                 PORTB.OUTCLR    = LEDS_PORTB_LEDS;
 123
 124                                 PORTCFG.MPCMASK = 0;
 125                                 PORTB.PIN0CTRL  = LEDS_PORTB_LEDS;
 126
 127                                 PORTE.DIRCLR    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 128                                 PORTE.OUTCLR    = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 129                         }
 130
 131                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
 132                         {
 133                                 PORTB_OUTSET = (LEDMask & LEDS_PORTB_LEDS);
 134                                 PORTE_OUTSET = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 135                         }
 136
 137                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 138                         {
 139                                 PORTB_OUTCLR = (LEDMask & LEDS_PORTB_LEDS);
 140                                 PORTE_OUTCLR = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 141                         }
 142
 143                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 144                         {
 145                                 PORTB_OUTCLR = LEDS_PORTB_LEDS;
 146                                 PORTE_OUTCLR = (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT);
 147
 148                                 PORTB_OUTSET = (LEDMask & LEDS_PORTB_LEDS);
 149                                 PORTE_OUTSET = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 150                         }
 151
 152                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
 153                                                            const uint8_t ActiveMask)
 154                         {
 155                                 PORTB_OUTCLR =  (LEDMask & LEDS_PORTB_LEDS);
 156                                 PORTE_OUTCLR = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 157
 158                                 PORTB_OUTSET =  (ActiveMask & LEDS_PORTB_LEDS);
 159                                 PORTE_OUTSET = ((ActiveMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 160                         }
 161
 162                         static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
 163                         {
 164                                 PORTB_OUTTGL = (LEDMask & LEDS_PORTB_LEDS);
 165                                 PORTE_OUTTGL = ((LEDMask & LEDS_PORTE_LEDS) << LEDS_PORTE_MASK_SHIFT);
 166                         }
 167
 168                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 169                         static inline uint8_t LEDs_GetLEDs(void)
 170                         {
 171                                 return ((PORTB_OUT & LEDS_PORTB_LEDS) | (PORTE_OUT & (LEDS_PORTE_LEDS << LEDS_PORTE_MASK_SHIFT)));
 172                         }
 173                 #endif
 174
 175         /* Disable C linkage for C++ Compilers: */
 176                 #if defined(__cplusplus)
 177                         }
 178                 #endif
 179
 180 #endif
 181
 182 /** @} */
 183