Minor documentation improvements.

[pub/lufa.git] / Projects / AVRISP-MKII / Lib / V2ProtocolParams.h

diff --git a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h
index 4bbb024..ab47664 100644 (file)
--- a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h
+++ b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.h
@@ -1,21 +1,21 @@
 /*
              LUFA Library
 /*
              LUFA Library

-     Copyright (C) Dean Camera, 2010.
-              
+     Copyright (C) Dean Camera, 2012.
+

   dean [at] fourwalledcubicle [dot] com
   dean [at] fourwalledcubicle [dot] com

-      www.fourwalledcubicle.com
+           www.lufa-lib.org

 */
 
 /*
 */
 
 /*

-  Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
+  Copyright 2012  Dean Camera (dean [at] fourwalledcubicle [dot] com)

 
 

-  Permission to use, copy, modify, distribute, and sell this 
+  Permission to use, copy, modify, distribute, and sell this

   software and its documentation for any purpose is hereby granted
   software and its documentation for any purpose is hereby granted

-  without fee, provided that the above copyright notice appear in 
+  without fee, provided that the above copyright notice appear in

   all copies and that both that the copyright notice and this
   all copies and that both that the copyright notice and this

-  permission notice and warranty disclaimer appear in supporting 
-  documentation, and that the name of the author not be used in 
-  advertising or publicity pertaining to distribution of the 
+  permission notice and warranty disclaimer appear in supporting
+  documentation, and that the name of the author not be used in
+  advertising or publicity pertaining to distribution of the

   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this
   software without specific, written prior permission.
 
   The author disclaim all warranties with regard to this


@@ -45,20 +45,26 @@
                #if defined(ADC)
                        #include <LUFA/Drivers/Peripheral/ADC.h>
                #endif
                #if defined(ADC)
                        #include <LUFA/Drivers/Peripheral/ADC.h>
                #endif

-               
+

                #include "V2Protocol.h"
                #include "V2ProtocolConstants.h"
                #include "ISP/ISPTarget.h"
 
        /* Macros: */
                #include "V2Protocol.h"
                #include "V2ProtocolConstants.h"
                #include "ISP/ISPTarget.h"
 
        /* Macros: */

-               /** Parameter privilege mask to allow the host PC to read the parameter's value */
+               /** Parameter privilege mask to allow the host PC to read the parameter's value. */

                #define PARAM_PRIV_READ     (1 << 0)
 
                #define PARAM_PRIV_READ     (1 << 0)
 

-               /** Parameter privilege mask to allow the host PC to change the parameter's value */
+               /** Parameter privilege mask to allow the host PC to change the parameter's value. */

                #define PARAM_PRIV_WRITE    (1 << 1)
                #define PARAM_PRIV_WRITE    (1 << 1)

-               
+

                /** Total number of parameters in the parameter table */
                #define TABLE_PARAM_COUNT   (sizeof(ParameterTable) / sizeof(ParameterTable[0]))
                /** Total number of parameters in the parameter table */
                #define TABLE_PARAM_COUNT   (sizeof(ParameterTable) / sizeof(ParameterTable[0]))

+               
+               #if (!defined(FIRMWARE_VERSION_MINOR) || defined(__DOXYGEN__))
+                       /** Minor firmware version, reported to the host on request; must match the version
+                        *  the host is expecting, or it (may) reject further communications with the programmer. */
+                       #define FIRMWARE_VERSION_MINOR   0x11
+               #endif

 
        /* Type Defines: */
                /** Type define for a parameter table entry indicating a PC readable or writable device parameter. */
 
        /* Type Defines: */
                /** Type define for a parameter table entry indicating a PC readable or writable device parameter. */


@@ -72,11 +78,12 @@
        /* Function Prototypes: */
                void    V2Params_LoadNonVolatileParamValues(void);
                void    V2Params_UpdateParamValues(void);
        /* Function Prototypes: */
                void    V2Params_LoadNonVolatileParamValues(void);
                void    V2Params_UpdateParamValues(void);

-       
+

                uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID);
                uint8_t V2Params_GetParameterValue(const uint8_t ParamID);
                uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID);
                uint8_t V2Params_GetParameterValue(const uint8_t ParamID);

-               void    V2Params_SetParameterValue(const uint8_t ParamID, const uint8_t Value);
-               
+               void    V2Params_SetParameterValue(const uint8_t ParamID,
+                                                  const uint8_t Value);
+

                #if defined(INCLUDE_FROM_V2PROTOCOL_PARAMS_C)
                        static ParameterItem_t* V2Params_GetParamFromTable(const uint8_t ParamID);
                #endif
                #if defined(INCLUDE_FROM_V2PROTOCOL_PARAMS_C)
                        static ParameterItem_t* V2Params_GetParamFromTable(const uint8_t ParamID);
                #endif