Partial Commit: Move AVRISP project out of the Projects\Incomplete directory.
[pub/lufa.git] / Projects / AVRISP / Lib / V2ProtocolParams.c
diff --git a/Projects/AVRISP/Lib/V2ProtocolParams.c b/Projects/AVRISP/Lib/V2ProtocolParams.c
new file mode 100644 (file)
index 0000000..9914c08
--- /dev/null
@@ -0,0 +1,166 @@
+/*\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
+ *  V2Protocol parameter handler, to process V2 Protocol device parameters.\r
+ */\r
+\r
+#define  INCLUDE_FROM_V2PROTOCOL_PARAMS_C\r
+#include "V2ProtocolParams.h"\r
+\r
+/* Non-Volatile Parameter Values for EEPROM storage */\r
+uint8_t EEMEM EEPROM_Rest_Polarity = 0x00;\r
+\r
+/* Volatile Parameter Values for RAM storage */\r
+static ParameterItem_t ParameterTable[] = \r
+       {\r
+               { .ParamID          = PARAM_BUILD_NUMBER_LOW,\r
+                 .ParamValue       = (LUFA_VERSION_INTEGER >> 8),\r
+                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+\r
+               { .ParamID          = PARAM_BUILD_NUMBER_HIGH,\r
+                 .ParamValue       = (LUFA_VERSION_INTEGER & 0xFF),\r
+                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+\r
+               { .ParamID          = PARAM_HW_VER,\r
+                 .ParamValue       = 0x00,\r
+                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+\r
+               { .ParamID          = PARAM_SW_MAJOR,\r
+                 .ParamValue       = 0x01,\r
+                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+\r
+               { .ParamID          = PARAM_SW_MINOR,\r
+                 .ParamValue       = 0x0C,\r
+                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+\r
+               { .ParamID          = PARAM_VTARGET,\r
+                 .ParamValue       = 0x32,\r
+                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+\r
+               { .ParamID          = PARAM_SCK_DURATION,\r
+                 .ParamValue       = (TOTAL_PROGRAMMING_SPEEDS - 1),\r
+                 .ParamPrivellages = PARAM_PRIV_READ | PARAM_PRIV_WRITE },\r
+\r
+               { .ParamID          = PARAM_RESET_POLARITY,\r
+                 .ParamValue       = 0x00,\r
+                 .ParamPrivellages = PARAM_PRIV_WRITE                   },\r
+\r
+               { .ParamID          = PARAM_STATUS_TGT_CONN,\r
+                 .ParamValue       = 0x00,\r
+                 .ParamPrivellages = PARAM_PRIV_READ                    },\r
+\r
+               { .ParamID          = PARAM_DISCHARGEDELAY,\r
+                 .ParamValue       = 0x00,\r
+                 .ParamPrivellages = PARAM_PRIV_WRITE                   },\r
+       };\r
+\r
+\r
+/** Loads saved non-volatile parameter values from the EEPROM into the parameter table, as needed. */\r
+void V2Params_LoadEEPROMParamValues(void)\r
+{\r
+       /* Target RESET line polarity is a non-volatile value, retrieve current parameter value from EEPROM */\r
+       V2Params_GetParamFromTable(PARAM_RESET_POLARITY)->ParamValue = eeprom_read_byte(&EEPROM_Rest_Polarity);\r
+}\r
+\r
+/** Retrieves the host PC read/write privellages for a given parameter in the parameter table. This should\r
+ *  be called before calls to \ref V2Params_GetParameterValue() or \ref V2Params_SetParameterValue() when\r
+ *  getting or setting parameter values in response to requests from the host.\r
+ *\r
+ *  \param ParamID  Parameter ID whose privellages are to be retrieved from the table\r
+ *\r
+ *  \return Privellages for the requested parameter, as a mask of PARAM_PRIV_* masks\r
+ */ \r
+uint8_t V2Params_GetParameterPrivellages(uint8_t ParamID)\r
+{\r
+       ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
+       \r
+       if (ParamInfo == NULL)\r
+         return 0;\r
+\r
+       return ParamInfo->ParamPrivellages;\r
+}\r
+\r
+/** Retrieves the current value for a given parameter in the parameter table.\r
+ *\r
+ *  \param ParamID  Parameter ID whose value is to be retrieved from the table\r
+ *\r
+ *  \return Current value of the parameter in the table, or 0 if not found\r
+ */ \r
+uint8_t V2Params_GetParameterValue(uint8_t ParamID)\r
+{\r
+       ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
+       \r
+       if (ParamInfo == NULL)\r
+         return 0;\r
+       \r
+       return ParamInfo->ParamValue;\r
+}\r
+\r
+/** Sets the value for a given parameter in the parameter table.\r
+ *\r
+ *  \param ParamID  Parameter ID whose value is to be set in the table\r
+ *  \param Value  New value to set the parameter to\r
+ *\r
+ *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise\r
+ */\r
+void V2Params_SetParameterValue(uint8_t ParamID, uint8_t Value)\r
+{\r
+       ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);\r
+\r
+       if (ParamInfo == NULL)\r
+         return;\r
+\r
+       ParamInfo->ParamValue = Value;\r
+\r
+       /* The target RESET line polarity is a non-volatile parameter, save to EEPROM when changed */\r
+       if (ParamID == PARAM_RESET_POLARITY)\r
+         eeprom_write_byte(&EEPROM_Rest_Polarity, Value);  \r
+}\r
+\r
+/** Retrieves a parameter entry (including ID, value and privellages) from the parameter table that matches the given\r
+ *  parameter ID.\r
+ *\r
+ *  \param ParamID  Parameter ID to find in the table\r
+ *\r
+ *  \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise\r
+ */\r
+static ParameterItem_t* V2Params_GetParamFromTable(uint8_t ParamID)\r
+{\r
+       /* Find the parameter in the parameter table if present */\r
+       for (uint8_t TableIndex = 0; TableIndex < (sizeof(ParameterTable) / sizeof(ParameterTable[0])); TableIndex++)\r
+       {\r
+               if (ParamID == ParameterTable[TableIndex].ParamID)\r
+                 return &ParameterTable[TableIndex];\r
+       }\r
+       \r
+       return NULL;\r
+}\r