diff options
| author | Dean Camera <dean@fourwalledcubicle.com> | 2014-10-12 22:19:16 +1100 |
|---|---|---|
| committer | Dean Camera <dean@fourwalledcubicle.com> | 2014-10-12 22:19:16 +1100 |
| commit | 2358d7dcac412e8b516f70701915b6379f2905d2 (patch) | |
| tree | fd87b7ee781ca797d3ce26085c5e05ad4f7c38da /Bootloaders/MassStorage/BootloaderMassStorage.txt | |
| parent | 2304a730508331b3d71c5c37602201b5b065b4a4 (diff) | |
| download | lufa-2358d7dcac412e8b516f70701915b6379f2905d2.tar.gz lufa-2358d7dcac412e8b516f70701915b6379f2905d2.tar.bz2 lufa-2358d7dcac412e8b516f70701915b6379f2905d2.zip | |
Revert "Improve bootloader documentation."
Revert commit 2304a730508331b3d71c5c37602201b5b065b4a4 as it breaks
compilation of the bootloaders.
Diffstat (limited to 'Bootloaders/MassStorage/BootloaderMassStorage.txt')
| -rw-r--r-- | Bootloaders/MassStorage/BootloaderMassStorage.txt | 23 |
1 files changed, 22 insertions, 1 deletions
diff --git a/Bootloaders/MassStorage/BootloaderMassStorage.txt b/Bootloaders/MassStorage/BootloaderMassStorage.txt index ab77c5d7d..190ff4a3e 100644 --- a/Bootloaders/MassStorage/BootloaderMassStorage.txt +++ b/Bootloaders/MassStorage/BootloaderMassStorage.txt @@ -111,7 +111,28 @@ * 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: * - * \snippet BootloaderAPI.h User Application API + * \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 |