(no commit message)
[libreriscv.git] / HDL_workflow / ls2.mdwn
index ceb844babc717b94055134e4d280c59c47e19c59..edcd3eb9b1cc85460b055c915e745bae11e110de 100644 (file)
@@ -1,18 +1,24 @@
 # Steps for Hello World Microwatt ls2 for fpga/boards 
 
 * Currently works for Arty A7-100t, VERSA_ECP5 and in future others
-
 * Bugzilla page <https://bugs.libre-soc.org/show_bug.cgi?id=802>
+* NGI POINTER  <https://bugs.libre-soc.org/show_bug.cgi?id=818>
 
-## Install Instructions
+# Install Instructions
 
+    # devscripts
     git clone https://git.libre-soc.org/git/dev-env-setup.git
     cd dev-env-setup
     sudo bash
     ./mk-deb-chroot ls2-hello-world
     ./cp-scripts-to-chroot ls2-hello-world
+    exit # back to user
+
     schroot -c ls2-hello-world
+    sudo bash # helps define SUDO_USER in new chroot
     cd ~/dev-env-setup
+
+    # install dependencies in new chroot
     ./install-hdl-apt-reqs
     ./hdl-dev-repos
     ./hdl-tools-yosys
     export XRAY_DIR=/usr/local/nextpnr-xilinx
     ./hdl-dev-ls2
     cd ~/src
+
+    # make hello_world.bin from microwatt
     cd tercel-qspi/
     cd hello_world/
     make
     cp hello_world.bin ../../ls2
     cd ../..
 
-    pip3 install textx
-
-    # somehow pip3 install of fasm fails, so we manually install
-
-    apt-get install -y wget
-    wget https://files.pythonhosted.org/packages/78/4c/94fb3bdb87bea21406c0e5da375f0b10d7b1e4b5103cea453a2de23b5d61/fasm-0.0.2.post88.tar.gz
-    cd fasm-0.0.2.post88
-    python3 setup.py install
-    cd ..
-
+    # make the Libre-SOC core (for external use)
     cd soc
-
-    # pip3 may install newer nmigen from repo which may cause error
-    # in next step. If so you can run "python3 setup.py develop"
-    # in nmigen source directory.
-
     make microwatt_external_core
     cp external_core_top.v ../ls2
+
+    # check out ls2 peripheral framework
     cd ../ls2
     git checkout 426e2d9585cd4b1fb96a38987f97878285ee5ba7
 
     # plug in FPGA board (Arty A7-100t, VERSA_ECP5, other)
     # run in 2nd terminal "minicom -D /dev/ttyUSB1"
 
-    python3 src/ls2.py arty_a7 hello_world.bin
+    python3 src/ls2.py arty_a7 hello_world.bin    # for Arty A7-100t
+    python3 src/ls2.py versa_ecp5 hello_world.bin # (for a VERSA_ECP5)
+
+This directly programs a tmp bitstream using xc3sprog to nexys4 board.
+If needed modify sources to produce a fixed file bitstream and
+
+    copy build/top.bit to board/server (scp, rsync)
+    minicom -D /dev/ttyUSB1
+    xc3sprog -c nexys4 top.bit
+
+# Using ls2 with microwatt
+
+This is doable but tricky.  An older version is required at present.
+
+    git clone https://git.libre-soc.org/git/microwatt.git
+    git checkout microwatt_verilator
+    make microwatt.v
+
+From there, some hand-editing is required.  search for core_NNNNNNN_XXX_YYY
+and rename it to external_core_top. Save the file as external_core_top.v
+and it can be used in place of the Libre-SOC Core, above.
+
+In fact any core can be used with ls, as long as it is compliant with
+the interfaces.  Both Wishbone Interfaces must be WB4 Pipeline
+compliant (proper stall handling) or the stall signal faked externally
+with a wrapper: `stall=stb&~ack`
+
+# Using ls2 with verilator
+
+first you need to build hello_world (or any other firmware) to start at 
+0xff000000. Then you can run build ls.v using that firmware:
+
+    python3 src/ls2.py sim /tmp/ff000000_hw.bin
+
+The output of that command is:
+
+    platform sim /tmp/ff000000_hw.bin None
+    fpga sim firmware /tmp/ff000000_hw.bin
+    ddr pins None
+    spiflash pins None
+    ethmac pins None
+    hyperram pins [<lambdasoc.periph.hyperram.HyperRAMPads object at 0x735e9940dd30>]
+    fw at address ff000000
+    SRAM 0x8000 at address 0x0
 
-* this directly programs a tmp bitstream using xc3sprog to nexys4 board
-* If needed modify sources to produce a fixed file bitstream and
-* cp top.bit to board/server
-* xc3sprog -c nexys4 top.bit
-* minicom -D /dev/ttyUSB1
+After that you can compile microwatt-verilator:
 
-* Or python3 src/ls2.py versa_ecp5 hello_world.bin (for a VERSA_ECP5)
+       export FPGA_TARGET=verilator
+       make microwatt-verilator