clocked_object.hh revision 9157
1/* 2 * Copyright (c) 2012 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: Andreas Hansson 38 */ 39 40/** 41 * @file 42 * ClockedObject declaration and implementation. 43 */ 44 45#ifndef __SIM_CLOCKED_OBJECT_HH__ 46#define __SIM_CLOCKED_OBJECT_HH__ 47 48#include "base/intmath.hh" 49#include "params/ClockedObject.hh" 50#include "sim/sim_object.hh" 51 52/** 53 * The ClockedObject class extends the SimObject with a clock and 54 * accessor functions to relate ticks to the cycles of the object. 55 */ 56class ClockedObject : public SimObject 57{ 58 59 private: 60 61 /** 62 * Prevent inadvertent use of the copy constructor and assignment 63 * operator by making them private. 64 */ 65 ClockedObject(ClockedObject&); 66 ClockedObject& operator=(ClockedObject&); 67 68 protected: 69 70 // Clock period in ticks 71 Tick clock; 72 73 /** 74 * Create a clocked object and set the clock based on the 75 * parameters. 76 */ 77 ClockedObject(const ClockedObjectParams* p) : SimObject(p), clock(p->clock) 78 { } 79 80 /** 81 * Virtual destructor due to inheritance. 82 */ 83 virtual ~ClockedObject() { } 84 85 public: 86 87 /** 88 * Based on the clock of the object, determine the tick when the 89 * next cycle begins, in other words, round the curTick() to the 90 * next tick that is a multiple of the clock. 91 * 92 * @return The tick when the next cycle starts 93 */ 94 Tick nextCycle() const 95 { return divCeil(curTick(), clock) * clock; } 96 97 /** 98 * Determine the next cycle starting from a given tick instead of 99 * curTick(). 100 * 101 * @param begin_tick The tick to round to a clock edge 102 * 103 * @return The tick when the cycle after or on begin_tick starts 104 */ 105 Tick nextCycle(Tick begin_tick) const 106 { return divCeil(begin_tick, clock) * clock; } 107 108 inline Tick frequency() const { return SimClock::Frequency / clock; } 109 110 inline Tick ticks(int numCycles) const { return clock * numCycles; } 111 112 inline Tick curCycle() const { return curTick() / clock; } 113 114 inline Tick tickToCycles(Tick val) const { return val / clock; } 115 116}; 117 118#endif //__SIM_CLOCKED_OBJECT_HH__ 119