LUFA/Drivers/Board/UC3/EVK1104/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2015.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6            www.lufa-lib.org
   7 */
   8
   9 /*
  10   Copyright 2015  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 EVK1104.
  33  *  \copydetails Group_LEDs_EVK1104
  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_EVK1104 EVK1104
  41  *  \brief Board specific LED driver header for the Atmel EVK1104.
  42  *
  43  *  Board specific LED driver header for the Atmel EVK1104.
  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>GPIO67</td></tr>
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>LED1 LED</td><td>Low</td><td>GPIO101</td></tr>
  49  *    <tr><td>LEDS_LED3</td><td>Green</td><td>LED2 LED</td><td>Low</td><td>GPIO102</td></tr>
  50  *    <tr><td>LEDS_LED4</td><td>Green</td><td>LED3 LED</td><td>Low</td><td>GPIO105</td></tr>
  51  *  </table>
  52  *
  53  *  @{
  54  */
  55
  56 #ifndef __LEDS_EVK1104_H__
  57 #define __LEDS_EVK1104_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_LEDMASK2    (1UL << 3)
  76                         #define LEDS_LEDMASK3   ((1UL << 9) | (1UL << 6) | (1UL << 5))
  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        (1UL << 3)
  83
  84                         /** LED mask for the second LED on the board. */
  85                         #define LEDS_LED2        (1UL << 5)
  86
  87                         /** LED mask for the third LED on the board. */
  88                         #define LEDS_LED3        (1UL << 9)
  89
  90                         /** LED mask for the fourth LED on the board. */
  91                         #define LEDS_LED4        (1UL << 6)
  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 the 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                                 AVR32_GPIO.port[2].gpers = LEDS_LEDMASK2;
 104                                 AVR32_GPIO.port[2].oders = LEDS_LEDMASK2;
 105                                 AVR32_GPIO.port[2].ovrs  = LEDS_LEDMASK2;
 106
 107                                 AVR32_GPIO.port[3].gpers = LEDS_LEDMASK3;
 108                                 AVR32_GPIO.port[3].oders = LEDS_LEDMASK3;
 109                                 AVR32_GPIO.port[3].ovrs  = LEDS_LEDMASK3;
 110                         }
 111
 112                         static inline void LEDs_Disable(void)
 113                         {
 114                                 AVR32_GPIO.port[2].gperc = LEDS_LEDMASK2;
 115                                 AVR32_GPIO.port[2].oderc = LEDS_LEDMASK2;
 116                                 AVR32_GPIO.port[2].ovrc  = LEDS_LEDMASK2;
 117
 118                                 AVR32_GPIO.port[3].gperc = LEDS_LEDMASK3;
 119                                 AVR32_GPIO.port[3].oderc = LEDS_LEDMASK3;
 120                                 AVR32_GPIO.port[3].ovrc  = LEDS_LEDMASK3;
 121                         }
 122
 123                         static inline void LEDs_TurnOnLEDs(const uint32_t LEDMask)
 124                         {
 125                                 AVR32_GPIO.port[2].ovrc  = (LEDMask & LEDS_LEDMASK2);
 126                                 AVR32_GPIO.port[3].ovrc  = (LEDMask & LEDS_LEDMASK3);
 127                         }
 128
 129                         static inline void LEDs_TurnOffLEDs(const uint32_t LEDMask)
 130                         {
 131                                 AVR32_GPIO.port[2].ovrs  = (LEDMask & LEDS_LEDMASK2);
 132                                 AVR32_GPIO.port[3].ovrs  = (LEDMask & LEDS_LEDMASK3);
 133                         }
 134
 135                         static inline void LEDs_SetAllLEDs(const uint32_t LEDMask)
 136                         {
 137                                 AVR32_GPIO.port[2].ovrs  = LEDS_LEDMASK2;
 138                                 AVR32_GPIO.port[2].ovrc  = (LEDMask & LEDS_LEDMASK2);
 139
 140                                 AVR32_GPIO.port[3].ovrs  = LEDS_LEDMASK3;
 141                                 AVR32_GPIO.port[3].ovrc  = (LEDMask & LEDS_LEDMASK3);
 142                         }
 143
 144                         static inline void LEDs_ChangeLEDs(const uint32_t LEDMask, const uint32_t ActiveMask)
 145                         {
 146                                 AVR32_GPIO.port[2].ovrs  = (LEDMask    & LEDS_LEDMASK2);
 147                                 AVR32_GPIO.port[2].ovrc  = (ActiveMask & LEDS_LEDMASK2);
 148
 149                                 AVR32_GPIO.port[3].ovrs  = (LEDMask    & LEDS_LEDMASK3);
 150                                 AVR32_GPIO.port[3].ovrc  = (ActiveMask & LEDS_LEDMASK3);
 151                         }
 152
 153                         static inline void LEDs_ToggleLEDs(const uint32_t LEDMask)
 154                         {
 155                                 AVR32_GPIO.port[2].ovrt  = (LEDMask & LEDS_LEDMASK2);
 156                                 AVR32_GPIO.port[3].ovrt  = (LEDMask & LEDS_LEDMASK3);
 157                         }
 158
 159                         static inline uint32_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 160                         static inline uint32_t LEDs_GetLEDs(void)
 161                         {
 162                                 return ((~AVR32_GPIO.port[2].ovr & LEDS_LEDMASK2) | (~AVR32_GPIO.port[3].ovr & LEDS_LEDMASK3));
 163                         }
 164                 #endif
 165
 166         /* Disable C linkage for C++ Compilers: */
 167                 #if defined(__cplusplus)
 168                         }
 169                 #endif
 170
 171 #endif
 172
 173 /** @} */
 174