X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/c5038f1bf44aea75f1ae1ed035cb7d523ccfdacb..eaa914a4e445c25ffdbee7be7caf85165540c98a:/LUFA/ManPages/CompileTimeTokens.txt diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt index 387af21df..8213c678b 100644 --- a/LUFA/ManPages/CompileTimeTokens.txt +++ b/LUFA/ManPages/CompileTimeTokens.txt @@ -23,17 +23,6 @@ * \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens * This section describes compile tokens which affect USB class-specific drivers in the LUFA library. * - * HID_ENABLE_FEATURE_PROCESSING - ( \ref Group_HIDParser ) \n - * Define this token to enable the processing of FEATURE HID report items, if any, into the processed HID structure. - * By default FEATURE items (which are device features settable by the host but not directly visible by the user) are - * skipped when processing a device HID report. - * - * HID_INCLUDE_CONSTANT_DATA_ITEMS - ( \ref Group_HIDParser ) \n - * By default, constant data items (usually used as spacers to align separate report items to a byte or word boundary) - * in the HID report are skipped during report processing. It is highly unusual for an application to make any use of - * constant data items (as they do not carry any useful data and only occupy limited RAM) however if required defining - * this switch will put constant data items into the processed HID report structure. - * * HID_STATETABLE_STACK_DEPTH - ( \ref Group_HIDParser ) \n * HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This * allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous @@ -62,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. * + * HID_MAX_REPORT_IDS - ( \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. @@ -76,12 +72,6 @@ * USE_EEPROM_DESCRIPTORS - ( \ref Group_Descriptors ) \n * Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM. * - * USE_NONSTANDARD_DESCRIPTOR_NAMES - ( \ref Group_Descriptors ) \n - * The USB 2.0 standard gives some rather obscure names for the elements in the standard descriptor types (device, configuration, - * string, endpoint, etc.). By default the LUFA library uses these names in its predefined descriptor structure types for - * compatibility. If this token is defined, the structure element names are switched to the LUFA-specific but more descriptive - * names documented in the StdDescriptors.h source file. - * * NO_INTERNAL_SERIAL - ( \ref Group_Descriptors ) \n * Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This * allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing