diff options
author | zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60> | 2009-05-24 01:57:13 +0000 |
---|---|---|
committer | zwelch <zwelch@b42882b7-edfa-0310-969c-e2dbd0fdcd60> | 2009-05-24 01:57:13 +0000 |
commit | eb385b2e7086cd0bb97d99f8253ae16579394663 (patch) | |
tree | a1c22682f0785b277d373f1fc58c4556382f2add /doc | |
parent | c0fc8f93f1eabe8a4adfed7784b1416b257cf035 (diff) | |
download | openocd+libswd-eb385b2e7086cd0bb97d99f8253ae16579394663.tar.gz openocd+libswd-eb385b2e7086cd0bb97d99f8253ae16579394663.tar.bz2 openocd+libswd-eb385b2e7086cd0bb97d99f8253ae16579394663.tar.xz openocd+libswd-eb385b2e7086cd0bb97d99f8253ae16579394663.zip |
David Brownell <david-b@pacbell.net>:
Update two oddball NAND commands to work with {offset, length}
instead of block numbers, matching the other commands as well
as usage in U-Boot and the Linux-MTD utilities.
Document them accordingly. Update the single in-tree use of
those commands (sheevaplug).
ALSO:
(a) Document the current 2 GByte/chip ceiling for NAND chipsize.
(32 bit offset/length values can't represent 4 GBytes.) Maybe
after the upcoming release, the code can switch to 64-bits.
(b) The "nand check_bad_blocks" should report "bad" blocks. They
are not "invalid" blocks; they're "bad" ones.
(c) Tweak the "nand info" command to handle the "no arguments"
case sanely (show everything, instead of showing garbage) and
not listing the blocksize in hex kbytes (duh).
git-svn-id: svn://svn.berlios.de/openocd/trunk@1904 b42882b7-edfa-0310-969c-e2dbd0fdcd60
Diffstat (limited to 'doc')
-rw-r--r-- | doc/openocd.texi | 37 |
1 files changed, 33 insertions, 4 deletions
diff --git a/doc/openocd.texi b/doc/openocd.texi index 8cea8b0c..995d0ec2 100644 --- a/doc/openocd.texi +++ b/doc/openocd.texi @@ -2616,6 +2616,15 @@ boot loader, operating system, or other data needed to initialize or de-brick a board. @end enumerate +@b{NOTE:} At the time this text was written, the largest NAND +flash fully supported by OpenOCD is 2 GiBytes (16 GiBits). +This is because the variables used to hold offsets and lengths +are only 32 bits wide. +(Larger chips may work in some cases, unless an offset or length +is larger than 0xffffffff, the largest 32-bit unsigned integer.) +Some larger devices will work, since they are actually multi-chip +modules with two smaller chips and individual chipselect lines. + @section NAND Configuration Commands @cindex NAND configuration @@ -2702,9 +2711,19 @@ spare areas associated with each data page. @end itemize @end deffn -@deffn Command {nand erase} num ... +@deffn Command {nand erase} num offset length @cindex NAND erasing -@b{NOTE:} Syntax is in flux. +Erases blocks on the specified NAND device, starting at the +specified @var{offset} and continuing for @var{length} bytes. +Both of those values must be exact multiples of the device's +block size, and the region they specify must fit entirely in the chip. +The @var{num} parameter is the value shown by @command{nand list}. + +@b{NOTE:} This command will try to erase bad blocks, when told +to do so, which will probably invalidate the manufacturer's bad +block marker. +For the remainder of the current server session, @command{nand info} +will still report that the block ``is'' bad. @end deffn @deffn Command {nand write} num filename offset [option...] @@ -2768,8 +2787,18 @@ the underlying driver from applying hardware ECC. @section Other NAND commands @cindex NAND other commands -@deffn Command {nand check_bad} num ... -@b{NOTE:} Syntax is in flux. +@deffn Command {nand check_bad_blocks} [offset length] +Checks for manufacturer bad block markers on the specified NAND +device. If no parameters are provided, checks the whole +device; otherwise, starts at the specified @var{offset} and +continues for @var{length} bytes. +Both of those values must be exact multiples of the device's +block size, and the region they specify must fit entirely in the chip. +The @var{num} parameter is the value shown by @command{nand list}. + +@b{NOTE:} Before using this command you should force raw access +with @command{nand raw_access enable} to ensure that the underlying +driver will not try to apply hardware ECC. @end deffn @deffn Command {nand info} num |