summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorH. Peter Anvin <hpa@zytor.com>2011-06-07 07:04:08 (GMT)
committerH. Peter Anvin <hpa@zytor.com>2011-06-07 07:04:08 (GMT)
commit58cb650d586b305f4d5a1bf6630fc4755e3c1d63 (patch)
tree3bbdd9c5d9e993ef601fc865888214ecebc2fa36
parente9c700c69e5d8e53c386a051a96ac5935b6efeaa (diff)
downloadde1flash-58cb650d586b305f4d5a1bf6630fc4755e3c1d63.zip
de1flash-58cb650d586b305f4d5a1bf6630fc4755e3c1d63.tar.gz
de1flash-58cb650d586b305f4d5a1bf6630fc4755e3c1d63.tar.bz2
de1flash-58cb650d586b305f4d5a1bf6630fc4755e3c1d63.tar.xz
README: update documentation to define the filespec syntaxde1flash-1.0
Update with the filespec syntax and new commands.
-rw-r--r--README31
1 files changed, 22 insertions, 9 deletions
diff --git a/README b/README
index df7a67e..285282d 100644
--- a/README
+++ b/README
@@ -42,18 +42,31 @@ Usage:
quartus_pgm -m jtag -o 'p;de1flash.sof'
# Second, execute either of these commands
- quartus_stp -t de1flash.tcl read filename [length]
- quartus_stp -t de1flash.tcl write filename [length]
+ quartus_stp -t de1flash.tcl read filespec...
+ quartus_stp -t de1flash.tcl write filespec...
+ quartus_stp -t de1flash.tcl writeonly filespec...
+ quartus_stp -t de1flash.tcl erase filespec...
quartus_stp -t de1flash.tcl eraseall
-It is NOT necessary to erase before writing; the utility will
-automatically erase any sectors that are being written (but not any
-other sectors.) The "eraseall" command is available to clear out the
-entire flash.
+The "write" command is equivalent to the "erase" command followed by
+the "writeonly" command. Therefore it is NOT necessary to issue an
+explicit erase before writing; the utility will automatically erase
+any sectors that are being written (but not any other sectors.) The
+"eraseall" command is available to clear out the entire flash. The
+utility will not erase any sectors that are already blank.
-Both the "write" and the "eraseall" commands automatically skip
-erasing any sectors that are already blank.
+A "filespec" is of the following form:
+
+ [filename][@[address][,length]]
+
+The default starting address is 0 for the first file and whatever byte
+follows the previous file for subsequent files; the default length is
+the length of the file for write or erase commands or the total size
+of the flash for read commands.
+
+A filespec without a filename is ignored (except for computing the
+next default address) for the read and writeonly commands and means
+"erase only" for the write and erase commands.
Reads are substantially slower than writes. This appears to be a
limitation of the Altera JTAG stack.
-