Be doubly-certain that the incomming CDC class driver's endpoint/pipe is flushed...

[pub/USBasp.git] / Bootloaders / CDC / BootloaderCDC.txt

diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt
index cb6f9f0..4f48a6e 100644 (file)
--- a/Bootloaders/CDC/BootloaderCDC.txt
+++ b/Bootloaders/CDC/BootloaderCDC.txt
@@ -5,36 +5,68 @@
  */\r
  \r
 /** \mainpage CDC Class USB AVR Bootloader\r
  */\r
  \r
 /** \mainpage CDC Class USB AVR Bootloader\r

- * \r
- * This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109\r
- * protocol compatible programming software to load firmware onto the AVR.     \r
+ *\r
+ *  \section SSec_Compat Demo Compatibility:\r
+ *\r
+ *  The following list indicates what microcontrollers are compatible with this demo.\r
+ *\r
+ *  - Series 7 USB AVRs\r
+ *  - Series 6 USB AVRs\r
+ *  - Series 4 USB AVRs\r
+ *  - Series 2 USB AVRs\r
+ *\r
+ *  \section SSec_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)</td>\r
+ *   </tr>\r
+ *   <tr> \r
+ *    <td><b>USB Subclass:</b></td>\r
+ *    <td>Abstract Control Model (ACM)</td>\r
+ *   </tr>\r
+ *   <tr>\r
+ *    <td><b>Relevant Standards:</b></td>\r
+ *    <td>USBIF CDC Class Standard</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 SSec_Description Project Description: \r
+ *\r
+ *  This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109\r
+ *  protocol compatible programming software to load firmware onto the AVR.    \r

  *  \r
  *  \r

- * Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If\r
- * you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU\r
- * values in the accompanying makefile.\r
+ *  Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If\r
+ *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU\r
+ *  values in the accompanying makefile.\r

  *  \r
  *  \r

- * This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.\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)</td>\r
- *  </tr>\r
- *  <tr> \r
- *   <td><b>USB Subclass:</b></td>\r
- *   <td>Abstract Control Model (ACM)</td>\r
- *  </tr>\r
- *  <tr>\r
- *   <td><b>Relevant Standards:</b></td>\r
- *   <td>USBIF CDC Class Standard</td>\r
- *  </tr>\r
- *  <tr>\r
- *   <td><b>Usable Speeds:</b></td>\r
- *   <td>Full Speed Mode</td>\r
- *  </tr>\r
- * </table>\r
- */\r
+ *  This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.\r
+ *\r
+ *  After running this bootloader for the first time on a new computer, you will need to supply the .INF\r
+ *  file located in this bootloader project's directory as the device's driver when running under Windows.\r
+ *  This will enable Windows to use its inbuilt CDC drivers, negating the need for custom drivers for the\r
+ *  device. Other Operating Systems should automatically use their own inbuilt CDC-ACM drivers.\r
+ *\r
+ *  \section SSec_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
+ *  </table>\r
+ */
\ No newline at end of file