Add LUFA-side channel open/close routines, add signalling handlers for the creation...

[pub/USBasp.git] / LUFA / Drivers / USB / LowLevel / Endpoint.h

diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.h b/LUFA/Drivers/USB/LowLevel/Endpoint.h
index 5bbbb87..389d3c4 100644 (file)
--- a/LUFA/Drivers/USB/LowLevel/Endpoint.h
+++ b/LUFA/Drivers/USB/LowLevel/Endpoint.h
@@ -1,21 +1,21 @@
 /*\r
              LUFA Library\r
 /*\r
              LUFA Library\r

-     Copyright (C) Dean Camera, 2009.\r
+     Copyright (C) Dean Camera, 2010.\r

               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r
               \r
   dean [at] fourwalledcubicle [dot] com\r
       www.fourwalledcubicle.com\r
 */\r
 \r
 /*\r

-  Copyright 2009  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
+  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 without specific, written prior permission.\r
 \r
   The author disclaim all warranties with regard to this\r


@@ -28,6 +28,16 @@
   this software.\r
 */\r
 \r
   this software.\r
 */\r
 \r

+/** \file\r
+ *  \brief USB device endpoint management definitions.\r
+ *\r
+ *  This file contains structures, function prototypes and macros related to the management of the device's\r
+ *  data endpoints when the library is initialized in USB device mode.\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_USB\r
  *  @defgroup Group_EndpointManagement Endpoint Management\r
  *\r
 /** \ingroup Group_USB\r
  *  @defgroup Group_EndpointManagement Endpoint Management\r
  *\r


@@ -83,6 +93,11 @@
                        extern "C" {\r
                #endif\r
 \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 data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint\r
        /* Public Interface - May be used in end-application: */\r
                /* Macros: */\r
                        /** Endpoint data direction mask for \ref Endpoint_ConfigureEndpoint(). This indicates that the endpoint\r


@@ -126,6 +141,11 @@
                         */\r
                        #define ENDPOINT_EPNUM_MASK                   0x07\r
 \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 ENDPOINT_DESCRIPTOR_DIR_* masks.\r
+                        */\r
+                       #define ENDPOINT_EPDIR_MASK                   0x80\r
+\r

                        /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's\r
                         *  bank size in the device.\r
                         */\r
                        /** Endpoint bank size mask, for masking against endpoint addresses to retrieve the endpoint's\r
                         *  bank size in the device.\r
                         */\r


@@ -338,9 +358,11 @@
                                 */\r
                                static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);\r
                        #else\r
                                 */\r
                                static inline void Endpoint_SetEndpointDirection(uint8_t DirectionMask);\r
                        #else\r

-                               #if defined(USB_SERIES_4_AVR) || defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR) || defined(__DOXYGEN__)\r
+                               #if defined(USB_SERIES_6_AVR) || defined(USB_SERIES_7_AVR)\r

                                        #define Endpoint_BytesInEndpoint()        UEBCX\r
                                        #define Endpoint_BytesInEndpoint()        UEBCX\r

-                               #else\r
+                               #elif defined(USB_SERIES_4_AVR)\r
+                                       #define Endpoint_BytesInEndpoint()        (((uint16_t)UEBCHX << 8) | UEBCLX)                            \r
+                               #elif defined(USB_SERIES_2_AVR)\r

                                        #define Endpoint_BytesInEndpoint()        UEBCLX\r
                                #endif\r
                                \r
                                        #define Endpoint_BytesInEndpoint()        UEBCLX\r
                                #endif\r
                                \r


@@ -353,7 +375,7 @@
                                #if !defined(CONTROL_ONLY_DEVICE)\r
                                        #define Endpoint_SelectEndpoint(epnum)    MACROS{ UENUM = (epnum); }MACROE\r
                                #else\r
                                #if !defined(CONTROL_ONLY_DEVICE)\r
                                        #define Endpoint_SelectEndpoint(epnum)    MACROS{ UENUM = (epnum); }MACROE\r
                                #else\r

-                                       #define Endpoint_SelectEndpoint(epnum)    (void)epnum\r
+                                       #define Endpoint_SelectEndpoint(epnum)    (void)(epnum)\r

                                #endif\r
 \r
                                #define Endpoint_ResetFIFO(epnum)             MACROS{ UERST = (1 << (epnum)); UERST = 0; }MACROE\r
                                #endif\r
 \r
                                #define Endpoint_ResetFIFO(epnum)             MACROS{ UERST = (1 << (epnum)); UERST = 0; }MACROE\r


@@ -735,7 +757,7 @@
                        bool Endpoint_ConfigureEndpoint(const uint8_t  Number, const uint8_t Type, const uint8_t Direction,\r
                                                        const uint16_t Size, const uint8_t Banks);\r
 \r
                        bool Endpoint_ConfigureEndpoint(const uint8_t  Number, const uint8_t Type, const uint8_t Direction,\r
                                                        const uint16_t Size, const uint8_t Banks);\r
 \r

-                       /** Spinloops until the currently selected non-control endpoint is ready for the next packet of data\r
+                       /** Spin-loops until the currently selected non-control endpoint is ready for the next packet of data\r

                         *  to be read or written to it.\r
                         *\r
                         *  \note This routine should not be called on CONTROL type endpoints.\r
                         *  to be read or written to it.\r
                         *\r
                         *  \note This routine should not be called on CONTROL type endpoints.\r


@@ -1205,7 +1227,7 @@
                                }\r
                                \r
                                return (MaskVal << EPSIZE0);\r
                                }\r
                                \r
                                return (MaskVal << EPSIZE0);\r

-                       };\r
+                       }\r

 \r
        #endif\r
 \r
 \r
        #endif\r
 \r