diff options
Diffstat (limited to 'Bootloaders/CDC')
| -rw-r--r-- | Bootloaders/CDC/BootloaderAPI.h | 24 | ||||
| -rw-r--r-- | Bootloaders/CDC/BootloaderAPITable.S | 4 | ||||
| -rw-r--r-- | Bootloaders/CDC/BootloaderCDC.txt | 23 | ||||
| -rw-r--r-- | Bootloaders/CDC/doxyfile | 2 |
4 files changed, 25 insertions, 28 deletions
diff --git a/Bootloaders/CDC/BootloaderAPI.h b/Bootloaders/CDC/BootloaderAPI.h index 89ef46e91..2462cacdd 100644 --- a/Bootloaders/CDC/BootloaderAPI.h +++ b/Bootloaders/CDC/BootloaderAPI.h @@ -45,30 +45,6 @@ #include "Config/AppConfig.h" - /* 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 0xDF00 - - #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); diff --git a/Bootloaders/CDC/BootloaderAPITable.S b/Bootloaders/CDC/BootloaderAPITable.S index ebc514b98..69ebd387a 100644 --- a/Bootloaders/CDC/BootloaderAPITable.S +++ b/Bootloaders/CDC/BootloaderAPITable.S @@ -87,5 +87,5 @@ BootloaderAPI_JumpTable: BootloaderAPI_Signatures: .long BOOT_START_ADDR ; Start address of the bootloader - .word 0xDF00 ; Signature for the CDC class bootloader - .word 0xDCFB ; Signature for a LUFA class bootloader + .word 0xDF00 ; Signature for the CDC class bootloader + .word 0xDCFB ; Signature for a LUFA class bootloader diff --git a/Bootloaders/CDC/BootloaderCDC.txt b/Bootloaders/CDC/BootloaderCDC.txt index bc3e9df1d..f8c349cde 100644 --- a/Bootloaders/CDC/BootloaderCDC.txt +++ b/Bootloaders/CDC/BootloaderCDC.txt @@ -121,7 +121,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_CDC_SIGNATURE 0xDF00 + * + * #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 diff --git a/Bootloaders/CDC/doxyfile b/Bootloaders/CDC/doxyfile index 26fcc8a37..2dfb2a08a 100644 --- a/Bootloaders/CDC/doxyfile +++ b/Bootloaders/CDC/doxyfile @@ -834,7 +834,7 @@ EXCLUDE_SYMBOLS = __* \ # that contain example code fragments that are included (see the \include # command). -EXAMPLE_PATH = . +EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and |