LUFA/Drivers/Board/BUMBLEB/LEDs.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  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  *
  33  *  Board specific LED driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board
  34  *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
  35  *
  36  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  37  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  38  */
  39
  40 /** \ingroup Group_LEDs
  41  *  @defgroup Group_LEDs_BUMBLEB BUMBLEB
  42  *
  43  *  Board specific LED driver header for the BUMBLEB. The BUMBLEB third-party board does not include any on-board
  44  *  peripherals, but does have an officially recommended external peripheral layout for buttons, LEDs and a Joystick.
  45  *
  46  *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
  47  *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
  48  *
  49  *  @{
  50  */
  51
  52 #ifndef __LEDS_BUMBLEB_H__
  53 #define __LEDS_BUMBLEB_H__
  54
  55         /* Includes: */
  56                 #include <avr/io.h>
  57
  58                 #include "../../../Common/Common.h"
  59
  60         /* Enable C linkage for C++ Compilers: */
  61                 #if defined(__cplusplus)
  62                         extern "C" {
  63                 #endif
  64
  65         /* Preprocessor Checks: */
  66                 #if !defined(__INCLUDE_FROM_LEDS_H)
  67                         #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
  68                 #endif
  69
  70         /* Public Interface - May be used in end-application: */
  71                 /* Macros: */
  72                         /** LED mask for the first LED on the board. */
  73                         #define LEDS_LED1        (1 << 4)
  74
  75                         /** LED mask for the second LED on the board. */
  76                         #define LEDS_LED2        (1 << 5)
  77
  78                         /** LED mask for the third LED on the board. */
  79                         #define LEDS_LED3        (1 << 6)
  80
  81                         /** LED mask for the fourth LED on the board. */
  82                         #define LEDS_LED4        (1 << 7)
  83
  84                         /** LED mask for all the LEDs on the board. */
  85                         #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
  86
  87                         /** LED mask for the none of the board LEDs */
  88                         #define LEDS_NO_LEDS     0
  89
  90                 /* Inline Functions: */
  91                 #if !defined(__DOXYGEN__)
  92                         static inline void LEDs_Init(void)
  93                         {
  94                                 DDRB  |=  LEDS_ALL_LEDS;
  95                                 PORTB &= ~LEDS_ALL_LEDS;
  96                         }
  97
  98                         static inline void LEDs_TurnOnLEDs(const uint8_t LedMask)
  99                         {
 100                                 PORTB |= LedMask;
 101                         }
 102
 103                         static inline void LEDs_TurnOffLEDs(const uint8_t LedMask)
 104                         {
 105                                 PORTB &= ~LedMask;
 106                         }
 107
 108                         static inline void LEDs_SetAllLEDs(const uint8_t LedMask)
 109                         {
 110                                 PORTB = ((PORTB & ~LEDS_ALL_LEDS) | LedMask);
 111                         }
 112
 113                         static inline void LEDs_ChangeLEDs(const uint8_t LedMask, const uint8_t ActiveMask)
 114                         {
 115                                 PORTB = ((PORTB & ~LedMask) | ActiveMask);
 116                         }
 117
 118                         static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
 119                         static inline uint8_t LEDs_GetLEDs(void)
 120                         {
 121                                 return (PORTB & LEDS_ALL_LEDS);
 122                         }
 123                 #endif
 124
 125         /* Disable C linkage for C++ Compilers: */
 126                 #if defined(__cplusplus)
 127                         }
 128                 #endif
 129
 130 #endif
 131
 132 /** @} */