Bootloaders/MassStorage/BootloaderMassStorage.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 Mass Storage 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) - <i>See \ref SSec_Aux_Space</i>
  16  *  \li ATMEGA32U2 - <i>See \ref SSec_Aux_Space</i>
  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>Mass Storage Device</td>
  30  *   </tr>
  31  *   <tr>
  32  *    <td><b>USB Subclass:</b></td>
  33  *    <td>Bulk-Only Transport</td>
  34  *   </tr>
  35  *   <tr>
  36  *    <td><b>Relevant Standards:</b></td>
  37  *    <td>USBIF Mass Storage Standard \n
  38  *        USB Bulk-Only Transport Standard \n
  39  *        SCSI Primary Commands Specification \n
  40  *        SCSI Block Commands Specification</td>
  41  *   </tr>
  42  *   <tr>
  43  *    <td><b>Supported USB Speeds:</b></td>
  44  *    <td>Full Speed Mode</td>
  45  *   </tr>
  46  *  </table>
  47  *
  48  *  \section Sec_Description Project Description:
  49  *
  50  *  This bootloader enumerates to the host as a Mass Storage device, capable of reading and writing a new binary
  51  *  firmware image file, to load firmware onto the AVR.
  52  *
  53  *  Out of the box this bootloader builds for the AT90USB1287 with an 8KB bootloader section size, and will fit
  54  *  into 6KB of bootloader space. If you wish to alter this size and/or change the AVR model, you will need to
  55  *  edit the MCU, FLASH_SIZE_KB and BOOT_SECTION_SIZE_KB values in the accompanying makefile.
  56  *
  57  *  When the bootloader is running, the board's LED(s) will flash at regular intervals to distinguish the
  58  *  bootloader from the normal user application.
  59  *
  60  *  \warning <b>THIS BOOTLOADER IS NOT SECURE.</b> Malicious entities can recover written data, even if the device
  61  *           lockbits are set.
  62  *
  63  *  \section Sec_Running Running the Bootloader
  64  *
  65  *  On the USB AVR8 devices, setting the \c HWBE device fuse will cause the bootloader to run if the \c HWB pin of
  66  *  the AVR is grounded when the device is reset.
  67  *
  68  *  The are two behaviours of this bootloader, depending on the device's fuses:
  69  *
  70  *  <b>If the device's BOOTRST fuse is set</b>, the bootloader will run any time the system is reset from
  71  *  the external reset pin, unless no valid user application has been loaded. To initiate the bootloader, the
  72  *  device's external reset pin should be grounded momentarily.
  73  *
  74  *  <b>If the device's BOOTRST fuse is not set</b>, the bootloader will run only if initiated via a software
  75  *  jump, or if the \c HWB pin was low during the last device reset (if the \c HWBE fuse is set).
  76  *
  77  *  For board specific exceptions to the above, see below.
  78  *
  79  *  \subsection SSec_XPLAIN Atmel Xplain Board
  80  *  Ground the USB AVR JTAG's \c TCK pin to ground when powering on the board to start the bootloader. This assumes the
  81  *  \c HWBE fuse is cleared and the \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board.
  82  *
  83  *  \subsection SSec_Leonardo Arduino Leonardo Board
  84  *  Ground \c IO13 when powering the board to start the bootloader. This assumes the \c HWBE fuse is cleared and the
  85  *  \c BOOTRST fuse is set as the HWBE pin is not user accessible on this board.
  86  *
  87  *  \section Sec_Installation Driver Installation
  88  *
  89  *  This bootloader uses the Mass Storage drivers inbuilt into all modern operating systems, thus no additional
  90  *  drivers need to be supplied for correct operation.
  91  *
  92  *  \section Sec_HostApp Host Controller Application
  93  *
  94  *  This bootloader is compatible with all operating systems that support the FAT12 file system format. To reprogram the
  95  *  device, overwrite a file stored on the virtual FAT filesystem with a new binary (BIN format) image. Remember to safely
  96  *  remove your device from the host using the host OS's ejection APIs, to ensure all data is correctly flushed to the
  97  *  bootloader's virtual filesystem and not cached in the OS's file system driver.
  98  *
  99  *  The current device firmware can be read from the device by reading a file from the virtual FAT filesystem. Two files will
 100  *  be present:
 101  *    - <b>FLASH.BIN</b>, representing the AVR's internal flash memory
 102  *    - <b>EEPROM.BIN</b>, representing the AVR's internal EEPROM memory
 103  *
 104  *  To convert an existing Intel HEX (.HEX) program file to a binary (.BIN) file suitable for this bootloader, run:
 105  *    \code
 106  *              avr-objcopy -O binary -R .eeprom -R .fuse -R .lock -R .signature input.hex output.bin
 107  *    \endcode
 108  *  From a terminal, replacing <tt>input.hex</tt> and <tt>output.bin</tt> with the respective input and output filenames.
 109  *  AVR EEPROM data files in Intel HEX format (.EEP) uses a similar technique:
 110  *    \code
 111  *              avr-objcopy -O binary input.eep output.bin
 112  *    \endcode
 113  *
 114  *  \warning This bootloader is currently <b>incompatible with the Apple MacOS X OS Finder GUI</b>, due to the
 115  *           large amount of meta files this OS attempts to write to the disk along with the new binaries. On
 116  *           this platform, firmwares must be copied to the disk via the Terminal application only to prevent
 117  *           firmware corruption.
 118  *
 119  *  \section Sec_API User Application API
 120  *
 121  *  Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,
 122  *  allowing the user application to call into the bootloader at runtime to read and write FLASH data.
 123  *
 124  *  By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the
 125  *  following layout:
 126  *
 127  *  \code
 128  *  #define BOOTLOADER_API_TABLE_SIZE          32
 129  *  #define BOOTLOADER_API_TABLE_START         ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
 130  *  #define BOOTLOADER_API_CALL(Index)         (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
 131  *
 132  *  void    (*BootloaderAPI_ErasePage)(uint32_t Address)               = BOOTLOADER_API_CALL(0);
 133  *  void    (*BootloaderAPI_WritePage)(uint32_t Address)               = BOOTLOADER_API_CALL(1);
 134  *  void    (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
 135  *  uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address)           = BOOTLOADER_API_CALL(3);
 136  *  uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address)                = BOOTLOADER_API_CALL(4);
 137  *  uint8_t (*BootloaderAPI_ReadLock)(void)                            = BOOTLOADER_API_CALL(5);
 138  *  void    (*BootloaderAPI_WriteLock)(uint8_t LockBits)               = BOOTLOADER_API_CALL(6);
 139  *
 140  *  #define BOOTLOADER_MAGIC_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
 141  *  #define BOOTLOADER_MAGIC_SIGNATURE         0xDCFB
 142  *
 143  *  #define BOOTLOADER_CLASS_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
 144  *  #define BOOTLOADER_MASS_STORAGE_SIGNATURE  0xDF30
 145  *
 146  *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
 147  *  #define BOOTLOADER_ADDRESS_LENGTH          4
 148  *  \endcode
 149  *
 150  *  From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address
 151  *  \c BOOTLOADER_MAGIC_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader
 152  *  can be determined by reading the FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them
 153  *  to the value \c BOOTLOADER_MASS_STORAGE_SIGNATURE. The start address of the bootloader can be retrieved by reading the bytes
 154  *  of FLASH memory starting from address \c BOOTLOADER_ADDRESS_START.
 155  *
 156  *  \subsection SSec_Aux_Space Auxiliary Bootloader Section
 157  *  To make the bootloader function on smaller devices (those with a physical bootloader section of smaller than 6KB) a second
 158  *  section of memory (called the <i>Auxiliary Bootloader Section</i>) is added before the start of the real bootloader section,
 159  *  and is filled with a portion of the bootloader code. This allows smaller devices to run the bootloader, at the cost of an
 160  *  additional portion of the device's FLASH (the bootloader section size in KB subtracted from the 6KB total size). A small
 161  *  trampoline is inserted at the start of the auxiliary section so that the bootloader will run normally in the case of a blank
 162  *  application section.
 163  *
 164  *  On devices supporting a 8KB bootloader section size, the AUX section is not created in the final binary.
 165  *
 166  *  \subsection SSec_API_MemLayout Device Memory Map
 167  *  The following illustration indicates the final memory map of the device when loaded with the bootloader.
 168  *
 169  *  \verbatim
 170  *  +----------------------------+ 0x0000
 171  *  |                            |
 172  *  |                            |
 173  *  |                            |
 174  *  |                            |
 175  *  |                            |
 176  *  |                            |
 177  *  |                            |
 178  *  |                            |
 179  *  |      User Application      |
 180  *  |                            |
 181  *  |                            |
 182  *  |                            |
 183  *  |                            |
 184  *  |                            |
 185  *  |                            |
 186  *  |                            |
 187  *  |                            |
 188  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE - BOOT_AUX_SECTION_SIZE
 189  *  | Booloader Start Trampoline |
 190  *  | (Not User App. Accessible) |
 191  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE - BOOT_AUX_SECTION_SIZE + 4
 192  *  |                            |
 193  *  |     Auxiliary Bootloader   |
 194  *  |  Space for Smaller Devices |
 195  *  | (Not User App. Accessible) |
 196  *  |                            |
 197  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE
 198  *  |                            |
 199  *  |   Bootloader Application   |
 200  *  | (Not User App. Accessible) |
 201  *  |                            |
 202  *  +----------------------------+ FLASHEND - 96
 203  *  |   API Table Trampolines    |
 204  *  | (Not User App. Accessible) |
 205  *  +----------------------------+ FLASHEND - 32
 206  *  |    Bootloader API Table    |
 207  *  |   (User App. Accessible)   |
 208  *  +----------------------------+ FLASHEND - 8
 209  *  |   Bootloader ID Constants  |
 210  *  |   (User App. Accessible)   |
 211  *  +----------------------------+ FLASHEND
 212  *  \endverbatim
 213  *
 214  *  \section Sec_KnownIssues Known Issues:
 215  *
 216  *  \par In some cases, the application is not fully loaded into the device.
 217  *  Write-caching on some operating systems may interfere with the normal
 218  *  operation of the bootloader. Write caching should be disabled when using the
 219  *  Mass Storage bootloader, or the file system synced via an appropriate command
 220  *  (such as the OS's normal disk ejection command) before disconnecting the device.
 221  *
 222  *  \section Sec_Options Project Options
 223  *
 224  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 225  *
 226  *  <table>
 227  *   <tr>
 228  *    <th><b>Define Name:</b></th>
 229  *    <th><b>Location:</b></th>
 230  *    <th><b>Description:</b></th>
 231  *   </tr>
 232  *   <tr>
 233  *    <td>NO_APP_START_ON_EJECT</td>
 234  *    <td>AppConfig.h</td>
 235  *    <td>Define to disable automatic start of the loaded application when the virtual
 236  *        Mass Storage disk is ejected on the host.</td>
 237  *   </tr>
 238  *  </table>
 239  */
 240