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.
std::optional< Attribute >	getAttribute (StringRef identifier) const
	Returns the attribute associated with the given name if it exists, otherwise std::nullopt.
SmallVector< StringRef >	getAllIdentifiers () const
	Returns all identifiers for this dictionary attribute.

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 89 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 116 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 105 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 96 of file CalyxOps.h.

References assert(), and attributes.

Member Data Documentation

attributes

DictionaryAttr circt::calyx::PortInfo::attributes

Definition at line 93 of file CalyxOps.h.

Referenced by msft.DeclPhysicalRegionOp::add_bounds(), esi.RequestConnectionOp::clientNamePath(), getAllIdentifiers(), getAttribute(), hasAttribute(), esi.RandomAccessMemoryDeclOp::innerType(), msft.DynamicInstanceOp::instanceRef(), fsm.MachineOp::instantiate(), msft.PDPhysLocationOp::loc(), printComponentInterface(), msft.InstanceHierarchyOp::top_module_ref(), and fsm.MachineOp::type().

direction

Direction circt::calyx::PortInfo::direction

Definition at line 92 of file CalyxOps.h.

Referenced by verifyPortDirection().

name

StringAttr circt::calyx::PortInfo::name

Definition at line 90 of file CalyxOps.h.

Referenced by printComponentInterface().

type

Type circt::calyx::PortInfo::type

Definition at line 91 of file CalyxOps.h.

Referenced by esiaccel.types.WritePort::__serialize_msg(), hw.HWModuleOp::add_entry_block(), esiaccel.types.Port::connect(), hw.HWModuleOp::input_indices(), fsm.MachineOp::instantiate(), hw.HWModuleOp::outputs(), printComponentInterface(), and esiaccel.types.ReadPort::read().

---

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