gem5  v21.1.0.2
Public Member Functions | Protected Member Functions | Private Attributes | List of all members
gem5::ps2::Device Class Referenceabstract

#include <device.hh>

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

Public Member Functions

 Device (const PS2DeviceParams &p)
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
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 Member Functions

virtual bool recv (const std::vector< uint8_t > &data)=0
 Data received from host. More...
 
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...
 

Private Attributes

std::deque< uint8_t > outBuffer
 Device -> host FIFO. More...
 
std::vector< uint8_t > inBuffer
 Host -> device buffer. More...
 
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. 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...
 
- 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...
 

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
cCallback 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
cReceived 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
dataPending input data (at least one byte)
Returns
false if more data is needed to process the current command, true otherwise.

Implemented in gem5::ps2::PS2Mouse, gem5::ps2::TouchKit, and gem5::ps2::PS2Keyboard.

Referenced by hostWrite().

◆ send() [1/3]

void gem5::ps2::Device::send ( const std::vector< uint8_t > &  data)
inlineprotected

Definition at line 122 of file device.hh.

References data, and send().

◆ send() [2/3]

void gem5::ps2::Device::send ( const uint8_t *  data,
size_t  size 
)
protected

Send data from a PS/2 device to a host.

Parameters
dataPointer to data array
sizeSize of the data array

Definition at line 113 of file device.cc.

References data, dataAvailableCallback, DPRINTF, and outBuffer.

Referenced by gem5::ps2::PS2Keyboard::keyPress(), gem5::ps2::TouchKit::mouseAt(), gem5::ps2::PS2Keyboard::recv(), gem5::ps2::TouchKit::recv(), gem5::ps2::PS2Mouse::recv(), send(), sendAck(), and gem5::ps2::TouchKit::sendTouchKit().

◆ send() [3/3]

void gem5::ps2::Device::send ( uint8_t  data)
inlineprotected

Send a byte of data from a PS/2 device to a host.

Parameters
dataByte to send

Definition at line 131 of file device.hh.

References data, and send().

Referenced by send().

◆ sendAck()

void gem5::ps2::Device::sendAck ( )
protected

Send an ACK byte to the host.

Definition at line 128 of file device.cc.

References gem5::ps2::Ack, and send().

Referenced by gem5::ps2::PS2Keyboard::recv(), gem5::ps2::TouchKit::recv(), gem5::ps2::PS2Mouse::recv(), and gem5::ps2::TouchKit::recvTouchKit().

◆ sendPending()

size_t gem5::ps2::Device::sendPending ( ) const
inlineprotected

Output buffer size.

Device models may use this method to query the size of the output buffer to do rate limiting.

Definition at line 142 of file device.hh.

References outBuffer.

Referenced by gem5::ps2::TouchKit::mouseAt().

◆ serialize()

void gem5::ps2::Device::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Reimplemented in gem5::ps2::PS2Mouse, gem5::ps2::TouchKit, and gem5::ps2::PS2Keyboard.

Definition at line 65 of file device.cc.

References gem5::arrayParamOut, inBuffer, outBuffer, and SERIALIZE_CONTAINER.

Referenced by gem5::ps2::PS2Keyboard::serialize(), gem5::ps2::TouchKit::serialize(), and gem5::ps2::PS2Mouse::serialize().

◆ unserialize()

void gem5::ps2::Device::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Reimplemented in gem5::ps2::PS2Mouse, gem5::ps2::TouchKit, and gem5::ps2::PS2Keyboard.

Definition at line 75 of file device.cc.

References gem5::arrayParamIn(), gem5::ArmISA::c, inBuffer, outBuffer, and UNSERIALIZE_CONTAINER.

Referenced by gem5::ps2::PS2Keyboard::unserialize(), gem5::ps2::TouchKit::unserialize(), and gem5::ps2::PS2Mouse::unserialize().

Member Data Documentation

◆ dataAvailableCallback

std::function<void()> gem5::ps2::Device::dataAvailableCallback
private

Definition at line 151 of file device.hh.

Referenced by hostRegDataAvailable(), and send().

◆ inBuffer

std::vector<uint8_t> gem5::ps2::Device::inBuffer
private

Host -> device buffer.

Definition at line 149 of file device.hh.

Referenced by Device(), hostWrite(), serialize(), and unserialize().

◆ outBuffer

std::deque<uint8_t> gem5::ps2::Device::outBuffer
private

Device -> host FIFO.

Definition at line 146 of file device.hh.

Referenced by hostDataAvailable(), hostRead(), send(), sendPending(), serialize(), and unserialize().


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