drampower.hh revision 11229:1b9331fd8966 
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 * Authors: Omar Naji
38 */
39
40/**
41 * @file
42 * DRAMPower declaration
43 */
44
45#ifndef __MEM_DRAM_POWER_HH__
46#define __MEM_DRAM_POWER_HH__
47
48#include "libdrampower/LibDRAMPower.h"
49#include "params/DRAMCtrl.hh"
50
51/**
52 * DRAMPower is a standalone tool which calculates the power consumed by a
53 * DRAM in the system. This class wraps the DRAMPower library.
54 */
55class DRAMPower
56{
57
58 private:
59
60    /**
61     * Transform the architechture parameters defined in
62     * DRAMCtrlParams to the memSpec of DRAMPower
63     */
64    static Data::MemArchitectureSpec getArchParams(const DRAMCtrlParams* p);
65
66    /**
67     * Transforms the timing parameters defined in DRAMCtrlParams to
68     * the memSpec of DRAMPower
69     */
70    static Data::MemTimingSpec getTimingParams(const DRAMCtrlParams* p);
71
72    /**
73     * Transforms the power and current parameters defined in
74     * DRAMCtrlParam to the memSpec of DRAMPower
75     */
76    static Data::MemPowerSpec getPowerParams(const DRAMCtrlParams* p);
77
78    /**
79     * Determine data rate, either one or two.
80     */
81    static uint8_t getDataRate(const DRAMCtrlParams* p);
82
83    /**
84     * Determine if DRAM has two voltage domains (or one)
85     */
86    static bool hasTwoVDD(const DRAMCtrlParams* p);
87
88    /**
89     * Return an instance of MemSpec based on the DRAMCtrlParams
90     */
91    static Data::MemorySpecification getMemSpec(const DRAMCtrlParams* p);
92
93 public:
94
95    // Instance of DRAMPower Library
96    libDRAMPower powerlib;
97
98    DRAMPower(const DRAMCtrlParams* p, bool include_io);
99
100};
101
102#endif //__MEM_DRAM_POWER_HH__
103
104