Malta I/O device is a catch all for all the south bridge stuff we care to implement. More...

#include <malta_io.hh>

Inheritance diagram for gem5::MaltaIO:

Classes
class	RTC

Public Member Functions
Tick	frequency () const
	Return the freqency of the RTC.

	PARAMS (MaltaIO)

	MaltaIO (const Params &p)
	Initialize all the data for devices supported by Malta I/O.

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	postIntr (uint8_t interrupt)
	Post an Interrupt to the CPU.

void	clearIntr (uint8_t interrupt)
	Clear an Interrupt to the CPU.

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

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

void	startup () override
	Start running.

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 Attributes
uint8_t	mask1
	Mask of the PIC1.

uint8_t	mask2
	Mask of the PIC2.

uint8_t	mode1
	Mode of PIC1.

uint8_t	mode2
	Mode of PIC2.

uint8_t	picr
	Raw PIC interrupt register before masking.

bool	picInterrupting
	Is the pic interrupting right now or not.

Malta *	malta
	A pointer to the Malta device which be belong to.

Intel8254Timer	pitimer
	Intel 8253 Periodic Interval Timer.

RTC	rtc

uint16_t	timerData
	The interval is set via two writes to the PIT.

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.

Additional Inherited Members
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

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

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.

Detailed Description

Malta I/O device is a catch all for all the south bridge stuff we care to implement.

Definition at line 51 of file malta_io.hh.

Constructor & Destructor Documentation

◆ MaltaIO()

gem5::MaltaIO::MaltaIO ( const Params & p )

Initialize all the data for devices supported by Malta I/O.

Parameters

p	pointer to Params struct

Definition at line 63 of file malta_io.cc.

References gem5::Malta::io, malta, picInterrupting, picr, and timerData.

Member Function Documentation

◆ clearIntr()

void gem5::MaltaIO::clearIntr ( uint8_t interrupt )

Clear an Interrupt to the CPU.

Definition at line 103 of file malta_io.cc.

References gem5::Malta::cchip, gem5::MaltaCChip::clearIntr(), DPRINTF, and malta.

Referenced by gem5::Malta::clearConsoleInt().

◆ frequency()

Tick gem5::MaltaIO::frequency ( ) const

Return the freqency of the RTC.

Returns: interrupt rate of the RTC

Definition at line 76 of file malta_io.cc.

References gem5::sim_clock::Frequency, frequency(), and gem5::SimObject::params().

Referenced by frequency().

◆ PARAMS()

gem5::MaltaIO::PARAMS ( MaltaIO )

◆ postIntr()

void gem5::MaltaIO::postIntr ( uint8_t interrupt )

Post an Interrupt to the CPU.

Definition at line 96 of file malta_io.cc.

References gem5::Malta::cchip, DPRINTF, malta, and gem5::MaltaCChip::postIntr().

Referenced by gem5::Malta::postConsoleInt().

◆ read()

Tick gem5::MaltaIO::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 82 of file malta_io.cc.

References panic, and gem5::BasicPioDevice::pioDelay.

◆ serialize()

void gem5::MaltaIO::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 110 of file malta_io.cc.

References mask1, mask2, mode1, mode2, picInterrupting, picr, pitimer, rtc, gem5::Intel8254Timer::serialize(), gem5::MC146818::serialize(), SERIALIZE_SCALAR, and timerData.

◆ startup()

void gem5::MaltaIO::startup ( )

overridevirtual

Start running.

Reimplemented from gem5::SimObject.

Definition at line 142 of file malta_io.cc.

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

◆ unserialize()

void gem5::MaltaIO::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 126 of file malta_io.cc.

References mask1, mask2, mode1, mode2, picInterrupting, picr, pitimer, rtc, timerData, gem5::Intel8254Timer::unserialize(), gem5::MC146818::unserialize(), and UNSERIALIZE_SCALAR.

◆ write()

Tick gem5::MaltaIO::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 89 of file malta_io.cc.

References panic, and gem5::BasicPioDevice::pioDelay.

Member Data Documentation

◆ malta

Malta* gem5::MaltaIO::malta

protected

A pointer to the Malta device which be belong to.

Definition at line 88 of file malta_io.hh.

Referenced by clearIntr(), MaltaIO(), and postIntr().

◆ mask1

uint8_t gem5::MaltaIO::mask1

protected

Mask of the PIC1.

Definition at line 70 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ mask2

uint8_t gem5::MaltaIO::mask2

protected

Mask of the PIC2.

Definition at line 73 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ mode1

uint8_t gem5::MaltaIO::mode1

protected

Mode of PIC1.

Not used for anything

Definition at line 76 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ mode2

uint8_t gem5::MaltaIO::mode2

protected

Mode of PIC2.

Not used for anything

Definition at line 79 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ picInterrupting

bool gem5::MaltaIO::picInterrupting

protected

Is the pic interrupting right now or not.

Definition at line 85 of file malta_io.hh.

Referenced by MaltaIO(), serialize(), and unserialize().

◆ picr

uint8_t gem5::MaltaIO::picr

protected

Raw PIC interrupt register before masking.

Definition at line 82 of file malta_io.hh.

Referenced by MaltaIO(), serialize(), and unserialize().

◆ pitimer

Intel8254Timer gem5::MaltaIO::pitimer

protected

Intel 8253 Periodic Interval Timer.

Definition at line 91 of file malta_io.hh.

Referenced by serialize(), startup(), and unserialize().

◆ rtc

RTC gem5::MaltaIO::rtc

protected

Definition at line 93 of file malta_io.hh.

Referenced by serialize(), startup(), and unserialize().

◆ timerData

uint16_t gem5::MaltaIO::timerData

protected

The interval is set via two writes to the PIT.

This variable contains a flag as to how many writes have happened, and the time so far.

Definition at line 99 of file malta_io.hh.

Referenced by MaltaIO(), serialize(), and unserialize().

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

dev/mips/malta_io.hh
dev/mips/malta_io.cc

Classes

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MaltaIO()

Member Function Documentation

◆ clearIntr()

◆ frequency()

◆ PARAMS()

◆ postIntr()

◆ read()

◆ serialize()

◆ startup()

◆ unserialize()

◆ write()

Member Data Documentation

◆ malta

◆ mask1

◆ mask2

◆ mode1

◆ mode2

◆ picInterrupting

◆ picr

◆ pitimer

◆ rtc

◆ timerData