From: Cole Poirier <colepoirier@gmail.com>
Date: Fri, 24 Jul 2020 20:49:46 +0000 (-0700)
Subject: Document in HDL_workflow how to build and install power_instruction_analyzer(pia)
X-Git-Tag: convert-csv-opcode-to-binary~2332
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=c30f4c6ef2a1552bb492930c390e5af53be3eb87;p=libreriscv.git

Document in HDL_workflow how to build and install power_instruction_analyzer(pia)
---

diff --git a/HDL_workflow.mdwn b/HDL_workflow.mdwn
index 80d0b0851..7e56590b0 100644
--- a/HDL_workflow.mdwn
+++ b/HDL_workflow.mdwn
@@ -395,6 +395,35 @@ Install gdb from source.  Obtain the latest tarball, unpack it, then:
      ../configure --srcdir=.. --host=x86_64-linux --target=powerpc64-linux-gnu
     make -j$(nproc)
     make install
+    
+## power_instruction_analyzer (pia)
+
+We have a custom tool built in rust by programmerjake to help analyze
+the power instructions execution on *actual* hardware.
+
+Install rust:
+
+    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+
+Make sure we have the correct and up-to-date rust compiler (rustc):
+
+    rustup default stable
+    rustup update
+
+Use rust's package manager *cargo* to install the rust-python build tool maturin:
+
+    cargo install maturin
+
+Install from git source by doing the following:
+
+    git clone https://salsa.debian.org/Kazan-team/power-instruction-analyzer.git pia
+    cd pia
+    maturin build --cargo-extra-args=--features=python-extension
+
+Get a root prompt by doing sudo bash then:
+
+    cd /home/USERNAME/src/pia
+    python3 -m pip install target/wheels/*.whl
 
 ## Coriolis2