src/mem/drampower.hh

   1 /*
   2  * Copyright (c) 2014 ARM Limited
   3  * All rights reserved
   4  *
   5  * The license below extends only to copyright in the software and shall
   6  * not be construed as granting a license to any other intellectual
   7  * property including but not limited to intellectual property relating
   8  * to a hardware implementation of the functionality of the software
   9  * licensed hereunder.  You may use the software subject to the license
  10  * terms below provided that you ensure that this notice is replicated
  11  * unmodified and in its entirety in all distributions of the software,
  12  * modified or unmodified, in source code or in binary form.
  13  *
  14  * Redistribution and use in source and binary forms, with or without
  15  * modification, are permitted provided that the following conditions are
  16  * met: redistributions of source code must retain the above copyright
  17  * notice, this list of conditions and the following disclaimer;
  18  * redistributions in binary form must reproduce the above copyright
  19  * notice, this list of conditions and the following disclaimer in the
  20  * documentation and/or other materials provided with the distribution;
  21  * neither the name of the copyright holders nor the names of its
  22  * contributors may be used to endorse or promote products derived from
  23  * this software without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  28  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  29  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  31  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  35  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36  */
  37
  38 /**
  39  * @file
  40  * DRAMPower declaration
  41  */
  42
  43 #ifndef __MEM_DRAM_POWER_HH__
  44 #define __MEM_DRAM_POWER_HH__
  45
  46 #include "libdrampower/LibDRAMPower.h"
  47 #include "params/DRAMInterface.hh"
  48
  49 /**
  50  * DRAMPower is a standalone tool which calculates the power consumed by a
  51  * DRAM in the system. This class wraps the DRAMPower library.
  52  */
  53 class DRAMPower
  54 {
  55
  56  private:
  57
  58     /**
  59      * Transform the architechture parameters defined in
  60      * DRAMInterfaceParams to the memSpec of DRAMPower
  61      */
  62     static Data::MemArchitectureSpec getArchParams(
  63                                      const DRAMInterfaceParams &p);
  64
  65     /**
  66      * Transforms the timing parameters defined in DRAMInterfaceParams to
  67      * the memSpec of DRAMPower
  68      */
  69     static Data::MemTimingSpec getTimingParams(const DRAMInterfaceParams &p);
  70
  71     /**
  72      * Transforms the power and current parameters defined in
  73      * DRAMInterfaceParams to the memSpec of DRAMPower
  74      */
  75     static Data::MemPowerSpec getPowerParams(const DRAMInterfaceParams &p);
  76
  77     /**
  78      * Determine data rate, either one or two.
  79      */
  80     static uint8_t getDataRate(const DRAMInterfaceParams &p);
  81
  82     /**
  83      * Determine if DRAM has two voltage domains (or one)
  84      */
  85     static bool hasTwoVDD(const DRAMInterfaceParams &p);
  86
  87     /**
  88      * Return an instance of MemSpec based on the DRAMInterfaceParams
  89      */
  90     static Data::MemorySpecification getMemSpec(const DRAMInterfaceParams &p);
  91
  92  public:
  93
  94     // Instance of DRAMPower Library
  95     libDRAMPower powerlib;
  96
  97     DRAMPower(const DRAMInterfaceParams &p, bool include_io);
  98
  99 };
 100
 101 #endif //__MEM_DRAM_POWER_HH__
 102