X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/242303c1607fca405d9407b9fab6fb78cae676e2..fec31947a6b4e77f65d92bf14b32533bbbc39b2d:/LUFA/ManPages/CompileTimeTokens.txt diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt index 3619ec44a..d8d4edbb3 100644 --- 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 * the source code at compile time. * + * * \section Sec_SummaryUSBClassTokens USB Class Driver Related Tokens * This section describes compile tokens which affect USB class-specific drivers in the LUFA library. * + * HID_HOST_BOOT_PROTOCOL_ONLY - ( \ref Group_USBClassHIDHost ) \n + * By default, the USB HID Host class driver is designed to work with HID devices using either the Boot or Report HID + * communication protocols. On devices where the Report protocol is not used (i.e. in applications where only basic + * Mouse or Keyboard operation is desired, using boot compatible devices), the code responsible for the Report protocol + * mode can be removed to save space in the compiled application by defining this token. When defined, it is still neccesary + * to explicitly put the attached device into Boot protocol mode via a call to \ref HID_Host_SetBootProtocol(). + * * HID_STATETABLE_STACK_DEPTH=x - ( \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 @@ -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 * 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. * @@ -168,5 +177,5 @@ * INTERRUPT_CONTROL_ENDPOINT - ( \ref Group_USBManagement ) \n * Some applications prefer to not call the USB_USBTask() management task reguarly while in device mode, as it can complicate code significantly. * Instead, when device mode is used this token can be passed to the library via the -D switch to allow the library to manage the USB control - * endpoint entirely via interrupts asynchronously to the user application. + * endpoint entirely via USB controller interrupts asynchronously to the user application. */