tmk_core/protocol/lufa/LUFA-git/Bootloaders/Printer/BootloaderPrinter.txt

   1 /** \file
   2  *
   3  *  This file contains special DoxyGen information for the generation of the main page and other special
   4  *  documentation pages. It is not a project source file.
   5  */
   6
   7 /** \mainpage Printer Class USB AVR Bootloader
   8  *
   9  *  \section Sec_Compat Demo Compatibility:
  10  *
  11  *  The following list indicates what microcontrollers are compatible with this demo.
  12  *
  13  *  \li Series 7 USB AVRs (AT90USBxxx7)
  14  *  \li Series 6 USB AVRs (AT90USBxxx6)
  15  *  \li Series 4 USB AVRs (ATMEGAxxU4)
  16  *  \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
  17  *
  18  *  \section Sec_Info USB Information:
  19  *
  20  *  The following table gives a rundown of the USB utilization of this demo.
  21  *
  22  *  <table>
  23  *   <tr>
  24  *    <td><b>USB Mode:</b></td>
  25  *    <td>Device</td>
  26  *   </tr>
  27  *   <tr>
  28  *    <td><b>USB Class:</b></td>
  29  *    <td>Printer Class</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>Printer Subclass</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF Printer Class Standard</td>
  38  *   </tr>
  39  *   <tr>
  40  *    <td><b>Supported USB Speeds:</b></td>
  41  *    <td>Full Speed Mode</td>
  42  *   </tr>
  43  *  </table>
  44  *
  45  *  \section Sec_Description Project Description:
  46  *
  47  *  This bootloader enumerates to the host as a Generic Text Only Printer device, capable of reading and parsing
  48  *  "printed" plain-text Intel HEX files to load firmware onto the AVR.
  49  *
  50  *  Out of the box this bootloader builds for the AT90USB1287 with an 8KB bootloader section size, and will fit
  51  *  into 4KB of bootloader space. If you wish to alter this size and/or change the AVR model, you will need to
  52  *  edit the MCU, FLASH_SIZE_KB and BOOT_SECTION_SIZE_KB values in the accompanying makefile.
  53  *
  54  *  When the bootloader is running, the board's LED(s) will flash at regular intervals to distinguish the
  55  *  bootloader from the normal user application.
  56  *
  57  *  \section Sec_Running Running the Bootloader
  58  *
  59  *  This bootloader is designed to be started via the HWB mechanism of the USB AVRs; ground the HWB pin (see device
  60  *  datasheet) then momentarily ground /RESET to start the bootloader. This assumes the HWBE fuse is set and the BOOTRST
  61  *  fuse is cleared.
  62  *
  63  *  \section Sec_Installation Driver Installation
  64  *
  65  *  This bootloader uses the Generic Text-Only printer drivers inbuilt into all modern operating systems, thus no
  66  *  additional drivers need to be supplied for correct operation.
  67  *
  68  *  \section Sec_HostApp Host Controller Application
  69  *
  70  *  This bootloader is compatible with Notepad under Windows, and the command line \c lpr utility under Linux.
  71  *
  72  *  \subsection SSec_Notepad Notepad (Windows)
  73  *
  74  *  While most text applications under Windows will be compatible with the bootloader, the inbuilt Notepad utility
  75  *  is recommended as it will introduce minimal formatting changes to the output stream. To program with Notepad,
  76  *  open the target HEX file and print it to the Generic Text Only printer device the bootloader creates.
  77  *
  78  *  \subsection SSec_LPR LPR (Linux)
  79  *
  80  *  While the CUPS framework under Linux will enumerate the bootloader as a Generic Text-Only printer, many
  81  *  applications will refuse to print to the device due to the lack of rich formatting options available. As a result,
  82  *  under Linux HEX files must be printed via the low level \c lpr utility instead.
  83  *
  84  *  \code
  85  *  cat Mouse.hex | lpr
  86  *  \endcode
  87  *
  88  *  \section Sec_API User Application API
  89  *
  90  *  Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,
  91  *  allowing the user application to call into the bootloader at runtime to read and write FLASH data.
  92  *
  93  *  By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the
  94  *  following layout:
  95  *
  96  *  \code
  97  *  #define BOOTLOADER_API_TABLE_SIZE          32
  98  *  #define BOOTLOADER_API_TABLE_START         ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
  99  *  #define BOOTLOADER_API_CALL(Index)         (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
 100  *
 101  *  void    (*BootloaderAPI_ErasePage)(uint32_t Address)               = BOOTLOADER_API_CALL(0);
 102  *  void    (*BootloaderAPI_WritePage)(uint32_t Address)               = BOOTLOADER_API_CALL(1);
 103  *  void    (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
 104  *  uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address)           = BOOTLOADER_API_CALL(3);
 105  *  uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address)                = BOOTLOADER_API_CALL(4);
 106  *  uint8_t (*BootloaderAPI_ReadLock)(void)                            = BOOTLOADER_API_CALL(5);
 107  *  void    (*BootloaderAPI_WriteLock)(uint8_t LockBits)               = BOOTLOADER_API_CALL(6);
 108  *
 109  *  #define BOOTLOADER_MAGIC_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
 110  *  #define BOOTLOADER_MAGIC_SIGNATURE         0xDCFB
 111  *
 112  *  #define BOOTLOADER_CLASS_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
 113  *  #define BOOTLOADER_PRINTER_SIGNATURE       0xDF20
 114  *
 115  *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
 116  *  #define BOOTLOADER_ADDRESS_LENGTH          4
 117  *  \endcode
 118  *
 119  *  From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address
 120  *  \c BOOTLOADER_MAGIC_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader
 121  *  can be determined by reading the FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them
 122  *  to the value \c BOOTLOADER_PRINTER_SIGNATURE. The start address of the bootloader can be retrieved by reading the bytes of FLASH
 123  *  memory starting from address \c BOOTLOADER_ADDRESS_START.
 124  *
 125  *  \subsection SSec_API_MemLayout Device Memory Map
 126  *  The following illustration indicates the final memory map of the device when loaded with the bootloader.
 127  *
 128  *  \verbatim
 129  *  +----------------------------+ 0x0000
 130  *  |                            |
 131  *  |                            |
 132  *  |                            |
 133  *  |                            |
 134  *  |                            |
 135  *  |                            |
 136  *  |                            |
 137  *  |                            |
 138  *  |      User Application      |
 139  *  |                            |
 140  *  |                            |
 141  *  |                            |
 142  *  |                            |
 143  *  |                            |
 144  *  |                            |
 145  *  |                            |
 146  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE
 147  *  |                            |
 148  *  |   Bootloader Application   |
 149  *  | (Not User App. Accessible) |
 150  *  |                            |
 151  *  +----------------------------+ FLASHEND - 96
 152  *  |   API Table Trampolines    |
 153  *  | (Not User App. Accessible) |
 154  *  +----------------------------+ FLASHEND - 32
 155  *  |    Bootloader API Table    |
 156  *  |   (User App. Accessible)   |
 157  *  +----------------------------+ FLASHEND - 8
 158  *  |   Bootloader ID Constants  |
 159  *  |   (User App. Accessible)   |
 160  *  +----------------------------+ FLASHEND
 161  *  \endverbatim
 162  *
 163  *
 164  *  \section Sec_KnownIssues Known Issues:
 165  *
 166  *  \par On Linux machines, new firmware fails to be sent to the device via CUPS.
 167  *  Only a limited subset of normal printer functionality is exposed via the
 168  *  bootloader, causing CUPS to reject print requests from applications that
 169  *  are unable to handle true plain-text printing. For best results, the low
 170  *  level \c lpr command should be used to print new firmware to the bootloader.
 171  *
 172  *  \par After loading an application, it is not run automatically on startup.
 173  *  Some USB AVR boards ship with the BOOTRST fuse set, causing the bootloader
 174  *  to run automatically when the device is reset. In most cases, the BOOTRST
 175  *  fuse should be disabled and the HWBE fuse used instead to run the bootloader
 176  *  when needed.
 177  *
 178  *  \section Sec_Options Project Options
 179  *
 180  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 181  *
 182  *  <table>
 183  *   <tr>
 184  *    <td>
 185  *     None
 186  *    </td>
 187  *   </tr>
 188  *  </table>
 189  */
 190