aboutsummaryrefslogtreecommitdiffstats
path: root/Projects/Incomplete/AVRISP/Lib/V2ProtocolParams.h
diff options
context:
space:
mode:
Diffstat (limited to 'Projects/Incomplete/AVRISP/Lib/V2ProtocolParams.h')
-rw-r--r--Projects/Incomplete/AVRISP/Lib/V2ProtocolParams.h10
1 files changed, 7 insertions, 3 deletions
diff --git a/Projects/Incomplete/AVRISP/Lib/V2ProtocolParams.h b/Projects/Incomplete/AVRISP/Lib/V2ProtocolParams.h
index 4797c9fa8..d0a467b00 100644
--- a/Projects/Incomplete/AVRISP/Lib/V2ProtocolParams.h
+++ b/Projects/Incomplete/AVRISP/Lib/V2ProtocolParams.h
@@ -46,15 +46,19 @@
#include "V2ProtocolConstants.h"
/* Macros: */
+ /* Parameter privellage mask to allow the host PC to read the parameter's value */
#define PARAM_PRIV_READ (1 << 0)
+
+ /* Parameter privellage mask to allow the host PC to change the parameter's value */
#define PARAM_PRIV_WRITE (1 << 1)
/* Type Defines: */
+ /** Type define for a parameter table entry indicating a PC readable or writable device parameter. */
typedef struct
{
- const uint8_t ParamID;
- uint8_t ParamValue;
- uint8_t ParamPrivellages;
+ const uint8_t ParamID; /**< Parameter ID number to uniquely identify the parameter within the device */
+ uint8_t ParamValue; /**< Current parameter's value within the device */
+ uint8_t ParamPrivellages; /**< Parameter privellages to allow the host to read or write the parameter's value */
} ParameterItem_t;
/* Function Prototypes: */