Statistics
| Branch: | Tag: | Revision:

root / LUFA / Drivers / Board / AVR8 / BUMBLEB / LEDs.h @ 978b99e5

History | View | Annotate | Download (4 KB)

1
/*
2
             LUFA Library
3
     Copyright (C) Dean Camera, 2011.
4

5
  dean [at] fourwalledcubicle [dot] com
6
           www.lufa-lib.org
7
*/
8

    
9
/*
10
  Copyright 2011  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
 *  \brief Board specific LED driver header for the Fletchtronics BUMBLEB.
33
 *  \copydetails Group_LEDs_BUMBLEB
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_BUMBLEB BUMBLEB
41
 *  \brief Board specific LED driver header for the Fletchtronics BUMBLEB.
42
 *
43
 *  Board specific LED driver header for the Fletchtronics BUMBLEB (http://fletchtronics.net/bumble-b). The BUMBLEB
44
 *  third-party board does not include any on-board peripherals, but does have an officially recommended external
45
 *  peripheral layout for buttons, LEDs and a Joystick.
46
 *
47
 *  @{
48
 */
49

    
50
#ifndef __LEDS_BUMBLEB_H__
51
#define __LEDS_BUMBLEB_H__
52

    
53
        /* Includes: */
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
        /* Public Interface - May be used in end-application: */
67
                /* Macros: */
68
                        /** LED mask for the first LED on the board. */
69
                        #define LEDS_LED1        (1 << 4)
70

    
71
                        /** LED mask for the second LED on the board. */
72
                        #define LEDS_LED2        (1 << 5)
73

    
74
                        /** LED mask for the third LED on the board. */
75
                        #define LEDS_LED3        (1 << 6)
76

    
77
                        /** LED mask for the fourth LED on the board. */
78
                        #define LEDS_LED4        (1 << 7)
79

    
80
                        /** LED mask for all the LEDs on the board. */
81
                        #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
82

    
83
                        /** LED mask for 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
                                DDRB  |=  LEDS_ALL_LEDS;
91
                                PORTB &= ~LEDS_ALL_LEDS;
92
                        }
93

    
94
                        static inline void LEDs_TurnOnLEDs(const uint8_t LedMask)
95
                        {
96
                                PORTB |= LedMask;
97
                        }
98

    
99
                        static inline void LEDs_TurnOffLEDs(const uint8_t LedMask)
100
                        {
101
                                PORTB &= ~LedMask;
102
                        }
103

    
104
                        static inline void LEDs_SetAllLEDs(const uint8_t LedMask)
105
                        {
106
                                PORTB = ((PORTB & ~LEDS_ALL_LEDS) | LedMask);
107
                        }
108

    
109
                        static inline void LEDs_ChangeLEDs(const uint8_t LedMask,
110
                                                           const uint8_t ActiveMask)
111
                        {
112
                                PORTB = ((PORTB & ~LedMask) | ActiveMask);
113
                        }
114

    
115
                        static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
116
                        {
117
                                PORTB ^= LEDMask;
118
                        }
119

    
120
                        static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
121
                        static inline uint8_t LEDs_GetLEDs(void)
122
                        {
123
                                return (PORTB & LEDS_ALL_LEDS);
124
                        }
125
                #endif
126

    
127
        /* Disable C linkage for C++ Compilers: */
128
                #if defined(__cplusplus)
129
                        }
130
                #endif
131

    
132
#endif
133

    
134
/** @} */
135