From cca24c8dc90313eba722873df816a7573003a0f1 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 17 May 2012 20:07:16 +0000 Subject: Update CDC and DFU class bootloader documentation with a device memory map illustration. --- Bootloaders/DFU/BootloaderDFU.txt | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) (limited to 'Bootloaders/DFU/BootloaderDFU.txt') diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index 0ef8aba67..f6a5d1cf5 100644 --- a/Bootloaders/DFU/BootloaderDFU.txt +++ b/Bootloaders/DFU/BootloaderDFU.txt @@ -128,6 +128,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. -- cgit v1.2.3 From c31fdbd03eee95660d65adb0f1bf7c0c397fd435 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Fri, 18 May 2012 18:39:35 +0000 Subject: Minor documentation adjustments to the demos, projects and bootloaders to ensure correct formatting of application device support. --- Bootloaders/DFU/BootloaderDFU.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'Bootloaders/DFU/BootloaderDFU.txt') diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index f6a5d1cf5..13dd05b63 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,7 +37,7 @@ * USBIF DFU Class Standard, Atmel USB Bootloader Datasheet * * - * Usable Speeds: + * Supported USB Speeds: * Full Speed Mode * * -- cgit v1.2.3 From f2ae4dc255bd86438cffb62c138326b1c0b5725f Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Sun, 20 May 2012 10:55:59 +0000 Subject: Upgrade Doxygen configuration files for Doxygen 1.8.1, fix broken stylesheet and footer HTML, add explicit spacing into documentation code fragments to prevent Doxygen from removing empty lines in the output. --- Bootloaders/DFU/BootloaderDFU.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'Bootloaders/DFU/BootloaderDFU.txt') diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt index 13dd05b63..a01b1d9fd 100644 --- a/Bootloaders/DFU/BootloaderDFU.txt +++ b/Bootloaders/DFU/BootloaderDFU.txt @@ -103,7 +103,7 @@ * #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); @@ -111,13 +111,13 @@ * 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 (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 2)) * #define BOOTLOADER_MAGIC_SIGNATURE 0xDCFB - * + * * #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 -- cgit v1.2.3