forked from mfulz_github/qmk_firmware
Add documentation to the Printer class bootloader, add LED flash when the bootloader is active.
This commit is contained in:
Dean Camera
parent
041bdf8954
commit
0c40ef8897
|
|
@ -297,6 +297,16 @@ void SetupHardware(void)
|
||||||
/* Hardware Initialization */
|
/* Hardware Initialization */
|
||||||
LEDs_Init();
|
LEDs_Init();
|
||||||
USB_Init();
|
USB_Init();
|
||||||
|
|
||||||
|
/* Bootloader active LED toggle timer initialization */
|
||||||
|
TIMSK1 = (1 << TOIE1);
|
||||||
|
TCCR1B = ((1 << CS11) | (1 << CS10));
|
||||||
|
}
|
||||||
|
|
||||||
|
/** ISR to periodically toggle the LEDs on the board to indicate that the bootloader is active. */
|
||||||
|
ISR(TIMER1_OVF_vect, ISR_BLOCK)
|
||||||
|
{
|
||||||
|
LEDs_ToggleLEDs(LEDS_LED1 | LEDS_LED2);
|
||||||
}
|
}
|
||||||
|
|
||||||
/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
|
/** Event handler for the USB_Connect event. This indicates that the device is enumerating via the status LEDs. */
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,169 @@
|
||||||
|
/** \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 Printer Class USB AVR Bootloader
|
||||||
|
*
|
||||||
|
* \section Sec_Compat Demo Compatibility:
|
||||||
|
*
|
||||||
|
* The following list indicates what microcontrollers are compatible with this demo.
|
||||||
|
*
|
||||||
|
* \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 Sec_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>Printer Class</td>
|
||||||
|
* </tr>
|
||||||
|
* <tr>
|
||||||
|
* <td><b>USB Subclass:</b></td>
|
||||||
|
* <td>Printer Subclass</td>
|
||||||
|
* </tr>
|
||||||
|
* <tr>
|
||||||
|
* <td><b>Relevant Standards:</b></td>
|
||||||
|
* <td>USBIF Printer Class Standard</td>
|
||||||
|
* </tr>
|
||||||
|
* <tr>
|
||||||
|
* <td><b>Supported USB Speeds:</b></td>
|
||||||
|
* <td>Full Speed Mode</td>
|
||||||
|
* </tr>
|
||||||
|
* </table>
|
||||||
|
*
|
||||||
|
* \section Sec_Description Project Description:
|
||||||
|
*
|
||||||
|
* This bootloader enumerates to the host as a Generic Text Only Printer device, capable of reading and parsing
|
||||||
|
* "printed" plain-text Intel HEX files to load firmware onto the AVR.
|
||||||
|
*
|
||||||
|
* Out of the box this bootloader builds for the AT90USB1287 with an 8KB bootloader section size, and will fit
|
||||||
|
* into 4KB of bootloader space. 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.
|
||||||
|
*
|
||||||
|
* 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
|
||||||
|
*
|
||||||
|
* This bootloader uses the Generic Text-Only printer drivers inbuilt into all modern operating systems, thus no
|
||||||
|
* additional drivers need to be supplied for correct operation.
|
||||||
|
*
|
||||||
|
* \section Sec_HostApp Host Controller Application
|
||||||
|
*
|
||||||
|
* This bootloader is compatible with Notepad under Windows, and the command line \c lpr utility under Linux.
|
||||||
|
*
|
||||||
|
* \subsection SSec_Notepad Notepad (Windows)
|
||||||
|
*
|
||||||
|
* While most text applications under Windows will be compatible with the bootloader, the inbuilt Notepad utility
|
||||||
|
* is recommended as it will introduce minimal formatting changes to the output stream. To program with Notepad,
|
||||||
|
* open the target HEX file and print it to the Generic Text Only printer device the bootloader creates.
|
||||||
|
*
|
||||||
|
* \subsection SSec_LPR LPR (Linux)
|
||||||
|
*
|
||||||
|
* While the CUPS framework under Linux will enumerate the bootloader as a Generic Text-Only printer, many
|
||||||
|
* applications will refuse to print to the device due to the lack of rich formatting options available. As a result,
|
||||||
|
* under Linux HEX files must be printed via the low level \c lpr utility instead.
|
||||||
|
*
|
||||||
|
* \code
|
||||||
|
* cat Mouse.hex | lpr
|
||||||
|
* \endcode
|
||||||
|
*
|
||||||
|
* \section Sec_API User Application API
|
||||||
|
*
|
||||||
|
* Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,
|
||||||
|
* allowing the user application to call into the bootloader at runtime to read and write FLASH data.
|
||||||
|
*
|
||||||
|
* By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the
|
||||||
|
* following layout:
|
||||||
|
*
|
||||||
|
* \code
|
||||||
|
* #define BOOTLOADER_API_TABLE_SIZE 32
|
||||||
|
* #define BOOTLOADER_API_TABLE_START ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
|
||||||
|
* #define BOOTLOADER_API_CALL(Index) (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
|
||||||
|
*
|
||||||
|
* void (*BootloaderAPI_ErasePage)(uint32_t Address) = BOOTLOADER_API_CALL(0);
|
||||||
|
* void (*BootloaderAPI_WritePage)(uint32_t Address) = BOOTLOADER_API_CALL(1);
|
||||||
|
* void (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
|
||||||
|
* uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_CALL(3);
|
||||||
|
* uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address) = BOOTLOADER_API_CALL(4);
|
||||||
|
* uint8_t (*BootloaderAPI_ReadLock)(void) = BOOTLOADER_API_CALL(5);
|
||||||
|
* void (*BootloaderAPI_WriteLock)(uint8_t LockBits) = BOOTLOADER_API_CALL(6);
|
||||||
|
*
|
||||||
|
* #define BOOTLOADER_MAGIC_SIGNATURE_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
|
||||||
|
* #define BOOTLOADER_MAGIC_SIGNATURE 0xDCFB
|
||||||
|
*
|
||||||
|
* #define BOOTLOADER_CLASS_SIGNATURE_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
|
||||||
|
* #define BOOTLOADER_CDC_SIGNATURE 0xCDC1
|
||||||
|
*
|
||||||
|
* #define BOOTLOADER_ADDRESS_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
|
||||||
|
* #define BOOTLOADER_ADDRESS_LENGTH 4
|
||||||
|
* \endcode
|
||||||
|
*
|
||||||
|
* \subsection SSec_API_MemLayout Device Memory Map
|
||||||
|
* The following illustration indicates the final memory map of the device when loaded with the bootloader.
|
||||||
|
*
|
||||||
|
* \verbatim
|
||||||
|
* +----------------------------+ 0x0000
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | User Application |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* | |
|
||||||
|
* +----------------------------+ FLASHEND - BOOT_SECTION_SIZE
|
||||||
|
* | |
|
||||||
|
* | Bootloader Application |
|
||||||
|
* | (Not User App. Accessible) |
|
||||||
|
* | |
|
||||||
|
* +----------------------------+ FLASHEND - 96
|
||||||
|
* | API Table Trampolines |
|
||||||
|
* | (Not User App. Accessible) |
|
||||||
|
* +----------------------------+ FLASHEND - 32
|
||||||
|
* | Bootloader API Table |
|
||||||
|
* | (User App. Accessible) |
|
||||||
|
* +----------------------------+ FLASHEND - 8
|
||||||
|
* | Bootloader ID Constants |
|
||||||
|
* | (User App. Accessible) |
|
||||||
|
* +----------------------------+ FLASHEND
|
||||||
|
* \endverbatim
|
||||||
|
*
|
||||||
|
* Bootloaders reporting a device release revision number of 1.00 or greater are bootloader API enabled. From the application
|
||||||
|
* the API support of the bootloader can be detected by reading the FLASH memory bytes located at address \c BOOTLOADER_MAGIC_SIGNATURE_START
|
||||||
|
* and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader can be determined by reading the
|
||||||
|
* FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them to the value \c BOOTLOADER_CDC_SIGNATURE.
|
||||||
|
* The start address of the bootloader can be retrieved by reading the bytes of FLASH memory starting from address \c BOOTLOADER_ADDRESS_START.
|
||||||
|
*
|
||||||
|
* \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.
|
||||||
|
*
|
||||||
|
* <table>
|
||||||
|
* <tr>
|
||||||
|
* <td>
|
||||||
|
* None
|
||||||
|
* </td>
|
||||||
|
* </tr>
|
||||||
|
* </table>
|
||||||
|
*/
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue