Skip to content
GitLab
Commit 1d26e782 authored by Dean Camera's avatar Dean Camera
Browse files

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.
parent 0fcbe22c
Hide whitespace changes
Inline Side-by-side
Bootloaders/CDC/BootloaderCDC.txt
View file @ 1d26e782
......@@ -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:
*
......
Bootloaders/DFU/BootloaderDFU.txt
View file @ 1d26e782
......@@ -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:
*
......
Bootloaders/TeensyHID/TeensyHID.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/AudioInput/AudioInput.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/AudioOutput/AudioOutput.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/CDC/CDC.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/DualCDC/DualCDC.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/GenericHID/GenericHID.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/Joystick/Joystick.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/Keyboard/Keyboard.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/KeyboardMouse/KeyboardMouse.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/MIDI/MIDI.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/MassStorage/MassStorage.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/Mouse/Mouse.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/ClassDriver/RNDISEthernet/Lib/TCP.h
View file @ 1d26e782
......@@ -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)
......
Demos/Device/ClassDriver/RNDISEthernet/RNDISEthernet.txt
View file @ 1d26e782
......@@ -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.
......
Demos/Device/ClassDriver/USBtoSerial/USBtoSerial.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/LowLevel/AudioInput/AudioInput.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/LowLevel/AudioOutput/AudioOutput.txt
View file @ 1d26e782
......@@ -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:
*
......
Demos/Device/LowLevel/CDC/CDC.txt
View file @ 1d26e782
......@@ -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:
*
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment