CIRCT  20.0.0git
Public Member Functions | Public Attributes | List of all members
circt::firrtl::FirMemory Struct Reference

#include <FIRRTLOps.h>

Collaboration diagram for circt::firrtl::FirMemory:
Collaboration graph
[legend]

Public Member Functions

auto getTuple () const
 
bool operator< (const FirMemory &rhs) const
 
bool operator== (const FirMemory &rhs) const
 
StringAttr getFirMemoryName () const
 
bool isSeqMem () const
 Check whether the memory is a seq mem. More...
 

Public Attributes

size_t numReadPorts
 
size_t numWritePorts
 
size_t numReadWritePorts
 
size_t dataWidth
 
size_t depth
 
size_t readLatency
 
size_t writeLatency
 
size_t maskBits
 
seq::RUW readUnderWrite
 
seq::WUW writeUnderWrite
 
SmallVector< int32_t > writeClockIDs
 
StringAttr modName
 
bool isMasked
 
MemoryInitAttr init
 
StringAttr prefix
 
Location loc
 
bool isInDut = false
 
Operation * op = nullptr
 

Detailed Description

Definition at line 166 of file FIRRTLOps.h.

Member Function Documentation

◆ getFirMemoryName()

StringAttr FirMemory::getFirMemoryName ( ) const

Definition at line 3348 of file FIRRTLOps.cpp.

References modName.

◆ getTuple()

auto circt::firrtl::FirMemory::getTuple ( ) const
inline

◆ isSeqMem()

bool circt::firrtl::FirMemory::isSeqMem ( ) const
inline

Check whether the memory is a seq mem.

The following conditions must hold:

  1. read latency and write latency of one.
  2. undefined read-under-write behavior.

Definition at line 214 of file FIRRTLOps.h.

References dataWidth, readLatency, and writeLatency.

◆ operator<()

bool circt::firrtl::FirMemory::operator< ( const FirMemory rhs) const
inline

Definition at line 199 of file FIRRTLOps.h.

References getTuple().

◆ operator==()

bool circt::firrtl::FirMemory::operator== ( const FirMemory rhs) const
inline

Definition at line 202 of file FIRRTLOps.h.

References getTuple().

Member Data Documentation

◆ dataWidth

size_t circt::firrtl::FirMemory::dataWidth

Definition at line 170 of file FIRRTLOps.h.

Referenced by getTuple(), and isSeqMem().

◆ depth

size_t circt::firrtl::FirMemory::depth

Definition at line 171 of file FIRRTLOps.h.

Referenced by getTuple().

◆ init

MemoryInitAttr circt::firrtl::FirMemory::init

Definition at line 180 of file FIRRTLOps.h.

Referenced by getTuple().

◆ isInDut

bool circt::firrtl::FirMemory::isInDut = false

Definition at line 187 of file FIRRTLOps.h.

◆ isMasked

bool circt::firrtl::FirMemory::isMasked

Definition at line 179 of file FIRRTLOps.h.

◆ loc

Location circt::firrtl::FirMemory::loc

Definition at line 184 of file FIRRTLOps.h.

◆ maskBits

size_t circt::firrtl::FirMemory::maskBits

Definition at line 174 of file FIRRTLOps.h.

Referenced by getTuple().

◆ modName

StringAttr circt::firrtl::FirMemory::modName

Definition at line 178 of file FIRRTLOps.h.

Referenced by getFirMemoryName().

◆ numReadPorts

size_t circt::firrtl::FirMemory::numReadPorts

Definition at line 167 of file FIRRTLOps.h.

Referenced by getTuple().

◆ numReadWritePorts

size_t circt::firrtl::FirMemory::numReadWritePorts

Definition at line 169 of file FIRRTLOps.h.

Referenced by getTuple().

◆ numWritePorts

size_t circt::firrtl::FirMemory::numWritePorts

Definition at line 168 of file FIRRTLOps.h.

Referenced by getTuple().

◆ op

Operation* circt::firrtl::FirMemory::op = nullptr

Definition at line 189 of file FIRRTLOps.h.

◆ prefix

StringAttr circt::firrtl::FirMemory::prefix

Definition at line 181 of file FIRRTLOps.h.

Referenced by getTuple().

◆ readLatency

size_t circt::firrtl::FirMemory::readLatency

Definition at line 172 of file FIRRTLOps.h.

Referenced by getTuple(), and isSeqMem().

◆ readUnderWrite

seq::RUW circt::firrtl::FirMemory::readUnderWrite

Definition at line 175 of file FIRRTLOps.h.

Referenced by getTuple().

◆ writeClockIDs

SmallVector<int32_t> circt::firrtl::FirMemory::writeClockIDs

Definition at line 177 of file FIRRTLOps.h.

Referenced by getTuple().

◆ writeLatency

size_t circt::firrtl::FirMemory::writeLatency

Definition at line 173 of file FIRRTLOps.h.

Referenced by getTuple(), and isSeqMem().

◆ writeUnderWrite

seq::WUW circt::firrtl::FirMemory::writeUnderWrite

Definition at line 176 of file FIRRTLOps.h.

Referenced by getTuple().


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