gem5  v22.1.0.0
Classes | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
gem5::LupioTMR Class Reference

LupioTMR: A virtual timer device which provides a real time counter, as well as a configurable timer offering periodic and one shot modes. More...

#include <lupio_tmr.hh>

Inheritance diagram for gem5::LupioTMR:
gem5::BasicPioDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

struct  LupioTimer
 

Public Member Functions

 PARAMS (LupioTMR)
 
 LupioTMR (const Params &params)
 
 ~LupioTMR ()
 
Tick read (PacketPtr pkt) override
 Implement BasicPioDevice virtual functions. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
- Public Member Functions inherited from gem5::BasicPioDevice
 PARAMS (BasicPioDevice)
 
 BasicPioDevice (const Params &p, Addr size)
 
AddrRangeList getAddrRanges () const override
 Determine the address ranges that this device responds to. More...
 
- Public Member Functions inherited from gem5::PioDevice
 PioDevice (const Params &p)
 
virtual ~PioDevice ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. More...
 
- Public Member Functions inherited from gem5::ClockedObject
 ClockedObject (const ClockedObjectParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () const
 
 SimObject (const Params &p)
 
virtual ~SimObject ()
 
virtual void loadState (CheckpointIn &cp)
 loadState() is called on each SimObject when restoring from a checkpoint. More...
 
virtual void initState ()
 initState() is called on each SimObject when not restoring from a checkpoint. More...
 
virtual void regProbePoints ()
 Register probe points for this object. More...
 
virtual void regProbeListeners ()
 Register probe listeners for this object. More...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual void startup ()
 startup() is the final initialization call before simulation. More...
 
DrainState drain () override
 Provide a default implementation of the drain interface for objects that don't need draining. More...
 
virtual void memWriteback ()
 Write back dirty buffers to memory using functional writes. More...
 
virtual void memInvalidate ()
 Invalidate the contents of memory buffers. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from gem5::EventManager
EventQueueeventQueue () const
 
void schedule (Event &event, Tick when)
 
void deschedule (Event &event)
 
void reschedule (Event &event, Tick when, bool always=false)
 
void schedule (Event *event, Tick when)
 
void deschedule (Event *event)
 
void reschedule (Event *event, Tick when, bool always=false)
 
void wakeupEventQueue (Tick when=(Tick) -1)
 This function is not needed by the usual gem5 event loop but may be necessary in derived EventQueues which host gem5 on other schedulers. More...
 
void setCurTick (Tick newVal)
 
 EventManager (EventManager &em)
 Event manger manages events in the event queue. More...
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
- Public Member Functions inherited from gem5::Serializable
 Serializable ()
 
virtual ~Serializable ()
 
void serializeSection (CheckpointOut &cp, const char *name) const
 Serialize an object into a new section. More...
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object. More...
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 
- Public Member Functions inherited from gem5::Drainable
DrainState drainState () const
 Return the current drain state of an object. More...
 
virtual void notifyFork ()
 Notify a child process of a fork. More...
 
- Public Member Functions inherited from gem5::statistics::Group
 Group (Group *parent, const char *name=nullptr)
 Construct a new statistics group. More...
 
virtual ~Group ()
 
virtual void regStats ()
 Callback to set stat parameters. More...
 
virtual void resetStats ()
 Callback to reset stats. More...
 
virtual void preDumpStats ()
 Callback before stats are dumped. More...
 
void addStat (statistics::Info *info)
 Register a stat with this group. More...
 
const std::map< std::string, Group * > & getStatGroups () const
 Get all child groups associated with this object. More...
 
const std::vector< Info * > & getStats () const
 Get all stats associated with this object. More...
 
void addStatGroup (const char *name, Group *block)
 Add a stat block as a child of this block. More...
 
const InforesolveStat (std::string name) const
 Resolve a stat by its name within this group. More...
 
void mergeStatGroup (Group *block)
 Merge the contents (stats & children) of a block to this block. More...
 
 Group ()=delete
 
 Group (const Group &)=delete
 
Groupoperator= (const Group &)=delete
 
- Public Member Functions inherited from gem5::Named
 Named (const std::string &name_)
 
virtual ~Named ()=default
 
virtual std::string name () const
 
- Public Member Functions inherited from gem5::Clocked
void updateClockPeriod ()
 Update the tick to the current tick. More...
 
Tick clockEdge (Cycles cycles=Cycles(0)) const
 Determine the tick when a cycle begins, by default the current one, but the argument also enables the caller to determine a future cycle. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
Tick nextCycle () const
 Based on the clock of the object, determine the start tick of the first cycle that is at least one cycle in the future. More...
 
uint64_t frequency () const
 
Tick clockPeriod () const
 
double voltage () const
 
Cycles ticksToCycles (Tick t) const
 
Tick cyclesToTicks (Cycles c) const
 

Private Types

enum  {
  LUPIO_TMR_TIME = 0x0 , LUPIO_TMR_LOAD = 0x4 , LUPIO_TMR_CTRL = 0x8 , LUPIO_TMR_STAT = 0xC ,
  LUPIO_TMR_MAX = 0x10
}
 

Private Member Functions

uint64_t lupioTMRRead (const uint8_t addr, int size)
 Function to return data pertaining to the timer, such as the simulated time in ticks. More...
 
void lupioTMRWrite (const uint8_t addr, uint64_t val64, int size)
 Function to launch or stop the timer depending on the load value. More...
 
uint64_t lupioTMRCurrentTime ()
 Return the simulated time. More...
 
void lupioTMRSet (int cpu)
 Schedule the next timer event. More...
 
void lupioTMRCallback (int cpu)
 Process the timer's event. More...
 
void updateIRQ (int level, int cpu)
 Post or clear timer interrupts. More...
 

Private Attributes

const ByteOrder byteOrder = ByteOrder::little
 
Systemsystem
 
int nThread
 
int intType
 
std::vector< LupioTimertimers
 

Additional Inherited Members

- Public Types inherited from gem5::PioDevice
using Params = PioDeviceParams
 
- Public Types inherited from gem5::ClockedObject
using Params = ClockedObjectParams
 Parameters of ClockedObject. More...
 
- Public Types inherited from gem5::SimObject
typedef SimObjectParams Params
 
- Static Public Member Functions inherited from gem5::SimObject
static void serializeAll (const std::string &cpt_dir)
 Create a checkpoint by serializing all SimObjects in the system. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- Protected Member Functions inherited from gem5::Drainable
 Drainable ()
 
virtual ~Drainable ()
 
virtual void drainResume ()
 Resume execution after a successful drain. More...
 
void signalDrainDone () const
 Signal that an object is drained. More...
 
- Protected Member Functions inherited from gem5::Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
virtual void clockPeriodUpdated ()
 A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. More...
 
- Protected Attributes inherited from gem5::BasicPioDevice
Addr pioAddr
 Address that the device listens to. More...
 
Addr pioSize
 Size that the device's address range. More...
 
Tick pioDelay
 Delay that the device experinces on an access. More...
 
- Protected Attributes inherited from gem5::PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

Detailed Description

LupioTMR: A virtual timer device which provides a real time counter, as well as a configurable timer offering periodic and one shot modes.

Definition at line 46 of file lupio_tmr.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
private
Enumerator
LUPIO_TMR_TIME 
LUPIO_TMR_LOAD 
LUPIO_TMR_CTRL 
LUPIO_TMR_STAT 
LUPIO_TMR_MAX 

Definition at line 55 of file lupio_tmr.hh.

Constructor & Destructor Documentation

◆ LupioTMR()

gem5::LupioTMR::LupioTMR ( const Params params)

Definition at line 46 of file lupio_tmr.cc.

References DPRINTF, lupioTMRCallback(), gem5::Named::name(), nThread, and timers.

◆ ~LupioTMR()

gem5::LupioTMR::~LupioTMR ( )

Definition at line 65 of file lupio_tmr.cc.

References nThread, and timers.

Member Function Documentation

◆ lupioTMRCallback()

void gem5::LupioTMR::lupioTMRCallback ( int  cpu)
private

Process the timer's event.

Definition at line 107 of file lupio_tmr.cc.

References gem5::MipsISA::ie, lupioTMRSet(), timers, and updateIRQ().

Referenced by LupioTMR().

◆ lupioTMRCurrentTime()

uint64_t gem5::LupioTMR::lupioTMRCurrentTime ( )
private

Return the simulated time.

Definition at line 86 of file lupio_tmr.cc.

References gem5::curTick(), and gem5::sim_clock::as_int::ns.

Referenced by lupioTMRRead().

◆ lupioTMRRead()

uint64_t gem5::LupioTMR::lupioTMRRead ( const uint8_t  addr,
int  size 
)
private

Function to return data pertaining to the timer, such as the simulated time in ticks.

Definition at line 122 of file lupio_tmr.cc.

References gem5::X86ISA::addr, DPRINTF, LUPIO_TMR_EXPD, LUPIO_TMR_LOAD, LUPIO_TMR_MAX, LUPIO_TMR_STAT, LUPIO_TMR_TIME, lupioTMRCurrentTime(), panic, gem5::VegaISA::r, gem5::X86ISA::reg, timers, and updateIRQ().

Referenced by read().

◆ lupioTMRSet()

void gem5::LupioTMR::lupioTMRSet ( int  cpu)
private

Schedule the next timer event.

Definition at line 92 of file lupio_tmr.cc.

References gem5::curTick(), gem5::sim_clock::as_int::ns, gem5::EventManager::schedule(), and timers.

Referenced by lupioTMRCallback(), and lupioTMRWrite().

◆ lupioTMRWrite()

void gem5::LupioTMR::lupioTMRWrite ( const uint8_t  addr,
uint64_t  val64,
int  size 
)
private

◆ PARAMS()

gem5::LupioTMR::PARAMS ( LupioTMR  )

◆ read()

Tick gem5::LupioTMR::read ( PacketPtr  pkt)
overridevirtual

◆ updateIRQ()

void gem5::LupioTMR::updateIRQ ( int  level,
int  cpu 
)
private

Post or clear timer interrupts.

Definition at line 73 of file lupio_tmr.cc.

References intType, gem5::X86ISA::level, system, and gem5::System::threads.

Referenced by lupioTMRCallback(), and lupioTMRRead().

◆ write()

Tick gem5::LupioTMR::write ( PacketPtr  pkt)
overridevirtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 214 of file lupio_tmr.cc.

References byteOrder, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::getUintX(), lupioTMRWrite(), gem5::Packet::makeResponse(), gem5::BasicPioDevice::pioAddr, and gem5::BasicPioDevice::pioDelay.

Member Data Documentation

◆ byteOrder

const ByteOrder gem5::LupioTMR::byteOrder = ByteOrder::little
private

Definition at line 49 of file lupio_tmr.hh.

Referenced by read(), and write().

◆ intType

int gem5::LupioTMR::intType
private

Definition at line 52 of file lupio_tmr.hh.

Referenced by updateIRQ().

◆ nThread

int gem5::LupioTMR::nThread
private

Definition at line 51 of file lupio_tmr.hh.

Referenced by LupioTMR(), and ~LupioTMR().

◆ system

System* gem5::LupioTMR::system
private

Definition at line 50 of file lupio_tmr.hh.

Referenced by updateIRQ().

◆ timers

std::vector<LupioTimer> gem5::LupioTMR::timers
private

The documentation for this class was generated from the following files:

Generated on Wed Dec 21 2022 10:23:19 for gem5 by doxygen 1.9.1