X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/064643e06648dcb7e4d03bd2c2029b9186c250b5..aceb015ea75267f97b97e0bce11b7f6123b0bc06:/LUFA/ManPages/CompileTimeTokens.txt diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt index 660cdcfb2..e96f7c163 100644 --- a/LUFA/ManPages/CompileTimeTokens.txt +++ b/LUFA/ManPages/CompileTimeTokens.txt @@ -81,10 +81,12 @@ * \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. * - * ORDERED_EP_CONFIG - (\ref Group_EndpointManagement , \ref Group_PipeManagement) - AVR8 Only \n + * ORDERED_EP_CONFIG - (\ref Group_EndpointManagement , \ref Group_PipeManagement) - AVR8, UC3 \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 @@ -165,7 +167,7 @@ * is through control endpoint requests. Defining this token will remove several features related to the selection and control of device * endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided. * - * INTERRUPT_CONTROL_ENDPOINT - (\ref Group_USBManagement) - AVR8 Only \n + * INTERRUPT_CONTROL_ENDPOINT - (\ref Group_USBManagement) - All Architectures \n * Some applications prefer to not call the USB_USBTask() management task regularly 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 USB controller interrupts asynchronously to the user application. When defined, USB_USBTask() does not need to be called @@ -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