circt::calyx::PortInfo Struct Reference

This holds information about the port for either a Component or Cell. More...

#include <CalyxOps.h>

Collaboration diagram for circt::calyx::PortInfo:

Public Member Functions
bool	hasAttribute (StringRef identifier) const
	Returns whether the given port has attribute with Identifier name. More...
std::optional< Attribute >	getAttribute (StringRef identifier) const
	Returns the attribute associated with the given name if it exists, otherwise std::nullopt. More...
SmallVector< StringRef >	getAllIdentifiers () const
	Returns all identifiers for this dictionary attribute. More...

Public Attributes
StringAttr	name
Type	type
Direction	direction
DictionaryAttr	attributes

Detailed Description

This holds information about the port for either a Component or Cell.

Definition at line 78 of file CalyxOps.h.

Member Function Documentation

getAllIdentifiers()

SmallVector<StringRef> circt::calyx::PortInfo::getAllIdentifiers ( ) const

inline

Returns all identifiers for this dictionary attribute.

Definition at line 105 of file CalyxOps.h.

References assert(), and attributes.

getAttribute()

std::optional<Attribute> circt::calyx::PortInfo::getAttribute ( StringRef  identifier ) const

inline

Returns the attribute associated with the given name if it exists, otherwise std::nullopt.

Definition at line 94 of file CalyxOps.h.

References assert(), and attributes.

hasAttribute()

bool circt::calyx::PortInfo::hasAttribute ( StringRef  identifier ) const

inline

Returns whether the given port has attribute with Identifier name.

Definition at line 85 of file CalyxOps.h.

References assert(), and attributes.

Member Data Documentation

attributes

DictionaryAttr circt::calyx::PortInfo::attributes

Definition at line 82 of file CalyxOps.h.

Referenced by _msft_ops_ext.PhysicalRegionOp::add_bounds(), _msft_ops_ext.MSFTModuleOp::childAppIDBases(), _esi_ops_ext.RequestToServerConnectionOp::clientNamePath(), _esi_ops_ext.RequestToClientConnectionOp::clientNamePath(), getAllIdentifiers(), getAttribute(), hasAttribute(), _esi_ops_ext.RandomAccessMemoryDeclOp::innerType(), _hw_ops_ext.HWModuleOp::input_indices(), _msft_ops_ext.DynamicInstanceOp::instanceRef(), _fsm_ops_ext.MachineOp::instantiate(), _msft_ops_ext.PDPhysLocationOp::loc(), _msft_ops_ext.InstanceOp::moduleName(), _hw_ops_ext.ModuleLike::name(), _msft_ops_ext.MSFTModuleLike::name(), _hw_ops_ext.HWModuleOp::outputs(), _hw_ops_ext.ModuleLike::parameters(), _msft_ops_ext.MSFTModuleLike::parameters(), _msft_ops_ext.MSFTModuleOp::parameters(), printComponentInterface(), _msft_ops_ext.InstanceHierarchyOp::top_module_ref(), _fsm_ops_ext.MachineOp::type(), _hw_ops_ext.ModuleLike::type(), and _msft_ops_ext.MSFTModuleLike::type().

direction

Direction circt::calyx::PortInfo::direction

Definition at line 81 of file CalyxOps.h.

Referenced by verifyPortDirection().

name

StringAttr circt::calyx::PortInfo::name

Definition at line 79 of file CalyxOps.h.

Referenced by printComponentInterface().

type

Type circt::calyx::PortInfo::type

Definition at line 80 of file CalyxOps.h.

Referenced by _fsm_ops_ext.MachineOp::__init__(), _hw_ops_ext.HWModuleOp::add_entry_block(), _msft_ops_ext.MSFTModuleOp::add_entry_block(), _fsm_ops_ext.MachineOp::instantiate(), _hw_ops_ext.HWModuleOp::outputs(), and printComponentInterface().

---

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

• /home/runner/work/circt-www/circt-www/circt_src/include/circt/Dialect/Calyx/CalyxOps.h