diff options
Diffstat (limited to 'Bootloaders')
| -rw-r--r-- | Bootloaders/CDC/BootloaderCDC.txt | 38 | ||||
| -rw-r--r-- | Bootloaders/DFU/BootloaderDFU.txt | 69 | ||||
| -rw-r--r-- | Bootloaders/TeensyHID/TeensyHID.h | 4 | ||||
| -rw-r--r-- | Bootloaders/TeensyHID/TeensyHID.txt | 36 |
4 files changed, 104 insertions, 43 deletions
diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt index cb6f9f01f..1f8970d57 100644 --- a/Bootloaders/CDC/BootloaderCDC.txt +++ b/Bootloaders/CDC/BootloaderCDC.txt @@ -5,15 +5,10 @@ */
/** \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.
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -37,4 +32,27 @@ * <td>Full Speed Mode</td>
* </tr>
* </table>
- */
+ *
+ * \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>
+ * <td>
+ * None
+ * </td>
+ * </tr>
+ * </table>
+ */
\ No newline at end of file diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index 091ce4083..7107cc123 100644 --- a/Bootloaders/DFU/BootloaderDFU.txt +++ b/Bootloaders/DFU/BootloaderDFU.txt @@ -5,27 +5,10 @@ */
/** \mainpage DFU Class USB AVR Bootloader
- *
- * This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
- * software to load firmware onto the AVR.
- *
- * This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's
- * DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader.
- *
- * As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
- * software, available for download at http://sourceforge.net/projects/dfu-programmer/.
- *
- * If SECURE_MODE is defined as true, upon startup the bootloader will be locked, with only the chip erase
- * function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
- * are usable on startup without the prerequisite firmware erase.
- *
- * Out of the box this bootloader builds for the USB1287, and should 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.
- *
- * <b>NOTE:</b> This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader
- * drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
- * manually change them in Descriptors.c and alter your driver's INF file accordingly.
+ *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
*
* <table>
* <tr>
@@ -49,4 +32,46 @@ * <td>Full Speed Mode</td>
* </tr>
* </table>
- */
+ *
+ * \section SSec_Description Project Description:
+ *
+ * This bootloader enumerates to the host as a DFU Class device, allowing for DFU-compatible programming
+ * software to load firmware onto the AVR.
+ *
+ * This bootloader is compatible with Atmel's FLIP application. However, it requires the use of Atmel's
+ * DFU drivers. You will need to install Atmel's DFU drivers prior to using this bootloader.
+ *
+ * As an open-source option, this bootloader is also compatible with the Linux Atmel USB DFU Programmer
+ * software, available for download at http://sourceforge.net/projects/dfu-programmer/.
+ *
+ * If SECURE_MODE is defined as true, upon startup the bootloader will be locked, with only the chip erase
+ * function available (similar to Atmel's DFU bootloader). If SECURE_MODE is defined as false, all functions
+ * are usable on startup without the prerequisite firmware erase.
+ *
+ * Out of the box this bootloader builds for the USB1287, and should 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.
+ *
+ * <b>NOTE:</b> This device spoofs Atmel's DFU Bootloader USB VID and PID so that the Atmel DFU bootloader
+ * drivers included with FLIP will work. If you do not wish to use Atmel's ID codes, please
+ * manually change them in Descriptors.c and alter your driver's INF file accordingly.
+ *
+ * \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><b>Define Name:</b></td>
+ * <td><b>Location:</b></td>
+ * <td><b>Description:</b></td>
+ * </tr>
+ * <tr>
+ * <td>SECURE_MODE</td>
+ * <td>BootloaderDFU.h</td>
+ * <td>If defined to true, the bootloader will not accept any memory commands other than a chip erase on statup, until an
+ * erase has been perfomed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
+ * being dumped by unauthorized persons.</td>
+ * </tr>
+ * </table>
+ */
\ No newline at end of file diff --git a/Bootloaders/TeensyHID/TeensyHID.h b/Bootloaders/TeensyHID/TeensyHID.h index a4773f8f5..ae180f778 100644 --- a/Bootloaders/TeensyHID/TeensyHID.h +++ b/Bootloaders/TeensyHID/TeensyHID.h @@ -57,9 +57,9 @@ /* Macros: */
/** HID Class specific request to send the next HID report to the device. */
- #define REQ_SetReport 0x09
+ #define REQ_SetReport 0x09
- #define TEENSY_STARTAPPLICATION 0xFFFF
+ #define TEENSY_STARTAPPLICATION 0xFFFF
/* Event Handlers: */
/** Indicates that this module will catch the USB_Disconnect event when thrown by the library. */
diff --git a/Bootloaders/TeensyHID/TeensyHID.txt b/Bootloaders/TeensyHID/TeensyHID.txt index 973819cf8..1d83510d8 100644 --- a/Bootloaders/TeensyHID/TeensyHID.txt +++ b/Bootloaders/TeensyHID/TeensyHID.txt @@ -5,15 +5,11 @@ */
/** \mainpage Teensy HID Class USB AVR Bootloader
- *
- * This bootloader enumerates to the host as a HID Class device, allowing for Teensy compatible programming
- * software to load firmware onto the AVR, such as the official software at http://www.pjrc.com/teensy/.
- *
- * Out of the box this bootloader builds for the USB162, and will fit into 2KB of bootloader space.
*
- * This spoofs (with permission) the offical Teensy bootloader's VID and PID, so that the software remains
- * compatible with no changes.
- *
+ * \section SSec_Info USB Information:
+ *
+ * The following table gives a rundown of the USB utilization of this demo.
+ *
* <table>
* <tr>
* <td><b>USB Mode:</b></td>
@@ -38,4 +34,26 @@ * <td>Full Speed Mode</td>
* </tr>
* </table>
- */
+ *
+ * \section SSec_Description Project Description:
+ *
+ * This bootloader enumerates to the host as a HID Class device, allowing for Teensy compatible programming
+ * software to load firmware onto the AVR, such as the official software at http://www.pjrc.com/teensy/.
+ *
+ * Out of the box this bootloader builds for the USB162, and will fit into 2KB of bootloader space.
+ *
+ * This spoofs (with permission) the offical Teensy bootloader's VID and PID, so that the software remains
+ * 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>
+ */
\ No newline at end of file |