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 Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - <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  *  \section Sec_Installation Driver Installation
  61  *
  62  *  This bootloader uses the Mass Storage drivers inbuilt into all modern operating systems, thus no additional
  63  *  drivers need to be supplied for correct operation.
  64  *
  65  *  \section Sec_HostApp Host Controller Application
  66  *
  67  *  This bootloader is compatible with all operating systems that support the FAT12 file system format. To reprogram the
  68  *  device, overwrite a file stored on the virtual FAT filesystem with a new binary (BIN format) image. Remember to safely
  69  *  remove your device from the host using the host OS's ejection APIs, to ensure all data is correctly flushed to the
  70  *  bootloader's virtual filesystem and not cached in the OS's file system driver.
  71  *
  72  *  The current device firmware can be read from the device by reading a file from the virtual FAT filesystem.
  73  *
  74  *  \section Sec_API User Application API
  75  *
  76  *  Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,
  77  *  allowing the user application to call into the bootloader at runtime to read and write FLASH data.
  78  *
  79  *  By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the
  80  *  following layout:
  81  *
  82  *  \code
  83  *  #define BOOTLOADER_API_TABLE_SIZE          32
  84  *  #define BOOTLOADER_API_TABLE_START         ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
  85  *  #define BOOTLOADER_API_CALL(Index)         (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
  86  *
  87  *  void    (*BootloaderAPI_ErasePage)(uint32_t Address)               = BOOTLOADER_API_CALL(0);
  88  *  void    (*BootloaderAPI_WritePage)(uint32_t Address)               = BOOTLOADER_API_CALL(1);
  89  *  void    (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
  90  *  uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address)           = BOOTLOADER_API_CALL(3);
  91  *  uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address)                = BOOTLOADER_API_CALL(4);
  92  *  uint8_t (*BootloaderAPI_ReadLock)(void)                            = BOOTLOADER_API_CALL(5);
  93  *  void    (*BootloaderAPI_WriteLock)(uint8_t LockBits)               = BOOTLOADER_API_CALL(6);
  94  *
  95  *  #define BOOTLOADER_MAGIC_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
  96  *  #define BOOTLOADER_MAGIC_SIGNATURE         0xDCFB
  97  *
  98  *  #define BOOTLOADER_CLASS_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
  99  *  #define BOOTLOADER_MASS_STORAGE_SIGNATURE  0xDF30
 100  *
 101  *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
 102  *  #define BOOTLOADER_ADDRESS_LENGTH          4
 103  *  \endcode
 104  *
 105  *  From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address
 106  *  \c BOOTLOADER_MAGIC_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader
 107  *  can be determined by reading the FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them
 108  *  to the value \c BOOTLOADER_MASS_STORAGE_SIGNATURE. The start address of the bootloader can be retrieved by reading the bytes
 109  *  of FLASH memory starting from address \c BOOTLOADER_ADDRESS_START.
 110  *
 111  *  \subsection SSec_Aux_Space Auxiliary Bootloader Section
 112  *  To make the bootloader function on smaller devices (those with a physical bootloader section of smaller than 6KB) a second
 113  *  section of memory (called the <i>Auxiliary Bootloader Section</i>) is added before the start of the real bootloader section,
 114  *  and is filled with a portion of the bootloader code. This allows smaller devices to run the bootloader, at the cost of an
 115  *  additional portion of the device's FLASH (the bootloader section size in KB subtracted from the 6KB total size). A small
 116  *  trampoline is inserted at the start of the auxiliary section so that the bootloader will run normally in the case of a blank
 117  *  application section.
 118  *
 119  *  On devices supporting a 8KB bootloader section size, the AUX section is not created in the final binary.
 120  *
 121  *  \subsection SSec_API_MemLayout Device Memory Map
 122  *  The following illustration indicates the final memory map of the device when loaded with the bootloader.
 123  *
 124  *  \verbatim
 125  *  +----------------------------+ 0x0000
 126  *  |                            |
 127  *  |                            |
 128  *  |                            |
 129  *  |                            |
 130  *  |                            |
 131  *  |                            |
 132  *  |                            |
 133  *  |                            |
 134  *  |      User Application      |
 135  *  |                            |
 136  *  |                            |
 137  *  |                            |
 138  *  |                            |
 139  *  |                            |
 140  *  |                            |
 141  *  |                            |
 142  *  |                            |
 143  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE - BOOT_AUX_SECTION_SIZE
 144  *  | Booloader Start Trampoline |
 145  *  | (Not User App. Accessible) |
 146  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE - BOOT_AUX_SECTION_SIZE + 4
 147  *  |                            |
 148  *  |     Auxiliary Bootloader   |
 149  *  |  Space for Smaller Devices |
 150  *  | (Not User App. Accessible) |
 151  *  |                            |
 152  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE
 153  *  |                            |
 154  *  |   Bootloader Application   |
 155  *  | (Not User App. Accessible) |
 156  *  |                            |
 157  *  +----------------------------+ FLASHEND - 96
 158  *  |   API Table Trampolines    |
 159  *  | (Not User App. Accessible) |
 160  *  +----------------------------+ FLASHEND - 32
 161  *  |    Bootloader API Table    |
 162  *  |   (User App. Accessible)   |
 163  *  +----------------------------+ FLASHEND - 8
 164  *  |   Bootloader ID Constants  |
 165  *  |   (User App. Accessible)   |
 166  *  +----------------------------+ FLASHEND
 167  *  \endverbatim
 168  *
 169  *  \section Sec_KnownIssues Known Issues:
 170  *
 171  *  \par In some cases, the application is not fully loaded into the device.
 172  *  Write-caching on some operating systems may interfere with the normal
 173  *  operation of the bootloader. Write caching should be disabled when using the
 174  *  Mass Storage bootloader, or the file system synced via an appropriate command
 175  *  (such as the OS's normal disk ejection command) before disconnecting the device.
 176  *
 177  *  \par After loading an application, it is not run automatically on startup.
 178  *  Some USB AVR boards ship with the BOOTRST fuse set, causing the bootloader
 179  *  to run automatically when the device is reset. In most cases, the BOOTRST
 180  *  fuse should be disabled and the HWBE fuse used instead to run the bootloader
 181  *  when needed.
 182  *
 183  *  \section Sec_Options Project Options
 184  *
 185  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 186  *
 187  *  <table>
 188  *   <tr>
 189  *    <td>
 190  *     None
 191  *    </td>
 192  *   </tr>
 193  *  </table>
 194  */
 195