LUFA/Drivers/Board/ATAVRUSBRF01/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  *
  33  *  Board specific LED driver header for the ATAVRUSBRF01.
  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_ATAVRUSBRF01 ATAVRUSBRF01
  41  *
  42  *  @{
  43  */
  44
  45 #ifndef __LEDS_ATAVRUSBRF01_H__
  46 #define __LEDS_ATAVRUSBRF01_H__
  47
  48         /* Includes: */
  49                 #include <avr/io.h>
  50
  51                 #include "../../../Common/Common.h"
  52
  53         /* Enable C linkage for C++ Compilers: */
  54                 #if defined(__cplusplus)
  55                         extern "C" {
  56                 #endif
  57
  58         /* Preprocessor Checks: */
  59                 #if !defined(INCLUDE_FROM_LEDS_H)
  60                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  61                 #endif
  62
  63         /* Private Interface - For use in library only: */
  64         #if !defined(__DOXYGEN__)
  65                 /* Macros: */
  66                         #define LEDS_PORTD_LEDS       (LEDS_LED1 | LEDS_LED2)
  67                         #define LEDS_PORTE_LEDS       (LEDS_LED3 | LEDS_LED4)
  68
  69                         #define LEDS_PORTE_MASK_SHIFT 4
  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             (1 << 0)
  76
  77                         /** LED mask for the second LED on the board. */
  78                         #define LEDS_LED2             (1 << 1)
  79
  80                         /** LED mask for all the LEDs on the board. */
  81                         #define LEDS_ALL_LEDS         (LEDS_LED1 | LEDS_LED2)
  82
  83                         /** LED mask for the none of the board LEDs */
  84                         #define LEDS_NO_LEDS          0
  85
  86                 /* Inline Functions: */
  87                 #if !defined(__DOXYGEN__)
  88                         static inline void LEDs_Init(void)
  89                         {
  90                                 DDRD  |=  LEDS_ALL_LEDS;
  91                                 PORTD &= ~LEDS_ALL_LEDS;
  92                         }
  93
  94                         static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
  95                         {
  96                                 PORTD |= (LEDMask & LEDS_ALL_LEDS);
  97                         }
  98
  99                         static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
 100                         {
 101                                 PORTD &= ~(LEDMask & LEDS_ALL_LEDS);
 102                         }
 103
 104                         static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
 105                         {
 106                                 PORTD = (PORTD & ~LEDS_ALL_LEDS) | (LEDMask & LEDS_ALL_LEDS);
 107                         }
 108
 109                         static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask)
 110                         {
 111                                 PORTD = ((PORTD & ~(LEDMask & LEDS_ALL_LEDS)) | (ActiveMask & LEDS_ALL_LEDS));
 112                         }
 113
 114                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 115                         static inline uint8_t LEDs_GetLEDs(void)
 116                         {
 117                                 return (PORTD & LEDS_ALL_LEDS);
 118                         }
 119                 #endif
 120
 121         /* Disable C linkage for C++ Compilers: */
 122                 #if defined(__cplusplus)
 123                         }
 124                 #endif
 125
 126 #endif
 127
 128 /** @} */