Documentation/index.mdwn

   1 # Documentation
   2
   3 ## Codebase Structure
   4
   5 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.
   6
   7 | Git Repo | Documentation | Description
   8 |----------|---------------|---------------|
   9 | [SOC](https://git.libre-soc.org/?p=soc.git;a=tree) | [[SOC Docs|3d_gpu/architecture]] | Main POWER9 GPU |
  10 | [FPU](https://git.libre-soc.org/?p=ieee754fpu.git;a=tree) | -- | Equivalent to hardfloat-3 |
  11 | [nmutil](https://git.libre-soc.org/?p=nmutil.git;a=tree) | -- | Equivalent to Chisel3.util |
  12
  13 ## Installing the Codebase
  14
  15     pip3 install virtualenv requests
  16     mkdir ~/.virtualenvs && cd ~/.virtualenvs
  17     python3 -m venv libresoc
  18     source ~/.virtualenvs/libresoc/bin/activate
  19
  20     cd ~; mkdir libresoc; cd libresoc
  21     git clone https://git.libre-soc.org/git/nmutil.git
  22     git clone https://git.libre-soc.org/git/ieee754fpu.git
  23     git clone https://git.libre-soc.org/git/soc.git
  24
  25     cd nmutil; make install; cd ..
  26     cd ieee754fpu; make install; cd ..
  27     cd soc; make gitupdate; make install; cd ..
  28
  29     python3 soc/src/soc/decoder/power_decoder.py
  30     yosys -p "read_ilang decoder.il; show dec31"