X-Git-Url: http://git.linex4red.de/pub/lufa.git/blobdiff_plain/0fcbe22c9eb68f5769bf57469e1bcf9b340d0ae3..8a28fd8e6ccdb6a33727f7df089802b4d34dbea7:/LUFA/ManPages/CompileTimeTokens.txt
diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 796ee8484..2d9ec7a95 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.
*
* USE_RAM_DESCRIPTORS - ( \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.
+ *
+ * USE_FLASH_DESCRIPTORS - ( \ref Group_Descriptors ) \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
- * 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.
*
* USE_NONSTANDARD_DESCRIPTOR_NAMES - ( \ref Group_Descriptors ) \n
* The USB 2.0 standard gives some rather obscure names for the elements in the standard descriptor types (device, configuration,
@@ -93,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.
*
- * USE_SINGLE_DEVICE_CONFIGURATION - ( \ref Group_Device ) \n
+ * TOTAL_NUM_CONFIGURATIONS - ( \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.
*
* CONTROL_ONLY_DEVICE \n
* In some limited USB device applications, there are no device endpoints other than the control endpoint; i.e. all device communication
@@ -112,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.
*
+ * 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 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.
+ *
* USB_HOST_TIMEOUT_MS - ( \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