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

#include <i8042.hh>

Inheritance diagram for X86ISA::I8042:
BasicPioDevice PioDevice MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable

Public Types

typedef I8042Params 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
 
 I8042 (Params *p)
 
AddrRangeList getAddrRanges () const override
 Determine the address ranges that this device responds to. More...
 
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 serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
- Public Member Functions inherited from BasicPioDevice
 BasicPioDevice (const Params *p, Addr size)
 
const Paramsparams () const
 
- 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 Types

enum  Command {
  GetCommandByte = 0x20, ReadControllerRamBase = 0x20, WriteCommandByte = 0x60, WriteControllerRamBase = 0x60,
  CheckForPassword = 0xA4, LoadPassword = 0xA5, CheckPassword = 0xA6, DisableMouse = 0xA7,
  EnableMouse = 0xA8, TestMouse = 0xA9, SelfTest = 0xAA, InterfaceTest = 0xAB,
  DiagnosticDump = 0xAC, DisableKeyboard = 0xAD, EnableKeyboard = 0xAE, ReadInputPort = 0xC0,
  ContinuousPollLow = 0xC1, ContinuousPollHigh = 0xC2, ReadOutputPort = 0xD0, WriteOutputPort = 0xD1,
  WriteKeyboardOutputBuff = 0xD2, WriteMouseOutputBuff = 0xD3, WriteToMouse = 0xD4, DisableA20 = 0xDD,
  EnableA20 = 0xDF, ReadTestInputs = 0xE0, PulseOutputBitBase = 0xF0, SystemReset = 0xFE
}
 

Protected Member Functions

 BitUnion8 (StatusReg) Bitfield< 7 > parityError
 
 EndBitUnion (StatusReg) BitUnion8(CommandByte) Bitfield< 6 > convertScanCodes
 
 EndBitUnion (CommandByte) Tick latency
 
void writeData (uint8_t newData, bool mouse=false)
 
uint8_t readDataOut ()
 
- 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 Attributes

Bitfield< 6 > timeout
 
Bitfield< 5 > mouseOutputFull
 
Bitfield< 4 > keyboardUnlocked
 
Bitfield< 3 > commandLast
 
Bitfield< 2 > passedSelfTest
 
Bitfield< 1 > inputFull
 
Bitfield< 0 > outputFull
 
Bitfield< 5 > disableMouse
 
Bitfield< 4 > disableKeyboard
 
Bitfield< 1 > mouseFullInt
 
Bitfield< 0 > keyboardFullInt
 
Addr dataPort
 
Addr commandPort
 
StatusReg statusReg
 
CommandByte commandByte
 
uint8_t dataReg
 
uint16_t lastCommand
 
IntSourcePinmouseIntPin
 
IntSourcePinkeyboardIntPin
 
PS2Mouse mouse
 
PS2Keyboard keyboard
 
- 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 uint16_t NoCommand = (uint16_t)(-1)
 

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 157 of file i8042.hh.

Member Typedef Documentation

typedef I8042Params X86ISA::I8042::Params

Definition at line 234 of file i8042.hh.

Member Enumeration Documentation

enum X86ISA::I8042::Command
protected
Enumerator
GetCommandByte 
ReadControllerRamBase 
WriteCommandByte 
WriteControllerRamBase 
CheckForPassword 
LoadPassword 
CheckPassword 
DisableMouse 
EnableMouse 
TestMouse 
SelfTest 
InterfaceTest 
DiagnosticDump 
DisableKeyboard 
EnableKeyboard 
ReadInputPort 
ContinuousPollLow 
ContinuousPollHigh 
ReadOutputPort 
WriteOutputPort 
WriteKeyboardOutputBuff 
WriteMouseOutputBuff 
WriteToMouse 
DisableA20 
EnableA20 
ReadTestInputs 
PulseOutputBitBase 
SystemReset 

Definition at line 160 of file i8042.hh.

Constructor & Destructor Documentation

X86ISA::I8042::I8042 ( Params p)

Definition at line 48 of file i8042.cc.

References commandByte, and statusReg.

Member Function Documentation

X86ISA::I8042::BitUnion8 ( StatusReg  )
protected
X86ISA::I8042::EndBitUnion ( StatusReg  )
protected
X86ISA::I8042::EndBitUnion ( CommandByte  )
protected
AddrRangeList X86ISA::I8042::getAddrRanges ( ) const
overridevirtual

Determine the address ranges that this device responds to.

Returns
a list of non-overlapping address ranges

Reimplemented from BasicPioDevice.

Definition at line 66 of file i8042.cc.

References RangeSize().

const Params* X86ISA::I8042::params ( ) const
inline

Definition at line 237 of file i8042.hh.

References SimObject::_params.

Tick X86ISA::I8042::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 337 of file i8042.cc.

References X86ISA::addr, data, Packet::getAddr(), Packet::getSize(), Packet::makeAtomicResponse(), panic, and Packet::set().

uint8_t X86ISA::I8042::readDataOut ( )
protected

Definition at line 141 of file i8042.cc.

References data.

void X86ISA::I8042::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 490 of file i8042.cc.

References SERIALIZE_SCALAR.

void X86ISA::I8042::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 506 of file i8042.cc.

References UNSERIALIZE_SCALAR.

Tick X86ISA::I8042::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 356 of file i8042.cc.

References X86ISA::addr, data, DPRINTF, Packet::get(), Packet::getAddr(), Packet::getSize(), Packet::makeAtomicResponse(), NumOutputBits, panic, RamSize, and warn.

void X86ISA::I8042::writeData ( uint8_t  newData,
bool  mouse = false 
)
protected

Definition at line 76 of file i8042.cc.

References DPRINTF.

Member Data Documentation

CommandByte X86ISA::I8042::commandByte
protected

Definition at line 217 of file i8042.hh.

Referenced by I8042().

Bitfield<3> X86ISA::I8042::commandLast
protected

Definition at line 197 of file i8042.hh.

Addr X86ISA::I8042::commandPort
protected

Definition at line 214 of file i8042.hh.

Addr X86ISA::I8042::dataPort
protected

Definition at line 213 of file i8042.hh.

uint8_t X86ISA::I8042::dataReg
protected

Definition at line 219 of file i8042.hh.

Bitfield<4> X86ISA::I8042::disableKeyboard
protected

Definition at line 206 of file i8042.hh.

Bitfield<5> X86ISA::I8042::disableMouse
protected

Definition at line 205 of file i8042.hh.

Bitfield<1> X86ISA::I8042::inputFull
protected

Definition at line 199 of file i8042.hh.

PS2Keyboard X86ISA::I8042::keyboard
protected

Definition at line 228 of file i8042.hh.

Bitfield<0> X86ISA::I8042::keyboardFullInt
protected

Definition at line 209 of file i8042.hh.

IntSourcePin* X86ISA::I8042::keyboardIntPin
protected

Definition at line 225 of file i8042.hh.

Bitfield<4> X86ISA::I8042::keyboardUnlocked
protected

Definition at line 196 of file i8042.hh.

uint16_t X86ISA::I8042::lastCommand
protected

Definition at line 222 of file i8042.hh.

PS2Mouse X86ISA::I8042::mouse
protected

Definition at line 227 of file i8042.hh.

Bitfield<1> X86ISA::I8042::mouseFullInt
protected

Definition at line 208 of file i8042.hh.

IntSourcePin* X86ISA::I8042::mouseIntPin
protected

Definition at line 224 of file i8042.hh.

Bitfield<5> X86ISA::I8042::mouseOutputFull
protected

Definition at line 195 of file i8042.hh.

const uint16_t X86ISA::I8042::NoCommand = (uint16_t)(-1)
staticprotected

Definition at line 221 of file i8042.hh.

Bitfield<0> X86ISA::I8042::outputFull
protected

Definition at line 200 of file i8042.hh.

Bitfield< 2 > X86ISA::I8042::passedSelfTest
protected

Definition at line 198 of file i8042.hh.

StatusReg X86ISA::I8042::statusReg
protected

Definition at line 216 of file i8042.hh.

Referenced by I8042().

Bitfield<6> X86ISA::I8042::timeout
protected

Definition at line 194 of file i8042.hh.


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

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