Minor documentation corrections.

[pub/USBasp.git] / Bootloaders / DFU / BootloaderDFU.h

diff --git a/Bootloaders/DFU/BootloaderDFU.h b/Bootloaders/DFU/BootloaderDFU.h
index 545548d..5e1f19e 100644 (file)
--- a/Bootloaders/DFU/BootloaderDFU.h
+++ b/Bootloaders/DFU/BootloaderDFU.h
@@ -48,8 +48,10 @@
                #include <stdbool.h>
 
                #include "Descriptors.h"
                #include <stdbool.h>
 
                #include "Descriptors.h"

+               #include "BootloaderAPI.h"

 
                #include <LUFA/Drivers/USB/USB.h>
 
                #include <LUFA/Drivers/USB/USB.h>

+               #include <LUFA/Drivers/Board/LEDs.h>

 
        /* Macros: */
                /** Configuration define. Define this token to true to case the bootloader to reject all memory commands
 
        /* Macros: */
                /** Configuration define. Define this token to true to case the bootloader to reject all memory commands


@@ -103,25 +105,25 @@
                #define DFU_FILLER_BYTES_SIZE    26
 
                /** DFU class command request to detach from the host. */
                #define DFU_FILLER_BYTES_SIZE    26
 
                /** DFU class command request to detach from the host. */

-               #define REQ_DFU_DETATCH          0x00
+               #define DFU_REQ_DETATCH          0x00

 
                /** DFU class command request to send data from the host to the bootloader. */
 
                /** DFU class command request to send data from the host to the bootloader. */

-               #define REQ_DFU_DNLOAD           0x01
+               #define DFU_REQ_DNLOAD           0x01

 
                /** DFU class command request to send data from the bootloader to the host. */
 
                /** DFU class command request to send data from the bootloader to the host. */

-               #define REQ_DFU_UPLOAD           0x02
+               #define DFU_REQ_UPLOAD           0x02

 
                /** DFU class command request to get the current DFU status and state from the bootloader. */
 
                /** DFU class command request to get the current DFU status and state from the bootloader. */

-               #define REQ_DFU_GETSTATUS        0x03
+               #define DFU_REQ_GETSTATUS        0x03

 
                /** DFU class command request to reset the current DFU status and state variables to their defaults. */
 
                /** DFU class command request to reset the current DFU status and state variables to their defaults. */

-               #define REQ_DFU_CLRSTATUS        0x04
+               #define DFU_REQ_CLRSTATUS        0x04

 
                /** DFU class command request to get the current DFU state of the bootloader. */
 
                /** DFU class command request to get the current DFU state of the bootloader. */

-               #define REQ_DFU_GETSTATE         0x05
+               #define DFU_REQ_GETSTATE         0x05

 
                /** DFU class command request to abort the current multi-request transfer and return to the dfuIDLE state. */
 
                /** DFU class command request to abort the current multi-request transfer and return to the dfuIDLE state. */

-               #define REQ_DFU_ABORT            0x06
+               #define DFU_REQ_ABORT            0x06

 
                /** DFU command to begin programming the device's memory. */
                #define COMMAND_PROG_START       0x01
 
                /** DFU command to begin programming the device's memory. */
                #define COMMAND_PROG_START       0x01


@@ -146,7 +148,7 @@
                /** Type define for a structure containing a complete DFU command issued by the host. */
                typedef struct
                {
                /** Type define for a structure containing a complete DFU command issued by the host. */
                typedef struct
                {

-                       uint8_t  Command; /**< Single byte command to perform, one of the COMMAND_* macro values */
+                       uint8_t  Command; /**< Single byte command to perform, one of the \c COMMAND_* macro values */

                        uint8_t  Data[5]; /**< Command parameters */
                        uint16_t DataSize; /**< Size of the command parameters */
                } DFU_Command_t;
                        uint8_t  Data[5]; /**< Command parameters */
                        uint16_t DataSize; /**< Size of the command parameters */
                } DFU_Command_t;


@@ -190,8 +192,8 @@
                };
 
        /* Function Prototypes: */
                };
 
        /* Function Prototypes: */

-               void SetupHardware(void);
-               void ResetHardware(void);
+               static void SetupHardware(void);
+               static void ResetHardware(void);

 
                void EVENT_USB_Device_ControlRequest(void);
 
 
                void EVENT_USB_Device_ControlRequest(void);