gem5  v21.1.0.2
Classes | Public Member Functions | Protected Attributes | List of all members
gem5::MaltaIO Class Reference

Malta I/O device is a catch all for all the south bridge stuff we care to implement. More...

#include <malta_io.hh>

Inheritance diagram for gem5::MaltaIO:
gem5::BasicPioDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  RTC
 

Public Member Functions

Tick frequency () const
 Return the freqency of the RTC. More...
 
 PARAMS (MaltaIO)
 
 MaltaIO (const Params &p)
 Initialize all the data for devices supported by Malta I/O. 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 postIntr (uint8_t interrupt)
 Post an Interrupt to the CPU. More...
 
void clearIntr (uint8_t interrupt)
 Clear an Interrupt to the CPU. More...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void startup () override
 Start running. More...
 
- Public Member Functions inherited from gem5::BasicPioDevice
 PARAMS (BasicPioDevice)
 
 BasicPioDevice (const Params &p, Addr size)
 
AddrRangeList getAddrRanges () const override
 Determine the address ranges that this device responds to. 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...
 
PortgetPort (const std::string &if_name, PortID idx=InvalidPortID) override
 Get a port with a given name and index. 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 Paramsparams () 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...
 
ProbeManagergetProbeManager ()
 Get the probe manager for this object. 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
 
- 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 Attributes

uint8_t mask1
 Mask of the PIC1. More...
 
uint8_t mask2
 Mask of the PIC2. More...
 
uint8_t mode1
 Mode of PIC1. More...
 
uint8_t mode2
 Mode of PIC2. More...
 
uint8_t picr
 Raw PIC interrupt register before masking. More...
 
bool picInterrupting
 Is the pic interrupting right now or not. More...
 
Maltamalta
 A pointer to the Malta device which be belong to. More...
 
Intel8254Timer pitimer
 Intel 8253 Periodic Interval Timer. More...
 
RTC rtc
 
uint16_t timerData
 The interval is set via two writes to the PIT. More...
 
- Protected Attributes inherited from gem5::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 gem5::PioDevice
Systemsys
 
PioPort< PioDevicepioPort
 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
EventQueueeventq
 A pointer to this object's event queue. More...
 

Additional Inherited Members

- 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
 
- 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...
 
- Public Attributes inherited from gem5::ClockedObject
PowerStatepowerState
 
- 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
 
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...
 
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...
 

Detailed Description

Malta I/O device is a catch all for all the south bridge stuff we care to implement.

Definition at line 51 of file malta_io.hh.

Constructor & Destructor Documentation

◆ MaltaIO()

gem5::MaltaIO::MaltaIO ( const Params p)

Initialize all the data for devices supported by Malta I/O.

Parameters
ppointer to Params struct

Definition at line 63 of file malta_io.cc.

References gem5::Malta::io, malta, picInterrupting, picr, and timerData.

Member Function Documentation

◆ clearIntr()

void gem5::MaltaIO::clearIntr ( uint8_t  interrupt)

Clear an Interrupt to the CPU.

Definition at line 103 of file malta_io.cc.

References gem5::Malta::cchip, gem5::MaltaCChip::clearIntr(), DPRINTF, and malta.

Referenced by gem5::Malta::clearConsoleInt().

◆ frequency()

Tick gem5::MaltaIO::frequency ( ) const

Return the freqency of the RTC.

Returns
interrupt rate of the RTC

Definition at line 76 of file malta_io.cc.

References gem5::sim_clock::Frequency, and gem5::SimObject::params().

◆ PARAMS()

gem5::MaltaIO::PARAMS ( MaltaIO  )

◆ postIntr()

void gem5::MaltaIO::postIntr ( uint8_t  interrupt)

Post an Interrupt to the CPU.

Definition at line 96 of file malta_io.cc.

References gem5::Malta::cchip, DPRINTF, malta, and gem5::MaltaCChip::postIntr().

Referenced by gem5::Malta::postConsoleInt().

◆ read()

Tick gem5::MaltaIO::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 gem5::PioDevice.

Definition at line 82 of file malta_io.cc.

References panic, and gem5::BasicPioDevice::pioDelay.

◆ serialize()

void gem5::MaltaIO::serialize ( CheckpointOut cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 110 of file malta_io.cc.

References mask1, mask2, mode1, mode2, picInterrupting, picr, pitimer, rtc, gem5::MC146818::serialize(), gem5::Intel8254Timer::serialize(), SERIALIZE_SCALAR, and timerData.

◆ startup()

void gem5::MaltaIO::startup ( )
overridevirtual

Start running.

Reimplemented from gem5::SimObject.

Definition at line 142 of file malta_io.cc.

References pitimer, rtc, gem5::MC146818::startup(), and gem5::Intel8254Timer::startup().

◆ unserialize()

void gem5::MaltaIO::unserialize ( CheckpointIn cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Definition at line 126 of file malta_io.cc.

References mask1, mask2, mode1, mode2, picInterrupting, picr, pitimer, rtc, timerData, gem5::MC146818::unserialize(), gem5::Intel8254Timer::unserialize(), and UNSERIALIZE_SCALAR.

◆ write()

Tick gem5::MaltaIO::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 gem5::PioDevice.

Definition at line 89 of file malta_io.cc.

References panic, and gem5::BasicPioDevice::pioDelay.

Member Data Documentation

◆ malta

Malta* gem5::MaltaIO::malta
protected

A pointer to the Malta device which be belong to.

Definition at line 88 of file malta_io.hh.

Referenced by clearIntr(), MaltaIO(), and postIntr().

◆ mask1

uint8_t gem5::MaltaIO::mask1
protected

Mask of the PIC1.

Definition at line 70 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ mask2

uint8_t gem5::MaltaIO::mask2
protected

Mask of the PIC2.

Definition at line 73 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ mode1

uint8_t gem5::MaltaIO::mode1
protected

Mode of PIC1.

Not used for anything

Definition at line 76 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ mode2

uint8_t gem5::MaltaIO::mode2
protected

Mode of PIC2.

Not used for anything

Definition at line 79 of file malta_io.hh.

Referenced by serialize(), and unserialize().

◆ picInterrupting

bool gem5::MaltaIO::picInterrupting
protected

Is the pic interrupting right now or not.

Definition at line 85 of file malta_io.hh.

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

◆ picr

uint8_t gem5::MaltaIO::picr
protected

Raw PIC interrupt register before masking.

Definition at line 82 of file malta_io.hh.

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

◆ pitimer

Intel8254Timer gem5::MaltaIO::pitimer
protected

Intel 8253 Periodic Interval Timer.

Definition at line 91 of file malta_io.hh.

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

◆ rtc

RTC gem5::MaltaIO::rtc
protected

Definition at line 93 of file malta_io.hh.

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

◆ timerData

uint16_t gem5::MaltaIO::timerData
protected

The interval is set via two writes to the PIT.

This variable contains a flag as to how many writes have happened, and the time so far.

Definition at line 99 of file malta_io.hh.

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


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

Generated on Tue Sep 21 2021 12:27:45 for gem5 by doxygen 1.8.17