Fixed GenericHIDHost demo report write routine incorrect for control type requests (thanks to Andrei Krainev).

Removed Endpoint_ClearCurrentBank() and Pipe_ClearCurrentBank() in favour of new Endpoint_ClearIN(), Endpoint_ClearOUT(), Endpoint_ClearControlIN(), Endpoint_ClearControlOUT(), Pipe_ClearIN(), Pipe_ClearOUT(), Pipe_ClearControlIN() and Pipe_ClearControlOUT() macros (done to allow for the detection of packets of zero length).

Renamed *_ReadWriteAllowed() macros to *_IsReadWriteAllowed() to remain consistent with the rest of the LUFA API.

Endpoint_IsSetupReceived() macro has been renamed to Endpoint_IsSETUPReceived(), Endpoint_ClearSetupReceived() macro has been renamed to Endpoint_ClearControlSETUP(), the Pipe_IsSetupSent() macro has been renamed to Pipe_IsSETUPSent() and the Pipe_ClearSetupSent() macro is no longer applicable and should be removed - changes made to compliment the new endpoint and pipe bank management API.

Updated all demos, bootloaders and projects to use the new endpoint and pipe management APIs (thanks to Roman Thiel).

Updated library doxygen documentation, added groups, changed documentation macro functions to real functions for clarity.

Removed old endpoint and pipe aliased read/write/discard routines which did not have an explicit endian specifier for clarity.

Removed the ButtLoadTag.h header file, as no one used for its intended purpose anyway.

3 files changed, 35 insertions, 5 deletions

diff --git a/LUFA/Drivers/USB/Class/ConfigDescriptor.h b/LUFA/Drivers/USB/Class/ConfigDescriptor.h
index bd92b51f3..d5fcbb0bb 100644
--- a/LUFA/Drivers/USB/Class/ConfigDescriptor.h
+++ b/LUFA/Drivers/USB/Class/ConfigDescriptor.h
@@ -35,6 +35,14 @@
  *  and other descriptor data can be extracted and used as needed.

  */

 

+/** \ingroup Group_Descriptors

+ *  @defgroup Group_ConfigDescriptorParser Configuration Descriptor Parser

+ *

+ *  Functions, macros, variables, enums and types related to the parsing of Configuration Descriptors.

+ *

+ *  @{

+ */

+

 #ifndef __CONFIGDESCRIPTOR_H__

 #define __CONFIGDESCRIPTOR_H__

 

@@ -109,7 +117,7 @@
 			 *  for certain descriptors matching unique criteria.

 			 *

 			 *  Comparator routines are passed in a single pointer named CurrentDescriptor, and should return a value

-			 *  of a member of the DSEARCH_Return_ErrorCodes_t enum.

+			 *  of a member of the DSearch_Return_ErrorCodes_t enum.

 			 */

 			#define DESCRIPTOR_COMPARATOR(name)           uint8_t DCOMP_##name (void* const CurrentDescriptor)

 

@@ -124,7 +132,7 @@
 			 *  \param DPos     Pointer to the current position in the configuration descriptor

 			 *  \param DSearch  Name of the comparator search function to use on the configuration descriptor

 			 *

-			 *  \return Value of one of the members of the DSEARCH_Comp_Return_ErrorCodes_t enum

+			 *  \return Value of one of the members of the DSearch_Comp_Return_ErrorCodes_t enum

 			 *

 			 *  Usage Example:

 			 *  \code

@@ -151,7 +159,7 @@
 			                                              USB_Host_GetNextDescriptorComp_P(DSize, DPos, DCOMP_##DSearch)

 		/* Enums: */

 			/** Enum for return values of a descriptor comparator made with DESCRIPTOR_COMPARATOR. */

-			enum DSEARCH_Return_ErrorCodes_t

+			enum DSearch_Return_ErrorCodes_t

 			{

 				Descriptor_Search_Found                = 0, /**< Current descriptor matches comparator criteria. */

 				Descriptor_Search_Fail                 = 1, /**< No further descriptor could possibly match criteria, fail the search. */

@@ -159,7 +167,7 @@
 			};

 

 			/** Enum for return values of USB_Host_GetNextDescriptorComp() */

-			enum DSEARCH_Comp_Return_ErrorCodes_t

+			enum DSearch_Comp_Return_ErrorCodes_t

 			{

 				Descriptor_Search_Comp_Found           = 0, /**< Configuration descriptor now points to descriptor which matches

 				                                             *   search criteria of the given comparator function. */

@@ -259,5 +267,7 @@
 		#if defined(__cplusplus)

 			}

 		#endif

-		

+

 #endif

+

+/** @} */

diff --git a/LUFA/Drivers/USB/Class/HIDParser.h b/LUFA/Drivers/USB/Class/HIDParser.h
index 47a678b9b..ad242fe56 100644
--- a/LUFA/Drivers/USB/Class/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/HIDParser.h
@@ -44,6 +44,14 @@
  *  HID_INCLUDE_CONSTANT_DATA_ITEMS tokens in the user project makefile, passing them to the compiler via the -D

  *  switch.

  */

+ 

+/** \ingroup Group_USB

+ *  @defgroup Group_HIDParser HID Report Parser

+ *

+ *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.

+ *

+ *  @{

+ */

 

 #ifndef __HIDPARSER_H__

 #define __HIDPARSER_H__

@@ -250,3 +258,5 @@
 		#endif

 

 #endif

+

+/** @} */

diff --git a/LUFA/Drivers/USB/Class/HIDReportData.h b/LUFA/Drivers/USB/Class/HIDReportData.h
index b1468a31a..eee38be04 100644
--- a/LUFA/Drivers/USB/Class/HIDReportData.h
+++ b/LUFA/Drivers/USB/Class/HIDReportData.h
@@ -34,6 +34,14 @@
  *  flag's meaning when applied to an IN, OUT or FEATURE item.

  */

 

+/** \ingroup Group_HIDParser

+ *  @defgroup Group_HIDIOFConst Input/Output/Feature Masks

+ *

+ *  Masks indicating the type of Input, Output of Feature HID report item.

+ *

+ *  @{

+ */

+ 

 #ifndef __HIDREPORTDATA_H__

 #define __HIDREPORTDATA_H__

 

@@ -126,5 +134,7 @@
 			#define TAG_LOCAL_USAGEMIN       0x10

 			#define TAG_LOCAL_USAGEMAX       0x20

 	#endif

+

+/** @} */

 		

 #endif