#include <fvp_base_pwr_ctrl.hh>

Inheritance diagram for FVPBasePwrCtrl:

Classes
struct	Registers

Public Member Functions
	FVPBasePwrCtrl (const FVPBasePwrCtrlParams &params)

void	setStandByWfi (ThreadContext *const tc)
	Triggered by the ISA when a WFI instruction is executed and (1) there are no pending interrupts and (2) it is not trapped. More...

void	clearStandByWfi (ThreadContext *const tc)
	Triggered when an interrupt is posted to the core. More...

bool	setWakeRequest (ThreadContext *const tc)
	Triggered by the GIC when GICR_WAKER.ProcessorSleep is 1 and there are pending interrupts for the core. More...

void	clearWakeRequest (ThreadContext *const tc)
	Triggered by the GIC when GICR_WAKER.ProcessorSleep becomes 0. More...

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

Public Member Functions inherited from 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 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...

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

Public Member Functions inherited from 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 SimObject
const Params &	params () const

	SimObject (const Params &p)

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

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

void	mergeStatGroup (Group *block)
	Merge the contents (stats & children) of a block to this block. 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
Tick	read (PacketPtr pkt) override
	Pure virtual function that the device must implement. More...

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

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

Private Types
enum	{ WK_COLD, WK_RESET, WK_PPONR, WK_GICWR }
	Wake-up reasons. More...

Private Member Functions
	BitUnion32 (PwrStatus) Bitfield< 30 > l1

PwrStatus *	getCorePwrStatus (ThreadContext *const tc)
	Retrieves the power status of a certain core and resizes the entries if needed. More...

ThreadContext *	getThreadContextByMPID (uint32_t mpid) const
	Retrieves the thread context reference for a CPU core by MPID. More...

void	powerCoreOn (ThreadContext const tc, PwrStatus const pwrs)
	Powers on a core. More...

void	powerCoreOff (ThreadContext const tc, PwrStatus const pwrs)
	Powers off a core. More...

void	startCoreUp (ThreadContext *const tc)
	Starts a core up. More...

Private Attributes
Bitfield< 29 >	l0

Bitfield< 28 >	wen

Bitfield< 27 >	pc

Bitfield< 26 >	pp

Bitfield< 25, 24 >	wk

Bitfield< 1 >	pwfi

Bitfield< 0 >	pwk

EndBitUnion(PwrStatus) enum Offset struct FVPBasePwrCtrl::Registers	regs

std::vector< PwrStatus >	corePwrStatus
	Per-core power status. More...

std::unordered_map< uint32_t, size_t >	poweredCoresPerCluster
	Number of powered cores per cluster. More...

ArmSystem &	system
	Reference to the arm system. More...

Static Private Attributes
static constexpr uint32_t	MPID_MSK = 0x00ffffff
	Mask for extracting the MPID from a 32-bit value. More...

Additional Inherited Members
Public Types inherited from PioDevice
using	Params = PioDeviceParams

Public Types inherited from ClockedObject
using	Params = ClockedObjectParams
	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

Protected Attributes inherited from 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 PioDevice
System *	sys

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

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

Detailed Description

Definition at line 55 of file fvp_base_pwr_ctrl.hh.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

private

Wake-up reasons.

Enumerator
WK_COLD
WK_RESET
WK_PPONR
WK_GICWR

Definition at line 128 of file fvp_base_pwr_ctrl.hh.

Constructor & Destructor Documentation

◆ FVPBasePwrCtrl()

FVPBasePwrCtrl::FVPBasePwrCtrl ( const FVPBasePwrCtrlParams & params )

Definition at line 50 of file fvp_base_pwr_ctrl.cc.

References System::multiThread, ArmSystem::setPowerController(), PioDevice::sys, system, and warn_if.

Member Function Documentation

◆ BitUnion32()

FVPBasePwrCtrl::BitUnion32 ( PwrStatus )

private

◆ clearStandByWfi()

void FVPBasePwrCtrl::clearStandByWfi ( ThreadContext *const tc )

Triggered when an interrupt is posted to the core.

Core is brought up from quiescent state if it is suspended. The latter is done by BaseCPU::wakeup.

Parameters

tc	Thread context representing the core

Definition at line 84 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::contextId(), DPRINTF, and getCorePwrStatus().

Referenced by startCoreUp().

◆ clearWakeRequest()

void FVPBasePwrCtrl::clearWakeRequest ( ThreadContext *const tc )

Triggered by the GIC when GICR_WAKER.ProcessorSleep becomes 0.

Parameters

tc	Thread context representing the core

Definition at line 112 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::contextId(), DPRINTF, and getCorePwrStatus().

Referenced by startCoreUp().

◆ getCorePwrStatus()

FVPBasePwrCtrl::PwrStatus * FVPBasePwrCtrl::getCorePwrStatus ( ThreadContext *const tc )

private

Retrieves the power status of a certain core and resizes the entries if needed.

This is a workaround for a limitation of the System object only exposing existing thread contexts after "init()"

Parameters

Thread (HW) context in the core

Returns: Core power status

Definition at line 250 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::contextId(), corePwrStatus, poweredCoresPerCluster, and ThreadContext::socketId().

Referenced by clearStandByWfi(), clearWakeRequest(), powerCoreOn(), setStandByWfi(), setWakeRequest(), and write().

◆ getThreadContextByMPID()

ThreadContext * FVPBasePwrCtrl::getThreadContextByMPID ( uint32_t mpid ) const

private

Retrieves the thread context reference for a CPU core by MPID.

Parameters

mpid	ID provided by software

Returns: valid thread context reference if valid MPID, nullptr otherwise

Definition at line 258 of file fvp_base_pwr_ctrl.cc.

References ArmISA::getAffinity(), PioDevice::sys, system, and System::threads.

Referenced by write().

◆ powerCoreOff()

void FVPBasePwrCtrl::powerCoreOff	(	ThreadContext *const	tc,
		PwrStatus *const	pwrs
	)

private

Powers off a core.

The core enters into quiescent state until an explicit PPONR write or a WakeRequest from the GIC wakes it up

Parameters

Thread	(HW) context in the core
Core	power status

Definition at line 287 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::contextId(), DPRINTF, ThreadContext::getCpuPtr(), RiscvISA::OFF, poweredCoresPerCluster, ClockedObject::powerState, PowerState::set(), and ThreadContext::socketId().

Referenced by setStandByWfi(), and write().

◆ powerCoreOn()

void FVPBasePwrCtrl::powerCoreOn	(	ThreadContext *const	tc,
		PwrStatus *const	pwrs
	)

private

Powers on a core.

A Reset fault is invoked in the core followed by an activation

Parameters

Thread	(HW) context in the core
Core	power status

Definition at line 268 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::contextId(), DPRINTF, getCorePwrStatus(), ThreadContext::getCpuPtr(), poweredCoresPerCluster, ClockedObject::powerState, PowerState::set(), ThreadContext::socketId(), PioDevice::sys, and System::threads.

Referenced by setWakeRequest(), and write().

◆ read()

Tick FVPBasePwrCtrl::read ( PacketPtr pkt )

overrideprotectedvirtual

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

Definition at line 123 of file fvp_base_pwr_ctrl.cc.

References X86ISA::addr, DPRINTF, Packet::getAddr(), Packet::getSize(), Packet::makeResponse(), panic_if, FVPBasePwrCtrl::Registers::pcoffr, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, FVPBasePwrCtrl::Registers::ppoffr, FVPBasePwrCtrl::Registers::pponr, FVPBasePwrCtrl::Registers::psysr, FVPBasePwrCtrl::Registers::pwkupr, regs, Packet::setUintX(), and warn.

◆ setStandByWfi()

void FVPBasePwrCtrl::setStandByWfi ( ThreadContext *const tc )

Triggered by the ISA when a WFI instruction is executed and (1) there are no pending interrupts and (2) it is not trapped.

Core is set to quiescent state only if there is a pending power off

Parameters

tc	Thread context representing the core

Definition at line 71 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::contextId(), DPRINTF, getCorePwrStatus(), and powerCoreOff().

◆ setWakeRequest()

bool FVPBasePwrCtrl::setWakeRequest ( ThreadContext *const tc )

Triggered by the GIC when GICR_WAKER.ProcessorSleep is 1 and there are pending interrupts for the core.

Parameters

tc	Thread context representing the core

Returns: true if the core is powered ON when PwrStatus.WEN is enabled, false otherwise

Definition at line 95 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::contextId(), DPRINTF, getCorePwrStatus(), powerCoreOn(), and WK_GICWR.

◆ startCoreUp()

void FVPBasePwrCtrl::startCoreUp ( ThreadContext *const tc )

private

Starts a core up.

This invokes the reset vector to setup the wake-up entrypoint and activates the thread context. This covers cases when PSYSR.WEN is enabled or PPONR is written

Parameters

Thread (HW) context in the core

Definition at line 302 of file fvp_base_pwr_ctrl.cc.

References ThreadContext::activate(), clearStandByWfi(), clearWakeRequest(), ThreadContext::contextId(), DPRINTF, and Ps2::Reset.

Referenced by write().

◆ startup()

void FVPBasePwrCtrl::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 SimObject.

Definition at line 61 of file fvp_base_pwr_ctrl.cc.

References corePwrStatus, poweredCoresPerCluster, System::Threads::size(), SimObject::startup(), PioDevice::sys, and System::threads.

◆ write()

Tick FVPBasePwrCtrl::write ( PacketPtr pkt )

overrideprotectedvirtual

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

Definition at line 160 of file fvp_base_pwr_ctrl.cc.

References X86ISA::addr, bits(), data, DPRINTF, Packet::getAddr(), getCorePwrStatus(), Packet::getSize(), getThreadContextByMPID(), Packet::getUintX(), Packet::makeResponse(), MPID_MSK, panic_if, FVPBasePwrCtrl::Registers::pcoffr, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, powerCoreOff(), powerCoreOn(), FVPBasePwrCtrl::Registers::ppoffr, FVPBasePwrCtrl::Registers::pponr, FVPBasePwrCtrl::Registers::psysr, FVPBasePwrCtrl::Registers::pwkupr, regs, ThreadContext::socketId(), startCoreUp(), PioDevice::sys, System::threads, warn, WK_GICWR, and WK_PPONR.

Member Data Documentation

◆ corePwrStatus

std::vector<PwrStatus> FVPBasePwrCtrl::corePwrStatus

private

Per-core power status.

This is power related information for each core that is bound to this power controller functionality

Definition at line 134 of file fvp_base_pwr_ctrl.hh.

Referenced by getCorePwrStatus(), and startup().

◆ l0

Bitfield<29> FVPBasePwrCtrl::l0

private

Definition at line 100 of file fvp_base_pwr_ctrl.hh.

◆ MPID_MSK

constexpr uint32_t FVPBasePwrCtrl::MPID_MSK = 0x00ffffff

staticconstexprprivate

Mask for extracting the MPID from a 32-bit value.

Definition at line 126 of file fvp_base_pwr_ctrl.hh.

Referenced by write().

◆ pc

Bitfield<27> FVPBasePwrCtrl::pc

private

Definition at line 102 of file fvp_base_pwr_ctrl.hh.

◆ poweredCoresPerCluster

std::unordered_map<uint32_t, size_t> FVPBasePwrCtrl::poweredCoresPerCluster

private

Number of powered cores per cluster.

Helps keep track of PSYSR.L1

Definition at line 137 of file fvp_base_pwr_ctrl.hh.

Referenced by getCorePwrStatus(), powerCoreOff(), powerCoreOn(), and startup().

◆ pp

Bitfield<26> FVPBasePwrCtrl::pp

private

Definition at line 103 of file fvp_base_pwr_ctrl.hh.

◆ pwfi

Bitfield<1> FVPBasePwrCtrl::pwfi

private

Definition at line 105 of file fvp_base_pwr_ctrl.hh.

◆ pwk

Bitfield<0> FVPBasePwrCtrl::pwk

private

Definition at line 106 of file fvp_base_pwr_ctrl.hh.

◆ regs

EndBitUnion (PwrStatus) enum Offset struct FVPBasePwrCtrl::Registers FVPBasePwrCtrl::regs

private

Referenced by read(), and write().

◆ system

ArmSystem& FVPBasePwrCtrl::system

private

Reference to the arm system.

Definition at line 180 of file fvp_base_pwr_ctrl.hh.

Referenced by FVPBasePwrCtrl(), and getThreadContextByMPID().

◆ wen

Bitfield<28> FVPBasePwrCtrl::wen

private

Definition at line 101 of file fvp_base_pwr_ctrl.hh.

◆ wk

Bitfield<25,24> FVPBasePwrCtrl::wk

private

Definition at line 104 of file fvp_base_pwr_ctrl.hh.

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

dev/arm/fvp_base_pwr_ctrl.hh
dev/arm/fvp_base_pwr_ctrl.cc

Classes

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ FVPBasePwrCtrl()

Member Function Documentation

◆ BitUnion32()

◆ clearStandByWfi()

◆ clearWakeRequest()

◆ getCorePwrStatus()

◆ getThreadContextByMPID()

◆ powerCoreOff()

◆ powerCoreOn()

◆ read()

◆ setStandByWfi()

◆ setWakeRequest()

◆ startCoreUp()

◆ startup()

◆ write()

Member Data Documentation

◆ corePwrStatus

◆ l0

◆ MPID_MSK

◆ pc

◆ poweredCoresPerCluster

◆ pp

◆ pwfi

◆ pwk

◆ regs

◆ system

◆ wen

◆ wk