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  *
  16  *  \section Sec_Info USB Information:
  17  *
  18  *  The following table gives a rundown of the USB utilization of this demo.
  19  *
  20  *  <table>
  21  *   <tr>
  22  *    <td><b>USB Mode:</b></td>
  23  *    <td>Device</td>
  24  *   </tr>
  25  *   <tr>
  26  *    <td><b>USB Class:</b></td>
  27  *    <td>Mass Storage Device</td>
  28  *   </tr>
  29  *   <tr>
  30  *    <td><b>USB Subclass:</b></td>
  31  *    <td>Bulk-Only Transport</td>
  32  *   </tr>
  33  *   <tr>
  34  *    <td><b>Relevant Standards:</b></td>
  35  *    <td>USBIF Mass Storage Standard \n
  36  *        USB Bulk-Only Transport Standard \n
  37  *        SCSI Primary Commands Specification \n
  38  *        SCSI Block Commands Specification</td>
  39  *   </tr>
  40  *   <tr>
  41  *    <td><b>Supported USB Speeds:</b></td>
  42  *    <td>Full Speed Mode</td>
  43  *   </tr>
  44  *  </table>
  45  *
  46  *  \section Sec_Description Project Description:
  47  *
  48  *  This bootloader enumerates to the host as a Mass Storage device, capable of reading and writing a new binary
  49  *  firmware image file, to load firmware onto the AVR.
  50  *
  51  *  Out of the box this bootloader builds for the AT90USB1287 with an 8KB bootloader section size, and will fit
  52  *  into 8KB of bootloader space. If you wish to alter this size and/or change the AVR model, you will need to
  53  *  edit the MCU, FLASH_SIZE_KB and BOOT_SECTION_SIZE_KB values in the accompanying makefile.
  54  *
  55  *  When the bootloader is running, the board's LED(s) will flash at regular intervals to distinguish the
  56  *  bootloader from the normal user application.
  57  *
  58  *  \section Sec_Installation Driver Installation
  59  *
  60  *  This bootloader uses the Mass Storage drivers inbuilt into all modern operating systems, thus no additional
  61  *  drivers need to be supplied for correct operation.
  62  *
  63  *  \section Sec_HostApp Host Controller Application
  64  *
  65  *  This bootloader is compatible with all operating systems that support the FAT12 file system format. To reprogram the
  66  *  device, overwrite a file stored on the virtual FAT filesystem with a new binary (BIN format) image. Remember to safely
  67  *  remove your device from the host using the host OS's ejection APIs, to ensure all data is correctly flushed to the
  68  *  bootloader's virtual filesystem and not cached in the OS's file system driver.
  69  *
  70  *  The current device firmware can be read from the device by reading a file from the virtual FAT filesystem.
  71  *
  72  *  \section Sec_API User Application API
  73  *
  74  *  Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader,
  75  *  allowing the user application to call into the bootloader at runtime to read and write FLASH data.
  76  *
  77  *  By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the
  78  *  following layout:
  79  *
  80  *  \code
  81  *  #define BOOTLOADER_API_TABLE_SIZE          32
  82  *  #define BOOTLOADER_API_TABLE_START         ((FLASHEND + 1UL) - BOOTLOADER_API_TABLE_SIZE)
  83  *  #define BOOTLOADER_API_CALL(Index)         (void*)((BOOTLOADER_API_TABLE_START + (Index * 2)) / 2)
  84  *
  85  *  void    (*BootloaderAPI_ErasePage)(uint32_t Address)               = BOOTLOADER_API_CALL(0);
  86  *  void    (*BootloaderAPI_WritePage)(uint32_t Address)               = BOOTLOADER_API_CALL(1);
  87  *  void    (*BootloaderAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
  88  *  uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address)           = BOOTLOADER_API_CALL(3);
  89  *  uint8_t (*BootloaderAPI_ReadFuse)(uint16_t Address)                = BOOTLOADER_API_CALL(4);
  90  *  uint8_t (*BootloaderAPI_ReadLock)(void)                            = BOOTLOADER_API_CALL(5);
  91  *  void    (*BootloaderAPI_WriteLock)(uint8_t LockBits)               = BOOTLOADER_API_CALL(6);
  92  *
  93  *  #define BOOTLOADER_MAGIC_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
  94  *  #define BOOTLOADER_MAGIC_SIGNATURE         0xDCFB
  95  *
  96  *  #define BOOTLOADER_CLASS_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
  97  *  #define BOOTLOADER_MASS_STORAGE_SIGNATURE  0xDF30
  98  *
  99  *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
 100  *  #define BOOTLOADER_ADDRESS_LENGTH          4
 101  *  \endcode
 102  *
 103  *  \subsection SSec_API_MemLayout Device Memory Map
 104  *  The following illustration indicates the final memory map of the device when loaded with the bootloader.
 105  *
 106  *  \verbatim
 107  *  +----------------------------+ 0x0000
 108  *  |                            |
 109  *  |                            |
 110  *  |                            |
 111  *  |                            |
 112  *  |                            |
 113  *  |                            |
 114  *  |                            |
 115  *  |                            |
 116  *  |      User Application      |
 117  *  |                            |
 118  *  |                            |
 119  *  |                            |
 120  *  |                            |
 121  *  |                            |
 122  *  |                            |
 123  *  |                            |
 124  *  +----------------------------+ FLASHEND - BOOT_SECTION_SIZE
 125  *  |                            |
 126  *  |   Bootloader Application   |
 127  *  | (Not User App. Accessible) |
 128  *  |                            |
 129  *  +----------------------------+ FLASHEND - 96
 130  *  |   API Table Trampolines    |
 131  *  | (Not User App. Accessible) |
 132  *  +----------------------------+ FLASHEND - 32
 133  *  |    Bootloader API Table    |
 134  *  |   (User App. Accessible)   |
 135  *  +----------------------------+ FLASHEND - 8
 136  *  |   Bootloader ID Constants  |
 137  *  |   (User App. Accessible)   |
 138  *  +----------------------------+ FLASHEND
 139  *  \endverbatim
 140  *
 141  *  Bootloaders reporting a device release revision number of 1.00 or greater are bootloader API enabled. From the application
 142  *  the API support of the bootloader can be detected by reading the FLASH memory bytes located at address \c BOOTLOADER_MAGIC_SIGNATURE_START
 143  *  and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader can be determined by reading the
 144  *  FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MASS_STORAGE_SIGNATURE.
 145  *  The start address of the bootloader can be retrieved by reading the bytes of FLASH memory starting from address \c BOOTLOADER_ADDRESS_START.
 146  *
 147  *  \section Sec_Options Project Options
 148  *
 149  *  The following defines can be found in this demo, which can control the demo behaviour when defined, or changed in value.
 150  *
 151  *  <table>
 152  *   <tr>
 153  *    <td>
 154  *     None
 155  *    </td>
 156  *   </tr>
 157  *  </table>
 158  */
 159