Improve bootloader documentation.

diff --git a/Bootloaders/CDC/BootloaderAPI.h b/Bootloaders/CDC/BootloaderAPI.h
index 2462cac..89ef46e 100644 (file)
--- a/Bootloaders/CDC/BootloaderAPI.h
+++ b/Bootloaders/CDC/BootloaderAPI.h
@@ -45,6 +45,30 @@
 
                #include "Config/AppConfig.h"
 
 
                #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);
        /* 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 69ebd38..ebc514b 100644 (file)
--- 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
 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 f8c349c..bc3e9df 100644 (file)
--- a/Bootloaders/CDC/BootloaderCDC.txt
+++ b/Bootloaders/CDC/BootloaderCDC.txt
@@ -121,28 +121,7 @@
  *  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:
  *
  *  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_CDC_SIGNATURE           0xDF00
- *
- *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
- *  #define BOOTLOADER_ADDRESS_LENGTH          4
- *  \endcode
+ *  \snippet BootloaderAPI.h User Application API

  *
  *  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
  *
  *  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 2dfb2a0..26fcc8a 100644 (file)
--- 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).
 
 # 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
 
 # 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

diff --git a/Bootloaders/DFU/BootloaderAPI.h b/Bootloaders/DFU/BootloaderAPI.h
index 2462cac..9502bd9 100644 (file)
--- a/Bootloaders/DFU/BootloaderAPI.h
+++ b/Bootloaders/DFU/BootloaderAPI.h
@@ -45,6 +45,30 @@
 
                #include "Config/AppConfig.h"
 
 
                #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           0xDF10
+
+               #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);
        /* Function Prototypes: */
                void    BootloaderAPI_ErasePage(const uint32_t Address);
                void    BootloaderAPI_WritePage(const uint32_t Address);

diff --git a/Bootloaders/DFU/BootloaderAPITable.S b/Bootloaders/DFU/BootloaderAPITable.S
index 101dcbd..52bd6f8 100644 (file)
--- a/Bootloaders/DFU/BootloaderAPITable.S
+++ b/Bootloaders/DFU/BootloaderAPITable.S
@@ -87,5 +87,5 @@ BootloaderAPI_JumpTable:
 BootloaderAPI_Signatures:
 
        .long BOOT_START_ADDR ; Start address of the bootloader
 BootloaderAPI_Signatures:
 
        .long BOOT_START_ADDR ; Start address of the bootloader

-       .word 0xDF10 ; Signature for the DFU class bootloader, V1
-       .word 0xDCFB ; Signature for a LUFA class bootloader
+       .word 0xDF10          ; Signature for the DFU class bootloader, V1
+       .word 0xDCFB          ; Signature for a LUFA class bootloader

diff --git a/Bootloaders/DFU/BootloaderDFU.txt b/Bootloaders/DFU/BootloaderDFU.txt
index b2540a5..801b6df 100644 (file)
--- a/Bootloaders/DFU/BootloaderDFU.txt
+++ b/Bootloaders/DFU/BootloaderDFU.txt
@@ -124,28 +124,7 @@
  *  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:
  *
  *  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_DFU_SIGNATURE           0xDF10
- *
- *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
- *  #define BOOTLOADER_ADDRESS_LENGTH          4
- *  \endcode
+ *  \snippet BootloaderAPI.h User Application API

  *
  *  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
  *
  *  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/DFU/doxyfile b/Bootloaders/DFU/doxyfile
index 6cc42af..07e331c 100644 (file)
--- a/Bootloaders/DFU/doxyfile
+++ b/Bootloaders/DFU/doxyfile
@@ -834,7 +834,7 @@ EXCLUDE_SYMBOLS        = __* \
 # that contain example code fragments that are included (see the \include
 # command).
 
 # 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
 
 # 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

diff --git a/Bootloaders/MassStorage/BootloaderAPI.h b/Bootloaders/MassStorage/BootloaderAPI.h
index 0f0cd70..56748b7 100644 (file)
--- a/Bootloaders/MassStorage/BootloaderAPI.h
+++ b/Bootloaders/MassStorage/BootloaderAPI.h
@@ -50,6 +50,30 @@
                        #define AUX_BOOT_SECTION
                #endif
 
                        #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);
        /* Function Prototypes: */
                void    BootloaderAPI_ErasePage(const uint32_t Address);
                void    BootloaderAPI_WritePage(const uint32_t Address);

diff --git a/Bootloaders/MassStorage/BootloaderAPITable.S b/Bootloaders/MassStorage/BootloaderAPITable.S
index 6844d4b..02a3047 100644 (file)
--- a/Bootloaders/MassStorage/BootloaderAPITable.S
+++ b/Bootloaders/MassStorage/BootloaderAPITable.S
@@ -98,5 +98,5 @@ BootloaderAPI_JumpTable:
 BootloaderAPI_Signatures:\r
 \r
        .long BOOT_START_ADDR ; Start address of the bootloader\r
 BootloaderAPI_Signatures:\r
 \r
        .long BOOT_START_ADDR ; Start address of the bootloader\r

-       .word 0xDF30 ; Signature for the MS class bootloader, V1\r
-       .word 0xDCFB ; Signature for a LUFA class bootloader\r
+       .word 0xDF30          ; Signature for the MS class bootloader, V1\r
+       .word 0xDCFB          ; Signature for a LUFA class bootloader\r

diff --git a/Bootloaders/MassStorage/BootloaderMassStorage.txt b/Bootloaders/MassStorage/BootloaderMassStorage.txt
index 190ff4a..ab77c5d 100644 (file)
--- a/Bootloaders/MassStorage/BootloaderMassStorage.txt
+++ b/Bootloaders/MassStorage/BootloaderMassStorage.txt
@@ -111,28 +111,7 @@
  *  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:
  *
  *  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
+ *  \snippet BootloaderAPI.h User Application API

  *
  *  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
  *
  *  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/MassStorage/doxyfile b/Bootloaders/MassStorage/doxyfile
index 9e81690..6f8bf9e 100644 (file)
--- a/Bootloaders/MassStorage/doxyfile
+++ b/Bootloaders/MassStorage/doxyfile
@@ -834,7 +834,7 @@ EXCLUDE_SYMBOLS        = __* \
 # that contain example code fragments that are included (see the \include
 # command).
 
 # 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
 
 # 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

diff --git a/Bootloaders/Printer/BootloaderAPI.h b/Bootloaders/Printer/BootloaderAPI.h
index f44ab06..990ffb9 100644 (file)
--- a/Bootloaders/Printer/BootloaderAPI.h
+++ b/Bootloaders/Printer/BootloaderAPI.h
@@ -43,6 +43,30 @@
 
                #include <LUFA/Common/Common.h>
 
 
                #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);
        /* 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 ec499b7..8e1badf 100644 (file)
--- a/Bootloaders/Printer/BootloaderAPITable.S
+++ b/Bootloaders/Printer/BootloaderAPITable.S
@@ -87,5 +87,5 @@ BootloaderAPI_JumpTable:
 BootloaderAPI_Signatures:\r
 \r
        .long BOOT_START_ADDR ; Start address of the bootloader\r
 BootloaderAPI_Signatures:\r
 \r
        .long BOOT_START_ADDR ; Start address of the bootloader\r

-       .word 0xDF20 ; Signature for the Printer class bootloader\r
-       .word 0xDCFB ; Signature for a LUFA class bootloader\r
+       .word 0xDF20          ; Signature for the Printer class bootloader\r
+       .word 0xDCFB          ; Signature for a LUFA class bootloader\r

diff --git a/Bootloaders/Printer/BootloaderPrinter.txt b/Bootloaders/Printer/BootloaderPrinter.txt
index d9aa796..68c3972 100644 (file)
--- a/Bootloaders/Printer/BootloaderPrinter.txt
+++ b/Bootloaders/Printer/BootloaderPrinter.txt
@@ -111,28 +111,7 @@
  *  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:
  *
  *  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_PRINTER_SIGNATURE       0xDF20
- *
- *  #define BOOTLOADER_ADDRESS_START           (BOOTLOADER_API_TABLE_START + (BOOTLOADER_API_TABLE_SIZE - 8))
- *  #define BOOTLOADER_ADDRESS_LENGTH          4
- *  \endcode
+ *  \snippet BootloaderAPI.h User Application API

  *
  *  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
  *
  *  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 a81be54..733512d 100644 (file)
--- 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).
 
 # 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
 
 # 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