#include <kmi.hh>

Inheritance diagram for gem5::Pl050:

Public Member Functions
	Pl050 (const Pl050Params &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	serialize (CheckpointOut &cp) const override
	Serialize an object.

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

Public Member Functions inherited from gem5::AmbaIntDevice
	AmbaIntDevice (const Params &p, Addr pio_size)

Public Member Functions inherited from gem5::AmbaPioDevice
	AmbaPioDevice (const Params &p, Addr pio_size)

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.

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

Protected Member Functions
	BitUnion8 (ControlReg) Bitfield< 0 > force_clock_low

	EndBitUnion (ControlReg) ControlReg control
	control register

	BitUnion8 (StatusReg) Bitfield< 0 > data_in
	KMI status register.

	EndBitUnion (StatusReg) StatusReg status

	BitUnion8 (InterruptReg) Bitfield< 0 > rx

	EndBitUnion (InterruptReg) InterruptReg rawInterrupts
	raw interrupt register (unmasked)

void	setTxInt (bool value)
	Set or clear the TX interrupt.

void	updateRxInt ()
	Update the RX interrupt using PS/2 device state.

void	updateIntCtrl (InterruptReg ints, ControlReg ctrl)
	Update the status of the interrupt and control registers and deliver an interrupt if required.

void	setInterrupts (InterruptReg ints)

void	setControl (ControlReg ctrl)

InterruptReg	getInterrupt () const
	Get current interrupt value.

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 Member Functions inherited from gem5::AmbaDevice
bool	readId (PacketPtr pkt, uint64_t amba_id, Addr pio_addr)

Protected Attributes
Bitfield< 1 >	force_data_low

Bitfield< 2 >	enable

Bitfield< 3 >	txint_enable

Bitfield< 4 >	rxint_enable

Bitfield< 5 >	type

Bitfield< 1 >	clk_in

Bitfield< 2 >	rxparity

Bitfield< 3 >	rxbusy

Bitfield< 4 >	rxfull

Bitfield< 5 >	txbusy

Bitfield< 6 >	txempty

uint8_t	clkdiv
	clock divisor register This register is just kept around to satisfy reads after driver does writes.

Bitfield< 1 >	tx

ps2::Device *	ps2Device
	PS2 device connected to this KMI interface.

Protected Attributes inherited from gem5::AmbaIntDevice
ArmInterruptPin *const	interrupt

Tick	intDelay

Protected Attributes inherited from gem5::AmbaPioDevice
uint64_t	ambaId

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.

Static Protected Attributes
static const int	kmiCr = 0x000

static const int	kmiStat = 0x004

static const int	kmiData = 0x008

static const int	kmiClkDiv = 0x00C

static const int	kmiISR = 0x010

Static Protected Attributes inherited from gem5::AmbaDevice
static const int	AMBA_PER_ID0 = 0xFE0

static const int	AMBA_PER_ID1 = 0xFE4

static const int	AMBA_PER_ID2 = 0xFE8

static const int	AMBA_PER_ID3 = 0xFEC

static const int	AMBA_CEL_ID0 = 0xFF0

static const int	AMBA_CEL_ID1 = 0xFF4

static const int	AMBA_CEL_ID2 = 0xFF8

static const int	AMBA_CEL_ID3 = 0xFFC

Additional Inherited Members
Public Types inherited from gem5::AmbaIntDevice
typedef AmbaIntDeviceParams	Params

Public Types inherited from gem5::AmbaPioDevice
typedef AmbaPioDeviceParams	Params

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

Detailed Description

Definition at line 62 of file kmi.hh.

Constructor & Destructor Documentation

◆ Pl050()

gem5::Pl050::Pl050 ( const Pl050Params & p )

Definition at line 54 of file kmi.cc.

References gem5::ps2::Device::hostRegDataAvailable(), ps2Device, and updateRxInt().

Member Function Documentation

◆ BitUnion8() [1/3]

gem5::Pl050::BitUnion8 ( ControlReg )

protected

◆ BitUnion8() [2/3]

gem5::Pl050::BitUnion8 ( InterruptReg )

protected

◆ BitUnion8() [3/3]

gem5::Pl050::BitUnion8 ( StatusReg )

protected

KMI status register.

◆ EndBitUnion() [1/3]

gem5::Pl050::EndBitUnion ( ControlReg )

protected

control register

◆ EndBitUnion() [2/3]

gem5::Pl050::EndBitUnion ( InterruptReg )

protected

raw interrupt register (unmasked)

◆ EndBitUnion() [3/3]

gem5::Pl050::EndBitUnion ( StatusReg )

protected

◆ getInterrupt()

Pl050::InterruptReg gem5::Pl050::getInterrupt ( ) const

protected

Get current interrupt value.

Definition at line 198 of file kmi.cc.

Referenced by read(), and updateIntCtrl().

◆ read()

Tick gem5::Pl050::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 63 of file kmi.cc.

References gem5::AmbaPioDevice::ambaId, clkdiv, data, DPRINTF, gem5::Packet::getAddr(), getInterrupt(), gem5::Packet::getUintX(), gem5::ps2::Device::hostDataAvailable(), gem5::ps2::Device::hostRead(), kmiClkDiv, kmiCr, kmiData, kmiISR, kmiStat, gem5::Packet::makeAtomicResponse(), gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, gem5::BasicPioDevice::pioSize, ps2Device, gem5::AmbaDevice::readId(), gem5::Packet::setUintX(), gem5::ArmISA::status, updateRxInt(), and warn.

◆ serialize()

void gem5::Pl050::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 209 of file kmi.cc.

References clkdiv, gem5::paramOut(), SERIALIZE_SCALAR, and gem5::ArmISA::status.

◆ setControl()

void gem5::Pl050::setControl ( ControlReg ctrl )

inlineprotected

Definition at line 125 of file kmi.hh.

References updateIntCtrl().

Referenced by write().

◆ setInterrupts()

void gem5::Pl050::setInterrupts ( InterruptReg ints )

inlineprotected

Definition at line 124 of file kmi.hh.

References updateIntCtrl().

Referenced by setTxInt(), and updateRxInt().

◆ setTxInt()

void gem5::Pl050::setTxInt ( bool value )

protected

Set or clear the TX interrupt.

Definition at line 159 of file kmi.cc.

References setInterrupts().

Referenced by write().

◆ unserialize()

void gem5::Pl050::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 218 of file kmi.cc.

References clkdiv, gem5::paramIn(), gem5::ArmISA::status, and UNSERIALIZE_SCALAR.

◆ updateIntCtrl()

void gem5::Pl050::updateIntCtrl	(	InterruptReg	ints,
		ControlReg	ctrl )

protected

Update the status of the interrupt and control registers and deliver an interrupt if required.

Definition at line 179 of file kmi.cc.

References gem5::ArmInterruptPin::clear(), DPRINTF, getInterrupt(), gem5::AmbaIntDevice::interrupt, and gem5::ArmInterruptPin::raise().

Referenced by setControl(), and setInterrupts().

◆ updateRxInt()

void gem5::Pl050::updateRxInt ( )

protected

Update the RX interrupt using PS/2 device state.

Definition at line 169 of file kmi.cc.

References gem5::ps2::Device::hostDataAvailable(), ps2Device, and setInterrupts().

Referenced by Pl050(), and read().

◆ write()

Tick gem5::Pl050::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 115 of file kmi.cc.

References clkdiv, data, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::getUintX(), gem5::ps2::Device::hostWrite(), kmiClkDiv, kmiCr, kmiData, gem5::Packet::makeAtomicResponse(), panic_if, gem5::BasicPioDevice::pioAddr, gem5::BasicPioDevice::pioDelay, gem5::BasicPioDevice::pioSize, ps2Device, setControl(), setTxInt(), and warn.

Member Data Documentation

◆ clk_in

Bitfield<1> gem5::Pl050::clk_in

protected

Definition at line 87 of file kmi.hh.

◆ clkdiv

uint8_t gem5::Pl050::clkdiv

protected

clock divisor register This register is just kept around to satisfy reads after driver does writes.

The divsor does nothing, as we're not actually signaling ps2 serial commands to anything.

Definition at line 102 of file kmi.hh.

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

◆ enable

Bitfield<2> gem5::Pl050::enable

protected

Definition at line 74 of file kmi.hh.

◆ force_data_low

Bitfield<1> gem5::Pl050::force_data_low

protected

Definition at line 73 of file kmi.hh.

◆ kmiClkDiv

const int gem5::Pl050::kmiClkDiv = 0x00C

staticprotected

Definition at line 68 of file kmi.hh.

Referenced by read(), and write().

◆ kmiCr

const int gem5::Pl050::kmiCr = 0x000

staticprotected

Definition at line 65 of file kmi.hh.

Referenced by read(), and write().

◆ kmiData

const int gem5::Pl050::kmiData = 0x008

staticprotected

Definition at line 67 of file kmi.hh.

Referenced by read(), and write().

◆ kmiISR

const int gem5::Pl050::kmiISR = 0x010

staticprotected

Definition at line 69 of file kmi.hh.

Referenced by read().

◆ kmiStat

const int gem5::Pl050::kmiStat = 0x004

staticprotected

Definition at line 66 of file kmi.hh.

Referenced by read().

◆ ps2Device

ps2::Device* gem5::Pl050::ps2Device

protected

PS2 device connected to this KMI interface.

Definition at line 131 of file kmi.hh.

Referenced by Pl050(), read(), updateRxInt(), and write().

◆ rxbusy

Bitfield<3> gem5::Pl050::rxbusy

protected

Definition at line 89 of file kmi.hh.

◆ rxfull

Bitfield<4> gem5::Pl050::rxfull

protected

Definition at line 90 of file kmi.hh.

◆ rxint_enable

Bitfield<4> gem5::Pl050::rxint_enable

protected

Definition at line 76 of file kmi.hh.

◆ rxparity

Bitfield<2> gem5::Pl050::rxparity

protected

Definition at line 88 of file kmi.hh.

◆ tx

Bitfield<1> gem5::Pl050::tx

protected

Definition at line 106 of file kmi.hh.

◆ txbusy

Bitfield<5> gem5::Pl050::txbusy

protected

Definition at line 91 of file kmi.hh.

◆ txempty

Bitfield<6> gem5::Pl050::txempty

protected

Definition at line 92 of file kmi.hh.

◆ txint_enable

Bitfield<3> gem5::Pl050::txint_enable

protected

Definition at line 75 of file kmi.hh.

◆ type

Bitfield<5> gem5::Pl050::type

protected

Definition at line 77 of file kmi.hh.

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

dev/arm/kmi.hh
dev/arm/kmi.cc

Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Pl050()

Member Function Documentation

◆ BitUnion8() [1/3]

◆ BitUnion8() [2/3]

◆ BitUnion8() [3/3]

◆ EndBitUnion() [1/3]

◆ EndBitUnion() [2/3]

◆ EndBitUnion() [3/3]

◆ getInterrupt()

◆ read()

◆ serialize()

◆ setControl()

◆ setInterrupts()

◆ setTxInt()

◆ unserialize()

◆ updateIntCtrl()

◆ updateRxInt()

◆ write()

Member Data Documentation

◆ clk_in

◆ clkdiv

◆ enable

◆ force_data_low

◆ kmiClkDiv

◆ kmiCr

◆ kmiData

◆ kmiISR

◆ kmiStat

◆ ps2Device

◆ rxbusy

◆ rxfull

◆ rxint_enable

◆ rxparity

◆ tx

◆ txbusy

◆ txempty

◆ txint_enable

◆ type