LEDs.h 3.99 KB
Newer Older
1
2
/*
             LUFA Library
Dean Camera's avatar
Dean Camera committed
3
     Copyright (C) Dean Camera, 2010.
4
5
6
7
8
9
              
  dean [at] fourwalledcubicle [dot] com
      www.fourwalledcubicle.com
*/

/*
Dean Camera's avatar
Dean Camera committed
10
  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
11

12
13
14
15
16
17
18
  Permission to use, copy, modify, distribute, and sell this 
  software and its documentation for any purpose is hereby granted
  without fee, provided that the above copyright notice appear in 
  all copies and that both that the copyright notice and this
  permission notice and warranty disclaimer appear in supporting 
  documentation, and that the name of the author not be used in 
  advertising or publicity pertaining to distribution of the 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
  software without specific, written prior permission.

  The author disclaim all warranties with regard to this
  software, including all implied warranties of merchantability
  and fitness.  In no event shall the author be liable for any
  special, indirect or consequential damages or any damages
  whatsoever resulting from loss of use, data or profits, whether
  in an action of contract, negligence or other tortious action,
  arising out of or in connection with the use or performance of
  this software.
*/

/** \file
 *
 *  Board specific LED driver header for the ATAVRUSBRF01.
 *
 *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
 *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
 */
 
39
40
41
/** \ingroup Group_LEDs
 *  @defgroup Group_LEDs_ATAVRUSBRF01 ATAVRUSBRF01
 *
42
43
44
45
46
 *  Board specific LED driver header for the ATAVRUSBRF01.
 *
 *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver
 *        dispatch header located in LUFA/Drivers/Board/LEDs.h.
 *
47
48
49
 *  @{
 */
 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
#ifndef __LEDS_ATAVRUSBRF01_H__
#define __LEDS_ATAVRUSBRF01_H__

	/* Includes: */
		#include <avr/io.h>

		#include "../../../Common/Common.h"

	/* Enable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			extern "C" {
		#endif

	/* Preprocessor Checks: */
64
		#if !defined(__INCLUDE_FROM_LEDS_H)
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
			#error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.
		#endif

	/* Private Interface - For use in library only: */
	#if !defined(__DOXYGEN__)
		/* Macros: */
			#define LEDS_PORTD_LEDS       (LEDS_LED1 | LEDS_LED2)
			#define LEDS_PORTE_LEDS       (LEDS_LED3 | LEDS_LED4)
			
			#define LEDS_PORTE_MASK_SHIFT 4
	#endif

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

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

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

			/** LED mask for the none of the board LEDs */
			#define LEDS_NO_LEDS          0
			
		/* Inline Functions: */
		#if !defined(__DOXYGEN__)
			static inline void LEDs_Init(void)
			{
				DDRD  |=  LEDS_ALL_LEDS;
				PORTD &= ~LEDS_ALL_LEDS;
			}

99
			static inline void LEDs_TurnOnLEDs(const uintN_t LEDMask)
100
101
102
103
			{
				PORTD |= (LEDMask & LEDS_ALL_LEDS);
			}

104
			static inline void LEDs_TurnOffLEDs(const uintN_t LEDMask)
105
106
107
108
			{
				PORTD &= ~(LEDMask & LEDS_ALL_LEDS);
			}

109
			static inline void LEDs_SetAllLEDs(const uintN_t LEDMask)
110
111
112
113
			{
				PORTD = (PORTD & ~LEDS_ALL_LEDS) | (LEDMask & LEDS_ALL_LEDS);
			}
			
114
			static inline void LEDs_ChangeLEDs(const uintN_t LEDMask, const uintN_t ActiveMask)
115
			{
116
				PORTD = ((PORTD & ~(LEDMask & LEDS_ALL_LEDS)) | (ActiveMask & LEDS_ALL_LEDS));
117
			}
118

119
			static inline void LEDs_ToggleLEDs(const uintN_t LEDMask)
120
121
122
			{
				PORTD = (PORTD ^ (LEDMask & LEDS_ALL_LEDS));
			}
123
			
124
			static inline uintN_t LEDs_GetLEDs(void)
125
126
127
128
129
130
131
132
133
134
135
			{
				return (PORTD & LEDS_ALL_LEDS);
			}
		#endif

	/* Disable C linkage for C++ Compilers: */
		#if defined(__cplusplus)
			}
		#endif
	
#endif
136
137

/** @} */