Add LUFA-111009-BETA tag.
[pub/USBasp.git] / Demos / Device / ClassDriver / VirtualSerialMassStorage / VirtualSerialMassStorage.txt
index aa9a74f..ff1d3c2 100644 (file)
@@ -1,87 +1,86 @@
-/** \file\r
- *\r
- *  This file contains special DoxyGen information for the generation of the main page and other special\r
- *  documentation pages. It is not a project source file.\r
- */\r
-\r
-/** \mainpage Communications Device Class (Virtual Serial Port) and Mass Storage Demo\r
- *\r
- *  \section Sec_Compat Demo Compatibility:\r
- *\r
- *  The following list indicates what microcontrollers are compatible with this demo.\r
- *\r
- *  - Series 7 USB AVRs (AT90USBxxx7)\r
- *  - Series 6 USB AVRs (AT90USBxxx6)\r
- *  - Series 4 USB AVRs (ATMEGAxxU4)\r
- *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)\r
- *\r
- *  \section Sec_Info USB Information:\r
- *\r
- *  The following table gives a rundown of the USB utilization of this demo.\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td><b>USB Mode:</b></td>\r
- *    <td>Device</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>USB Class:</b></td>\r
- *    <td>Communications Device Class (CDC) \n\r
- *        Mass Storage Device</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>USB Subclass:</b></td>\r
- *    <td>Abstract Control Model (ACM) \n\r
- *        Bulk-Only Transport</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Relevant Standards:</b></td>\r
- *    <td>USBIF CDC Class Standard \n\r
- *        USBIF Mass Storage Standard \n\r
- *        USB Bulk-Only Transport Standard \n\r
- *        SCSI Primary Commands Specification \n\r
- *        SCSI Block Commands Specification</td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td><b>Usable Speeds:</b></td>\r
- *    <td>Full Speed Mode</td>\r
- *   </tr>\r
- *  </table>\r
- *\r
- *  \section Sec_Description Project Description:\r
- *\r
- *  Combined Communications Device Class/Mass Storage demonstration application.\r
- *  This gives a simple reference application for implementing a combined\r
- *  CDC and Mass Storage device acting as a both a virtual serial port and a flash\r
- *  drive. Joystick actions are transmitted to the host as strings, and data can be\r
- *  written to or read from the exposed flash drive interface in the same manner as\r
- *  other USB flash drives. The device does not respond to serial data sent from the\r
- *  host.\r
- *\r
- *  After running this demo for the first time on a new computer,\r
- *  you will need to supply the .INF file located in this demo\r
- *  project's directory as the device's driver when running under\r
- *  Windows. This will enable Windows to use its inbuilt CDC drivers,\r
- *  negating the need for custom drivers for the device. Other\r
- *  Operating Systems should automatically use their own inbuilt\r
- *  CDC-ACM drivers.\r
- *\r
- *  \section Sec_Options Project Options\r
- *\r
- *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.\r
- *\r
- *  <table>\r
- *   <tr>\r
- *    <td><b>Define Name:</b></td>\r
- *    <td><b>Location:</b></td>\r
- *    <td><b>Description:</b></td>\r
- *   </tr>\r
- *   <tr>\r
- *    <td>TOTAL_LUNS</td>\r
- *    <td>MassStorage.h</td>\r
- *    <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -\r
- *        this can be set to any positive non-zero amount.</td>\r
- *   </tr>\r
- *  </table>\r
- */\r
-\r
+/** \file
+ *
+ *  This file contains special DoxyGen information for the generation of the main page and other special
+ *  documentation pages. It is not a project source file.
+ */
+
+/** \mainpage Communications Device Class (Virtual Serial Port) and Mass Storage Demo
+ *
+ *  \section Sec_Compat Demo Compatibility:
+ *
+ *  The following list indicates what microcontrollers are compatible with this demo.
+ *
+ *  - Series 7 USB AVRs (AT90USBxxx7)
+ *  - Series 6 USB AVRs (AT90USBxxx6)
+ *  - Series 4 USB AVRs (ATMEGAxxU4)
+ *
+ *  \section Sec_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) \n
+ *        Mass Storage Device</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>USB Subclass:</b></td>
+ *    <td>Abstract Control Model (ACM) \n
+ *        Bulk-Only Transport</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Relevant Standards:</b></td>
+ *    <td>USBIF CDC Class Standard \n
+ *        USBIF Mass Storage Standard \n
+ *        USB Bulk-Only Transport Standard \n
+ *        SCSI Primary Commands Specification \n
+ *        SCSI Block Commands Specification</td>
+ *   </tr>
+ *   <tr>
+ *    <td><b>Usable Speeds:</b></td>
+ *    <td>Full Speed Mode</td>
+ *   </tr>
+ *  </table>
+ *
+ *  \section Sec_Description Project Description:
+ *
+ *  Combined Communications Device Class/Mass Storage demonstration application.
+ *  This gives a simple reference application for implementing a combined
+ *  CDC and Mass Storage device acting as a both a virtual serial port and a flash
+ *  drive. Joystick actions are transmitted to the host as strings, and data can be
+ *  written to or read from the exposed flash drive interface in the same manner as
+ *  other USB flash drives. The device does not respond to serial data sent from the
+ *  host.
+ *
+ *  After running this demo for the first time on a new computer,
+ *  you will need to supply the .INF file located in this demo
+ *  project's directory as the device's driver when running under
+ *  Windows. This will enable Windows to use its inbuilt CDC drivers,
+ *  negating the need for custom drivers for the device. Other
+ *  Operating Systems should automatically use their own inbuilt
+ *  CDC-ACM drivers.
+ *
+ *  \section Sec_Options Project Options
+ *
+ *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
+ *
+ *  <table>
+ *   <tr>
+ *    <td><b>Define Name:</b></td>
+ *    <td><b>Location:</b></td>
+ *    <td><b>Description:</b></td>
+ *   </tr>
+ *   <tr>
+ *    <td>TOTAL_LUNS</td>
+ *    <td>MassStorage.h</td>
+ *    <td>Total number of Logical Units (drives) in the device. The total device capacity is shared equally between each drive -
+ *        this can be set to any positive non-zero amount.</td>
+ *   </tr>
+ *  </table>
+ */
+