gem5  v21.1.0.2
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | List of all members
gem5::ps2::TouchKit Class Reference

#include <touchkit.hh>

Inheritance diagram for gem5::ps2::TouchKit:
gem5::ps2::Device gem5::VncMouse gem5::SimObject gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Public Member Functions

 TouchKit (const PS2TouchKitParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
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 More...
 
- 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. More...
 
bool hostDataAvailable () const
 Check if there is pending data from the PS/2 device. More...
 
uint8_t hostRead ()
 Read a character from the device. More...
 
void hostWrite (uint8_t c)
 Transmit a character from the host interface to the device. More...
 
- Public Member Functions inherited from gem5::SimObject
const Paramsparams () 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. More...
 
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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. More...
 
virtual PortgetPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a port with a given name and index. 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 gem5::EventManager
EventQueueeventQueue () 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 gem5::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 gem5::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 gem5::statistics::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 (statistics::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 InforesolveStat (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
 
Groupoperator= (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. More...
 
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. More...
 
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. More...
 
void sendAck ()
 Send an ACK byte to the host. More...
 
size_t sendPending () const
 Output buffer size. More...
 
- Protected Member Functions inherited from gem5::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 Attributes

VncInput *const vnc
 The vnc server we're connected to (if any) More...
 
bool enabled
 Is the device enabled? More...
 
bool touchKitEnabled
 Has the driver enabled TouchKit mode? The model suppresses touch event generation until this is true. More...
 
- Protected Attributes inherited from gem5::SimObject
const SimObjectParams & _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from gem5::EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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. More...
 
static SimObjectfind (const char *name)
 Find the SimObject with the given name and return a pointer to it. More...
 
static void setSimObjectResolver (SimObjectResolver *resolver)
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
static SimObjectResolvergetSimObjectResolver ()
 There is a single object name resolver, and it is only set when simulation is restoring from checkpoints. More...
 
- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section. More...
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it. More...
 

Detailed Description

Definition at line 53 of file touchkit.hh.

Member Enumeration Documentation

◆ PS2Commands

Enumerator
TpReadId 
TouchKitDiag 

Definition at line 56 of file touchkit.hh.

◆ TKCommands

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
xthe x position of the mouse
ythe y position of the mouse
buttosthe 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
dataPending 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

◆ 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
cpCheckpoint 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
cpCheckpoint 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:

Generated on Tue Sep 21 2021 12:31:54 for gem5 by doxygen 1.8.17