Added new HID_HOST_BOOT_PROTOCOL_ONLY compile time token to reduce the size of the...

[pub/USBasp.git] / LUFA / ManPages / CompileTimeTokens.txt

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 3619ec4..f41c196 100644 (file)
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -20,9 +20,17 @@
  *  this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from\r
  *  the source code at compile time.\r
  *\r
  *  this token is defined, all ANSI control codes in the application code from the TerminalCodes.h header are removed from\r
  *  the source code at compile time.\r
  *\r

+ *\r

  *  \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
  *  \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_HOST_BOOT_PROTOCOL_ONLY</b> - ( \ref Group_USBClassHIDHost ) \n\r
+ *  By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID\r
+ *  communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic\r
+ *  Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol\r
+ *  mode can be removed to save space in the compiled application by defining this token. When defined, it is still neccesary\r
+ *  to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol().\r
+ * \r

  *  <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \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
  *  <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \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


@@ -59,6 +67,7 @@
  *  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
  *  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

+ *\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
  *\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
  *\r