generic_timer.hh revision 10037
110037SARM gem5 Developers/* 210037SARM gem5 Developers * Copyright (c) 2013 ARM Limited 310037SARM gem5 Developers * All rights reserved. 410037SARM gem5 Developers * 510037SARM gem5 Developers * The license below extends only to copyright in the software and shall 610037SARM gem5 Developers * not be construed as granting a license to any other intellectual 710037SARM gem5 Developers * property including but not limited to intellectual property relating 810037SARM gem5 Developers * to a hardware implementation of the functionality of the software 910037SARM gem5 Developers * licensed hereunder. You may use the software subject to the license 1010037SARM gem5 Developers * terms below provided that you ensure that this notice is replicated 1110037SARM gem5 Developers * unmodified and in its entirety in all distributions of the software, 1210037SARM gem5 Developers * modified or unmodified, in source code or in binary form. 1310037SARM gem5 Developers * 1410037SARM gem5 Developers * Redistribution and use in source and binary forms, with or without 1510037SARM gem5 Developers * modification, are permitted provided that the following conditions are 1610037SARM gem5 Developers * met: redistributions of source code must retain the above copyright 1710037SARM gem5 Developers * notice, this list of conditions and the following disclaimer; 1810037SARM gem5 Developers * redistributions in binary form must reproduce the above copyright 1910037SARM gem5 Developers * notice, this list of conditions and the following disclaimer in the 2010037SARM gem5 Developers * documentation and/or other materials provided with the distribution; 2110037SARM gem5 Developers * neither the name of the copyright holders nor the names of its 2210037SARM gem5 Developers * contributors may be used to endorse or promote products derived from 2310037SARM gem5 Developers * this software without specific prior written permission. 2410037SARM gem5 Developers * 2510037SARM gem5 Developers * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 2610037SARM gem5 Developers * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 2710037SARM gem5 Developers * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 2810037SARM gem5 Developers * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 2910037SARM gem5 Developers * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 3010037SARM gem5 Developers * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 3110037SARM gem5 Developers * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 3210037SARM gem5 Developers * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 3310037SARM gem5 Developers * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 3410037SARM gem5 Developers * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 3510037SARM gem5 Developers * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 3610037SARM gem5 Developers * 3710037SARM gem5 Developers * Authors: Giacomo Gabrielli 3810037SARM gem5 Developers */ 3910037SARM gem5 Developers 4010037SARM gem5 Developers#ifndef __DEV_ARM_GENERIC_TIMER_HH__ 4110037SARM gem5 Developers#define __DEV_ARM_GENERIC_TIMER_HH__ 4210037SARM gem5 Developers 4310037SARM gem5 Developers#include "base/bitunion.hh" 4410037SARM gem5 Developers#include "params/GenericTimer.hh" 4510037SARM gem5 Developers#include "sim/core.hh" 4610037SARM gem5 Developers#include "sim/sim_object.hh" 4710037SARM gem5 Developers 4810037SARM gem5 Developers/// @file 4910037SARM gem5 Developers/// This module implements the global system counter and the local per-CPU 5010037SARM gem5 Developers/// architected timers as specified by the ARM Generic Timer extension (ARM 5110037SARM gem5 Developers/// ARM, Issue C, Chapter 17). 5210037SARM gem5 Developers 5310037SARM gem5 Developersclass Checkpoint; 5410037SARM gem5 Developersclass BaseGic; 5510037SARM gem5 Developers 5610037SARM gem5 Developers/// Wrapper around the actual counters and timers of the Generic Timer 5710037SARM gem5 Developers/// extension. 5810037SARM gem5 Developersclass GenericTimer : public SimObject 5910037SARM gem5 Developers{ 6010037SARM gem5 Developers public: 6110037SARM gem5 Developers 6210037SARM gem5 Developers /// Global system counter. It is shared by the architected timers. 6310037SARM gem5 Developers /// @todo: implement memory-mapped controls 6410037SARM gem5 Developers class SystemCounter 6510037SARM gem5 Developers { 6610037SARM gem5 Developers protected: 6710037SARM gem5 Developers /// Counter frequency (as specified by CNTFRQ). 6810037SARM gem5 Developers uint64_t _freq; 6910037SARM gem5 Developers /// Cached copy of the counter period (inverse of the frequency). 7010037SARM gem5 Developers Tick _period; 7110037SARM gem5 Developers /// Tick when the counter was reset. 7210037SARM gem5 Developers Tick _resetTick; 7310037SARM gem5 Developers 7410037SARM gem5 Developers public: 7510037SARM gem5 Developers /// Ctor. 7610037SARM gem5 Developers SystemCounter() 7710037SARM gem5 Developers : _freq(0), _period(0), _resetTick(0) 7810037SARM gem5 Developers { 7910037SARM gem5 Developers setFreq(0x01800000); 8010037SARM gem5 Developers } 8110037SARM gem5 Developers 8210037SARM gem5 Developers /// Returns the current value of the physical counter. 8310037SARM gem5 Developers uint64_t value() const 8410037SARM gem5 Developers { 8510037SARM gem5 Developers if (_freq == 0) 8610037SARM gem5 Developers return 0; // Counter is still off. 8710037SARM gem5 Developers return (curTick() - _resetTick) / _period; 8810037SARM gem5 Developers } 8910037SARM gem5 Developers 9010037SARM gem5 Developers /// Returns the counter frequency. 9110037SARM gem5 Developers uint64_t freq() const { return _freq; } 9210037SARM gem5 Developers /// Sets the counter frequency. 9310037SARM gem5 Developers /// @param freq frequency in Hz. 9410037SARM gem5 Developers void setFreq(uint32_t freq); 9510037SARM gem5 Developers 9610037SARM gem5 Developers /// Returns the counter period. 9710037SARM gem5 Developers Tick period() const { return _period; } 9810037SARM gem5 Developers 9910037SARM gem5 Developers void serialize(std::ostream &os); 10010037SARM gem5 Developers void unserialize(Checkpoint *cp, const std::string §ion); 10110037SARM gem5 Developers }; 10210037SARM gem5 Developers 10310037SARM gem5 Developers /// Per-CPU architected timer. 10410037SARM gem5 Developers class ArchTimer 10510037SARM gem5 Developers { 10610037SARM gem5 Developers protected: 10710037SARM gem5 Developers /// Control register. 10810037SARM gem5 Developers BitUnion32(ArchTimerCtrl) 10910037SARM gem5 Developers Bitfield<0> enable; 11010037SARM gem5 Developers Bitfield<1> imask; 11110037SARM gem5 Developers Bitfield<2> istatus; 11210037SARM gem5 Developers EndBitUnion(ArchTimerCtrl) 11310037SARM gem5 Developers 11410037SARM gem5 Developers /// Name of this timer. 11510037SARM gem5 Developers std::string _name; 11610037SARM gem5 Developers /// Pointer to parent class. 11710037SARM gem5 Developers GenericTimer *_parent; 11810037SARM gem5 Developers /// Pointer to the global system counter. 11910037SARM gem5 Developers SystemCounter *_counter; 12010037SARM gem5 Developers /// ID of the CPU this timer is attached to. 12110037SARM gem5 Developers int _cpuNum; 12210037SARM gem5 Developers /// ID of the interrupt to be triggered. 12310037SARM gem5 Developers int _intNum; 12410037SARM gem5 Developers /// Cached value of the control register ({CNTP/CNTHP/CNTV}_CTL). 12510037SARM gem5 Developers ArchTimerCtrl _control; 12610037SARM gem5 Developers /// Programmed limit value for the upcounter ({CNTP/CNTHP/CNTV}_CVAL). 12710037SARM gem5 Developers uint64_t _counterLimit; 12810037SARM gem5 Developers 12910037SARM gem5 Developers /// Called when the upcounter reaches the programmed value. 13010037SARM gem5 Developers void counterLimitReached(); 13110037SARM gem5 Developers EventWrapper<ArchTimer, &ArchTimer::counterLimitReached> 13210037SARM gem5 Developers _counterLimitReachedEvent; 13310037SARM gem5 Developers 13410037SARM gem5 Developers /// Returns the value of the counter which this timer relies on. 13510037SARM gem5 Developers uint64_t counterValue() const { return _counter->value(); } 13610037SARM gem5 Developers 13710037SARM gem5 Developers public: 13810037SARM gem5 Developers /// Ctor. 13910037SARM gem5 Developers ArchTimer() 14010037SARM gem5 Developers : _control(0), _counterLimit(0), _counterLimitReachedEvent(this) 14110037SARM gem5 Developers {} 14210037SARM gem5 Developers 14310037SARM gem5 Developers /// Returns the timer name. 14410037SARM gem5 Developers std::string name() const { return _name; } 14510037SARM gem5 Developers 14610037SARM gem5 Developers /// Returns the CompareValue view of the timer. 14710037SARM gem5 Developers uint64_t compareValue() const { return _counterLimit; } 14810037SARM gem5 Developers /// Sets the CompareValue view of the timer. 14910037SARM gem5 Developers void setCompareValue(uint64_t val); 15010037SARM gem5 Developers 15110037SARM gem5 Developers /// Returns the TimerValue view of the timer. 15210037SARM gem5 Developers uint32_t timerValue() const { return _counterLimit - counterValue(); } 15310037SARM gem5 Developers /// Sets the TimerValue view of the timer. 15410037SARM gem5 Developers void setTimerValue(uint32_t val); 15510037SARM gem5 Developers 15610037SARM gem5 Developers /// Sets the control register. 15710037SARM gem5 Developers uint32_t control() const { return _control; } 15810037SARM gem5 Developers void setControl(uint32_t val); 15910037SARM gem5 Developers 16010037SARM gem5 Developers virtual void serialize(std::ostream &os); 16110037SARM gem5 Developers virtual void unserialize(Checkpoint *cp, const std::string §ion); 16210037SARM gem5 Developers 16310037SARM gem5 Developers friend class GenericTimer; 16410037SARM gem5 Developers }; 16510037SARM gem5 Developers 16610037SARM gem5 Developers protected: 16710037SARM gem5 Developers 16810037SARM gem5 Developers static const int CPU_MAX = 8; 16910037SARM gem5 Developers 17010037SARM gem5 Developers /// Pointer to the GIC, needed to trigger timer interrupts. 17110037SARM gem5 Developers BaseGic *_gic; 17210037SARM gem5 Developers /// System counter. 17310037SARM gem5 Developers SystemCounter _systemCounter; 17410037SARM gem5 Developers /// Per-CPU architected timers. 17510037SARM gem5 Developers // @todo: this would become a 2-dim. array with Security and Virt. 17610037SARM gem5 Developers ArchTimer _archTimers[CPU_MAX]; 17710037SARM gem5 Developers 17810037SARM gem5 Developers public: 17910037SARM gem5 Developers typedef GenericTimerParams Params; 18010037SARM gem5 Developers const Params * 18110037SARM gem5 Developers params() const 18210037SARM gem5 Developers { 18310037SARM gem5 Developers return dynamic_cast<const Params *>(_params); 18410037SARM gem5 Developers } 18510037SARM gem5 Developers 18610037SARM gem5 Developers /// Ctor. 18710037SARM gem5 Developers GenericTimer(Params *p); 18810037SARM gem5 Developers 18910037SARM gem5 Developers /// Returns a pointer to the system counter. 19010037SARM gem5 Developers SystemCounter *getSystemCounter() { return &_systemCounter; } 19110037SARM gem5 Developers 19210037SARM gem5 Developers /// Returns a pointer to the architected timer for cpu_id. 19310037SARM gem5 Developers ArchTimer *getArchTimer(int cpu_id) { return &_archTimers[cpu_id]; } 19410037SARM gem5 Developers 19510037SARM gem5 Developers virtual void serialize(std::ostream &os); 19610037SARM gem5 Developers virtual void unserialize(Checkpoint *cp, const std::string §ion); 19710037SARM gem5 Developers}; 19810037SARM gem5 Developers 19910037SARM gem5 Developers#endif // __DEV_ARM_GENERIC_TIMER_HH__ 200