CIRCT  20.0.0git
Public Types | Public Attributes | List of all members
circt::firrtl::ModuleModifications Struct Reference

A store of pending modifications to a FIRRTL module associated with solving one or more WiringProblems. More...

#include <FIRRTLAnnotationHelper.h>

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

Public Types

using portInfoPair = std::pair< size_t, PortInfo >
 A pair of Wiring Problem index and port information. More...
 
using uturnPair = std::pair< size_t, Value >
 A pair of Wiring Problem index and a U-turn Value that should be connected. More...
 

Public Attributes

SmallVector< portInfoPairportsToAdd
 Ports that should be added to a module. More...
 
DenseMap< size_t, Value > connectionMap
 A mapping of a Value that should be connected to either a new port or a U-turn, for a specific Wiring Problem. More...
 
SmallVector< uturnPairuturns
 A secondary value that may need to be hooked up. More...
 

Detailed Description

A store of pending modifications to a FIRRTL module associated with solving one or more WiringProblems.

Definition at line 287 of file FIRRTLAnnotationHelper.h.

Member Typedef Documentation

◆ portInfoPair

A pair of Wiring Problem index and port information.

Definition at line 289 of file FIRRTLAnnotationHelper.h.

◆ uturnPair

using circt::firrtl::ModuleModifications::uturnPair = std::pair<size_t, Value>

A pair of Wiring Problem index and a U-turn Value that should be connected.

Definition at line 293 of file FIRRTLAnnotationHelper.h.

Member Data Documentation

◆ connectionMap

DenseMap<size_t, Value> circt::firrtl::ModuleModifications::connectionMap

A mapping of a Value that should be connected to either a new port or a U-turn, for a specific Wiring Problem.

This is pre-populated with the source and sink.

Definition at line 301 of file FIRRTLAnnotationHelper.h.

◆ portsToAdd

SmallVector<portInfoPair> circt::firrtl::ModuleModifications::portsToAdd

Ports that should be added to a module.

Definition at line 296 of file FIRRTLAnnotationHelper.h.

◆ uturns

SmallVector<uturnPair> circt::firrtl::ModuleModifications::uturns

A secondary value that may need to be hooked up.

This is always set after the Value in the connectionMap.

Definition at line 305 of file FIRRTLAnnotationHelper.h.


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