Bootloaders/TeensyHID/TeensyHID.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 Teensy 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  *  - AT90USB162 (Teensy 1.0)
  14  *  - AT90USB646 (Teensy++ 1.0)
  15  *  - ATMEGA32U4 (Teensy 2.0)
  16  *  - AT90USB1286 (Teensy++ 2.0)
  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 Teensy compatible programming
  50  * software to load firmware onto the AVR, such as the official software at <a>http://www.pjrc.com/teensy/</a>.
  51  *
  52  * Out of the box this bootloader builds for the ATMEGA32U4, and will fit into 2-4KB of bootloader space. For other
  53  * devices, the makefile will need to be updated to reflect the altered MCU model and bootloader start address. When
  54  * calculating the bootloader start address, use (TARGET_FLASH_SIZE_BYTES - 4096) for targets where the bootloader
  55  * compiles larger than 2KB, or (TARGET_FLASH_SIZE_BYTES - 2048) for smaller targets where the bootloader compiles
  56  * under 2KB.
  57  *
  58  * This spoofs (with permission) the official Teensy bootloader's VID and PID, so that the software remains
  59  * compatible with no changes.
  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  */