Statistics
| Branch: | Tag: | Revision:

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

History | View | Annotate | Download (3.9 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 Atmel ATAVRUSBRF01.
33
 *  \copydetails Group_LEDs_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
 *  \brief Board specific LED driver header for the Atmel ATAVRUSBRF01.
42
 *
43
 *  Board specific LED driver header for the Atmel ATAVRUSBRF01.
44
 *
45
 *  @{
46
 */
47

    
48
#ifndef __LEDS_ATAVRUSBRF01_H__
49
#define __LEDS_ATAVRUSBRF01_H__
50

    
51
        /* Includes: */
52
                #include "../../../../Common/Common.h"
53

    
54
        /* Enable C linkage for C++ Compilers: */
55
                #if defined(__cplusplus)
56
                        extern "C" {
57
                #endif
58

    
59
        /* Preprocessor Checks: */
60
                #if !defined(__INCLUDE_FROM_LEDS_H)
61
                        #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
62
                #endif
63

    
64
        /* Private Interface - For use in library only: */
65
        #if !defined(__DOXYGEN__)
66
                /* Macros: */
67
                        #define LEDS_PORTD_LEDS       (LEDS_LED1 | LEDS_LED2)
68
                        #define LEDS_PORTE_LEDS       (LEDS_LED3 | LEDS_LED4)
69

    
70
                        #define LEDS_PORTE_MASK_SHIFT 4
71
        #endif
72

    
73
        /* Public Interface - May be used in end-application: */
74
                /* Macros: */
75
                        /** LED mask for the first LED on the board. */
76
                        #define LEDS_LED1        (1 << 0)
77

    
78
                        /** LED mask for the second LED on the board. */
79
                        #define LEDS_LED2        (1 << 1)
80

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

    
84
                        /** LED mask for none of the board LEDs. */
85
                        #define LEDS_NO_LEDS     0
86

    
87
                /* Inline Functions: */
88
                #if !defined(__DOXYGEN__)
89
                        static inline void LEDs_Init(void)
90
                        {
91
                                DDRD  |=  LEDS_ALL_LEDS;
92
                                PORTD &= ~LEDS_ALL_LEDS;
93
                        }
94

    
95
                        static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
96
                        {
97
                                PORTD |= (LEDMask & LEDS_ALL_LEDS);
98
                        }
99

    
100
                        static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
101
                        {
102
                                PORTD &= ~(LEDMask & LEDS_ALL_LEDS);
103
                        }
104

    
105
                        static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
106
                        {
107
                                PORTD = (PORTD & ~LEDS_ALL_LEDS) | (LEDMask & LEDS_ALL_LEDS);
108
                        }
109

    
110
                        static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
111
                                                           const uint8_t ActiveMask)
112
                        {
113
                                PORTD = ((PORTD & ~LEDMask) | ActiveMask);
114
                        }
115

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

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

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

    
133
#endif
134

    
135
/** @} */
136