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"
42 static const Jim_Nvp nvp_jtag_tap_event
[] = {
43 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
44 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
46 { .name
= NULL
, .value
= -1 }
49 /* jtag interfaces (parport, FTDI-USB, TI-USB, ...)
52 #if BUILD_ECOSBOARD == 1
53 extern jtag_interface_t zy1000_interface
;
54 #elif defined(BUILD_MINIDRIVER_DUMMY)
55 extern jtag_interface_t minidummy_interface
;
56 #else // standard drivers
57 #if BUILD_PARPORT == 1
58 extern jtag_interface_t parport_interface
;
62 extern jtag_interface_t dummy_interface
;
65 #if BUILD_FT2232_FTD2XX == 1
66 extern jtag_interface_t ft2232_interface
;
69 #if BUILD_FT2232_LIBFTDI == 1
70 extern jtag_interface_t ft2232_interface
;
73 #if BUILD_AMTJTAGACCEL == 1
74 extern jtag_interface_t amt_jtagaccel_interface
;
78 extern jtag_interface_t ep93xx_interface
;
81 #if BUILD_AT91RM9200 == 1
82 extern jtag_interface_t at91rm9200_interface
;
85 #if BUILD_GW16012 == 1
86 extern jtag_interface_t gw16012_interface
;
89 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
90 extern jtag_interface_t presto_interface
;
93 #if BUILD_USBPROG == 1
94 extern jtag_interface_t usbprog_interface
;
98 extern jtag_interface_t jlink_interface
;
101 #if BUILD_VSLLINK == 1
102 extern jtag_interface_t vsllink_interface
;
106 extern jtag_interface_t rlink_interface
;
109 #if BUILD_ARMJTAGEW == 1
110 extern jtag_interface_t armjtagew_interface
;
112 #endif // standard drivers
115 * The list of built-in JTAG interfaces, containing entries for those
116 * drivers that were enabled by the @c configure script.
118 * The list should be defined to contain either one minidriver interface
119 * or some number of standard driver interfaces, never both.
121 jtag_interface_t
*jtag_interfaces
[] = {
122 #if BUILD_ECOSBOARD == 1
124 #elif defined(BUILD_MINIDRIVER_DUMMY)
125 &minidummy_interface
,
126 #else // standard drivers
127 #if BUILD_PARPORT == 1
133 #if BUILD_FT2232_FTD2XX == 1
136 #if BUILD_FT2232_LIBFTDI == 1
139 #if BUILD_AMTJTAGACCEL == 1
140 &amt_jtagaccel_interface
,
142 #if BUILD_EP93XX == 1
145 #if BUILD_AT91RM9200 == 1
146 &at91rm9200_interface
,
148 #if BUILD_GW16012 == 1
151 #if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1
154 #if BUILD_USBPROG == 1
160 #if BUILD_VSLLINK == 1
166 #if BUILD_ARMJTAGEW == 1
167 &armjtagew_interface
,
169 #endif // standard drivers
173 extern jtag_interface_t
*jtag_interface
;
176 static int handle_interface_list_command(struct command_context_s
*cmd_ctx
,
177 char *cmd
, char **args
, int argc
);
178 static int handle_interface_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
179 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
180 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
181 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
182 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
183 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
184 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
186 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
188 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
189 static int handle_runtest_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
190 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
191 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
192 static int Jim_Command_pathmove(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
);
193 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
195 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
196 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
197 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
199 extern int jtag_examine_chain(void);
200 extern int jtag_validate_chain(void);
202 enum jtag_tap_cfg_param
{
206 static Jim_Nvp nvp_config_opts
[] = {
207 { .name
= "-event", .value
= JCFG_EVENT
},
209 { .name
= NULL
, .value
= -1 }
212 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
218 /* parse config or cget options */
219 while (goi
->argc
> 0) {
220 Jim_SetEmptyResult (goi
->interp
);
222 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
224 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
230 if (goi
->argc
== 0) {
231 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
235 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
237 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
241 if (goi
->isconfigure
) {
242 if (goi
->argc
!= 1) {
243 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
247 if (goi
->argc
!= 0) {
248 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
254 jtag_tap_event_action_t
*jteap
;
256 jteap
= tap
->event_action
;
257 /* replace existing? */
259 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
265 if (goi
->isconfigure
) {
268 jteap
= calloc(1, sizeof (*jteap
));
270 jteap
->event
= n
->value
;
271 Jim_GetOpt_Obj( goi
, &o
);
273 Jim_DecrRefCount(interp
, jteap
->body
);
275 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
276 Jim_IncrRefCount(jteap
->body
);
278 /* add to head of event list */
279 jteap
->next
= tap
->event_action
;
280 tap
->event_action
= jteap
;
281 Jim_SetEmptyResult(goi
->interp
);
285 Jim_SetEmptyResult(goi
->interp
);
287 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
294 } /* while (goi->argc) */
299 static int is_bad_irval(int ir_length
, jim_wide w
)
309 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
318 const Jim_Nvp opts
[] = {
319 #define NTAP_OPT_IRLEN 0
320 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
321 #define NTAP_OPT_IRMASK 1
322 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
323 #define NTAP_OPT_IRCAPTURE 2
324 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
325 #define NTAP_OPT_ENABLED 3
326 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
327 #define NTAP_OPT_DISABLED 4
328 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
329 #define NTAP_OPT_EXPECTED_ID 5
330 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
331 { .name
= NULL
, .value
= -1 },
334 pTap
= calloc(1, sizeof(jtag_tap_t
));
336 Jim_SetResult_sprintf(goi
->interp
, "no memory");
341 * we expect CHIP + TAP + OPTIONS
344 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
347 Jim_GetOpt_String( goi
, &cp
, NULL
);
348 pTap
->chip
= strdup(cp
);
350 Jim_GetOpt_String( goi
, &cp
, NULL
);
351 pTap
->tapname
= strdup(cp
);
353 /* name + dot + name + null */
354 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
356 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
357 pTap
->dotted_name
= cp
;
359 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
360 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
362 /* default is enabled */
365 /* deal with options */
366 #define NTREQ_IRLEN 1
367 #define NTREQ_IRCAPTURE 2
368 #define NTREQ_IRMASK 4
370 /* clear them as we find them */
371 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
374 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
376 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
379 LOG_DEBUG("Processing option: %s", n
->name
);
381 case NTAP_OPT_ENABLED
:
384 case NTAP_OPT_DISABLED
:
387 case NTAP_OPT_EXPECTED_ID
:
389 u32
*new_expected_ids
;
391 e
= Jim_GetOpt_Wide( goi
, &w
);
393 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
397 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
398 if (new_expected_ids
== NULL
) {
399 Jim_SetResult_sprintf( goi
->interp
, "no memory");
403 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
405 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
407 free(pTap
->expected_ids
);
408 pTap
->expected_ids
= new_expected_ids
;
409 pTap
->expected_ids_cnt
++;
413 case NTAP_OPT_IRMASK
:
414 case NTAP_OPT_IRCAPTURE
:
415 e
= Jim_GetOpt_Wide( goi
, &w
);
417 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
422 if (w
< (jim_wide
) sizeof(pTap
->ir_capture_value
))
423 LOG_WARNING("huge IR length %d", (int) w
);
425 reqbits
&= (~(NTREQ_IRLEN
));
427 case NTAP_OPT_IRMASK
:
428 if (is_bad_irval(pTap
->ir_length
, w
)) {
429 LOG_ERROR("IR mask %x too big",
433 pTap
->ir_capture_mask
= w
;
434 reqbits
&= (~(NTREQ_IRMASK
));
436 case NTAP_OPT_IRCAPTURE
:
437 if (is_bad_irval(pTap
->ir_length
, w
)) {
438 LOG_ERROR("IR capture %x too big",
442 pTap
->ir_capture_value
= w
;
443 reqbits
&= (~(NTREQ_IRCAPTURE
));
446 } /* switch(n->value) */
447 } /* while( goi->argc ) */
449 /* Did all the required option bits get cleared? */
456 Jim_SetResult_sprintf(goi
->interp
,
457 "newtap: %s missing required parameters",
463 static void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
465 jtag_tap_event_action_t
* jteap
;
468 jteap
= tap
->event_action
;
472 if (jteap
->event
== e
) {
474 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
477 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
478 Jim_GetString(jteap
->body
, NULL
) );
479 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
480 Jim_PrintErrorMessage(interp
);
488 LOG_DEBUG( "event %d %s - no action",
490 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
495 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
501 struct command_context_s
*context
;
509 JTAG_CMD_TAPISENABLED
,
514 const Jim_Nvp jtag_cmds
[] = {
515 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
516 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
517 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
518 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
519 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
520 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
521 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
522 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
524 { .name
= NULL
, .value
= -1 },
527 context
= Jim_GetAssocData(interp
, "context");
528 /* go past the command */
529 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
531 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
533 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
536 Jim_SetEmptyResult( goi
.interp
);
538 case JTAG_CMD_INTERFACE
:
539 /* return the name of the interface */
540 /* TCL code might need to know the exact type... */
541 /* FUTURE: we allow this as a means to "set" the interface. */
543 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
546 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
548 case JTAG_CMD_INIT_RESET
:
550 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
553 e
= jtag_init_reset(context
);
555 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
559 case JTAG_CMD_NEWTAP
:
560 return jim_newtap_cmd( &goi
);
562 case JTAG_CMD_TAPISENABLED
:
563 case JTAG_CMD_TAPENABLE
:
564 case JTAG_CMD_TAPDISABLE
:
566 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
572 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
577 case JTAG_CMD_TAPISENABLED
:
580 case JTAG_CMD_TAPENABLE
:
581 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
585 case JTAG_CMD_TAPDISABLE
:
586 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
591 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
598 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
605 Jim_GetOpt_Obj(&goi
, &o
);
606 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
612 return jtag_tap_configure_cmd( &goi
, t
);
616 case JTAG_CMD_CONFIGURE
:
618 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
625 Jim_GetOpt_Obj(&goi
, &o
);
626 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
632 return jtag_tap_configure_cmd( &goi
, t
);
639 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
641 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
643 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
644 COMMAND_CONFIG
, "try to configure interface");
645 register_command(cmd_ctx
, NULL
,
646 "interface_list", &handle_interface_list_command
,
647 COMMAND_ANY
, "list all built-in interfaces");
648 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
649 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
650 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
651 COMMAND_ANY
, "set maximum jtag speed (if supported); "
652 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
653 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
654 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
655 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
657 "[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]");
658 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
659 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
660 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
661 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
663 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
664 COMMAND_EXEC
, "print current scan chain configuration");
666 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
667 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
668 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
669 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
670 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
671 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
672 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
673 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
674 register_jim(cmd_ctx
, "pathmove", Jim_Command_pathmove
, "move JTAG to state1 then to state2, state3, etc. <state1>,<state2>,<stat3>...");
676 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
677 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
678 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
679 COMMAND_ANY
, "verify value capture <enable|disable>");
680 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
681 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
685 static int default_khz(int khz
, int *jtag_speed
)
687 LOG_ERROR("Translation from khz to jtag_speed not implemented");
691 static int default_speed_div(int speed
, int *khz
)
693 LOG_ERROR("Translation from jtag_speed to khz not implemented");
697 static int default_power_dropout(int *dropout
)
699 *dropout
=0; /* by default we can't detect power dropout */
703 static int default_srst_asserted(int *srst_asserted
)
705 *srst_asserted
=0; /* by default we can't detect srst asserted */
709 static int handle_interface_command(struct command_context_s
*cmd_ctx
,
710 char *cmd
, char **args
, int argc
)
712 /* check whether the interface is already configured */
715 LOG_WARNING("Interface already configured, ignoring");
719 /* interface name is a mandatory argument */
720 if (argc
!= 1 || args
[0][0] == '\0')
721 return ERROR_COMMAND_SYNTAX_ERROR
;
723 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
725 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) != 0)
728 int retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
);
729 if (ERROR_OK
!= retval
)
732 jtag_interface
= jtag_interfaces
[i
];
734 if (jtag_interface
->khz
== NULL
)
735 jtag_interface
->khz
= default_khz
;
736 if (jtag_interface
->speed_div
== NULL
)
737 jtag_interface
->speed_div
= default_speed_div
;
738 if (jtag_interface
->power_dropout
== NULL
)
739 jtag_interface
->power_dropout
= default_power_dropout
;
740 if (jtag_interface
->srst_asserted
== NULL
)
741 jtag_interface
->srst_asserted
= default_srst_asserted
;
746 /* no valid interface was found (i.e. the configuration option,
747 * didn't match one of the compiled-in interfaces
749 LOG_ERROR("The specified JTAG interface was not found (%s)", args
[0]);
750 handle_interface_list_command(cmd_ctx
, cmd
, args
, argc
);
751 return ERROR_JTAG_INVALID_INTERFACE
;
754 static int handle_interface_list_command(struct command_context_s
*cmd_ctx
,
755 char *cmd
, char **args
, int argc
)
757 if (strcmp(cmd
, "interface_list") == 0 && argc
> 0)
758 return ERROR_COMMAND_SYNTAX_ERROR
;
760 command_print(cmd_ctx
, "The following JTAG interfaces are available:");
761 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
763 const char *name
= jtag_interfaces
[i
]->name
;
764 command_print(cmd_ctx
, "%u: %s", i
+ 1, name
);
770 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
774 Jim_Obj
*newargs
[ 10 ];
778 * argv[ 0] = ir length
779 * argv[ 1] = ir capture
781 * argv[ 3] = not actually used by anything but in the docs
785 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
788 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
789 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
793 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
794 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
795 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
796 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
798 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
799 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
800 sprintf( buf
, "chip%d", jtag_tap_count() );
801 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
802 sprintf( buf
, "tap%d", jtag_tap_count() );
803 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
804 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
805 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
806 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
807 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
808 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
809 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
811 command_print( cmd_ctx
, "NEW COMMAND:");
812 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
813 Jim_GetString( newargs
[0], NULL
),
814 Jim_GetString( newargs
[1], NULL
),
815 Jim_GetString( newargs
[2], NULL
),
816 Jim_GetString( newargs
[3], NULL
),
817 Jim_GetString( newargs
[4], NULL
),
818 Jim_GetString( newargs
[5], NULL
),
819 Jim_GetString( newargs
[6], NULL
),
820 Jim_GetString( newargs
[7], NULL
),
821 Jim_GetString( newargs
[8], NULL
),
822 Jim_GetString( newargs
[9], NULL
) );
824 e
= jim_jtag_command( interp
, 10, newargs
);
826 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
831 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
835 tap
= jtag_all_taps();
836 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
837 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
840 u32 expected
, expected_mask
, cur_instr
, ii
;
841 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
842 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
843 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
845 command_print(cmd_ctx
,
846 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
847 tap
->abs_chain_position
,
849 tap
->enabled
? 'Y' : 'n',
851 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
857 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
858 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
859 tap
->expected_ids
[ii
]);
868 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
874 return ERROR_COMMAND_SYNTAX_ERROR
;
876 /* Original versions cared about the order of these tokens:
877 * reset_config signals [combination [trst_type [srst_type]]]
878 * They also clobbered the previous configuration even on error.
880 * Here we don't care about the order, and only change values
881 * which have been explicitly specified.
883 for (; argc
; argc
--, args
++) {
888 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
889 if (strcmp(*args
, "none") == 0)
891 else if (strcmp(*args
, "trst_only") == 0)
892 tmp
= RESET_HAS_TRST
;
893 else if (strcmp(*args
, "srst_only") == 0)
894 tmp
= RESET_HAS_SRST
;
895 else if (strcmp(*args
, "trst_and_srst") == 0)
896 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
900 LOG_ERROR("extra reset_config %s spec (%s)",
902 return ERROR_INVALID_ARGUMENTS
;
907 /* combination (options for broken wiring) */
908 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
909 if (strcmp(*args
, "separate") == 0)
910 /* separate reset lines - default */;
911 else if (strcmp(*args
, "srst_pulls_trst") == 0)
912 tmp
|= RESET_SRST_PULLS_TRST
;
913 else if (strcmp(*args
, "trst_pulls_srst") == 0)
914 tmp
|= RESET_TRST_PULLS_SRST
;
915 else if (strcmp(*args
, "combined") == 0)
916 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
920 LOG_ERROR("extra reset_config %s spec (%s)",
921 "combination", *args
);
922 return ERROR_INVALID_ARGUMENTS
;
927 /* trst_type (NOP without HAS_TRST) */
928 m
= RESET_TRST_OPEN_DRAIN
;
929 if (strcmp(*args
, "trst_open_drain") == 0)
930 tmp
|= RESET_TRST_OPEN_DRAIN
;
931 else if (strcmp(*args
, "trst_push_pull") == 0)
932 /* push/pull from adapter - default */;
936 LOG_ERROR("extra reset_config %s spec (%s)",
938 return ERROR_INVALID_ARGUMENTS
;
943 /* srst_type (NOP without HAS_SRST) */
944 m
|= RESET_SRST_PUSH_PULL
;
945 if (strcmp(*args
, "srst_push_pull") == 0)
946 tmp
|= RESET_SRST_PUSH_PULL
;
947 else if (strcmp(*args
, "srst_open_drain") == 0)
948 /* open drain from adapter - default */;
952 LOG_ERROR("extra reset_config %s spec (%s)",
954 return ERROR_INVALID_ARGUMENTS
;
959 /* caller provided nonsense; fail */
960 LOG_ERROR("unknown reset_config flag (%s)", *args
);
961 return ERROR_INVALID_ARGUMENTS
;
964 /* Remember the bits which were specified (mask)
965 * and their new values (new_cfg).
971 /* clear previous values of those bits, save new values */
972 enum reset_types old_cfg
= jtag_get_reset_config();
975 jtag_set_reset_config(new_cfg
);
980 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
981 char *cmd
, char **args
, int argc
)
984 return ERROR_COMMAND_SYNTAX_ERROR
;
988 int retval
= parse_uint(args
[0], &delay
);
989 if (ERROR_OK
!= retval
)
991 jtag_set_nsrst_delay(delay
);
993 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
997 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
998 char *cmd
, char **args
, int argc
)
1001 return ERROR_COMMAND_SYNTAX_ERROR
;
1005 int retval
= parse_uint(args
[0], &delay
);
1006 if (ERROR_OK
!= retval
)
1008 jtag_set_ntrst_delay(delay
);
1010 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
1014 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1016 int retval
= ERROR_OK
;
1019 return ERROR_COMMAND_SYNTAX_ERROR
;
1022 LOG_DEBUG("handle jtag speed");
1024 unsigned cur_speed
= 0;
1025 int retval
= parse_uint(args
[0], &cur_speed
);
1026 if (ERROR_OK
!= retval
)
1028 retval
= jtag_set_speed(cur_speed
);
1031 command_print(cmd_ctx
, "jtag_speed: %d", jtag_get_speed());
1036 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1039 return ERROR_COMMAND_SYNTAX_ERROR
;
1041 int retval
= ERROR_OK
;
1045 int retval
= parse_uint(args
[0], &khz
);
1046 if (ERROR_OK
!= retval
)
1048 retval
= jtag_config_khz(khz
);
1049 if (ERROR_OK
!= retval
)
1053 int cur_speed
= jtag_get_speed_khz();
1054 retval
= jtag_get_speed_readable(&cur_speed
);
1055 if (ERROR_OK
!= retval
)
1059 command_print(cmd_ctx
, "%d kHz", cur_speed
);
1061 command_print(cmd_ctx
, "RCLK - adaptive");
1066 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
1067 char *cmd
, char **args
, int argc
)
1070 return ERROR_COMMAND_SYNTAX_ERROR
;
1073 if (args
[0][0] == '1')
1075 else if (args
[0][0] == '0')
1078 return ERROR_COMMAND_SYNTAX_ERROR
;
1081 if (args
[1][0] == '1')
1083 else if (args
[1][0] == '0')
1086 return ERROR_COMMAND_SYNTAX_ERROR
;
1088 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
1089 return ERROR_JTAG_INIT_FAILED
;
1091 jtag_add_reset(trst
, srst
);
1092 jtag_execute_queue();
1097 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
1098 char *cmd
, char **args
, int argc
)
1101 return ERROR_COMMAND_SYNTAX_ERROR
;
1103 unsigned num_clocks
;
1104 int retval
= parse_uint(args
[0], &num_clocks
);
1105 if (ERROR_OK
!= retval
)
1108 jtag_add_runtest(num_clocks
, jtag_get_end_state());
1109 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] );
1188 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
1191 int field_size
= tap
->ir_length
;
1192 fields
[i
].tap
= tap
;
1193 fields
[i
].num_bits
= field_size
;
1194 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
1197 retval
= parse_u32(args
[i
* 2 + 1], &value
);
1198 if (ERROR_OK
!= retval
)
1200 buf_set_u32(fields
[i
].out_value
, 0, field_size
, value
);
1201 fields
[i
].in_value
= NULL
;
1204 /* did we have an endstate? */
1205 jtag_add_ir_scan(num_fields
, fields
, endstate
);
1207 retval
= jtag_execute_queue();
1210 for (i
= 0; i
< num_fields
; i
++)
1212 if (NULL
!= fields
[i
].out_value
)
1213 free(fields
[i
].out_value
);
1221 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1224 scan_field_t
*fields
;
1226 int field_count
= 0;
1229 tap_state_t endstate
;
1232 * args[2] = num_bits
1233 * args[3] = hex string
1234 * ... repeat num bits and hex string ...
1237 * args[N-2] = "-endstate"
1238 * args[N-1] = statename
1240 if ((argc
< 4) || ((argc
% 2)!=0))
1242 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
1246 endstate
= TAP_IDLE
;
1248 script_debug(interp
, "drscan", argc
, args
);
1250 /* validate arguments as numbers */
1252 for (i
= 2; i
< argc
; i
+=2)
1257 e
= Jim_GetLong(interp
, args
[i
], &bits
);
1258 /* If valid - try next arg */
1263 /* Not valid.. are we at the end? */
1264 if ( ((i
+2) != argc
) ){
1265 /* nope, then error */
1269 /* it could be: "-endstate FOO"
1270 * e.g. DRPAUSE so we can issue more instructions
1271 * before entering RUN/IDLE and executing them.
1274 /* get arg as a string. */
1275 cp
= Jim_GetString( args
[i
], NULL
);
1276 /* is it the magic? */
1277 if( 0 == strcmp( "-endstate", cp
) ){
1278 /* is the statename valid? */
1279 cp
= Jim_GetString( args
[i
+1], NULL
);
1281 /* see if it is a valid state name */
1282 endstate
= tap_state_by_name(cp
);
1284 /* update the error message */
1285 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
1287 if (!scan_is_safe(endstate
))
1288 LOG_WARNING("drscan with unsafe "
1289 "endstate \"%s\"", cp
);
1291 /* valid - so clear the error */
1293 /* and remove the last 2 args */
1298 /* Still an error? */
1300 return e
; /* too bad */
1302 } /* validate args */
1304 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
1309 num_fields
=(argc
-2)/2;
1310 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
1311 for (i
= 2; i
< argc
; i
+=2)
1317 Jim_GetLong(interp
, args
[i
], &bits
);
1318 str
= Jim_GetString(args
[i
+1], &len
);
1320 fields
[field_count
].tap
= tap
;
1321 fields
[field_count
].num_bits
= bits
;
1322 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
1323 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
1324 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
1328 jtag_add_dr_scan(num_fields
, fields
, endstate
);
1330 retval
= jtag_execute_queue();
1331 if (retval
!= ERROR_OK
)
1333 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
1338 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1339 for (i
= 2; i
< argc
; i
+=2)
1344 Jim_GetLong(interp
, args
[i
], &bits
);
1345 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
1346 free(fields
[field_count
].out_value
);
1348 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
1353 Jim_SetResult(interp
, list
);
1361 static int Jim_Command_pathmove(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1363 tap_state_t states
[8];
1365 if ((argc
< 2) || ((size_t)argc
> (sizeof(states
)/sizeof(*states
)+1)))
1367 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
1371 script_debug(interp
, "pathmove", argc
, args
);
1374 for (i
=0; i
<argc
-1; i
++)
1377 cp
= Jim_GetString( args
[i
+1], NULL
);
1378 states
[i
] = tap_state_by_name(cp
);
1381 /* update the error message */
1382 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
1387 if ((jtag_add_statemove(states
[0]) != ERROR_OK
) || ( jtag_execute_queue()!= ERROR_OK
))
1389 Jim_SetResultString(interp
, "pathmove: jtag execute failed",-1);
1393 jtag_add_pathmove(argc
-2, states
+1);
1395 if (jtag_execute_queue()!= ERROR_OK
)
1397 Jim_SetResultString(interp
, "pathmove: failed",-1);
1405 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1407 script_debug(interp
, "flush_count", argc
, args
);
1409 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
1415 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1418 return ERROR_COMMAND_SYNTAX_ERROR
;
1422 if (strcmp(args
[0], "enable") == 0)
1423 jtag_set_verify_capture_ir(true);
1424 else if (strcmp(args
[0], "disable") == 0)
1425 jtag_set_verify_capture_ir(false);
1427 return ERROR_COMMAND_SYNTAX_ERROR
;
1430 const char *status
= jtag_will_verify_capture_ir() ? "enabled": "disabled";
1431 command_print(cmd_ctx
, "verify Capture-IR is %s", status
);
1436 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1439 return ERROR_COMMAND_SYNTAX_ERROR
;
1443 if (strcmp(args
[0], "enable") == 0)
1444 jtag_set_verify(true);
1445 else if (strcmp(args
[0], "disable") == 0)
1446 jtag_set_verify(false);
1448 return ERROR_COMMAND_SYNTAX_ERROR
;
1451 const char *status
= jtag_will_verify() ? "enabled": "disabled";
1452 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
1457 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1460 return ERROR_COMMAND_SYNTAX_ERROR
;
1465 if (strcmp(args
[0], "short") == 0)
1466 use_new_table
= true;
1467 else if (strcmp(args
[0], "long") == 0)
1468 use_new_table
= false;
1470 return ERROR_COMMAND_SYNTAX_ERROR
;
1472 tap_use_new_tms_table(use_new_table
);
1475 command_print(cmd_ctx
, "tms sequence is %s",
1476 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)