#include <i8042.hh>

Inheritance diagram for gem5::X86ISA::I8042:

Public Types
using	Params = I8042Params

Public Types inherited from gem5::PioDevice
using	Params = PioDeviceParams

Public Types inherited from gem5::ClockedObject
using	Params = ClockedObjectParams
	Parameters of ClockedObject. More...

Public Types inherited from gem5::SimObject
typedef SimObjectParams	Params

Public Member Functions
	I8042 (const Params &p)

Port &	getPort (const std::string &if_name, PortID idx=InvalidPortID) override
	Get a port with a given name and index. More...

AddrRangeList	getAddrRanges () const override
	Every PIO device is obliged to provide an implementation that returns the address ranges the 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 gem5::PioDevice
	PioDevice (const Params &p)

virtual	~PioDevice ()

void	init () override
	init() is called after all C++ SimObjects have been created and all ports are connected. More...

Public Member Functions inherited from gem5::ClockedObject
	ClockedObject (const ClockedObjectParams &p)

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::SimObject
const Params &	params () const

	SimObject (const Params &p)

virtual	~SimObject ()

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

ProbeManager *	getProbeManager ()
	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 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. 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 Info *	resolveStat (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

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

Public Member Functions inherited from gem5::Clocked
void	updateClockPeriod ()
	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=0

void	writeData (uint8_t newData, bool mouse=false)

uint8_t	readDataOut ()

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 Member Functions inherited from gem5::Clocked
	Clocked (ClockDomain &clk_domain)
	Create a clocked object and set the clock domain based on the parameters. More...

	Clocked (Clocked &)=delete

Clocked &	operator= (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...

virtual void	clockPeriodUpdated ()
	A hook subclasses can implement so they can do any extra work that's needed when the clock rate is changed. 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 = 0

Addr	commandPort = 0

StatusReg	statusReg = 0

CommandByte	commandByte = 0

uint8_t	dataReg = 0

uint16_t	lastCommand = NoCommand

std::vector< IntSourcePin< I8042 > * >	mouseIntPin

std::vector< IntSourcePin< I8042 > * >	keyboardIntPin

ps2::Device *	mouse = nullptr

ps2::Device *	keyboard = nullptr

Protected Attributes inherited from gem5::PioDevice
System *	sys

PioPort< PioDevice >	pioPort
	The pioPort that handles the requests for us and provides us requests that it sees. More...

Protected Attributes inherited from gem5::SimObject
const SimObjectParams &	_params
	Cached copy of the object parameters. More...

Protected Attributes inherited from gem5::EventManager
EventQueue *	eventq
	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 gem5::SimObject
static void	serializeAll (const std::string &cpt_dir)
	Create a checkpoint by serializing all SimObjects in the system. More...

static SimObject *	find (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 SimObjectResolver *	getSimObjectResolver ()
	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...

Public Attributes inherited from gem5::ClockedObject
PowerState *	powerState

Detailed Description

Definition at line 46 of file i8042.hh.

Member Typedef Documentation

◆ Params

using gem5::X86ISA::I8042::Params = I8042Params

Definition at line 123 of file i8042.hh.

Member Enumeration Documentation

◆ Command

enum gem5::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 49 of file i8042.hh.

Constructor & Destructor Documentation

◆ I8042()

gem5::X86ISA::I8042::I8042 ( const Params & p )

Definition at line 50 of file i8042.cc.

References commandByte, gem5::csprintf(), fatal_if, gem5::ArmISA::i, keyboard, keyboardIntPin, mouse, mouseIntPin, gem5::Named::name(), gem5::X86ISA::p, and statusReg.

Member Function Documentation

◆ BitUnion8()

gem5::X86ISA::I8042::BitUnion8 ( StatusReg )

protected

◆ EndBitUnion() [1/2]

gem5::X86ISA::I8042::EndBitUnion ( CommandByte )

protectedpure virtual

◆ EndBitUnion() [2/2]

gem5::X86ISA::I8042::EndBitUnion ( StatusReg )

protected

◆ getAddrRanges()

AddrRangeList gem5::X86ISA::I8042::getAddrRanges ( ) const

overridevirtual

Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to.

Returns: a list of non-overlapping address ranges

Implements gem5::PioDevice.

Definition at line 76 of file i8042.cc.

References gem5::RangeSize().

◆ getPort()

Port& gem5::X86ISA::I8042::getPort	(	const std::string &	if_name,
		PortID	idx = `InvalidPortID`
	)

inlineoverridevirtual

Get a port with a given name and index.

This is used at binding time and returns a reference to a protocol-agnostic port.

gem5 has a request and response port interface. All memory objects are connected together via ports. These ports provide a rigid interface between these memory objects. These ports implement three different memory system modes: timing, atomic, and functional. The most important mode is the timing mode and here timing mode is used for conducting cycle-level timing experiments. The other modes are only used in special circumstances and should not be used to conduct cycle-level timing experiments. The other modes are only used in special circumstances. These ports allow SimObjects to communicate with each other.

Parameters

if_name	Port name
idx	Index in the case of a VectorPort

Returns: A reference to the given port

Reimplemented from gem5::PioDevice.

Definition at line 128 of file i8042.hh.

References gem5::PioDevice::getPort(), keyboardIntPin, and mouseIntPin.

◆ read()

Tick gem5::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

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 123 of file i8042.cc.

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

◆ readDataOut()

uint8_t gem5::X86ISA::I8042::readDataOut ( )

protected

Definition at line 109 of file i8042.cc.

References data.

◆ serialize()

void gem5::X86ISA::I8042::serialize ( CheckpointOut & cp ) const

overridevirtual

Serialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 301 of file i8042.cc.

References SERIALIZE_SCALAR.

◆ unserialize()

void gem5::X86ISA::I8042::unserialize ( CheckpointIn & cp )

overridevirtual

Unserialize an object.

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

Parameters

cp	Checkpoint state

Implements gem5::Serializable.

Definition at line 312 of file i8042.cc.

References UNSERIALIZE_SCALAR.

◆ write()

Tick gem5::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

pkt	Packet describing this request

Returns: number of ticks it took to complete

Implements gem5::PioDevice.

Definition at line 142 of file i8042.cc.

References gem5::X86ISA::addr, gem5::bits(), data, DPRINTF, gem5::Packet::getAddr(), gem5::Packet::getLE(), gem5::Packet::getSize(), gem5::Packet::makeAtomicResponse(), gem5::NumOutputBits, panic, panic_if, gem5::RamSize, and warn.

◆ writeData()

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

protected

Definition at line 85 of file i8042.cc.

References DPRINTF.

Member Data Documentation

◆ commandByte

CommandByte gem5::X86ISA::I8042::commandByte = 0

protected

Definition at line 106 of file i8042.hh.

Referenced by I8042().

◆ commandLast

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

protected

Definition at line 86 of file i8042.hh.

◆ commandPort

Addr gem5::X86ISA::I8042::commandPort = 0

protected

Definition at line 103 of file i8042.hh.

◆ dataPort

Addr gem5::X86ISA::I8042::dataPort = 0

protected

Definition at line 102 of file i8042.hh.

◆ dataReg

uint8_t gem5::X86ISA::I8042::dataReg = 0

protected

Definition at line 108 of file i8042.hh.

◆ disableKeyboard

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

protected

Definition at line 95 of file i8042.hh.

◆ disableMouse

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

protected

Definition at line 94 of file i8042.hh.

◆ inputFull

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

protected

Definition at line 88 of file i8042.hh.

◆ keyboard

ps2::Device* gem5::X86ISA::I8042::keyboard = nullptr

protected

Definition at line 117 of file i8042.hh.

Referenced by I8042().

◆ keyboardFullInt

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

protected

Definition at line 98 of file i8042.hh.

◆ keyboardIntPin

std::vector<IntSourcePin<I8042> *> gem5::X86ISA::I8042::keyboardIntPin

protected

Definition at line 114 of file i8042.hh.

Referenced by getPort(), and I8042().

◆ keyboardUnlocked

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

protected

Definition at line 85 of file i8042.hh.

◆ lastCommand

uint16_t gem5::X86ISA::I8042::lastCommand = NoCommand

protected

Definition at line 111 of file i8042.hh.

◆ mouse

ps2::Device* gem5::X86ISA::I8042::mouse = nullptr

protected

Definition at line 116 of file i8042.hh.

Referenced by I8042().

◆ mouseFullInt

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

protected

Definition at line 97 of file i8042.hh.

◆ mouseIntPin

std::vector<IntSourcePin<I8042> *> gem5::X86ISA::I8042::mouseIntPin

protected

Definition at line 113 of file i8042.hh.

Referenced by getPort(), and I8042().

◆ mouseOutputFull

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

protected

Definition at line 84 of file i8042.hh.

◆ NoCommand

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

inlinestaticprotected

Definition at line 110 of file i8042.hh.

◆ outputFull

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

protected

Definition at line 89 of file i8042.hh.

◆ passedSelfTest

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

protected

Definition at line 87 of file i8042.hh.

◆ statusReg

StatusReg gem5::X86ISA::I8042::statusReg = 0

protected

Definition at line 105 of file i8042.hh.

Referenced by I8042().

◆ timeout

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

protected

Definition at line 83 of file i8042.hh.

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

dev/x86/i8042.hh
dev/x86/i8042.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Params

Member Enumeration Documentation

◆ Command

Constructor & Destructor Documentation

◆ I8042()

Member Function Documentation

◆ BitUnion8()

◆ EndBitUnion() [1/2]

◆ EndBitUnion() [2/2]

◆ getAddrRanges()

◆ getPort()

◆ read()

◆ readDataOut()

◆ serialize()

◆ unserialize()

◆ write()

◆ writeData()

Member Data Documentation

◆ commandByte

◆ commandLast

◆ commandPort

◆ dataPort

◆ dataReg

◆ disableKeyboard

◆ disableMouse

◆ inputFull

◆ keyboard

◆ keyboardFullInt

◆ keyboardIntPin

◆ keyboardUnlocked

◆ lastCommand

◆ mouse

◆ mouseFullInt

◆ mouseIntPin

◆ mouseOutputFull

◆ NoCommand

◆ outputFull

◆ passedSelfTest

◆ statusReg

◆ timeout