Added board hardware driver support for the Busware CUL V3 board.
[pub/lufa.git] / LUFA / Drivers / Board / UDIP / LEDs.h
index aeb0957..36979f5 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2010.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, distribute, and sell this \r
-  software and its documentation for any purpose is hereby granted\r
-  without fee, provided that the above copyright notice appear in \r
-  all copies and that both that the copyright notice and this\r
-  permission notice and warranty disclaimer appear in supporting \r
-  documentation, and that the name of the author not be used in \r
-  advertising or publicity pertaining to distribution of the \r
-  software without specific, written prior permission.\r
-\r
-  The author disclaim all warranties with regard to this\r
-  software, including all implied warranties of merchantability\r
-  and fitness.  In no event shall the author be liable for any\r
-  special, indirect or consequential damages or any damages\r
-  whatsoever resulting from loss of use, data or profits, whether\r
-  in an action of contract, negligence or other tortious action,\r
-  arising out of or in connection with the use or performance of\r
-  this software.\r
-*/\r
-\r
-/** \file\r
- *  \brief Board specific LED driver header for the Linnix UDIP.\r
- *\r
- *  Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).\r
- *\r
- *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
- *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
- */\r
-\r
-/** \ingroup Group_LEDs\r
- *  @defgroup Group_LEDs_UDIP UDIP\r
- *\r
- *  Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).\r
- *\r
- *  \note This file should not be included directly. It is automatically included as needed by the LEDs driver\r
- *        dispatch header located in LUFA/Drivers/Board/LEDs.h.\r
- *\r
- *  @{\r
- */\r
-\r
-#ifndef __LEDS_UDIP_H__\r
-#define __LEDS_UDIP_H__\r
-\r
-       /* Includes: */\r
-               #include <avr/io.h>\r
-\r
-               #include "../../../Common/Common.h"\r
-\r
-       /* Enable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       extern "C" {\r
-               #endif\r
-\r
-       /* Preprocessor Checks: */\r
-               #if !defined(__INCLUDE_FROM_LEDS_H)\r
-                       #error Do not include this file directly. Include LUFA/Drivers/Board/LEDS.h instead.\r
-               #endif\r
-\r
-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\r
-               /* Macros: */\r
-                       #define LEDS_PORTB_LEDS       (LEDS_LED1 | LEDS_LED2)\r
-                       #define LEDS_PORTD_LEDS       (LEDS_LED3 | LEDS_LED4)\r
-                       \r
-                       #define LEDS_PORTD_MASK_SHIFT 1\r
-       #endif\r
-\r
-       /* Public Interface - May be used in end-application: */\r
-               /* Macros: */\r
-                       /** LED mask for the first LED on the board. */\r
-                       #define LEDS_LED1        (1 << 6)\r
-\r
-                       /** LED mask for the second LED on the board. */\r
-                       #define LEDS_LED2        (1 << 5)\r
-\r
-                       /** LED mask for the third LED on the board. */\r
-                       #define LEDS_LED3        ((1 << 5) >> LEDS_PORTD_MASK_SHIFT)\r
-\r
-                       /** LED mask for the fourth LED on the board. */\r
-                       #define LEDS_LED4        ((1 << 4) >> LEDS_PORTD_MASK_SHIFT)\r
-\r
-                       /** LED mask for all the LEDs on the board. */\r
-                       #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)\r
-\r
-                       /** LED mask for none of the board LEDs. */\r
-                       #define LEDS_NO_LEDS     0\r
-\r
-               /* Inline Functions: */\r
-               #if !defined(__DOXYGEN__)\r
-                       static inline void LEDs_Init(void)\r
-                       {\r
-                               DDRB |= LEDS_PORTB_LEDS;\r
-                               DDRD |= (LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT);\r
-                       }\r
-                       \r
-                       static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)\r
-                       {\r
-                               PORTB |= (LEDMask & LEDS_PORTB_LEDS);\r
-                               PORTD |= ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
-                       }\r
-\r
-                       static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)\r
-                       {\r
-                               PORTB &= ~(LEDMask & LEDS_PORTB_LEDS);\r
-                               PORTD &= ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
-                       }\r
-\r
-                       static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)\r
-                       {\r
-                               PORTB = (PORTB & ~LEDS_PORTB_LEDS) | (LEDMask & LEDS_PORTB_LEDS);\r
-                               PORTD = (PORTD & ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT)) |\r
-                                       ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
-                       }\r
-                       \r
-                       static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,\r
-                                                          const uint8_t ActiveMask)\r
-                       {\r
-                               PORTB = (PORTB & ~(LEDMask & LEDS_PORTB_LEDS)) | (ActiveMask & LEDS_PORTB_LEDS);\r
-                               PORTD = (PORTD & ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT)) |\r
-                                       ((ActiveMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
-                       }\r
-                       \r
-                       static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)\r
-                       {\r
-                               PORTB ^= (LEDMask & LEDS_PORTB_LEDS);\r
-                               PORTD ^= ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);\r
-                       }\r
-                       \r
-                       static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;\r
-                       static inline uint8_t LEDs_GetLEDs(void)\r
-                       {\r
-                               return ((PORTB & LEDS_PORTB_LEDS) | ((PORTD & LEDS_PORTD_LEDS) >> LEDS_PORTD_MASK_SHIFT));\r
-                       }\r
-               #endif\r
-\r
-       /* Disable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       }\r
-               #endif\r
-               \r
-#endif\r
-\r
-/** @} */\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2010.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  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 
+  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 Linnix UDIP.
+ *
+ *  Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).
+ *
+ *  \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
+ *  @defgroup Group_LEDs_UDIP UDIP
+ *
+ *  Board specific LED driver header for the Linnix UDIP (http://linnix.com/udip/).
+ *
+ *  \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.
+ *
+ *  @{
+ */
+
+#ifndef __LEDS_UDIP_H__
+#define __LEDS_UDIP_H__
+
+       /* Includes: */
+               #include <avr/io.h>
+
+               #include "../../../Common/Common.h"
+
+       /* 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
+
+       /* Private Interface - For use in library only: */
+       #if !defined(__DOXYGEN__)
+               /* Macros: */
+                       #define LEDS_PORTB_LEDS       (LEDS_LED1 | LEDS_LED2)
+                       #define LEDS_PORTD_LEDS       (LEDS_LED3 | LEDS_LED4)
+                       
+                       #define LEDS_PORTD_MASK_SHIFT 1
+       #endif
+
+       /* Public Interface - May be used in end-application: */
+               /* Macros: */
+                       /** LED mask for the first LED on the board. */
+                       #define LEDS_LED1        (1 << 6)
+
+                       /** LED mask for the second LED on the board. */
+                       #define LEDS_LED2        (1 << 5)
+
+                       /** LED mask for the third LED on the board. */
+                       #define LEDS_LED3        ((1 << 5) >> LEDS_PORTD_MASK_SHIFT)
+
+                       /** LED mask for the fourth LED on the board. */
+                       #define LEDS_LED4        ((1 << 4) >> LEDS_PORTD_MASK_SHIFT)
+
+                       /** LED mask for all the LEDs on the board. */
+                       #define LEDS_ALL_LEDS    (LEDS_LED1 | LEDS_LED2 | LEDS_LED3 | LEDS_LED4)
+
+                       /** LED mask for none of the board LEDs. */
+                       #define LEDS_NO_LEDS     0
+
+               /* Inline Functions: */
+               #if !defined(__DOXYGEN__)
+                       static inline void LEDs_Init(void)
+                       {
+                               DDRB |= LEDS_PORTB_LEDS;
+                               DDRD |= (LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT);
+                       }
+                       
+                       static inline void LEDs_TurnOnLEDs(const uint8_t LEDMask)
+                       {
+                               PORTB |= (LEDMask & LEDS_PORTB_LEDS);
+                               PORTD |= ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);
+                       }
+
+                       static inline void LEDs_TurnOffLEDs(const uint8_t LEDMask)
+                       {
+                               PORTB &= ~(LEDMask & LEDS_PORTB_LEDS);
+                               PORTD &= ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);
+                       }
+
+                       static inline void LEDs_SetAllLEDs(const uint8_t LEDMask)
+                       {
+                               PORTB = (PORTB & ~LEDS_PORTB_LEDS) | (LEDMask & LEDS_PORTB_LEDS);
+                               PORTD = (PORTD & ~(LEDS_PORTD_LEDS << LEDS_PORTD_MASK_SHIFT)) |
+                                       ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);
+                       }
+                       
+                       static inline void LEDs_ChangeLEDs(const uint8_t LEDMask,
+                                                          const uint8_t ActiveMask)
+                       {
+                               PORTB = (PORTB & ~(LEDMask & LEDS_PORTB_LEDS)) | (ActiveMask & LEDS_PORTB_LEDS);
+                               PORTD = (PORTD & ~((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT)) |
+                                       ((ActiveMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);
+                       }
+                       
+                       static inline void LEDs_ToggleLEDs(const uint8_t LEDMask)
+                       {
+                               PORTB ^= (LEDMask & LEDS_PORTB_LEDS);
+                               PORTD ^= ((LEDMask & LEDS_PORTD_LEDS) << LEDS_PORTD_MASK_SHIFT);
+                       }
+                       
+                       static inline uint8_t LEDs_GetLEDs(void) ATTR_WARN_UNUSED_RESULT;
+                       static inline uint8_t LEDs_GetLEDs(void)
+                       {
+                               return ((PORTB & LEDS_PORTB_LEDS) | ((PORTD & LEDS_PORTD_LEDS) >> LEDS_PORTD_MASK_SHIFT));
+                       }
+               #endif
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+               
+#endif
+
+/** @} */