Partial Commit: Move AVRISP project out of the Projects\Incomplete directory.

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

diff --git a/Projects/AVRISP/Lib/V2ProtocolParams.h b/Projects/AVRISP/Lib/V2ProtocolParams.h
new file mode 100644 (file)
index 0000000..9c0f044
--- /dev/null
+++ b/Projects/AVRISP/Lib/V2ProtocolParams.h
@@ -0,0 +1,76 @@
+/*\r
+             LUFA Library\r
+     Copyright (C) Dean Camera, 2009.\r
+              \r
+  dean [at] fourwalledcubicle [dot] com\r
+      www.fourwalledcubicle.com\r
+*/\r
+\r
+/*\r
+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)\r
+\r
+  Permission to use, copy, modify, and distribute this software\r
+  and its documentation for any purpose and without fee is hereby\r
+  granted, provided that the above copyright notice appear in all\r
+  copies and that both that the copyright notice and this\r
+  permission notice and warranty disclaimer appear in supporting\r
+  documentation, and that the name of the author not be used in\r
+  advertising or publicity pertaining to distribution of the\r
+  software without specific, written prior permission.\r
+\r
+  The author disclaim all warranties with regard to this\r
+  software, including all implied warranties of merchantability\r
+  and fitness.  In no event shall the author be liable for any\r
+  special, indirect or consequential damages or any damages\r
+  whatsoever resulting from loss of use, data or profits, whether\r
+  in an action of contract, negligence or other tortious action,\r
+  arising out of or in connection with the use or performance of\r
+  this software.\r
+*/\r
+\r
+/** \file\r
+ *\r
+ *  Header file for V2ProtocolParams.c.\r
+ */\r
+\r
+#ifndef _V2_PROTOCOL_PARAMS_
+#define _V2_PROTOCOL_PARAMS_
+
+       /* Includes: */
+               #include <avr/io.h>\r
+               #include <avr/eeprom.h>
+\r
+               #include <LUFA/Version.h>
+\r
+               #include "V2Protocol.h"\r
+               #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; /**< 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
+               void    V2Params_LoadEEPROMParamValues(void);\r
+       \r
+               uint8_t V2Params_GetParameterPrivellages(uint8_t ParamID);\r
+               uint8_t V2Params_GetParameterValue(uint8_t ParamID);\r
+               void    V2Params_SetParameterValue(uint8_t ParamID, uint8_t Value);\r
+               \r
+               #if defined(INCLUDE_FROM_V2PROTOCOL_PARAMS_C)\r
+                       static ParameterItem_t* V2Params_GetParamFromTable(uint8_t ParamID);\r
+               #endif\r
+
+#endif
+