help text: remove trailing space
[fw/openocd] / src / jtag / tcl.c
index e32f0ca078ceb2436568a9b5f699539996fd2c85..5dc2f14f678d931d6347d86665cd6b230e4d9a8e 100644 (file)
@@ -108,8 +108,6 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args
 
        endstate = TAP_IDLE;
 
-       script_debug(interp, "drscan", argc, args);
-
        /* validate arguments as numbers */
        e = JIM_OK;
        for (i = 2; i < argc; i += 2) {
@@ -194,6 +192,11 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args
        retval = jtag_execute_queue();
        if (retval != ERROR_OK) {
                Jim_SetResultString(interp, "drscan: jtag execute failed", -1);
+
+               for (i = 0; i < field_count; i++)
+                       free(fields[i].in_value);
+               free(fields);
+
                return JIM_ERR;
        }
 
@@ -204,7 +207,7 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args
                char *str;
 
                Jim_GetLong(interp, args[i], &bits);
-               str = buf_to_str(fields[field_count].in_value, bits, 16);
+               str = buf_to_hex_str(fields[field_count].in_value, bits);
                free(fields[field_count].in_value);
 
                Jim_ListAppendElement(interp, list, Jim_NewStringObj(interp, str, strlen(str)));
@@ -229,8 +232,6 @@ static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *ar
                return JIM_ERR;
        }
 
-       script_debug(interp, "pathmove", argc, args);
-
        int i;
        for (i = 0; i < argc-1; i++) {
                const char *cp;
@@ -261,8 +262,6 @@ static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *ar
 
 static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args)
 {
-       script_debug(interp, "flush_count", argc, args);
-
        Jim_SetResult(interp, Jim_NewIntObj(interp, jtag_get_flush_queue_count()));
 
        return JIM_OK;
@@ -307,11 +306,13 @@ static const struct command_registration jtag_command_handlers_to_move[] = {
 
 
 enum jtag_tap_cfg_param {
-       JCFG_EVENT
+       JCFG_EVENT,
+       JCFG_IDCODE,
 };
 
 static Jim_Nvp nvp_config_opts[] = {
        { .name = "-event",      .value = JCFG_EVENT },
+       { .name = "-idcode",     .value = JCFG_IDCODE },
 
        { .name = NULL,          .value = -1 }
 };
@@ -404,8 +405,23 @@ static int jtag_tap_configure_cmd(Jim_GetOptInfo *goi, struct jtag_tap *tap)
                                if (e != JIM_OK)
                                        return e;
                                break;
+                       case JCFG_IDCODE:
+                               if (goi->isconfigure) {
+                                       Jim_SetResultFormatted(goi->interp,
+                                                       "not settable: %s", n->name);
+                                       return JIM_ERR;
+                               } else {
+                                       if (goi->argc != 0) {
+                                               Jim_WrongNumArgs(goi->interp,
+                                                               goi->argc, goi->argv,
+                                                               "NO PARAMS");
+                                               return JIM_ERR;
+                                       }
+                               }
+                               Jim_SetResult(goi->interp, Jim_NewIntObj(goi->interp, tap->idcode));
+                               break;
                        default:
-                               Jim_SetResultFormatted(goi->interp, "unknown event: %s", n->name);
+                               Jim_SetResultFormatted(goi->interp, "unknown value: %s", n->name);
                                return JIM_ERR;
                }
        }
@@ -622,6 +638,7 @@ static int jim_newtap_cmd(Jim_GetOptInfo *goi)
 static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e)
 {
        struct jtag_tap_event_action *jteap;
+       int retval;
 
        for (jteap = tap->event_action; jteap != NULL; jteap = jteap->next) {
                if (jteap->event != e)
@@ -632,7 +649,11 @@ static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e)
                        tap->dotted_name, e, nvp->name,
                        Jim_GetString(jteap->body, NULL));
 
-               if (Jim_EvalObj(jteap->interp, jteap->body) != JIM_OK) {
+               retval = Jim_EvalObj(jteap->interp, jteap->body);
+               if (retval == JIM_RETURN)
+                       retval = jteap->interp->returnCode;
+
+               if (retval != JIM_OK) {
                        Jim_MakeErrorMessage(jteap->interp);
                        LOG_USER("%s", Jim_GetString(Jim_GetResult(jteap->interp), NULL));
                        continue;
@@ -666,9 +687,8 @@ static int jim_jtag_arp_init(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
        struct command_context *context = current_command_context(interp);
        int e = jtag_init_inner(context);
        if (e != ERROR_OK) {
-               Jim_Obj *eObj = Jim_NewIntObj(goi.interp, e);
-               Jim_SetResultFormatted(goi.interp, "error: %#s", eObj);
-               Jim_FreeNewObj(goi.interp, eObj);
+               Jim_Obj *obj = Jim_NewIntObj(goi.interp, e);
+               Jim_SetResultFormatted(goi.interp, "error: %#s", obj);
                return JIM_ERR;
        }
        return JIM_OK;
@@ -690,9 +710,8 @@ static int jim_jtag_arp_init_reset(Jim_Interp *interp, int argc, Jim_Obj *const
                e = swd_init_reset(context);
 
        if (e != ERROR_OK) {
-               Jim_Obj *eObj = Jim_NewIntObj(goi.interp, e);
-               Jim_SetResultFormatted(goi.interp, "error: %#s", eObj);
-               Jim_FreeNewObj(goi.interp, eObj);
+               Jim_Obj *obj = Jim_NewIntObj(goi.interp, e);
+               Jim_SetResultFormatted(goi.interp, "error: %#s", obj);
                return JIM_ERR;
        }
        return JIM_OK;
@@ -738,7 +757,8 @@ static bool jtag_tap_disable(struct jtag_tap *t)
 
 int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
-       const char *cmd_name = Jim_GetString(argv[0], NULL);
+       struct command *c = jim_to_command(interp);
+       const char *cmd_name = c->name;
        Jim_GetOptInfo goi;
        Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
        if (goi.argc != 1) {
@@ -775,7 +795,8 @@ int jim_jtag_tap_enabler(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 
 int jim_jtag_configure(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
 {
-       const char *cmd_name = Jim_GetString(argv[0], NULL);
+       struct command *c = jim_to_command(interp);
+       const char *cmd_name = c->name;
        Jim_GetOptInfo goi;
        Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1);
        goi.isconfigure = !strcmp(cmd_name, "configure");
@@ -866,7 +887,7 @@ static const struct command_registration jtag_subcommand_handlers[] = {
                        "['-expected_id' number] "
                        "['-ignore-version'] "
                        "['-ircapture' number] "
-                       "['-mask' number] ",
+                       "['-mask' number]",
        },
        {
                .name = "tapisenabled",
@@ -894,7 +915,7 @@ static const struct command_registration jtag_subcommand_handlers[] = {
        },
        {
                .name = "configure",
-               .mode = COMMAND_EXEC,
+               .mode = COMMAND_ANY,
                .jim_handler = jim_jtag_configure,
                .help = "Provide a Tcl handler for the specified "
                        "TAP event.",
@@ -935,15 +956,15 @@ COMMAND_HANDLER(handle_scan_chain_command)
        char expected_id[12];
 
        tap = jtag_all_taps();
-       command_print(CMD_CTX,
+       command_print(CMD,
                "   TapName             Enabled  IdCode     Expected   IrLen IrCap IrMask");
-       command_print(CMD_CTX,
+       command_print(CMD,
                "-- ------------------- -------- ---------- ---------- ----- ----- ------");
 
        while (tap) {
                uint32_t expected, expected_mask, ii;
 
-               snprintf(expected_id, sizeof expected_id, "0x%08x",
+               snprintf(expected_id, sizeof(expected_id), "0x%08x",
                        (unsigned)((tap->expected_ids_cnt > 0)
                                   ? tap->expected_ids[0]
                                   : 0));
@@ -953,7 +974,7 @@ COMMAND_HANDLER(handle_scan_chain_command)
                expected = buf_get_u32(tap->expected, 0, tap->ir_length);
                expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length);
 
-               command_print(CMD_CTX,
+               command_print(CMD,
                        "%2d %-18s     %c     0x%08x %s %5d 0x%02x  0x%02x",
                        tap->abs_chain_position,
                        tap->dotted_name,
@@ -965,12 +986,12 @@ COMMAND_HANDLER(handle_scan_chain_command)
                        (unsigned int)(expected_mask));
 
                for (ii = 1; ii < tap->expected_ids_cnt; ii++) {
-                       snprintf(expected_id, sizeof expected_id, "0x%08x",
+                       snprintf(expected_id, sizeof(expected_id), "0x%08x",
                                (unsigned) tap->expected_ids[ii]);
                        if (tap->ignore_version)
                                expected_id[2] = '*';
 
-                       command_print(CMD_CTX,
+                       command_print(CMD,
                                "                                           %s",
                                expected_id);
                }
@@ -991,7 +1012,7 @@ COMMAND_HANDLER(handle_jtag_ntrst_delay_command)
 
                jtag_set_ntrst_delay(delay);
        }
-       command_print(CMD_CTX, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
+       command_print(CMD, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
        return ERROR_OK;
 }
 
@@ -1005,7 +1026,7 @@ COMMAND_HANDLER(handle_jtag_ntrst_assert_width_command)
 
                jtag_set_ntrst_assert_width(delay);
        }
-       command_print(CMD_CTX, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
+       command_print(CMD, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
        return ERROR_OK;
 }
 
@@ -1030,41 +1051,13 @@ COMMAND_HANDLER(handle_jtag_rclk_command)
                return retval;
 
        if (cur_khz)
-               command_print(CMD_CTX, "RCLK not supported - fallback to %d kHz", cur_khz);
+               command_print(CMD, "RCLK not supported - fallback to %d kHz", cur_khz);
        else
-               command_print(CMD_CTX, "RCLK - adaptive");
+               command_print(CMD, "RCLK - adaptive");
 
        return retval;
 }
 
-COMMAND_HANDLER(handle_jtag_reset_command)
-{
-       if (CMD_ARGC != 2)
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       int trst = -1;
-       if (CMD_ARGV[0][0] == '1')
-               trst = 1;
-       else if (CMD_ARGV[0][0] == '0')
-               trst = 0;
-       else
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       int srst = -1;
-       if (CMD_ARGV[1][0] == '1')
-               srst = 1;
-       else if (CMD_ARGV[1][0] == '0')
-               srst = 0;
-       else
-               return ERROR_COMMAND_SYNTAX_ERROR;
-
-       if (adapter_init(CMD_CTX) != ERROR_OK)
-               return ERROR_JTAG_INIT_FAILED;
-
-       jtag_add_reset(trst, srst);
-       return jtag_execute_queue();
-}
-
 COMMAND_HANDLER(handle_runtest_command)
 {
        if (CMD_ARGC != 1)
@@ -1131,18 +1124,23 @@ COMMAND_HANDLER(handle_irscan_command)
                tap = jtag_tap_by_string(CMD_ARGV[i*2]);
                if (tap == NULL) {
                        free(fields);
-                       command_print(CMD_CTX, "Tap: %s unknown", CMD_ARGV[i*2]);
+                       command_print(CMD, "Tap: %s unknown", CMD_ARGV[i*2]);
 
                        return ERROR_FAIL;
                }
-               int field_size = tap->ir_length;
-               fields[i].num_bits = field_size;
-               uint8_t *v = malloc(DIV_ROUND_UP(field_size, 8));
-
                uint64_t value;
                retval = parse_u64(CMD_ARGV[i * 2 + 1], &value);
                if (ERROR_OK != retval)
                        goto error_return;
+
+               int field_size = tap->ir_length;
+               fields[i].num_bits = field_size;
+               uint8_t *v = calloc(1, DIV_ROUND_UP(field_size, 8));
+               if (!v) {
+                       LOG_ERROR("Out of memory");
+                       goto error_return;
+               }
+
                buf_set_u64(v, 0, field_size, value);
                fields[i].out_value = v;
                fields[i].in_value = NULL;
@@ -1154,10 +1152,8 @@ COMMAND_HANDLER(handle_irscan_command)
        retval = jtag_execute_queue();
 
 error_return:
-       for (i = 0; i < num_fields; i++) {
-               if (NULL != fields[i].out_value)
-                       free((void *)fields[i].out_value);
-       }
+       for (i = 0; i < num_fields; i++)
+               free((void *)fields[i].out_value);
 
        free(fields);
 
@@ -1176,7 +1172,7 @@ COMMAND_HANDLER(handle_verify_ircapture_command)
        }
 
        const char *status = jtag_will_verify_capture_ir() ? "enabled" : "disabled";
-       command_print(CMD_CTX, "verify Capture-IR is %s", status);
+       command_print(CMD, "verify Capture-IR is %s", status);
 
        return ERROR_OK;
 }
@@ -1193,7 +1189,7 @@ COMMAND_HANDLER(handle_verify_jtag_command)
        }
 
        const char *status = jtag_will_verify() ? "enabled" : "disabled";
-       command_print(CMD_CTX, "verify jtag capture is %s", status);
+       command_print(CMD, "verify jtag capture is %s", status);
 
        return ERROR_OK;
 }
@@ -1215,7 +1211,7 @@ COMMAND_HANDLER(handle_tms_sequence_command)
                tap_use_new_tms_table(use_new_table);
        }
 
-       command_print(CMD_CTX, "tms sequence is  %s",
+       command_print(CMD, "tms sequence is  %s",
                tap_uses_new_tms_table() ? "short" : "long");
 
        return ERROR_OK;
@@ -1309,14 +1305,6 @@ static const struct command_registration jtag_command_handlers[] = {
                .help = "print current scan chain configuration",
                .usage = ""
        },
-       {
-               .name = "jtag_reset",
-               .handler = handle_jtag_reset_command,
-               .mode = COMMAND_EXEC,
-               .help = "Set reset line values.  Value '1' is active, "
-                       "value '0' is inactive.",
-               .usage = "trst_active srst_active",
-       },
        {
                .name = "runtest",
                .handler = handle_runtest_command,
@@ -1328,7 +1316,7 @@ static const struct command_registration jtag_command_handlers[] = {
                .name = "irscan",
                .handler = handle_irscan_command,
                .mode = COMMAND_EXEC,
-               .help = "Execute Instruction Register (DR) scan.  The "
+               .help = "Execute Instruction Register (IR) scan.  The "
                        "specified opcodes are put into each TAP's IR, "
                        "and other TAPs are put in BYPASS.",
                .usage = "[tap_name instruction]* ['-endstate' state_name]",
@@ -1365,7 +1353,7 @@ static const struct command_registration jtag_command_handlers[] = {
                .mode = COMMAND_ANY,
                .help = "Wait for an SRST deassert. "
                        "Useful for cases where you need something to happen within ms "
-                       "of an srst deassert. Timeout in ms ",
+                       "of an srst deassert. Timeout in ms",
                .usage = "ms",
        },
        {