summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorZachary T Welch <zw@superlucidity.net>2009-11-07 21:20:45 -0800
committerZachary T Welch <zw@superlucidity.net>2009-11-16 01:38:19 -0800
commit555757175eb344d11f3c0123f2f83460ef6ca67b (patch)
tree4a08968050dba7f2b20651d3c9a6752c310c6530 /doc
parentda4cb3c029e7f271ee4fa7165ceefbef04d45e49 (diff)
downloadopenocd_libswd-555757175eb344d11f3c0123f2f83460ef6ca67b.tar.gz
openocd_libswd-555757175eb344d11f3c0123f2f83460ef6ca67b.tar.bz2
openocd_libswd-555757175eb344d11f3c0123f2f83460ef6ca67b.tar.xz
openocd_libswd-555757175eb344d11f3c0123f2f83460ef6ca67b.zip
Add 'nand verify' command
Add the 'nand verify' command to perform a dump and fake-write simultaneously, checking the read bits against those generated by the write process. Appropriate user documentation for this command has been added to the user guide as well. The algorithm presently makes a relatively naive comparison. Some chips that use ECC may not verify correctly using this implementation, but the new documentation provides details about this limitation.
Diffstat (limited to 'doc')
-rw-r--r--doc/openocd.texi26
1 files changed, 26 insertions, 0 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi
index bb96a2e6..81409acc 100644
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -4620,6 +4620,32 @@ the underlying driver from applying hardware ECC.
@end itemize
@end deffn
+@deffn Command {nand verify} num filename offset [option...]
+@cindex NAND verification
+@cindex NAND programming
+Verify the binary data in the file has been programmed to the
+specified NAND device, starting at the specified offset.
+The @var{num} parameter is the value shown by @command{nand list}.
+
+Use a complete path name for @var{filename}, so you don't depend
+on the directory used to start the OpenOCD server.
+
+The @var{offset} must be an exact multiple of the device's page size.
+All data in the file will be read and compared to the contents of the
+flash, assuming it doesn't run past the end of the device.
+As with @command{nand write}, only full pages are verified, so any extra
+space in the last page will be filled with 0xff bytes.
+
+The same @var{options} accepted by @command{nand write},
+and the file will be processed similarly to produce the buffers that
+can be compared against the contents produced from @command{nand dump}.
+
+@b{NOTE:} This will not work when the underlying NAND controller
+driver's @code{write_page} routine must update the OOB with a
+hardward-computed ECC before the data is written. This limitation may
+be removed in a future release.
+@end deffn
+
@section Other NAND commands
@cindex NAND other commands