gem5  v21.1.0.2
Public Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | List of all members
gem5::NoMaliGpu Class Reference

#include <gpu_nomali.hh>

Inheritance diagram for gem5::NoMaliGpu:
gem5::PioDevice gem5::ClockedObject gem5::SimObject gem5::Clocked gem5::EventManager gem5::Serializable gem5::Drainable gem5::statistics::Group gem5::Named gem5::CustomNoMaliGpu

Public Member Functions

 NoMaliGpu (const NoMaliGpuParams &p)
 
virtual ~NoMaliGpu ()
 
void init () override
 init() is called after all C++ SimObjects have been created and all ports are connected. More...
 
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...
 
- 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
 

Protected Member Functions

API wrappers
void reset ()
 Wrapper around nomali_reset(). More...
 
uint32_t readReg (nomali_addr_t reg)
 Wrapper around nomali_reg_read(). More...
 
void writeReg (nomali_addr_t reg, uint32_t value)
 Wrapper around nomali_reg_write(). More...
 
uint32_t readRegRaw (nomali_addr_t reg) const
 Wrapper around nomali_reg_read_raw(). More...
 
void writeRegRaw (nomali_addr_t reg, uint32_t value)
 Wrapper around nomali_reg_write_raw(). More...
 
bool intState (nomali_int_t intno)
 Wrapper around nomali_int_state() More...
 
Callbacks
virtual void onInterrupt (nomali_int_t intno, bool set)
 Interrupt callback from the NoMali library. More...
 
virtual void onReset ()
 Reset callback from the NoMali library. More...
 
- 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...
 

Static Protected Member Functions

static void gpuPanic (nomali_error_t err, const char *msg)
 Format a NoMali error into an error message and panic. More...
 
static void panicOnErr (nomali_error_t err, const char *msg)
 Panic if the NoMali returned an error, do nothing otherwise. More...
 

Protected Attributes

const Addr pioAddr
 Device base address. More...
 
RealView *const platform
 Platform, used to discover GIC. More...
 
const std::map< nomali_int_t, uint32_t > interruptMap
 Map between NoMali interrupt types and actual GIC interrupts. More...
 
nomali_info_t nomaliInfo
 Cached information struct from the NoMali library. More...
 
nomali_handle_t nomali
 Handle of a NoMali library instance. 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...
 

Private Member Functions

void setCallback (const nomali_callback_t &callback)
 Wrapper around nomali_set_callback() More...
 

Static Private Member Functions

static void _interrupt (nomali_handle_t h, void *usr, nomali_int_t intno, int set)
 Interrupt callback from the NoMali library. More...
 
static void _reset (nomali_handle_t h, void *usr)
 Reset callback from the NoMali library. 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
 

Detailed Description

Definition at line 53 of file gpu_nomali.hh.

Constructor & Destructor Documentation

◆ NoMaliGpu()

gem5::NoMaliGpu::NoMaliGpu ( const NoMaliGpuParams &  p)

Definition at line 58 of file gpu_nomali.cc.

References gem5::MipsISA::p.

◆ ~NoMaliGpu()

gem5::NoMaliGpu::~NoMaliGpu ( )
virtual

Definition at line 110 of file gpu_nomali.cc.

References nomali.

Member Function Documentation

◆ _interrupt()

void gem5::NoMaliGpu::_interrupt ( nomali_handle_t  h,
void *  usr,
nomali_int_t  intno,
int  set 
)
staticprivate

Interrupt callback from the NoMali library.

This method calls onInterrupt() on the NoMaliGpu owning this device.

Parameters
hNoMali library handle.
usrPointer to an instance of the NoMaliGpu
intnoGPU interrupt type
setWas the interrupt raised (1) or lowered (0)?

Definition at line 310 of file gpu_nomali.cc.

References onInterrupt(), and gem5::X86ISA::usr.

◆ _reset()

void gem5::NoMaliGpu::_reset ( nomali_handle_t  h,
void *  usr 
)
staticprivate

Reset callback from the NoMali library.

This method calls onReset() on the NoMaliGpu owning this device.

Parameters
hNoMali library handle.
usrPointer to an instance of the NoMaliGpu

Definition at line 319 of file gpu_nomali.cc.

References onReset(), and gem5::X86ISA::usr.

◆ getAddrRanges()

AddrRangeList gem5::NoMaliGpu::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 192 of file gpu_nomali.cc.

References nomaliInfo, pioAddr, and gem5::RangeSize().

◆ gpuPanic()

void gem5::NoMaliGpu::gpuPanic ( nomali_error_t  err,
const char *  msg 
)
staticprotected

Format a NoMali error into an error message and panic.

Parameters
errError code from the NoMali library.
msgMessage to print.

Definition at line 267 of file gpu_nomali.cc.

References gem5::ArmISA::err, and panic.

Referenced by panicOnErr().

◆ init()

void gem5::NoMaliGpu::init ( )
overridevirtual

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

Initializations that are independent of unserialization but rely on a fully instantiated and connected SimObject graph should be done here.

Reimplemented from gem5::SimObject.

Definition at line 117 of file gpu_nomali.cc.

References gem5::PioDevice::init(), and reset().

◆ intState()

bool gem5::NoMaliGpu::intState ( nomali_int_t  intno)
protected

Wrapper around nomali_int_state()

Parameters
intnoInterrupt number
Returns
True if asserted, false otherwise.

Definition at line 256 of file gpu_nomali.cc.

References nomali, and panicOnErr().

◆ onInterrupt()

void gem5::NoMaliGpu::onInterrupt ( nomali_int_t  intno,
bool  set 
)
protectedvirtual

Interrupt callback from the NoMali library.

This method is called whenever there is an interrupt state change.

Parameters
intnoInterrupt number
setTrue is the interrupt is being asserted, false otherwise.

Definition at line 274 of file gpu_nomali.cc.

References gem5::BaseGic::clearInt(), DPRINTF, gem5::RealView::gic, interruptMap, panic, platform, and gem5::BaseGic::sendInt().

Referenced by _interrupt().

◆ onReset()

void gem5::NoMaliGpu::onReset ( )
protectedvirtual

Reset callback from the NoMali library.

This method is called whenever the GPU is reset through the register interface or the API (reset() or nomali_reset()).

Reimplemented in gem5::CustomNoMaliGpu.

Definition at line 293 of file gpu_nomali.cc.

References DPRINTF.

Referenced by _reset(), and gem5::CustomNoMaliGpu::onReset().

◆ panicOnErr()

static void gem5::NoMaliGpu::panicOnErr ( nomali_error_t  err,
const char *  msg 
)
inlinestaticprotected

Panic if the NoMali returned an error, do nothing otherwise.

Parameters
errError code from the NoMali library.
msgMessage to print when panicking.

Definition at line 112 of file gpu_nomali.hh.

References gem5::ArmISA::err, and gpuPanic().

Referenced by intState(), readReg(), readRegRaw(), reset(), setCallback(), writeReg(), and writeRegRaw().

◆ read()

Tick gem5::NoMaliGpu::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 150 of file gpu_nomali.cc.

References gem5::X86ISA::addr, gem5::Packet::getAddr(), gem5::Packet::getSize(), gem5::Packet::makeResponse(), nomaliInfo, panic, pioAddr, readReg(), and gem5::Packet::setLE().

◆ readReg()

uint32_t gem5::NoMaliGpu::readReg ( nomali_addr_t  reg)
protected

Wrapper around nomali_reg_read().

Definition at line 208 of file gpu_nomali.cc.

References DPRINTF, nomali, panicOnErr(), and gem5::X86ISA::reg.

Referenced by read().

◆ readRegRaw()

uint32_t gem5::NoMaliGpu::readRegRaw ( nomali_addr_t  reg) const
protected

Wrapper around nomali_reg_read_raw().

Definition at line 235 of file gpu_nomali.cc.

References nomali, panicOnErr(), and gem5::X86ISA::reg.

Referenced by serialize().

◆ reset()

void gem5::NoMaliGpu::reset ( )
protected

Wrapper around nomali_reset().

Definition at line 198 of file gpu_nomali.cc.

References DPRINTF, nomali, and panicOnErr().

Referenced by init().

◆ serialize()

void gem5::NoMaliGpu::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 128 of file gpu_nomali.cc.

References gem5::ArmISA::i, nomaliInfo, readRegRaw(), and SERIALIZE_CONTAINER.

◆ setCallback()

void gem5::NoMaliGpu::setCallback ( const nomali_callback_t &  callback)
private

Wrapper around nomali_set_callback()

Definition at line 299 of file gpu_nomali.cc.

References DPRINTF, nomali, and panicOnErr().

◆ unserialize()

void gem5::NoMaliGpu::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 139 of file gpu_nomali.cc.

References gem5::ArmISA::i, nomaliInfo, UNSERIALIZE_CONTAINER, and writeRegRaw().

◆ write()

Tick gem5::NoMaliGpu::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 171 of file gpu_nomali.cc.

References gem5::X86ISA::addr, gem5::Packet::getAddr(), gem5::Packet::getLE(), gem5::Packet::getSize(), gem5::Packet::makeAtomicResponse(), nomaliInfo, panic, pioAddr, and writeReg().

◆ writeReg()

void gem5::NoMaliGpu::writeReg ( nomali_addr_t  reg,
uint32_t  value 
)
protected

Wrapper around nomali_reg_write().

Definition at line 224 of file gpu_nomali.cc.

References DPRINTF, nomali, panicOnErr(), and gem5::X86ISA::reg.

Referenced by write().

◆ writeRegRaw()

void gem5::NoMaliGpu::writeRegRaw ( nomali_addr_t  reg,
uint32_t  value 
)
protected

Wrapper around nomali_reg_write_raw().

Definition at line 248 of file gpu_nomali.cc.

References nomali, panicOnErr(), and gem5::X86ISA::reg.

Referenced by gem5::CustomNoMaliGpu::onReset(), and unserialize().

Member Data Documentation

◆ interruptMap

const std::map<nomali_int_t, uint32_t> gem5::NoMaliGpu::interruptMap
protected

Map between NoMali interrupt types and actual GIC interrupts.

Definition at line 181 of file gpu_nomali.hh.

Referenced by onInterrupt().

◆ nomali

nomali_handle_t gem5::NoMaliGpu::nomali
protected

Handle of a NoMali library instance.

Definition at line 187 of file gpu_nomali.hh.

Referenced by intState(), readReg(), readRegRaw(), reset(), setCallback(), writeReg(), writeRegRaw(), and ~NoMaliGpu().

◆ nomaliInfo

nomali_info_t gem5::NoMaliGpu::nomaliInfo
protected

Cached information struct from the NoMali library.

Definition at line 184 of file gpu_nomali.hh.

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

◆ pioAddr

const Addr gem5::NoMaliGpu::pioAddr
protected

Device base address.

Definition at line 174 of file gpu_nomali.hh.

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

◆ platform

RealView* const gem5::NoMaliGpu::platform
protected

Platform, used to discover GIC.

Definition at line 177 of file gpu_nomali.hh.

Referenced by onInterrupt().


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

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