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.
Dean Camera 16 years ago
parent 0fcbe22c9e
commit 1d26e78258

@ -5,6 +5,19 @@
*/
/** \mainpage CDC Class USB AVR Bootloader
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,19 @@
*/
/** \mainpage DFU Class USB AVR Bootloader
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Teensy HID Class USB AVR Bootloader
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB646
* - AT90USB162
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,16 @@
*/
/** \mainpage Audio Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,16 @@
*/
/** \mainpage Audio Output Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Communications Device Class Device (Virtual Serial Port)
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Dual Communications Device Class Device (Dual Virtual Serial Port)
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Generic HID Device
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Joystick Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Keyboard Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Dual HID Keyboard and Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage MIDI Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Mass Storage Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -52,7 +52,7 @@
#define MAX_TCP_CONNECTIONS 1
/** TCP window size, giving the maximum number of bytes which can be buffered at the one time */
#define TCP_WINDOW_SIZE 1024
#define TCP_WINDOW_SIZE 512
/** Port number for HTTP transmissions */
#define TCP_PORT_HTTP SwapEndian_16(80)

@ -5,11 +5,45 @@
*/
/** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
*
* \section SSec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
* <td><b>USB Mode:</b></td>
* <td>Device</td>
* </tr>
* <tr>
* <td><b>USB Class:</b></td>
* <td>Communications Device Class (CDC)</td>
* </tr>
* <tr>
* <td><b>USB Subclass:</b></td>
* <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
* <td>Microsoft RNDIS Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
* <td>Full Speed Mode</td>
* </tr>
* </table>
*
* \section SSec_Description Project Description:
*
* Remote Network Driver Interface demonstration application.
* This gives a simple reference application for implementing
* a CDC RNDIS device acting as a simple network interface for
@ -41,31 +75,6 @@
* recommended that it be replaced with an external open source TCP/IP
* stack that is feature complete, such as the uIP stack.
*
* \section SSec_Description Project Description:
*
* <table>
* <tr>
* <td><b>USB Mode:</b></td>
* <td>Device</td>
* </tr>
* <tr>
* <td><b>USB Class:</b></td>
* <td>Communications Device Class (CDC)</td>
* </tr>
* <tr>
* <td><b>USB Subclass:</b></td>
* <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
* <td>Microsoft RNDIS Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
* <td>Full Speed Mode</td>
* </tr>
* </table>
*
* \section SSec_Options Project Options
*
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.

@ -5,6 +5,20 @@
*/
/** \mainpage USB to Serial Converter Demo (via CDC-ACM class)
*
* \section SSec_Compat Demo Compatibility:
*
* This demo is known to be compatible with the following microcontrollers:
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,15 @@
*/
/** \mainpage Audio Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,16 @@
*/
/** \mainpage Audio Output Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Communications Device Class Device (Virtual Serial Port)
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Dual Communications Device Class Device (Dual Virtual Serial Port)
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Generic HID Device
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Joystick Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Keyboard Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Dual HID Keyboard and Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage MIDI Input Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Mass Storage Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,20 @@
*/
/** \mainpage Mouse Device Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -52,7 +52,7 @@
#define MAX_TCP_CONNECTIONS 1
/** TCP window size, giving the maximum number of bytes which can be buffered at the one time */
#define TCP_WINDOW_SIZE 1024
#define TCP_WINDOW_SIZE 512
/** Port number for HTTP transmissions */
#define TCP_PORT_HTTP SwapEndian_16(80)

@ -5,11 +5,45 @@
*/
/** \mainpage RNDIS Class Ethernet Demo (with Webserver/Telnet)
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
*
* \section SSec_Info USB Information:
*
* The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
* <td><b>USB Mode:</b></td>
* <td>Device</td>
* </tr>
* <tr>
* <td><b>USB Class:</b></td>
* <td>Communications Device Class (CDC)</td>
* </tr>
* <tr>
* <td><b>USB Subclass:</b></td>
* <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
* <td>Microsoft RNDIS Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
* <td>Full Speed Mode</td>
* </tr>
* </table>
*
* \section SSec_Description Project Description:
*
* Remote Network Driver Interface demonstration application.
* This gives a simple reference application for implementing
* a CDC RNDIS device acting as a simple network interface for
@ -41,31 +75,6 @@
* recommended that it be replaced with an external open source TCP/IP
* stack that is feature complete, such as the uIP stack.
*
* \section SSec_Description Project Description:
*
* <table>
* <tr>
* <td><b>USB Mode:</b></td>
* <td>Device</td>
* </tr>
* <tr>
* <td><b>USB Class:</b></td>
* <td>Communications Device Class (CDC)</td>
* </tr>
* <tr>
* <td><b>USB Subclass:</b></td>
* <td>Remote NDIS (Microsoft Proprietary CDC Class Networking Standard)</td>
* </tr>
* <tr>
* <td><b>Relevant Standards:</b></td>
* <td>Microsoft RNDIS Specification</td>
* </tr>
* <tr>
* <td><b>Usable Speeds:</b></td>
* <td>Full Speed Mode</td>
* </tr>
* </table>
*
* \section SSec_Options Project Options
*
* The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.

@ -5,6 +5,20 @@
*/
/** \mainpage USB to Serial Converter Demo (via CDC-ACM class)
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
* - AT90USB647
* - AT90USB646
* - ATMEGA32U6
* - ATMEGA32U4
* - ATMEGA16U4
* - AT90USB162
* - AT90USB82
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage CDC Host Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage CDC Host Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Generic HID Host Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Keyboard Host Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Keyboard Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Mass Storage Host Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Mouse Host Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Mouse Host With HID Descriptor Parser Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Still Image Host Demo
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -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)

@ -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

@ -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

@ -5,6 +5,13 @@
*/
/** \mainpage Denver Gingerich's USBSnoop Magnetic Card Reader Project
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

@ -5,6 +5,13 @@
*/
/** \mainpage Missile Launcher
*
* \section SSec_Compat Demo Compatibility:
*
* The following table indicates what microcontrollers are compatible with this demo.
*
* - AT90USB1287
* - AT90USB1286
*
* \section SSec_Info USB Information:
*

Loading…
Cancel
Save