Fix LUFA event list generation rule in the main LUFA makefile (thanks to Thomas Bleeker).
[pub/lufa.git] / LUFA / ManPages / CompileTimeTokens.txt
index 387af21..8213c67 100644 (file)
  *  \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens\r
  *  This section describes compile tokens which affect USB class-specific drivers in the LUFA library.\r
  *\r
- *  <b>HID_ENABLE_FEATURE_PROCESSING</b> - ( \ref Group_HIDParser ) \n\r
- *  Define this token to enable the processing of FEATURE HID report items, if any, into the processed HID structure.\r
- *  By default FEATURE items (which are device features settable by the host but not directly visible by the user) are\r
- *  skipped when processing a device HID report.\r
- *\r
- *  <b>HID_INCLUDE_CONSTANT_DATA_ITEMS</b> - ( \ref Group_HIDParser ) \n\r
- *  By default, constant data items (usually used as spacers to align separate report items to a byte or word boundary)\r
- *  in the HID report are skipped during report processing. It is highly unusual for an application to make any use of\r
- *  constant data items (as they do not carry any useful data and only occupy limited RAM) however if required defining\r
- *  this switch will put constant data items into the processed HID report structure.\r
- *\r
  *  <b>HID_STATETABLE_STACK_DEPTH</b> - ( \ref Group_HIDParser ) \n\r
  *  HID reports may contain PUSH and POP elements, to store and retrieve the current HID state table onto a stack. This\r
  *  allows for reports to save the state table before modifying it slightly for a data item, and then restore the previous\r
  *  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\r
  *  processed HID report table. If not defined, this defaults to the value indicated in the HID.h file documentation.\r
  *\r
+ *  <b>HID_MAX_REPORT_IDS</b> - ( \ref Group_HIDParser ) \n\r
+ *  HID reports may contain several report IDs, to logically distinguish grouped device data from one another - for example, a combination\r
+ *  keyboard and mouse might use report IDs to seperate the keyboard reports from the mouse reports. In order to determine the size of each\r
+ *  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\r
+ *  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\r
+ *  and their sizes calculated/stored into the resultant processed report structure. If not defined, this defaults to the value indicated in\r
+ *  the HID.h file documentation.\r
  *\r
  *  \section Sec_SummaryUSBTokens USB Driver Related Tokens\r
  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.\r
  *  <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n\r
  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.\r
  *\r
- *  <b>USE_NONSTANDARD_DESCRIPTOR_NAMES</b> - ( \ref Group_Descriptors ) \n\r
- *  The USB 2.0 standard gives some rather obscure names for the elements in the standard descriptor types (device, configuration,\r
- *  string, endpoint, etc.). By default the LUFA library uses these names in its predefined descriptor structure types for\r
- *  compatibility. If this token is defined, the structure element names are switched to the LUFA-specific but more descriptive\r
- *  names documented in the StdDescriptors.h source file.\r
- *\r
  *  <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n\r
  *  Some AVR models contain a unique 20-digit serial number which can be used as the device serial number, while in device mode. This\r
  *  allows the host to uniquely identify the device regardless of if it is moved between USB ports on the same computer, allowing\r