Documentation/index.mdwn

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