1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
5 * Copyright (C) 2007,2008 Øyvind Harboe *
6 * oyvind.harboe@zylin.com *
8 * Copyright (C) 2009 SoftPLC Corporation *
12 * Copyright (C) 2009 Zachary T Welch *
13 * zw@superlucidity.net *
15 * This program is free software; you can redistribute it and/or modify *
16 * it under the terms of the GNU General Public License as published by *
17 * the Free Software Foundation; either version 2 of the License, or *
18 * (at your option) any later version. *
20 * This program is distributed in the hope that it will be useful, *
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
23 * GNU General Public License for more details. *
25 * You should have received a copy of the GNU General Public License *
26 * along with this program; if not, write to the *
27 * Free Software Foundation, Inc., *
28 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
29 ***************************************************************************/
35 #include "minidriver.h"
36 #include "interface.h"
37 #include "interfaces.h"
43 static const Jim_Nvp nvp_jtag_tap_event
[] = {
44 { .value
= JTAG_TAP_EVENT_POST_RESET
, .name
= "post-reset" },
45 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
46 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
48 { .name
= NULL
, .value
= -1 }
51 extern jtag_interface_t
*jtag_interface
;
54 static int handle_interface_list_command(struct command_context_s
*cmd_ctx
,
55 char *cmd
, char **args
, int argc
);
56 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
57 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
58 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
59 static int handle_jtag_rclk_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
60 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
61 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
62 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
63 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
65 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
67 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
68 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
69 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
70 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
71 static int Jim_Command_pathmove(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
72 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
74 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
75 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
76 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
79 enum jtag_tap_cfg_param
{
83 static Jim_Nvp nvp_config_opts
[] = {
84 { .name
= "-event", .value
= JCFG_EVENT
},
86 { .name
= NULL
, .value
= -1 }
89 static int jtag_tap_configure_cmd(Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
95 /* parse config or cget options */
96 while (goi
->argc
> 0) {
97 Jim_SetEmptyResult (goi
->interp
);
99 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
101 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
107 if (goi
->argc
== 0) {
108 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ...");
112 e
= Jim_GetOpt_Nvp(goi
, nvp_jtag_tap_event
, &n
);
114 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
118 if (goi
->isconfigure
) {
119 if (goi
->argc
!= 1) {
120 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
124 if (goi
->argc
!= 0) {
125 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
131 jtag_tap_event_action_t
*jteap
;
133 jteap
= tap
->event_action
;
134 /* replace existing? */
136 if (jteap
->event
== (enum jtag_event
)n
->value
) {
142 if (goi
->isconfigure
) {
146 jteap
= calloc(1, sizeof (*jteap
));
149 jteap
->event
= n
->value
;
150 Jim_GetOpt_Obj(goi
, &o
);
152 Jim_DecrRefCount(interp
, jteap
->body
);
154 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
155 Jim_IncrRefCount(jteap
->body
);
159 /* add to head of event list */
160 jteap
->next
= tap
->event_action
;
161 tap
->event_action
= jteap
;
163 Jim_SetEmptyResult(goi
->interp
);
167 Jim_SetEmptyResult(goi
->interp
);
169 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
176 } /* while (goi->argc) */
181 static int is_bad_irval(int ir_length
, jim_wide w
)
191 static int jim_newtap_cmd(Jim_GetOptInfo
*goi
)
200 const Jim_Nvp opts
[] = {
201 #define NTAP_OPT_IRLEN 0
202 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
203 #define NTAP_OPT_IRMASK 1
204 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
205 #define NTAP_OPT_IRCAPTURE 2
206 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
207 #define NTAP_OPT_ENABLED 3
208 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
209 #define NTAP_OPT_DISABLED 4
210 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
211 #define NTAP_OPT_EXPECTED_ID 5
212 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
213 { .name
= NULL
, .value
= -1 },
216 pTap
= calloc(1, sizeof(jtag_tap_t
));
218 Jim_SetResult_sprintf(goi
->interp
, "no memory");
223 * we expect CHIP + TAP + OPTIONS
226 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
230 Jim_GetOpt_String(goi
, &cp
, NULL
);
231 pTap
->chip
= strdup(cp
);
233 Jim_GetOpt_String(goi
, &cp
, NULL
);
234 pTap
->tapname
= strdup(cp
);
236 /* name + dot + name + null */
237 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
239 sprintf(cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
240 pTap
->dotted_name
= cp
;
242 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
243 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
245 /* deal with options */
246 #define NTREQ_IRLEN 1
247 #define NTREQ_IRCAPTURE 2
248 #define NTREQ_IRMASK 4
250 /* clear them as we find them */
251 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
254 e
= Jim_GetOpt_Nvp(goi
, opts
, &n
);
256 Jim_GetOpt_NvpUnknown(goi
, opts
, 0);
257 free((void *)pTap
->dotted_name
);
261 LOG_DEBUG("Processing option: %s", n
->name
);
263 case NTAP_OPT_ENABLED
:
264 pTap
->disabled_after_reset
= false;
266 case NTAP_OPT_DISABLED
:
267 pTap
->disabled_after_reset
= true;
269 case NTAP_OPT_EXPECTED_ID
:
271 uint32_t *new_expected_ids
;
273 e
= Jim_GetOpt_Wide(goi
, &w
);
275 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
276 free((void *)pTap
->dotted_name
);
281 new_expected_ids
= malloc(sizeof(uint32_t) * (pTap
->expected_ids_cnt
+ 1));
282 if (new_expected_ids
== NULL
) {
283 Jim_SetResult_sprintf(goi
->interp
, "no memory");
284 free((void *)pTap
->dotted_name
);
289 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(uint32_t) * pTap
->expected_ids_cnt
);
291 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
293 free(pTap
->expected_ids
);
294 pTap
->expected_ids
= new_expected_ids
;
295 pTap
->expected_ids_cnt
++;
299 case NTAP_OPT_IRMASK
:
300 case NTAP_OPT_IRCAPTURE
:
301 e
= Jim_GetOpt_Wide(goi
, &w
);
303 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
304 free((void *)pTap
->dotted_name
);
310 if (w
> (jim_wide
) (8 * sizeof(pTap
->ir_capture_value
)))
311 LOG_WARNING("huge IR length %d", (int) w
);
313 reqbits
&= (~(NTREQ_IRLEN
));
315 case NTAP_OPT_IRMASK
:
316 if (is_bad_irval(pTap
->ir_length
, w
)) {
317 LOG_ERROR("IR mask %x too big",
319 free((void *)pTap
->dotted_name
);
323 pTap
->ir_capture_mask
= w
;
324 reqbits
&= (~(NTREQ_IRMASK
));
326 case NTAP_OPT_IRCAPTURE
:
327 if (is_bad_irval(pTap
->ir_length
, w
)) {
328 LOG_ERROR("IR capture %x too big",
330 free((void *)pTap
->dotted_name
);
334 pTap
->ir_capture_value
= w
;
335 reqbits
&= (~(NTREQ_IRCAPTURE
));
338 } /* switch (n->value) */
339 } /* while (goi->argc) */
341 /* default is enabled-after-reset */
342 pTap
->enabled
= !pTap
->disabled_after_reset
;
344 /* Did all the required option bits get cleared? */
351 Jim_SetResult_sprintf(goi
->interp
,
352 "newtap: %s missing required parameters",
358 static void jtag_tap_handle_event(jtag_tap_t
*tap
, enum jtag_event e
)
360 jtag_tap_event_action_t
* jteap
;
363 jteap
= tap
->event_action
;
367 if (jteap
->event
== e
) {
369 LOG_DEBUG("JTAG tap: %s event: %d (%s) action: %s\n",
372 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
373 Jim_GetString(jteap
->body
, NULL
));
374 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
375 Jim_PrintErrorMessage(interp
);
377 case JTAG_TAP_EVENT_ENABLE
:
378 case JTAG_TAP_EVENT_DISABLE
:
379 /* NOTE: we currently assume the handlers
380 * can't fail. That presumes later code
381 * will be verifying the scan chains ...
383 tap
->enabled
= (e
== JTAG_TAP_EVENT_ENABLE
);
394 LOG_DEBUG("event %d %s - no action",
396 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
);
401 static int jim_jtag_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
407 struct command_context_s
*context
;
415 JTAG_CMD_TAPISENABLED
,
421 const Jim_Nvp jtag_cmds
[] = {
422 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
423 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
424 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
425 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
426 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
427 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
428 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
429 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
430 { .name
= "names" , .value
= JTAG_CMD_NAMES
},
432 { .name
= NULL
, .value
= -1 },
435 context
= Jim_GetAssocData(interp
, "context");
436 /* go past the command */
437 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
439 e
= Jim_GetOpt_Nvp(&goi
, jtag_cmds
, &n
);
441 Jim_GetOpt_NvpUnknown(&goi
, jtag_cmds
, 0);
444 Jim_SetEmptyResult(goi
.interp
);
446 case JTAG_CMD_INTERFACE
:
447 /* return the name of the interface */
448 /* TCL code might need to know the exact type... */
449 /* FUTURE: we allow this as a means to "set" the interface. */
451 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
454 Jim_SetResultString(goi
.interp
, jtag_interface
->name
, -1);
456 case JTAG_CMD_INIT_RESET
:
458 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
461 e
= jtag_init_reset(context
);
463 Jim_SetResult_sprintf(goi
.interp
, "error: %d", e
);
467 case JTAG_CMD_NEWTAP
:
468 return jim_newtap_cmd(&goi
);
470 case JTAG_CMD_TAPISENABLED
:
471 case JTAG_CMD_TAPENABLE
:
472 case JTAG_CMD_TAPDISABLE
:
474 Jim_SetResultString(goi
.interp
, "Too many parameters",-1);
481 t
= jtag_tap_by_jim_obj(goi
.interp
, goi
.argv
[0]);
486 case JTAG_CMD_TAPISENABLED
:
488 case JTAG_CMD_TAPENABLE
:
491 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_ENABLE
);
495 /* FIXME add JTAG sanity checks, w/o TLR
496 * - scan chain length grew by one (this)
497 * - IDs and IR lengths are as expected
500 jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE
);
502 case JTAG_CMD_TAPDISABLE
:
505 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_DISABLE
);
509 /* FIXME add JTAG sanity checks, w/o TLR
510 * - scan chain length shrank by one (this)
511 * - IDs and IR lengths are as expected
514 jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE
);
518 Jim_SetResult(goi
.interp
, Jim_NewIntObj(goi
.interp
, e
));
525 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
526 "cget tap_name queryparm");
533 Jim_GetOpt_Obj(&goi
, &o
);
534 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
540 return jtag_tap_configure_cmd(&goi
, t
);
544 case JTAG_CMD_CONFIGURE
:
546 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
547 "configure tap_name attribute value ...");
554 Jim_GetOpt_Obj(&goi
, &o
);
555 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
561 return jtag_tap_configure_cmd(&goi
, t
);
567 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
, "Too many parameters");
570 Jim_SetResult(goi
.interp
, Jim_NewListObj(goi
.interp
, NULL
, 0));
574 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
) {
575 Jim_ListAppendElement(goi
.interp
,
576 Jim_GetResult(goi
.interp
),
577 Jim_NewStringObj(goi
.interp
,
578 tap
->dotted_name
, -1));
590 void jtag_notify_reset(void)
593 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
)
595 jtag_tap_handle_event(tap
, JTAG_TAP_EVENT_POST_RESET
);
600 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
602 register_jim(cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
604 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
605 COMMAND_CONFIG
, "try to configure interface");
606 register_command(cmd_ctx
, NULL
,
607 "interface_list", &handle_interface_list_command
,
608 COMMAND_ANY
, "list all built-in interfaces");
609 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
610 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
611 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
612 COMMAND_ANY
, "set maximum jtag speed (if supported); "
613 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
614 register_command(cmd_ctx
, NULL
, "jtag_rclk", handle_jtag_rclk_command
,
615 COMMAND_ANY
, "fallback_speed_khz - set JTAG speed to RCLK or use fallback speed");
616 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
617 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
618 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
620 "[none/trst_only/srst_only/trst_and_srst] [srst_pulls_trst/trst_pulls_srst] [combined/separate] [trst_push_pull/trst_open_drain] [srst_push_pull/srst_open_drain]");
621 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
622 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
623 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
624 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
626 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
627 COMMAND_EXEC
, "print current scan chain configuration");
629 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
630 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
631 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
632 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
633 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
634 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
635 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
636 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
637 register_jim(cmd_ctx
, "pathmove", Jim_Command_pathmove
, "move JTAG to state1 then to state2, state3, etc. <state1>,<state2>,<stat3>...");
639 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
640 COMMAND_ANY
, "verify value captured during Capture-IR <enable | disable>");
641 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
642 COMMAND_ANY
, "verify value capture <enable | disable>");
643 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
644 COMMAND_ANY
, "choose short(default) or long tms_sequence <short | long>");
648 static int default_khz(int khz
, int *jtag_speed
)
650 LOG_ERROR("Translation from khz to jtag_speed not implemented");
654 static int default_speed_div(int speed
, int *khz
)
656 LOG_ERROR("Translation from jtag_speed to khz not implemented");
660 static int default_power_dropout(int *dropout
)
662 *dropout
= 0; /* by default we can't detect power dropout */
666 static int default_srst_asserted(int *srst_asserted
)
668 *srst_asserted
= 0; /* by default we can't detect srst asserted */
672 static int handle_interface_command(struct command_context_s
*cmd_ctx
,
673 char *cmd
, char **args
, int argc
)
675 /* check whether the interface is already configured */
678 LOG_WARNING("Interface already configured, ignoring");
682 /* interface name is a mandatory argument */
683 if (argc
!= 1 || args
[0][0] == '\0')
684 return ERROR_COMMAND_SYNTAX_ERROR
;
686 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
688 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) != 0)
691 int retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
);
692 if (ERROR_OK
!= retval
)
695 jtag_interface
= jtag_interfaces
[i
];
697 if (jtag_interface
->khz
== NULL
)
698 jtag_interface
->khz
= default_khz
;
699 if (jtag_interface
->speed_div
== NULL
)
700 jtag_interface
->speed_div
= default_speed_div
;
701 if (jtag_interface
->power_dropout
== NULL
)
702 jtag_interface
->power_dropout
= default_power_dropout
;
703 if (jtag_interface
->srst_asserted
== NULL
)
704 jtag_interface
->srst_asserted
= default_srst_asserted
;
709 /* no valid interface was found (i.e. the configuration option,
710 * didn't match one of the compiled-in interfaces
712 LOG_ERROR("The specified JTAG interface was not found (%s)", args
[0]);
713 handle_interface_list_command(cmd_ctx
, cmd
, args
, argc
);
714 return ERROR_JTAG_INVALID_INTERFACE
;
717 static int handle_interface_list_command(struct command_context_s
*cmd_ctx
,
718 char *cmd
, char **args
, int argc
)
720 if (strcmp(cmd
, "interface_list") == 0 && argc
> 0)
721 return ERROR_COMMAND_SYNTAX_ERROR
;
723 command_print(cmd_ctx
, "The following JTAG interfaces are available:");
724 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
726 const char *name
= jtag_interfaces
[i
]->name
;
727 command_print(cmd_ctx
, "%u: %s", i
+ 1, name
);
733 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
737 Jim_Obj
*newargs
[ 10 ];
741 * argv[ 0] = ir length
742 * argv[ 1] = ir capture
744 * argv[ 3] = not actually used by anything but in the docs
748 command_print(cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
751 command_print(cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
752 command_print(cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
756 command_print(cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
757 command_print(cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
758 command_print(cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
759 command_print(cmd_ctx
, "And then refer to the taps by the dotted name.");
761 newargs
[0] = Jim_NewStringObj(interp
, "jtag", -1);
762 newargs
[1] = Jim_NewStringObj(interp
, "newtap", -1);
763 sprintf(buf
, "chip%d", jtag_tap_count());
764 newargs
[2] = Jim_NewStringObj(interp
, buf
, -1);
765 sprintf(buf
, "tap%d", jtag_tap_count());
766 newargs
[3] = Jim_NewStringObj(interp
, buf
, -1);
767 newargs
[4] = Jim_NewStringObj(interp
, "-irlen", -1);
768 newargs
[5] = Jim_NewStringObj(interp
, args
[0], -1);
769 newargs
[6] = Jim_NewStringObj(interp
, "-ircapture", -1);
770 newargs
[7] = Jim_NewStringObj(interp
, args
[1], -1);
771 newargs
[8] = Jim_NewStringObj(interp
, "-irmask", -1);
772 newargs
[9] = Jim_NewStringObj(interp
, args
[2], -1);
774 command_print(cmd_ctx
, "NEW COMMAND:");
775 sprintf(buf
, "%s %s %s %s %s %s %s %s %s %s",
776 Jim_GetString(newargs
[0], NULL
),
777 Jim_GetString(newargs
[1], NULL
),
778 Jim_GetString(newargs
[2], NULL
),
779 Jim_GetString(newargs
[3], NULL
),
780 Jim_GetString(newargs
[4], NULL
),
781 Jim_GetString(newargs
[5], NULL
),
782 Jim_GetString(newargs
[6], NULL
),
783 Jim_GetString(newargs
[7], NULL
),
784 Jim_GetString(newargs
[8], NULL
),
785 Jim_GetString(newargs
[9], NULL
));
787 e
= jim_jtag_command(interp
, 10, newargs
);
789 command_print(cmd_ctx
, "%s", Jim_GetString(Jim_GetResult(interp
), NULL
));
794 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
798 tap
= jtag_all_taps();
799 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
800 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
803 uint32_t expected
, expected_mask
, cur_instr
, ii
;
804 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
805 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
806 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
808 command_print(cmd_ctx
,
809 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
810 tap
->abs_chain_position
,
812 tap
->enabled
? 'Y' : 'n',
813 (unsigned int)(tap
->idcode
),
814 (unsigned int)(tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
815 (unsigned int)(tap
->ir_length
),
816 (unsigned int)(expected
),
817 (unsigned int)(expected_mask
),
818 (unsigned int)(cur_instr
));
820 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
821 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
822 (unsigned int)(tap
->expected_ids
[ii
]));
831 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
837 return ERROR_COMMAND_SYNTAX_ERROR
;
839 /* Original versions cared about the order of these tokens:
840 * reset_config signals [combination [trst_type [srst_type]]]
841 * They also clobbered the previous configuration even on error.
843 * Here we don't care about the order, and only change values
844 * which have been explicitly specified.
846 for (; argc
; argc
--, args
++) {
850 m
= RESET_SRST_GATES_JTAG
;
852 if (strcmp(*args
, "srst_gates_jtag") == 0)
854 tmp
= RESET_SRST_GATES_JTAG
;
859 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
860 if (strcmp(*args
, "none") == 0)
862 else if (strcmp(*args
, "trst_only") == 0)
863 tmp
= RESET_HAS_TRST
;
864 else if (strcmp(*args
, "srst_only") == 0)
865 tmp
= RESET_HAS_SRST
;
866 else if (strcmp(*args
, "trst_and_srst") == 0)
867 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
871 LOG_ERROR("extra reset_config %s spec (%s)",
873 return ERROR_INVALID_ARGUMENTS
;
878 /* combination (options for broken wiring) */
879 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
880 if (strcmp(*args
, "separate") == 0)
881 /* separate reset lines - default */;
882 else if (strcmp(*args
, "srst_pulls_trst") == 0)
883 tmp
|= RESET_SRST_PULLS_TRST
;
884 else if (strcmp(*args
, "trst_pulls_srst") == 0)
885 tmp
|= RESET_TRST_PULLS_SRST
;
886 else if (strcmp(*args
, "combined") == 0)
887 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
891 LOG_ERROR("extra reset_config %s spec (%s)",
892 "combination", *args
);
893 return ERROR_INVALID_ARGUMENTS
;
898 /* trst_type (NOP without HAS_TRST) */
899 m
= RESET_TRST_OPEN_DRAIN
;
900 if (strcmp(*args
, "trst_open_drain") == 0)
901 tmp
|= RESET_TRST_OPEN_DRAIN
;
902 else if (strcmp(*args
, "trst_push_pull") == 0)
903 /* push/pull from adapter - default */;
907 LOG_ERROR("extra reset_config %s spec (%s)",
909 return ERROR_INVALID_ARGUMENTS
;
914 /* srst_type (NOP without HAS_SRST) */
915 m
|= RESET_SRST_PUSH_PULL
;
916 if (strcmp(*args
, "srst_push_pull") == 0)
917 tmp
|= RESET_SRST_PUSH_PULL
;
918 else if (strcmp(*args
, "srst_open_drain") == 0)
919 /* open drain from adapter - default */;
923 LOG_ERROR("extra reset_config %s spec (%s)",
925 return ERROR_INVALID_ARGUMENTS
;
930 /* caller provided nonsense; fail */
931 LOG_ERROR("unknown reset_config flag (%s)", *args
);
932 return ERROR_INVALID_ARGUMENTS
;
935 /* Remember the bits which were specified (mask)
936 * and their new values (new_cfg).
942 /* clear previous values of those bits, save new values */
943 enum reset_types old_cfg
= jtag_get_reset_config();
946 jtag_set_reset_config(new_cfg
);
951 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
952 char *cmd
, char **args
, int argc
)
955 return ERROR_COMMAND_SYNTAX_ERROR
;
959 int retval
= parse_uint(args
[0], &delay
);
960 if (ERROR_OK
!= retval
)
962 jtag_set_nsrst_delay(delay
);
964 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
968 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
969 char *cmd
, char **args
, int argc
)
972 return ERROR_COMMAND_SYNTAX_ERROR
;
976 int retval
= parse_uint(args
[0], &delay
);
977 if (ERROR_OK
!= retval
)
979 jtag_set_ntrst_delay(delay
);
981 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
985 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
987 int retval
= ERROR_OK
;
989 command_print(cmd_ctx
, "OLD SYNTAX: DEPRECATED - "
990 "use jtag_khz, not jtag_speed");
993 return ERROR_COMMAND_SYNTAX_ERROR
;
996 LOG_DEBUG("handle jtag speed");
998 unsigned cur_speed
= 0;
999 int retval
= parse_uint(args
[0], &cur_speed
);
1000 if (ERROR_OK
!= retval
)
1002 retval
= jtag_config_speed(cur_speed
);
1005 command_print(cmd_ctx
, "jtag_speed: %d", jtag_get_speed());
1010 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1013 return ERROR_COMMAND_SYNTAX_ERROR
;
1015 int retval
= ERROR_OK
;
1019 int retval
= parse_uint(args
[0], &khz
);
1020 if (ERROR_OK
!= retval
)
1022 retval
= jtag_config_khz(khz
);
1023 if (ERROR_OK
!= retval
)
1027 int cur_speed
= jtag_get_speed_khz();
1028 retval
= jtag_get_speed_readable(&cur_speed
);
1029 if (ERROR_OK
!= retval
)
1033 command_print(cmd_ctx
, "%d kHz", cur_speed
);
1035 command_print(cmd_ctx
, "RCLK - adaptive");
1040 static int handle_jtag_rclk_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1043 return ERROR_COMMAND_SYNTAX_ERROR
;
1045 int retval
= ERROR_OK
;
1049 int retval
= parse_uint(args
[0], &khz
);
1050 if (ERROR_OK
!= retval
)
1052 retval
= jtag_config_rclk(khz
);
1053 if (ERROR_OK
!= retval
)
1057 int cur_khz
= jtag_get_speed_khz();
1058 retval
= jtag_get_speed_readable(&cur_khz
);
1059 if (ERROR_OK
!= retval
)
1063 command_print(cmd_ctx
, "RCLK not supported - fallback to %d kHz", cur_khz
);
1065 command_print(cmd_ctx
, "RCLK - adaptive");
1070 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
1071 char *cmd
, char **args
, int argc
)
1074 return ERROR_COMMAND_SYNTAX_ERROR
;
1077 if (args
[0][0] == '1')
1079 else if (args
[0][0] == '0')
1082 return ERROR_COMMAND_SYNTAX_ERROR
;
1085 if (args
[1][0] == '1')
1087 else if (args
[1][0] == '0')
1090 return ERROR_COMMAND_SYNTAX_ERROR
;
1092 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
1093 return ERROR_JTAG_INIT_FAILED
;
1095 jtag_add_reset(trst
, srst
);
1096 return jtag_execute_queue();
1099 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
1100 char *cmd
, char **args
, int argc
)
1103 return ERROR_COMMAND_SYNTAX_ERROR
;
1105 unsigned num_clocks
;
1106 int retval
= parse_uint(args
[0], &num_clocks
);
1107 if (ERROR_OK
!= retval
)
1110 jtag_add_runtest(num_clocks
, TAP_IDLE
);
1111 return jtag_execute_queue();
1115 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1116 * should be stable ... and *NOT* a shift state, otherwise free-running
1117 * jtag clocks could change the values latched by the update state.
1119 static bool scan_is_safe(tap_state_t state
)
1134 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1137 scan_field_t
*fields
;
1139 tap_state_t endstate
;
1141 if ((argc
< 2) || (argc
% 2))
1143 return ERROR_COMMAND_SYNTAX_ERROR
;
1146 /* optional "-endstate" "statename" at the end of the arguments,
1147 * so that e.g. IRPAUSE can let us load the data register before
1148 * entering RUN/IDLE to execute the instruction we load here.
1150 endstate
= TAP_IDLE
;
1153 /* have at least one pair of numbers. */
1154 /* is last pair the magic text? */
1155 if (0 == strcmp("-endstate", args
[ argc
- 2 ])) {
1158 cpA
= args
[ argc
-1 ];
1159 for (endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++) {
1160 cpS
= tap_state_name(endstate
);
1161 if (0 == strcmp(cpA
, cpS
)) {
1165 if (endstate
>= TAP_NUM_STATES
) {
1166 return ERROR_COMMAND_SYNTAX_ERROR
;
1168 if (!scan_is_safe(endstate
))
1169 LOG_WARNING("irscan with unsafe "
1170 "endstate \"%s\"", cpA
);
1171 /* found - remove the last 2 args */
1177 int num_fields
= argc
/ 2;
1178 size_t fields_len
= sizeof(scan_field_t
) * num_fields
;
1179 fields
= malloc(fields_len
);
1180 memset(fields
, 0, fields_len
);
1183 for (i
= 0; i
< num_fields
; i
++)
1185 tap
= jtag_tap_by_string(args
[i
*2]);
1189 for (j
= 0; j
< i
; j
++)
1190 free(fields
[j
].out_value
);
1192 command_print(cmd_ctx
, "Tap: %s unknown", args
[i
*2]);
1196 int field_size
= tap
->ir_length
;
1197 fields
[i
].tap
= tap
;
1198 fields
[i
].num_bits
= field_size
;
1199 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
1202 retval
= parse_u32(args
[i
* 2 + 1], &value
);
1203 if (ERROR_OK
!= retval
)
1205 buf_set_u32(fields
[i
].out_value
, 0, field_size
, value
);
1206 fields
[i
].in_value
= NULL
;
1209 /* did we have an endstate? */
1210 jtag_add_ir_scan(num_fields
, fields
, endstate
);
1212 retval
= jtag_execute_queue();
1215 for (i
= 0; i
< num_fields
; i
++)
1217 if (NULL
!= fields
[i
].out_value
)
1218 free(fields
[i
].out_value
);
1226 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1229 scan_field_t
*fields
;
1231 int field_count
= 0;
1234 tap_state_t endstate
;
1237 * args[2] = num_bits
1238 * args[3] = hex string
1239 * ... repeat num bits and hex string ...
1242 * args[N-2] = "-endstate"
1243 * args[N-1] = statename
1245 if ((argc
< 4) || ((argc
% 2) != 0))
1247 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
1251 endstate
= TAP_IDLE
;
1253 script_debug(interp
, "drscan", argc
, args
);
1255 /* validate arguments as numbers */
1257 for (i
= 2; i
< argc
; i
+= 2)
1262 e
= Jim_GetLong(interp
, args
[i
], &bits
);
1263 /* If valid - try next arg */
1268 /* Not valid.. are we at the end? */
1269 if (((i
+ 2) != argc
)) {
1270 /* nope, then error */
1274 /* it could be: "-endstate FOO"
1275 * e.g. DRPAUSE so we can issue more instructions
1276 * before entering RUN/IDLE and executing them.
1279 /* get arg as a string. */
1280 cp
= Jim_GetString(args
[i
], NULL
);
1281 /* is it the magic? */
1282 if (0 == strcmp("-endstate", cp
)) {
1283 /* is the statename valid? */
1284 cp
= Jim_GetString(args
[i
+ 1], NULL
);
1286 /* see if it is a valid state name */
1287 endstate
= tap_state_by_name(cp
);
1289 /* update the error message */
1290 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
1292 if (!scan_is_safe(endstate
))
1293 LOG_WARNING("drscan with unsafe "
1294 "endstate \"%s\"", cp
);
1296 /* valid - so clear the error */
1298 /* and remove the last 2 args */
1303 /* Still an error? */
1305 return e
; /* too bad */
1307 } /* validate args */
1309 tap
= jtag_tap_by_jim_obj(interp
, args
[1]);
1314 num_fields
= (argc
-2)/2;
1315 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
1316 for (i
= 2; i
< argc
; i
+= 2)
1322 Jim_GetLong(interp
, args
[i
], &bits
);
1323 str
= Jim_GetString(args
[i
+ 1], &len
);
1325 fields
[field_count
].tap
= tap
;
1326 fields
[field_count
].num_bits
= bits
;
1327 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
1328 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
1329 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
1333 jtag_add_dr_scan(num_fields
, fields
, endstate
);
1335 retval
= jtag_execute_queue();
1336 if (retval
!= ERROR_OK
)
1338 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
1343 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1344 for (i
= 2; i
< argc
; i
+= 2)
1349 Jim_GetLong(interp
, args
[i
], &bits
);
1350 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
1351 free(fields
[field_count
].out_value
);
1353 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
1358 Jim_SetResult(interp
, list
);
1366 static int Jim_Command_pathmove(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1368 tap_state_t states
[8];
1370 if ((argc
< 2) || ((size_t)argc
> (sizeof(states
)/sizeof(*states
) + 1)))
1372 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
1376 script_debug(interp
, "pathmove", argc
, args
);
1379 for (i
= 0; i
< argc
-1; i
++)
1382 cp
= Jim_GetString(args
[i
+ 1], NULL
);
1383 states
[i
] = tap_state_by_name(cp
);
1386 /* update the error message */
1387 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
1392 if ((jtag_add_statemove(states
[0]) != ERROR_OK
) || (jtag_execute_queue()!= ERROR_OK
))
1394 Jim_SetResultString(interp
, "pathmove: jtag execute failed",-1);
1398 jtag_add_pathmove(argc
-2, states
+ 1);
1400 if (jtag_execute_queue()!= ERROR_OK
)
1402 Jim_SetResultString(interp
, "pathmove: failed",-1);
1410 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1412 script_debug(interp
, "flush_count", argc
, args
);
1414 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
1420 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1423 return ERROR_COMMAND_SYNTAX_ERROR
;
1427 if (strcmp(args
[0], "enable") == 0)
1428 jtag_set_verify_capture_ir(true);
1429 else if (strcmp(args
[0], "disable") == 0)
1430 jtag_set_verify_capture_ir(false);
1432 return ERROR_COMMAND_SYNTAX_ERROR
;
1435 const char *status
= jtag_will_verify_capture_ir() ? "enabled": "disabled";
1436 command_print(cmd_ctx
, "verify Capture-IR is %s", status
);
1441 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1444 return ERROR_COMMAND_SYNTAX_ERROR
;
1448 if (strcmp(args
[0], "enable") == 0)
1449 jtag_set_verify(true);
1450 else if (strcmp(args
[0], "disable") == 0)
1451 jtag_set_verify(false);
1453 return ERROR_COMMAND_SYNTAX_ERROR
;
1456 const char *status
= jtag_will_verify() ? "enabled": "disabled";
1457 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
1462 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1465 return ERROR_COMMAND_SYNTAX_ERROR
;
1470 if (strcmp(args
[0], "short") == 0)
1471 use_new_table
= true;
1472 else if (strcmp(args
[0], "long") == 0)
1473 use_new_table
= false;
1475 return ERROR_COMMAND_SYNTAX_ERROR
;
1477 tap_use_new_tms_table(use_new_table
);
1480 command_print(cmd_ctx
, "tms sequence is %s",
1481 tap_uses_new_tms_table() ? "short": "long");
Linking to existing account procedure
If you already have an account and want to add another login method
you
MUST first sign in with your existing account and
then change URL to read
https://review.openocd.org/login/?link
to get to this page again but this time it'll work for linking. Thank you.
SSH host keys fingerprints
1024 SHA256:YKx8b7u5ZWdcbp7/4AeXNaqElP49m6QrwfXaqQGJAOk gerrit-code-review@openocd.zylin.com (DSA)
384 SHA256:jHIbSQa4REvwCFG4cq5LBlBLxmxSqelQPem/EXIrxjk gerrit-code-review@openocd.org (ECDSA)
521 SHA256:UAOPYkU9Fjtcao0Ul/Rrlnj/OsQvt+pgdYSZ4jOYdgs gerrit-code-review@openocd.org (ECDSA)
256 SHA256:A13M5QlnozFOvTllybRZH6vm7iSt0XLxbA48yfc2yfY gerrit-code-review@openocd.org (ECDSA)
256 SHA256:spYMBqEYoAOtK7yZBrcwE8ZpYt6b68Cfh9yEVetvbXg gerrit-code-review@openocd.org (ED25519)
+--[ED25519 256]--+
|=.. |
|+o.. . |
|*.o . . |
|+B . . . |
|Bo. = o S |
|Oo.+ + = |
|oB=.* = . o |
| =+=.+ + E |
|. .=o . o |
+----[SHA256]-----+
2048 SHA256:0Onrb7/PHjpo6iVZ7xQX2riKN83FJ3KGU0TvI0TaFG4 gerrit-code-review@openocd.zylin.com (RSA)