NOR: User's Guide updates

Remove long-obsolete text about "erase_check" affecting "flash info" output.
Move parts of that text to "protect_check", where it's still relevant; and
update the "flash info" description to mention the issue.

(This is still awkward.  It might be best to make "protect_check" mirror
"erase_check" by dumping what it finds, so "flash info" doesn't dump any
potentially-stale cache info.)

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
This commit is contained in:
David Brownell 2010-02-02 10:53:13 -08:00
parent cc440ca1d4
commit 5750e899e0
1 changed files with 5 additions and 6 deletions

View File

@ -4033,17 +4033,14 @@ it has been removed by the @option{unlock} flag.
Check erase state of sectors in flash bank @var{num}, Check erase state of sectors in flash bank @var{num},
and display that status. and display that status.
The @var{num} parameter is a value shown by @command{flash banks}. The @var{num} parameter is a value shown by @command{flash banks}.
This is the only operation that
updates the erase state information displayed by @option{flash info}. That means you have
to issue a @command{flash erase_check} command after erasing or programming the device
to get updated information.
(Code execution may have invalidated any state records kept by OpenOCD.)
@end deffn @end deffn
@deffn Command {flash info} num @deffn Command {flash info} num
Print info about flash bank @var{num} Print info about flash bank @var{num}
The @var{num} parameter is a value shown by @command{flash banks}. The @var{num} parameter is a value shown by @command{flash banks}.
The information includes per-sector protect status. The information includes per-sector protect status, which may be
incorrect (outdated) unless you first issue a
@command{flash protect_check num} command.
@end deffn @end deffn
@anchor{flash protect} @anchor{flash protect}
@ -4060,6 +4057,8 @@ The @var{num} parameter is a value shown by @command{flash banks}.
Check protection state of sectors in flash bank @var{num}. Check protection state of sectors in flash bank @var{num}.
The @var{num} parameter is a value shown by @command{flash banks}. The @var{num} parameter is a value shown by @command{flash banks}.
@comment @option{flash erase_sector} using the same syntax. @comment @option{flash erase_sector} using the same syntax.
This updates the protection information displayed by @option{flash info}.
(Code execution may have invalidated any state records kept by OpenOCD.)
@end deffn @end deffn
@anchor{Flash Driver List} @anchor{Flash Driver List}