TeensyHID.txt 2.11 KB
Newer Older
1
2
3
4
5
6
7
/** \file
 *
 *  This file contains special DoxyGen information for the generation of the main page and other special
 *  documentation pages. It is not a project source file.
 */
 
/** \mainpage Teensy HID Class USB AVR Bootloader
8
9
10
 *
 *  \section SSec_Compat Demo Compatibility:
 *
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
17
18
19
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
 *
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 * <table>
 *  <tr>
 *   <td><b>USB Mode:</b></td>
 *   <td>Device</td>
 *  </tr>
 *  <tr>
 *   <td><b>USB Class:</b></td>
 *   <td>Human Interface Device Class (HID)</td>
 *  </tr>
 *  <tr> 
 *   <td><b>USB Subclass:</b></td>
 *   <td>N/A</td>
 *  </tr>
 *  <tr>
 *   <td><b>Relevant Standards:</b></td>
35
36
 *   <td>USBIF HID Class Standard \n
 *       Teensy Programming Protocol Specification</td>
37
38
39
 *  </tr>
 *  <tr>
 *   <td><b>Usable Speeds:</b></td>
40
41
 *   <td>Low Speed Mode \n
 *       Full Speed Mode</td>
42
43
 *  </tr>
 * </table>
44
45
46
47
 *
 *  \section SSec_Description Project Description: 
 *
 * 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 2-4KB of bootloader space. For other
51
52
 * devices, the makefile will need to be updated to reflect the altered MCU model and bootloader start address. When
 * 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
56
57
58
59
60
61
62
63
64
65
66
67
 * compatible with no changes.
 *
 *  \section SSec_Options Project Options
 *
 *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 *
 *  <table>
 *   <tr>
 *    <td>
 *     None
 *    </td>
 *   </tr>
 *  </table>
68
 */