ARM720: help/usage updates

Deprecate the "pass an instruction opcode" flavor of cp15 access
in favor of the "arm mcr ..." and "arm mrc ..." commands, which
offer fewer ways to break things.

Use the same EBNF syntax in the code as for the user's guide.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>

diff --git a/doc/openocd.texi b/doc/openocd.texi
index a6fb97071759959efbb3bc6dac1c39cb3a9e10f2..ea23bf722a1887746edb9c4bf9b30e64d0070986 100644 (file)
--- a/doc/openocd.texi
+++ b/doc/openocd.texi
@@ -5921,9 +5921,13 @@ which are implementations of the ARMv4T architecture
 based on the ARM7TDMI-S integer core.
 They are available in addition to the ARM and ARM7/ARM9 commands.
 
-@deffn Command {arm720t cp15} regnum [value]
-Display cp15 register @var{regnum};
+@deffn Command {arm720t cp15} opcode [value]
+@emph{DEPRECATED -- avoid using this.
+Use the @command{arm mrc} or @command{arm mcr} commands instead.}
+
+Display cp15 register returned by the ARM instruction @var{opcode};
 else if a @var{value} is provided, that value is written to that register.
+The @var{opcode} should be the value of either an MRC or MCR instruction.
 @end deffn
 
 @subsection ARM9 specific commands

diff --git a/src/target/arm720t.c b/src/target/arm720t.c
index 84c66b8d8a877e5540fff4a64e4d8dfd3a63cd7b..2f516997420b5eec3c9f728a477cf30360bdb544 100644 (file)
--- a/src/target/arm720t.c
+++ b/src/target/arm720t.c
@@ -516,8 +516,10 @@ static const struct command_registration arm720t_exec_command_handlers[] = {
                .name = "cp15",
                .handler = arm720t_handle_cp15_command,
                .mode = COMMAND_EXEC,
-               .usage = "<opcode> [value]",
-               .help = "display/modify cp15 register",
+               /* prefer using less error-prone "arm mcr" or "arm mrc" */
+               .help = "display/modify cp15 register using ARM opcode"
+                       " (DEPRECATED)",
+               .usage = "instruction [value]",
        },
        COMMAND_REGISTRATION_DONE
 };