LEDs.h 3.51 KB
Newer Older
1
2
/*
             LUFA Library
3
     Copyright (C) Dean Camera, 2012.
4

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

/*
10
  Copyright 2012  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
17
18
  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
  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
 *  \brief Board specific LED driver header for the Olimex AVR-USB-162.
33
 *  \copydetails Group_LEDs_OLIMEX162
34
35
36
37
38
39
 *
 *  \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.
 */

/** \ingroup Group_LEDs
40
 *  \defgroup Group_LEDs_OLIMEX162 OLIMEX162
41
 *  \brief Board specific LED driver header for the Olimex AVR-USB-162.
42
43
44
45
46
 *
 *  Board specific LED driver header for the Olimex AVR-USB-162 (http://www.olimex.com/dev/avr-usb-162.html).
 *
 *  @{
 */
47

48
49
50
51
#ifndef __LEDS_OLIMEX162_H__
#define __LEDS_OLIMEX162_H__

	/* Includes: */
52
		#include "../../../../Common/Common.h"
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

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

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

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

			/** LED mask for all the LEDs on the board. */
			#define LEDS_ALL_LEDS    LEDS_LED1

			/** LED mask for none of the board LEDs. */
			#define LEDS_NO_LEDS     0
74

75
76
77
78
		/* Inline Functions: */
		#if !defined(__DOXYGEN__)
			static inline void LEDs_Init(void)
			{
79
80
				DDRD  |=  LEDS_ALL_LEDS;
				PORTD &= ~LEDS_ALL_LEDS;
81
			}
82

83
84
85
86
87
88
			static inline void LEDs_Disable(void)
			{
				DDRD  &= ~LEDS_ALL_LEDS;
				PORTD &= ~LEDS_ALL_LEDS;
			}

89
90
			static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
			{
91
				PORTD |= LEDMask;
92
93
94
95
			}

			static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
			{
96
				PORTD &= ~LEDMask;
97
98
99
100
			}

			static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
			{
101
				PORTD = ((PORTD & ~LEDS_ALL_LEDS) | LEDMask);
102
			}
103

104
105
106
			static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
			                                   const uint8_t ActiveMask)
			{
107
				PORTD = ((PORTD & ~LEDMask) | ActiveMask);
108
			}
109

110
111
112
113
114
115
116
117
			static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
			{
				PORTD ^= LEDMask;
			}

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

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

127
128
129
#endif

/** @} */
130