X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/d1e52660368d34d693131f6aff3c8fd8584162e5..f9f1bcc25c17b031029200cd9648d76d4ee39dc4:/LUFA/Drivers/USB/Class/Host/HIDParser.h

diff --git a/LUFA/Drivers/USB/Class/Host/HIDParser.h b/LUFA/Drivers/USB/Class/Host/HIDParser.h
index 4acce2462..942fe1177 100644
--- a/LUFA/Drivers/USB/Class/Host/HIDParser.h
+++ b/LUFA/Drivers/USB/Class/Host/HIDParser.h
@@ -38,6 +38,11 @@
 /** \ingroup Group_USB
  *  @defgroup Group_HIDParser HID Report Parser
  *
+ *  \section Sec_Dependencies Module Source Dependencies
+ *  The following files must be built with any user project that uses this module:
+ *    - LUFA/Drivers/USB/Class/Host/HIDParser.c
+ *
+ *  \section Module Description
  *  Functions, macros, variables, enums and types related to the parsing of HID class device report descriptors.
  *
  *  The processed HID report is presented back to the user application as a flat structure containing each report
@@ -196,22 +201,26 @@
 			typedef struct
 			{
 				uint8_t                      TotalReportItems; /**< Total number of report items stored in the
-				                                                *   ReportItems array. */
-
+				                                                *   ReportItems array.
+				                                                */
 				HID_ReportItem_t             ReportItems[HID_MAX_REPORTITEMS]; /**< Report items array, including
-			                                                                    *   all IN, OUT and FEATURE items. */
-
+			                                                                    *   all IN, OUT and FEATURE items.
+				                                                                */
 				HID_CollectionPath_t         CollectionPaths[HID_MAX_COLLECTIONS]; /**< All collection items, referenced
-				                                                                    *   by the report items. */
+				                                                                    *   by the report items.
+				                                                                    */
+				bool                         UsingMultipleReports; /**< Indicates if the device has at least one REPORT ID
+				                                                    *   element in its HID report descriptor.
+				                                                    */
 			} HID_ReportInfo_t;
 			
 		/* Function Prototypes: */
 			/** Function to process a given HID report returned from an attached device, and store it into a given
 			 *  \ref HID_ReportInfo_t structure.
 			 *
-			 *  \param ReportData  Buffer containing the device's HID report table
-			 *  \param ReportSize  Size in bytes of the HID report table
-			 *  \param ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output
+			 *  \param[in] ReportData  Buffer containing the device's HID report table
+			 *  \param[in] ReportSize  Size in bytes of the HID report table
+			 *  \param[out] ParserData  Pointer to a \ref HID_ReportInfo_t instance for the parser output
 			 *
 			 *  \return A value in the \ref HID_Parse_ErrorCodes_t enum
 			 */
@@ -221,8 +230,8 @@
 			/** Extracts the given report item's value out of the given HID report and places it into the Value
 			 *  member of the report item's \ref HID_ReportItem_t structure.
 			 *
-			 *  \param ReportData  Buffer containing an IN or FEATURE report from an attached device
-			 *  \param ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
+			 *  \param[in] ReportData  Buffer containing an IN or FEATURE report from an attached device
+			 *  \param[in,out] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
 			 *
 			 *  \returns Boolean true if the item to retrieve was located in the given report, false otherwise
 			 */
@@ -234,10 +243,10 @@
 			 *  buffer. The report buffer is assumed to have the appropriate bits cleared before calling
 			 *  this function (i.e., the buffer should be explicitly cleared before report values are added).
 			 *
-			 *  If the device has multiple HID reports, the report ID is set to the report ID of the given item.
+			 *  If the device has multiple HID reports, the first byte in the report is set to the report ID of the given item.
 			 *
-			 *  \param ReportData  Buffer holding the current OUT report data
-			 *  \param ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
+			 *  \param[out] ReportData  Buffer holding the current OUT or FEATURE report data
+			 *  \param[in] ReportItem  Pointer to the report item of interest in a \ref HID_ReportInfo_t ReportItem array
 			 */
 			void USB_SetHIDReportItemInfo(uint8_t* ReportData, const HID_ReportItem_t* ReportItem)
 			                              ATTR_NON_NULL_PTR_ARG(1, 2);