From 670413603f528259ade457f27fe97c70736ca754 Mon Sep 17 00:00:00 2001
From: Dean Camera <dean@fourwalledcubicle.com>
Date: Wed, 26 May 2010 11:54:55 +0000
Subject: [PATCH] The EEPROM stream read/write functions now use
 eeprom_update_byte() instead of eeprom_write_byte(), so that only changed
 bytes are written to EEPROM to preserve its lifespan.

Changed over the AVRISP-MKII and TemperatureDataLogger projects to use eeprom_update_byte() when writing non-volatile parameters to EEPROM to preserve its lifespan.
---
 LUFA/Drivers/USB/LowLevel/Endpoint.c            |  8 ++++----
 LUFA/Drivers/USB/LowLevel/Pipe.c                |  4 ++--
 LUFA/ManPages/ChangeLog.txt                     |  4 ++++
 LUFA/ManPages/FutureChanges.txt                 |  1 +
 Projects/AVRISP-MKII/Lib/V2ProtocolParams.c     | 14 +++++++++++---
 Projects/TemperatureDataLogger/TempDataLogger.c |  2 +-
 6 files changed, 23 insertions(+), 10 deletions(-)

diff --git a/LUFA/Drivers/USB/LowLevel/Endpoint.c b/LUFA/Drivers/USB/LowLevel/Endpoint.c
index c704ac7c5..15cb9d011 100644
--- a/LUFA/Drivers/USB/LowLevel/Endpoint.c
+++ b/LUFA/Drivers/USB/LowLevel/Endpoint.c
@@ -266,7 +266,7 @@ uint8_t Endpoint_Discard_Stream(uint16_t Length
 #define  TEMPLATE_BUFFER_TYPE                      void*
 #define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearOUT()
 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr++, Endpoint_Read_Byte())
+#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte((uint8_t*)BufferPtr++, Endpoint_Read_Byte())
 #include "Template/Template_Endpoint_RW.c"
 
 #define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Stream_BE
@@ -280,7 +280,7 @@ uint8_t Endpoint_Discard_Stream(uint16_t Length
 #define  TEMPLATE_BUFFER_TYPE                      void*
 #define  TEMPLATE_CLEAR_ENDPOINT()                 Endpoint_ClearOUT()
 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr--, Endpoint_Read_Byte())
+#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte((uint8_t*)BufferPtr--, Endpoint_Read_Byte())
 #include "Template/Template_Endpoint_RW.c"
 
 #endif
@@ -322,7 +322,7 @@ uint8_t Endpoint_Discard_Stream(uint16_t Length
 
 #define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Control_EStream_LE
 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr++, Endpoint_Read_Byte())
+#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte((uint8_t*)BufferPtr++, Endpoint_Read_Byte())
 #include "Template/Template_Endpoint_Control_R.c"
 
 #define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Control_Stream_BE
@@ -332,7 +332,7 @@ uint8_t Endpoint_Discard_Stream(uint16_t Length
 
 #define  TEMPLATE_FUNC_NAME                        Endpoint_Read_Control_EStream_BE
 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr--, Endpoint_Read_Byte())
+#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte((uint8_t*)BufferPtr--, Endpoint_Read_Byte())
 #include "Template/Template_Endpoint_Control_R.c"
 
 #endif
diff --git a/LUFA/Drivers/USB/LowLevel/Pipe.c b/LUFA/Drivers/USB/LowLevel/Pipe.c
index 013193064..4bfcc21e2 100644
--- a/LUFA/Drivers/USB/LowLevel/Pipe.c
+++ b/LUFA/Drivers/USB/LowLevel/Pipe.c
@@ -270,7 +270,7 @@ uint8_t Pipe_Discard_Stream(uint16_t Length
 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 #define  TEMPLATE_BUFFER_OFFSET(Length)            0
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr++, Pipe_Read_Byte())
+#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte((uint8_t*)BufferPtr++, Pipe_Read_Byte())
 #include "Template/Template_Pipe_RW.c"
 
 #define  TEMPLATE_FUNC_NAME                        Pipe_Read_Stream_BE
@@ -286,7 +286,7 @@ uint8_t Pipe_Discard_Stream(uint16_t Length
 #define  TEMPLATE_TOKEN                            PIPE_TOKEN_IN
 #define  TEMPLATE_CLEAR_PIPE()                     Pipe_ClearIN()
 #define  TEMPLATE_BUFFER_OFFSET(Length)            (Length - 1)
-#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_write_byte((uint8_t*)BufferPtr--, Pipe_Read_Byte())
+#define  TEMPLATE_TRANSFER_BYTE(BufferPtr)         eeprom_update_byte((uint8_t*)BufferPtr--, Pipe_Read_Byte())
 #include "Template/Template_Pipe_RW.c"
 
 #endif
diff --git a/LUFA/ManPages/ChangeLog.txt b/LUFA/ManPages/ChangeLog.txt
index 5233af76d..957a4e560 100644
--- a/LUFA/ManPages/ChangeLog.txt
+++ b/LUFA/ManPages/ChangeLog.txt
@@ -13,6 +13,10 @@
   *  <b>Changed:</b>
   *  - The RingBuff library code has been replaced in the XPLAINBridge project with an ultra lightweight buffer to help
   *    improve the reliability of the bridge
+  *  - The EEPROM stream read/write functions now use eeprom_update_byte() instead of eeprom_write_byte(), so that only
+  *    changed bytes are written to EEPROM to preserve its lifespan
+  *  - Changed over the AVRISP-MKII and TemperatureDataLogger projects to use eeprom_update_byte() when writing non-volatile
+  *    parameters to EEPROM to preserve its lifespan
   *
   *  <b>Fixed:</b>
   *  - Fixed AVRISP project sending a LOAD EXTENDED ADDRESS command to 128KB AVRs after programming or reading from
diff --git a/LUFA/ManPages/FutureChanges.txt b/LUFA/ManPages/FutureChanges.txt
index 108e016a9..daf239397 100644
--- a/LUFA/ManPages/FutureChanges.txt
+++ b/LUFA/ManPages/FutureChanges.txt
@@ -18,6 +18,7 @@
   *      -# Add standardized descriptor names to class driver structures
   *      -# Correct mishandling of error cases in Mass Storage demos
   *      -# Fix AVRISP-MKII clone project's XMEGA EEPROM section erase command
+  *      -# Fix occasional dropped characters in the XPLAINBridge project
   *  - Documentation/Support
   *      -# Remake AVRStudio project files
   *      -# Add detailed overviews of how each demo works
diff --git a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c
index e12fa2d24..de21f0ff2 100644
--- a/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c
+++ b/Projects/AVRISP-MKII/Lib/V2ProtocolParams.c
@@ -98,7 +98,7 @@ void V2Params_UpdateParamValues(void)
 {
 	#if (defined(ADC) && !defined(NO_VTARGET_DETECT))
 	/* Update VTARGET parameter with the latest ADC conversion of VTARGET on supported AVR models */
-	V2Params_GetParamFromTable(PARAM_VTARGET)->ParamValue = ((5 * 10 * ADC_GetResult()) / 1024);
+	V2Params_SetParameterValue(PARAM_VTARGET, ((5 * 10 * ADC_GetResult()) / 1024));
 	#endif
 }
 
@@ -121,6 +121,10 @@ uint8_t V2Params_GetParameterPrivileges(const uint8_t ParamID)
 }
 
 /** Retrieves the current value for a given parameter in the parameter table.
+ *
+ *  \note This function does not first check for read privileges - if the value is being sent to the host via a
+ *        GET PARAM command, \ref V2Params_GetParameterPrivileges() should be called first to ensure that the
+ *        parameter is host-readable.
  *
  *  \param[in] ParamID  Parameter ID whose value is to be retrieved from the table
  *
@@ -137,6 +141,10 @@ uint8_t V2Params_GetParameterValue(const uint8_t ParamID)
 }
 
 /** Sets the value for a given parameter in the parameter table.
+ *
+ *  \note This function does not first check for write privileges - if the value is being sourced from the host
+ *        via a SET PARAM command, \ref V2Params_GetParameterPrivileges() should be called first to ensure that the
+ *        parameter is host-writable.
  *
  *  \param[in] ParamID  Parameter ID whose value is to be set in the table
  *  \param[in] Value    New value to set the parameter to
@@ -153,8 +161,8 @@ void V2Params_SetParameterValue(const uint8_t ParamID, const uint8_t Value)
 	ParamInfo->ParamValue = Value;
 
 	/* The target RESET line polarity is a non-volatile parameter, save to EEPROM when changed */
-	if ((ParamID == PARAM_RESET_POLARITY) && (eeprom_read_byte(&EEPROM_Rest_Polarity) != Value))
-	  eeprom_write_byte(&EEPROM_Rest_Polarity, Value);  
+	if (ParamID == PARAM_RESET_POLARITY)
+	  eeprom_update_byte(&EEPROM_Rest_Polarity, Value);  
 }
 
 /** Retrieves a parameter entry (including ID, value and privileges) from the parameter table that matches the given
diff --git a/Projects/TemperatureDataLogger/TempDataLogger.c b/Projects/TemperatureDataLogger/TempDataLogger.c
index a50903f54..d464cbe79 100644
--- a/Projects/TemperatureDataLogger/TempDataLogger.c
+++ b/Projects/TemperatureDataLogger/TempDataLogger.c
@@ -308,6 +308,6 @@ void CALLBACK_HID_Device_ProcessHIDReport(USB_ClassInfo_HID_Device_t* const HIDI
 	if (LoggingInterval500MS_SRAM != ReportParams->LogInterval500MS)
 	{
 		LoggingInterval500MS_SRAM = ReportParams->LogInterval500MS;
-		eeprom_write_byte(&LoggingInterval500MS_EEPROM, LoggingInterval500MS_SRAM);
+		eeprom_update_byte(&LoggingInterval500MS_EEPROM, LoggingInterval500MS_SRAM);
 	}
 }
-- 
GitLab