Minor documentation corrections.

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

diff --git a/LUFA/Drivers/USB/Core/USBController.h b/LUFA/Drivers/USB/Core/USBController.h
index 28faee5..1e4f326 100644 (file)
--- a/LUFA/Drivers/USB/Core/USBController.h
+++ b/LUFA/Drivers/USB/Core/USBController.h
@@ -50,7 +50,7 @@
 
        /* Includes: */
                #include "../../../Common/Common.h"
-               #include "USBMode.h"            
+               #include "USBMode.h"
 
        /* Enable C linkage for C++ Compilers: */
                #if defined(__cplusplus)
@@ -62,13 +62,64 @@
                        #error Do not include this file directly. Include LUFA/Drivers/USB/USB.h instead.
                #endif
 
+       /* Defines: */
+               /** \name Endpoint Direction Masks */
+               //@{
+               /** Endpoint direction mask, for masking against endpoint addresses to retrieve the endpoint's
+                *  direction for comparing with the \c ENDPOINT_DIR_* masks.
+                */
+               #define ENDPOINT_DIR_MASK                  0x80
+
+               /** Endpoint address direction mask for an OUT direction (Host to Device) endpoint. This may be ORed with
+                *  the index of the address within a device to obtain the full endpoint address.
+                */
+               #define ENDPOINT_DIR_OUT                   0x00
+
+               /** Endpoint address direction mask for an IN direction (Device to Host) endpoint. This may be ORed with
+                *  the index of the address within a device to obtain the full endpoint address.
+                */
+               #define ENDPOINT_DIR_IN                    0x80
+               //@}
+
+               /** \name Endpoint/Pipe Type Masks */
+               //@{
+               /** Mask for determining the type of an endpoint from an endpoint descriptor. This should then be compared
+                *  with the \c EP_TYPE_* masks to determine the exact type of the endpoint.
+                */
+               #define EP_TYPE_MASK                       0x03
+
+               /** Mask for a CONTROL type endpoint or pipe.
+                *
+                *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+                */
+               #define EP_TYPE_CONTROL                    0x00
+
+               /** Mask for an ISOCHRONOUS type endpoint or pipe.
+                *
+                *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+                */
+               #define EP_TYPE_ISOCHRONOUS                0x01
+
+               /** Mask for a BULK type endpoint or pipe.
+                *
+                *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+                */
+               #define EP_TYPE_BULK                       0x02
+
+               /** Mask for an INTERRUPT type endpoint or pipe.
+                *
+                *  \note See \ref Group_EndpointManagement and \ref Group_PipeManagement for endpoint/pipe functions.
+                */
+               #define EP_TYPE_INTERRUPT                  0x03
+               //@}
+
        /* Architecture Includes: */
                #if (ARCH == ARCH_AVR8)
                        #include "AVR8/USBController_AVR8.h"
                #elif (ARCH == ARCH_UC3)
                        #include "UC3/USBController_UC3.h"
                #elif (ARCH == ARCH_XMEGA)
-                       #include "XMEGA/USBController_XMEGA.h"  
+                       #include "XMEGA/USBController_XMEGA.h"
                #endif
 
        /* Disable C linkage for C++ Compilers: */