mem: Add DRAMPower wrapping class

This patch adds a class to wrap DRAMPower Library in gem5.
This class initiates an object of class MemorySpecification
of the DRAMPower Library, passes the parameters from DRAMCtrl.py
to this object and creates an object of drampower library using
the memory specification.

3 files changed, 265 insertions, 0 deletions

diff --git a/src/mem/SConscript b/src/mem/SConscript
index 35f2e9ce4..6d225385b 100644
--- a/src/mem/SConscript
+++ b/src/mem/SConscript
@@ -48,6 +48,7 @@ Source('abstract_mem.cc')
 Source('addr_mapper.cc')
 Source('bridge.cc')
 Source('coherent_xbar.cc')
+Source('drampower.cc')
 Source('dram_ctrl.cc')
 Source('mem_object.cc')
 Source('mport.cc')
diff --git a/src/mem/drampower.cc b/src/mem/drampower.cc
new file mode 100644
index 000000000..a7339656a
--- /dev/null
+++ b/src/mem/drampower.cc
@@ -0,0 +1,161 @@
+/*
+ * Copyright (const c) 2014 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be construed as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (const INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (const INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Omar Naji
+ */
+
+#include "base/intmath.hh"
+#include "mem/drampower.hh"
+#include "sim/core.hh"
+
+using namespace Data;
+
+DRAMPower::DRAMPower(const DRAMCtrlParams* p, bool include_io) :
+    powerlib(libDRAMPower(getMemSpec(p), include_io))
+{
+}
+
+Data::MemArchitectureSpec
+DRAMPower::getArchParams(const DRAMCtrlParams* p)
+{
+    Data::MemArchitectureSpec archSpec;
+    archSpec.burstLength = p->burst_length;
+    archSpec.nbrOfBanks = p->banks_per_rank;
+    // One DRAMPower instance per rank, hence set this to 1
+    archSpec.nbrOfRanks = 1;
+    archSpec.dataRate = getDataRate(p);
+    // For now we can ignore the number of columns and rows as they
+    // are not used in the power calculation.
+    archSpec.nbrOfColumns = 0;
+    archSpec.nbrOfRows = 0;
+    archSpec.width = p->device_bus_width;
+    archSpec.nbrOfBankGroups = p->bank_groups_per_rank;
+    archSpec.dll = p->dll;
+    archSpec.twoVoltageDomains = hasTwoVDD(p);
+    // Keep this disabled for now until the model is firmed up.
+    archSpec.termination = false;
+    return archSpec;
+}
+
+Data::MemTimingSpec
+DRAMPower::getTimingParams(const DRAMCtrlParams* p)
+{
+    // Set the values that are used for power calculations and ignore
+    // the ones only used by the controller functionality in DRAMPower
+
+    // All DRAMPower timings are in clock cycles
+    Data::MemTimingSpec timingSpec;
+    timingSpec.RC = divCeil((p->tRAS + p->tRP), p->tCK);
+    timingSpec.RCD = divCeil(p->tRCD, p->tCK);
+    timingSpec.RL = divCeil(p->tCL, p->tCK);
+    timingSpec.RP = divCeil(p->tRP, p->tCK);
+    timingSpec.RFC = divCeil(p->tRFC, p->tCK);
+    timingSpec.RAS = divCeil(p->tRAS, p->tCK);
+    // Write latency is read latency - 1 cycle
+    // Source: B.Jacob Memory Systems Cache, DRAM, Disk
+    timingSpec.WL = timingSpec.RL - 1;
+    timingSpec.DQSCK = 0; // ignore for now
+    timingSpec.RTP = divCeil(p->tRTP, p->tCK);
+    timingSpec.WR = divCeil(p->tWR, p->tCK);
+    timingSpec.XP = divCeil(p->tXP, p->tCK);
+    timingSpec.XPDLL = divCeil(p->tXPDLL, p->tCK);
+    timingSpec.XS = divCeil(p->tXS, p->tCK);
+    timingSpec.XSDLL = divCeil(p->tXSDLL, p->tCK);
+
+    // Clock period in ns
+    timingSpec.clkPeriod = (p->tCK / (double)(SimClock::Int::ns));
+    assert(timingSpec.clkPeriod != 0);
+    timingSpec.clkMhz = (1 / timingSpec.clkPeriod) * 1000;
+    return timingSpec;
+}
+
+Data::MemPowerSpec
+DRAMPower::getPowerParams(const DRAMCtrlParams* p)
+{
+    // All DRAMPower currents are in mA
+    Data::MemPowerSpec powerSpec;
+    powerSpec.idd0 = p->IDD0 * 1000;
+    powerSpec.idd02 = p->IDD02 * 1000;
+    powerSpec.idd2p0 = p->IDD2P0 * 1000;
+    powerSpec.idd2p02 = p->IDD2P02 * 1000;
+    powerSpec.idd2p1 = p->IDD2P1 * 1000;
+    powerSpec.idd2p12 = p->IDD2P12 * 1000;
+    powerSpec.idd2n = p->IDD2N * 1000;
+    powerSpec.idd2n2 = p->IDD2N2 * 1000;
+    powerSpec.idd3p0 = p->IDD3P0 * 1000;
+    powerSpec.idd3p02 = p->IDD3P02 * 1000;
+    powerSpec.idd3p1 = p->IDD3P1 * 1000;
+    powerSpec.idd3p12 = p->IDD3P12 * 1000;
+    powerSpec.idd3n = p->IDD3N * 1000;
+    powerSpec.idd3n2 = p->IDD3N2 * 1000;
+    powerSpec.idd4r = p->IDD4R * 1000;
+    powerSpec.idd4r2 = p->IDD4R2 * 1000;
+    powerSpec.idd4w = p->IDD4W * 1000;
+    powerSpec.idd4w2 = p->IDD4W2 * 1000;
+    powerSpec.idd5 = p->IDD5 * 1000;
+    powerSpec.idd52 = p->IDD52 * 1000;
+    powerSpec.idd6 = p->IDD6 * 1000;
+    powerSpec.idd62 = p->IDD62 * 1000;
+    powerSpec.vdd = p->VDD;
+    powerSpec.vdd2 = p->VDD2;
+    return powerSpec;
+}
+
+Data::MemorySpecification
+DRAMPower::getMemSpec(const DRAMCtrlParams* p)
+{
+    Data::MemorySpecification memSpec;
+    memSpec.memArchSpec = getArchParams(p);
+    memSpec.memTimingSpec = getTimingParams(p);
+    memSpec.memPowerSpec = getPowerParams(p);
+    return memSpec;
+}
+
+bool
+DRAMPower::hasTwoVDD(const DRAMCtrlParams* p)
+{
+    return p->VDD2 == 0 ? false : true;
+}
+
+uint8_t
+DRAMPower::getDataRate(const DRAMCtrlParams* p)
+{
+    uint32_t burst_cycles = divCeil(p->tBURST, p->tCK);
+    uint8_t data_rate = p->burst_length / burst_cycles;
+    if (data_rate != 1 && data_rate != 2)
+        fatal("Got unexpected data rate %d, should be 1 or 2\n");
+    return data_rate;
+}
diff --git a/src/mem/drampower.hh b/src/mem/drampower.hh
new file mode 100644
index 000000000..7b3890225
--- /dev/null
+++ b/src/mem/drampower.hh
@@ -0,0 +1,103 @@
+/*
+ * Copyright (const c) 2014 ARM Limited
+ * All rights reserved
+ *
+ * The license below extends only to copyright in the software and shall
+ * not be rued as granting a license to any other intellectual
+ * property including but not limited to intellectual property relating
+ * to a hardware implementation of the functionality of the software
+ * licensed hereunder.  You may use the software subject to the license
+ * terms below provided that you ensure that this notice is replicated
+ * unmodified and in its entirety in all distributions of the software,
+ * modified or unmodified, in source code or in binary form.
+
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met: redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer;
+ * redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution;
+ * neither the name of the copyright holders nor the names of its
+ * contributors may be used to endorse or promote products derived from
+ * this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (const INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (const INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * Authors: Omar Naji
+ */
+
+/**
+ * @file
+ * DRAMPower declaration
+ */
+
+#ifndef __MEM_DRAM_POWER_HH__
+#define __MEM_DRAM_POWER_HH__
+
+#include "libdrampower/LibDRAMPower.h"
+#include "params/DRAMCtrl.hh"
+
+/**
+ * DRAMPower is a standalone tool which calculates the power consumed by a
+ * DRAM in the system. This class wraps the DRAMPower library.
+ */
+class DRAMPower
+{
+
+ private:
+
+    /**
+     * Transform the architechture parameters defined in
+     * DRAMCtrlParams to the memSpec of DRAMPower
+     */
+    static Data::MemArchitectureSpec getArchParams(const DRAMCtrlParams* p);
+
+    /**
+     * Transforms the timing parameters defined in DRAMCtrlParams to
+     * the memSpec of DRAMPower
+     */
+    static Data::MemTimingSpec getTimingParams(const DRAMCtrlParams* p);
+
+    /**
+     * Transforms the power and current parameters defined in
+     * DRAMCtrlParam to the memSpec of DRAMPower
+     */
+    static Data::MemPowerSpec getPowerParams(const DRAMCtrlParams* p);
+
+    /**
+     * Determine data rate, either one or two.
+     */
+    static uint8_t getDataRate(const DRAMCtrlParams* p);
+
+    /**
+     * Determine if DRAM has two voltage domains (or one)
+     */
+    static bool hasTwoVDD(const DRAMCtrlParams* p);
+
+    /**
+     * Return an instance of MemSpec based on the DRAMCtrlParams
+     */
+    static Data::MemorySpecification getMemSpec(const DRAMCtrlParams* p);
+
+ public:
+
+    // Instance of DRAMPower Library
+    libDRAMPower powerlib;
+
+    DRAMPower(const DRAMCtrlParams* p, bool include_io);
+
+};
+
+#endif //__MEM_DRAM_POWER_HH__
+