clock_domain.cc revision 9793
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 * Andreas Hansson 409793Sakash.bagdia@arm.com */ 419793Sakash.bagdia@arm.com 429793Sakash.bagdia@arm.com#include "debug/ClockDomain.hh" 439793Sakash.bagdia@arm.com#include "params/ClockDomain.hh" 449793Sakash.bagdia@arm.com#include "params/DerivedClockDomain.hh" 459793Sakash.bagdia@arm.com#include "params/SrcClockDomain.hh" 469793Sakash.bagdia@arm.com#include "sim/clock_domain.hh" 479793Sakash.bagdia@arm.com 489793Sakash.bagdia@arm.comSrcClockDomain::SrcClockDomain(const Params *p) : ClockDomain(p) 499793Sakash.bagdia@arm.com{ 509793Sakash.bagdia@arm.com clockPeriod(p->clock); 519793Sakash.bagdia@arm.com} 529793Sakash.bagdia@arm.com 539793Sakash.bagdia@arm.comvoid 549793Sakash.bagdia@arm.comSrcClockDomain::clockPeriod(Tick clock_period) 559793Sakash.bagdia@arm.com{ 569793Sakash.bagdia@arm.com if (clock_period == 0) { 579793Sakash.bagdia@arm.com fatal("%s has a clock period of zero\n", name()); 589793Sakash.bagdia@arm.com } 599793Sakash.bagdia@arm.com 609793Sakash.bagdia@arm.com _clockPeriod = clock_period; 619793Sakash.bagdia@arm.com 629793Sakash.bagdia@arm.com DPRINTF(ClockDomain, 639793Sakash.bagdia@arm.com "Setting clock period to %d ticks for source clock %s\n", 649793Sakash.bagdia@arm.com _clockPeriod, name()); 659793Sakash.bagdia@arm.com 669793Sakash.bagdia@arm.com // inform any derived clocks they need to updated their period 679793Sakash.bagdia@arm.com for (auto c = children.begin(); c != children.end(); ++c) { 689793Sakash.bagdia@arm.com (*c)->updateClockPeriod(); 699793Sakash.bagdia@arm.com } 709793Sakash.bagdia@arm.com} 719793Sakash.bagdia@arm.com 729793Sakash.bagdia@arm.comSrcClockDomain * 739793Sakash.bagdia@arm.comSrcClockDomainParams::create() 749793Sakash.bagdia@arm.com{ 759793Sakash.bagdia@arm.com return new SrcClockDomain(this); 769793Sakash.bagdia@arm.com} 779793Sakash.bagdia@arm.com 789793Sakash.bagdia@arm.comDerivedClockDomain::DerivedClockDomain(const Params *p) : 799793Sakash.bagdia@arm.com ClockDomain(p), 809793Sakash.bagdia@arm.com parent(*p->clk_domain), 819793Sakash.bagdia@arm.com clockDivider(p->clk_divider) 829793Sakash.bagdia@arm.com{ 839793Sakash.bagdia@arm.com // Ensure that clock divider setting works as frequency divider and never 849793Sakash.bagdia@arm.com // work as frequency multiplier 859793Sakash.bagdia@arm.com if (clockDivider < 1) { 869793Sakash.bagdia@arm.com fatal("Clock divider param cannot be less than 1"); 879793Sakash.bagdia@arm.com } 889793Sakash.bagdia@arm.com 899793Sakash.bagdia@arm.com // let the parent keep track of this derived domain so that it can 909793Sakash.bagdia@arm.com // propagate changes 919793Sakash.bagdia@arm.com parent.addDerivedDomain(this); 929793Sakash.bagdia@arm.com 939793Sakash.bagdia@arm.com // update our clock period based on the parents clock 949793Sakash.bagdia@arm.com updateClockPeriod(); 959793Sakash.bagdia@arm.com} 969793Sakash.bagdia@arm.com 979793Sakash.bagdia@arm.comvoid 989793Sakash.bagdia@arm.comDerivedClockDomain::updateClockPeriod() 999793Sakash.bagdia@arm.com{ 1009793Sakash.bagdia@arm.com // recalculate the clock period, relying on the fact that changes 1019793Sakash.bagdia@arm.com // propagate downwards in the tree 1029793Sakash.bagdia@arm.com _clockPeriod = parent.clockPeriod() * clockDivider; 1039793Sakash.bagdia@arm.com 1049793Sakash.bagdia@arm.com DPRINTF(ClockDomain, 1059793Sakash.bagdia@arm.com "Setting clock period to %d ticks for derived clock %s\n", 1069793Sakash.bagdia@arm.com _clockPeriod, name()); 1079793Sakash.bagdia@arm.com 1089793Sakash.bagdia@arm.com // inform any derived clocks 1099793Sakash.bagdia@arm.com for (auto c = children.begin(); c != children.end(); ++c) { 1109793Sakash.bagdia@arm.com (*c)->updateClockPeriod(); 1119793Sakash.bagdia@arm.com } 1129793Sakash.bagdia@arm.com} 1139793Sakash.bagdia@arm.com 1149793Sakash.bagdia@arm.comDerivedClockDomain * 1159793Sakash.bagdia@arm.comDerivedClockDomainParams::create() 1169793Sakash.bagdia@arm.com{ 1179793Sakash.bagdia@arm.com return new DerivedClockDomain(this); 1189793Sakash.bagdia@arm.com} 119