Add Tercel PHY reset synchronization
[microwatt.git] / README.md
index 030a22e8abc36d2f568d87af387b3254f851b274..e11e56f3ecf4b48e211638448cd4578ba3fb5e8c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,7 +16,10 @@ 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/micropython/micropython.git
@@ -34,7 +37,7 @@ cd ../../../
   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 images. Read through the Makefile for details.
+  supports using Docker or Podman.
 
 - Next build microwatt:
 
@@ -42,6 +45,17 @@ cd ../../../
 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:
@@ -94,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):