protocol/lufa/LUFA-120730/LUFA/Drivers/Board/UC3/EVK1101/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 Atmel EVK1101.
  33  *  \copydetails Group_LEDs_EVK1101
  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_EVK1101 EVK1101
  41  *  \brief Board specific LED driver header for the Atmel EVK1101.
  42  *
  43  *  Board specific LED driver header for the Atmel EVK1101.
  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>GPIO7</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>LED1 LED</td><td>Low</td><td>GPIO8</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Green</td><td>LED2 LED</td><td>Low</td><td>GPIO21</td></tr>
  50  *    <tr><td>LEDS_LED4</td><td>Green</td><td>LED3 LED</td><td>Low</td><td>GPIO22</td></tr>
  51  *  </table>
  52  *
  53  *  @{
  54  */
  55
  56 #ifndef __LEDS_EVK1101_H__
  57 #define __LEDS_EVK1101_H__
  58
  59         /* Includes: */
  60                 #include "../../../../Common/Common.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_PORT        0
  76         #endif
  77
  78         /* Public Interface - May be used in end-application: */
  79                 /* Macros: */
  80                         /** LED mask for the first LED on the board. */
  81                         #define LEDS_LED1        (1UL << 7)
  82
  83                         /** LED mask for the second LED on the board. */
  84                         #define LEDS_LED2        (1UL << 8)
  85
  86                         /** LED mask for the third LED on the board. */
  87                         #define LEDS_LED3        (1UL << 21)
  88
  89                         /** LED mask for the fourth LED on the board. */
  90                         #define LEDS_LED4        (1UL << 22)
  91
  92                         /** LED mask for all the LEDs on the board. */
  93                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  94
  95                         /** LED mask for the none of the board LEDs */
  96                         #define LEDS_NO_LEDS     0
  97
  98                 /* Inline Functions: */
  99                 #if !defined(__DOXYGEN__)
 100                         static inline void LEDs_Init(void)
 101                         {
 102                                 AVR32_GPIO.port[LEDS_PORT].gpers = LEDS_ALL_LEDS;
 103                                 AVR32_GPIO.port[LEDS_PORT].oders = LEDS_ALL_LEDS;
 104                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDS_ALL_LEDS;
 105                         }
 106
 107                         static inline void LEDs_Disable(void)
 108                         {
 109                                 AVR32_GPIO.port[LEDS_PORT].gperc = LEDS_ALL_LEDS;
 110                                 AVR32_GPIO.port[LEDS_PORT].oderc = LEDS_ALL_LEDS;
 111                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LEDS_ALL_LEDS;
 112                         }
 113
 114                         static inline void LEDs_TurnOnLEDs(const uint32_t LEDMask)
 115                         {
 116                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LEDMask;
 117                         }
 118
 119                         static inline void LEDs_TurnOffLEDs(const uint32_t LEDMask)
 120                         {
 121                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDMask;
 122                         }
 123
 124                         static inline void LEDs_SetAllLEDs(const uint32_t LEDMask)
 125                         {
 126                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDS_ALL_LEDS;
 127                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LEDMask;
 128                         }
 129
 130                         static inline void LEDs_ChangeLEDs(const uint32_t LEDMask, const uint32_t ActiveMask)
 131                         {
 132                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDMask;
 133                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = ActiveMask;
 134                         }
 135
 136                         static inline void LEDs_ToggleLEDs(const uint32_t LEDMask)
 137                         {
 138                                 AVR32_GPIO.port[LEDS_PORT].ovrt  = LEDMask;
 139                         }
 140
 141                         static inline uint32_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 142                         static inline uint32_t LEDs_GetLEDs(void)
 143                         {
 144                                 return (~AVR32_GPIO.port[LEDS_PORT].ovr & LEDS_ALL_LEDS);
 145                         }
 146                 #endif
 147
 148         /* Disable C linkage for C++ Compilers: */
 149                 #if defined(__cplusplus)
 150                         }
 151                 #endif
 152
 153 #endif
 154
 155 /** @} */
 156