LEDs.h 4.2 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 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
  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.
*/

/*
   This is a stub driver header file, for implementing custom board
   layout hardware with compatible LUFA board specific drivers. If
   the library is configured to use the BOARD_USER board mode, this
   driver file should be completed and copied into the "/Board/" folder
   inside the application's folder.

   This stub is for the board-specific component of the LUFA LEDs driver,
   for the LEDs (up to four) mounted on most USB AVR boards.
*/

#ifndef __LEDS_USER_H__
#define __LEDS_USER_H__

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

		// TODO: Add any required includes here

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

	/* Preprocessor Checks: */
56
		#if !defined(__INCLUDE_FROM_LEDS_H)
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86
			#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        // TODO: Add mask for first board LED here

			/** LED mask for the second LED on the board. */
			#define LEDS_LED2        // TODO: Add mask for second board LED here

			/** LED mask for the third LED on the board. */
			#define LEDS_LED3        // TODO: Add mask for third board LED here

			/** LED mask for the fourth LED on the board. */
			#define LEDS_LED4        // TODO: Add mask for fourth board LED here

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

			/** 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)
			{
				// TODO: Add code to initialize LED port pins as outputs here
			}
			
87
			static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
88
			{
89
				// TODO: Add code to turn on LEDs given in the LEDMask mask here, leave others as-is
90 91
			}

92
			static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
93
			{
94
				// TODO: Add code to turn off LEDs given in the LEDMask mask here, leave others as-is
95 96
			}

97
			static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
98
			{
99
				// TODO: Add code to turn on only LEDs given in the LEDMask mask here, all others off
100 101
			}
			
102
			static inline void LEDs_ChangeLEDs(const uint8_t LEDMask, const uint8_t ActiveMask)
103
			{
104 105 106
				// TODO: Add code to set the Leds in the given LEDMask to the status given in ActiveMask here
			}

107
			static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
108 109
			{
				// TODO: Add code to toggle the Leds in the given LEDMask, ignoring all others
110 111
			}
			
112 113
			static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
			static inline uint8_t LEDs_GetLEDs(void)
114 115 116 117 118 119 120 121 122 123 124
			{
				// TODO: Add code to return the current LEDs status' here which can be masked against LED_LED* macros
			}
		#endif

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