Bootloaders/HID/BootloaderHID.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 HID 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 (AT90USBxxx7)
  14  *  - Series 6 USB AVRs (AT90USBxxx6)
  15  *  - Series 4 USB AVRs (ATMEGAxxU4)
  16  *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  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>Human Interface Device Class (HID)</td>
  30  *  </tr>
  31  *  <tr>
  32  *   <td><b>USB Subclass:</b></td>
  33  *   <td>N/A</td>
  34  *  </tr>
  35  *  <tr>
  36  *   <td><b>Relevant Standards:</b></td>
  37  *   <td>USBIF HID Class Standard \n
  38  *       Teensy Programming Protocol Specification</td>
  39  *  </tr>
  40  *  <tr>
  41  *   <td><b>Usable Speeds:</b></td>
  42  *   <td>Low Speed Mode \n
  43  *       Full Speed Mode</td>
  44  *  </tr>
  45  * </table>
  46  *
  47  *  \section SSec_Description Project Description:
  48  *
  49  *  This bootloader enumerates to the host as a HID Class device, allowing for device FLASH programming through
  50  *  the supplied command line software, which is a modified version of Paul's TeensyHID Command Line loader code
  51  *  from PJRC (used with permission). This bootloader is deliberatley non-compatible with the properietary PJRC
  52  *  HalfKay bootloader GUI; only the command line interface software accompanying this bootloader will work with it.
  53  *
  54  *  Out of the box this bootloader builds for the USB1287, and will fit into 2KB of bootloader space for the
  55  *  Series 2 USB AVRs (ATMEGAxxU2, AT90USBxx2) or 4KB of bootloader space for all other models. If you wish to
  56  *  enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU values in the
  57  *  accompanying makefile.
  58  *
  59  *  \section Sec_Installation Driver Installation
  60  *
  61  *  This bootloader uses the HID class driver inbuilt into all modern operating systems, thus no additional drivers
  62  *  need to be supplied for correct operation.
  63  *
  64  *  \section Sec_HostApp Host Controller Application
  65  *
  66  *  Due to licensing issues, the supplied bootloader is compatible with the HalfKay bootloader protocol designed
  67  *  by PJRC, but is non-compatible with the cross-platform loader GUI. A modified version of the open source
  68  *  cross-platform TeensyLoader application is supplied, which can be compiled under most operating systems. The
  69  *  command-line loader application should remain compatible with genuine Teensy boards in addition to boards using
  70  *  this custom bootloader.
  71  *
  72  *  Once compiled, programs can be loaded into the AVR's FLASH memory through the following example command:
  73  *  \code
  74  *  hid_bootloader_cli -mmcu=at90usb1287 Mouse.hex
  75  *  \endcode
  76  *
  77  *  \section SSec_Options Project Options
  78  *
  79  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  80  *
  81  *  <table>
  82  *   <tr>
  83  *    <td>
  84  *     None
  85  *    </td>
  86  *   </tr>
  87  *  </table>
  88  */