protocol/lufa/LUFA-120730/LUFA/Drivers/Board/UC3/EVK1104/LEDs.h

   1 /*\r
   2              LUFA Library\r
   3      Copyright (C) Dean Camera, 2012.\r
   4 \r
   5   dean [at] fourwalledcubicle [dot] com\r
   6            www.lufa-lib.org\r
   7 */\r
   8 \r
   9 /*\r
  10   Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
  11 \r
  12   Permission to use, copy, modify, distribute, and sell this\r
  13   software and its documentation for any purpose is hereby granted\r
  14   without fee, provided that the above copyright notice appear in\r
  15   all copies and that both that the copyright notice and this\r
  16   permission notice and warranty disclaimer appear in supporting\r
  17   documentation, and that the name of the author not be used in\r
  18   advertising or publicity pertaining to distribution of the\r
  19   software without specific, written prior permission.\r
  20 \r
  21   The author disclaim all warranties with regard to this\r
  22   software, including all implied warranties of merchantability\r
  23   and fitness.  In no event shall the author be liable for any\r
  24   special, indirect or consequential damages or any damages\r
  25   whatsoever resulting from loss of use, data or profits, whether\r
  26   in an action of contract, negligence or other tortious action,\r
  27   arising out of or in connection with the use or performance of\r
  28   this software.\r
  29 */\r
  30 \r
  31 /** \file\r
  32  *  \brief Board specific LED driver header for the Atmel EVK1104.\r
  33  *  \copydetails Group_LEDs_EVK1104\r
  34  *\r
  35  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
  36  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
  37  */\r
  38 \r
  39 /** \ingroup Group_LEDs\r
  40  *  \defgroup Group_LEDs_EVK1104 EVK1104\r
  41  *  \brief Board specific LED driver header for the Atmel EVK1104.\r
  42  *\r
  43  *  Board specific LED driver header for the Atmel EVK1104.\r
  44  *\r
  45  *  <table>\r
  46  *    <tr><th>Name</th><th>Color</th><th>Info</th><th>Active Level</th><th>Port Pin</th></tr>\r
  47  *    <tr><td>LEDS_LED1</td><td>Green</td><td>LED0 LED</td><td>Low</td><td>GPIO67</td></tr>\r
  48  *    <tr><td>LEDS_LED2</td><td>Green</td><td>LED1 LED</td><td>Low</td><td>GPIO101</td></tr>\r
  49  *    <tr><td>LEDS_LED3</td><td>Green</td><td>LED2 LED</td><td>Low</td><td>GPIO102</td></tr>\r
  50  *    <tr><td>LEDS_LED4</td><td>Green</td><td>LED3 LED</td><td>Low</td><td>GPIO105</td></tr>\r
  51  *  </table>\r
  52  *\r
  53  *  @{\r
  54  */\r
  55 \r
  56 #ifndef __LEDS_EVK1104_H__\r
  57 #define __LEDS_EVK1104_H__\r
  58 \r
  59         /* Includes: */\r
  60                 #include "../../../../Common/Common.h"\r
  61 \r
  62         /* Enable C linkage for C++ Compilers: */\r
  63                 #if defined(__cplusplus)\r
  64                         extern "C" {\r
  65                 #endif\r
  66 \r
  67         /* Preprocessor Checks: */\r
  68                 #if !defined(__INCLUDE_FROM_LEDS_H)\r
  69                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
  70                 #endif\r
  71 \r
  72         /* Private Interface - For use in library only: */\r
  73         #if !defined(__DOXYGEN__)\r
  74                 /* Macros: */\r
  75                         #define LEDS_LEDMASK2    (1UL << 3)\r
  76                         #define LEDS_LEDMASK3   ((1UL << 9) | (1UL << 6) | (1UL << 5))\r
  77         #endif\r
  78 \r
  79         /* Public Interface - May be used in end-application: */\r
  80                 /* Macros: */\r
  81                         /** LED mask for the first LED on the board. */\r
  82                         #define LEDS_LED1        (1UL << 3)\r
  83 \r
  84                         /** LED mask for the second LED on the board. */\r
  85                         #define LEDS_LED2        (1UL << 5)\r
  86 \r
  87                         /** LED mask for the third LED on the board. */\r
  88                         #define LEDS_LED3        (1UL << 9)\r
  89 \r
  90                         /** LED mask for the fourth LED on the board. */\r
  91                         #define LEDS_LED4        (1UL << 6)\r
  92 \r
  93                         /** LED mask for all the LEDs on the board. */\r
  94                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)\r
  95 \r
  96                         /** LED mask for the none of the board LEDs */\r
  97                         #define LEDS_NO_LEDS     0\r
  98 \r
  99                 /* Inline Functions: */\r
 100                 #if !defined(__DOXYGEN__)\r
 101                         static inline void LEDs_Init(void)\r
 102                         {\r
 103                                 AVR32_GPIO.port[2].gpers = LEDS_LEDMASK2;\r
 104                                 AVR32_GPIO.port[2].oders = LEDS_LEDMASK2;\r
 105                                 AVR32_GPIO.port[2].ovrs  = LEDS_LEDMASK2;\r
 106 \r
 107                                 AVR32_GPIO.port[3].gpers = LEDS_LEDMASK3;\r
 108                                 AVR32_GPIO.port[3].oders = LEDS_LEDMASK3;\r
 109                                 AVR32_GPIO.port[3].ovrs  = LEDS_LEDMASK3;\r
 110                         }\r
 111 \r
 112                         static inline void LEDs_Disable(void)\r
 113                         {\r
 114                                 AVR32_GPIO.port[2].gperc = LEDS_LEDMASK2;\r
 115                                 AVR32_GPIO.port[2].oderc = LEDS_LEDMASK2;\r
 116                                 AVR32_GPIO.port[2].ovrc  = LEDS_LEDMASK2;\r
 117 \r
 118                                 AVR32_GPIO.port[3].gperc = LEDS_LEDMASK3;\r
 119                                 AVR32_GPIO.port[3].oderc = LEDS_LEDMASK3;\r
 120                                 AVR32_GPIO.port[3].ovrc  = LEDS_LEDMASK3;\r
 121                         }\r
 122 \r
 123                         static inline void LEDs_TurnOnLEDs(const uint32_t LEDMask)\r
 124                         {\r
 125                                 AVR32_GPIO.port[2].ovrc  = (LEDMask & LEDS_LEDMASK2);\r
 126                                 AVR32_GPIO.port[3].ovrc  = (LEDMask & LEDS_LEDMASK3);\r
 127                         }\r
 128 \r
 129                         static inline void LEDs_TurnOffLEDs(const uint32_t LEDMask)\r
 130                         {\r
 131                                 AVR32_GPIO.port[2].ovrs  = (LEDMask & LEDS_LEDMASK2);\r
 132                                 AVR32_GPIO.port[3].ovrs  = (LEDMask & LEDS_LEDMASK3);\r
 133                         }\r
 134 \r
 135                         static inline void LEDs_SetAllLEDs(const uint32_t LEDMask)\r
 136                         {\r
 137                                 AVR32_GPIO.port[2].ovrs  = LEDS_LEDMASK2;\r
 138                                 AVR32_GPIO.port[2].ovrc  = (LEDMask & LEDS_LEDMASK2);\r
 139 \r
 140                                 AVR32_GPIO.port[3].ovrs  = LEDS_LEDMASK3;\r
 141                                 AVR32_GPIO.port[3].ovrc  = (LEDMask & LEDS_LEDMASK3);\r
 142                         }\r
 143 \r
 144                         static inline void LEDs_ChangeLEDs(const uint32_t LEDMask, const uint32_t ActiveMask)\r
 145                         {\r
 146                                 AVR32_GPIO.port[2].ovrs  = (LEDMask    & LEDS_LEDMASK2);\r
 147                                 AVR32_GPIO.port[2].ovrc  = (ActiveMask & LEDS_LEDMASK2);\r
 148 \r
 149                                 AVR32_GPIO.port[3].ovrs  = (LEDMask    & LEDS_LEDMASK3);\r
 150                                 AVR32_GPIO.port[3].ovrc  = (ActiveMask & LEDS_LEDMASK3);\r
 151                         }\r
 152 \r
 153                         static inline void LEDs_ToggleLEDs(const uint32_t LEDMask)\r
 154                         {\r
 155                                 AVR32_GPIO.port[2].ovrt  = (LEDMask & LEDS_LEDMASK2);\r
 156                                 AVR32_GPIO.port[3].ovrt  = (LEDMask & LEDS_LEDMASK3);\r
 157                         }\r
 158 \r
 159                         static inline uint32_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
 160                         static inline uint32_t LEDs_GetLEDs(void)\r
 161                         {\r
 162                                 return ((~AVR32_GPIO.port[2].ovr & LEDS_LEDMASK2) | (~AVR32_GPIO.port[3].ovr & LEDS_LEDMASK3));\r
 163                         }\r
 164                 #endif\r
 165 \r
 166         /* Disable C linkage for C++ Compilers: */\r
 167                 #if defined(__cplusplus)\r
 168                         }\r
 169                 #endif\r
 170 \r
 171 #endif\r
 172 \r
 173 /** @} */\r
 174 \r