#include <smmu_v3.hh>

Inheritance diagram for SMMUv3:

Public Member Functions
	SMMUv3 (SMMUv3Params *p)

virtual	~SMMUv3 ()

virtual void	init () override
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

virtual void	regStats () override
	Callback to set stat parameters. More...

Tick	recvAtomic (PacketPtr pkt, PortID id)

bool	recvTimingReq (PacketPtr pkt, PortID id)

bool	recvTimingResp (PacketPtr pkt)

void	recvReqRetry ()

bool	tableWalkRecvTimingResp (PacketPtr pkt)

void	tableWalkRecvReqRetry ()

Tick	readControl (PacketPtr pkt)

Tick	writeControl (PacketPtr pkt)

DrainState	drain () override
	Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight. More...

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

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

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

Public Member Functions inherited from ClockedObject
	ClockedObject (const ClockedObjectParams *p)

const Params *	params () const

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

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

Public Member Functions inherited from SimObject
const Params *	params () const

	SimObject (const Params *_params)

virtual	~SimObject ()

virtual const std::string	name () const

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...

ProbeManager *	getProbeManager ()
	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 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. 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 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 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 Stats::Group
	Group (Group parent, const char name=nullptr)
	Construct a new statistics group. More...

virtual	~Group ()

virtual void	resetStats ()
	Callback to reset stats. More...

virtual void	preDumpStats ()
	Callback before stats are dumped. More...

void	addStat (Stats::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 Info *	resolveStat (std::string name) const
	Resolve a stat by its name within this group. More...

	Group ()=delete

	Group (const Group &)=delete

Group &	operator= (const Group &)=delete

Public Member Functions inherited from 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 Member Functions
bool	inSecureBlock (uint32_t offs) const

void	scheduleDeviceRetries ()

SMMUAction	runProcess (SMMUProcess *proc, PacketPtr pkt)

SMMUAction	runProcessAtomic (SMMUProcess *proc, PacketPtr pkt)

SMMUAction	runProcessTiming (SMMUProcess *proc, PacketPtr pkt)

void	processCommands ()

void	processCommand (const SMMUCommand &cmd)

const PageTableOps *	getPageTableOps (uint8_t trans_granule)

Protected Member Functions inherited from 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 Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (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
const System &	system

const RequestorID	requestorId

SMMURequestPort	requestPort

SMMUTableWalkPort	tableWalkPort

SMMUControlPort	controlPort

ARMArchTLB	tlb

ConfigCache	configCache

IPACache	ipaCache

WalkCache	walkCache

const bool	tlbEnable

const bool	configCacheEnable

const bool	ipaCacheEnable

const bool	walkCacheEnable

bool	tableWalkPortEnable

const bool	walkCacheNonfinalEnable

const unsigned	walkCacheS1Levels

const unsigned	walkCacheS2Levels

const unsigned	requestPortWidth

SMMUSemaphore	tlbSem

SMMUSemaphore	ifcSmmuSem

SMMUSemaphore	smmuIfcSem

SMMUSemaphore	configSem

SMMUSemaphore	ipaSem

SMMUSemaphore	walkSem

SMMUSemaphore	requestPortSem

SMMUSemaphore	transSem

SMMUSemaphore	ptwSem

SMMUSemaphore	cycleSem

const Cycles	tlbLat

const Cycles	ifcSmmuLat

const Cycles	smmuIfcLat

const Cycles	configLat

const Cycles	ipaLat

const Cycles	walkLat

Stats::Scalar	steL1Fetches

Stats::Scalar	steFetches

Stats::Scalar	cdL1Fetches

Stats::Scalar	cdFetches

Stats::Distribution	translationTimeDist

Stats::Distribution	ptwTimeDist

std::vector< SMMUv3DeviceInterface * >	deviceInterfaces

SMMUCommandExecProcess	commandExecutor

const AddrRange	regsMap

SMMURegs	regs

std::queue< SMMUAction >	packetsToRetry

std::queue< SMMUAction >	packetsTableWalkToRetry

EventWrapper< SMMUv3, &SMMUv3::processCommands >	processCommandsEvent

Protected Attributes inherited from SimObject
const SimObjectParams *	_params
	Cached copy of the object parameters. More...

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

Friends
class	SMMUProcess

class	SMMUTranslationProcess

class	SMMUCommandExecProcess

class	SMMUv3DeviceInterface

Additional Inherited Members
Public Types inherited from ClockedObject
typedef ClockedObjectParams	Params
	Parameters of ClockedObject. More...

Public Types inherited from SimObject
typedef SimObjectParams	Params

Static Public Member Functions inherited from SimObject
static void	serializeAll (CheckpointOut &cp)
	Serialize all SimObjects in the system. More...

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

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

static void	serializeAll (const std::string &cpt_dir)
	Serializes all the SimObjects. More...

static void	unserializeGlobals (CheckpointIn &cp)

Public Attributes inherited from ClockedObject
PowerState *	powerState

Detailed Description

Definition at line 81 of file smmu_v3.hh.

Constructor & Destructor Documentation

◆ SMMUv3()

SMMUv3::SMMUv3 ( SMMUv3Params * p )

Definition at line 54 of file smmu_v3.cc.

References ClockedObject::params().

◆ ~SMMUv3()

virtual SMMUv3::~SMMUv3 ( )

inlinevirtual

Definition at line 169 of file smmu_v3.hh.

Member Function Documentation

◆ drain()

DrainState SMMUv3::drain ( )

overridevirtual

Draining is the process of clearing out the states of SimObjects.These are the SimObjects that are partially executed or are partially in flight.

Draining is mostly used before forking and creating a check point.

This function notifies an object that it needs to drain its state.

If the object does not need further simulation to drain internal buffers, it returns DrainState::Drained and automatically switches to the Drained state. If the object needs more simulation, it returns DrainState::Draining and automatically enters the Draining state. Other return values are invalid.

Note: An object that has entered the Drained state can be disturbed by other objects in the system and consequently stop being drained. These perturbations are not visible in the drain state. The simulator therefore repeats the draining process until all objects return DrainState::Drained on the first call to drain().

Returns: DrainState::Drained if the object is drained at this point in time, DrainState::Draining if it needs further simulation.

Implements Drainable.

Definition at line 791 of file smmu_v3.cc.

References commandExecutor, Drained, Draining, and SMMUCommandExecProcess::isBusy().

◆ getPageTableOps()

const PageTableOps * SMMUv3::getPageTableOps ( uint8_t trans_granule )

protected

Definition at line 565 of file smmu_v3.cc.

References panic, TRANS_GRANULE_16K, TRANS_GRANULE_4K, and TRANS_GRANULE_64K.

Referenced by SMMUTranslationProcess::translateStage1And2(), SMMUTranslationProcess::translateStage2(), and SMMUTranslationProcess::walkCacheLookup().

◆ getPort()

Port & SMMUv3::getPort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

overridevirtual

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 SimObject.

Definition at line 817 of file smmu_v3.cc.

References controlPort, SimObject::getPort(), SimObject::name(), requestPort, and tableWalkPort.

◆ init()

void SMMUv3::init ( )

overridevirtual

init() is called after all C++ SimObjects have been created and all ports are connected.

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from SimObject.

Definition at line 718 of file smmu_v3.cc.

References controlPort, deviceInterfaces, fatal, Port::isConnected(), requestPort, ResponsePort::sendRangeChange(), tableWalkPort, and tableWalkPortEnable.

◆ inSecureBlock()

bool SMMUv3::inSecureBlock ( uint32_t offs ) const

protected

Definition at line 709 of file smmu_v3.cc.

References SMMU_SECURE_SZ.

Referenced by readControl(), and writeControl().

◆ processCommand()

void SMMUv3::processCommand ( const SMMUCommand & cmd )

protected

Definition at line 383 of file smmu_v3.cc.

References SMMUCommand::addr(), addr, SMMUCommand::asid, CMD_CFGI_CD, CMD_CFGI_CD_ALL, CMD_CFGI_STE, CMD_CFGI_STE_RANGE, CMD_PRF_ADDR, CMD_PRF_CONFIG, CMD_RESUME, CMD_TLBI_NH_ALL, CMD_TLBI_NH_ASID, CMD_TLBI_NH_VA, CMD_TLBI_NH_VAA, CMD_TLBI_NSNH_ALL, CMD_TLBI_S12_VMALL, CMD_TLBI_S2_IPA, configCache, deviceInterfaces, DPRINTF, ARMArchTLB::invalidateAll(), IPACache::invalidateAll(), ConfigCache::invalidateAll(), WalkCache::invalidateAll(), ARMArchTLB::invalidateASID(), WalkCache::invalidateASID(), IPACache::invalidateIPA(), ConfigCache::invalidateSID(), ConfigCache::invalidateSSID(), ARMArchTLB::invalidateVA(), WalkCache::invalidateVA(), ARMArchTLB::invalidateVAA(), WalkCache::invalidateVAA(), ARMArchTLB::invalidateVMID(), IPACache::invalidateVMID(), WalkCache::invalidateVMID(), ipaCache, panic, SMMUCommand::range, SMMUCommand::sid, SMMUCommand::ssid, tlb, SMMUCommand::type, SMMUCommand::vmid, walkCache, and warn.

Referenced by SMMUCommandExecProcess::main().

◆ processCommands()

void SMMUv3::processCommands ( )

protected

Definition at line 367 of file smmu_v3.cc.

References ArmISA::a, commandExecutor, DPRINTF, System::isAtomicMode(), SMMUCommandExecProcess::isBusy(), System::isTimingMode(), panic, runProcessAtomic(), runProcessTiming(), and system.

◆ readControl()

Tick SMMUv3::readControl ( PacketPtr pkt )

Definition at line 581 of file smmu_v3.cc.

References SMMURegs::data, DPRINTF, Packet::getAddr(), Packet::getSize(), inSecureBlock(), Packet::makeAtomicResponse(), ArmISA::offset, panic, regs, regsMap, Packet::setLE(), SMMU_REG_SIZE, AddrRange::start(), and warn.

Referenced by SMMUControlPort::recvAtomic().

◆ recvAtomic()

Tick SMMUv3::recvAtomic	(	PacketPtr	pkt,
		PortID	id
	)

◆ recvReqRetry()

void SMMUv3::recvReqRetry ( )

Definition at line 144 of file smmu_v3.cc.

References ArmISA::a, ACTION_SEND_REQ, ACTION_SEND_REQ_FINAL, DPRINTF, packetsToRetry, requestPort, scheduleDeviceRetries(), and RequestPort::sendTimingReq().

Referenced by SMMURequestPort::recvReqRetry().

◆ recvTimingReq()

bool SMMUv3::recvTimingReq	(	PacketPtr	pkt,
		PortID	id
	)

◆ recvTimingResp()

bool SMMUv3::recvTimingResp ( PacketPtr pkt )

Definition at line 127 of file smmu_v3.cc.

References DPRINTF, Packet::getAddr(), Packet::getSize(), Packet::headerDelay, Packet::payloadDelay, Packet::popSenderState(), and runProcessTiming().

Referenced by SMMURequestPort::recvTimingResp().

◆ regStats()

void SMMUv3::regStats ( )

overridevirtual

Callback to set stat parameters.

This callback is typically used for complex stats (e.g., distributions) that need parameters in addition to a name and a description. Stat names and descriptions should typically be set from the constructor usingo from the constructor using the ADD_STAT macro.

Reimplemented from Stats::Group.

Definition at line 739 of file smmu_v3.cc.

References cdFetches, cdL1Fetches, configCache, csprintf(), Stats::DataWrap< Derived, InfoProxyType >::desc(), deviceInterfaces, Stats::DataWrap< Derived, InfoProxyType >::flags(), ArmISA::i, Stats::Distribution::init(), ipaCache, SimObject::name(), Stats::DataWrap< Derived, InfoProxyType >::name(), Stats::pdf, ptwTimeDist, SMMUv3BaseCache::regStats(), Stats::Group::regStats(), WalkCache::regStats(), steFetches, steL1Fetches, tlb, translationTimeDist, and walkCache.