X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/710f31c54023b2fd85d37b0d849be3895b70f1cb..b6a3c78fa3e46fea1dd6f4b93352686837983dfd:/LUFA/ManPages/CompileTimeTokens.txt diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt index 28b7cfc6b..f215ffec1 100644 --- a/LUFA/ManPages/CompileTimeTokens.txt +++ b/LUFA/ManPages/CompileTimeTokens.txt @@ -77,20 +77,10 @@ * \section Sec_SummaryUSBTokens General USB Driver Related Tokens * This section describes compile tokens which affect USB driver stack as a whole in the LUFA library. * - * NO_STREAM_CALLBACKS - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n - * Both the endpoint and the pipe driver code contains stream functions, allowing for arrays of data to be sent to or from the - * host easily via a single function call (rather than complex routines worrying about sending full packets, waiting for the endpoint/ - * pipe to become ready, etc.). By default, these stream functions require a callback function which is executed after each byte processed, - * allowing for early-aborts of stream transfers by the application. If callbacks are not required in an application, they can be removed - * by defining this token, reducing the compiled binary size. When removed, the stream functions no longer accept a callback function as - * a parameter. - * - * FAST_STREAM_TRANSFERS - ( \ref Group_EndpointPacketManagement , \ref Group_PipePacketManagement )\n - * By default, streams are transferred internally via a loop, sending or receiving one byte per iteration before checking for a bank full - * or empty condition. This allows for multiple stream functions to be chained together easily, as there are no alignment issues. However, - * this can lead to heavy performance penalties in applications where large streams are used frequently. When this compile time option is - * used, bytes are sent or received 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. + * ORDERED_EP_CONFIG - ( \ref Group_EndpointManagement , \ref Group_PipeManagement )\n + * The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they must be configured in an ascending order to + * prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialisation. This compile + * time token may be used to restrict the intialisation order to ascending indexes only in exchange for a smaller compiled binary size. * * 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 @@ -130,17 +120,17 @@ * \section Sec_SummaryUSBDeviceTokens USB Device Mode Driver Related Tokens * This section describes compile tokens which affect USB driver stack of the LUFA library when used in Device mode. * - * USE_RAM_DESCRIPTORS - ( \ref Group_Descriptors ) \n + * USE_RAM_DESCRIPTORS - ( \ref Group_StdDescriptors ) \n * Define this token to indicate to the USB driver that all device descriptors are stored in RAM, rather than being located in any one * of the AVR's memory spaces. RAM descriptors may be desirable in applications where the descriptors need to be modified at runtime. * - * USE_FLASH_DESCRIPTORS - ( \ref Group_Descriptors ) \n + * USE_FLASH_DESCRIPTORS - ( \ref Group_StdDescriptors ) \n * Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM. * - * USE_EEPROM_DESCRIPTORS - ( \ref Group_Descriptors ) \n + * USE_EEPROM_DESCRIPTORS - ( \ref Group_StdDescriptors ) \n * Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM. * - * NO_INTERNAL_SERIAL - ( \ref Group_Descriptors ) \n + * NO_INTERNAL_SERIAL - ( \ref Group_StdDescriptors ) \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 * allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the