gem5  v22.0.0.2
Classes | Public Member Functions | Private Attributes | List of all members
gem5::AMDGPUInterruptHandler Class Reference

#include <interrupt_handler.hh>

Inheritance diagram for gem5::AMDGPUInterruptHandler:
gem5::DmaDevice gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named

Classes

class  DmaEvent
 
struct  SenderState
 

Public Member Functions

 AMDGPUInterruptHandler (const AMDGPUInterruptHandlerParams &p)
 
Tick write (PacketPtr pkt) override
 Pure virtual function that the device must implement. More...
 
Tick read (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...
 
void serialize (CheckpointOut &cp) const override
 Serialize an object. More...
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object. More...
 
void setGPUDevice (AMDGPUDevice *gpu_device)
 
void prepareInterruptCookie (ContextID cntxtId, uint32_t ring_id, uint32_t client_id, uint32_t source_id)
 
void submitInterruptCookie ()
 
void submitWritePointer ()
 
void intrPost ()
 
void writeMMIO (PacketPtr pkt, Addr mmio_offset)
 Methods for setting the values of interrupt handler MMIO registers. More...
 
uint32_t getDoorbellOffset () const
 
void setCntl (const uint32_t &data)
 
void setBase (const uint32_t &data)
 
void setBaseHi (const uint32_t &data)
 
void setRptr (const uint32_t &data)
 
void setWptr (const uint32_t &data)
 
void setWptrAddrLo (const uint32_t &data)
 
void setWptrAddrHi (const uint32_t &data)
 
void setDoorbellOffset (const uint32_t &data)
 
void updateRptr (const uint32_t &data)
 
- Public Member Functions inherited from gem5::DmaDevice
 DmaDevice (const Params &p)
 
virtual ~DmaDevice ()=default
 
void dmaWrite (Addr addr, int size, Event *event, uint8_t *data, uint32_t sid, uint32_t ssid, Tick delay=0)
 
void dmaWrite (Addr addr, int size, Event *event, uint8_t *data, Tick delay=0)
 
void dmaRead (Addr addr, int size, Event *event, uint8_t *data, uint32_t sid, uint32_t ssid, Tick delay=0)
 
void dmaRead (Addr addr, int size, Event *event, uint8_t *data, Tick delay=0)
 
bool dmaPending () const
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
unsigned int cacheBlockSize () const
 
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::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...
 
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
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
 

Private Attributes

AMDGPUDevicegpuDevice
 
AMDGPUIHRegs regs
 
std::queue< AMDGPUInterruptCookie * > interruptQueue
 
AMDGPUInterruptHandler::DmaEventdmaEvent
 

Additional Inherited Members

- Public Types inherited from gem5::DmaDevice
typedef DmaDeviceParams Params
 
- 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...
 
- Protected Attributes inherited from gem5::DmaDevice
DmaPort dmaPort
 
- 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...
 

Detailed Description

Definition at line 122 of file interrupt_handler.hh.

Constructor & Destructor Documentation

◆ AMDGPUInterruptHandler()

gem5::AMDGPUInterruptHandler::AMDGPUInterruptHandler ( const AMDGPUInterruptHandlerParams &  p)

Definition at line 53 of file interrupt_handler.cc.

References regs.

Member Function Documentation

◆ getAddrRanges()

AddrRangeList gem5::AMDGPUInterruptHandler::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 61 of file interrupt_handler.cc.

◆ getDoorbellOffset()

uint32_t gem5::AMDGPUInterruptHandler::getDoorbellOffset ( ) const
inline

Definition at line 176 of file interrupt_handler.hh.

References gem5::AMDGPUIHRegs::IH_Doorbell, and regs.

Referenced by writeMMIO().

◆ intrPost()

void gem5::AMDGPUInterruptHandler::intrPost ( )

◆ prepareInterruptCookie()

void gem5::AMDGPUInterruptHandler::prepareInterruptCookie ( ContextID  cntxtId,
uint32_t  ring_id,
uint32_t  client_id,
uint32_t  source_id 
)

Setup the fields in the interrupt cookie (see header file for more detail on the fields). The timestamp here is a bogus value. It seems the driver does not really care what this value is. Additionally the model does not currently have anything to keep track of time. It is possible that tick/cycle count can be used in the future if this ends up being important. The remaining fields are passed from whichever block is sending the interrupt.

Definition at line 75 of file interrupt_handler.cc.

References gem5::AMDGPUInterruptCookie::clientId, interruptQueue, gem5::AMDGPUInterruptCookie::ringId, gem5::AMDGPUInterruptCookie::source_data_dw1, gem5::AMDGPUInterruptCookie::sourceId, and gem5::AMDGPUInterruptCookie::timestamp_Lo.

Referenced by gem5::PM4PacketProcessor::releaseMemDone(), and gem5::SDMAEngine::trap().

◆ read()

Tick gem5::AMDGPUInterruptHandler::read ( PacketPtr  pkt)
inlineoverridevirtual

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 159 of file interrupt_handler.hh.

◆ serialize()

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

◆ setBase()

void gem5::AMDGPUInterruptHandler::setBase ( const uint32_t &  data)

Definition at line 189 of file interrupt_handler.cc.

References gem5::AMDGPUIHRegs::baseAddr, data, gem5::AMDGPUIHRegs::IH_Base, and regs.

Referenced by writeMMIO().

◆ setBaseHi()

void gem5::AMDGPUInterruptHandler::setBaseHi ( const uint32_t &  data)

Definition at line 196 of file interrupt_handler.cc.

References gem5::AMDGPUIHRegs::baseAddr, data, gem5::AMDGPUIHRegs::IH_Base_Hi, and regs.

Referenced by writeMMIO().

◆ setCntl()

void gem5::AMDGPUInterruptHandler::setCntl ( const uint32_t &  data)

Definition at line 183 of file interrupt_handler.cc.

References data, gem5::AMDGPUIHRegs::IH_Cntl, and regs.

Referenced by writeMMIO().

◆ setDoorbellOffset()

void gem5::AMDGPUInterruptHandler::setDoorbellOffset ( const uint32_t &  data)

Definition at line 229 of file interrupt_handler.cc.

References data, gem5::AMDGPUIHRegs::IH_Doorbell, and regs.

Referenced by writeMMIO().

◆ setGPUDevice()

void gem5::AMDGPUInterruptHandler::setGPUDevice ( AMDGPUDevice gpu_device)
inline

Definition at line 164 of file interrupt_handler.hh.

References gpuDevice.

Referenced by gem5::AMDGPUDevice::AMDGPUDevice().

◆ setRptr()

void gem5::AMDGPUInterruptHandler::setRptr ( const uint32_t &  data)

Definition at line 203 of file interrupt_handler.cc.

References data, gem5::AMDGPUIHRegs::IH_Rptr, and regs.

Referenced by writeMMIO().

◆ setWptr()

void gem5::AMDGPUInterruptHandler::setWptr ( const uint32_t &  data)

Definition at line 209 of file interrupt_handler.cc.

References data, gem5::AMDGPUIHRegs::IH_Wptr, and regs.

Referenced by writeMMIO().

◆ setWptrAddrHi()

void gem5::AMDGPUInterruptHandler::setWptrAddrHi ( const uint32_t &  data)

Definition at line 222 of file interrupt_handler.cc.

References data, gem5::AMDGPUIHRegs::IH_Wptr_Addr_Hi, regs, and gem5::AMDGPUIHRegs::WptrAddr.

Referenced by writeMMIO().

◆ setWptrAddrLo()

void gem5::AMDGPUInterruptHandler::setWptrAddrLo ( const uint32_t &  data)

Definition at line 215 of file interrupt_handler.cc.

References data, gem5::AMDGPUIHRegs::IH_Wptr_Addr_Lo, regs, and gem5::AMDGPUIHRegs::WptrAddr.

Referenced by writeMMIO().

◆ submitInterruptCookie()

void gem5::AMDGPUInterruptHandler::submitInterruptCookie ( )

◆ submitWritePointer()

void gem5::AMDGPUInterruptHandler::submitWritePointer ( )

◆ unserialize()

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

◆ updateRptr()

void gem5::AMDGPUInterruptHandler::updateRptr ( const uint32_t &  data)

Definition at line 235 of file interrupt_handler.cc.

References data, gem5::AMDGPUIHRegs::IH_Rptr, and regs.

Referenced by gem5::AMDGPUDevice::writeDoorbell().

◆ write()

Tick gem5::AMDGPUInterruptHandler::write ( PacketPtr  pkt)
inlineoverridevirtual

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 158 of file interrupt_handler.hh.

◆ writeMMIO()

void gem5::AMDGPUInterruptHandler::writeMMIO ( PacketPtr  pkt,
Addr  mmio_offset 
)

Member Data Documentation

◆ dmaEvent

AMDGPUInterruptHandler::DmaEvent* gem5::AMDGPUInterruptHandler::dmaEvent
private

Definition at line 191 of file interrupt_handler.hh.

Referenced by submitInterruptCookie(), and submitWritePointer().

◆ gpuDevice

AMDGPUDevice* gem5::AMDGPUInterruptHandler::gpuDevice
private

Definition at line 188 of file interrupt_handler.hh.

Referenced by intrPost(), setGPUDevice(), and writeMMIO().

◆ interruptQueue

std::queue<AMDGPUInterruptCookie*> gem5::AMDGPUInterruptHandler::interruptQueue
private

Definition at line 190 of file interrupt_handler.hh.

Referenced by prepareInterruptCookie(), and submitInterruptCookie().

◆ regs

AMDGPUIHRegs gem5::AMDGPUInterruptHandler::regs
private

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

Generated on Thu Jul 28 2022 13:32:56 for gem5 by doxygen 1.8.17