LUFA/Drivers/Board/EVK1101/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *  @{
  46  */
  47
  48 #ifndef __LEDS_EVK1101_H__
  49 #define __LEDS_EVK1101_H__
  50
  51         /* Includes: */
  52                 #include <avr32/io.h>
  53
  54                 #include "../../../Common/Common.h"
  55
  56         /* Enable C linkage for C++ Compilers: */
  57                 #if defined(__cplusplus)
  58                         extern "C" {
  59                 #endif
  60
  61         /* Preprocessor Checks: */
  62                 #if !defined(__INCLUDE_FROM_LEDS_H)
  63                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  64                 #endif
  65
  66         /* Private Interface - For use in library only: */
  67         #if !defined(__DOXYGEN__)
  68                 /* Macros: */
  69                         #define LEDS_PORT        0
  70         #endif
  71
  72         /* Public Interface - May be used in end-application: */
  73                 /* Macros: */
  74                         /** LED mask for the first LED on the board. */
  75                         #define LEDS_LED1        (1UL << 7)
  76
  77                         /** LED mask for the second LED on the board. */
  78                         #define LEDS_LED2        (1UL << 8)
  79
  80                         /** LED mask for the third LED on the board. */
  81                         #define LEDS_LED3        (1UL << 21)
  82
  83                         /** LED mask for the fourth LED on the board. */
  84                         #define LEDS_LED4        (1UL << 22)
  85
  86                         /** LED mask for all the LEDs on the board. */
  87                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  88
  89                         /** LED mask for the none of the board LEDs */
  90                         #define LEDS_NO_LEDS     0
  91
  92                 /* Inline Functions: */
  93                 #if !defined(__DOXYGEN__)
  94                         static inline void LEDs_Init(void)
  95                         {
  96                                 AVR32_GPIO.port[LEDS_PORT].gpers = LEDS_ALL_LEDS;
  97                                 AVR32_GPIO.port[LEDS_PORT].oders = LEDS_ALL_LEDS;
  98                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDS_ALL_LEDS;
  99                         }
 100
 101                         static inline void LEDs_TurnOnLEDs(const uint32_t LedMask)
 102                         {
 103                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LedMask;
 104                         }
 105
 106                         static inline void LEDs_TurnOffLEDs(const uint32_t LedMask)
 107                         {
 108                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LedMask;
 109                         }
 110
 111                         static inline void LEDs_SetAllLEDs(const uint32_t LedMask)
 112                         {
 113                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LEDS_ALL_LEDS;
 114                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = LedMask;
 115                         }
 116
 117                         static inline void LEDs_ChangeLEDs(const uint32_t LedMask, const uint32_t ActiveMask)
 118                         {
 119                                 AVR32_GPIO.port[LEDS_PORT].ovrs  = LedMask;
 120                                 AVR32_GPIO.port[LEDS_PORT].ovrc  = ActiveMask;
 121                         }
 122
 123                         static inline uint32_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 124                         static inline uint32_t LEDs_GetLEDs(void)
 125                         {
 126                                 return (AVR32_GPIO.port[LEDS_PORT].ovr & LEDS_ALL_LEDS);
 127                         }
 128                 #endif
 129
 130         /* Disable C linkage for C++ Compilers: */
 131                 #if defined(__cplusplus)
 132                         }
 133                 #endif
 134
 135 #endif
 136
 137 /** @} */