Bootloaders/CDC/BootloaderCDC.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage CDC Class USB AVR Bootloader
   8  *
   9  *  \section SSec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  - Series 7 USB AVRs
  14  *  - Series 6 USB AVRs
  15  *  - Series 4 USB AVRs
  16  *  - Series 2 USB AVRs
  17  *
  18  *  \section SSec_Info USB Information:
  19  *
  20  *  The following table gives a rundown of the USB utilization of this demo.
  21  *
  22  *  <table>
  23  *   <tr>
  24  *    <td><b>USB Mode:</b></td>
  25  *    <td>Device</td>
  26  *   </tr>
  27  *   <tr>
  28  *    <td><b>USB Class:</b></td>
  29  *    <td>Communications Device Class (CDC)</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>Abstract Control Model (ACM)</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF CDC Class Standard</td>
  38  *   </tr>
  39  *   <tr>
  40  *    <td><b>Usable Speeds:</b></td>
  41  *    <td>Full Speed Mode</td>
  42  *   </tr>
  43  *  </table>
  44  *
  45  *  \section SSec_Description Project Description:
  46  *
  47  *  This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
  48  *  protocol compatible programming software to load firmware onto the AVR.
  49  *
  50  *  Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If
  51  *  you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
  52  *  values in the accompanying makefile.
  53  *
  54  *  This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.
  55  *
  56  *  After running this bootloader for the first time on a new computer, you will need to supply the .INF
  57  *  file located in this bootloader project's directory as the device's driver when running under Windows.
  58  *  This will enable Windows to use its inbuilt CDC drivers, negating the need for custom drivers for the
  59  *  device. Other Operating Systems should automatically use their own inbuilt CDC-ACM drivers.
  60  *
  61  *  \section SSec_Options Project Options
  62  *
  63  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  64  *
  65  *  <table>
  66  *   <tr>
  67  *    <td>
  68  *     None
  69  *    </td>
  70  *   </tr>
  71  *  </table>
  72  */