Tighten up the implementations of the USB_Device_SetDeviceAddress(), USB_Controller_R...

[pub/lufa.git] / Bootloaders / CDC / BootloaderCDC.txt

diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt
index 81e454d..4e5b3c5 100644 (file)
--- a/Bootloaders/CDC/BootloaderCDC.txt
+++ b/Bootloaders/CDC/BootloaderCDC.txt
@@ -51,13 +51,41 @@
  *  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.
+ *  When the bootloader is running, the board's LED(s) will flash at regular intervals to distinguish the
+ *  bootloader from the normal user application.
+ *
+ *  \section Sec_Installation Driver Installation
  *
  *  After running this bootloader for the first time on a new computer, you will need to supply the .INF
  *  file located in this bootloader project's directory as the device's driver when running under Windows.
  *  This will enable Windows to use its inbuilt CDC drivers, negating the need for custom drivers for the
  *  device. Other Operating Systems should automatically use their own inbuilt CDC-ACM drivers.
  *
+ *  \section Sec_HostApp Host Controller Application
+ *
+ *  This bootloader is compatible with the open source application AVRDUDE, Atmel's AVRPROG, or other
+ *  applications implementing the AVR109 protocol, which is documented on the Atmel website as an application
+ *  note.
+ *
+ *  \subsection SSec_AVRDude AVRDUDE (Windows, Mac, Linux)
+ *
+ *  AVRDude is a free, cross-platform and open source command line programmer for Atmel and third party AVR
+ *  programmers. It is available on the the Windows platform as part of the "WinAVR" package, or on other systems
+ *  either from a build from the official source code, or in many distributions as a precompiled binary package.
+ *
+ *  To load a new HEX file with AVRDude, specify "AVR109" as the programmer, with the allocated COM port. On Windows
+ *  platforms this will be a COMx port name:
+ *  \code
+ *  avrdude -c AVR109 -p at90usb1287 -P COM0 -U flash:w:Mouse.hex
+ *  \endcode
+ *
+ *  On Linux systems, this will typically be a /dev/ttyACMx port name:
+ *  \code
+ *  avrdude -c AVR109 -p at90usb1287 -P /dev/ttyACM0 -U flash:w:Mouse.hex
+ *  \endcode
+ *
+ *  Refer to the AVRDude project documentation for additional usage instructions.
+ *
  *  \section Sec_Options Project Options
  *
  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
@@ -67,24 +95,24 @@
  *    <td>NO_BLOCK_SUPPORT</td>
  *    <td>Makefile LUFA_OPTS</td>
  *    <td>Define to disable memory block read/write support in the bootloader, requiring all reads and writes to be made
- *        using the byte-level commands.
+ *        using the byte-level commands.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_EEPROM_BYTE_SUPPORT</td>
  *    <td>Makefile LUFA_OPTS</td>
  *    <td>Define to disable EEPROM memory byte read/write support in the bootloader, requiring all EEPROM reads and writes
- *        to be made using the block-level commands.
+ *        to be made using the block-level commands.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_FLASH_BYTE_SUPPORT</td>
  *    <td>Makefile LUFA_OPTS</td>
  *    <td>Define to disable FLASH memory byte read/write support in the bootloader, requiring all FLASH reads and writes
- *        to be made using the block-level commands.
+ *        to be made using the block-level commands.</td>
  *   </tr>
  *   <tr>
  *    <td>NO_LOCK_BYTE_WRITE_SUPPORT</td>
  *    <td>Makefile LUFA_OPTS</td>
- *    <td>Define to disable lock byte write support in the bootloader, preventing the lock bits from being set progmatically.
+ *    <td>Define to disable lock byte write support in the bootloader, preventing the lock bits from being set programmatically.</td>
  *   </tr>
  *  </table>
  */