X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/b221e7d175e4b5ca463fdd6d05b8c3fc71bd7c40..fec31947a6b4e77f65d92bf14b32533bbbc39b2d:/LUFA/ManPages/CompileTimeTokens.txt diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt index 8213c678b..d8d4edbb3 100644 --- a/LUFA/ManPages/CompileTimeTokens.txt +++ b/LUFA/ManPages/CompileTimeTokens.txt @@ -20,30 +20,38 @@ * 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_STATETABLE_STACK_DEPTH - ( \ref Group_HIDParser ) \n + * 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 * state table in a compact manner. This token may be defined to a non-zero 8-bit value to give the maximum depth of the state * table stack. If not defined, this defaults to the value indicated in the HID.h file documentation. * - * HID_USAGE_STACK_DEPTH - ( \ref Group_HIDParser ) \n + * HID_USAGE_STACK_DEPTH=x - ( \ref Group_HIDParser ) \n * HID reports generally contain many USAGE elements, which are assigned to INPUT, OUTPUT and FEATURE items in succession * when multiple items are defined at once (via REPORT COUNT elements). This allows for several items to be defined with * different usages in a compact manner. This token may be defined to a non-zero 8-bit value to set the maximum depth of the * usage stack, indicating the maximum number of USAGE items which can be stored temporarily until the next INPUT, OUTPUT * and FEATURE item. If not defined, this defaults to the value indicated in the HID.h file documentation. * - * HID_MAX_COLLECTIONS - ( \ref Group_HIDParser ) \n + * HID_MAX_COLLECTIONS=x - ( \ref Group_HIDParser ) \n * HID reports generally contain several COLLECTION elements, used to group related data items together. Collection information * is stored separately in the processed usage structure (and referred to by the data elements in the structure) to save space. * This token may be defined to a non-zero 8-bit value to set the maximum number of COLLECTION items which can be processed by the * parser into the resultant processed report structure. If not defined, this defaults to the value indicated in the HID.h file * documentation. * - * HID_MAX_REPORTITEMS - ( \ref Group_HIDParser ) \n + * HID_MAX_REPORTITEMS=x - ( \ref Group_HIDParser ) \n * All HID reports contain one or more INPUT, OUTPUT and/or FEATURE items describing the data which can be sent to and from the HID * device. Each item has associated usages, bit offsets in the item reports and other associated data indicating the manner in which * the report data should be interpreted by the host. This token may be defined to a non-zero 8-bit value to set the maximum number of @@ -51,7 +59,7 @@ * 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_MAX_REPORT_IDS=x - ( \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 @@ -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. * @@ -78,7 +87,7 @@ * allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the * code that performs this task can be disabled by defining this option and passing it to the compiler via the -D switch. * - * FIXED_CONTROL_ENDPOINT_SIZE - ( \ref Group_EndpointManagement ) \n + * FIXED_CONTROL_ENDPOINT_SIZE=x - ( \ref Group_EndpointManagement ) \n * By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor. * Normally this reduces the amount of configuration required for the library, allows the value to change dynamically (if * descriptors are stored in EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this token can be @@ -99,7 +108,7 @@ * reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except * implicitly via the library APIs. * - * FIXED_NUM_CONFIGURATIONS - ( \ref Group_Device ) \n + * FIXED_NUM_CONFIGURATIONS=x - ( \ref Group_Device ) \n * By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces * the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in * EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project @@ -125,18 +134,18 @@ * used, bytes are sent or recevied in groups of 8 bytes at a time increasing performance at the expense of a larger flash memory consumption * due to the extra code required to deal with byte alignment. * - * USB_HOST_TIMEOUT_MS - ( \ref Group_Host ) \n + * USB_HOST_TIMEOUT_MS=x - ( \ref Group_Host ) \n * When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached * device fails to respond within the timeout period. This token may be defined to a non-zero 16-bit value to set the timeout period for * control transfers, specified in milliseconds. If not defined, the default value specified in Host.h is used instead. * - * HOST_DEVICE_SETTLE_DELAY_MS - ( \ref Group_Host ) \n + * HOST_DEVICE_SETTLE_DELAY_MS=x - ( \ref Group_Host ) \n * Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or * they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled * back to a known idle state before communications occur with the device. This token may be defined to a 16-bit value to set the device * settle period, specified in milliseconds. If not defined, the default value specified in Host.h is used instead. * - * USE_STATIC_OPTIONS - ( \ref Group_USBManagement ) \n + * USE_STATIC_OPTIONS=x - ( \ref Group_USBManagement ) \n * By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad * voltage regulator is enabled, and the device speed when in device mode. By defining this token to a mask comprised of the USB options * mask defines usually passed as the Options parameter to USB_Init(), the resulting compiled binary can be decreased in size by removing @@ -152,7 +161,7 @@ * USB_HOST_ONLY - ( \ref Group_USBManagement ) \n * Same as USB_DEVICE_ONLY, except the library is fixed to USB host mode rather than USB device mode. Not available on some USB AVR models. * - * USB_STREAM_TIMEOUT_MS - ( \ref Group_USBManagement ) \n + * USB_STREAM_TIMEOUT_MS=x - ( \ref Group_USBManagement ) \n * When endpoint and/or pipe stream functions are used, by default there is a timeout between each transfer which the connected device or host * must satisfy, or the stream function aborts the remaining data transfer. This token may be defined to a non-zero 16-bit value to set the timeout * period for stream transfers, specified in milliseconds. If not defined, the default value specified in LowLevel.h is used instead. @@ -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. */