Add LUFA-111009-BETA tag.
[pub/USBasp.git] / LUFA / Drivers / USB / Core / Endpoint.h
index 877f0c1..f6412dd 100644 (file)
-/*\r
-             LUFA Library\r
-     Copyright (C) Dean Camera, 2011.\r
-\r
-  dean [at] fourwalledcubicle [dot] com\r
-           www.lufa-lib.org\r
-*/\r
-\r
-/*\r
-  Copyright 2011  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 USB Endpoint definitions for all architectures.\r
- *  \copydetails Group_EndpointManagement\r
- *\r
- *  \note This file should not be included directly. It is automatically included as needed by the USB driver\r
- *        dispatch header located in LUFA/Drivers/USB/USB.h.\r
- */\r
-\r
-/** \ingroup Group_EndpointManagement\r
- *  \defgroup Group_EndpointRW Endpoint Data Reading and Writing\r
- *  \brief Endpoint data read/write definitions.\r
- *\r
- *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.\r
- */\r
-\r
-/** \ingroup Group_EndpointRW\r
- *  \defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types\r
- *  \brief Endpoint data primitive read/write definitions.\r
- *\r
- *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types\r
- *  from and to endpoints.\r
- */\r
-\r
-/** \ingroup Group_EndpointManagement\r
- *  \defgroup Group_EndpointPacketManagement Endpoint Packet Management\r
- *  \brief USB Endpoint package management definitions.\r
- *\r
- *  Functions, macros, variables, enums and types related to packet management of endpoints.\r
- */\r
-\r
-/** \ingroup Group_USB\r
- *  \defgroup Group_EndpointManagement Endpoint Management\r
- *  \brief Endpoint management definitions.\r
- *\r
- *  Functions, macros and enums related to endpoint management when in USB Device mode. This\r
- *  module contains the endpoint management macros, as well as endpoint interrupt and data\r
- *  send/receive functions for various data types.\r
- *\r
- *  @{\r
- */\r
-\r
-#ifndef __ENDPOINT_H__\r
-#define __ENDPOINT_H__\r
-\r
-       /* Includes: */\r
-               #include "../../../Common/Common.h"\r
-               #include "USBMode.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_USB_DRIVER)\r
-                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.\r
-               #endif\r
-\r
-       /* Public Interface - May be used in end-application: */\r
-               /* Macros: */\r
-                       /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's\r
-                        *  numerical address in the device.\r
-                        */\r
-                       #define ENDPOINT_EPNUM_MASK                     0x07\r
-\r
-                       /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's\r
-                        *  direction for comparing with the \c ENDPOINT_DESCRIPTOR_DIR_* masks.\r
-                        */\r
-                       #define ENDPOINT_EPDIR_MASK                     0x80\r
-\r
-                       /** Endpoint address for the default control endpoint, which always resides in address 0. This is\r
-                        *  defined for convenience to give more readable code when used with the endpoint macros.\r
-                        */\r
-                       #define ENDPOINT_CONTROLEP                      0\r
-\r
-       /* Architecture Includes: */\r
-               #if (ARCH == ARCH_AVR8)\r
-                       #include "AVR8/Endpoint_AVR8.h"\r
-               #elif (ARCH == ARCH_UC3)\r
-                       #include "UC3/Endpoint_UC3.h"\r
-               #elif (ARCH == ARCH_XMEGA)\r
-                       #include "XMEGA/Endpoint_XMEGA.h"\r
-               #endif\r
-\r
-       /* Disable C linkage for C++ Compilers: */\r
-               #if defined(__cplusplus)\r
-                       }\r
-               #endif\r
-\r
-#endif\r
-\r
-/** @} */\r
-\r
+/*
+             LUFA Library
+     Copyright (C) Dean Camera, 2011.
+
+  dean [at] fourwalledcubicle [dot] com
+           www.lufa-lib.org
+*/
+
+/*
+  Copyright 2011  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 USB Endpoint definitions for all architectures.
+ *  \copydetails Group_EndpointManagement
+ *
+ *  \note This file should not be included directly. It is automatically included as needed by the USB driver
+ *        dispatch header located in LUFA/Drivers/USB/USB.h.
+ */
+
+/** \ingroup Group_EndpointManagement
+ *  \defgroup Group_EndpointRW Endpoint Data Reading and Writing
+ *  \brief Endpoint data read/write definitions.
+ *
+ *  Functions, macros, variables, enums and types related to data reading and writing from and to endpoints.
+ */
+
+/** \ingroup Group_EndpointRW
+ *  \defgroup Group_EndpointPrimitiveRW Read/Write of Primitive Data Types
+ *  \brief Endpoint data primitive read/write definitions.
+ *
+ *  Functions, macros, variables, enums and types related to data reading and writing of primitive data types
+ *  from and to endpoints.
+ */
+
+/** \ingroup Group_EndpointManagement
+ *  \defgroup Group_EndpointPacketManagement Endpoint Packet Management
+ *  \brief USB Endpoint package management definitions.
+ *
+ *  Functions, macros, variables, enums and types related to packet management of endpoints.
+ */
+
+/** \ingroup Group_USB
+ *  \defgroup Group_EndpointManagement Endpoint Management
+ *  \brief Endpoint management definitions.
+ *
+ *  Functions, macros and enums related to endpoint management when in USB Device mode. This
+ *  module contains the endpoint management macros, as well as endpoint interrupt and data
+ *  send/receive functions for various data types.
+ *
+ *  @{
+ */
+
+#ifndef __ENDPOINT_H__
+#define __ENDPOINT_H__
+
+       /* Includes: */
+               #include "../../../Common/Common.h"
+               #include "USBMode.h"            
+
+       /* Enable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       extern "C" {
+               #endif
+
+       /* Preprocessor Checks: */
+               #if !defined(__INCLUDE_FROM_USB_DRIVER)
+                       #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
+               #endif
+
+       /* Public Interface - May be used in end-application: */
+               /* Macros: */
+                       /** Endpoint number mask, for masking against endpoint addresses to retrieve the endpoint's
+                        *  numerical address in the device.
+                        */
+                       #define ENDPOINT_EPNUM_MASK                     0x07
+
+                       /** Endpoint address for the default control endpoint, which always resides in address 0. This is
+                        *  defined for convenience to give more readable code when used with the endpoint macros.
+                        */
+                       #define ENDPOINT_CONTROLEP                      0
+
+       /* Architecture Includes: */
+               #if (ARCH == ARCH_AVR8)
+                       #include "AVR8/Endpoint_AVR8.h"
+               #elif (ARCH == ARCH_UC3)
+                       #include "UC3/Endpoint_UC3.h"
+               #elif (ARCH == ARCH_XMEGA)
+                       #include "XMEGA/Endpoint_XMEGA.h"
+               #endif
+
+       /* Disable C linkage for C++ Compilers: */
+               #if defined(__cplusplus)
+                       }
+               #endif
+
+#endif
+
+/** @} */
+