diff options
| author | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2011-09-13 08:21:07 +0000 |
|---|---|---|
| committer | Dean <Dean@d5102386-fcda-11dd-9fdb-3debd5008f28> | 2011-09-13 08:21:07 +0000 |
| commit | 2b1f6dd63e3a9ae5ed2ab9d4aeabd60eab7c6c10 (patch) | |
| tree | 858ff1ca8b6781ea8f53ecc55881701602784991 /Bootloaders/HID/BootloaderHID.txt | |
| parent | 44e3311de4c0d12b228bce55edc4ceff690d4f91 (diff) | |
Commit LUFA-111009-QA tag for QA testing before moving into beta phase.LUFA-111009-QA
git-svn-id: http://lufa-lib.googlecode.com/svn/tags/LUFA-111009-QA@1923 d5102386-fcda-11dd-9fdb-3debd5008f28
Diffstat (limited to 'Bootloaders/HID/BootloaderHID.txt')
| -rw-r--r-- | Bootloaders/HID/BootloaderHID.txt | 176 |
1 files changed, 88 insertions, 88 deletions
diff --git a/Bootloaders/HID/BootloaderHID.txt b/Bootloaders/HID/BootloaderHID.txt index d6958221..a774ab48 100644 --- a/Bootloaders/HID/BootloaderHID.txt +++ b/Bootloaders/HID/BootloaderHID.txt @@ -1,88 +1,88 @@ -/** \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 HID Class USB AVR Bootloader
- *
- * \section SSec_Compat Demo Compatibility:
- *
- * The following list indicates what microcontrollers are compatible with this demo.
- *
- * - Series 7 USB AVRs (AT90USBxxx7)
- * - Series 6 USB AVRs (AT90USBxxx6)
- * - Series 4 USB AVRs (ATMEGAxxU4)
- * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
- *
- * \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>
- * <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>
- * <td>USBIF HID Class Standard \n
- * Teensy Programming Protocol Specification</td>
- * </tr>
- * <tr>
- * <td><b>Usable Speeds:</b></td>
- * <td>Low Speed Mode \n
- * Full Speed Mode</td>
- * </tr>
- * </table>
- *
- * \section SSec_Description Project Description:
- *
- * This bootloader enumerates to the host as a HID Class device, allowing for device FLASH programming through
- * the supplied command line software, which is a modified version of Paul's TeensyHID Command Line loader code
- * from PJRC (used with permission). This bootloader is deliberatley non-compatible with the properietary PJRC
- * HalfKay bootloader GUI; only the command line interface software accompanying this bootloader will work with it.
- *
- * Out of the box this bootloader builds for the USB1287, and will fit into 2KB of bootloader space for the
- * Series 2 USB AVRs (ATMEGAxxU2, AT90USBxx2) or 4KB of bootloader space for all other models. 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.
- *
- * \section Sec_Installation Driver Installation
- *
- * This bootloader uses the HID class driver inbuilt into all modern operating systems, thus no additional drivers
- * need to be supplied for correct operation.
- *
- * \section Sec_HostApp Host Controller Application
- *
- * Due to licensing issues, the supplied bootloader is compatible with the HalfKay bootloader protocol designed
- * by PJRC, but is non-compatible with the cross-platform loader GUI. A modified version of the open source
- * cross-platform TeensyLoader application is supplied, which can be compiled under most operating systems. The
- * command-line loader application should remain compatible with genuine Teensy boards in addition to boards using
- * this custom bootloader.
- *
- * Once compiled, programs can be loaded into the AVR's FLASH memory through the following example command:
- * \code
- * hid_bootloader_cli -mmcu=at90usb1287 Mouse.hex
- * \endcode
- *
- * \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>
- */
+/** \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 HID Class USB AVR Bootloader + * + * \section SSec_Compat Demo Compatibility: + * + * The following list indicates what microcontrollers are compatible with this demo. + * + * - Series 7 USB AVRs (AT90USBxxx7) + * - Series 6 USB AVRs (AT90USBxxx6) + * - Series 4 USB AVRs (ATMEGAxxU4) + * - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) + * + * \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> + * <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> + * <td>USBIF HID Class Standard \n + * Teensy Programming Protocol Specification</td> + * </tr> + * <tr> + * <td><b>Usable Speeds:</b></td> + * <td>Low Speed Mode \n + * Full Speed Mode</td> + * </tr> + * </table> + * + * \section SSec_Description Project Description: + * + * This bootloader enumerates to the host as a HID Class device, allowing for device FLASH programming through + * the supplied command line software, which is a modified version of Paul's TeensyHID Command Line loader code + * from PJRC (used with permission). This bootloader is deliberatley non-compatible with the properietary PJRC + * HalfKay bootloader GUI; only the command line interface software accompanying this bootloader will work with it. + * + * Out of the box this bootloader builds for the USB1287, and will fit into 2KB of bootloader space for the + * Series 2 USB AVRs (ATMEGAxxU2, AT90USBxx2) or 4KB of bootloader space for all other models. 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. + * + * \section Sec_Installation Driver Installation + * + * This bootloader uses the HID class driver inbuilt into all modern operating systems, thus no additional drivers + * need to be supplied for correct operation. + * + * \section Sec_HostApp Host Controller Application + * + * Due to licensing issues, the supplied bootloader is compatible with the HalfKay bootloader protocol designed + * by PJRC, but is non-compatible with the cross-platform loader GUI. A modified version of the open source + * cross-platform TeensyLoader application is supplied, which can be compiled under most operating systems. The + * command-line loader application should remain compatible with genuine Teensy boards in addition to boards using + * this custom bootloader. + * + * Once compiled, programs can be loaded into the AVR's FLASH memory through the following example command: + * \code + * hid_bootloader_cli -mmcu=at90usb1287 Mouse.hex + * \endcode + * + * \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> + */ |
