zcy
/
tinyriscv-openocd
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: remove references to "ocd_" prefixed commands 

The commands prefixed with "ocd_" are removed.
Remove any reference in the documentation.

Change-Id: I27cebaa4752752ec8700757bf1c98b267c24f15b
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: http://openocd.zylin.com/5088
Reviewed-by: Tomas Vanek <vanekt@fbl.cz>
Tested-by: jenkins
bscan_optimization
Antonio Borneo 2019-03-28 12:14:56 +01:00 committed by Tomas Vanek
parent 9eea9cce3f
commit 24bfdf53fd
1 changed files with 6 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/openocd.texi
View File

@ -4926,7 +4926,6 @@ Use it in board specific configuration files, not interactively.
@end quotation @end quotation
@end deffn @end deffn
@comment the REAL name for this command is "ocd_flash_banks"
@comment less confusing would be: "flash list" (like "nand list") @comment less confusing would be: "flash list" (like "nand list")
@deffn Command {flash banks} @deffn Command {flash banks}
Prints a one-line summary of each device that was Prints a one-line summary of each device that was
@ -9534,13 +9533,12 @@ The following commands can be used to authenticate to a RISC-V system. Eg. a
trivial challenge-response protocol could be implemented as follows in a trivial challenge-response protocol could be implemented as follows in a
configuration file, immediately following @command{init}: configuration file, immediately following @command{init}:
@example @example
set challenge [ocd_riscv authdata_read] set challenge [riscv authdata_read]
riscv authdata_write [expr $challenge + 1] riscv authdata_write [expr $challenge + 1]
@end example @end example
@deffn Command {riscv authdata_read} @deffn Command {riscv authdata_read}
Return the 32-bit value read from authdata. Note that to get read value back in Return the 32-bit value read from authdata.
a TCL script, it needs to be invoked as @command{ocd_riscv authdata_read}.
@end deffn @end deffn
@deffn Command {riscv authdata_write} value @deffn Command {riscv authdata_write} value
@ -9553,9 +9551,7 @@ The following commands allow direct access to the Debug Module Interface, which
can be used to interact with custom debug features. can be used to interact with custom debug features.
@deffn Command {riscv dmi_read} @deffn Command {riscv dmi_read}
Perform a 32-bit DMI read at address, returning the value. Note that to get Perform a 32-bit DMI read at address, returning the value.
read value back in a TCL script, it needs to be invoked as @command{ocd_riscv
dmi_read}.
@end deffn @end deffn
@deffn Command {riscv dmi_write} address value @deffn Command {riscv dmi_write} address value
@ -10439,10 +10435,6 @@ should be passed in to the proc in question.
By "low-level," we mean commands that a human would typically not By "low-level," we mean commands that a human would typically not
invoke directly. invoke directly.
Some low-level commands need to be prefixed with "ocd_"; e.g.
@command{ocd_flash_banks}
is the low-level API upon which @command{flash banks} is implemented.
@itemize @bullet @itemize @bullet
@item @b{mem2array} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}> @item @b{mem2array} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
@ -10450,7 +10442,7 @@ Read memory and return as a Tcl array for script processing
@item @b{array2mem} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}> @item @b{array2mem} <@var{varname}> <@var{width}> <@var{addr}> <@var{nelems}>
Convert a Tcl array to memory locations and write the values Convert a Tcl array to memory locations and write the values
@item @b{ocd_flash_banks} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> <@var{target}> [@option{driver options} ...] @item @b{flash banks} <@var{driver}> <@var{base}> <@var{size}> <@var{chip_width}> <@var{bus_width}> <@var{target}> [@option{driver options} ...]
Return information about the flash banks Return information about the flash banks
@ -10509,8 +10501,8 @@ interpreter terminating it with @code{0x1a} and wait for the return
value (it will be terminated with @code{0x1a} as well). This can be value (it will be terminated with @code{0x1a} as well). This can be
repeated as many times as desired without reopening the connection. repeated as many times as desired without reopening the connection.
Remember that most of the OpenOCD commands need to be prefixed with It is not needed anymore to prefix the OpenOCD commands with
@code{ocd_} to get the results back. Sometimes you might also need the @code{ocd_} to get the results back. But sometimes you might need the
@command{capture} command. @command{capture} command.
See @file{contrib/rpc_examples/} for specific client implementations. See @file{contrib/rpc_examples/} for specific client implementations.