Add Tercel PHY reset synchronization

[microwatt.git] / README.md

diff --git a/README.md b/README.md
index 86e9e2265754d20044e4e8ee422d54184e82e97e..e11e56f3ecf4b48e211638448cd4578ba3fb5e8c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,30 +16,58 @@ You can try out Microwatt/Micropython without hardware by using the ghdl simulat
 
 - Build micropython. If you aren't building on a ppc64le box you
   will need a cross compiler. If it isn't available on your distro
-  grab the powerpc64le-power8 toolchain from https://toolchains.bootlin.com
+  grab the powerpc64le-power8 toolchain from https://toolchains.bootlin.com.
+  You may need to set the CROSS_COMPILE environment variable
+  to the prefix used for your cross compilers.  The default is
+  powerpc64le-linux-gnu-.
 
 ```
-git clone https://github.com/mikey/micropython
+git clone https://github.com/micropython/micropython.git
 cd micropython
-git checkout powerpc
 cd ports/powerpc
 make -j$(nproc)
 cd ../../../
 ```
 
+  A prebuilt micropython image is also available in the micropython/ directory.
+
 - Microwatt uses ghdl for simulation. Either install this from your
-  distro or build it. Next build microwatt:
+  distro or build it. Microwatt requires ghdl to be built with the LLVM
+  or gcc backend, which not all distros do (Fedora does, Debian/Ubuntu
+  appears not to). ghdl with the LLVM backend is likely easier to build.
+
+  If building ghdl from scratch is too much for you, the microwatt Makefile
+  supports using Docker or Podman.
+
+- Next build microwatt:
 
 ```
 git clone https://github.com/antonblanchard/microwatt
 cd microwatt
 make
+```
+
+   To build using Docker:
+```
+make DOCKER=1
+```
+
+   and to build using Podman:
+
+```
+make PODMAN=1
 ```
 
 - Link in the micropython image:
 
 ```
-ln -s ../micropython/ports/powerpc/build/firmware.bin simple_ram_behavioural.bin
+ln -s ../micropython/ports/powerpc/build/firmware.bin main_ram.bin
+```
+
+  Or if you were using the pre-built image:
+
+```
+ln -s micropython/firmware.bin main_ram.bin
 ```
 
 - Now run microwatt, sending debug output to /dev/null:
@@ -63,6 +91,11 @@ source /opt/Xilinx/Vivado/2019.1/settings64.sh
 ```
 pip3 install --user -U fusesoc
 ```
+Fedora users can get FuseSoC package via
+```
+sudo dnf copr enable sharkcz/danny
+sudo dnf install fusesoc
+```
 
 - Create a working directory and point FuseSoC at microwatt:
 
@@ -75,9 +108,9 @@ fusesoc library add microwatt /path/to/microwatt/
 - Build using FuseSoC. For hello world (Replace nexys_video with your FPGA board such as --target=arty_a7-100):
 
 ```
-fusesoc run --target=nexys_video microwatt --memory_size=8192 --ram_init_file=/path/to/microwatt/fpga/hello_world.hex
+fusesoc run --target=nexys_video microwatt --memory_size=16384 --ram_init_file=/path/to/microwatt/fpga/hello_world.hex
 ```
-You should then be able to see output via the serial port of the board (/dev/ttyUSB1, 115200 for example assuming standard clock speeds). There is a know bug where initial output may not be sent - try the reset (not programming button on your board if you don't see anything.
+You should then be able to see output via the serial port of the board (/dev/ttyUSB1, 115200 for example assuming standard clock speeds). There is a know bug where initial output may not be sent - try the reset (not programming button) on your board if you don't see anything.
 
 - To build micropython (currently requires 1MB of BRAM eg an Artix-7 A200):