clock_domain.cc revision 10021
19793Sakash.bagdia@arm.com/* 29793Sakash.bagdia@arm.com * Copyright (c) 2013 ARM Limited 310000Sclt67@cornell.edu * Copyright (c) 2013 Cornell University 49793Sakash.bagdia@arm.com * All rights reserved 59793Sakash.bagdia@arm.com * 69793Sakash.bagdia@arm.com * The license below extends only to copyright in the software and shall 79793Sakash.bagdia@arm.com * not be construed as granting a license to any other intellectual 89793Sakash.bagdia@arm.com * property including but not limited to intellectual property relating 99793Sakash.bagdia@arm.com * to a hardware implementation of the functionality of the software 109793Sakash.bagdia@arm.com * licensed hereunder. You may use the software subject to the license 119793Sakash.bagdia@arm.com * terms below provided that you ensure that this notice is replicated 129793Sakash.bagdia@arm.com * unmodified and in its entirety in all distributions of the software, 139793Sakash.bagdia@arm.com * modified or unmodified, in source code or in binary form. 149793Sakash.bagdia@arm.com * 159793Sakash.bagdia@arm.com * Redistribution and use in source and binary forms, with or without 169793Sakash.bagdia@arm.com * modification, are permitted provided that the following conditions are 179793Sakash.bagdia@arm.com * met: redistributions of source code must retain the above copyright 189793Sakash.bagdia@arm.com * notice, this list of conditions and the following disclaimer; 199793Sakash.bagdia@arm.com * redistributions in binary form must reproduce the above copyright 209793Sakash.bagdia@arm.com * notice, this list of conditions and the following disclaimer in the 219793Sakash.bagdia@arm.com * documentation and/or other materials provided with the distribution; 229793Sakash.bagdia@arm.com * neither the name of the copyright holders nor the names of its 239793Sakash.bagdia@arm.com * contributors may be used to endorse or promote products derived from 249793Sakash.bagdia@arm.com * this software without specific prior written permission. 259793Sakash.bagdia@arm.com * 269793Sakash.bagdia@arm.com * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 279793Sakash.bagdia@arm.com * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 289793Sakash.bagdia@arm.com * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 299793Sakash.bagdia@arm.com * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 309793Sakash.bagdia@arm.com * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 319793Sakash.bagdia@arm.com * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 329793Sakash.bagdia@arm.com * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 339793Sakash.bagdia@arm.com * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 349793Sakash.bagdia@arm.com * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 359793Sakash.bagdia@arm.com * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 369793Sakash.bagdia@arm.com * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 379793Sakash.bagdia@arm.com * 389793Sakash.bagdia@arm.com * Authors: Vasileios Spiliopoulos 399793Sakash.bagdia@arm.com * Akash Bagdia 409793Sakash.bagdia@arm.com * Andreas Hansson 4110000Sclt67@cornell.edu * Christopher Torng 429793Sakash.bagdia@arm.com */ 439793Sakash.bagdia@arm.com 449793Sakash.bagdia@arm.com#include "debug/ClockDomain.hh" 459793Sakash.bagdia@arm.com#include "params/ClockDomain.hh" 469793Sakash.bagdia@arm.com#include "params/DerivedClockDomain.hh" 479793Sakash.bagdia@arm.com#include "params/SrcClockDomain.hh" 489793Sakash.bagdia@arm.com#include "sim/clock_domain.hh" 499827Sakash.bagdia@arm.com#include "sim/voltage_domain.hh" 5010000Sclt67@cornell.edu#include "sim/clocked_object.hh" 519793Sakash.bagdia@arm.com 5210021Sandreas.hansson@arm.comvoid 5310021Sandreas.hansson@arm.comClockDomain::regStats() 5410021Sandreas.hansson@arm.com{ 5510021Sandreas.hansson@arm.com using namespace Stats; 5610021Sandreas.hansson@arm.com 5710021Sandreas.hansson@arm.com // Expose the current clock period as a stat for observability in 5810021Sandreas.hansson@arm.com // the dumps 5910021Sandreas.hansson@arm.com currentClock 6010021Sandreas.hansson@arm.com .scalar(_clockPeriod) 6110021Sandreas.hansson@arm.com .name(params()->name + ".clock") 6210021Sandreas.hansson@arm.com .desc("Clock period in ticks") 6310021Sandreas.hansson@arm.com ; 6410021Sandreas.hansson@arm.com} 6510021Sandreas.hansson@arm.com 669827Sakash.bagdia@arm.comdouble 679827Sakash.bagdia@arm.comClockDomain::voltage() const 689827Sakash.bagdia@arm.com{ 699827Sakash.bagdia@arm.com return _voltageDomain->voltage(); 709827Sakash.bagdia@arm.com} 719827Sakash.bagdia@arm.com 729827Sakash.bagdia@arm.comSrcClockDomain::SrcClockDomain(const Params *p) : 739827Sakash.bagdia@arm.com ClockDomain(p, p->voltage_domain) 749793Sakash.bagdia@arm.com{ 759793Sakash.bagdia@arm.com clockPeriod(p->clock); 769793Sakash.bagdia@arm.com} 779793Sakash.bagdia@arm.com 789793Sakash.bagdia@arm.comvoid 799793Sakash.bagdia@arm.comSrcClockDomain::clockPeriod(Tick clock_period) 809793Sakash.bagdia@arm.com{ 819793Sakash.bagdia@arm.com if (clock_period == 0) { 829793Sakash.bagdia@arm.com fatal("%s has a clock period of zero\n", name()); 839793Sakash.bagdia@arm.com } 849793Sakash.bagdia@arm.com 8510000Sclt67@cornell.edu // Align all members to the current tick 8610000Sclt67@cornell.edu for (auto m = members.begin(); m != members.end(); ++m) { 8710000Sclt67@cornell.edu (*m)->updateClockPeriod(); 8810000Sclt67@cornell.edu } 8910000Sclt67@cornell.edu 909793Sakash.bagdia@arm.com _clockPeriod = clock_period; 919793Sakash.bagdia@arm.com 929793Sakash.bagdia@arm.com DPRINTF(ClockDomain, 939793Sakash.bagdia@arm.com "Setting clock period to %d ticks for source clock %s\n", 949793Sakash.bagdia@arm.com _clockPeriod, name()); 959793Sakash.bagdia@arm.com 969793Sakash.bagdia@arm.com // inform any derived clocks they need to updated their period 979793Sakash.bagdia@arm.com for (auto c = children.begin(); c != children.end(); ++c) { 989793Sakash.bagdia@arm.com (*c)->updateClockPeriod(); 999793Sakash.bagdia@arm.com } 1009793Sakash.bagdia@arm.com} 1019793Sakash.bagdia@arm.com 1029793Sakash.bagdia@arm.comSrcClockDomain * 1039793Sakash.bagdia@arm.comSrcClockDomainParams::create() 1049793Sakash.bagdia@arm.com{ 1059793Sakash.bagdia@arm.com return new SrcClockDomain(this); 1069793Sakash.bagdia@arm.com} 1079793Sakash.bagdia@arm.com 1089793Sakash.bagdia@arm.comDerivedClockDomain::DerivedClockDomain(const Params *p) : 1099827Sakash.bagdia@arm.com ClockDomain(p, p->clk_domain->voltageDomain()), 1109793Sakash.bagdia@arm.com parent(*p->clk_domain), 1119793Sakash.bagdia@arm.com clockDivider(p->clk_divider) 1129793Sakash.bagdia@arm.com{ 1139793Sakash.bagdia@arm.com // Ensure that clock divider setting works as frequency divider and never 1149793Sakash.bagdia@arm.com // work as frequency multiplier 1159793Sakash.bagdia@arm.com if (clockDivider < 1) { 1169793Sakash.bagdia@arm.com fatal("Clock divider param cannot be less than 1"); 1179793Sakash.bagdia@arm.com } 1189793Sakash.bagdia@arm.com 1199793Sakash.bagdia@arm.com // let the parent keep track of this derived domain so that it can 1209793Sakash.bagdia@arm.com // propagate changes 1219793Sakash.bagdia@arm.com parent.addDerivedDomain(this); 1229793Sakash.bagdia@arm.com 1239793Sakash.bagdia@arm.com // update our clock period based on the parents clock 1249793Sakash.bagdia@arm.com updateClockPeriod(); 1259793Sakash.bagdia@arm.com} 1269793Sakash.bagdia@arm.com 1279793Sakash.bagdia@arm.comvoid 1289793Sakash.bagdia@arm.comDerivedClockDomain::updateClockPeriod() 1299793Sakash.bagdia@arm.com{ 13010000Sclt67@cornell.edu // Align all members to the current tick 13110000Sclt67@cornell.edu for (auto m = members.begin(); m != members.end(); ++m) { 13210000Sclt67@cornell.edu (*m)->updateClockPeriod(); 13310000Sclt67@cornell.edu } 13410000Sclt67@cornell.edu 1359793Sakash.bagdia@arm.com // recalculate the clock period, relying on the fact that changes 1369793Sakash.bagdia@arm.com // propagate downwards in the tree 1379793Sakash.bagdia@arm.com _clockPeriod = parent.clockPeriod() * clockDivider; 1389793Sakash.bagdia@arm.com 1399793Sakash.bagdia@arm.com DPRINTF(ClockDomain, 1409793Sakash.bagdia@arm.com "Setting clock period to %d ticks for derived clock %s\n", 1419793Sakash.bagdia@arm.com _clockPeriod, name()); 1429793Sakash.bagdia@arm.com 1439793Sakash.bagdia@arm.com // inform any derived clocks 1449793Sakash.bagdia@arm.com for (auto c = children.begin(); c != children.end(); ++c) { 1459793Sakash.bagdia@arm.com (*c)->updateClockPeriod(); 1469793Sakash.bagdia@arm.com } 1479793Sakash.bagdia@arm.com} 1489793Sakash.bagdia@arm.com 1499793Sakash.bagdia@arm.comDerivedClockDomain * 1509793Sakash.bagdia@arm.comDerivedClockDomainParams::create() 1519793Sakash.bagdia@arm.com{ 1529793Sakash.bagdia@arm.com return new DerivedClockDomain(this); 1539793Sakash.bagdia@arm.com} 154