From e2f74e92db8663df65d5fb286d951bc7bf92edc5 Mon Sep 17 00:00:00 2001 From: Luke Kenneth Casson Leighton Date: Mon, 29 Jun 2020 22:20:41 +0100 Subject: [PATCH] add README for fu directory --- src/soc/fu/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 src/soc/fu/README.md 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.) -- 2.30.2