gem5  v21.1.0.2
Classes | Public Types | Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
gem5::RealViewCtrl Class Referenceabstract

#include <rv_ctrl.hh>

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

Classes

class  Device
 

Public Types

enum  DeviceFunc {
  FUNC_OSC = 1, FUNC_VOLT = 2, FUNC_AMP = 3, FUNC_TEMP = 4,
  FUNC_RESET = 5, FUNC_SCC = 6, FUNC_MUXFPGA = 7, FUNC_SHUTDOWN = 8,
  FUNC_REBOOT = 9, FUNC_DVIMODE = 11, FUNC_POWER = 12, FUNC_ENERGY = 13
}
 
- 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
 

Public Member Functions

 PARAMS (RealViewCtrl)
 
 RealViewCtrl (const Params &p)
 The constructor for RealView just registers itself with the MMU. More...
 
Tick read (PacketPtr pkt) override
 Handle a read to the device. More...
 
Tick write (PacketPtr pkt) override
 All writes are simply ignored. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void registerDevice (DeviceFunc func, uint8_t site, uint8_t pos, uint8_t dcc, uint16_t dev, Device *handler)
 
- 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
 

Protected Types

enum  {
  IdReg = 0x00, SwReg = 0x04, Led = 0x08, Osc0 = 0x0C,
  Osc1 = 0x10, Osc2 = 0x14, Osc3 = 0x18, Osc4 = 0x1C,
  Lock = 0x20, Clock100 = 0x24, CfgData1 = 0x28, CfgData2 = 0x2C,
  Flags = 0x30, FlagsClr = 0x34, NvFlags = 0x38, NvFlagsClr = 0x3C,
  ResetCtl = 0x40, PciCtl = 0x44, MciCtl = 0x48, Flash = 0x4C,
  Clcd = 0x50, ClcdSer = 0x54, Bootcs = 0x58, Clock24 = 0x5C,
  Misc = 0x60, IoSel = 0x70, ProcId0 = 0x84, ProcId1 = 0x88,
  CfgData = 0xA0, CfgCtrl = 0xA4, CfgStat = 0xA8, TestOsc0 = 0xC0,
  TestOsc1 = 0xC4, TestOsc2 = 0xC8, TestOsc3 = 0xCC, TestOsc4 = 0xD0
}
 

Protected Member Functions

 BitUnion32 (SysLockReg) Bitfield< 15
 
 EndBitUnion (SysLockReg) BitUnion32(CfgCtrlReg) Bitfield< 11
 
 EndBitUnion (CfgCtrlReg) static const uint32_t CFG_CTRL_ADDR_MASK=0x3fffffffUL
 
- 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

 lockVal
 
Bitfield< 16 > locked
 
 dev
 
Bitfield< 15, 12 > pos
 
Bitfield< 17, 16 > site
 
Bitfield< 25, 20 > func
 
Bitfield< 29, 26 > dcc
 
Bitfield< 30 > wr
 
Bitfield< 31 > start
 
SysLockReg sysLock
 
uint32_t flags
 This register is used for smp booting. More...
 
uint32_t scData
 This register contains the result from a system control reg access. More...
 
std::map< uint32_t, Device * > devices
 
- 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...
 

Additional Inherited Members

- 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
 

Detailed Description

Definition at line 54 of file rv_ctrl.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
protected
Enumerator
IdReg 
SwReg 
Led 
Osc0 
Osc1 
Osc2 
Osc3 
Osc4 
Lock 
Clock100 
CfgData1 
CfgData2 
Flags 
FlagsClr 
NvFlags 
NvFlagsClr 
ResetCtl 
PciCtl 
MciCtl 
Flash 
Clcd 
ClcdSer 
Bootcs 
Clock24 
Misc 
IoSel 
ProcId0 
ProcId1 
CfgData 
CfgCtrl 
CfgStat 
TestOsc0 
TestOsc1 
TestOsc2 
TestOsc3 
TestOsc4 

Definition at line 89 of file rv_ctrl.hh.

◆ DeviceFunc

Enumerator
FUNC_OSC 
FUNC_VOLT 
FUNC_AMP 
FUNC_TEMP 
FUNC_RESET 
FUNC_SCC 
FUNC_MUXFPGA 
FUNC_SHUTDOWN 
FUNC_REBOOT 
FUNC_DVIMODE 
FUNC_POWER 
FUNC_ENERGY 

Definition at line 57 of file rv_ctrl.hh.

Constructor & Destructor Documentation

◆ RealViewCtrl()

gem5::RealViewCtrl::RealViewCtrl ( const Params p)

The constructor for RealView just registers itself with the MMU.

Parameters
pparams structure

Definition at line 51 of file rv_ctrl.cc.

Member Function Documentation

◆ BitUnion32()

gem5::RealViewCtrl::BitUnion32 ( SysLockReg  )
protected

◆ EndBitUnion() [1/2]

gem5::RealViewCtrl::EndBitUnion ( CfgCtrlReg  ) const
protectedpure virtual

◆ EndBitUnion() [2/2]

gem5::RealViewCtrl::EndBitUnion ( SysLockReg  )
protected

◆ PARAMS()

gem5::RealViewCtrl::PARAMS ( RealViewCtrl  )

◆ read()

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

◆ registerDevice()

void gem5::RealViewCtrl::registerDevice ( DeviceFunc  func,
uint8_t  site,
uint8_t  pos,
uint8_t  dcc,
uint16_t  dev,
Device handler 
)

Definition at line 219 of file rv_ctrl.cc.

References gem5::X86ISA::addr, dcc, dev, devices, fatal, func, pos, and site.

Referenced by gem5::RealViewCtrl::Device::Device().

◆ serialize()

void gem5::RealViewCtrl::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

Output an object's state into the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 207 of file rv_ctrl.cc.

References flags, and SERIALIZE_SCALAR.

◆ unserialize()

void gem5::RealViewCtrl::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

Read an object's state from the current checkpoint section.

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 213 of file rv_ctrl.cc.

References flags, and UNSERIALIZE_SCALAR.

◆ write()

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

Member Data Documentation

◆ dcc

Bitfield<29, 26> gem5::RealViewCtrl::dcc
protected

Definition at line 140 of file rv_ctrl.hh.

Referenced by gem5::RealViewCtrl::Device::Device(), and registerDevice().

◆ dev

gem5::RealViewCtrl::dev
protected

Definition at line 136 of file rv_ctrl.hh.

Referenced by gem5::RealViewCtrl::Device::Device(), registerDevice(), and write().

◆ devices

std::map<uint32_t, Device *> gem5::RealViewCtrl::devices
protected

Definition at line 192 of file rv_ctrl.hh.

Referenced by registerDevice(), and write().

◆ flags

uint32_t gem5::RealViewCtrl::flags
protected

This register is used for smp booting.

The primary cpu writes the secondary start address here before sends it a soft interrupt. The secondary cpu reads this register and if it's non-zero it jumps to the address

Definition at line 154 of file rv_ctrl.hh.

Referenced by read(), serialize(), unserialize(), and write().

◆ func

Bitfield<25, 20> gem5::RealViewCtrl::func
protected

Definition at line 139 of file rv_ctrl.hh.

Referenced by gem5::RealViewCtrl::Device::Device(), and registerDevice().

◆ locked

Bitfield<16> gem5::RealViewCtrl::locked
protected

Definition at line 132 of file rv_ctrl.hh.

◆ lockVal

gem5::RealViewCtrl::lockVal
protected

Definition at line 131 of file rv_ctrl.hh.

◆ pos

Bitfield<15, 12> gem5::RealViewCtrl::pos
protected

Definition at line 137 of file rv_ctrl.hh.

Referenced by gem5::RealViewCtrl::Device::Device(), and registerDevice().

◆ scData

uint32_t gem5::RealViewCtrl::scData
protected

This register contains the result from a system control reg access.

Definition at line 158 of file rv_ctrl.hh.

Referenced by read(), and write().

◆ site

Bitfield<17, 16> gem5::RealViewCtrl::site
protected

Definition at line 138 of file rv_ctrl.hh.

Referenced by gem5::RealViewCtrl::Device::Device(), and registerDevice().

◆ start

Bitfield<31> gem5::RealViewCtrl::start
protected

Definition at line 142 of file rv_ctrl.hh.

◆ sysLock

SysLockReg gem5::RealViewCtrl::sysLock
protected

Definition at line 147 of file rv_ctrl.hh.

Referenced by read(), and write().

◆ wr

Bitfield<30> gem5::RealViewCtrl::wr
protected

Definition at line 141 of file rv_ctrl.hh.


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

Generated on Tue Sep 21 2021 12:28:00 for gem5 by doxygen 1.8.17