protocol/lufa/LUFA-git/LUFA/Drivers/Board/UC3/EVK1100/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 Atmel EVK1100.
  33  *  \copydetails Group_LEDs_EVK1100
  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_EVK1100 EVK1100
  41  *  \brief Board specific LED driver header for the Atmel EVK1100.
  42  *
  43  *  Board specific LED driver header for the Atmel EVK1100.
  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>Green</td><td>LED0 LED</td><td>Low</td><td>GPIO51</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>LED1 LED</td><td>Low</td><td>GPIO52</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Green</td><td>LED2 LED</td><td>Low</td><td>GPIO53</td></tr>
  50  *    <tr><td>LEDS_LED4</td><td>Green</td><td>LED3 LED</td><td>Low</td><td>GPIO54</td></tr>
  51  *    <tr><td>LEDS_LED5</td><td>Green</td><td>LED4 LED</td><td>Low</td><td>GPIO59</td></tr>
  52  *    <tr><td>LEDS_LED6</td><td>Green</td><td>LED5 LED</td><td>Low</td><td>GPIO60</td></tr>
  53  *    <tr><td>LEDS_LED7</td><td>Green</td><td>LED6 LED</td><td>Low</td><td>GPIO61</td></tr>
  54  *    <tr><td>LEDS_LED8</td><td>Green</td><td>LED7 LED</td><td>Low</td><td>GPIO62</td></tr>
  55  *  </table>
  56  *
  57  *  @{
  58  */
  59
  60 #ifndef __LEDS_EVK1100_H__
  61 #define __LEDS_EVK1100_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         /* Private Interface - For use in library only: */
  77         #if !defined(__DOXYGEN__)
  78                 /* Macros: */
  79                         #define LEDS_PORT        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        (1UL << 19)
  86
  87                         /** LED mask for the second LED on the board. */
  88                         #define LEDS_LED2        (1UL << 20)
  89
  90                         /** LED mask for the third LED on the board. */
  91                         #define LEDS_LED3        (1UL << 21)
  92
  93                         /** LED mask for the fourth LED on the board. */
  94                         #define LEDS_LED4        (1UL << 22)
  95
  96                         /** LED mask for the fifth LED on the board. */
  97                         #define LEDS_LED5        (1UL << 27)
  98
  99                         /** LED mask for the sixth LED on the board. */
 100                         #define LEDS_LED6        (1UL << 28)
 101
 102                         /** LED mask for the seventh LED on the board. */
 103                         #define LEDS_LED7        (1UL << 29)
 104
 105                         /** LED mask for the eighth LED on the board. */
 106                         #define LEDS_LED8        (1UL << 30)
 107
 108                         /** LED mask for all the LEDs on the board. */
 109                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4 \
 110                                                   LEDS_LED5 | LEDS_LED6 | LEDS_LED7 | LEDS_LED8)
 111
 112                         /** LED mask for the none of the board LEDs */
 113                         #define LEDS_NO_LEDS     0
 114
 115                 /* Inline Functions: */
 116                 #if !defined(__DOXYGEN__)
 117                         static inline void LEDs_Init(void)
 118                         {
 119                                 AVR32_GPIO.port[LEDS_PORT].gpers = LEDS_ALL_LEDS;
 120                                 AVR32_GPIO.port[LEDS_PORT].oders = LEDS_ALL_LEDS;
 121                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDS_ALL_LEDS;
 122                         }
 123
 124                         static inline void LEDs_Disable(void)
 125                         {
 126                                 AVR32_GPIO.port[LEDS_PORT].gperc = LEDS_ALL_LEDS;
 127                                 AVR32_GPIO.port[LEDS_PORT].oderc = LEDS_ALL_LEDS;
 128                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LEDS_ALL_LEDS;
 129                         }
 130
 131                         static inline void LEDs_TurnOnLEDs(const uint32_t LEDMask)
 132                         {
 133                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LEDMask;
 134                         }
 135
 136                         static inline void LEDs_TurnOffLEDs(const uint32_t LEDMask)
 137                         {
 138                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDMask;
 139                         }
 140
 141                         static inline void LEDs_SetAllLEDs(const uint32_t LEDMask)
 142                         {
 143                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDS_ALL_LEDS;
 144                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LEDMask;
 145                         }
 146
 147                         static inline void LEDs_ChangeLEDs(const uint32_t LEDMask, const uint32_t ActiveMask)
 148                         {
 149                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDMask;
 150                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = ActiveMask;
 151                         }
 152
 153                         static inline void LEDs_ToggleLEDs(const uint32_t LEDMask)
 154                         {
 155                                 AVR32_GPIO.port[LEDS_PORT].ovrt  = LEDMask;
 156                         }
 157
 158                         static inline uint32_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 159                         static inline uint32_t LEDs_GetLEDs(void)
 160                         {
 161                                 return (~AVR32_GPIO.port[LEDS_PORT].ovr & LEDS_ALL_LEDS);
 162                         }
 163                 #endif
 164
 165         /* Disable C linkage for C++ Compilers: */
 166                 #if defined(__cplusplus)
 167                         }
 168                 #endif
 169
 170 #endif
 171
 172 /** @} */
 173