X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/00d0883507efdc17688abafa75e81bf62f83d777..cbbd3d746acef02a4afd562652a2ba71b24dfd6f:/LUFA/ManPages/CompileTimeTokens.txt

diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index e1f248d8f..f11dff2e1 100644
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -67,12 +67,14 @@
  *  This section describes compile tokens which affect USB driver stack as a whole in the LUFA library.
  *
  *  <b>USE_RAM_DESCRIPTORS</b> - ( \ref Group_Descriptors ) \n
- *  Define this token to indicate to the USB driver that device descriptors are stored in RAM, rather than the default of
- *  the AVR's flash. RAM descriptors may be desirable in applications where speed or minimizing flash usage is more important
- *  than RAM usage, or applications where the descriptors need to be modified at runtime.
+ *  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
+ *  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
- *  Similar to USE_RAM_DESCRIPTORS, but descriptors are stored in the AVR's EEPROM memory rather than RAM.
+ *  Similar to USE_RAM_DESCRIPTORS, but all descriptors are stored in the AVR's EEPROM memory rather than RAM.
  *
  *  <b>USE_NONSTANDARD_DESCRIPTOR_NAMES</b> - ( \ref Group_Descriptors ) \n
  *  The USB 2.0 standard gives some rather obscure names for the elements in the standard descriptor types (device, configuration,
@@ -80,13 +82,11 @@
  *  compatibility. If this token is defined, the structure element names are switched to the LUFA-specific but more descriptive
  *  names documented in the StdDescriptors.h source file.
  *
- *  <b>USE_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \n
+ *  <b>NO_INTERNAL_SERIAL</b> - ( \ref Group_Descriptors ) \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. To make the library use this value for the
- *  device's serial number, define this token in the project makefile, set it to a unique string descriptor index (i.e. one not used
- *  elsewhere in the device for a string descriptor) and set the Device Descriptor's serial number descriptor index entry to the
- *  USE_INTERNAL_SERIAL value.
+ *  allocated resources (such as drivers, COM Port number allocations) to be preserved. This is not needed in many apps, and so the
+ *  code that performs this task can be disabled by defining this option and passing it to the compiler via the -D switch.
  *
  *  <b>FIXED_CONTROL_ENDPOINT_SIZE</b> - ( \ref Group_EndpointManagement ) \n
  *  By default, the library determines the size of the control endpoint (when in device mode) by reading the device descriptor.
@@ -95,11 +95,11 @@
  *  defined to a non-zero value instead to give the size in bytes of the control endpoint, to reduce the size of the compiled
  *  binary.
  *
- *  <b>USE_SINGLE_DEVICE_CONFIGURATION</b> - ( \ref Group_Device ) \n
+ *  <b>TOTAL_NUM_CONFIGURATIONS</b> - ( \ref Group_Device ) \n
  *  By default, the library determines the number of configurations a USB device supports by reading the device descriptor. This reduces
  *  the amount of configuration required to set up the library, and allows the value to change dynamically (if descriptors are stored in
- *  EEPROM or RAM rather than flash memory) and reduces code maintenance. However, many USB device projects use only a single configuration.
- *  Defining this token enables single-configuration mode, reducing the compiled size of the binary at the expense of flexibility.
+ *  EEPROM or RAM rather than flash memory) and reduces code maintenance. However, this value may be fixed via this token in the project
+ *  makefile to reduce the compiled size of the binary at the expense of flexibility.
  *
  *  <b>CONTROL_ONLY_DEVICE</b> \n
  *  In some limited USB device applications, there are no device endpoints other than the control endpoint; i.e. all device communication
@@ -114,6 +114,13 @@
  *  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>USB_HOST_TIMEOUT_MS</b> - ( \ref Group_Host ) \n
  *  When a control transfer is initiated in host mode to an attached device, a timeout is used to abort the transfer if the attached
  *  device fails to respond within the timeout period. This token may be defined to a non-zero 16-bit value to set the timeout period for
@@ -122,8 +129,8 @@
  *  <b>HOST_DEVICE_SETTLE_DELAY_MS</b> - ( \ref Group_Host ) \n
  *  Some devices require a delay of up to 5 seconds after they are connected to VBUS before the enumeration process can be started, or
  *  they will fail to enumerate correctly. By placing a delay before the enumeration process, it can be ensured that the bus has settled
- *  back to a known idle state before communications occur with the device. This token may be defined to a non-zero 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.
+ *  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.
  *
  *  <b>USE_STATIC_OPTIONS</b> - ( \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
@@ -150,7 +157,7 @@
  *  On the smaller USB AVRs, the USB controller lacks VBUS events to determine the physical connection state of the USB bus to a host. In lieu of
  *  VBUS events, the library attempts to determine the connection state via the bus suspension and wake up events instead. This however may be
  *  slightly inaccurate due to the possibility of the host suspending the bus while the device is still connected. If accurate connection status is
- *  required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_IsConnected global
+ *  required, the VBUS line of the USB connector should be routed to an AVR pin to detect its level, so that the USB_DeviceState global
  *  can be accurately set and the USB_Connect and USB_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.
  *