#include <touchkit.hh>

Inheritance diagram for gem5::ps2::TouchKit:

Public Member Functions
	TouchKit (const PS2TouchKitParams &p)

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

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

void	mouseAt (uint16_t x, uint16_t y, uint8_t buttons) override
	called whenever the mouse moves or it's button state changes buttons is a simple mask with each button (0-8) corresponding to a bit position in the byte with 1 being down and 0 being up

Public Member Functions inherited from gem5::ps2::Device
	Device (const PS2DeviceParams &p)

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.

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 Types
enum	PS2Commands { TpReadId = 0xE1 , TouchKitDiag = 0x0A }

enum	TKCommands { TouchKitActive = 'A' , TouchKitFWRev = 'D' , TouchKitCtrlType = 'E' }

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

bool	recvTouchKit (const std::vector< uint8_t > &data)

void	sendTouchKit (const uint8_t *data, size_t size)

void	sendTouchKit (uint8_t data)

Protected Member Functions inherited from gem5::ps2::Device
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.

Protected Attributes
VncInput *const	vnc
	The vnc server we're connected to (if any)

bool	enabled
	Is the device enabled?

bool	touchKitEnabled
	Has the driver enabled TouchKit mode? The model suppresses touch event generation until this is true.

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.

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.

Detailed Description

Definition at line 53 of file touchkit.hh.

Member Enumeration Documentation

◆ PS2Commands

enum gem5::ps2::TouchKit::PS2Commands

protected

Enumerator
TpReadId
TouchKitDiag

Definition at line 56 of file touchkit.hh.

◆ TKCommands

enum gem5::ps2::TouchKit::TKCommands

protected

Enumerator
TouchKitActive
TouchKitFWRev
TouchKitCtrlType

Definition at line 62 of file touchkit.hh.

Constructor & Destructor Documentation

◆ TouchKit()

gem5::ps2::TouchKit::TouchKit ( const PS2TouchKitParams & p )

Definition at line 58 of file touchkit.cc.

References gem5::VncInput::setMouse(), and vnc.

Member Function Documentation

◆ mouseAt()

void gem5::ps2::TouchKit::mouseAt	(	uint16_t	x,
		uint16_t	y,
		uint8_t	buttons )

overridevirtual

called whenever the mouse moves or it's button state changes buttons is a simple mask with each button (0-8) corresponding to a bit position in the byte with 1 being down and 0 being up

Parameters

x	the x position of the mouse
y	the y position of the mouse
buttos	the button state as described above

Implements gem5::VncMouse.

Definition at line 195 of file touchkit.cc.

References enabled, gem5::ps2::Device::send(), gem5::ps2::Device::sendPending(), touchKitEnabled, gem5::VncInput::videoHeight(), gem5::VncInput::videoWidth(), vnc, and gem5::RiscvISA::x.

◆ recv()

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

overrideprotectedvirtual

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

data	Pending input data (at least one byte)

Returns: false if more data is needed to process the current command, true otherwise.

Implements gem5::ps2::Device.

Definition at line 86 of file touchkit.cc.

References data, gem5::ps2::DefaultsAndDisable, gem5::ps2::Disable, DPRINTF, gem5::ps2::Enable, enabled, gem5::ps2::mouse::GetStatus, gem5::ps2::mouse::ID, panic, gem5::ps2::ReadID, recvTouchKit(), gem5::ps2::Reset, gem5::ps2::mouse::SampleRate, gem5::ps2::mouse::Scale1to1, gem5::ps2::mouse::Scale2to1, gem5::ps2::SelfTestPass, gem5::ps2::Device::send(), gem5::ps2::Device::sendAck(), gem5::ps2::mouse::SetResolution, TouchKitDiag, touchKitEnabled, and TpReadId.

◆ recvTouchKit()

bool gem5::ps2::TouchKit::recvTouchKit ( const std::vector< uint8_t > & data )

protected

Definition at line 155 of file touchkit.cc.

References data, gem5::ArmISA::len, panic, gem5::ps2::Device::sendAck(), sendTouchKit(), TouchKitActive, TouchKitDiag, touchKitEnabled, and warn_if.

Referenced by recv().

◆ sendTouchKit() [1/2]

void gem5::ps2::TouchKit::sendTouchKit	(	const uint8_t *	data,
		size_t	size )

protected

Definition at line 185 of file touchkit.cc.

References data, gem5::ArmISA::i, gem5::ps2::Device::send(), and TouchKitDiag.

Referenced by recvTouchKit().

◆ sendTouchKit() [2/2]

void gem5::ps2::TouchKit::sendTouchKit ( uint8_t data )

inlineprotected

Definition at line 84 of file touchkit.hh.

References data, and sendTouchKit().

Referenced by sendTouchKit().

◆ serialize()

void gem5::ps2::TouchKit::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::ps2::Device.

Definition at line 68 of file touchkit.cc.

References enabled, gem5::ps2::Device::serialize(), SERIALIZE_SCALAR, and touchKitEnabled.

◆ unserialize()

void gem5::ps2::TouchKit::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Reimplemented from gem5::ps2::Device.

Definition at line 77 of file touchkit.cc.

References enabled, touchKitEnabled, gem5::ps2::Device::unserialize(), and UNSERIALIZE_SCALAR.

Member Data Documentation

◆ enabled

bool gem5::ps2::TouchKit::enabled

protected

Is the device enabled?

Definition at line 90 of file touchkit.hh.

Referenced by mouseAt(), recv(), serialize(), and unserialize().

◆ touchKitEnabled

bool gem5::ps2::TouchKit::touchKitEnabled

protected

Has the driver enabled TouchKit mode? The model suppresses touch event generation until this is true.

Definition at line 96 of file touchkit.hh.

Referenced by mouseAt(), recv(), recvTouchKit(), serialize(), and unserialize().

◆ vnc

VncInput* const gem5::ps2::TouchKit::vnc

protected

The vnc server we're connected to (if any)

Definition at line 87 of file touchkit.hh.

Referenced by mouseAt(), and TouchKit().

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

dev/ps2/touchkit.hh
dev/ps2/touchkit.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PS2Commands

◆ TKCommands

Constructor & Destructor Documentation

◆ TouchKit()

Member Function Documentation

◆ mouseAt()

◆ recv()

◆ recvTouchKit()

◆ sendTouchKit() [1/2]

◆ sendTouchKit() [2/2]

◆ serialize()

◆ unserialize()

Member Data Documentation

◆ enabled

◆ touchKitEnabled

◆ vnc