parallel prefix operations

.github/workflows/general.yml

@@ -17,6 +17,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          submodules: recursive
 
       - name: Lint Markdown files
         uses: DavidAnson/markdownlint-cli2-action@v11

.gitignore

@@ -13,6 +13,7 @@ doc/api/
 tmp*
 *.vcd
 .vscode/
+*~
 
 # Exceptions
-!.vscode/extensions.json
+!.vscode/extensions.json

CONTRIBUTING.md

@@ -151,3 +151,4 @@ Here are some links to help guide you on style as recommended by Dart:
 * Design: <https://dart.dev/guides/language/effective-dart/design>
 
 We recommend following these same guidelines for any of your own packages you may create for the ecosystem, as well.
+

README.md

@@ -48,6 +48,5 @@ Some examples of component categories include:
 - Models
 
 ----------------
-
 Copyright (C) 2023 Intel Corporation  
 SPDX-License-Identifier: BSD-3-Clause

conflicts.txt

@@ -0,0 +1,34 @@
+From https://github.com/intel/rohd-hcl
+ * branch            main       -> FETCH_HEAD
+Auto-merging .github/workflows/general.yml
+Auto-merging doc/components/arbiter.md
+CONFLICT (content): Merge conflict in doc/components/arbiter.md
+Auto-merging doc/components/memory.md
+CONFLICT (content): Merge conflict in doc/components/memory.md
+CONFLICT (modify/delete): doc/fifo.md deleted in 861c4ad955af5ac6f2099eb3e1270fe83f40ac26 and modified in HEAD.  Version HEAD of doc/fifo.md left in tree.
+Auto-merging gen/arbiter_gen.dart
+CONFLICT (add/add): Merge conflict in gen/arbiter_gen.dart
+Auto-merging gen/fifo_gen.dart
+CONFLICT (add/add): Merge conflict in gen/fifo_gen.dart
+Auto-merging gen/generate.dart
+CONFLICT (add/add): Merge conflict in gen/generate.dart
+Auto-merging gen/one_hot_gen.dart
+CONFLICT (add/add): Merge conflict in gen/one_hot_gen.dart
+Auto-merging gen/rf_gen.dart
+CONFLICT (add/add): Merge conflict in gen/rf_gen.dart
+Auto-merging gen/rotate_gen.dart
+CONFLICT (add/add): Merge conflict in gen/rotate_gen.dart
+Auto-merging test/one_hot_test.dart
+Auto-merging tool/converters/verilog_html.sh
+CONFLICT (add/add): Merge conflict in tool/converters/verilog_html.sh
+Auto-merging tool/converters/verilog_json.sh
+CONFLICT (add/add): Merge conflict in tool/converters/verilog_json.sh
+Auto-merging tool/gh_actions/install_d3_hwschematic.sh
+CONFLICT (add/add): Merge conflict in tool/gh_actions/install_d3_hwschematic.sh
+Auto-merging tool/gh_actions/install_opencadsuite.sh
+CONFLICT (add/add): Merge conflict in tool/gh_actions/install_opencadsuite.sh
+Auto-merging tool/gh_codespaces/run_setup.sh
+CONFLICT (content): Merge conflict in tool/gh_codespaces/run_setup.sh
+Auto-merging tool/synthesize.sh
+CONFLICT (add/add): Merge conflict in tool/synthesize.sh
+Automatic merge failed; fix conflicts and then commit the result.

doc/components/parallel_prefix_operations.md

@@ -0,0 +1,16 @@
+# Parallel Prefix Operations
+
+ROHD HCL implements a set of parallel prefix compute operations using different parallel prefix computation trees based on the ['ParallelPrefix'] node class carrying carry/save or generate/propagate bits.
+
+For example, we have unary operations like a word-level 'or' [`ParallelPrefixOrScan`] class, and a priority encoder [`ParallelPrefixPriorityEncoder`] class which computes the position of the first bit set to '1'. We have simple unary arithmetic operations like an increment [`ParallelPrefixIncr`] class, and a decrement [`ParallelPrefixDecr`] class. Finally, we have a binary adder [`ParallelPrefixAdder`] class. For background on basic parallel prefix adder structures, see <https://en.wikipedia.org/wiki/Kogge%E2%80%93Stone_adder>.
+
+Each of these operations can be implemented with different ['ParallelPrefix'] tree structures:
+
+- ['Ripple']
+- ['Sklansky]
+- ['KoggeStone']
+- ['BrentKung]
+
+[ParallelPrefixAdder (BrentKung) Schematic]
+
+[ParallelPrefixPriorityEncoder (KoggeStone) Schematic]

doc/onehot.md

@@ -0,0 +1,15 @@
+# One Hot Codecs
+
+ROHD HCL implements a set of one hot encoder and decoders.
+
+For example, we have an encoder [`BinaryToOneHot`](https://intel.github.io/rohd-hcl/rohd_hcl/BinaryToOneHot-class.html) class, and a couple of implementations of decoder classes like [`OneHotToBinary`](https://intel.github.io/rohd-hcl/rohd_hcl/OneHotToBinary-class.html) and a more performant [`TreeBinaryToOneHot`](https://intel.github.io/rohd-hcl/rohd_hcl/TreeOneHotToBinary-class.html).
+
+The encoders take a Logic bitvector, with the constraint that only a single bit is set to '1' and outputs the bit position in binary.
+
+The decoders take a Logic input representing the bit position to be set to '1', and returns a Logic bitvector with that bit position set to '1', and all others set to '0'
+
+[BinaryToOneHot Schematic](https://intel.github.io/rohd-hcl/BinaryToOneHot.html)
+
+[OneHotToBinary Schematic](https://intel.github.io/rohd-hcl/OneHotToBinary.html)
+
+[TreeOneHotToBinary Schematic](https://intel.github.io/rohd-hcl/TreeOneHotToBinary.html)

gen/generate.dart

@@ -13,6 +13,7 @@
 import 'arbiter_gen.dart';
 import 'fifo_gen.dart';
 import 'one_hot_gen.dart';
+import 'parallel_prefix_operations_gen.dart';
 import 'rf_gen.dart';
 import 'rotate_gen.dart';
 
@@ -22,4 +23,5 @@ void main() async {
   await oneHotGen();
   await rfGen();
   await rotateGen();
+  await parallelPrefixGen();
 }

gen/parallel_prefix_operations_gen.dart

@@ -0,0 +1,35 @@
+// Copyright (C) 2023 Intel Corporation
+// SPDX-License-Identifier: BSD-3-Clause
+//
+// one_hot_gen.dart
+// Generate one_hot codecs.
+//
+// 2023 Oct 02
+// Author: Desmond Kirkpatrick <[email protected]>
+
+import 'dart:io';
+import 'package:rohd/rohd.dart';
+import 'package:rohd_hcl/src/parallel_prefix_operations.dart';
+
+Future<void> parallelPrefixGen() async {
+  const n = 8;
+  final a = Logic(name: 'a', width: n);
+  final b = Logic(name: 'b', width: n);
+
+  final generators = [Ripple.new, Sklansky.new, KoggeStone.new, BrentKung.new];
+  final names = ['Ripple', 'Sklansky', 'KoggeStone', 'BrentKung'];
+  var i = 0;
+  for (final ppGen in generators) {
+    final m1 = ParallelPrefixAdder(a, b, ppGen);
+    await m1.build();
+    File('build/${m1.definitionName}_${names[i]}.v').writeAsStringSync(m1
+        .generateSynth()
+        .replaceAll(m1.definitionName, '${m1.definitionName}_${names[i]}'));
+    final m2 = ParallelPrefixPriorityEncoder(a, ppGen);
+    await m2.build();
+    File('build/${m2.definitionName}_${names[i]}.v').writeAsStringSync(m2
+        .generateSynth()
+        .replaceAll(m2.definitionName, '${m2.definitionName}_${names[i]}'));
+    i = i + 1;
+  }
+}

lib/src/one_hot.dart

@@ -5,7 +5,7 @@
 // Implementation of one hot codec for Logic
 //
 // 2023 February 24
-// Author: Desmond Kirkpatrick
+// Author: Desmond Kirkpatrick <[email protected]>
 
 import 'dart:math';
 import 'package:rohd/rohd.dart';