clock_domain.hh revision 9827
19793Sakash.bagdia@arm.com/* 29793Sakash.bagdia@arm.com * Copyright (c) 2013 ARM Limited 39793Sakash.bagdia@arm.com * All rights reserved 49793Sakash.bagdia@arm.com * 59793Sakash.bagdia@arm.com * The license below extends only to copyright in the software and shall 69793Sakash.bagdia@arm.com * not be construed as granting a license to any other intellectual 79793Sakash.bagdia@arm.com * property including but not limited to intellectual property relating 89793Sakash.bagdia@arm.com * to a hardware implementation of the functionality of the software 99793Sakash.bagdia@arm.com * licensed hereunder. You may use the software subject to the license 109793Sakash.bagdia@arm.com * terms below provided that you ensure that this notice is replicated 119793Sakash.bagdia@arm.com * unmodified and in its entirety in all distributions of the software, 129793Sakash.bagdia@arm.com * modified or unmodified, in source code or in binary form. 139793Sakash.bagdia@arm.com * 149793Sakash.bagdia@arm.com * Redistribution and use in source and binary forms, with or without 159793Sakash.bagdia@arm.com * modification, are permitted provided that the following conditions are 169793Sakash.bagdia@arm.com * met: redistributions of source code must retain the above copyright 179793Sakash.bagdia@arm.com * notice, this list of conditions and the following disclaimer; 189793Sakash.bagdia@arm.com * redistributions in binary form must reproduce the above copyright 199793Sakash.bagdia@arm.com * notice, this list of conditions and the following disclaimer in the 209793Sakash.bagdia@arm.com * documentation and/or other materials provided with the distribution; 219793Sakash.bagdia@arm.com * neither the name of the copyright holders nor the names of its 229793Sakash.bagdia@arm.com * contributors may be used to endorse or promote products derived from 239793Sakash.bagdia@arm.com * this software without specific prior written permission. 249793Sakash.bagdia@arm.com * 259793Sakash.bagdia@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 269793Sakash.bagdia@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 279793Sakash.bagdia@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 289793Sakash.bagdia@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 299793Sakash.bagdia@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 309793Sakash.bagdia@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 319793Sakash.bagdia@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 329793Sakash.bagdia@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 339793Sakash.bagdia@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 349793Sakash.bagdia@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 359793Sakash.bagdia@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 369793Sakash.bagdia@arm.com * 379793Sakash.bagdia@arm.com * Authors: Vasileios Spiliopoulos 389793Sakash.bagdia@arm.com * Akash Bagdia 399793Sakash.bagdia@arm.com */ 409793Sakash.bagdia@arm.com 419793Sakash.bagdia@arm.com/** 429793Sakash.bagdia@arm.com * @file 439793Sakash.bagdia@arm.com * ClockDomain declarations. 449793Sakash.bagdia@arm.com */ 459793Sakash.bagdia@arm.com 469793Sakash.bagdia@arm.com#ifndef __SIM_CLOCK_DOMAIN_HH__ 479793Sakash.bagdia@arm.com#define __SIM_CLOCK_DOMAIN_HH__ 489793Sakash.bagdia@arm.com 499793Sakash.bagdia@arm.com#include "base/statistics.hh" 509793Sakash.bagdia@arm.com#include "params/ClockDomain.hh" 519793Sakash.bagdia@arm.com#include "params/DerivedClockDomain.hh" 529793Sakash.bagdia@arm.com#include "params/SrcClockDomain.hh" 539793Sakash.bagdia@arm.com#include "sim/sim_object.hh" 549793Sakash.bagdia@arm.com 559793Sakash.bagdia@arm.com/** 569793Sakash.bagdia@arm.com * Forward declaration 579793Sakash.bagdia@arm.com */ 589793Sakash.bagdia@arm.comclass DerivedClockDomain; 599827Sakash.bagdia@arm.comclass VoltageDomain; 609793Sakash.bagdia@arm.com 619793Sakash.bagdia@arm.com/** 629793Sakash.bagdia@arm.com * The ClockDomain provides clock to group of clocked objects bundled 639827Sakash.bagdia@arm.com * under the same clock domain. The clock domains, in turn, are 649827Sakash.bagdia@arm.com * grouped into voltage domains. The clock domains provide support for 659793Sakash.bagdia@arm.com * a hierarchial structure with source and derived domains. 669793Sakash.bagdia@arm.com */ 679793Sakash.bagdia@arm.comclass ClockDomain : public SimObject 689793Sakash.bagdia@arm.com{ 699793Sakash.bagdia@arm.com 709793Sakash.bagdia@arm.com protected: 719793Sakash.bagdia@arm.com 729793Sakash.bagdia@arm.com /** 739793Sakash.bagdia@arm.com * Pre-computed clock period in ticks. This is populated by the 749793Sakash.bagdia@arm.com * inheriting classes based on how their period is determined. 759793Sakash.bagdia@arm.com */ 769793Sakash.bagdia@arm.com Tick _clockPeriod; 779793Sakash.bagdia@arm.com 789793Sakash.bagdia@arm.com /** 799827Sakash.bagdia@arm.com * Voltage domain this clock domain belongs to 809827Sakash.bagdia@arm.com */ 819827Sakash.bagdia@arm.com VoltageDomain *_voltageDomain; 829827Sakash.bagdia@arm.com 839827Sakash.bagdia@arm.com /** 849793Sakash.bagdia@arm.com * Pointers to potential derived clock domains so we can propagate 859793Sakash.bagdia@arm.com * changes. 869793Sakash.bagdia@arm.com */ 879793Sakash.bagdia@arm.com std::vector<DerivedClockDomain*> children; 889793Sakash.bagdia@arm.com 899793Sakash.bagdia@arm.com public: 909793Sakash.bagdia@arm.com 919793Sakash.bagdia@arm.com typedef ClockDomainParams Params; 929827Sakash.bagdia@arm.com ClockDomain(const Params *p, VoltageDomain *voltage_domain) : 939827Sakash.bagdia@arm.com SimObject(p), 949827Sakash.bagdia@arm.com _clockPeriod(0), 959827Sakash.bagdia@arm.com _voltageDomain(voltage_domain) {} 969793Sakash.bagdia@arm.com 979793Sakash.bagdia@arm.com /** 989793Sakash.bagdia@arm.com * Get the clock period. 999793Sakash.bagdia@arm.com * 1009793Sakash.bagdia@arm.com * @return Clock period in ticks 1019793Sakash.bagdia@arm.com */ 1029793Sakash.bagdia@arm.com inline Tick clockPeriod() const { return _clockPeriod; } 1039793Sakash.bagdia@arm.com 1049793Sakash.bagdia@arm.com /** 1059827Sakash.bagdia@arm.com * Get the voltage domain. 1069827Sakash.bagdia@arm.com * 1079827Sakash.bagdia@arm.com * @return Voltage domain this clock domain belongs to 1089827Sakash.bagdia@arm.com */ 1099827Sakash.bagdia@arm.com inline VoltageDomain *voltageDomain() const { return _voltageDomain; } 1109827Sakash.bagdia@arm.com 1119827Sakash.bagdia@arm.com 1129827Sakash.bagdia@arm.com /** 1139827Sakash.bagdia@arm.com * Get the current voltage this clock domain operates at. 1149827Sakash.bagdia@arm.com * 1159827Sakash.bagdia@arm.com * @return Voltage applied to the clock domain 1169827Sakash.bagdia@arm.com */ 1179827Sakash.bagdia@arm.com inline double voltage() const; 1189827Sakash.bagdia@arm.com 1199827Sakash.bagdia@arm.com /** 1209793Sakash.bagdia@arm.com * Add a derived domain. 1219793Sakash.bagdia@arm.com * 1229793Sakash.bagdia@arm.com * @param Derived domain to add as a child 1239793Sakash.bagdia@arm.com */ 1249793Sakash.bagdia@arm.com void addDerivedDomain(DerivedClockDomain *clock_domain) 1259793Sakash.bagdia@arm.com { children.push_back(clock_domain); } 1269793Sakash.bagdia@arm.com 1279793Sakash.bagdia@arm.com}; 1289793Sakash.bagdia@arm.com 1299793Sakash.bagdia@arm.com/** 1309793Sakash.bagdia@arm.com * The source clock domains provides the notion of a clock domain that is 1319793Sakash.bagdia@arm.com * connected to a tunable clock source. It maintains the clock period and 1329793Sakash.bagdia@arm.com * provides methods for setting/getting the clock. 1339793Sakash.bagdia@arm.com */ 1349793Sakash.bagdia@arm.comclass SrcClockDomain : public ClockDomain 1359793Sakash.bagdia@arm.com{ 1369793Sakash.bagdia@arm.com 1379793Sakash.bagdia@arm.com public: 1389793Sakash.bagdia@arm.com 1399793Sakash.bagdia@arm.com typedef SrcClockDomainParams Params; 1409793Sakash.bagdia@arm.com SrcClockDomain(const Params *p); 1419793Sakash.bagdia@arm.com 1429793Sakash.bagdia@arm.com /** 1439793Sakash.bagdia@arm.com * Set new clock value 1449793Sakash.bagdia@arm.com * @param clock The new clock period in ticks 1459793Sakash.bagdia@arm.com */ 1469793Sakash.bagdia@arm.com void clockPeriod(Tick clock_period); 1479793Sakash.bagdia@arm.com 1489793Sakash.bagdia@arm.com}; 1499793Sakash.bagdia@arm.com 1509793Sakash.bagdia@arm.com/** 1519793Sakash.bagdia@arm.com * The derived clock domains provides the notion of a clock domain 1529793Sakash.bagdia@arm.com * that is connected to a parent clock domain that can either be a 1539793Sakash.bagdia@arm.com * source clock domain or a derived clock domain. It maintains the 1549793Sakash.bagdia@arm.com * clock divider and provides methods for getting the clock. 1559793Sakash.bagdia@arm.com */ 1569793Sakash.bagdia@arm.comclass DerivedClockDomain: public ClockDomain 1579793Sakash.bagdia@arm.com{ 1589793Sakash.bagdia@arm.com 1599793Sakash.bagdia@arm.com public: 1609793Sakash.bagdia@arm.com 1619793Sakash.bagdia@arm.com typedef DerivedClockDomainParams Params; 1629793Sakash.bagdia@arm.com DerivedClockDomain(const Params *p); 1639793Sakash.bagdia@arm.com 1649793Sakash.bagdia@arm.com /** 1659793Sakash.bagdia@arm.com * Called by the parent clock domain to propagate changes. This 1669793Sakash.bagdia@arm.com * also involves propagating the change further to any children of 1679793Sakash.bagdia@arm.com * the derived domain itself. 1689793Sakash.bagdia@arm.com */ 1699793Sakash.bagdia@arm.com void updateClockPeriod(); 1709793Sakash.bagdia@arm.com 1719793Sakash.bagdia@arm.com private: 1729793Sakash.bagdia@arm.com 1739793Sakash.bagdia@arm.com /** 1749793Sakash.bagdia@arm.com * Reference to the parent clock domain this clock domain derives 1759793Sakash.bagdia@arm.com * its clock period from 1769793Sakash.bagdia@arm.com */ 1779793Sakash.bagdia@arm.com ClockDomain &parent; 1789793Sakash.bagdia@arm.com 1799793Sakash.bagdia@arm.com /** 1809793Sakash.bagdia@arm.com * Local clock divider of the domain 1819793Sakash.bagdia@arm.com */ 1829793Sakash.bagdia@arm.com const uint64_t clockDivider; 1839793Sakash.bagdia@arm.com}; 1849793Sakash.bagdia@arm.com 1859793Sakash.bagdia@arm.com#endif 186