aboutsummaryrefslogtreecommitdiffstats
path: root/Bootloaders/CDC/BootloaderCDC.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2009-02-23 07:08:15 +0000
committerDean Camera <dean@fourwalledcubicle.com>2009-02-23 07:08:15 +0000
commitc1a1b6eeecb375259968ef6d989833312047f2d8 (patch)
tree28cf3939723d2282b997d5b59ea15b4dded1c69f /Bootloaders/CDC/BootloaderCDC.txt
parent4bc7e909f9c77c81971d3afba6e392c322d617b7 (diff)
downloadlufa-c1a1b6eeecb375259968ef6d989833312047f2d8.tar.gz
lufa-c1a1b6eeecb375259968ef6d989833312047f2d8.tar.bz2
lufa-c1a1b6eeecb375259968ef6d989833312047f2d8.zip
Moved all source to the trunk directory.
Diffstat (limited to 'Bootloaders/CDC/BootloaderCDC.txt')
-rw-r--r--Bootloaders/CDC/BootloaderCDC.txt40
1 files changed, 40 insertions, 0 deletions
diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt
new file mode 100644
index 000000000..cb6f9f01f
--- /dev/null
+++ b/Bootloaders/CDC/BootloaderCDC.txt
@@ -0,0 +1,40 @@
+/** \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
+ *
+ * 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.
+ *
+ * <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>
+ */