X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/711542ee8986482a12796ffdbc4a32912b267e44..b6a3c78fa3e46fea1dd6f4b93352686837983dfd:/LUFA/ManPages/CompileTimeTokens.txt
diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 6f2e804ad..f215ffec1 100644
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -7,7 +7,7 @@
/** \page Page_TokenSummary Summary of Compile Tokens
*
* The following lists all the possible tokens which can be defined in a project makefile, and passed to the
- * compiler via the -D switch, to alter the LUFA library code. These tokens may alter the library behavior,
+ * 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.
*
*
@@ -30,7 +30,7 @@
* 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 necessary
* 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
@@ -67,27 +67,23 @@
* 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.
*
+ * NO_CLASS_DRIVER_AUTOFLUSH
+ * Many of the device and host mode class drivers automatically flush any data waiting to be written to an interface, when the corresponding
+ * USB management task is executed. This is usually desirable to ensure that any queued data is sent as soon as possible once and new data is
+ * constructed in the main program loop. However, if flushing is to be controlled manually by the user application via the *_Flush() commands,
+ * the compile time token may be defined in the application's makefile to disable automatic flushing during calls to the class driver USB
+ * management tasks.
*
* \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 behavior, including whether the USB pad
+ * 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
* the dynamic options code, and replacing it with the statically set options. When defined, the USB_Init() function no longer accepts an
@@ -115,21 +111,26 @@
* can be accurately set and the \ref EVENT_USB_Device_Connect() and \ref EVENT_USB_Device_Disconnect() events manually raised by the RAISE_EVENT macro.
* When defined, this token disables the library's auto-detection of the connection state by the aforementioned suspension and wake up events.
*
+ * NO_SOF_EVENTS - ( \ref Group_Events ) \n
+ * By default, there exists a LUFA application event for the start of each USB frame while the USB bus is not suspended in either host or device mode.
+ * This event can be selectively enabled or disabled by calling the appropriate device or host mode function. When this compile time token is defined,
+ * the ability to receive USB Start of Frame events via the \ref EVENT_USB_Device_StartOfFrame() or \ref EVENT_USB_Host_StartOfFrame() events is removed,
+ * reducing the compiled program's binary size.
*
* \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
@@ -198,3 +199,4 @@
* 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.
*/
+