X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/7d3150423d8c25aba858ddff60cfe29faa7b6729..3309c00a99cca6d4a903aed9ecd092346b767ea0:/LUFA/ManPages/CompileTimeTokens.txt diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt index 415fde549..c640b10b5 100644 --- a/LUFA/ManPages/CompileTimeTokens.txt +++ b/LUFA/ManPages/CompileTimeTokens.txt @@ -10,9 +10,9 @@ * compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behaviour, * or remove features unused by a given application in order to save flash space. * - * If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located - * in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile - * defined tokens for configuring the library. + * \note If the \c USE_LUFA_CONFIG_HEADER token is defined, the library will include a header file named \c LUFAConfig.h located + * in the user directory where the below compile time tokens may be defined. This allows for an alternative to makefile + * defined tokens for configuring the library. * * \section Sec_SummaryNonUSBTokens Non USB Related Tokens * This section describes compile tokens which affect non-USB sections of the LUFA library. @@ -83,8 +83,10 @@ * * ORDERED_EP_CONFIG - (\ref Group_EndpointManagement , \ref Group_PipeManagement) - AVR8 Only \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. + * prevent data corruption issues. However, by default LUFA employs a workaround to allow for unordered Endpoint/Pipe initialization. This compile + * time token may be used to restrict the initialization order to ascending indexes only in exchange for a smaller compiled binary size. Use + * caution when applied to applications using the library USB Class drivers; the user application must ensure that all endpoints and pipes are + * allocated sequentially. * * USE_STATIC_OPTIONS=x - (\ref Group_USBManagement) - All Architectures \n * By default, the USB_Init() function accepts dynamic options at runtime to alter the library behaviour, including whether the USB pad @@ -177,8 +179,8 @@ * * NO_DEVICE_SELF_POWER - (\ref Group_Device) - All Architectures \n * USB devices may be bus powered, self powered, or a combination of both. When a device can be both bus powered and self powered, the host may - * query the device to determine the current power source, via \ref USB_CurrentlySelfPowered. For solely bus powered devices, this global and the - * code required to manage it may be disabled by passing this token to the library via the -D switch. + * query the device to determine the current power source, via \ref USB_Device_CurrentlySelfPowered. For solely bus powered devices, this global + * and the code required to manage it may be disabled by passing this token to the library via the -D switch. * * * \section Sec_SummaryUSBHostTokens USB Host Mode Driver Related Tokens