NOTE: This implementation of CLINT is based on the SiFive U54MC datasheet: https://sifive.cdn.prismic.io/sifive/fab000f6- 0e07-48d0-9602-e437d5367806_sifive_U54MC_rtl_ full_20G1.03.00_manual.pdf. More...

#include <clint.hh>

Inheritance diagram for Clint:

Classes
class	ClintRegisters
	MMIO Registers 0x0000 - 0x3FFF: msip (write-through to misc reg file) ...: reserved[0] 0x4000 - 0xBFF7: mtimecmp ...: reserved[1] 0xBFF8: mtime (read-only) More...

Public Types
typedef ClintParams	Params

using	Register32 = ClintRegisters::Register32

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

Public Member Functions
	Clint (const Params &params)

void	raiseInterruptPin (int id)
	Timer tick callback. More...

void	lowerInterruptPin (int id)

uint32_t	readMSIP (Register32 &reg, const int thread_id)

void	writeMSIP (Register32 &reg, const uint32_t &data, const int thread_id)

Tick	read (PacketPtr pkt) override
	PioDevice interface functions. More...

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

void	init () override
	SimObject functions. More...

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index. 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 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 ()

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

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

Public Attributes
Clint::ClintRegisters	registers

Public Attributes inherited from ClockedObject
PowerState *	powerState

Protected Attributes
System *	system

IntrControl *	intrctrl

int	nThread

IntSinkPin< Clint >	signal

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

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

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

Detailed Description

NOTE: This implementation of CLINT is based on the SiFive U54MC datasheet: https://sifive.cdn.prismic.io/sifive/fab000f6- 0e07-48d0-9602-e437d5367806_sifive_U54MC_rtl_ full_20G1.03.00_manual.pdf.

Future improvement of the model can check the current privilege mode and enforce access control.

Definition at line 69 of file clint.hh.

Member Typedef Documentation

◆ Params

typedef ClintParams Clint::Params

Definition at line 79 of file clint.hh.

◆ Register32

using Clint::Register32 = ClintRegisters::Register32

Definition at line 125 of file clint.hh.

Constructor & Destructor Documentation

◆ Clint()

Clint::Clint ( const Params & params )

Definition at line 48 of file clint.cc.

Member Function Documentation

◆ getPort()

Port & Clint::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 PioDevice.

Definition at line 198 of file clint.cc.

References PioDevice::getPort(), and signal.

◆ init()

void Clint::init ( )

overridevirtual

SimObject functions.

Reimplemented from PioDevice.

Definition at line 190 of file clint.cc.

References Clint::ClintRegisters::init(), PioDevice::init(), nThread, registers, System::Threads::size(), system, and System::threads.

◆ lowerInterruptPin()

void Clint::lowerInterruptPin ( int id )

inline

Definition at line 90 of file clint.hh.

◆ raiseInterruptPin()

void Clint::raiseInterruptPin ( int id )

Timer tick callback.

Separated from RTC class for easier implementation of a separate RTC PioDevice.

Definition at line 58 of file clint.cc.

References IntrControl::clear(), DPRINTF, RiscvISA::INT_TIMER_MACHINE, intrctrl, RiscvISA::MISCREG_TIME, Clint::ClintRegisters::mtime, Clint::ClintRegisters::mtimecmp, nThread, IntrControl::post(), registers, RiscvISA::ISA::setMiscRegNoEffect(), system, and System::threads.

◆ read()

Tick Clint::read ( PacketPtr pkt )

overridevirtual

PioDevice interface functions.

Implements PioDevice.

Definition at line 154 of file clint.cc.

References Packet::cmd, DPRINTF, Packet::getAddr(), Packet::getAtomicOp(), Packet::getPtr(), Packet::getSize(), Packet::isAtomicOp(), Packet::makeResponse(), BasicPioDevice::pioDelay, RegisterBank< BankByteOrder >::read(), registers, MemCmd::SwapReq, and RegisterBank< ByteOrder::little >::write().

◆ readMSIP()

uint32_t Clint::readMSIP	(	Register32 &	reg,
		const int	thread_id
	)

Definition at line 125 of file clint.cc.

References RiscvISA::INT_SOFTWARE_MACHINE, RiscvISA::MISCREG_IP, Clint::ClintRegisters::msip, X86ISA::reg, system, and System::threads.

Referenced by Clint::ClintRegisters::init().

◆ serialize()

void Clint::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 207 of file clint.cc.

References Clint::ClintRegisters::msip, Clint::ClintRegisters::mtime, Clint::ClintRegisters::mtimecmp, paramOut(), X86ISA::reg, and registers.

◆ unserialize()

void Clint::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements Serializable.

Definition at line 219 of file clint.cc.

References Clint::ClintRegisters::msip, Clint::ClintRegisters::mtime, Clint::ClintRegisters::mtimecmp, paramIn(), X86ISA::reg, and registers.

◆ write()

Tick Clint::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 PioDevice.

Definition at line 176 of file clint.cc.

References DPRINTF, Packet::getAddr(), Packet::getPtr(), Packet::getSize(), Packet::makeResponse(), BasicPioDevice::pioDelay, registers, and RegisterBank< BankByteOrder >::write().

◆ writeMSIP()

void Clint::writeMSIP	(	Register32 &	reg,
		const uint32_t &	data,
		const int	thread_id
	)

Definition at line 136 of file clint.cc.

References IntrControl::clear(), data, DPRINTF, RiscvISA::INT_SOFTWARE_MACHINE, intrctrl, IntrControl::post(), and X86ISA::reg.

Referenced by Clint::ClintRegisters::init().

Member Data Documentation

◆ intrctrl

IntrControl* Clint::intrctrl

protected

Definition at line 74 of file clint.hh.

Referenced by raiseInterruptPin(), and writeMSIP().

◆ nThread

int Clint::nThread

protected

Definition at line 75 of file clint.hh.

Referenced by Clint::ClintRegisters::init(), init(), and raiseInterruptPin().

◆ registers

Clint::ClintRegisters Clint::registers

Referenced by init(), raiseInterruptPin(), read(), serialize(), unserialize(), and write().

◆ signal

IntSinkPin<Clint> Clint::signal

protected

Definition at line 76 of file clint.hh.

Referenced by getPort().

◆ system

System* Clint::system

protected

Definition at line 73 of file clint.hh.

Referenced by init(), raiseInterruptPin(), and readMSIP().

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

dev/riscv/clint.hh
dev/riscv/clint.cc

Classes

Public Types

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

◆ Register32

Constructor & Destructor Documentation

◆ Clint()

Member Function Documentation

◆ getPort()

◆ init()

◆ lowerInterruptPin()

◆ raiseInterruptPin()

◆ read()

◆ readMSIP()

◆ serialize()

◆ unserialize()

◆ write()

◆ writeMSIP()

Member Data Documentation

◆ intrctrl

◆ nThread

◆ registers

◆ signal

◆ system