From 7de21cf05603a8103421dca00b086c1e9506e0cc Mon Sep 17 00:00:00 2001
From: Johannes Feldmann <jfeldman@rhrk.uni-kl.de>
Date: Thu, 8 Jun 2017 11:01:08 +0200
Subject: [PATCH] Configuration for ECC Controller extended to make it possible
 to add other ECC Controller

---
 .../configs/simulator/ddr3-single-device.xml    |  1 +
 .../resources/configs/simulator/ddr3.xml        |  1 +
 .../resources/configs/simulator/ddr3_ecc.xml    |  2 +-
 .../resources/configs/simulator/wideio.xml      |  1 +
 .../resources/configs/simulator/wideio_ecc.xml  |  2 +-
 .../configs/simulator/wideio_thermal.xml        |  1 +
 .../core/configuration/Configuration.cpp        | 17 +++++++++++++++--
 .../core/configuration/Configuration.h          |  4 +++-
 DRAMSys/simulator/src/error/errormodel.cpp      |  3 ++-
 DRAMSys/simulator/src/simulation/DRAMSys.cpp    | 16 ++++++++++++----
 DRAMSys/simulator/src/simulation/Dram.h         |  2 +-
 DRAMSys/simulator/src/simulation/main.cpp       |  2 +-
 README.md                                       |  8 ++++----
 13 files changed, 44 insertions(+), 16 deletions(-)

diff --git a/DRAMSys/simulator/resources/configs/simulator/ddr3-single-device.xml b/DRAMSys/simulator/resources/configs/simulator/ddr3-single-device.xml
index 0a19ff35..354ad0d5 100644
--- a/DRAMSys/simulator/resources/configs/simulator/ddr3-single-device.xml
+++ b/DRAMSys/simulator/resources/configs/simulator/ddr3-single-device.xml
@@ -11,6 +11,7 @@
     <NumberOfDevicesOnDIMM value = "8" />
     <CheckTLM2Protocol value = "0" />
     <AddressOffset value = "0" />
+    <ECCControllerMode value = "Disabled" />
     <ErrorChipSeed value="42" />
     <ErrorCSVFile value="" />
     <!-- Modes:
diff --git a/DRAMSys/simulator/resources/configs/simulator/ddr3.xml b/DRAMSys/simulator/resources/configs/simulator/ddr3.xml
index 155ab0ff..d48f6a8d 100644
--- a/DRAMSys/simulator/resources/configs/simulator/ddr3.xml
+++ b/DRAMSys/simulator/resources/configs/simulator/ddr3.xml
@@ -11,6 +11,7 @@
     <NumberOfDevicesOnDIMM value = "8" />
     <CheckTLM2Protocol value = "0" />
     <AddressOffset value = "0" />
+    <ECCControllerMode value = "Disabled" />
     <ErrorChipSeed value="42" />
     <ErrorCSVFile value="" />
     <!-- Modes:
diff --git a/DRAMSys/simulator/resources/configs/simulator/ddr3_ecc.xml b/DRAMSys/simulator/resources/configs/simulator/ddr3_ecc.xml
index f22a1f9c..70a766c4 100644
--- a/DRAMSys/simulator/resources/configs/simulator/ddr3_ecc.xml
+++ b/DRAMSys/simulator/resources/configs/simulator/ddr3_ecc.xml
@@ -11,7 +11,7 @@
     <NumberOfDevicesOnDIMM value = "8" />
     <CheckTLM2Protocol value = "0" />
     <AddressOffset value = "0" />
-    <EnableControllerECC value = "1" />
+    <ECCControllerMode value = "Hamming" />
     <ErrorChipSeed value="42" />
     <ErrorCSVFile value="" />
     <!-- Modes:
diff --git a/DRAMSys/simulator/resources/configs/simulator/wideio.xml b/DRAMSys/simulator/resources/configs/simulator/wideio.xml
index ba435056..34c328c3 100644
--- a/DRAMSys/simulator/resources/configs/simulator/wideio.xml
+++ b/DRAMSys/simulator/resources/configs/simulator/wideio.xml
@@ -10,6 +10,7 @@
     <NumberOfMemChannels value="4"/>
     <NumberOfDevicesOnDIMM value = "1" />
     <CheckTLM2Protocol value = "0" />
+    <ECCControllerMode value = "Disabled" />
     <ErrorChipSeed value="42" />
     <ErrorCSVFile value="../../DRAMSys/simulator/resources/error/wideio.csv" />
     <!-- Modes:
diff --git a/DRAMSys/simulator/resources/configs/simulator/wideio_ecc.xml b/DRAMSys/simulator/resources/configs/simulator/wideio_ecc.xml
index 3a7c43e5..49967b58 100644
--- a/DRAMSys/simulator/resources/configs/simulator/wideio_ecc.xml
+++ b/DRAMSys/simulator/resources/configs/simulator/wideio_ecc.xml
@@ -10,7 +10,7 @@
     <NumberOfMemChannels value="1"/>
     <NumberOfDevicesOnDIMM value = "1" />
     <CheckTLM2Protocol value = "0" />
-    <EnableControllerECC value = "1" />
+    <ECCControllerMode value = "Hamming" />
     <ErrorChipSeed value="42" />
     <ErrorCSVFile value="../../DRAMSys/simulator/resources/error/wideio.csv" />
     <!-- Modes:
diff --git a/DRAMSys/simulator/resources/configs/simulator/wideio_thermal.xml b/DRAMSys/simulator/resources/configs/simulator/wideio_thermal.xml
index 880e573d..f3a99d72 100644
--- a/DRAMSys/simulator/resources/configs/simulator/wideio_thermal.xml
+++ b/DRAMSys/simulator/resources/configs/simulator/wideio_thermal.xml
@@ -10,6 +10,7 @@
     <NumberOfMemChannels value="1"/>
     <NumberOfDevicesOnDIMM value = "1" />
     <CheckTLM2Protocol value = "0" />
+    <ECCControllerMode value = "Disabled" />
     <ErrorChipSeed value="42" />
     <ErrorCSVFile value="../../DRAMSys/simulator/resources/error/wideio.csv" />
     <!-- Modes:
diff --git a/DRAMSys/simulator/src/controller/core/configuration/Configuration.cpp b/DRAMSys/simulator/src/controller/core/configuration/Configuration.cpp
index 3598217b..b5070da2 100644
--- a/DRAMSys/simulator/src/controller/core/configuration/Configuration.cpp
+++ b/DRAMSys/simulator/src/controller/core/configuration/Configuration.cpp
@@ -110,6 +110,19 @@ EPowerDownMode string2PDNMode(string s)
     }
 }
 
+ECCControllerMode string2ECCControllerMode(string s)
+{
+	if(s == "Disabled")
+		return ECCControllerMode::Disabled;
+	else if(s == "Hamming")
+		return ECCControllerMode::Hamming;
+	else
+	{
+		SC_REPORT_FATAL("Configuration", ("Unknown ECCControllerMode: " + s).c_str());
+		throw;
+	}
+}
+
 enum sc_time_unit string2TimeUnit(string s)
 {
     if (s == "s")
@@ -201,8 +214,8 @@ void Configuration::setParameter(std::string name, std::string value)
     }
     else if(name == "CheckTLM2Protocol")
         CheckTLM2Protocol = string2bool(value);
-    else if(name == "EnableControllerECC")
-        EnableControllerECC = string2bool(value);
+	else if(name == "ECCControllerMode")
+		ECCMode = string2ECCControllerMode(value);
     // Specification for ErrorChipSeed, ErrorCSVFile path and StoreMode
     else if(name == "ErrorChipSeed")
         ErrorChipSeed = string2int(value);
diff --git a/DRAMSys/simulator/src/controller/core/configuration/Configuration.h b/DRAMSys/simulator/src/controller/core/configuration/Configuration.h
index 1e5326c9..433bf73e 100644
--- a/DRAMSys/simulator/src/controller/core/configuration/Configuration.h
+++ b/DRAMSys/simulator/src/controller/core/configuration/Configuration.h
@@ -49,6 +49,8 @@ enum class StorageMode{NoStorage, Store, ErrorModel};
 
 enum class EPowerDownMode{NoPowerDown, Staggered, TimeoutPDN, TimeoutSREF};
 
+enum class ECCControllerMode{Disabled, Hamming};
+
 struct  Configuration
 {
     static std::string memspecUri;
@@ -81,7 +83,7 @@ struct  Configuration
     bool SimulationProgressBar = false;
     unsigned int NumberOfDevicesOnDIMM = 1;
     bool CheckTLM2Protocol = false;
-    bool EnableControllerECC = false;
+	ECCControllerMode ECCMode = ECCControllerMode::Disabled;
     bool gem5 = false;
     unsigned long long int AddressOffset = 0;
 
diff --git a/DRAMSys/simulator/src/error/errormodel.cpp b/DRAMSys/simulator/src/error/errormodel.cpp
index 499d16f2..c213acd9 100644
--- a/DRAMSys/simulator/src/error/errormodel.cpp
+++ b/DRAMSys/simulator/src/error/errormodel.cpp
@@ -49,7 +49,8 @@ void errorModel::init()
     burstLenght = Configuration::getInstance().memSpec.BurstLength;
     numberOfColumns = Configuration::getInstance().memSpec.NumberOfColumns;
     bytesPerColumn = xmlAddressDecoder::getInstance().amount["bytes"];
-	if(Configuration::getInstance().EnableControllerECC)
+
+	if(Configuration::getInstance().ECCMode != ECCControllerMode::Disabled)
 	{
 		bytesPerColumn += bytesPerColumn>>3;
 	}
diff --git a/DRAMSys/simulator/src/simulation/DRAMSys.cpp b/DRAMSys/simulator/src/simulation/DRAMSys.cpp
index 0cb5bbc5..16c823a3 100644
--- a/DRAMSys/simulator/src/simulation/DRAMSys.cpp
+++ b/DRAMSys/simulator/src/simulation/DRAMSys.cpp
@@ -188,9 +188,16 @@ void DRAMSys::instantiateModules(const string &traceName,
     // They need to be ready before creating some modules.
     setupTlmRecorders(traceName, pathToResources);
 
-    // Initialize ECC Controller is enabled
-    if(Configuration::getInstance().EnableControllerECC)
-        ecc = new ControllerECC("ControllerECC");
+	// Create new ECC Controller
+	switch (Configuration::getInstance().ECCMode)
+	{
+		case ECCControllerMode::Hamming:
+			ecc = new ControllerECC("ControllerECC");
+			break;
+		default:
+			ecc = 0;
+			break;
+	}
 
     arbiter = new Arbiter("arbiter");
     arbiter->setTlmRecorders(tlmRecorders);
@@ -222,7 +229,7 @@ void DRAMSys::instantiateModules(const string &traceName,
 void DRAMSys::bindSockets()
 {
     // If ECC Controller enabled, put it between Trace and arbiter
-    if(Configuration::getInstance().EnableControllerECC)
+	if(Configuration::getInstance().ECCMode != ECCControllerMode::Disabled)
     {
         tSocket.bind(ecc->t_socket);
         ecc->i_socket.bind(arbiter->tSocket);
@@ -260,6 +267,7 @@ DRAMSys::~DRAMSys()
 {
     if(ecc)
         delete ecc;
+
     delete arbiter;
 
     for (auto controller : controllers)
diff --git a/DRAMSys/simulator/src/simulation/Dram.h b/DRAMSys/simulator/src/simulation/Dram.h
index d641afcb..d2759473 100644
--- a/DRAMSys/simulator/src/simulation/Dram.h
+++ b/DRAMSys/simulator/src/simulation/Dram.h
@@ -92,7 +92,7 @@ struct Dram : sc_module
 
     SC_CTOR(Dram) : tSocket("socket")
     {
-		if(Configuration::getInstance().EnableControllerECC)
+		if(Configuration::getInstance().ECCMode != ECCControllerMode::Disabled)
 			bytesPerBurst += bytesPerBurst>>3;
 
         std::uint64_t memorySize = Configuration::getInstance().getSimMemSizeInBytes();
diff --git a/DRAMSys/simulator/src/simulation/main.cpp b/DRAMSys/simulator/src/simulation/main.cpp
index 18e00f77..2ac03edd 100644
--- a/DRAMSys/simulator/src/simulation/main.cpp
+++ b/DRAMSys/simulator/src/simulation/main.cpp
@@ -72,7 +72,7 @@ int sc_main(int argc, char **argv)
     }
     else
     {
-        SimulationXML = resources + "simulations/ddr3-example.xml";
+		SimulationXML = resources + "simulations/wideio-ecc.xml";
     }
 
     std::vector<StlPlayer*> players;
diff --git a/README.md b/README.md
index 06e96cb6..75ce2bc9 100644
--- a/README.md
+++ b/README.md
@@ -544,7 +544,7 @@ Below, the sub-configurations are listed and explained.
       <SimulationProgressBar value="1"/>
       <NumberOfMemChannels value="1"/>
       <NumberOfDevicesOnDIMM value = "8" />
-      <EnableControllerECC value = "0" />
+      <ECCControllerMode value = "Disabled" />
   </simconfig>
   ```
 
@@ -579,9 +579,9 @@ Below, the sub-configurations are listed and explained.
   - *CheckTLM2Protocol* (boolean)
     - "1": enables the TLM 2.0 Protocol Checking 
     - "0": disables the TLM 2.0 Protocol Checking 
-  - *EnableControllerECC* (boolean)
-    - "1": enables the ECC Controller with classic SECDED implementation
-    - "0": disables the ECC Controller with classic SECDED implementation
+  - *ECCControllerMode* (string)
+    - "Disabled": No ECC Controller is used
+    - "Hamming": Enables an ECC Controller with classic SECDED implementation using Hamming Code
 
 - **Temperature Simulator Configuration**