/** \file * * This file contains special DoxyGen information for the generation of the main page and other special * documentation pages. It is not a project source file. */ /** \mainpage Mass Storage Class USB AVR Bootloader * * \section Sec_Compat Demo Compatibility: * * The following list indicates what microcontrollers are compatible with this demo. * * \li Series 7 USB AVRs (AT90USBxxx7) * \li Series 6 USB AVRs (AT90USBxxx6) * \li Series 4 USB AVRs (ATMEGAxxU4) - See \ref SSec_Aux_Space * \li Series 2 USB AVRs (AT90USBxx2, ATMEGAxxU2) - See \ref SSec_Aux_Space * * \section Sec_Info USB Information: * * The following table gives a rundown of the USB utilization of this demo. * * * * * * * * * * * * * * * * * * * * * * *
USB Mode:Device
USB Class:Mass Storage Device
USB Subclass:Bulk-Only Transport
Relevant Standards:USBIF Mass Storage Standard \n * USB Bulk-Only Transport Standard \n * SCSI Primary Commands Specification \n * SCSI Block Commands Specification
Supported USB Speeds:Full Speed Mode
* * \section Sec_Description Project Description: * * This bootloader enumerates to the host as a Mass Storage device, capable of reading and writing a new binary * firmware image file, to load firmware onto the AVR. * * Out of the box this bootloader builds for the AT90USB1287 with an 8KB bootloader section size, and will fit * into 6KB of bootloader space. If you wish to alter this size and/or change the AVR model, you will need to * edit the MCU, FLASH_SIZE_KB and BOOT_SECTION_SIZE_KB values in the accompanying makefile. * * When the bootloader is running, the board's LED(s) will flash at regular intervals to distinguish the * bootloader from the normal user application. * * \section Sec_Installation Driver Installation * * This bootloader uses the Mass Storage drivers inbuilt into all modern operating systems, thus no additional * drivers need to be supplied for correct operation. * * \section Sec_HostApp Host Controller Application * * This bootloader is compatible with all operating systems that support the FAT12 file system format. To reprogram the * device, overwrite a file stored on the virtual FAT filesystem with a new binary (BIN format) image. Remember to safely * remove your device from the host using the host OS's ejection APIs, to ensure all data is correctly flushed to the * bootloader's virtual filesystem and not cached in the OS's file system driver. * * The current device firmware can be read from the device by reading a file from the virtual FAT filesystem. * * \section Sec_API User Application API * * Several user application functions for FLASH and other special memory area manipulations are exposed by the bootloader, * allowing the user application to call into the bootloader at runtime to read and write FLASH data. * * By default, the bootloader API jump table is located 32 bytes from the end of the device's FLASH memory, and follows the * following layout: * * \code * #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); * uint8_t (*BootloaderAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_CALL(3); * 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_MASS_STORAGE_SIGNATURE 0xDF30 * * #define BOOTLOADER_ADDRESS_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8)) * #define BOOTLOADER_ADDRESS_LENGTH 4 * \endcode * * From the application the API support of the bootloader can be detected by reading the FLASH memory bytes located at address * \c BOOTLOADER_MAGIC_SIGNATURE_START and comparing them to the value \c BOOTLOADER_MAGIC_SIGNATURE. The class of bootloader * can be determined by reading the FLASH memory bytes located at address \c BOOTLOADER_CLASS_SIGNATURE_START and comparing them * to the value \c BOOTLOADER_MASS_STORAGE_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_Aux_Space Auxiliary Bootloader Section * To make the bootloader function on smaller devices (those with a physical bootloader section of smaller than 6KB) a second * section of memory (called the Auxiliary Bootloader Section) is added before the start of the real bootloader section, * and is filled with a portion of the bootloader code. This allows smaller devices to run the bootloader, at the cost of an * additional portion of the device's FLASH (the bootloader section size in KB subtracted from the 6KB total size). A small * trampoline is inserted at the start of the auxiliary section so that the bootloader will run normally in the case of a blank * application section. * * On devices supporting a 8KB bootloader section size, the AUX section is not created in the final binary. * * \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 - BOOT_AUX_SECTION_SIZE * | Booloader Start Trampoline | * | (Not User App. Accessible) | * +----------------------------+ FLASHEND - BOOT_SECTION_SIZE - BOOT_AUX_SECTION_SIZE + 4 * | | * | Auxiliary Bootloader | * | Space for Smaller Devices | * | (Not User App. Accessible) | * | | * +----------------------------+ 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. * * * * * *
* None *
*/