#include <cmos.hh>

Inheritance diagram for gem5::X86ISA::Cmos:

Classes
class	X86RTC

Public Types
typedef CmosParams	Params

Public Types inherited from gem5::PioDevice
using	Params = PioDeviceParams

Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject.

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	Cmos (const Params &p)

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.

Tick	read (PacketPtr pkt) override
	Pure virtual function that the device must implement.

Tick	write (PacketPtr pkt) override
	Pure virtual function that the device must implement.

void	startup () override
	startup() is the final initialization call before simulation.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

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.

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.

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index.

Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

virtual void	loadState (CheckpointIn &cp)
	loadState() is called on each SimObject when restoring from a checkpoint.

virtual void	initState ()
	initState() is called on each SimObject when not restoring from a checkpoint.

virtual void	regProbePoints ()
	Register probe points for this object.

virtual void	regProbeListeners ()
	Register probe listeners for this object.

ProbeManager *	getProbeManager ()
	Get the probe manager for this object.

DrainState	drain () override
	Provide a default implementation of the drain interface for objects that don't need draining.

virtual void	memWriteback ()
	Write back dirty buffers to memory using functional writes.

virtual void	memInvalidate ()
	Invalidate the contents of memory buffers.

void	serialize (CheckpointOut &cp) const override
	Serialize an object.

void	unserialize (CheckpointIn &cp) override
	Unserialize an object.

Public Member Functions inherited from gem5::EventManager
EventQueue *	eventQueue () 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.

void	setCurTick (Tick newVal)

	EventManager (EventManager &em)
	Event manger manages events in the event queue.

	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.

void	serializeSection (CheckpointOut &cp, const std::string &name) const

void	unserializeSection (CheckpointIn &cp, const char *name)
	Unserialize an a child object.

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.

virtual void	notifyFork ()
	Notify a child process of a fork.

Public Member Functions inherited from gem5::statistics::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group.

virtual	~Group ()

virtual void	regStats ()
	Callback to set stat parameters.

virtual void	resetStats ()
	Callback to reset stats.

virtual void	preDumpStats ()
	Callback before stats are dumped.

void	addStat (statistics::Info *info)
	Register a stat with this group.

const std::map< std::string, Group * > &	getStatGroups () const
	Get all child groups associated with this object.

const std::vector< Info * > &	getStats () const
	Get all stats associated with this object.

void	addStatGroup (const char name, Group block)
	Add a stat block as a child of this block.

const Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group.

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block.

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (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.

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.

Cycles	curCycle () const
	Determine the current cycle, corresponding to a tick aligned to a clock edge.

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.

uint64_t	frequency () const

Tick	clockPeriod () const

double	voltage () const

Cycles	ticksToCycles (Tick t) const

Tick	cyclesToTicks (Cycles c) const

Protected Member Functions
	BitUnion8 (CmosAddress) Bitfield< 6

	EndBitUnion (CmosAddress) CmosAddress address

uint8_t	readRegister (uint8_t reg)

void	writeRegister (uint8_t reg, uint8_t val)

Protected Member Functions inherited from gem5::Drainable
	Drainable ()

virtual	~Drainable ()

virtual void	drainResume ()
	Resume execution after a successful drain.

void	signalDrainDone () const
	Signal that an object is drained.

Protected Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters.

	Clocked (Clocked &)=delete

Clocked &	operator= (Clocked &)=delete

virtual	~Clocked ()
	Virtual destructor due to inheritance.

void	resetClock () const
	Reset the object's clock using the current global tick value.

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed.

Protected Attributes
Tick	latency

	regNum

Bitfield< 7 >	nmiMask

uint8_t	regs [numRegs]

gem5::X86ISA::Cmos::X86RTC	rtc

Protected Attributes inherited from gem5::BasicPioDevice
Addr	pioAddr
	Address that the device listens to.

Addr	pioSize
	Size that the device's address range.

Tick	pioDelay
	Delay that the device experinces on an access.

Protected Attributes inherited from gem5::PioDevice
System *	sys

PioPort< PioDevice >	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees.

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters.

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	A pointer to this object's event queue.

Static Protected Attributes
static const int	numRegs = 128

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.

static SimObject *	find (const char *name)
	Find the SimObject with the given name and return a pointer to it.

static void	setSimObjectResolver (SimObjectResolver *resolver)
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

static SimObjectResolver *	getSimObjectResolver ()
	There is a single object name resolver, and it is only set when simulation is restoring from checkpoints.

Static Public Member Functions inherited from gem5::Serializable
static const std::string &	currentSection ()
	Gets the fully-qualified name of the active section.

static void	generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
	Generate a checkpoint file so that the serialization can be routed to it.

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Detailed Description

Definition at line 44 of file cmos.hh.

Member Typedef Documentation

◆ Params

typedef CmosParams gem5::X86ISA::Cmos::Params

Definition at line 82 of file cmos.hh.

Constructor & Destructor Documentation

◆ Cmos()

gem5::X86ISA::Cmos::Cmos ( const Params & p )

inline

Definition at line 84 of file cmos.hh.

References numRegs, and regs.

Member Function Documentation

◆ BitUnion8()

gem5::X86ISA::Cmos::BitUnion8 ( CmosAddress )

protected

◆ EndBitUnion()

gem5::X86ISA::Cmos::EndBitUnion ( CmosAddress )

protected

◆ getPort()

Port & gem5::X86ISA::Cmos::getPort	(	const std::string &	if_name,
		PortID	idx = InvalidPortID )

inlineoverridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters

if_name	Port name
idx	Index in the case of a VectorPort

Returns: A reference to the given port

Reimplemented from gem5::SimObject.

Definition at line 93 of file cmos.hh.

References gem5::PioDevice::getPort(), gem5::X86ISA::Cmos::X86RTC::intPin, and rtc.

◆ read()

Tick gem5::X86ISA::Cmos::read ( PacketPtr pkt )

overridevirtual

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 50 of file cmos.cc.

References gem5::Packet::getAddr(), gem5::Packet::getSize(), latency, gem5::Packet::makeAtomicResponse(), panic, gem5::BasicPioDevice::pioAddr, readRegister(), and gem5::Packet::setLE().

◆ readRegister()

uint8_t gem5::X86ISA::Cmos::readRegister ( uint8_t reg )

protected

Definition at line 89 of file cmos.cc.

References DPRINTF, numRegs, gem5::MC146818::readData(), gem5::X86ISA::reg, regs, rtc, and gem5::X86ISA::val.

Referenced by read().

◆ serialize()

void gem5::X86ISA::Cmos::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Reimplemented from gem5::ClockedObject.

Definition at line 127 of file cmos.cc.

References numRegs, regs, rtc, gem5::MC146818::serialize(), SERIALIZE_ARRAY, and SERIALIZE_SCALAR.

◆ startup()

void gem5::X86ISA::Cmos::startup ( )

overridevirtual

startup() is the final initialization call before simulation.

All state is initialized (including unserialized state, if any, such as the curTick() value), so this is the appropriate place to schedule initial event(s) for objects that need them.

Reimplemented from gem5::SimObject.

Definition at line 121 of file cmos.cc.

References rtc, and gem5::MC146818::startup().

◆ unserialize()

void gem5::X86ISA::Cmos::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Reimplemented from gem5::ClockedObject.

Definition at line 137 of file cmos.cc.

References numRegs, regs, rtc, gem5::MC146818::unserialize(), UNSERIALIZE_ARRAY, and UNSERIALIZE_SCALAR.

◆ write()

Tick gem5::X86ISA::Cmos::write ( PacketPtr pkt )

overridevirtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

Parameters

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 69 of file cmos.cc.

References gem5::Packet::getAddr(), gem5::Packet::getLE(), gem5::Packet::getSize(), latency, gem5::Packet::makeAtomicResponse(), panic, gem5::BasicPioDevice::pioAddr, and writeRegister().

◆ writeRegister()

void gem5::X86ISA::Cmos::writeRegister	(	uint8_t	reg,
		uint8_t	val )

protected

Definition at line 106 of file cmos.cc.

References DPRINTF, numRegs, gem5::X86ISA::reg, regs, rtc, gem5::X86ISA::val, and gem5::MC146818::writeData().

Referenced by write().

Member Data Documentation

◆ latency

Tick gem5::X86ISA::Cmos::latency

protected

Definition at line 47 of file cmos.hh.

Referenced by read(), and write().

◆ nmiMask

Bitfield<7> gem5::X86ISA::Cmos::nmiMask

protected

Definition at line 51 of file cmos.hh.

◆ numRegs

const int gem5::X86ISA::Cmos::numRegs = 128

staticprotected

Definition at line 56 of file cmos.hh.

Referenced by Cmos(), readRegister(), serialize(), unserialize(), and writeRegister().

◆ regNum

gem5::X86ISA::Cmos::regNum

protected

Definition at line 50 of file cmos.hh.

◆ regs

uint8_t gem5::X86ISA::Cmos::regs[numRegs]

protected

Definition at line 58 of file cmos.hh.

Referenced by Cmos(), readRegister(), serialize(), unserialize(), and writeRegister().

◆ rtc

gem5::X86ISA::Cmos::X86RTC gem5::X86ISA::Cmos::rtc

protected

Referenced by getPort(), readRegister(), serialize(), startup(), unserialize(), and writeRegister().

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

dev/x86/cmos.hh
dev/x86/cmos.cc

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Constructor & Destructor Documentation

◆ Cmos()

Member Function Documentation

◆ BitUnion8()

◆ EndBitUnion()

◆ getPort()

◆ read()

◆ readRegister()

◆ serialize()

◆ startup()

◆ unserialize()

◆ write()

◆ writeRegister()

Member Data Documentation

◆ latency

◆ nmiMask

◆ numRegs

◆ regNum

◆ regs

◆ rtc