]> git.gir.st - tmk_keyboard.git/blob - protocol/lufa/LUFA-git/Bootloaders/CDC/BootloaderCDC.txt
Squashed 'tmk_core/' changes from caca2c0..dc0e46e
[tmk_keyboard.git] / protocol / lufa / LUFA-git / Bootloaders / CDC / BootloaderCDC.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 CDC Class USB AVR Bootloader
8 *
9 * \section Sec_Compat Demo Compatibility:
10 *
11 * The following list indicates what microcontrollers are compatible with this demo.
12 *
13 * \li Series 7 USB AVRs (AT90USBxxx7)
14 * \li Series 6 USB AVRs (AT90USBxxx6)
15 * \li Series 4 USB AVRs (ATMEGAxxU4)
16 * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
17 *
18 * \section Sec_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>Communications Device Class (CDC)</td>
30 * </tr>
31 * <tr>
32 * <td><b>USB Subclass:</b></td>
33 * <td>Abstract Control Model (ACM)</td>
34 * </tr>
35 * <tr>
36 * <td><b>Relevant Standards:</b></td>
37 * <td>USBIF CDC Class Standard</td>
38 * </tr>
39 * <tr>
40 * <td><b>Supported USB Speeds:</b></td>
41 * <td>Full Speed Mode</td>
42 * </tr>
43 * </table>
44 *
45 * \section Sec_Description Project Description:
46 *
47 * This bootloader enumerates to the host as a CDC Class device (virtual serial port), allowing for AVR109
48 * protocol compatible programming software to load firmware onto the AVR.
49 *
50 * Out of the box this bootloader builds for the AT90USB1287 with an 8KB bootloader section size, and will fit
51 * into 4KB of bootloader space. If you wish to alter this size and/or change the AVR model, you will need to
52 * edit the MCU, FLASH_SIZE_KB and BOOT_SECTION_SIZE_KB values in the accompanying makefile.
53 *
54 * When the bootloader is running, the board's LED(s) will flash at regular intervals to distinguish the
55 * bootloader from the normal user application.
56 *
57 * \warning <b>THIS BOOTLOADER IS NOT SECURE.</b> Malicious entities can recover written data, even if the device
58 * lockbits are set.
59 *
60 * \section Sec_Running Running the Bootloader
61 *
62 * This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device
63 * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST
64 * fuse is cleared.
65 *
66 * For board specific exceptions to the above, see below.
67 *
68 * \subsection SSec_XPLAIN Atmel Xplain Board
69 * Ground the USB AVR JTAG's \c TCK pin to ground when powering on the board to start the bootloader. This assumes the
70 * \c HWBE fuse is cleared and the \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board.
71 *
72 * \subsection SSec_Leonardo Arduino Leonardo Board
73 * Ground \c IO13 when powering the board to start the bootloader. This assumes the \c HWBE fuse is cleared and the
74 * \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board.
75 *
76 * \section Sec_Installation Driver Installation
77 *
78 * After running this bootloader for the first time on a new computer, you will need to supply the .INF
79 * file located in this bootloader project's directory as the device's driver when running under Windows.
80 * This will enable Windows to use its inbuilt CDC drivers, negating the need for custom drivers for the
81 * device. Other Operating Systems should automatically use their own inbuilt CDC-ACM drivers.
82 *
83 * \section Sec_HostApp Host Controller Application
84 *
85 * This bootloader is compatible with the open source application AVRDUDE, Atmel's AVRPROG, or other
86 * applications implementing the AVR109 protocol, which is documented on the Atmel website as an application
87 * note.
88 *
89 * \subsection SSec_AVRDude AVRDUDE (Windows, Mac, Linux)
90 *
91 * AVRDude is a free, cross-platform and open source command line programmer for Atmel and third party AVR
92 * programmers. It is available on the the Windows platform as part of the "WinAVR" package, or on other systems
93 * either from a build from the official source code, or in many distributions as a precompiled binary package.
94 *
95 * To load a new HEX file with AVRDude, specify "AVR109" as the programmer, with the allocated COM port. On Windows
96 * platforms this will be a COMx port name:
97 * \code
98 * avrdude -c AVR109 -p at90usb1287 -P COM0 -U flash:w:Mouse.hex
99 * \endcode
100 *
101 * On Linux systems, this will typically be a /dev/ttyACMx port name:
102 * \code
103 * avrdude -c AVR109 -p at90usb1287 -P /dev/ttyACM0 -U flash:w:Mouse.hex
104 * \endcode
105 *
106 * Refer to the AVRDude project documentation for additional usage instructions.
107 *
108 * \section Sec_API User Application API
109 *
110 * Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,
111 * allowing the user application to call into the bootloader at runtime to read and write FLASH data.
112 *
113 * By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the
114 * following layout:
115 *
116 * \code
117 * #define BOOTLOADER_API_TABLE_SIZE 32
118 * #define BOOTLOADER_API_TABLE_START ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
119 * #define BOOTLOADER_API_CALL(Index) (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
120 *
121 * void (*BootloaderAPI_ErasePage)(uint32_t Address) = BOOTLOADER_API_CALL(0);
122 * void (*BootloaderAPI_WritePage)(uint32_t Address) = BOOTLOADER_API_CALL(1);
123 * void (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
124 * uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_CALL(3);
125 * uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address) = BOOTLOADER_API_CALL(4);
126 * uint8_t (*BootloaderAPI_ReadLock)(void) = BOOTLOADER_API_CALL(5);
127 * void (*BootloaderAPI_WriteLock)(uint8_t LockBits) = BOOTLOADER_API_CALL(6);
128 *
129 * #define BOOTLOADER_MAGIC_SIGNATURE_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
130 * #define BOOTLOADER_MAGIC_SIGNATURE 0xDCFB
131 *
132 * #define BOOTLOADER_CLASS_SIGNATURE_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
133 * #define BOOTLOADER_CDC_SIGNATURE 0xDF00
134 *
135 * #define BOOTLOADER_ADDRESS_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
136 * #define BOOTLOADER_ADDRESS_LENGTH 4
137 * \endcode
138 *
139 * From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address
140 * \c BOOTLOADER_MAGIC_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader
141 * can be determined by reading the FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them
142 * to the value \c BOOTLOADER_CDC_SIGNATURE. The start address of the bootloader can be retrieved by reading the bytes of FLASH
143 * memory starting from address \c BOOTLOADER_ADDRESS_START.
144 *
145 * \subsection SSec_API_MemLayout Device Memory Map
146 * The following illustration indicates the final memory map of the device when loaded with the bootloader.
147 *
148 * \verbatim
149 * +----------------------------+ 0x0000
150 * | |
151 * | |
152 * | |
153 * | |
154 * | |
155 * | |
156 * | |
157 * | |
158 * | User Application |
159 * | |
160 * | |
161 * | |
162 * | |
163 * | |
164 * | |
165 * | |
166 * +----------------------------+ FLASHEND - BOOT_SECTION_SIZE
167 * | |
168 * | Bootloader Application |
169 * | (Not User App. Accessible) |
170 * | |
171 * +----------------------------+ FLASHEND - 96
172 * | API Table Trampolines |
173 * | (Not User App. Accessible) |
174 * +----------------------------+ FLASHEND - 32
175 * | Bootloader API Table |
176 * | (User App. Accessible) |
177 * +----------------------------+ FLASHEND - 8
178 * | Bootloader ID Constants |
179 * | (User App. Accessible) |
180 * +----------------------------+ FLASHEND
181 * \endverbatim
182 *
183 * \section Sec_KnownIssues Known Issues:
184 *
185 * \par On Linux machines, the CDC bootloader is unstable or inaccessible.
186 * A change to the \c ModemManager module in many Linux distributions causes
187 * this module to try to take control over inserted CDC devices, corrupting the
188 * datastream. A UDEV rule is required to prevent this.
189 * See <a href=https://groups.google.com/d/msg/lufa-support/CP9cy2bc8yo/kBqsOu-RBeMJ>here</a> for resolution steps.
190 * If the issue still persists then uninstall modemmanager by executing <tt>sudo apt-get remove modemmanager</tt>, or
191 * the equivalent using your chosen distribution's package manager.
192 *
193 * \par On Linux machines, the CDC bootloader is inaccessible.
194 * On many Linux systems, non-root users do not have automatic access to newly
195 * inserted CDC devices. Root privileges or a UDEV rule is required to gain
196 * access.
197 * See <a href=https://groups.google.com/d/msg/lufa-support/CP9cy2bc8yo/kBqsOu-RBeMJ>here</a> for resolution steps.
198 *
199 * \par After loading an application, it is not run automatically on startup.
200 * Some USB AVR boards ship with the BOOTRST fuse set, causing the bootloader
201 * to run automatically when the device is reset. In most cases, the BOOTRST
202 * fuse should be disabled and the HWBE fuse used instead to run the bootloader
203 * when needed.
204 *
205 * \section Sec_Options Project Options
206 *
207 * The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
208 *
209 * <table>
210 * <tr>
211 * <th><b>Define Name:</b></th>
212 * <th><b>Location:</b></th>
213 * <th><b>Description:</b></th>
214 * </tr>
215 * <tr>
216 * <td>NO_BLOCK_SUPPORT</td>
217 * <td>AppConfig.h</td>
218 * <td>Define to disable memory block read/write support in the bootloader, requiring all reads and writes to be made
219 * using the byte-level commands.</td>
220 * </tr>
221 * <tr>
222 * <td>NO_EEPROM_BYTE_SUPPORT</td>
223 * <td>AppConfig.h</td>
224 * <td>Define to disable EEPROM memory byte read/write support in the bootloader, requiring all EEPROM reads and writes
225 * to be made using the block-level commands.</td>
226 * </tr>
227 * <tr>
228 * <td>NO_FLASH_BYTE_SUPPORT</td>
229 * <td>AppConfig.h</td>
230 * <td>Define to disable FLASH memory byte read/write support in the bootloader, requiring all FLASH reads and writes
231 * to be made using the block-level commands.</td>
232 * </tr>
233 * <tr>
234 * <td>NO_LOCK_BYTE_WRITE_SUPPORT</td>
235 * <td>AppConfig.h</td>
236 * <td>Define to disable lock byte write support in the bootloader, preventing the lock bits from being set programmatically.</td>
237 * </tr>
238 * </table>
239 */
240
Imprint / Impressum