aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAustin Seipp <aseipp@pobox.com>2019-01-11 15:55:56 -0600
committerAustin Seipp <aseipp@pobox.com>2019-01-11 16:09:07 -0600
commit770b5bd4c6e9383e840319c69a64dfb47be833d4 (patch)
tree51615009935b3e7bbf1777bb02ef0a73bce4d879
parent13a9edf12251049b2c64746a5e76b9ede7ee6b31 (diff)
downloadpicorv32-770b5bd4c6e9383e840319c69a64dfb47be833d4.tar.gz
picorv32-770b5bd4c6e9383e840319c69a64dfb47be833d4.zip
scripts/icestorm: add readme
Notes about how to build proper simulation vs hardware bitstreams. Signed-off-by: Austin Seipp <aseipp@pobox.com>
-rw-r--r--scripts/icestorm/readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/scripts/icestorm/readme.md b/scripts/icestorm/readme.md
new file mode 100644
index 0000000..101391f
--- /dev/null
+++ b/scripts/icestorm/readme.md
@@ -0,0 +1,12 @@
+To build the example LED-blinking firmware for an HX8K Breakout Board and get
+a timing report (checked against the default 12MHz oscillator):
+
+ $ make clean example.bin timing
+
+To run all the simulation tests:
+
+ $ make clean example_sim synth_sim route_sim FIRMWARE_COUNTER_BITS=4
+
+(You must run the `clean` target to rebuild the firmware with the updated
+`FIRMWARE_COUNTER_BITS` parameter; the firmware source must be recompiled for
+simulation vs hardware, but this is not tracked as a Makefile dependency.)