docs.mdwn

   1 # Documentation
   2
   3 A draft version of the specification is available at
   4 <https://ftp.libre-soc.org/power-spec-draft.pdf>
   5
   6 ## Codebase Structure
   7
   8 The SOC is partitioned into three repositories. The subrepositories are
   9 intended as standalone projects useful outside of LibreSOC. For example,
  10 the IEE754 FPU repository is a general purpose IEEE754 toolkit for the
  11 construction of FSMs and arbitrary length pipelines.
  12
  13 | Git Repo | Documentation | Description
  14 |----------|---------------|---------------|
  15 | [SOC](https://git.libre-soc.org/?p=soc.git;a=tree) | [Libre-SOC](https://docs.libre-soc.org/soc/) | Main OpenPOWER Hybrid CPU-GPU |
  16 | [FPU](https://git.libre-soc.org/?p=ieee754fpu.git;a=tree) | -- | Equivalent to hardfloat-3 |
  17 | [nmutil](https://git.libre-soc.org/?p=nmutil.git;a=tree) | -- | Equivalent to Chisel3.util |
  18
  19 Also see [[SOC Architecture|3d_gpu/architecture]]
  20
  21 ## Installing the Codebase
  22
  23     pip3 install virtualenv requests
  24     mkdir ~/.virtualenvs && cd ~/.virtualenvs
  25     python3 -m venv libresoc
  26     source ~/.virtualenvs/libresoc/bin/activate
  27
  28     cd ~; mkdir libresoc; cd libresoc
  29     git clone https://git.libre-soc.org/git/nmutil.git
  30     git clone https://git.libre-soc.org/git/ieee754fpu.git
  31     git clone https://git.libre-soc.org/git/soc.git
  32
  33     cd nmutil; make install; cd ..
  34     cd ieee754fpu; make install; cd ..
  35     cd soc; make gitupdate; make install; cd ..
  36
  37     python3 soc/src/soc/decoder/power_decoder.py
  38     yosys -p "read_ilang decoder.il; show dec31"
  39
  40 ## Gtkwave Tutorial
  41
  42 [[docs/gtkwave_tutorial]]
  43
  44 ## Formal proof notes
  45
  46 [[docs/notes_on_formal_proofs]]