#include <iob.hh>

Inheritance diagram for gem5::Iob:

Classes
struct	IntBusy

struct	IntCtl

struct	IntMan

Public Member Functions
	PARAMS (Iob)

	Iob (const Params &p)

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	generateIpi (Type type, int cpu_id, int vector)

void	receiveDeviceInterrupt (DeviceId devid)

bool	receiveJBusInterrupt (int cpu_id, int source, uint64_t d0, uint64_t d1)

AddrRangeList	getAddrRanges () const override
	Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

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

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

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.

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

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

Private Types
enum	DeviceId { Interal = 0 , Error = 1 , SSI = 2 , Reserved = 3 , NumDeviceIds }

enum	Type { Interrupt , Reset , Idle , Resume }

Private Member Functions
void	writeIob (PacketPtr pkt)

void	writeJBus (PacketPtr pkt)

void	readIob (PacketPtr pkt)

void	readJBus (PacketPtr pkt)

Private Attributes
Addr	iobManAddr

Addr	iobManSize

Addr	iobJBusAddr

Addr	iobJBusSize

Tick	pioDelay

IntMan	intMan [NumDeviceIds]

IntCtl	intCtl [NumDeviceIds]

uint64_t	jIntVec

uint64_t	jBusData0 [MaxNiagaraProcs]

uint64_t	jBusData1 [MaxNiagaraProcs]

IntBusy	jIntBusy [MaxNiagaraProcs]

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.

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.

Detailed Description

Definition at line 72 of file iob.hh.

Member Enumeration Documentation

◆ DeviceId

enum gem5::Iob::DeviceId

private

Enumerator
Interal
Error
SSI
Reserved
NumDeviceIds

Definition at line 81 of file iob.hh.

◆ Type

enum gem5::Iob::Type

private

Enumerator
Interrupt
Reset
Idle
Resume

Definition at line 108 of file iob.hh.

Constructor & Destructor Documentation

◆ Iob()

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

Definition at line 56 of file iob.cc.

References gem5::Iob::IntMan::cpu, intCtl, intMan, iobJBusAddr, iobJBusSize, iobManAddr, iobManSize, gem5::Iob::IntCtl::mask, gem5::MaxNiagaraProcs, NumDeviceIds, gem5::MipsISA::p, gem5::SimObject::params(), gem5::Iob::IntCtl::pend, pioDelay, gem5::X86ISA::system, gem5::Iob::IntMan::vector, and gem5::RiscvISA::x.

Member Function Documentation

◆ generateIpi()

void gem5::Iob::generateIpi	(	Type	type,
		int	cpu_id,
		int	vector )

Definition at line 279 of file iob.cc.

References DPRINTF, gem5::SparcISA::SparcFaultBase::invoke(), gem5::SparcISA::IT_INT_VEC, panic, gem5::System::Threads::size(), gem5::PioDevice::sys, gem5::System::threads, gem5::SparcISA::SparcFault< T >::trapType(), gem5::X86ISA::type, gem5::X86ISA::vector, and warn.

Referenced by writeIob().

◆ getAddrRanges()

AddrRangeList gem5::Iob::getAddrRanges ( ) const

overridevirtual

Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

Returns: a list of non-overlapping address ranges

Implements gem5::PioDevice.

Definition at line 339 of file iob.cc.

References iobJBusAddr, iobJBusSize, iobManAddr, iobManSize, and gem5::RangeSize().

◆ PARAMS()

gem5::Iob::PARAMS ( Iob )

◆ read()

Tick gem5::Iob::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 76 of file iob.cc.

References gem5::Packet::getAddr(), iobJBusAddr, iobJBusSize, iobManAddr, iobManSize, gem5::Packet::makeAtomicResponse(), panic, pioDelay, readIob(), and readJBus().

◆ readIob()

void gem5::Iob::readIob ( PacketPtr pkt )

private

Definition at line 91 of file iob.cc.

References gem5::Iob::IntMan::cpu, data, gem5::Packet::getAddr(), gem5::MipsISA::index, intCtl, gem5::IntCtlAddr, gem5::IntCtlSize, intMan, gem5::IntManAddr, gem5::IntManSize, iobManAddr, jIntVec, gem5::JIntVecAddr, gem5::Iob::IntCtl::mask, panic, gem5::Packet::setBE(), and gem5::Iob::IntMan::vector.

Referenced by read().

◆ readJBus()

void gem5::Iob::readJBus ( PacketPtr pkt )

private

Definition at line 120 of file iob.cc.

References gem5::Iob::IntBusy::busy, gem5::MipsISA::cpuid, data, gem5::Packet::getAddr(), gem5::MipsISA::index, iobJBusAddr, jBusData0, jBusData1, gem5::JIntABusyAddr, jIntBusy, gem5::JIntBusyAddr, gem5::JIntBusySize, gem5::JIntData0Addr, gem5::JIntData1Addr, gem5::JIntDataA0Addr, gem5::JIntDataA1Addr, panic, gem5::Packet::req, gem5::Packet::setBE(), and gem5::Iob::IntBusy::source.

Referenced by read().

◆ receiveDeviceInterrupt()

void gem5::Iob::receiveDeviceInterrupt ( DeviceId devid )

Definition at line 263 of file iob.cc.

References gem5::Iob::IntMan::cpu, DPRINTF, intCtl, intMan, gem5::SparcISA::IT_INT_VEC, gem5::ArmISA::mask, gem5::Iob::IntCtl::mask, NumDeviceIds, gem5::Iob::IntCtl::pend, gem5::PioDevice::sys, gem5::System::threads, gem5::Iob::IntMan::vector, and gem5::X86ISA::vector.

◆ receiveJBusInterrupt()

bool gem5::Iob::receiveJBusInterrupt	(	int	cpu_id,
		int	source,
		uint64_t	d0,
		uint64_t	d1 )

Definition at line 317 of file iob.cc.

References gem5::Iob::IntBusy::busy, gem5::PowerISA::d0, gem5::PowerISA::d1, DPRINTF, gem5::SparcISA::IT_INT_VEC, jBusData0, jBusData1, jIntBusy, jIntVec, gem5::Iob::IntBusy::source, gem5::PioDevice::sys, and gem5::System::threads.

◆ serialize()

void gem5::Iob::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 349 of file iob.cc.

References gem5::csprintf(), intCtl, intMan, jBusData0, jBusData1, jIntBusy, jIntVec, gem5::ArmISA::mask, gem5::MaxNiagaraProcs, NumDeviceIds, gem5::paramOut(), SERIALIZE_ARRAY, SERIALIZE_SCALAR, gem5::X86ISA::vector, and gem5::RiscvISA::x.

◆ unserialize()

void gem5::Iob::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 370 of file iob.cc.

References gem5::csprintf(), intCtl, intMan, jBusData0, jBusData1, jIntBusy, jIntVec, gem5::ArmISA::mask, gem5::MaxNiagaraProcs, NumDeviceIds, gem5::paramIn(), UNSERIALIZE_ARRAY, UNSERIALIZE_SCALAR, gem5::X86ISA::vector, and gem5::RiscvISA::x.

◆ write()

Tick gem5::Iob::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 170 of file iob.cc.

References gem5::Packet::getAddr(), iobJBusAddr, iobJBusSize, iobManAddr, iobManSize, gem5::Packet::makeAtomicResponse(), panic, pioDelay, writeIob(), and writeJBus().

◆ writeIob()

void gem5::Iob::writeIob ( PacketPtr pkt )

private

Definition at line 185 of file iob.cc.

References gem5::bits(), gem5::Iob::IntMan::cpu, data, DPRINTF, generateIpi(), gem5::Packet::getAddr(), gem5::Packet::getBE(), gem5::MipsISA::index, intCtl, gem5::IntCtlAddr, gem5::IntCtlSize, intMan, gem5::IntManAddr, gem5::IntManSize, gem5::IntVecDisAddr, gem5::IntVecDisSize, iobManAddr, jIntVec, gem5::JIntVecAddr, gem5::Iob::IntCtl::mask, panic, gem5::Iob::IntCtl::pend, gem5::X86ISA::type, gem5::Iob::IntMan::vector, and gem5::X86ISA::vector.

Referenced by write().

◆ writeJBus()

void gem5::Iob::writeJBus ( PacketPtr pkt )

private

Definition at line 236 of file iob.cc.

References gem5::bits(), gem5::Iob::IntBusy::busy, gem5::MipsISA::cpuid, data, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getBE(), gem5::MipsISA::index, iobJBusAddr, gem5::JIntABusyAddr, jIntBusy, gem5::JIntBusyAddr, gem5::JIntBusySize, panic, and gem5::Packet::req.

Referenced by write().

Member Data Documentation

◆ intCtl

IntCtl gem5::Iob::intCtl[NumDeviceIds]

private

Definition at line 117 of file iob.hh.

Referenced by Iob(), readIob(), receiveDeviceInterrupt(), serialize(), unserialize(), and writeIob().

◆ intMan

IntMan gem5::Iob::intMan[NumDeviceIds]

private

Definition at line 116 of file iob.hh.

Referenced by Iob(), readIob(), receiveDeviceInterrupt(), serialize(), unserialize(), and writeIob().

◆ iobJBusAddr

Addr gem5::Iob::iobJBusAddr

private

Definition at line 77 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), readJBus(), write(), and writeJBus().

◆ iobJBusSize

Addr gem5::Iob::iobJBusSize

private

Definition at line 78 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), and write().

◆ iobManAddr

Addr gem5::Iob::iobManAddr

private

Definition at line 75 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), readIob(), write(), and writeIob().

◆ iobManSize

Addr gem5::Iob::iobManSize

private

Definition at line 76 of file iob.hh.

Referenced by getAddrRanges(), Iob(), read(), and write().

◆ jBusData0

uint64_t gem5::Iob::jBusData0[MaxNiagaraProcs]

private

Definition at line 119 of file iob.hh.

Referenced by readJBus(), receiveJBusInterrupt(), serialize(), and unserialize().

◆ jBusData1

uint64_t gem5::Iob::jBusData1[MaxNiagaraProcs]

private

Definition at line 120 of file iob.hh.

Referenced by readJBus(), receiveJBusInterrupt(), serialize(), and unserialize().

◆ jIntBusy

IntBusy gem5::Iob::jIntBusy[MaxNiagaraProcs]

private

Definition at line 121 of file iob.hh.

Referenced by readJBus(), receiveJBusInterrupt(), serialize(), unserialize(), and writeJBus().

◆ jIntVec

uint64_t gem5::Iob::jIntVec

private

Definition at line 118 of file iob.hh.

Referenced by readIob(), receiveJBusInterrupt(), serialize(), unserialize(), and writeIob().

◆ pioDelay

Tick gem5::Iob::pioDelay

private

Definition at line 79 of file iob.hh.

Referenced by Iob(), read(), and write().

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

dev/sparc/iob.hh
dev/sparc/iob.cc

Classes

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ DeviceId

◆ Type

Constructor & Destructor Documentation

◆ Iob()

Member Function Documentation

◆ generateIpi()

◆ getAddrRanges()

◆ PARAMS()

◆ read()

◆ readIob()

◆ readJBus()

◆ receiveDeviceInterrupt()

◆ receiveJBusInterrupt()

◆ serialize()

◆ unserialize()

◆ write()

◆ writeIob()

◆ writeJBus()

Member Data Documentation

◆ intCtl

◆ intMan

◆ iobJBusAddr

◆ iobJBusSize

◆ iobManAddr

◆ iobManSize

◆ jBusData0

◆ jBusData1

◆ jIntBusy

◆ jIntVec

◆ pioDelay