From: Luke Kenneth Casson Leighton <lkcl@lkcl.net>
Date: Mon, 29 Jun 2020 21:20:41 +0000 (+0100)
Subject: add README for fu directory
X-Git-Tag: div_pipeline~196
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=e2f74e92db8663df65d5fb286d951bc7bf92edc5;p=soc.git

add README for fu directory
---

diff --git a/src/soc/fu/README.md b/src/soc/fu/README.md
new file mode 100644
index 00000000..fad4daef
--- /dev/null
+++ b/src/soc/fu/README.md
@@ -0,0 +1,16 @@
+# Pipelines
+
+In this directory are the pipelines.  The structure of each pipeline is
+as follows:
+
+* pipe_data.py: contains pipeline input and output data structures
+* XXXX_stage.py: files with function-specific stages
+* XXX_input_record.py: a PowerISA decoded instruction subset for this pipeline
+* pipeline.py: the actual pipeline chain, which brings all stages together
+
+# Common files
+
+* regspec.py: the register specification API.  used by each pipe_data.py
+* pipe_data.py: base class for pipeline pipe_data.py data structures
+* common_input_stage.py: functionality common to input stages (RA, RB)
+* common_output_stage.py: functionality common to output stages (SO, CA/32 etc.)