Documentation/index.mdwn

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