src/soc/fu/README.md

   1 # Pipelines
   2
   3 In this directory are the pipelines.  The structure of each pipeline is
   4 as follows:
   5
   6 * pipe_data.py: contains pipeline input and output data structures
   7 * XXXX_stage.py: files with function-specific stages
   8 * XXX_input_record.py: a PowerISA decoded instruction subset for this pipeline
   9 * pipeline.py: the actual pipeline chain, which brings all stages together
  10
  11 # Common files
  12
  13 * regspec.py: the register specification API.  used by each pipe_data.py
  14 * pipe_data.py: base class for pipeline pipe_data.py data structures
  15 * common_input_stage.py: functionality common to input stages (RA, RB)
  16 * common_output_stage.py: functionality common to output stages (SO, CA/32 etc.)