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

A very simple implementation of the Tsunami PCI interface chips. More...

#include <tsunami_pchip.hh>

Inheritance diagram for TsunamiPChip:
GenericPciHost PciHost PioDevice MemObject ClockedObject SimObject Clocked EventManager Serializable Drainable

Public Types

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

 TsunamiPChip (const Params *p)
 Register the PChip with the mmu and init all wsba, wsm, and tba to 0. More...
 
const Paramsparams () const
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. 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...
 
AddrRangeList getAddrRanges () const override
 Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. More...
 
Addr dmaAddr (const PciBusAddr &addr, Addr pci_addr) const override
 Translate a PCI bus address to a memory address for DMA. More...
 
- Public Member Functions inherited from GenericPciHost
 GenericPciHost (const GenericPciHostParams *p)
 
virtual ~GenericPciHost ()
 
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...
 
AddrRangeList getAddrRanges () const override
 Every PIO device is obliged to provide an implementation that returns the address ranges the device responds to. More...
 
- Public Member Functions inherited from PciHost
 PciHost (const PciHostParams *p)
 
virtual ~PciHost ()
 
virtual DeviceInterface registerDevice (PciDevice *device, PciBusAddr bus_addr, PciIntPin pin)
 Register a PCI device with the host. 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 Attributes

uint64_t pctl
 Pchip control register. More...
 
uint64_t wsba [4]
 Window Base addresses. More...
 
uint64_t wsm [4]
 Window masks. More...
 
uint64_t tba [4]
 Translated Base Addresses. More...
 
const AddrRange pioRange
 
const Tick pioDelay
 
- Protected Attributes inherited from GenericPciHost
Platformplatform
 
const Addr confBase
 
const Addr confSize
 
const uint8_t confDeviceBits
 
const Addr pciPioBase
 
const Addr pciMemBase
 
const Addr pciDmaBase
 
- 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 GenericPciHost
Addr pioAddr (const PciBusAddr &bus_addr, Addr pci_addr) const override
 Calculate the physical address of an IO location on the PCI bus. More...
 
Addr memAddr (const PciBusAddr &bus_addr, Addr pci_addr) const override
 Calculate the physical address of a non-prefetchable memory location in the PCI address space. More...
 
Addr dmaAddr (const PciBusAddr &bus_addr, Addr pci_addr) const override
 Calculate the physical address of a prefetchable memory location in the PCI address space. More...
 
virtual std::pair< PciBusAddr,
Addr
decodeAddress (Addr address)
 Decode a configuration space address. More...
 
void postInt (const PciBusAddr &addr, PciIntPin pin) override
 Post an interrupt to the CPU. More...
 
void clearInt (const PciBusAddr &addr, PciIntPin pin) override
 Post an interrupt to the CPU. More...
 
virtual uint32_t mapPciInterrupt (const PciBusAddr &bus_addr, PciIntPin pin) const
 
- Protected Member Functions inherited from PciHost
PciDevicegetDevice (const PciBusAddr &addr)
 Retrieve a PCI device from its bus address. More...
 
const PciDevicegetDevice (const PciBusAddr &addr) const
 Retrieve a PCI device from its bus address. 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...
 

Detailed Description

A very simple implementation of the Tsunami PCI interface chips.

Definition at line 45 of file tsunami_pchip.hh.

Member Typedef Documentation

typedef TsunamiPChipParams TsunamiPChip::Params

Definition at line 62 of file tsunami_pchip.hh.

Constructor & Destructor Documentation

TsunamiPChip::TsunamiPChip ( const Params p)

Register the PChip with the mmu and init all wsba, wsm, and tba to 0.

Parameters
ppointer to the parameters struct

Definition at line 56 of file tsunami_pchip.cc.

References ArmISA::i, pctl, tba, ULL, wsba, and wsm.

Member Function Documentation

Addr TsunamiPChip::dmaAddr ( const PciBusAddr addr,
Addr  pci_addr 
) const
overridevirtual

Translate a PCI bus address to a memory address for DMA.

Todo:
Andrew says this needs to be fixed. What's wrong with it?
Parameters
pci_addrPCI address to translate.
Returns
memory system address
Todo:
This currently is faked by just doing a direct read from memory, however, to be realistic, this needs to actually do a bus transaction. The process is explained in the tsunami documentation on page 10-12 and basically munges the address to look up a PTE from a table in memory and then uses that mapping to create an address for the SG page

Implements PciHost.

Definition at line 253 of file tsunami_pchip.cc.

References DMA_ADDR_MASK, DPRINTF, ArmISA::i, System::physProxy, PortProxy::readBlob(), PioDevice::sys, tba, ULL, wsba, and wsm.

AddrRangeList TsunamiPChip::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 PioDevice.

Definition at line 241 of file tsunami_pchip.cc.

References GenericPciHost::confBase, GenericPciHost::confSize, pioRange, and RangeSize().

const Params* TsunamiPChip::params ( ) const
inline

Definition at line 70 of file tsunami_pchip.hh.

References SimObject::_params.

Tick TsunamiPChip::read ( PacketPtr  pkt)
overridevirtual
void TsunamiPChip::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 328 of file tsunami_pchip.cc.

References pctl, SERIALIZE_ARRAY, SERIALIZE_SCALAR, tba, wsba, and wsm.

void TsunamiPChip::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 337 of file tsunami_pchip.cc.

References pctl, tba, UNSERIALIZE_ARRAY, UNSERIALIZE_SCALAR, wsba, and wsm.

Tick TsunamiPChip::write ( PacketPtr  pkt)
overridevirtual

Member Data Documentation

uint64_t TsunamiPChip::pctl
protected

Pchip control register.

Definition at line 50 of file tsunami_pchip.hh.

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

const Tick TsunamiPChip::pioDelay
protected

Definition at line 95 of file tsunami_pchip.hh.

Referenced by read(), and write().

const AddrRange TsunamiPChip::pioRange
protected

Definition at line 94 of file tsunami_pchip.hh.

Referenced by getAddrRanges(), read(), and write().

uint64_t TsunamiPChip::tba[4]
protected

Translated Base Addresses.

Definition at line 59 of file tsunami_pchip.hh.

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

uint64_t TsunamiPChip::wsba[4]
protected

Window Base addresses.

Definition at line 53 of file tsunami_pchip.hh.

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

uint64_t TsunamiPChip::wsm[4]
protected

Window masks.

Definition at line 56 of file tsunami_pchip.hh.

Referenced by dmaAddr(), read(), serialize(), TsunamiPChip(), unserialize(), 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