Update to latest version of DMBS.

[pub/lufa.git] / Bootloaders / HID / BootloaderHID.txt

diff --git a/Bootloaders/HID/BootloaderHID.txt b/Bootloaders/HID/BootloaderHID.txt
index d32efee..e340703 100644 (file)
--- a/Bootloaders/HID/BootloaderHID.txt
+++ b/Bootloaders/HID/BootloaderHID.txt
@@ -3,17 +3,17 @@
  *  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.
  */
  *  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.
  *
 /** \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)
+ *  \li Series 7 USB AVRs (AT90USBxxx7)
+ *  \li Series 6 USB AVRs (AT90USBxxx6)
+ *  \li Series 4 USB AVRs (ATMEGAxxU4)
+ *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)

  *
  *  \section SSec_Info USB Information:
  *
  *
  *  \section SSec_Info USB Information:
  *


@@ -28,7 +28,7 @@
  *   <td><b>USB Class:</b></td>
  *   <td>Human Interface Device Class (HID)</td>
  *  </tr>
  *   <td><b>USB Class:</b></td>
  *   <td>Human Interface Device Class (HID)</td>
  *  </tr>

- *  <tr> 
+ *  <tr>

  *   <td><b>USB Subclass:</b></td>
  *   <td>N/A</td>
  *  </tr>
  *   <td><b>USB Subclass:</b></td>
  *   <td>N/A</td>
  *  </tr>


@@ -38,23 +38,32 @@
  *       Teensy Programming Protocol Specification</td>
  *  </tr>
  *  <tr>
  *       Teensy Programming Protocol Specification</td>
  *  </tr>
  *  <tr>

- *   <td><b>Usable Speeds:</b></td>
+ *   <td><b>Supported USB Speeds:</b></td>

  *   <td>Low Speed Mode \n
  *       Full Speed Mode</td>
  *  </tr>
  * </table>
  *
  *   <td>Low Speed Mode \n
  *       Full Speed Mode</td>
  *  </tr>
  * </table>
  *

- *  \section SSec_Description Project Description: 
+ *  \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
  *
  *  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
+ *  from PJRC (used with permission). This bootloader is deliberately non-compatible with the proprietary PJRC

  *  HalfKay bootloader GUI; only the command line interface software accompanying this bootloader will work with it.
  *  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 AT90USB1287, 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 MCU, FLASH_SIZE_KB and
- *  BOOT_SECTION_SIZE_KB values in the accompanying makefile.
+ *
+ *  Out of the box this bootloader builds for the AT90USB1287 with an 8KB bootloader section size, 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 alter this size and/or change the AVR model, you will need to edit the MCU,
+ *  FLASH_SIZE_KB and BOOT_SECTION_SIZE_KB values in the accompanying makefile.
+ *
+ *  \warning <b>THIS BOOTLOADER IS NOT SECURE.</b> Malicious entities can recover written data, even if the device
+ *           lockbits are set.
+ *
+ *  \section Sec_Running Running the Bootloader
+ *
+ *  This bootloader is designed to be started via the \c HWB mechanism of the USB AVRs; ground the \c HWB pin (see device
+ *  datasheet) then momentarily ground \c /RESET to start the bootloader. This assumes the \c HWBE fuse is set and the
+ *  \c BOOTRST fuse is cleared.

  *
  *  \section Sec_Installation Driver Installation
  *
  *
  *  \section Sec_Installation Driver Installation
  *


@@ -64,7 +73,7 @@
  *  \section Sec_HostApp Host Controller Application
  *
  *  Due to licensing issues, the supplied bootloader is compatible with the HalfKay bootloader protocol designed
  *  \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
+ *  by PJRC, but is <b>not compatible with the cross-platform loader GUI</b>. 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.
  *  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.


@@ -74,6 +83,14 @@
  *  hid_bootloader_cli -mmcu=at90usb1287 Mouse.hex
  *  \endcode
  *
  *  hid_bootloader_cli -mmcu=at90usb1287 Mouse.hex
  *  \endcode
  *

+ *  \section Sec_KnownIssues Known Issues:
+ *
+ *  \par After loading an application, it is not run automatically on startup.
+ *  Some USB AVR boards ship with the \c BOOTRST fuse set, causing the bootloader
+ *  to run automatically when the device is reset. This booloader requires the
+ *  \c BOOTRST be disabled and the HWBE fuse used instead to run the bootloader
+ *  when needed.
+ *

  *  \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.
  *  \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.