Merge pull request #6 from 1a2m3/1a2m3-patch-20211116

20211119 updates

Author: 1a2m3

firmware/SpdReaderWriter.ino

@@ -16,13 +16,12 @@
 #include <EEPROM.h>
 #include "SpdReaderWriterSettings.h"  // Settings
 
-#define VERSION 20211111  // Version number (YYYYMMDD)
+#define VERSION 20211119  // Version number (YYYYMMDD)
 
-// RSWP RAM support bitmask
-#define DDR2 (1 << 2)
-#define DDR3 (1 << 3)
-#define DDR4 (1 << 4)
-#define DDR5 (1 << 5)
+// RSWP RAM support bitmasks
+#define DDR5 (1 << 5) // Offline mode control
+#define DDR4 (1 << 4) // VHV control
+#define DDR3 (1 << 3) // VHV+SA1 controls
 
 // SPD5 hub registers
 #pragma region SPD5 hub registers
@@ -106,6 +105,7 @@
 #define DDR4DETECT   '4' // DDR4 detection test
 #define DDR5DETECT   '5' // DDR5 detection test
 #define RETESTRSWP   'e' // Reevaluate RSWP capabilities
+#define FACTORYRESET '-' // Factory reset device settings
 #pragma endregion
 
 // Device pin names
@@ -121,24 +121,27 @@
 #define UNKNOWN (char) '?'
 
 // Pin states
-#define ON      HIGH
-#define OFF     LOW
-#define ENABLE  1
-#define SET     1
-#define DISABLE 0
-#define RESET   0
-#define GET    '?'  // Suffix added to commands to return current state
+#define ON             HIGH
+#define OFF            LOW
+#define ENABLE  (byte) 0x01
+#define SET     (byte) 0x01
+#define DISABLE (byte) 0x00
+#define RESET   (byte) 0x00
+#define GET     (char) '?'  // Suffix added to commands to return current state
 
 // Device name settings
 #define NAMELENGTH 16
 char deviceName[NAMELENGTH];
 
-// Device i2c clock settings
-uint8_t clockSettings = 0x20;    // EEPROM location to store I2C clock
-uint32_t i2cClock     = 100000L; // Initial I2C clock
+// Device settings
+#define DEVICESETTINGS 0x20 // EEPROM location to store device settings
+#define CLOCKMODE      0    // Bit position for I2C clock settings
+#define FASTMODE       true
+#define STDMODE        false
 
 // Global variables
-uint8_t rswpSupport = 0;                      // Bitmask representing RAM RSWP support
+uint32_t i2cClock         = 100000L;          // Initial I2C clock
+uint8_t rswpSupport       = 0;                // Bitmask representing RAM RSWP support
 uint8_t eepromPageAddress = 0;                // Initial EEPROM page address
 const int pins[] = { OFF_EN, SA1_EN, HV_EN }; // Configuration pins array
 
@@ -156,7 +159,7 @@ void setup() {
   // Initiate and join the I2C bus as a master
   Wire.begin();
 
-  // Perform device features test
+  // Perform initial device RSWP support test
   rswpSupport = rswpSupportTest();
 
   // Check saved i2c clock and set mode accordingly
@@ -196,7 +199,7 @@ void parseCommand() {
     return;
   }
 
-  char cmd = PORT.read();
+  char cmd = (char) PORT.read();
 
   switch (cmd) {
 
@@ -277,7 +280,12 @@ void parseCommand() {
     // Device name controls
     case NAME: 
       cmdName();
-      break;    
+      break;
+
+    // Factory defaults restore
+    case FACTORYRESET:
+      cmdFactoryReset();
+      break; 
   }
 }
 
@@ -442,7 +450,7 @@ void cmdI2CClock() {
   PORT.readBytes(buffer, sizeof(buffer));
 
   // Set I2C clock
-  if (buffer[0] == ENABLE || buffer[0] == DISABLE) {
+  if (buffer[0] == FASTMODE || buffer[0] == STDMODE) {
     setI2cClockMode(buffer[0]);
     PORT.write(getI2cClockMode() == buffer[0] ? SUCCESS : ERROR);
   }
@@ -456,6 +464,10 @@ void cmdI2CClock() {
   }  
 }
 
+bool cmdFactoryReset() {
+  PORT.write(factoryReset() ? SUCCESS : ERROR);
+}
+
 void cmdRSWP() {
 
   // Data buffer
@@ -709,7 +721,7 @@ byte rswpSupportTest() {
     if ((setConfigPin(SA1_EN, ON) && setConfigPin(SA1_EN, OFF)) && 
         (setConfigPin(SA1_EN, ON)  ^ scanBus()) != 
         (setConfigPin(SA1_EN, OFF) ^ scanBus())) {
-      rswpSupport |= DDR3 | DDR2;
+      rswpSupport |= DDR3;
     }
   }
 
@@ -888,7 +900,7 @@ void setLegacyModeAddress(uint8_t address, bool twoByteAddressing) {
 }
 
 
-/*  -=  Device name functions =-  */
+/*  -=  Device settings functions =-  */
 
 // Assign a new name
 bool setName(String name) {
@@ -915,20 +927,33 @@ String getName() {
   return deviceNameChar;
 }
 
+// Read device settings
+bool getSettings(byte name) {
+  return bitRead(EEPROM.read(DEVICESETTINGS), name);
+}
+
+// Save device settings
+bool saveSettings(byte name, byte value) {
+
+  byte currentSettings = EEPROM.read(DEVICESETTINGS);
+  EEPROM.update(DEVICESETTINGS, bitWrite(currentSettings, name, value));
+}
+
 
 /*  -=  I2C bus functions  =-  */
 
 // Set I2C bus clock mode
-bool setI2cClockMode(bool fastMode) {
-  EEPROM.update(clockSettings, (byte)(fastMode ? ENABLE : DISABLE));
-  i2cClock = fastMode ? 400000 : 100000;
+bool setI2cClockMode(bool mode) {
+  saveSettings(CLOCKMODE, mode ? FASTMODE : STDMODE);
+  i2cClock = mode ? 400000 : 100000;
   Wire.setClock(i2cClock);
-  return getI2cClockMode() == fastMode;
+
+  return getI2cClockMode();
 }
 
 // Gets saved I2C clock mode (true=fast mode, false=std mode)
 bool getI2cClockMode() {
-  return EEPROM.read(clockSettings) == ENABLE;
+  return getSettings(CLOCKMODE);
 }
 
 // Scans I2C bus range 80-87
@@ -1083,3 +1108,16 @@ bool ddr5Detect(uint8_t address) {
 
   return result;
 }
+
+// Restores device's default settings
+bool factoryReset() {
+  for (uint8_t i = 0; i < 32; i++) {
+    EEPROM.update(i, ZERO);
+  }
+  for (uint8_t i = 0; i < 32; i++) {
+    if (EEPROM.read(i) != ZERO) {
+      return false;
+    }
+  }
+  return true;
+}

src/SpdReaderWriterDll/Command.cs

@@ -22,7 +22,7 @@ public struct Command {
         /// <summary>
         /// Set i2c clock 
         /// </summary>
-        public const byte I2CSETCLOCK  = (byte) 'c';
+        public const byte I2CCLOCK     = (byte) 'c';
         /// <summary>
         /// Probe i2c address
         /// </summary>
@@ -68,6 +68,10 @@ public struct Command {
         /// </summary>
         public const byte DDR5DETECT   = (byte) '5';
         /// <summary>
+        /// Restore device settings to default
+        /// </summary>
+        public const byte FACTORYRESET = (byte) '-';
+        /// <summary>
         /// Suffix added to get current state
         /// </summary>
         public const byte GET          = (byte) '?';