Skip to content

Commit b8735bb

Browse files
committed
doc: fix riscv commands
- Fix the declaration of riscv command 'set_mem_access'. - Remove non existing riscv command 'set_scratch_ram'. - Add riscv commands 'info', 'reset_delays'; copy the description from the 'help' text. - Don't add riscv commands 'set_prefer_sba' and 'test_sba_config_reg' as they are marked as deprecated. - Ensure that 'test_sba_config_reg' prints a deprecation warning when used. Change-Id: I39dc3aec4e7f13b69ac19685f1b593790acdde83 Signed-off-by: Antonio Borneo <[email protected]> Signed-off-by: Jan Matyas <[email protected]> Reviewed-on: https://review.openocd.org/c/openocd/+/7268 Reviewed-by: Tim Newsome <[email protected]> Tested-by: jenkins
1 parent 1f7d58d commit b8735bb

File tree

2 files changed

+14
-6
lines changed

2 files changed

+14
-6
lines changed

doc/openocd.texi

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10649,6 +10649,16 @@ $_TARGETNAME expose_custom 32=myregister
1064910649
@end example
1065010650
@end deffn
1065110651

10652+
@deffn {Command} {riscv info}
10653+
Displays some information OpenOCD detected about the target.
10654+
@end deffn
10655+
10656+
@deffn {Command} {riscv reset_delays} [wait]
10657+
OpenOCD learns how many Run-Test/Idle cycles are required between scans to avoid
10658+
encountering the target being busy. This command resets those learned values
10659+
after `wait` scans. It's only useful for testing OpenOCD itself.
10660+
@end deffn
10661+
1065210662
@deffn {Command} {riscv set_command_timeout_sec} [seconds]
1065310663
Set the wall-clock timeout (in seconds) for individual commands. The default
1065410664
should work fine for all but the slowest targets (eg. simulators).
@@ -10659,12 +10669,7 @@ Set the maximum time to wait for a hart to come out of reset after reset is
1065910669
deasserted.
1066010670
@end deffn
1066110671

10662-
@deffn {Command} {riscv set_scratch_ram} none|[address]
10663-
Set the address of 16 bytes of scratch RAM the debugger can use, or 'none'.
10664-
This is used to access 64-bit floating point registers on 32-bit targets.
10665-
@end deffn
10666-
10667-
@deffn Command {riscv set_mem_access} method1 [method2] [method3]
10672+
@deffn {Command} {riscv set_mem_access} method1 [method2] [method3]
1066810673
Specify which RISC-V memory access method(s) shall be used, and in which order
1066910674
of priority. At least one method must be specified.
1067010675

src/target/riscv/riscv.c

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2744,6 +2744,9 @@ COMMAND_HANDLER(riscv_dmi_write)
27442744

27452745
COMMAND_HANDLER(riscv_test_sba_config_reg)
27462746
{
2747+
LOG_WARNING("Command \"riscv test_sba_config_reg\" is deprecated. "
2748+
"It will be removed in a future OpenOCD version.");
2749+
27472750
if (CMD_ARGC != 4) {
27482751
LOG_ERROR("Command takes exactly 4 arguments");
27492752
return ERROR_COMMAND_SYNTAX_ERROR;

0 commit comments

Comments
 (0)