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  *  - ATMEGA32U4 (Teensy 2.0)
  15  *
  16  *  \section SSec_Info USB Information:
  17  *
  18  *  The following table gives a rundown of the USB utilization of this demo.
  19  *
  20  * <table>
  21  *  <tr>
  22  *   <td><b>USB Mode:</b></td>
  23  *   <td>Device</td>
  24  *  </tr>
  25  *  <tr>
  26  *   <td><b>USB Class:</b></td>
  27  *   <td>Human Interface Device Class (HID)</td>
  28  *  </tr>
  29  *  <tr>
  30  *   <td><b>USB Subclass:</b></td>
  31  *   <td>N/A</td>
  32  *  </tr>
  33  *  <tr>
  34  *   <td><b>Relevant Standards:</b></td>
  35  *   <td>USBIF HID Class Standard \n
  36  *       Teensy Programming Protocol Specification</td>
  37  *  </tr>
  38  *  <tr>
  39  *   <td><b>Usable Speeds:</b></td>
  40  *   <td>Low Speed Mode \n
  41  *       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 HID Class device, allowing for Teensy compatible programming
  48  * software to load firmware onto the AVR, such as the official software at <a>http://www.pjrc.com/teensy/</a>.
  49  *
  50  * Out of the box this bootloader builds for the ATMEGA32U4, and will fit into 4KB of bootloader space. For other
  51  * devices, the makefile will need to be updated to reflect the altered MCU model and bootloader start address. When
  52  * calculating the bootloader start address, use (TARGET_FLASH_SIZE_BYTES - 4096).
  53  *
  54  * This spoofs (with permission) the official Teensy bootloader's VID and PID, so that the software remains
  55  * compatible with no changes.
  56  *
  57  *  \section SSec_Options Project Options
  58  *
  59  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
  60  *
  61  *  <table>
  62  *   <tr>
  63  *    <td>
  64  *     None
  65  *    </td>
  66  *   </tr>
  67  *  </table>
  68  */