Add LUFA-111009-BETA tag.
[pub/USBasp.git] / LUFA / Drivers / Board / UC3 / EVK1100 / Joystick.h
index 58108d4..e35d1b3 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2011.\r
-              \r
-  dean [at] fourwalledcubicle [dot] com\r
-      www.fourwalledcubicle.com\r
-*/\r
-\r
-/*\r
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
-\r
-  Permission to use, copy, modify, and distribute this software\r
-  and its documentation for any purpose and without fee is hereby\r
-  granted, provided that the above copyright notice appear in all\r
-  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 joystick driver header for the Atmel EVK1100.\r
- *  \copydetails Group_Joystick_EVK1100\r
- *\r
- *  \note This file should not be included directly. It is automatically included as needed by the joystick driver\r
- *        dispatch header located in LUFA/Drivers/Board/Joystick.h.\r
- */\r
-\r
-/** \ingroup Group_Joystick\r
- *  \defgroup Group_Joystick_EVK1100 EVK1100\r
- *  \brief Board specific joystick driver header for the Atmel EVK1100.\r
- *\r
- *  Board specific joystick driver header for the Atmel EVK1100.\r
- *\r
- *  @{\r
- */\r
\r
-#ifndef __JOYSTICK_EVK1100_H__\r
-#define __JOYSTICK_EVK1100_H__\r
-\r
-       /* Includes: */\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_JOYSTICK_H)\r
-                       #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.\r
-               #endif\r
-\r
-       /* Private Interface - For use in library only: */\r
-       #if !defined(__DOXYGEN__)\r
-               /* Macros: */\r
-                       #define JOY_PORT                 0\r
-                       #define JOY_MASK                ((1UL << 28) | (1UL << 27) | (1UL << 26) | (1UL << 25) | (1UL << 20))\r
-       #endif\r
-       \r
-       /* Public Interface - May be used in end-application: */\r
-               /* Macros: */\r
-                       /** Mask for the joystick being pushed in the left direction. */\r
-                       #define JOY_LEFT                  (1UL << 25)\r
-\r
-                       /** Mask for the joystick being pushed in the upward direction. */\r
-                       #define JOY_UP                    (1UL << 26)\r
-\r
-                       /** Mask for the joystick being pushed in the right direction. */\r
-                       #define JOY_RIGHT                 (1UL << 28)\r
-\r
-                       /** Mask for the joystick being pushed in the downward direction. */\r
-                       #define JOY_DOWN                  (1UL << 27)\r
-\r
-                       /** Mask for the joystick being pushed inward. */\r
-                       #define JOY_PRESS                 (1UL << 20)\r
-                       \r
-               /* Inline Functions: */\r
-               #if !defined(__DOXYGEN__)\r
-                       static inline void Joystick_Init(void)\r
-                       {\r
-                               AVR32_GPIO.port[JOY_PORT].gpers = JOY_MASK;\r
-                               AVR32_GPIO.port[JOY_PORT].gpers = JOY_MASK;\r
-                       };\r
-                       \r
-                       static inline uint32_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;\r
-                       static inline uint32_t Joystick_GetStatus(void)\r
-                       {\r
-                               return (uint32_t)(~(AVR32_GPIO.port[JOY_PORT].pvr & JOY_MASK));\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, 2011.
+              
+  dean [at] fourwalledcubicle [dot] com
+      www.fourwalledcubicle.com
+*/
+
+/*
+  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+
+  Permission to use, copy, modify, and distribute this software
+  and its documentation for any purpose and without fee is hereby
+  granted, 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 joystick driver header for the Atmel EVK1100.
+ *  \copydetails Group_Joystick_EVK1100
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the joystick driver
+ *        dispatch header located in LUFA/Drivers/Board/Joystick.h.
+ */
+
+/** \ingroup Group_Joystick
+ *  \defgroup Group_Joystick_EVK1100 EVK1100
+ *  \brief Board specific joystick driver header for the Atmel EVK1100.
+ *
+ *  Board specific joystick driver header for the Atmel EVK1100.
+ *
+ *  @{
+ */
+#ifndef __JOYSTICK_EVK1100_H__
+#define __JOYSTICK_EVK1100_H__
+
+       /* Includes: */
+               #include "../../../../Common/Common.h"
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_JOYSTICK_H)
+                       #error Do not include this file directly. Include LUFA/Drivers/Board/Joystick.h instead.
+               #endif
+
+       /* Private Interface - For use in library only: */
+       #if !defined(__DOXYGEN__)
+               /* Macros: */
+                       #define JOY_PORT                 0
+                       #define JOY_MASK                ((1UL << 28) | (1UL << 27) | (1UL << 26) | (1UL << 25) | (1UL << 20))
+       #endif
+       
+       /* Public Interface - May be used in end-application: */
+               /* Macros: */
+                       /** Mask for the joystick being pushed in the left direction. */
+                       #define JOY_LEFT                  (1UL << 25)
+
+                       /** Mask for the joystick being pushed in the upward direction. */
+                       #define JOY_UP                    (1UL << 26)
+
+                       /** Mask for the joystick being pushed in the right direction. */
+                       #define JOY_RIGHT                 (1UL << 28)
+
+                       /** Mask for the joystick being pushed in the downward direction. */
+                       #define JOY_DOWN                  (1UL << 27)
+
+                       /** Mask for the joystick being pushed inward. */
+                       #define JOY_PRESS                 (1UL << 20)
+                       
+               /* Inline Functions: */
+               #if !defined(__DOXYGEN__)
+                       static inline void Joystick_Init(void)
+                       {
+                               AVR32_GPIO.port[JOY_PORT].gpers = JOY_MASK;
+                               AVR32_GPIO.port[JOY_PORT].gpers = JOY_MASK;
+                       };
+                       
+                       static inline uint32_t Joystick_GetStatus(void) ATTR_WARN_UNUSED_RESULT;
+                       static inline uint32_t Joystick_GetStatus(void)
+                       {
+                               return (uint32_t)(~(AVR32_GPIO.port[JOY_PORT].pvr & JOY_MASK));
+                       }
+               #endif
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+
+#endif
+
+/** @} */