X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/071e02c6b6b4837fa9cf0b6d4c749994e02638d7..b6a3c78fa3e46fea1dd6f4b93352686837983dfd:/LUFA/ManPages/CompileTimeTokens.txt

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 046101e76..f215ffec1 100644
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -28,9 +28,9 @@
  *  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
+ *  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().
- * 
+ *
  *  <b>HID_STATETABLE_STACK_DEPTH</b>=<i>x</i> - ( \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
@@ -61,30 +61,26 @@
  *
  *  <b>HID_MAX_REPORT_IDS</b>=<i>x</i> - ( \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
+ *  keyboard and mouse might use report IDs to separate 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
  *  stored. This token may be defined to a non-zero 8-bit value to set the maximum number of report IDs in a device which can be processed
  *  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.
  *
+ *  <b>NO_CLASS_DRIVER_AUTOFLUSH</b>
+ *  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.
  *
- *  <b>NO_STREAM_CALLBACKS</b> - ( \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.
- *
- *  <b>FAST_STREAM_TRANSFERS</b> - ( \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 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.
+ *  <b>ORDERED_EP_CONFIG</b> - ( \ref Group_EndpointManagement , \ref Group_PipeManagement )\n
+ *  The USB AVRs do not allow for Endpoints and Pipes to be configured out of order; they <i>must</i> 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.
  *
  *  <b>USE_STATIC_OPTIONS</b>=<i>x</i> - ( \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
@@ -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.
  *
+ *  <b>NO_SOF_EVENTS</b> - ( \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.
  *
- *  <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
+ *  <b>USE_RAM_DESCRIPTORS</b> - ( \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.
  *
- *  <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
+ *  <b>USE_FLASH_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's FLASH memory rather than RAM.
  *
- *  <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
+ *  <b>USE_EEPROM_DESCRIPTORS</b> - ( \ref Group_StdDescriptors ) \n
  *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.
  *
- *  <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n
+ *  <b>NO_INTERNAL_SERIAL</b> - ( \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
@@ -143,7 +144,7 @@
  *  binary.
  *
  *  <b>DEVICE_STATE_AS_GPIOR</b> - ( \ref Group_Device ) \n
- *  One of the most frequenty used global variables in the stack is the USB_DeviceState global, which indicates the current state of
+ *  One of the most frequently used global variables in the stack is the USB_DeviceState global, which indicates the current state of
  *  the Device State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
@@ -161,7 +162,7 @@
  *  endpoints internally, saving space. Generally, this is usually only useful in (some) bootloaders and is best avoided.
  *
  *  <b>INTERRUPT_CONTROL_ENDPOINT</b> - ( \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.
+ *  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
  *  when in USB device mode.
@@ -181,7 +182,7 @@
  *  This section describes compile tokens which affect USB driver stack of the LUFA library when used in Host mode.
  *
  *  <b>HOST_STATE_AS_GPIOR</b> - ( \ref Group_Host ) \n
- *  One of the most frequenty used global variables in the stack is the USB_HostState global, which indicates the current state of
+ *  One of the most frequently used global variables in the stack is the USB_HostState global, which indicates the current state of
  *  the Host State Machine. To reduce the amount of code and time required to access and modify this global in an application, this token
  *  may be defined to a value between 0 and 2 to fix the state variable into one of the three general purpose IO registers inside the AVR
  *  reserved for application use. When defined, the corresponding GPIOR register should not be used within the user application except
@@ -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.
  */
+