diff options
author | Dean Camera <dean@fourwalledcubicle.com> | 2014-07-15 22:02:19 +1000 |
---|---|---|
committer | Dean Camera <dean@fourwalledcubicle.com> | 2014-07-15 22:02:19 +1000 |
commit | 0c15a451280d2ff2b2fd962b4c3f9fc4812d3cbf (patch) | |
tree | 9b7a33f1368d76373ff19b1337404681745bc153 /Bootloaders | |
parent | d90ef9aa2f97a5f8b5fd2cf0bd9564025d069f6e (diff) | |
download | lufa-0c15a451280d2ff2b2fd962b4c3f9fc4812d3cbf.tar.gz lufa-0c15a451280d2ff2b2fd962b4c3f9fc4812d3cbf.tar.bz2 lufa-0c15a451280d2ff2b2fd962b4c3f9fc4812d3cbf.zip |
Update bootloader documentation to include execution instructions.
Diffstat (limited to 'Bootloaders')
-rw-r--r-- | Bootloaders/CDC/BootloaderCDC.txt | 16 | ||||
-rw-r--r-- | Bootloaders/DFU/BootloaderDFU.txt | 16 | ||||
-rw-r--r-- | Bootloaders/HID/BootloaderHID.txt | 6 | ||||
-rw-r--r-- | Bootloaders/MassStorage/BootloaderMassStorage.txt | 16 | ||||
-rw-r--r-- | Bootloaders/Printer/BootloaderPrinter.txt | 6 |
5 files changed, 60 insertions, 0 deletions
diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt index 1e054de45..55e5e55a4 100644 --- a/Bootloaders/CDC/BootloaderCDC.txt +++ b/Bootloaders/CDC/BootloaderCDC.txt @@ -57,6 +57,22 @@ * \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 HWB mechanism of the USB AVRs; ground the HWB pin (see device + * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST + * fuse is cleared. + * + * For board specific exceptions to the above, see below. + * + * \subsection SSec_XPLAIN Atmel Xplain Board + * Ground the USB AVR JTAG's \c TCK pin to ground when powering on the board to start the bootloader. This assumes the + * \c HWBE fuse is cleared and the \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * + * \subsection SSec_Leonardo Arduino Leonardo Board + * Ground \c IO13 when powering the board to start the bootloader. This assumes the \c HWBE fuse is cleared and the + * \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * * \section Sec_Installation Driver Installation * * After running this bootloader for the first time on a new computer, you will need to supply the .INF diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index b6ba45553..e63bcc1f0 100644 --- a/Bootloaders/DFU/BootloaderDFU.txt +++ b/Bootloaders/DFU/BootloaderDFU.txt @@ -55,6 +55,22 @@ * 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_Running Running the Bootloader + * + * This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device + * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST + * fuse is cleared. + * + * For board specific exceptions to the above, see below. + * + * \subsection SSec_XPLAIN Atmel Xplain Board + * Ground the USB AVR JTAG's \c TCK pin to ground when powering on the board to start the bootloader. This assumes the + * \c HWBE fuse is cleared and the \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * + * \subsection SSec_Leonardo Arduino Leonardo Board + * Ground \c IO13 when powering the board to start the bootloader. This assumes the \c HWBE fuse is cleared and the + * \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * * \section Sec_Installation Driver Installation * * This bootloader is designed to be compatible with Atmel's provided Windows DFU class drivers. You will need to diff --git a/Bootloaders/HID/BootloaderHID.txt b/Bootloaders/HID/BootloaderHID.txt index 8f26f34d5..63c1505cc 100644 --- a/Bootloaders/HID/BootloaderHID.txt +++ b/Bootloaders/HID/BootloaderHID.txt @@ -59,6 +59,12 @@ * \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 HWB mechanism of the USB AVRs; ground the HWB pin (see device + * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST + * fuse is cleared. + * * \section Sec_Installation Driver Installation * * This bootloader uses the HID class driver inbuilt into all modern operating systems, thus no additional drivers diff --git a/Bootloaders/MassStorage/BootloaderMassStorage.txt b/Bootloaders/MassStorage/BootloaderMassStorage.txt index 493f43ca7..e09484793 100644 --- a/Bootloaders/MassStorage/BootloaderMassStorage.txt +++ b/Bootloaders/MassStorage/BootloaderMassStorage.txt @@ -60,6 +60,22 @@ * \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 HWB mechanism of the USB AVRs; ground the HWB pin (see device + * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST + * fuse is cleared. + * + * For board specific exceptions to the above, see below. + * + * \subsection SSec_XPLAIN Atmel Xplain Board + * Ground the USB AVR JTAG's \c TCK pin to ground when powering on the board to start the bootloader. This assumes the + * \c HWBE fuse is cleared and the \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * + * \subsection SSec_Leonardo Arduino Leonardo Board + * Ground \c IO13 when powering the board to start the bootloader. This assumes the \c HWBE fuse is cleared and the + * \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board. + * * \section Sec_Installation Driver Installation * * This bootloader uses the Mass Storage drivers inbuilt into all modern operating systems, thus no additional diff --git a/Bootloaders/Printer/BootloaderPrinter.txt b/Bootloaders/Printer/BootloaderPrinter.txt index 71e9b2871..cfa51d4cf 100644 --- a/Bootloaders/Printer/BootloaderPrinter.txt +++ b/Bootloaders/Printer/BootloaderPrinter.txt @@ -54,6 +54,12 @@ * 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_Running Running the Bootloader + * + * This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device + * datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST + * fuse is cleared. + * * \section Sec_Installation Driver Installation * * This bootloader uses the Generic Text-Only printer drivers inbuilt into all modern operating systems, thus no |