Add MAX_ENDPOINT_INDEX compile time option for the XMEGA devices.

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

diff --git a/LUFA/Drivers/USB/Core/ConfigDescriptor.h b/LUFA/Drivers/USB/Core/ConfigDescriptor.h
index 634dc8f..97fb39b 100644 (file)
--- a/LUFA/Drivers/USB/Core/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/Core/ConfigDescriptor.h
@@ -1,13 +1,13 @@
 /*
              LUFA Library
-     Copyright (C) Dean Camera, 2011.
+     Copyright (C) Dean Camera, 2012.
 
   dean [at] fourwalledcubicle [dot] com
            www.lufa-lib.org
 */
 
 /*
-  Copyright 2011  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  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
@@ -36,7 +36,7 @@
  *        dispatch header located in LUFA/Drivers/USB/USB.h.
  */
 
-/** \ingroup Group_Descriptors
+/** \ingroup Group_StdDescriptors
  *  \defgroup Group_ConfigDescriptorParser Configuration Descriptor Parser
  *  \brief USB Configuration Descriptor definitions.
  *
@@ -52,7 +52,7 @@
 
        /* Includes: */
                #include "../../../Common/Common.h"
-               #include "USBMode.h"            
+               #include "USBMode.h"
                #include "HostStandardReq.h"
                #include "StdDescriptors.h"
 
@@ -68,11 +68,6 @@
 
        /* Public Interface - May be used in end-application: */
                /* Macros: */
-                       /** 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
-
                        /** Casts a pointer to a descriptor inside the configuration descriptor into a pointer to the given
                         *  descriptor type.
                         *
@@ -81,7 +76,7 @@
                         *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
                         *  USB_Descriptor_Configuration_Header_t* ConfigHeaderPtr = DESCRIPTOR_PCAST(CurrDescriptor,
                         *                                                           USB_Descriptor_Configuration_Header_t);
-                        *
+                        *  
                         *  // Can now access elements of the configuration header struct using the -> indirection operator
                         *  \endcode
                         */
@@ -95,7 +90,7 @@
                         *  uint8_t* CurrDescriptor = &ConfigDescriptor[0]; // Pointing to the configuration header
                         *  USB_Descriptor_Configuration_Header_t ConfigHeader = DESCRIPTOR_CAST(CurrDescriptor,
                         *                                                       USB_Descriptor_Configuration_Header_t);
-                        *
+                        *  
                         *  // Can now access elements of the configuration header struct using the . operator
                         *  \endcode
                         */
@@ -218,7 +213,7 @@
                         *  function. The routine updates the position and remaining configuration descriptor bytes values
                         *  automatically. If a comparator routine fails a search, the descriptor pointer is retreated back
                         *  so that the next descriptor search invocation will start from the descriptor which first caused the
-                        *  original search to fail. This behaviour allows for one comparator to be used immediately after another
+                        *  original search to fail. This behavior allows for one comparator to be used immediately after another
                         *  has failed, starting the second search from the descriptor which failed the first.
                         *
                         *  Comparator functions should be standard functions which accept a pointer to the header of the current
@@ -236,7 +231,7 @@
                         *  Usage Example:
                         *  \code
                         *  uint8_t EndpointSearcher(void* CurrentDescriptor); // Comparator Prototype
-                        *
+                        *  
                         *  uint8_t EndpointSearcher(void* CurrentDescriptor)
                         *  {
                         *     if (DESCRIPTOR_TYPE(CurrentDescriptor) == DTYPE_Endpoint)
@@ -244,8 +239,9 @@
                         *     else
                         *         return DESCRIPTOR_SEARCH_NotFound;
                         *  }
-                        *
+                        *  
                         *  //...
+                        *  
                         *  // After retrieving configuration descriptor:
                         *  if (USB_Host_GetNextDescriptorComp(&BytesRemaining, &CurrentConfigLoc, EndpointSearcher) ==
                         *      Descriptor_Search_Comp_Found)
@@ -256,7 +252,7 @@
                         */
                        uint8_t USB_GetNextDescriptorComp(uint16_t* const BytesRem,
                                                          void** const CurrConfigLoc,
-                                                         const ConfigComparatorPtr_t const ComparatorRoutine);
+                                                         ConfigComparatorPtr_t const ComparatorRoutine);
 
                /* Inline Functions: */
                        /** Skips over the current sub-descriptor inside the configuration descriptor, so that the pointer then
@@ -271,7 +267,7 @@
                                                                 void** CurrConfigLoc)
                        {
                                uint16_t CurrDescriptorSize = DESCRIPTOR_CAST(*CurrConfigLoc, USB_Descriptor_Header_t).Size;
-                               
+
                                if (*BytesRem < CurrDescriptorSize)
                                  CurrDescriptorSize = *BytesRem;