michi/qmk_firmware
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve bootloader documentation.

Browse Source
This commit is contained in:
Dean Camera
2014-10-12 16:58:42 +11:00
parent a09cb7e3d8
commit 2304a73050
16 changed files with 112 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Bootloaders/MassStorage/BootloaderAPI.h
+24
View File
@@ -50,6 +50,30 @@
#define AUX_BOOT_SECTION
#endif
/* User Application API: */
/** [User Application API] */
#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 (*BootAPI_ErasePage)(uint32_t Address) = BOOTLOADER_API_CALL(0);
void (*BootAPI_WritePage)(uint32_t Address) = BOOTLOADER_API_CALL(1);
void (*BootAPI_FillWord)(uint32_t Address, uint16_t Word) = BOOTLOADER_API_CALL(2);
uint8_t (*BootAPI_ReadSignature)(uint16_t Address) = BOOTLOADER_API_CALL(3);
uint8_t (*BootAPI_ReadFuse)(uint16_t Address) = BOOTLOADER_API_CALL(4);
uint8_t (*BootAPI_ReadLock)(void) = BOOTLOADER_API_CALL(5);
void (*BootAPI_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 0xDF30
#define BOOTLOADER_ADDRESS_START (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
#define BOOTLOADER_ADDRESS_LENGTH 4
/** [User Application API] */
/* Function Prototypes: */
void BootloaderAPI_ErasePage(const uint32_t Address);
void BootloaderAPI_WritePage(const uint32_t Address);