#include <device.hh>

Inheritance diagram for gem5::ps2::Device:

Public Member Functions
	Device (const PS2DeviceParams &p)

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

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

void	hostRegDataAvailable (const std::function< void()> &c)
	Register a data available callback into the PS/2 interface.

bool	hostDataAvailable () const
	Check if there is pending data from the PS/2 device.

uint8_t	hostRead ()
	Read a character from the device.

void	hostWrite (uint8_t c)
	Transmit a character from the host interface to the device.

Public Member Functions inherited from gem5::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

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

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

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

Protected Member Functions
virtual bool	recv (const std::vector< uint8_t > &data)=0
	Data received from host.

void	send (const uint8_t *data, size_t size)
	Send data from a PS/2 device to a host.

void	send (const std::vector< uint8_t > &data)

void	send (uint8_t data)
	Send a byte of data from a PS/2 device to a host.

void	sendAck ()
	Send an ACK byte to the host.

size_t	sendPending () const
	Output buffer size.

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.

Private Attributes
std::deque< uint8_t >	outBuffer
	Device -> host FIFO.

std::vector< uint8_t >	inBuffer
	Host -> device buffer.

std::function< void()>	dataAvailableCallback

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

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 60 of file device.hh.

Constructor & Destructor Documentation

◆ Device()

gem5::ps2::Device::Device ( const PS2DeviceParams & p )

Definition at line 58 of file device.cc.

References inBuffer.

Member Function Documentation

◆ hostDataAvailable()

bool gem5::ps2::Device::hostDataAvailable ( ) const

inline

Check if there is pending data from the PS/2 device.

Returns: true if there is data pending that can be read using the readData() method.

Definition at line 82 of file device.hh.

References outBuffer.

Referenced by gem5::Pl050::read(), and gem5::Pl050::updateRxInt().

◆ hostRead()

uint8_t gem5::ps2::Device::hostRead ( )

Read a character from the device.

Returns: Character from the device's output buffer, undefined if no data is pending.

Definition at line 96 of file device.cc.

References data, and outBuffer.

Referenced by gem5::Pl050::read().

◆ hostRegDataAvailable()

void gem5::ps2::Device::hostRegDataAvailable ( const std::function< void()> & c )

Register a data available callback into the PS/2 interface.

Parameters

c	Callback instance from host interface

Definition at line 86 of file device.cc.

References gem5::ArmISA::c, dataAvailableCallback, and fatal_if.

Referenced by gem5::Pl050::Pl050().

◆ hostWrite()

void gem5::ps2::Device::hostWrite ( uint8_t c )

Transmit a character from the host interface to the device.

Parameters

c	Received data.

Definition at line 104 of file device.cc.

References gem5::ArmISA::c, DPRINTF, inBuffer, and recv().

Referenced by gem5::Pl050::write().

◆ recv()

virtual bool gem5::ps2::Device::recv ( const std::vector< uint8_t > & data )

protectedpure virtual

Data received from host.

Data sent to the device is buffered one byte at a time. Each time a byte is added, this function is called and passed the current buffer. It should return true if it has consumed the data and the buffer can be cleared, or false if more data is needed to process the current command.

Parameters