Moved out the handling of V2 Protocol parameters to a seperate set of files. Added parameter privellages, so that an error can be returned to the host when trying to perform a get/set value action on a parameter without the correct privellages.

6 files changed, 239 insertions, 89 deletions

diff --git a/Projects/Unfinished/AVRISP/AVRISP.c b/Projects/Unfinished/AVRISP/AVRISP.c
index e937253e3..0b101247f 100644
--- a/Projects/Unfinished/AVRISP/AVRISP.c
+++ b/Projects/Unfinished/AVRISP/AVRISP.c
@@ -43,7 +43,7 @@ int main(void)
 {

 	SetupHardware();

 

-	V2Protocol_Init();

+	V2Params_LoadEEPROMParamValues();

 

 	printf("AVRISP-MKII Clone\r\n");

 	

@@ -100,7 +100,8 @@ void EVENT_USB_Device_ConfigurationChanged(void)
 		LEDs_SetAllLEDs(LEDMASK_USB_ERROR);

 	}

 }

-
+

+/** Processes incomming V2 Protocol commands from the host, returning a response when required. */
 void Process_AVRISP_Commands(void)
 {
 	/* Device must be connected and configured for the task to run */

diff --git a/Projects/Unfinished/AVRISP/Lib/V2Protocol.c b/Projects/Unfinished/AVRISP/Lib/V2Protocol.c
index 905214c6d..403889241 100644
--- a/Projects/Unfinished/AVRISP/Lib/V2Protocol.c
+++ b/Projects/Unfinished/AVRISP/Lib/V2Protocol.c
@@ -37,7 +37,7 @@
 #include "V2Protocol.h"

 

 /* Table of masks for SPI_Init() from a given PARAM_SCK_DURATION value */

-static const uint8_t SPIMaskFromSCKDuration[] =

+static const uint8_t SPIMaskFromSCKDuration[MAX_SPI_SETTINGS] =

 	{

 		#if (F_CPU == 8000000)

 		SPI_SPEED_FCPU_DIV_2,

@@ -48,42 +48,13 @@ static const uint8_t SPIMaskFromSCKDuration[] =
 		, SPI_SPEED_FCPU_DIV_128

 		#endif

 	};

-	

-/* Non-Volatile Parameter Values for EEPROM storage */

-uint8_t EEMEM EEPROM_Rest_Polarity;

-

-/* Volatile Parameter Values for RAM storage */

-static ParameterItem_t ParameterTable[] = 

-	{

-		{ .ParameterID    = PARAM_BUILD_NUMBER_LOW,

-		  .ParameterValue = (LUFA_VERSION_INTEGER >> 8)    },

-		{ .ParameterID    = PARAM_BUILD_NUMBER_HIGH,

-		  .ParameterValue = (LUFA_VERSION_INTEGER & 0xFF)  },

-		{ .ParameterID    = PARAM_HW_VER,

-		  .ParameterValue = 0x01                           },

-		{ .ParameterID    = PARAM_SW_MAJOR,

-		  .ParameterValue = 0x01                           },

-		{ .ParameterID    = PARAM_SW_MINOR,

-		  .ParameterValue = 0x00                           },

-		{ .ParameterID    = PARAM_VTARGET,

-		  .ParameterValue = 0x00                           },

-		{ .ParameterID    = PARAM_SCK_DURATION,

-		  .ParameterValue = sizeof(SPIMaskFromSCKDuration) },

-		{ .ParameterID    = PARAM_RESET_POLARITY,

-		  .ParameterValue = 0x01                           },

-		{ .ParameterID    = PARAM_STATUS_TGT_CONN,

-		  .ParameterValue = 0x00                           },

-		{ .ParameterID    = PARAM_DISCHARGEDELAY,

-		  .ParameterValue = 0x00                           },

-	};

-

 

 static void V2Protocol_ReconfigureSPI(void)

 {

-	uint8_t SCKDuration = V2Protocol_GetParameter(PARAM_SCK_DURATION);

+	uint8_t SCKDuration = V2Params_GetParameterValue(PARAM_SCK_DURATION);

 

-	if (SCKDuration >= sizeof(SPIMaskFromSCKDuration))

-	  SCKDuration = (sizeof(SPIMaskFromSCKDuration) - 1);

+	if (SCKDuration >= MAX_SPI_SETTINGS)

+	  SCKDuration = (MAX_SPI_SETTINGS - 1);

 	  

 	SPI_Init(SPIMaskFromSCKDuration[SCKDuration], true);	

 }

@@ -94,7 +65,7 @@ static void V2Protocol_ChangeTargetResetLine(bool ResetTarget)
 	{

 		RESET_LINE_DDR  |= RESET_LINE_MASK;

 		

-		if (!(V2Protocol_GetParameter(PARAM_RESET_POLARITY)))

+		if (!(V2Params_GetParameterValue(PARAM_RESET_POLARITY)))

 		  RESET_LINE_PORT |= RESET_LINE_MASK;

 	}

 	else

@@ -103,41 +74,6 @@ static void V2Protocol_ChangeTargetResetLine(bool ResetTarget)
 		RESET_LINE_DDR  &= ~RESET_LINE_MASK;

 	}

 }

-

-static uint8_t V2Protocol_GetParameter(uint8_t ParamID)

-{

-	/* Find the parameter in the parameter table and retrieve the value */

-	for (uint8_t TableIndex = 0; TableIndex < (sizeof(ParameterTable) / sizeof(ParameterTable[0])); TableIndex++)

-	{

-		if (ParamID == ParameterTable[TableIndex].ParameterID)

-		  return ParameterTable[TableIndex].ParameterValue;

-	}

-	

-	return 0;

-}

-

-static void V2Protocol_SetParameter(uint8_t ParamID, uint8_t Value)

-{

-	/* The target RESET line polarity is a non-volatile parameter, save to EEPROM when changed */

-	if (ParamID == PARAM_RESET_POLARITY)

-	  eeprom_write_byte(&EEPROM_Rest_Polarity, Value);

-

-	/* Find the parameter in the parameter table and store the new value */

-	for (uint8_t TableIndex = 0; TableIndex < (sizeof(ParameterTable) / sizeof(ParameterTable[0])); TableIndex++)

-	{

-		if (ParamID == ParameterTable[TableIndex].ParameterID)

-		{

-			ParameterTable[TableIndex].ParameterValue = Value;

-			return;

-		}

-	}

-}

-

-void V2Protocol_Init(void)

-{

-	/* Target RESET line polarity is a non-volatile value, retrieve current parameter value from EEPROM */

-	V2Protocol_SetParameter(PARAM_RESET_POLARITY, eeprom_read_byte(&EEPROM_Rest_Polarity));

-}

 
 void V2Protocol_ProcessCommand(void)
 {
@@ -206,13 +142,24 @@ static void V2Protocol_Command_GetSetParam(uint8_t V2Command)
 	Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);

 	Endpoint_WaitUntilReady();

 	

+	uint8_t ParamPrivs = V2Params_GetParameterPrivellages(ParamID);

+	

 	Endpoint_Write_Byte(V2Command);

-	Endpoint_Write_Byte(STATUS_CMD_OK);

-

-	if (V2Command == CMD_SET_PARAMETER)

-	  V2Protocol_SetParameter(ParamID, ParamValue);

+	

+	if ((V2Command == CMD_SET_PARAMETER) && (ParamPrivs & PARAM_PRIV_WRITE))

+	{

+		Endpoint_Write_Byte(STATUS_CMD_OK);

+		V2Params_SetParameterValue(ParamID, ParamValue);

+	}

+	else if ((V2Command == CMD_GET_PARAMETER) && (ParamPrivs & PARAM_PRIV_READ))

+	{

+		Endpoint_Write_Byte(STATUS_CMD_OK);

+		Endpoint_Write_Byte(V2Params_GetParameterValue(ParamID));

+	}

 	else

-	  Endpoint_Write_Byte(V2Protocol_GetParameter(ParamID));

+	{	

+		Endpoint_Write_Byte(STATUS_CMD_FAILED);

+	}

 

 	Endpoint_ClearIN();

 }

diff --git a/Projects/Unfinished/AVRISP/Lib/V2Protocol.h b/Projects/Unfinished/AVRISP/Lib/V2Protocol.h
index 7b9f1b12f..9f6b83b47 100644
--- a/Projects/Unfinished/AVRISP/Lib/V2Protocol.h
+++ b/Projects/Unfinished/AVRISP/Lib/V2Protocol.h
@@ -45,30 +45,22 @@
 		#include <LUFA/Drivers/Peripheral/SPI.h>

 		

 		#include "../Descriptors.h"
-		#include "V2ProtocolConstants.h"
+		#include "V2ProtocolConstants.h"

+		#include "V2ProtocolParams.h"
 
 	/* Macros: */
 		#define PROGRAMMER_ID       "AVRISP_MK2"
-		#define PROGRAMMER_ID_LEN   (sizeof(PROGRAMMER_ID) - 1)

-		

-	/* Type Defines: */

-		typedef struct

-		{

-			uint8_t ParameterID;

-			uint8_t ParameterValue;

-		} ParameterItem_t;
+		#define PROGRAMMER_ID_LEN   (sizeof(PROGRAMMER_ID) - 1)
+

+		#define MAX_SPI_SETTINGS    7

 
 	/* Function Prototypes: */

-		void V2Protocol_Init(void);

 		void V2Protocol_ProcessCommand(void);

 		

 		#if defined(INCLUDE_FROM_V2PROTOCOL_C)

 			static void    V2Protocol_ReconfigureSPI(void);

 			static void    V2Protocol_ChangeTargetResetLine(bool ResetTarget);

 

-			static uint8_t V2Protocol_GetParameter(uint8_t ParamID);

-			static void    V2Protocol_SetParameter(uint8_t ParamID, uint8_t Value);

-

 			static void    V2Protocol_Command_Unknown(uint8_t V2Command);

 			static void    V2Protocol_Command_SignOn(void);

 			static void    V2Protocol_Command_GetSetParam(uint8_t V2Command);

diff --git a/Projects/Unfinished/AVRISP/Lib/V2ProtocolParams.c b/Projects/Unfinished/AVRISP/Lib/V2ProtocolParams.c
new file mode 100644
index 000000000..777770188
--- /dev/null
+++ b/Projects/Unfinished/AVRISP/Lib/V2ProtocolParams.c
@@ -0,0 +1,137 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2009.

+              

+  dean [at] fourwalledcubicle [dot] com

+      www.fourwalledcubicle.com

+*/

+

+/*

+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

+

+  Permission to use, copy, modify, and distribute this software

+  and its documentation for any purpose and without fee is hereby

+  granted, provided that the above copyright notice appear in 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

+  software without specific, written prior permission.

+

+  The author disclaim all warranties with regard to this

+  software, including all implied warranties of merchantability

+  and fitness.  In no event shall the author be liable for any

+  special, indirect or consequential damages or any damages

+  whatsoever resulting from loss of use, data or profits, whether

+  in an action of contract, negligence or other tortious action,

+  arising out of or in connection with the use or performance of

+  this software.

+*/

+

+/** \file

+ *

+ *  V2Protocol parameter handler, to process V2 Protocol device parameters.

+ */

+

+#define  INCLUDE_FROM_V2PROTOCOL_PARAMS_C

+#include "V2ProtocolParams.h"

+

+/* Non-Volatile Parameter Values for EEPROM storage */

+uint8_t EEMEM EEPROM_Rest_Polarity;

+

+/* Volatile Parameter Values for RAM storage */

+static ParameterItem_t ParameterTable[] = 

+	{

+		{ .ParamID          = PARAM_BUILD_NUMBER_LOW,

+		  .ParamValue       = (LUFA_VERSION_INTEGER >> 8),

+		  .ParamPrivellages = PARAM_PRIV_READ                    },

+

+		{ .ParamID          = PARAM_BUILD_NUMBER_HIGH,

+		  .ParamValue       = (LUFA_VERSION_INTEGER & 0xFF),

+		  .ParamPrivellages = PARAM_PRIV_READ                    },

+

+		{ .ParamID          = PARAM_HW_VER,

+		  .ParamValue       = 0x01,

+		  .ParamPrivellages = PARAM_PRIV_READ                    },

+

+		{ .ParamID          = PARAM_SW_MAJOR,

+		  .ParamValue       = 0x01,

+		  .ParamPrivellages = PARAM_PRIV_READ                    },

+

+		{ .ParamID          = PARAM_SW_MINOR,

+		  .ParamValue       = 0x00,

+		  .ParamPrivellages = PARAM_PRIV_READ                    },

+

+		{ .ParamID          = PARAM_VTARGET,

+		  .ParamValue       = 0x00,

+		  .ParamPrivellages = PARAM_PRIV_READ                    },

+

+		{ .ParamID          = PARAM_SCK_DURATION,

+		  .ParamValue       = MAX_SPI_SETTINGS,

+		  .ParamPrivellages = PARAM_PRIV_READ | PARAM_PRIV_WRITE },

+

+		{ .ParamID          = PARAM_RESET_POLARITY,

+		  .ParamValue       = 0x01,

+		  .ParamPrivellages = PARAM_PRIV_WRITE                   },

+

+		{ .ParamID          = PARAM_STATUS_TGT_CONN,

+		  .ParamValue       = 0x00,

+		  .ParamPrivellages = PARAM_PRIV_READ                    },

+

+		{ .ParamID          = PARAM_DISCHARGEDELAY,

+		  .ParamValue       = 0x00,

+		  .ParamPrivellages = PARAM_PRIV_WRITE                   },

+	};

+

+

+void V2Params_LoadEEPROMParamValues(void)

+{

+	/* Target RESET line polarity is a non-volatile value, retrieve current parameter value from EEPROM */

+	V2Params_GetParamFromTable(PARAM_RESET_POLARITY)->ParamValue = eeprom_read_byte(&EEPROM_Rest_Polarity);

+}

+

+static ParameterItem_t* V2Params_GetParamFromTable(uint8_t ParamID)

+{

+	/* Find the parameter in the parameter table if present */

+	for (uint8_t TableIndex = 0; TableIndex < (sizeof(ParameterTable) / sizeof(ParameterTable[0])); TableIndex++)

+	{

+		if (ParamID == ParameterTable[TableIndex].ParamID)

+		  return &ParameterTable[TableIndex];

+	}

+	

+	return NULL;

+}

+

+uint8_t V2Params_GetParameterPrivellages(uint8_t ParamID)

+{

+	ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);

+	

+	if (ParamInfo == NULL)

+	  return 0;

+

+	return ParamInfo->ParamPrivellages;

+}

+

+uint8_t V2Params_GetParameterValue(uint8_t ParamID)

+{

+	ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);

+	

+	if (ParamInfo == NULL)

+	  return 0;

+	

+	return ParamInfo->ParamValue;

+}

+

+void V2Params_SetParameterValue(uint8_t ParamID, uint8_t Value)

+{

+	ParameterItem_t* ParamInfo = V2Params_GetParamFromTable(ParamID);

+

+	if (ParamInfo == NULL)

+	  return;

+

+	ParamInfo->ParamValue = Value;

+

+	/* The target RESET line polarity is a non-volatile parameter, save to EEPROM when changed */

+	if (ParamID == PARAM_RESET_POLARITY)

+	  eeprom_write_byte(&EEPROM_Rest_Polarity, Value);

+}

diff --git a/Projects/Unfinished/AVRISP/Lib/V2ProtocolParams.h b/Projects/Unfinished/AVRISP/Lib/V2ProtocolParams.h
new file mode 100644
index 000000000..4797c9fa8
--- /dev/null
+++ b/Projects/Unfinished/AVRISP/Lib/V2ProtocolParams.h
@@ -0,0 +1,72 @@
+/*

+             LUFA Library

+     Copyright (C) Dean Camera, 2009.

+              

+  dean [at] fourwalledcubicle [dot] com

+      www.fourwalledcubicle.com

+*/

+

+/*

+  Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)

+

+  Permission to use, copy, modify, and distribute this software

+  and its documentation for any purpose and without fee is hereby

+  granted, provided that the above copyright notice appear in 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

+  software without specific, written prior permission.

+

+  The author disclaim all warranties with regard to this

+  software, including all implied warranties of merchantability

+  and fitness.  In no event shall the author be liable for any

+  special, indirect or consequential damages or any damages

+  whatsoever resulting from loss of use, data or profits, whether

+  in an action of contract, negligence or other tortious action,

+  arising out of or in connection with the use or performance of

+  this software.

+*/

+

+/** \file

+ *

+ *  Header file for V2ProtocolParams.c.

+ */

+

+#ifndef _V2_PROTOCOL_PARAMS_
+#define _V2_PROTOCOL_PARAMS_
+
+	/* Includes: */
+		#include <avr/io.h>

+		#include <avr/eeprom.h>
+

+		#include <LUFA/Version.h>
+

+		#include "V2Protocol.h"

+		#include "V2ProtocolConstants.h"

+

+	/* Macros: */

+		#define PARAM_PRIV_READ   (1 << 0)

+		#define PARAM_PRIV_WRITE  (1 << 1)

+
+	/* Type Defines: */

+		typedef struct

+		{

+			const uint8_t ParamID;

+			uint8_t ParamValue;

+			uint8_t ParamPrivellages;

+		} ParameterItem_t;
+
+	/* Function Prototypes: */

+		void    V2Params_LoadEEPROMParamValues(void);

+	

+		uint8_t V2Params_GetParameterPrivellages(uint8_t ParamID);

+		uint8_t V2Params_GetParameterValue(uint8_t ParamID);

+		void    V2Params_SetParameterValue(uint8_t ParamID, uint8_t Value);

+		

+		#if defined(INCLUDE_FROM_V2PROTOCOL_PARAMS_C)

+			static ParameterItem_t* V2Params_GetParamFromTable(uint8_t ParamID);

+		#endif

+
+#endif
+
diff --git a/Projects/Unfinished/AVRISP/makefile b/Projects/Unfinished/AVRISP/makefile
index d2128dcf3..958d9abae 100644
--- a/Projects/Unfinished/AVRISP/makefile
+++ b/Projects/Unfinished/AVRISP/makefile
@@ -136,6 +136,7 @@ LUFA_OPTS += -D USE_STATIC_OPTIONS="(USB_DEVICE_OPT_FULLSPEED | USB_OPT_REG_ENAB
 SRC = $(TARGET).c                                                 \

 	  Descriptors.c                                               \
       Lib/V2Protocol.c                                            \

+      Lib/V2ProtocolParams.c                                      \

 	  $(LUFA_PATH)/LUFA/Drivers/Peripheral/SerialStream.c         \

 	  $(LUFA_PATH)/LUFA/Drivers/USB/LowLevel/DevChapter9.c        \

 	  $(LUFA_PATH)/LUFA/Drivers/USB/LowLevel/Endpoint.c           \