aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/ManPages
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-07-13 06:44:14 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-07-13 06:44:14 +0000
commit1d26e78258c10dcca63e31e66732f1e525b5dade (patch)
treefcb03e4309dc7abb8c47df6c0eada59e990e230a /LUFA/ManPages
parent0fcbe22c9eb68f5769bf57469e1bcf9b340d0ae3 (diff)
downloadlufa-1d26e78258c10dcca63e31e66732f1e525b5dade.tar.gz
lufa-1d26e78258c10dcca63e31e66732f1e525b5dade.tar.bz2
lufa-1d26e78258c10dcca63e31e66732f1e525b5dade.zip
Added compatibility list to the documentation of each individual demo.
Documented FAST_STREAM_TRANSFERS compile time option. Reduced the TCP window size for the RNDIS demos (Class and LowLevel) to make them compatible with the AT90USB64x.
Diffstat (limited to 'LUFA/ManPages')
-rw-r--r--LUFA/ManPages/ChangeLog.txt1
-rw-r--r--LUFA/ManPages/CompileTimeTokens.txt7
-rw-r--r--LUFA/ManPages/FutureChanges.txt3
3 files changed, 8 insertions, 3 deletions
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt
index f22a9ff04..04213ac1e 100644
--- a/LUFA/ManPages/ChangeLog.txt
+++ b/LUFA/ManPages/ChangeLog.txt
@@ -23,6 +23,7 @@
* - Updated MassStorage device block write routines to use ping-pong Dataflash buffering to increase throughput by around 30%
* - Added new HOST_STATE_WaitForDeviceRemoval host state machine state for non-blocking disabling of device communications until the
* device has been removed (for use when an error occurs or communications with the device have completed)
+ * - Added new FAST_STREAM_TRANSFERS compile time option for faster stream transfers via multiple bytes copied per stream loop
*
* <b>Changed:</b>
* - Deprecated psuedo-scheduler and removed dynamic memory allocator from the library (first no longer needed and second unused)
diff --git a/LUFA/ManPages/CompileTimeTokens.txt b/LUFA/ManPages/CompileTimeTokens.txt
index 796ee8484..3d15759e4 100644
--- a/LUFA/ManPages/CompileTimeTokens.txt
+++ b/LUFA/ManPages/CompileTimeTokens.txt
@@ -112,6 +112,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
diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt
index 2e348d53e..8d2545f29 100644
--- a/LUFA/ManPages/FutureChanges.txt
+++ b/LUFA/ManPages/FutureChanges.txt
@@ -21,11 +21,8 @@
* - Add standardized descriptor names to device and host class driver structures
* - Add in INTERRUPT_CONTROL_PIPE to use HSOFI to trigger calls to the host state machine
* - Make Suspend host state suspend USB bus frames
- * - Split StillImageHost demo into lib directory
* - Add in Stream functions for PROGMEM, EEPROM -- move to templated system
* - Debug mode for pipe/endpoint calls
- * - Test and document new FAST_STREAM_TRANSFERS compile time option
- * - Demo hardware compatibility table/list
*
* <b>Targeted for Future Releases:</b>
* - Remake AVRStudio project files