gem5 [DEVELOP-FOR-25.0]
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | List of all members
gem5::IGbE::DescCache< T > Class Template Referenceabstract
Inheritance diagram for gem5::IGbE::DescCache< T >:
gem5::Serializable

Public Member Functions

 DescCache (IGbE *i, const std::string n, int s)
 
virtual ~DescCache ()
 
std::string name ()
 
void areaChanged ()
 If the address/len/head change when we've got descriptors that are dirty that is very bad.
 
void writeback (Addr aMask)
 
void writeback1 ()
 
void fetchDescriptors ()
 Fetch a chunk of descriptors into the descriptor cache.
 
void fetchDescriptors1 ()
 
void fetchComplete ()
 Called by event when dma to read descriptors is completed.
 
void wbComplete ()
 Called by event when dma to writeback descriptors is completed.
 
unsigned descLeft () const
 
unsigned descUsed () const
 
unsigned descUnused () const
 
void reset ()
 
void serialize (CheckpointOut &cp) const override
 Serialize an object.
 
void unserialize (CheckpointIn &cp) override
 Unserialize an object.
 
virtual bool hasOutstandingEvents ()
 
- 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.
 
void serializeSection (CheckpointOut &cp, const std::string &name) const
 
void unserializeSection (CheckpointIn &cp, const char *name)
 Unserialize an a child object.
 
void unserializeSection (CheckpointIn &cp, const std::string &name)
 

Public Attributes

std::string annSmFetch
 Annotate sm.
 
std::string annSmWb
 
std::string annUnusedDescQ
 
std::string annUsedCacheQ
 
std::string annUsedDescQ
 
std::string annUnusedCacheQ
 
std::string annDescQ
 
EventFunctionWrapper wbDelayEvent
 
EventFunctionWrapper fetchDelayEvent
 
EventFunctionWrapper fetchEvent
 
EventFunctionWrapper wbEvent
 

Protected Types

typedef std::deque< T * > CacheType
 

Protected Member Functions

virtual Addr descBase () const =0
 
virtual long descHead () const =0
 
virtual long descTail () const =0
 
virtual long descLen () const =0
 
virtual void updateHead (long h)=0
 
virtual void enableSm ()=0
 
virtual void actionAfterWb ()
 
virtual void fetchAfterWb ()=0
 
Addr pciToDma (Addr a)
 Shortcut for DMA address translation.
 

Protected Attributes

CacheType usedCache
 
CacheType unusedCache
 
T * fetchBuf
 
T * wbBuf
 
IGbE * igbe
 
std::string _name
 
int cachePnt
 
int size
 
int curFetching
 
int wbOut
 
bool moreToWb
 
Addr wbAlignment
 
EthPacketPtr pktPtr
 The packet that is currently being dmad to memory if any.
 

Additional Inherited Members

- Static Public Member Functions inherited from gem5::Serializable
static const std::string & currentSection ()
 Gets the fully-qualified name of the active section.
 
static void generateCheckpointOut (const std::string &cpt_dir, std::ofstream &outstream)
 Generate a checkpoint file so that the serialization can be routed to it.
 

Detailed Description

template<class T>
class gem5::IGbE::DescCache< T >

Definition at line 181 of file i8254xGBe.hh.

Member Typedef Documentation

◆ CacheType

template<class T>
typedef std::deque<T *> gem5::IGbE::DescCache< T >::CacheType
protected

Definition at line 193 of file i8254xGBe.hh.

Constructor & Destructor Documentation

◆ DescCache()

template<class T>
gem5::IGbE::DescCache< T >::DescCache ( IGbE * i,
const std::string n,
int s )

Definition at line 827 of file i8254xGBe.cc.

References _name, cachePnt, curFetching, gem5::ArmISA::i, gem5::IGbE::IGbE(), igbe, moreToWb, gem5::ArmISA::n, pktPtr, gem5::ArmISA::s, size, wbAlignment, wbDelayEvent, wbOut, and writeback1().

◆ ~DescCache()

template<class T>
gem5::IGbE::DescCache< T >::~DescCache ( )
virtual

Definition at line 840 of file i8254xGBe.cc.

References fetchBuf, gem5::statistics::reset(), and wbBuf.

Member Function Documentation

◆ actionAfterWb()

template<class T>
virtual void gem5::IGbE::DescCache< T >::actionAfterWb ( )
inlineprotectedvirtual

Reimplemented in gem5::IGbE::TxDescCache.

Definition at line 190 of file i8254xGBe.hh.

Referenced by wbComplete().

◆ areaChanged()

template<class T>
void gem5::IGbE::DescCache< T >::areaChanged ( )

If the address/len/head change when we've got descriptors that are dirty that is very bad.

This function checks that we don't and if we do panics.

Definition at line 849 of file i8254xGBe.cc.

References curFetching, panic, gem5::statistics::reset(), usedCache, and wbOut.

◆ descBase()

template<class T>
virtual Addr gem5::IGbE::DescCache< T >::descBase ( ) const
protectedpure virtual

Implemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Referenced by fetchDescriptors1(), and writeback1().

◆ descHead()

template<class T>
virtual long gem5::IGbE::DescCache< T >::descHead ( ) const
protectedpure virtual

Implemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Referenced by fetchDescriptors(), wbComplete(), writeback(), and writeback1().

◆ descLeft()

template<class T>
unsigned gem5::IGbE::DescCache< T >::descLeft ( ) const
inline

Definition at line 272 of file i8254xGBe.hh.

References cachePnt, descLen(), descTail(), and unusedCache.

Referenced by fetchDescriptors(), and writeback().

◆ descLen()

template<class T>
virtual long gem5::IGbE::DescCache< T >::descLen ( ) const
protectedpure virtual

Implemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Referenced by descLeft(), fetchComplete(), fetchDescriptors(), wbComplete(), and writeback().

◆ descTail()

template<class T>
virtual long gem5::IGbE::DescCache< T >::descTail ( ) const
protectedpure virtual

Implemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Referenced by descLeft(), fetchDescriptors(), and writeback().

◆ descUnused()

template<class T>
unsigned gem5::IGbE::DescCache< T >::descUnused ( ) const
inline

Definition at line 288 of file i8254xGBe.hh.

References unusedCache.

◆ descUsed()

template<class T>
unsigned gem5::IGbE::DescCache< T >::descUsed ( ) const
inline

Definition at line 285 of file i8254xGBe.hh.

References usedCache.

◆ enableSm()

template<class T>
virtual void gem5::IGbE::DescCache< T >::enableSm ( )
protectedpure virtual

Implemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Referenced by fetchComplete().

◆ fetchAfterWb()

template<class T>
virtual void gem5::IGbE::DescCache< T >::fetchAfterWb ( )
protectedpure virtual

Implemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Referenced by wbComplete().

◆ fetchComplete()

template<class T>
void gem5::IGbE::DescCache< T >::fetchComplete ( )

Called by event when dma to read descriptors is completed.

Definition at line 990 of file i8254xGBe.cc.

References cachePnt, curFetching, descLen(), DPRINTF, enableSm(), fetchBuf, igbe, unusedCache, and gem5::RiscvISA::x.

◆ fetchDescriptors()

template<class T>
void gem5::IGbE::DescCache< T >::fetchDescriptors ( )

Fetch a chunk of descriptors into the descriptor cache.

Calls fetchComplete when the memory system returns the data

Definition at line 931 of file i8254xGBe.cc.

References cachePnt, curFetching, gem5::curTick(), descHead(), descLeft(), descLen(), descTail(), DPRINTF, fetchDelayEvent, igbe, size, unusedCache, and usedCache.

◆ fetchDescriptors1()

template<class T>
void gem5::IGbE::DescCache< T >::fetchDescriptors1 ( )

Definition at line 970 of file i8254xGBe.cc.

References cachePnt, curFetching, gem5::curTick(), descBase(), DPRINTF, fetchBuf, fetchDelayEvent, fetchEvent, igbe, gem5::PciDevice::pciToDma(), and gem5::Running.

◆ hasOutstandingEvents()

template<class T>
virtual bool gem5::IGbE::DescCache< T >::hasOutstandingEvents ( )
inlinevirtual

Reimplemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Definition at line 298 of file i8254xGBe.hh.

References fetchEvent, and wbEvent.

◆ name()

template<class T>
std::string gem5::IGbE::DescCache< T >::name ( )
inline

Definition at line 239 of file i8254xGBe.hh.

References _name.

◆ pciToDma()

template<class T>
Addr gem5::IGbE::DescCache< T >::pciToDma ( Addr a)
inlineprotected

Shortcut for DMA address translation.

Definition at line 229 of file i8254xGBe.hh.

References gem5::ArmISA::a, and igbe.

◆ reset()

template<class T>
void gem5::IGbE::DescCache< T >::reset ( )

Definition at line 1057 of file i8254xGBe.cc.

References cachePnt, DPRINTF, unusedCache, usedCache, and gem5::RiscvISA::x.

◆ serialize()

template<class T>
void gem5::IGbE::DescCache< T >::serialize ( CheckpointOut & cp) const
overridevirtual

Serialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Reimplemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Definition at line 1074 of file i8254xGBe.cc.

References gem5::arrayParamOut(), cachePnt, gem5::csprintf(), curFetching, fetchDelayEvent, moreToWb, SERIALIZE_SCALAR, unusedCache, usedCache, wbAlignment, wbDelayEvent, wbOut, and gem5::RiscvISA::x.

Referenced by gem5::IGbE::RxDescCache::serialize(), and gem5::IGbE::TxDescCache::serialize().

◆ unserialize()

template<class T>
void gem5::IGbE::DescCache< T >::unserialize ( CheckpointIn & cp)
overridevirtual

Unserialize an object.

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

Parameters
cpCheckpoint state

Implements gem5::Serializable.

Reimplemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Definition at line 1109 of file i8254xGBe.cc.

References gem5::arrayParamIn(), cachePnt, gem5::csprintf(), curFetching, fetchDelayEvent, igbe, moreToWb, UNSERIALIZE_SCALAR, unusedCache, usedCache, wbAlignment, wbDelayEvent, wbOut, and gem5::RiscvISA::x.

Referenced by gem5::IGbE::RxDescCache::unserialize(), and gem5::IGbE::TxDescCache::unserialize().

◆ updateHead()

template<class T>
virtual void gem5::IGbE::DescCache< T >::updateHead ( long h)
protectedpure virtual

Implemented in gem5::IGbE::RxDescCache, and gem5::IGbE::TxDescCache.

Referenced by wbComplete().

◆ wbComplete()

template<class T>
void gem5::IGbE::DescCache< T >::wbComplete ( )

Called by event when dma to writeback descriptors is completed.

Definition at line 1018 of file i8254xGBe.cc.

References actionAfterWb(), descHead(), descLen(), DPRINTF, fetchAfterWb(), igbe, moreToWb, updateHead(), usedCache, wbAlignment, wbOut, gem5::ArmISA::writeback, and gem5::RiscvISA::x.

◆ writeback()

template<class T>
void gem5::IGbE::DescCache< T >::writeback ( Addr aMask)

Definition at line 859 of file i8254xGBe.cc.

References cachePnt, gem5::curTick(), descHead(), descLeft(), descLen(), descTail(), DPRINTF, igbe, moreToWb, usedCache, wbAlignment, wbDelayEvent, and wbOut.

◆ writeback1()

template<class T>
void gem5::IGbE::DescCache< T >::writeback1 ( )

Definition at line 907 of file i8254xGBe.cc.

References gem5::curTick(), descBase(), descHead(), DPRINTF, igbe, gem5::PciDevice::pciToDma(), gem5::Running, usedCache, wbBuf, wbDelayEvent, wbEvent, wbOut, and gem5::RiscvISA::x.

Referenced by DescCache().

Member Data Documentation

◆ _name

template<class T>
std::string gem5::IGbE::DescCache< T >::_name
protected

Definition at line 204 of file i8254xGBe.hh.

Referenced by DescCache(), and name().

◆ annDescQ

template<class T>
std::string gem5::IGbE::DescCache< T >::annDescQ

Definition at line 234 of file i8254xGBe.hh.

◆ annSmFetch

template<class T>
std::string gem5::IGbE::DescCache< T >::annSmFetch

Annotate sm.

Definition at line 233 of file i8254xGBe.hh.

◆ annSmWb

template<class T>
std::string gem5::IGbE::DescCache< T >::annSmWb

Definition at line 233 of file i8254xGBe.hh.

◆ annUnusedCacheQ

template<class T>
std::string gem5::IGbE::DescCache< T >::annUnusedCacheQ

Definition at line 234 of file i8254xGBe.hh.

◆ annUnusedDescQ

template<class T>
std::string gem5::IGbE::DescCache< T >::annUnusedDescQ

Definition at line 233 of file i8254xGBe.hh.

◆ annUsedCacheQ

template<class T>
std::string gem5::IGbE::DescCache< T >::annUsedCacheQ

Definition at line 233 of file i8254xGBe.hh.

◆ annUsedDescQ

template<class T>
std::string gem5::IGbE::DescCache< T >::annUsedDescQ

Definition at line 234 of file i8254xGBe.hh.

◆ cachePnt

template<class T>
int gem5::IGbE::DescCache< T >::cachePnt
protected

Definition at line 207 of file i8254xGBe.hh.

Referenced by DescCache(), descLeft(), fetchComplete(), fetchDescriptors(), fetchDescriptors1(), reset(), serialize(), unserialize(), and writeback().

◆ curFetching

template<class T>
int gem5::IGbE::DescCache< T >::curFetching
protected

Definition at line 213 of file i8254xGBe.hh.

Referenced by areaChanged(), DescCache(), fetchComplete(), fetchDescriptors(), fetchDescriptors1(), serialize(), and unserialize().

◆ fetchBuf

template<class T>
T* gem5::IGbE::DescCache< T >::fetchBuf
protected

Definition at line 197 of file i8254xGBe.hh.

Referenced by fetchComplete(), fetchDescriptors1(), and ~DescCache().

◆ fetchDelayEvent

template<class T>
EventFunctionWrapper gem5::IGbE::DescCache< T >::fetchDelayEvent

Definition at line 256 of file i8254xGBe.hh.

Referenced by fetchDescriptors(), fetchDescriptors1(), serialize(), and unserialize().

◆ fetchEvent

template<class T>
EventFunctionWrapper gem5::IGbE::DescCache< T >::fetchEvent

Definition at line 261 of file i8254xGBe.hh.

Referenced by fetchDescriptors1(), and hasOutstandingEvents().

◆ igbe

template<class T>
IGbE* gem5::IGbE::DescCache< T >::igbe
protected

Definition at line 201 of file i8254xGBe.hh.

Referenced by DescCache(), fetchComplete(), fetchDescriptors(), fetchDescriptors1(), pciToDma(), unserialize(), wbComplete(), writeback(), and writeback1().

◆ moreToWb

template<class T>
bool gem5::IGbE::DescCache< T >::moreToWb
protected

Definition at line 220 of file i8254xGBe.hh.

Referenced by DescCache(), serialize(), unserialize(), wbComplete(), and writeback().

◆ pktPtr

template<class T>
EthPacketPtr gem5::IGbE::DescCache< T >::pktPtr
protected

The packet that is currently being dmad to memory if any.

Definition at line 226 of file i8254xGBe.hh.

Referenced by DescCache().

◆ size

template<class T>
int gem5::IGbE::DescCache< T >::size
protected

Definition at line 210 of file i8254xGBe.hh.

Referenced by DescCache(), and fetchDescriptors().

◆ unusedCache

template<class T>
CacheType gem5::IGbE::DescCache< T >::unusedCache
protected

Definition at line 195 of file i8254xGBe.hh.

Referenced by descLeft(), descUnused(), fetchComplete(), fetchDescriptors(), reset(), serialize(), and unserialize().

◆ usedCache

template<class T>
CacheType gem5::IGbE::DescCache< T >::usedCache
protected

Definition at line 194 of file i8254xGBe.hh.

Referenced by areaChanged(), descUsed(), fetchDescriptors(), reset(), serialize(), unserialize(), wbComplete(), writeback(), and writeback1().

◆ wbAlignment

template<class T>
Addr gem5::IGbE::DescCache< T >::wbAlignment
protected

Definition at line 223 of file i8254xGBe.hh.

Referenced by DescCache(), serialize(), unserialize(), wbComplete(), and writeback().

◆ wbBuf

template<class T>
T* gem5::IGbE::DescCache< T >::wbBuf
protected

Definition at line 198 of file i8254xGBe.hh.

Referenced by writeback1(), and ~DescCache().

◆ wbDelayEvent

template<class T>
EventFunctionWrapper gem5::IGbE::DescCache< T >::wbDelayEvent

Definition at line 249 of file i8254xGBe.hh.

Referenced by DescCache(), serialize(), unserialize(), writeback(), and writeback1().

◆ wbEvent

template<class T>
EventFunctionWrapper gem5::IGbE::DescCache< T >::wbEvent

Definition at line 266 of file i8254xGBe.hh.

Referenced by hasOutstandingEvents(), and writeback1().

◆ wbOut

template<class T>
int gem5::IGbE::DescCache< T >::wbOut
protected

Definition at line 216 of file i8254xGBe.hh.

Referenced by areaChanged(), DescCache(), serialize(), unserialize(), wbComplete(), writeback(), and writeback1().

The documentation for this class was generated from the following files:
Generated on Mon May 26 2025 09:19:22 for gem5 by doxygen 1.13.2