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

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

#include <tsunami_io.hh>

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

Classes

class  RTC
 

Public Types

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

Tick frequency () const
 Return the freqency of the RTC. More...
 
 TsunamiIO (const Params *p)
 Initialize all the data for devices supported by Tsunami I/O. More...
 
const Paramsparams () const
 
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 postPIC (uint8_t bitvector)
 Post an PIC interrupt to the CPU via the CChip. More...
 
void clearPIC (uint8_t bitvector)
 Clear a posted interrupt. 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 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...
 
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 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...
 
Tsunamitsunami
 A pointer to the Tsunami device which be belong to. More...
 
Intel8254Timer pitimer
 Intel 8253 Periodic Interval Timer. More...
 
RTC rtc
 
uint8_t rtcAddr
 
uint16_t timerData
 The interval is set via two writes to the PIT. More...
 
- 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...
 

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

Detailed Description

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

Definition at line 52 of file tsunami_io.hh.

Member Typedef Documentation

typedef TsunamiIOParams TsunamiIO::Params

Definition at line 113 of file tsunami_io.hh.

Constructor & Destructor Documentation

TsunamiIO::TsunamiIO ( const Params p)

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

Parameters
ppointer to Params struct

Definition at line 72 of file tsunami_io.cc.

References Tsunami::io, picInterrupting, picr, timerData, and tsunami.

Member Function Documentation

void TsunamiIO::clearPIC ( uint8_t  bitvector)

Clear a posted interrupt.

Parameters
bitvectorinterrupt to clear

Definition at line 244 of file tsunami_io.cc.

References Tsunami::cchip, TsunamiCChip::clearDRIR(), DPRINTF, mask1, picr, and tsunami.

Referenced by Tsunami::clearConsoleInt().

Tick TsunamiIO::frequency ( ) const

Return the freqency of the RTC.

Returns
interrupt rate of the RTC

Definition at line 85 of file tsunami_io.cc.

References SimClock::Frequency, and params().

Referenced by Tsunami::init(), and AlphaBackdoor::startup().

const Params* TsunamiIO::params ( ) const
inline

Definition at line 121 of file tsunami_io.hh.

References SimObject::_params.

Referenced by frequency().

void TsunamiIO::postPIC ( uint8_t  bitvector)

Post an PIC interrupt to the CPU via the CChip.

Parameters
bitvectorinterrupt to post.

Definition at line 233 of file tsunami_io.cc.

References Tsunami::cchip, DPRINTF, mask1, picr, TsunamiCChip::postDRIR(), and tsunami.

Referenced by Tsunami::postConsoleInt().

Tick TsunamiIO::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 91 of file tsunami_io.cc.

References DPRINTF, Packet::getAddr(), Packet::getSize(), Packet::makeAtomicResponse(), mask1, mask2, Intel8254Timer::outputHigh(), panic, picr, BasicPioDevice::pioAddr, BasicPioDevice::pioDelay, BasicPioDevice::pioSize, pitimer, PORTB_SPKR_HIGH, Intel8254Timer::readCounter(), MC146818::readData(), rtc, rtcAddr, Packet::set(), TSDEV_CTRL_PORTB, TSDEV_PIC1_ISR, TSDEV_PIC1_MASK, TSDEV_PIC2_ISR, TSDEV_PIC2_MASK, TSDEV_RTC_DATA, TSDEV_TMR0_DATA, TSDEV_TMR1_DATA, and TSDEV_TMR2_DATA.

void TsunamiIO::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 255 of file tsunami_io.cc.

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

void TsunamiIO::startup ( )
overridevirtual

Start running.

Reimplemented from SimObject.

Definition at line 289 of file tsunami_io.cc.

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

void TsunamiIO::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 272 of file tsunami_io.cc.

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

Tick TsunamiIO::write ( PacketPtr  pkt)
overridevirtual

Member Data Documentation

uint8_t TsunamiIO::mask1
protected

Mask of the PIC1.

Definition at line 72 of file tsunami_io.hh.

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

uint8_t TsunamiIO::mask2
protected

Mask of the PIC2.

Definition at line 75 of file tsunami_io.hh.

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

uint8_t TsunamiIO::mode1
protected

Mode of PIC1.

Not used for anything

Definition at line 78 of file tsunami_io.hh.

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

uint8_t TsunamiIO::mode2
protected

Mode of PIC2.

Not used for anything

Definition at line 81 of file tsunami_io.hh.

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

bool TsunamiIO::picInterrupting
protected

Is the pic interrupting right now or not.

Definition at line 87 of file tsunami_io.hh.

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

uint8_t TsunamiIO::picr
protected

Raw PIC interrupt register before masking.

Definition at line 84 of file tsunami_io.hh.

Referenced by clearPIC(), postPIC(), read(), serialize(), TsunamiIO(), unserialize(), and write().

Intel8254Timer TsunamiIO::pitimer
protected

Intel 8253 Periodic Interval Timer.

Definition at line 93 of file tsunami_io.hh.

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

RTC TsunamiIO::rtc
protected

Definition at line 95 of file tsunami_io.hh.

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

uint8_t TsunamiIO::rtcAddr
protected

Definition at line 97 of file tsunami_io.hh.

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

uint16_t TsunamiIO::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 103 of file tsunami_io.hh.

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

Tsunami* TsunamiIO::tsunami
protected

A pointer to the Tsunami device which be belong to.

Definition at line 90 of file tsunami_io.hh.

Referenced by clearPIC(), postPIC(), TsunamiIO(), and write().


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

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