aboutsummaryrefslogtreecommitdiffstats
path: root/Bootloaders/Printer
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2014-10-12 22:19:16 +1100
committerDean Camera <dean@fourwalledcubicle.com>2014-10-12 22:19:16 +1100
commit2358d7dcac412e8b516f70701915b6379f2905d2 (patch)
treefd87b7ee781ca797d3ce26085c5e05ad4f7c38da /Bootloaders/Printer
parent2304a730508331b3d71c5c37602201b5b065b4a4 (diff)
downloadlufa-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/Printer')
-rw-r--r--Bootloaders/Printer/BootloaderAPI.h24
-rw-r--r--Bootloaders/Printer/BootloaderAPITable.S4
-rw-r--r--Bootloaders/Printer/BootloaderPrinter.txt23
-rw-r--r--Bootloaders/Printer/doxyfile2
4 files changed, 25 insertions, 28 deletions
diff --git a/Bootloaders/Printer/BootloaderAPI.h b/Bootloaders/Printer/BootloaderAPI.h
index 990ffb9f4..f44ab06c7 100644
--- a/Bootloaders/Printer/BootloaderAPI.h
+++ b/Bootloaders/Printer/BootloaderAPI.h
@@ -43,30 +43,6 @@
#include <LUFA/Common/Common.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 0xDF20
-
- #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/Printer/BootloaderAPITable.S b/Bootloaders/Printer/BootloaderAPITable.S
index 8e1badf60..ec499b74e 100644
--- a/Bootloaders/Printer/BootloaderAPITable.S
+++ b/Bootloaders/Printer/BootloaderAPITable.S
@@ -87,5 +87,5 @@ BootloaderAPI_JumpTable:
BootloaderAPI_Signatures:
.long BOOT_START_ADDR ; Start address of the bootloader
- .word 0xDF20 ; Signature for the Printer class bootloader
- .word 0xDCFB ; Signature for a LUFA class bootloader
+ .word 0xDF20 ; Signature for the Printer class bootloader
+ .word 0xDCFB ; Signature for a LUFA class bootloader
diff --git a/Bootloaders/Printer/BootloaderPrinter.txt b/Bootloaders/Printer/BootloaderPrinter.txt
index 68c39725b..d9aa79686 100644
--- a/Bootloaders/Printer/BootloaderPrinter.txt
+++ b/Bootloaders/Printer/BootloaderPrinter.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_PRINTER_SIGNATURE 0xDF20
+ *
+ * #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/Printer/doxyfile b/Bootloaders/Printer/doxyfile
index 733512d0d..a81be54f4 100644
--- a/Bootloaders/Printer/doxyfile
+++ b/Bootloaders/Printer/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