Minor documentation updates.

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

diff --git a/LUFA/Drivers/USB/Core/Endpoint.h b/LUFA/Drivers/USB/Core/Endpoint.h
index ddbba27..d7a8bb7 100644 (file)
--- a/LUFA/Drivers/USB/Core/Endpoint.h
+++ b/LUFA/Drivers/USB/Core/Endpoint.h
@@ -74,18 +74,37 @@
 \r
        /* Includes: */\r
                #include "../../../Common/Common.h"\r
 \r
        /* Includes: */\r
                #include "../../../Common/Common.h"\r

+               #include "USBMode.h"            \r

 \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_UC3B)\r
                        #include "UC3B/Endpoint_UC3B.h"\r
                #endif\r
 \r
                #if (ARCH == ARCH_AVR8)\r
                        #include "AVR8/Endpoint_AVR8.h"\r
                #elif (ARCH == ARCH_UC3B)\r
                        #include "UC3B/Endpoint_UC3B.h"\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

 #endif\r
 \r
 /** @} */\r
 #endif\r
 \r
 /** @} */\r