aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/ManPages/CompileTimeTokens.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-09-09 08:34:24 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-09-09 08:34:24 +0000
commit524decdeb3a0a4c7adbeb4af906556e7bc6dd77c (patch)
tree3d3e83df9e11a61b2710d334c82609b0f3c89b4d /LUFA/ManPages/CompileTimeTokens.txt
parent331929833da3e48ac9c43dce90487490d7a77af1 (diff)
downloadlufa-524decdeb3a0a4c7adbeb4af906556e7bc6dd77c.tar.gz
lufa-524decdeb3a0a4c7adbeb4af906556e7bc6dd77c.tar.bz2
lufa-524decdeb3a0a4c7adbeb4af906556e7bc6dd77c.zip
Change HID report parser so that it can calculate and record the sizes (IN, OUT and FEATURE) of each report within the device, by report ID. This will be required in host mode, so that the host can determine how many bytes of data must be read in for each report.
Add to MouseHostWithParser and KeyboardHostWithParser demos to print out the report sizes when a valid device is connected.
Diffstat (limited to 'LUFA/ManPages/CompileTimeTokens.txt')
-rw-r--r--LUFA/ManPages/CompileTimeTokens.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index ee18d27c8..fb051b8c8 100644
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -51,6 +51,13 @@
* If a item has a multiple count (i.e. a REPORT COUNT of more than 1), each item in the report count is placed separately in the
* processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.
*
+ * <b>HID_MAX_REPORT_IDS</b> - ( \ref Group_HIDParser ) \n
+ * HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination
+ * keyboard and mouse might use report IDs to seperate the keyboard reports from the mouse reports. In order to determine the size of each
+ * report, and thus know how many bytes must be read or written, the size of each report (IN, OUT and FEATURE) must be calculated and
+ * stored. This token may be defined to a non-zero 8-bit value to set the maximum number of report IDs in a device which can be processed
+ * and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in
+ * the HID.h file documentation.
*
* \section Sec_SummaryUSBTokens USB Driver Related Tokens
* This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.