Skip to content

Commit bdb6e7b

Browse files
committed
Update comments
1 parent c612ee1 commit bdb6e7b

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

lib/Dialect/FIRRTL/Transforms/InferDomains.cpp

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,9 @@
66
//
77
//===----------------------------------------------------------------------===//
88
//
9-
// This pass implements FIRRTL domain inference and checking with canonical
10-
// domain representation. Domain sequences are canonicalized by sorting and
11-
// removing duplicates, making domain order irrelevant and allowing duplicate
12-
// domains to be treated as equivalent. The result of this pass is either a
13-
// correctly domain-inferred circuit or pass failure if the circuit contains
14-
// illegal domain crossings.
9+
// InferDomains implements FIRRTL domain inference and checking. This pass is a
10+
// bottom-up transform acting on modules. For each module, we ensure there are
11+
// no domain crossings, and we make explicit the domain associations of ports.
1512
//
1613
//===----------------------------------------------------------------------===//
1714

@@ -93,9 +90,10 @@ static bool isPort(FModuleOp module, Value value) {
9390
// Circuit-wide state.
9491
//====--------------------------------------------------------------------------
9592

96-
/// Each declared domain in the circuit is assigned an index, based on the order
97-
/// in which it appears. Domain associations for hardware values are represented
98-
/// as a list of domains, sorted by the index of the domain type.
93+
/// Each domain type declared in the circuit is assigned a type-id, based on the
94+
/// order of declaration. Domain associations for hardware values are
95+
/// represented as a list, or row, of domains. The domains in a row are ordered
96+
/// according to their type's id.
9997
using DomainTypeID = size_t;
10098

10199
/// Information about the domains in the circuit. Able to map domains to their

0 commit comments

Comments
 (0)