aboutsummaryrefslogtreecommitdiffstats
path: root/Bootloaders/HID/BootloaderHID.txt
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-06-02 13:40:53 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-06-02 13:40:53 +0000
commitc2135f2776e01842a775502c24b59d9169ffa851 (patch)
tree301f86b2f95fdbbd406260a16940ab725f3227fd /Bootloaders/HID/BootloaderHID.txt
parentf01a05415c03b0dd61297849ece2cfcce7f8d3e8 (diff)
downloadlufa-c2135f2776e01842a775502c24b59d9169ffa851.tar.gz
lufa-c2135f2776e01842a775502c24b59d9169ffa851.tar.bz2
lufa-c2135f2776e01842a775502c24b59d9169ffa851.zip
Expand the documentation for each Bootloader to give sample usage instructions for the command line programmer utilities.
Fix typo in the HID class bootloader CLI programmer application usage instructions.
Diffstat (limited to 'Bootloaders/HID/BootloaderHID.txt')
-rw-r--r--Bootloaders/HID/BootloaderHID.txt22
1 files changed, 20 insertions, 2 deletions
diff --git a/Bootloaders/HID/BootloaderHID.txt b/Bootloaders/HID/BootloaderHID.txt
index 51dceb831..d69582212 100644
--- a/Bootloaders/HID/BootloaderHID.txt
+++ b/Bootloaders/HID/BootloaderHID.txt
@@ -48,14 +48,32 @@
*
* 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 delibertely non-compatible with the properietary HalfKay
- * bootloader GUI; only the command line interface software accompanying this bootloader will work with it.
+ * 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.