gem5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
Pl050 Class Reference

#include <kmi.hh>

Inheritance diagram for Pl050:
AmbaIntDevice VncKeyboard VncMouse AmbaPioDevice BasicPioDevice AmbaDevice PioDevice MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable

Public Types

typedef Pl050Params Params
 
- Public Types inherited from AmbaIntDevice
typedef AmbaIntDeviceParams Params
 
- Public Types inherited from AmbaPioDevice
typedef AmbaPioDeviceParams Params
 
- Public Types inherited from BasicPioDevice
typedef BasicPioDeviceParams Params
 
- Public Types inherited from PioDevice
typedef PioDeviceParams Params
 
- Public Types inherited from MemObject
typedef MemObjectParams Params
 
- Public Types inherited from ClockedObject
typedef ClockedObjectParams Params
 Parameters of ClockedObject. More...
 
- Public Types inherited from SimObject
typedef SimObjectParams Params
 

Public Member Functions

const Paramsparams () const
 
 Pl050 (const Params *p)
 
Tick read (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. 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...
 
void keyPress (uint32_t key, bool down) override
 Called when the vnc server receives a key press event from the client. 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 AmbaIntDevice
 AmbaIntDevice (const Params *p, Addr pio_size)
 
- Public Member Functions inherited from AmbaPioDevice
 AmbaPioDevice (const Params *p, Addr pio_size)
 
- Public Member Functions inherited from BasicPioDevice
 BasicPioDevice (const Params *p, Addr size)
 
const Paramsparams () const
 
virtual AddrRangeList getAddrRanges () const
 Determine the address ranges that this device responds to. More...
 
- Public Member Functions inherited from PioDevice
 PioDevice (const Params *p)
 
virtual ~PioDevice ()
 
const Paramsparams () const
 
virtual void init ()
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
virtual BaseSlavePortgetSlavePort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a slave port with a given name and index. More...
 
- Public Member Functions inherited from MemObject
const Paramsparams () const
 
 MemObject (const Params *params)
 
virtual BaseMasterPortgetMasterPort (const std::string &if_name, PortID idx=InvalidPortID)
 Get a master port with a given name and index. More...
 
- Public Member Functions inherited from ClockedObject
 ClockedObject (const ClockedObjectParams *p)
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
Enums::PwrState pwrState () const
 
std::string pwrStateName () const
 
std::vector< double > pwrStateWeights () const
 Returns the percentage residency for each power state. More...
 
void computeStats ()
 Record stats values like state residency by computing the time difference from previous update. More...
 
void pwrState (Enums::PwrState)
 
void regStats () override
 Register statistics for this object. More...
 
- Public Member Functions inherited from SimObject
const Paramsparams () const
 
 SimObject (const Params *_params)
 
virtual ~SimObject ()
 
virtual const std::string name () const
 
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 resetStats ()
 Reset statistics associated with this object. 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 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 EventManager
 EventManager (EventManager &em)
 
 EventManager (EventManager *em)
 
 EventManager (EventQueue *eq)
 
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)
 
void setCurTick (Tick newVal)
 
- Public Member Functions inherited from 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 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 Clocked
void updateClockPeriod () const
 Update the tick to the current tick. More...
 
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. More...
 
Cycles curCycle () const
 Determine the current cycle, corresponding to a tick aligned to a clock edge. More...
 
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. More...
 
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 More...
 
 BitUnion8 (StatusReg) Bitfield< 0 > data_in
 KMI status register. More...
 
 EndBitUnion (StatusReg) StatusReg status
 
 BitUnion8 (InterruptReg) Bitfield< 0 > rx
 
 EndBitUnion (InterruptReg) InterruptReg rawInterrupts
 raw interrupt register (unmasked) More...
 
void updateIntStatus ()
 Update the status of the interrupt registers and schedule an interrupt if required. More...
 
void generateInterrupt ()
 Function to generate interrupt. More...
 
InterruptReg getInterrupt () const
 Get interrupt value. More...
 
void processCommand (uint8_t byte)
 Handle a command sent to the kmi and respond appropriately. More...
 
- Protected Member Functions inherited from 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 Member Functions inherited from Clocked
 Clocked (ClockDomain &clk_domain)
 Create a clocked object and set the clock domain based on the parameters. More...
 
 Clocked (Clocked &)=delete
 
Clockedoperator= (Clocked &)=delete
 
virtual ~Clocked ()
 Virtual destructor due to inheritance. More...
 
void resetClock () const
 Reset the object's clock using the current global tick value. More...
 
- Protected Member Functions inherited from 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. More...
 
Bitfield< 1 > tx
 
int ackNext
 If the controller should ignore the next data byte and acknowledge it. More...
 
bool shiftDown
 is the shift key currently down More...
 
VncInputvnc
 The vnc server we're connected to (if any) More...
 
bool driverInitialized
 If the linux driver has initialized the device yet and thus can we send mouse data. More...
 
EventWrapper< Pl050,&Pl050::generateInterruptintEvent
 Wrapper to create an event out of the thing. More...
 
std::list< uint8_t > rxQueue
 Receive queue. More...
 
- Protected Attributes inherited from AmbaIntDevice
int intNum
 
BaseGicgic
 
Tick intDelay
 
- Protected Attributes inherited from AmbaPioDevice
uint64_t ambaId
 
- Protected Attributes inherited from BasicPioDevice
Addr pioAddr
 Address that the device listens to. More...
 
Addr pioSize
 Size that the device's address range. More...
 
Tick pioDelay
 Delay that the device experinces on an access. More...
 
- Protected Attributes inherited from PioDevice
Systemsys
 
PioPort pioPort
 The pioPort that handles the requests for us and provides us requests that it sees. More...
 
- Protected Attributes inherited from ClockedObject
Enums::PwrState _currPwrState
 To keep track of the current power state. More...
 
Tick prvEvalTick
 
Stats::Scalar numPwrStateTransitions
 
Stats::Distribution pwrStateClkGateDist
 
Stats::Vector pwrStateResidencyTicks
 
- Protected Attributes inherited from SimObject
const SimObjectParams * _params
 Cached copy of the object parameters. More...
 
- Protected Attributes inherited from EventManager
EventQueueeventq
 A pointer to this object's event queue. More...
 

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 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

- Static Public Member Functions inherited from SimObject
static void serializeAll (CheckpointOut &cp)
 Serialize 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 Public Member Functions inherited from Serializable
static const std::string & currentSection ()
 Get the fully-qualified name of the active section. More...
 
static void serializeAll (const std::string &cpt_dir)
 
static void unserializeGlobals (CheckpointIn &cp)
 
- Static Public Attributes inherited from Serializable
static int ckptCount = 0
 
static int ckptMaxCount = 0
 
static int ckptPrevCount = -1
 

Detailed Description

Definition at line 57 of file kmi.hh.

Member Typedef Documentation

typedef Pl050Params Pl050::Params

Definition at line 149 of file kmi.hh.

Constructor & Destructor Documentation

Pl050::Pl050 ( const Params p)

Definition at line 54 of file kmi.cc.

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

Member Function Documentation

Pl050::BitUnion8 ( ControlReg  )
protected
Pl050::BitUnion8 ( StatusReg  )
protected

KMI status register.

Pl050::BitUnion8 ( InterruptReg  )
protected
Pl050::EndBitUnion ( ControlReg  )
protected

control register

Pl050::EndBitUnion ( StatusReg  )
protected
Pl050::EndBitUnion ( InterruptReg  )
protected

raw interrupt register (unmasked)

void Pl050::generateInterrupt ( )
protected

Function to generate interrupt.

Definition at line 256 of file kmi.cc.

References DPRINTF, getInterrupt(), AmbaIntDevice::gic, AmbaIntDevice::intNum, and BaseGic::sendInt().

InterruptReg Pl050::getInterrupt ( ) const
inlineprotected

Get interrupt value.

Definition at line 130 of file kmi.hh.

Referenced by generateInterrupt(), read(), and updateIntStatus().

void Pl050::keyPress ( uint32_t  key,
bool  down 
)
overridevirtual

Called when the vnc server receives a key press event from the client.

Parameters
keythe key passed is an x11 keysym
downis the key now down or up?

Implements VncKeyboard.

Definition at line 298 of file kmi.cc.

References Ps2::keys, Ps2::keySymToPs2(), rxQueue, shiftDown, and updateIntStatus().

void Pl050::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 VncMouse.

Definition at line 268 of file kmi.cc.

References driverInitialized, rxQueue, updateIntStatus(), VncInput::videoHeight(), VncInput::videoWidth(), and vnc.

const Params* Pl050::params ( ) const
inline

Definition at line 151 of file kmi.hh.

References SimObject::_params.

Referenced by processCommand().

void Pl050::processCommand ( uint8_t  byte)
protected
Tick Pl050::read ( PacketPtr  pkt)
overridevirtual

Pure virtual function that the device must implement.

Called when a read command is recieved by the port.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implements PioDevice.

Definition at line 68 of file kmi.cc.

References AmbaPioDevice::ambaId, clkdiv, data, DPRINTF, Packet::get(), Packet::getAddr(), getInterrupt(), Packet::getSize(), kmiClkDiv, kmiCr, kmiData, kmiISR, kmiStat, Packet::makeAtomicResponse(), panic, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, AmbaDevice::readId(), rxQueue, Packet::set(), ArmISA::status, updateIntStatus(), and warn.

void Pl050::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 313 of file kmi.cc.

References ackNext, clkdiv, driverInitialized, rxQueue, SERIALIZE_CONTAINER, SERIALIZE_SCALAR, shiftDown, and ArmISA::status.

void Pl050::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements Serializable.

Definition at line 333 of file kmi.cc.

References ackNext, clkdiv, driverInitialized, rxQueue, shiftDown, ArmISA::status, UNSERIALIZE_CONTAINER, and UNSERIALIZE_SCALAR.

void Pl050::updateIntStatus ( )
protected

Update the status of the interrupt registers and schedule an interrupt if required.

Definition at line 239 of file kmi.cc.

References BaseGic::clearInt(), curTick(), getInterrupt(), AmbaIntDevice::gic, if(), AmbaIntDevice::intDelay, intEvent, AmbaIntDevice::intNum, rxQueue, EventManager::schedule(), and Event::scheduled().

Referenced by keyPress(), mouseAt(), processCommand(), read(), and write().

Tick Pl050::write ( PacketPtr  pkt)
overridevirtual

Pure virtual function that the device must implement.

Called when a write command is recieved by the port.

Parameters
pktPacket describing this request
Returns
number of ticks it took to complete

Implements PioDevice.

Definition at line 138 of file kmi.cc.

References clkdiv, DPRINTF, Packet::get(), Packet::getAddr(), Packet::getSize(), kmiClkDiv, kmiCr, kmiData, Packet::makeAtomicResponse(), BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, processCommand(), updateIntStatus(), and warn.

Member Data Documentation

int Pl050::ackNext
protected

If the controller should ignore the next data byte and acknowledge it.

The driver is attempting to setup some feature we don't care about

Definition at line 110 of file kmi.hh.

Referenced by processCommand(), serialize(), and unserialize().

Bitfield<1> Pl050::clk_in
protected

Definition at line 82 of file kmi.hh.

uint8_t 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 97 of file kmi.hh.

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

bool Pl050::driverInitialized
protected

If the linux driver has initialized the device yet and thus can we send mouse data.

Definition at line 120 of file kmi.hh.

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

Bitfield<2> Pl050::enable
protected

Definition at line 69 of file kmi.hh.

Bitfield<1> Pl050::force_data_low
protected

Definition at line 68 of file kmi.hh.

EventWrapper<Pl050, &Pl050::generateInterrupt> Pl050::intEvent
protected

Wrapper to create an event out of the thing.

Definition at line 137 of file kmi.hh.

Referenced by updateIntStatus().

const int Pl050::kmiClkDiv = 0x00C
staticprotected

Definition at line 63 of file kmi.hh.

Referenced by read(), and write().

const int Pl050::kmiCr = 0x000
staticprotected

Definition at line 60 of file kmi.hh.

Referenced by read(), and write().

const int Pl050::kmiData = 0x008
staticprotected

Definition at line 62 of file kmi.hh.

Referenced by read(), and write().

const int Pl050::kmiISR = 0x010
staticprotected

Definition at line 64 of file kmi.hh.

Referenced by read().

const int Pl050::kmiStat = 0x004
staticprotected

Definition at line 61 of file kmi.hh.

Referenced by read().

Bitfield<3> Pl050::rxbusy
protected

Definition at line 84 of file kmi.hh.

Bitfield<4> Pl050::rxfull
protected

Definition at line 85 of file kmi.hh.

Bitfield<4> Pl050::rxint_enable
protected

Definition at line 71 of file kmi.hh.

Bitfield<2> Pl050::rxparity
protected

Definition at line 83 of file kmi.hh.

std::list<uint8_t> Pl050::rxQueue
protected

Receive queue.

This list contains all the pending commands that need to be sent to the driver

Definition at line 142 of file kmi.hh.

Referenced by keyPress(), mouseAt(), processCommand(), read(), serialize(), unserialize(), and updateIntStatus().

bool Pl050::shiftDown
protected

is the shift key currently down

Definition at line 113 of file kmi.hh.

Referenced by keyPress(), serialize(), and unserialize().

Bitfield<1> Pl050::tx
protected

Definition at line 101 of file kmi.hh.

Bitfield<5> Pl050::txbusy
protected

Definition at line 86 of file kmi.hh.

Bitfield<6> Pl050::txempty
protected

Definition at line 87 of file kmi.hh.

Bitfield<3> Pl050::txint_enable
protected

Definition at line 70 of file kmi.hh.

Bitfield<5> Pl050::type
protected

Definition at line 72 of file kmi.hh.

VncInput* Pl050::vnc
protected

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

Definition at line 116 of file kmi.hh.

Referenced by mouseAt(), and Pl050().


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

Generated on Fri Jun 9 2017 13:04:16 for gem5 by doxygen 1.8.6