#include "V2ProtocolConstants.h"\r
\r
/* Macros: */\r
+ /* Parameter privellage mask to allow the host PC to read the parameter's value */\r
#define PARAM_PRIV_READ (1 << 0)\r
+\r
+ /* Parameter privellage mask to allow the host PC to change the parameter's value */\r
#define PARAM_PRIV_WRITE (1 << 1)\r
/* Type Defines: */\r
+ /** Type define for a parameter table entry indicating a PC readable or writable device parameter. */\r
typedef struct\r
{\r
- const uint8_t ParamID;\r
- uint8_t ParamValue;\r
- uint8_t ParamPrivellages;\r
+ const uint8_t ParamID; /**< Parameter ID number to uniquely identify the parameter within the device */\r
+ uint8_t ParamValue; /**< Current parameter's value within the device */\r
+ uint8_t ParamPrivellages; /**< Parameter privellages to allow the host to read or write the parameter's value */\r
} ParameterItem_t;
/* Function Prototypes: */\r