BootloaderCDC.txt 2.15 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 CDC Class USB AVR Bootloader
8
9
10
11
 *
 *  \section SSec_Info USB Information:
 *
 *  The following table gives a rundown of the USB utilization of this demo.
12
13
14
15
16
17
18
19
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>Communications Device Class (CDC)</td>
 *  </tr>
 *  <tr> 
 *   <td><b>USB Subclass:</b></td>
 *   <td>Abstract Control Model (ACM)</td>
 *  </tr>
 *  <tr>
 *   <td><b>Relevant Standards:</b></td>
 *   <td>USBIF CDC Class Standard</td>
 *  </tr>
 *  <tr>
 *   <td><b>Usable Speeds:</b></td>
 *   <td>Full Speed Mode</td>
 *  </tr>
 * </table>
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 *
 *  \section SSec_Description Project Description: 
 *
 * This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
 * protocol compatible programming software to load firmware onto the AVR.	
 *  
 * Out of the box this bootloader builds for the USB1287, and will fit into 4KB of bootloader space. If
 * you wish to enlarge this space and/or change the AVR model, you will need to edit the BOOT_START and MCU
 * values in the accompanying makefile.
 *  
 * This bootloader is compatible with the open source application AVRDUDE, or Atmel's AVRPROG.
 *
 *  \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>
53
54
55
56
57
58
59
60
61
62
 *    <td><b>Define Name:</b></td>
 *    <td><b>Location:</b></td>
 *    <td><b>Description:</b></td>
 *   </tr>
 *   <tr>
 *    <td>SIGNATURE_0, SIGNATURE_1, SIGNATURE_2</td>
 *    <td>Makefile CDEFS</td>
 *    <td>AVR part signature bytes. These are normally defined as part of the AVR device header files in recent avr-libc
 *        distributions. If your avr-libc library is out of date and does not define these values, you can define them
 *        manually in the makefile CDEFS.</td>
63
64
65
 *   </tr>
 *  </table>
 */