ARM ETM/ETB/trace: help/usage updates

Provide helptext which was sometimes missing; update some of it
to be more accurate.

Usage syntax messages have the same EBNF as the User's Guide;
no angle brackets in either place.

Don't use "&function"; functions are like arrays, their address
is their name.  Shrink some overlong lines, remove some empties.

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

diff --git a/src/target/etb.c b/src/target/etb.c
index fb2dd60995de25bb98ba887b6d67f414ce7b5c83..18258f6acc793238f4574963978943d04a8d000e 100644 (file)
--- a/src/target/etb.c
+++ b/src/target/etb.c
@@ -447,17 +447,21 @@ COMMAND_HANDLER(handle_etb_trigger_percent_command)
 
 static const struct command_registration etb_config_command_handlers[] = {
        {
+               /* NOTE:  with ADIv5, ETBs are accessed using DAP operations,
+                * possibly over SWD, not through separate TAPs...
+                */
                .name = "config",
-               .handler = &handle_etb_config_command,
+               .handler = handle_etb_config_command,
                .mode = COMMAND_CONFIG,
+               .help = "Associate ETB with target and JTAG TAP.",
                .usage = "target tap",
        },
        {
                .name = "trigger_percent",
-               .handler = &handle_etb_trigger_percent_command,
+               .handler = handle_etb_trigger_percent_command,
                .mode = COMMAND_EXEC,
-               .help = "percent of trace buffer to be filled "
-                       "after the trigger occurs",
+               .help = "Set percent of trace buffer to be filled "
+                       "after the trigger occurs (2..100).",
                .usage = "[percent]",
        },
        COMMAND_REGISTRATION_DONE

diff --git a/src/target/etm.c b/src/target/etm.c
index d22bc4070a6bc8086fc4f628fd2449cf6c273618..3126efc2f211f597be37d5bc6b1572005f399238 100644 (file)
--- a/src/target/etm.c
+++ b/src/target/etm.c
@@ -1259,12 +1259,16 @@ COMMAND_HANDLER(handle_etm_tracemode_command)
        case 0:
                break;
        case 4:
-               CALL_COMMAND_HANDLER(handle_etm_tracemode_command_update, &tracemode);
+               CALL_COMMAND_HANDLER(handle_etm_tracemode_command_update,
+                               &tracemode);
                break;
        default:
-               command_print(CMD_CTX, "usage: configure trace mode "
-                               "<none | data | address | all> "
-                               "<context id bits> <cycle accurate> <branch output>");
+               command_print(CMD_CTX, "usage: tracemode "
+                               "('none'|'data'|'address'|'all') "
+                               "context_id_bits "
+                               "('enable'|'disable') "
+                               "('enable'|'disable')"
+                               );
                return ERROR_FAIL;
        }
 
@@ -2112,11 +2116,16 @@ COMMAND_HANDLER(handle_etm_analyze_command)
 
 static const struct command_registration etm_config_command_handlers[] = {
        {
+               /* NOTE:  with ADIv5, ETMs are accessed by DAP operations,
+                * possibly over SWD, not JTAG scanchain 6 of 'target'.
+                *
+                * Also, these parameters don't match ETM v3+ modules...
+                */
                .name = "config",
-               .handler = &handle_etm_config_command,
+               .handler = handle_etm_config_command,
                .mode = COMMAND_CONFIG,
-               .usage = "<target> <port_width> <port_mode> "
-                       "<clocking> <capture_driver>",
+               .help = "Set up ETM output port.",
+               .usage = "target port_width port_mode clocking capture_driver",
        },
        COMMAND_REGISTRATION_DONE
 };
@@ -2132,33 +2141,36 @@ const struct command_registration etm_command_handlers[] = {
 
 static const struct command_registration etm_exec_command_handlers[] = {
        {
-               .name = "tracemode", handle_etm_tracemode_command,
+               .name = "tracemode",
+               .handler = handle_etm_tracemode_command,
                .mode = COMMAND_EXEC,
                .help = "configure/display trace mode",
-               .usage = "<none | data | address | all> "
-                       "<context_id_bits> <cycle_accurate> <branch_output>",
+               .usage = "('none'|'data'|'address'|'all') "
+                       "context_id_bits "
+                       "['enable'|'disable'] "
+                       "['enable'|'disable']",
        },
        {
                .name = "info",
-               .handler = &handle_etm_info_command,
+               .handler = handle_etm_info_command,
                .mode = COMMAND_EXEC,
                .help = "display info about the current target's ETM",
        },
        {
                .name = "status",
-               .handler = &handle_etm_status_command,
+               .handler = handle_etm_status_command,
                .mode = COMMAND_EXEC,
                .help = "display current target's ETM status",
        },
        {
                .name = "start",
-               .handler = &handle_etm_start_command,
+               .handler = handle_etm_start_command,
                .mode = COMMAND_EXEC,
                .help = "start ETM trace collection",
        },
        {
                .name = "stop",
-               .handler = &handle_etm_stop_command,
+               .handler = handle_etm_stop_command,
                .mode = COMMAND_EXEC,
                .help = "stop ETM trace collection",
        },
@@ -2167,7 +2179,7 @@ static const struct command_registration etm_exec_command_handlers[] = {
                .handler = handle_etm_trigger_debug_command,
                .mode = COMMAND_EXEC,
                .help = "enable/disable debug entry on trigger",
-               .usage = "(enable | disable)",
+               .usage = "['enable'|'disable']",
        },
        {
                .name = "analyze",
@@ -2177,19 +2189,21 @@ static const struct command_registration etm_exec_command_handlers[] = {
        },
        {
                .name = "image",
-               .handler = &handle_etm_image_command,
+               .handler = handle_etm_image_command,
                .mode = COMMAND_EXEC,
-               .help = "load image from <file> [base address]",
+               .help = "load image from file with optional offset",
+               .usage = "filename [offset]",
        },
        {
                .name = "dump",
-               .handler = &handle_etm_dump_command,
+               .handler = handle_etm_dump_command,
                .mode = COMMAND_EXEC,
-               .help = "dump captured trace data <file>",
+               .help = "dump captured trace data to file",
+               .usage = "filename",
        },
        {
                .name = "load",
-               .handler = &handle_etm_load_command,
+               .handler = handle_etm_load_command,
                .mode = COMMAND_EXEC,
                .help = "load trace data for analysis <file>",
        },

diff --git a/src/target/etm_dummy.c b/src/target/etm_dummy.c
index 19a078f13cf9a93672d18d1f7c74ea0796363acf..f9c6fe738080b415634aaa942d5dbe2092e51851 100644 (file)
--- a/src/target/etm_dummy.c
+++ b/src/target/etm_dummy.c
@@ -61,9 +61,9 @@ COMMAND_HANDLER(handle_etm_dummy_config_command)
 static const struct command_registration etm_dummy_config_command_handlers[] = {
        {
                .name = "config",
-               .handler = &handle_etm_dummy_config_command,
+               .handler = handle_etm_dummy_config_command,
                .mode = COMMAND_CONFIG,
-               .usage = "<target>",
+               .usage = "target",
        },
        COMMAND_REGISTRATION_DONE
 };

diff --git a/src/target/oocd_trace.c b/src/target/oocd_trace.c
index 2533c40d96d6386f09b2e010826f8c59cade7b5b..3b4357194372f71a215b954a08a56f63811626da 100644 (file)
--- a/src/target/oocd_trace.c
+++ b/src/target/oocd_trace.c
@@ -398,13 +398,13 @@ COMMAND_HANDLER(handle_oocd_trace_resync_command)
 static const struct command_registration oocd_trace_all_command_handlers[] = {
        {
                .name = "config",
-               .handler = &handle_oocd_trace_config_command,
+               .handler = handle_oocd_trace_config_command,
                .mode = COMMAND_CONFIG,
-               .usage = "<target>",
+               .usage = "target",
        },
        {
                .name = "status",
-               .handler = &handle_oocd_trace_status_command,
+               .handler = handle_oocd_trace_status_command,
                .mode = COMMAND_EXEC,
                .help = "display OpenOCD + trace status",
        },