X-Git-Url: http://git.linex4red.de/pub/USBasp.git/blobdiff_plain/74fb2d895e3197f9b0204366d7f6f52c9c41b2ff..841bb33e362cfbeee8fb3d267072a3e64f5fbd87:/Bootloaders/DFU/BootloaderDFU.txt?ds=sidebyside

diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt
index 04f911617..aefe344ea 100644
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@@ -10,10 +10,10 @@
  *
  *  The following list indicates what microcontrollers are compatible with this demo.
  *
- *  - Series 7 USB AVRs (AT90USBxxx7)
- *  - Series 6 USB AVRs (AT90USBxxx6)
- *  - Series 4 USB AVRs (ATMEGAxxU4)
- *  - Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2)
+ *  \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:
  *
@@ -37,8 +37,9 @@
  *   <td>USBIF DFU Class Standard, Atmel USB Bootloader Datasheet</td>
  *  </tr>
  *  <tr>
- *   <td><b>Usable Speeds:</b></td>
- *   <td>Full Speed Mode</td>
+ *   <td><b>Supported USB Speeds:</b></td>
+ *   <td>Low Speed Mode \n
+ *       Full Speed Mode</td>
  *  </tr>
  * </table>
  *
@@ -100,8 +101,10 @@
  *  following layout:
  *
  *  \code
- *  #define BOOTLOADER_API_CALL(Index)        (void*)(((FLASHEND - 32) + (2 * Index)) / 2)
- *
+ *  #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);
@@ -109,14 +112,14 @@
  *  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   (FLASHEND - 2)
+ *  
+ *  #define BOOTLOADER_MAGIC_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2))
  *  #define BOOTLOADER_MAGIC_SIGNATURE         0xDCFB
- *
- *  #define BOOTLOADER_CLASS_SIGNATURE_START   (FLASHEND - 4)
- *  #define BOOTLOADER_DFU_SIGNATURE           0xDFB1
- *
- *  #define BOOTLOADER_ADDRESS_START           (FLASHEND - 8)
+ *  
+ *  #define BOOTLOADER_CLASS_SIGNATURE_START   (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 4))
+ *  #define BOOTLOADER_CDC_SIGNATURE           0xDFB1
+ *  
+ *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
  *  #define BOOTLOADER_ADDRESS_LENGTH          4
  *  \endcode
  *
@@ -126,6 +129,44 @@
  *  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.
  *
+ *  \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
+ *
  *  \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.
@@ -138,10 +179,10 @@
  *   </tr>
  *   <tr>
  *    <td>SECURE_MODE</td>
- *    <td>BootloaderDFU.h</td>
+ *    <td>AppConfig.h</td>
  *    <td>If defined to \c true, the bootloader will not accept any memory commands other than a chip erase on start-up, until an
  *        erase has been performed. This can be used in conjunction with the AVR's lockbits to prevent the AVRs firmware from
- *        being dumped by unauthorized persons.</td>
+ *        being dumped by unauthorized persons. When false, all memory operations are allowed at any time.</td>
  *   </tr>
  *  </table>
  */