From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Thu, 2 May 2019 23:35:17 +0000 (+0100)
Subject: document concurrentunit
X-Git-Tag: ls180-24jan2020~1054
X-Git-Url: https://git.libre-soc.org/?p=ieee754fpu.git;a=commitdiff_plain;h=e6ba0ac37e5db58318ba272659d78cb599b27a34;hp=e7a11f8b7eb3693289646d2f2091a45137f7c20f

document concurrentunit
---

diff --git a/src/nmutil/concurrentunit.py b/src/nmutil/concurrentunit.py
index 82b81ff5..5f02d7cd 100644
--- a/src/nmutil/concurrentunit.py
+++ b/src/nmutil/concurrentunit.py
@@ -1,6 +1,12 @@
-# IEEE Floating Point Adder (Single Precision)
-# Copyright (C) Jonathan P Dawson 2013
-# 2013-12-12
+""" concurrent unit from mitch alsup augmentations to 6600 scoreboard
+
+    * data fans in
+    * data goes through a pipeline
+    * results fan back out.
+
+    the output data format has to have a member "mid", which is used
+    as the array index on fan-out
+"""
 
 from math import log
 from nmigen import Module
@@ -14,6 +20,7 @@ from nmutil.multipipe import PriorityCombMuxInPipe
 def num_bits(n):
     return int(log(n) / log(2))
 
+
 class FPADDInMuxPipe(PriorityCombMuxInPipe):
     def __init__(self, num_rows, iospecfn):
         self.num_rows = num_rows