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_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
);
194 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
195 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
196 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
);
198 extern int jtag_examine_chain(void);
199 extern int jtag_validate_chain(void);
201 enum jtag_tap_cfg_param
{
205 static Jim_Nvp nvp_config_opts
[] = {
206 { .name
= "-event", .value
= JCFG_EVENT
},
208 { .name
= NULL
, .value
= -1 }
211 static int jtag_tap_configure_cmd( Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
217 /* parse config or cget options */
218 while (goi
->argc
> 0) {
219 Jim_SetEmptyResult (goi
->interp
);
221 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
223 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
229 if (goi
->argc
== 0) {
230 Jim_WrongNumArgs( goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ..." );
234 e
= Jim_GetOpt_Nvp( goi
, nvp_jtag_tap_event
, &n
);
236 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
240 if (goi
->isconfigure
) {
241 if (goi
->argc
!= 1) {
242 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
246 if (goi
->argc
!= 0) {
247 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
253 jtag_tap_event_action_t
*jteap
;
255 jteap
= tap
->event_action
;
256 /* replace existing? */
258 if (jteap
->event
== (enum jtag_tap_event
)n
->value
) {
264 if (goi
->isconfigure
) {
267 jteap
= calloc(1, sizeof (*jteap
));
269 jteap
->event
= n
->value
;
270 Jim_GetOpt_Obj( goi
, &o
);
272 Jim_DecrRefCount(interp
, jteap
->body
);
274 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
275 Jim_IncrRefCount(jteap
->body
);
277 /* add to head of event list */
278 jteap
->next
= tap
->event_action
;
279 tap
->event_action
= jteap
;
280 Jim_SetEmptyResult(goi
->interp
);
284 Jim_SetEmptyResult(goi
->interp
);
286 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
293 } /* while (goi->argc) */
299 extern void jtag_tap_init(jtag_tap_t
*tap
);
300 extern void jtag_tap_free(jtag_tap_t
*tap
);
302 static int jim_newtap_cmd( Jim_GetOptInfo
*goi
)
311 const Jim_Nvp opts
[] = {
312 #define NTAP_OPT_IRLEN 0
313 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
314 #define NTAP_OPT_IRMASK 1
315 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
316 #define NTAP_OPT_IRCAPTURE 2
317 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
318 #define NTAP_OPT_ENABLED 3
319 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
320 #define NTAP_OPT_DISABLED 4
321 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
322 #define NTAP_OPT_EXPECTED_ID 5
323 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
324 { .name
= NULL
, .value
= -1 },
327 pTap
= malloc( sizeof(jtag_tap_t
) );
328 memset( pTap
, 0, sizeof(*pTap
) );
330 Jim_SetResult_sprintf( goi
->interp
, "no memory");
334 * we expect CHIP + TAP + OPTIONS
337 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
340 Jim_GetOpt_String( goi
, &cp
, NULL
);
341 pTap
->chip
= strdup(cp
);
343 Jim_GetOpt_String( goi
, &cp
, NULL
);
344 pTap
->tapname
= strdup(cp
);
346 /* name + dot + name + null */
347 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
349 sprintf( cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
350 pTap
->dotted_name
= cp
;
352 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
353 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
355 /* default is enabled */
358 /* deal with options */
359 #define NTREQ_IRLEN 1
360 #define NTREQ_IRCAPTURE 2
361 #define NTREQ_IRMASK 4
363 /* clear them as we find them */
364 reqbits
= (NTREQ_IRLEN
| NTREQ_IRCAPTURE
| NTREQ_IRMASK
);
367 e
= Jim_GetOpt_Nvp( goi
, opts
, &n
);
369 Jim_GetOpt_NvpUnknown( goi
, opts
, 0 );
372 LOG_DEBUG("Processing option: %s", n
->name
);
374 case NTAP_OPT_ENABLED
:
377 case NTAP_OPT_DISABLED
:
380 case NTAP_OPT_EXPECTED_ID
:
382 u32
*new_expected_ids
;
384 e
= Jim_GetOpt_Wide( goi
, &w
);
386 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
390 new_expected_ids
= malloc(sizeof(u32
) * (pTap
->expected_ids_cnt
+ 1));
391 if (new_expected_ids
== NULL
) {
392 Jim_SetResult_sprintf( goi
->interp
, "no memory");
396 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(u32
) * pTap
->expected_ids_cnt
);
398 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
400 free(pTap
->expected_ids
);
401 pTap
->expected_ids
= new_expected_ids
;
402 pTap
->expected_ids_cnt
++;
406 case NTAP_OPT_IRMASK
:
407 case NTAP_OPT_IRCAPTURE
:
408 e
= Jim_GetOpt_Wide( goi
, &w
);
410 Jim_SetResult_sprintf( goi
->interp
, "option: %s bad parameter", n
->name
);
413 if( (w
< 0) || (w
> 0xffff) ){
415 Jim_SetResult_sprintf( goi
->interp
, "option: %s - wacky value: %d (0x%x)",
416 n
->name
, (int)(w
), (int)(w
));
422 reqbits
&= (~(NTREQ_IRLEN
));
424 case NTAP_OPT_IRMASK
:
425 pTap
->ir_capture_mask
= w
;
426 reqbits
&= (~(NTREQ_IRMASK
));
428 case NTAP_OPT_IRCAPTURE
:
429 pTap
->ir_capture_value
= w
;
430 reqbits
&= (~(NTREQ_IRCAPTURE
));
433 } /* switch(n->value) */
434 } /* while( goi->argc ) */
436 /* Did all the required option bits get cleared? */
443 Jim_SetResult_sprintf(goi
->interp
,
444 "newtap: %s missing required parameters",
450 static void jtag_tap_handle_event( jtag_tap_t
* tap
, enum jtag_tap_event e
)
452 jtag_tap_event_action_t
* jteap
;
455 jteap
= tap
->event_action
;
459 if (jteap
->event
== e
) {
461 LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n",
464 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
465 Jim_GetString(jteap
->body
, NULL
) );
466 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
467 Jim_PrintErrorMessage(interp
);
475 LOG_DEBUG( "event %d %s - no action",
477 Jim_Nvp_value2name_simple( nvp_jtag_tap_event
, e
)->name
);
482 static int jim_jtag_command( Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
488 struct command_context_s
*context
;
496 JTAG_CMD_TAPISENABLED
,
501 const Jim_Nvp jtag_cmds
[] = {
502 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
503 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
504 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
505 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
506 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
507 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
508 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
509 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
511 { .name
= NULL
, .value
= -1 },
514 context
= Jim_GetAssocData(interp
, "context");
515 /* go past the command */
516 Jim_GetOpt_Setup( &goi
, interp
, argc
-1, argv
+1 );
518 e
= Jim_GetOpt_Nvp( &goi
, jtag_cmds
, &n
);
520 Jim_GetOpt_NvpUnknown( &goi
, jtag_cmds
, 0 );
523 Jim_SetEmptyResult( goi
.interp
);
525 case JTAG_CMD_INTERFACE
:
526 /* return the name of the interface */
527 /* TCL code might need to know the exact type... */
528 /* FUTURE: we allow this as a means to "set" the interface. */
530 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
533 Jim_SetResultString( goi
.interp
, jtag_interface
->name
, -1 );
535 case JTAG_CMD_INIT_RESET
:
537 Jim_WrongNumArgs( goi
.interp
, 1, goi
.argv
-1, "(no params)");
540 e
= jtag_init_reset(context
);
542 Jim_SetResult_sprintf( goi
.interp
, "error: %d", e
);
546 case JTAG_CMD_NEWTAP
:
547 return jim_newtap_cmd( &goi
);
549 case JTAG_CMD_TAPISENABLED
:
550 case JTAG_CMD_TAPENABLE
:
551 case JTAG_CMD_TAPDISABLE
:
553 Jim_SetResultString( goi
.interp
, "Too many parameters",-1 );
559 t
= jtag_tap_by_jim_obj( goi
.interp
, goi
.argv
[0] );
564 case JTAG_CMD_TAPISENABLED
:
567 case JTAG_CMD_TAPENABLE
:
568 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_ENABLE
);
572 case JTAG_CMD_TAPDISABLE
:
573 jtag_tap_handle_event( t
, JTAG_TAP_EVENT_DISABLE
);
578 Jim_SetResult( goi
.interp
, Jim_NewIntObj( goi
.interp
, e
) );
585 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ...");
592 Jim_GetOpt_Obj(&goi
, &o
);
593 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
599 return jtag_tap_configure_cmd( &goi
, t
);
603 case JTAG_CMD_CONFIGURE
:
605 Jim_WrongNumArgs( goi
.interp
, 0, NULL
, "?tap-name? -option ?VALUE? ...");
612 Jim_GetOpt_Obj(&goi
, &o
);
613 t
= jtag_tap_by_jim_obj( goi
.interp
, o
);
619 return jtag_tap_configure_cmd( &goi
, t
);
626 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
628 register_jim( cmd_ctx
, "jtag", jim_jtag_command
, "perform jtag tap actions");
630 register_command(cmd_ctx
, NULL
, "interface", handle_interface_command
,
631 COMMAND_CONFIG
, "try to configure interface");
632 register_command(cmd_ctx
, NULL
,
633 "interface_list", &handle_interface_list_command
,
634 COMMAND_ANY
, "list all built-in interfaces");
635 register_command(cmd_ctx
, NULL
, "jtag_speed", handle_jtag_speed_command
,
636 COMMAND_ANY
, "(DEPRECATED) set jtag speed (if supported)");
637 register_command(cmd_ctx
, NULL
, "jtag_khz", handle_jtag_khz_command
,
638 COMMAND_ANY
, "set maximum jtag speed (if supported); "
639 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
640 register_command(cmd_ctx
, NULL
, "jtag_device", handle_jtag_device_command
,
641 COMMAND_CONFIG
, "(DEPRECATED) jtag_device <ir_length> <ir_expected> <ir_mask>");
642 register_command(cmd_ctx
, NULL
, "reset_config", handle_reset_config_command
,
644 "[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]");
645 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command
,
646 COMMAND_ANY
, "jtag_nsrst_delay <ms> - delay after deasserting srst in ms");
647 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command
,
648 COMMAND_ANY
, "jtag_ntrst_delay <ms> - delay after deasserting trst in ms");
650 register_command(cmd_ctx
, NULL
, "scan_chain", handle_scan_chain_command
,
651 COMMAND_EXEC
, "print current scan chain configuration");
653 register_command(cmd_ctx
, NULL
, "jtag_reset", handle_jtag_reset_command
,
654 COMMAND_EXEC
, "toggle reset lines <trst> <srst>");
655 register_command(cmd_ctx
, NULL
, "runtest", handle_runtest_command
,
656 COMMAND_EXEC
, "move to Run-Test/Idle, and execute <num_cycles>");
657 register_command(cmd_ctx
, NULL
, "irscan", handle_irscan_command
,
658 COMMAND_EXEC
, "execute IR scan <device> <instr> [dev2] [instr2] ...");
659 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
, "execute DR scan <device> <num_bits> <value> <num_bits1> <value2> ...");
660 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
, "returns number of times the JTAG queue has been flushed");
662 register_command(cmd_ctx
, NULL
, "verify_ircapture", handle_verify_ircapture_command
,
663 COMMAND_ANY
, "verify value captured during Capture-IR <enable|disable>");
664 register_command(cmd_ctx
, NULL
, "verify_jtag", handle_verify_jtag_command
,
665 COMMAND_ANY
, "verify value capture <enable|disable>");
666 register_command(cmd_ctx
, NULL
, "tms_sequence", handle_tms_sequence_command
,
667 COMMAND_ANY
, "choose short(default) or long tms_sequence <short|long>");
671 static int default_khz(int khz
, int *jtag_speed
)
673 LOG_ERROR("Translation from khz to jtag_speed not implemented");
677 static int default_speed_div(int speed
, int *khz
)
679 LOG_ERROR("Translation from jtag_speed to khz not implemented");
683 static int default_power_dropout(int *dropout
)
685 *dropout
=0; /* by default we can't detect power dropout */
689 static int default_srst_asserted(int *srst_asserted
)
691 *srst_asserted
=0; /* by default we can't detect srst asserted */
695 static int handle_interface_command(struct command_context_s
*cmd_ctx
,
696 char *cmd
, char **args
, int argc
)
698 /* check whether the interface is already configured */
701 LOG_WARNING("Interface already configured, ignoring");
705 /* interface name is a mandatory argument */
706 if (argc
!= 1 || args
[0][0] == '\0')
707 return ERROR_COMMAND_SYNTAX_ERROR
;
709 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
711 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) != 0)
714 int retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
);
715 if (ERROR_OK
!= retval
)
718 jtag_interface
= jtag_interfaces
[i
];
720 if (jtag_interface
->khz
== NULL
)
721 jtag_interface
->khz
= default_khz
;
722 if (jtag_interface
->speed_div
== NULL
)
723 jtag_interface
->speed_div
= default_speed_div
;
724 if (jtag_interface
->power_dropout
== NULL
)
725 jtag_interface
->power_dropout
= default_power_dropout
;
726 if (jtag_interface
->srst_asserted
== NULL
)
727 jtag_interface
->srst_asserted
= default_srst_asserted
;
732 /* no valid interface was found (i.e. the configuration option,
733 * didn't match one of the compiled-in interfaces
735 LOG_ERROR("The specified JTAG interface was not found (%s)", args
[0]);
736 handle_interface_list_command(cmd_ctx
, cmd
, args
, argc
);
737 return ERROR_JTAG_INVALID_INTERFACE
;
740 static int handle_interface_list_command(struct command_context_s
*cmd_ctx
,
741 char *cmd
, char **args
, int argc
)
743 if (strcmp(cmd
, "interface_list") == 0 && argc
> 0)
744 return ERROR_COMMAND_SYNTAX_ERROR
;
746 command_print(cmd_ctx
, "The following JTAG interfaces are available:");
747 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
749 const char *name
= jtag_interfaces
[i
]->name
;
750 command_print(cmd_ctx
, "%u: %s", i
+ 1, name
);
756 static int handle_jtag_device_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
760 Jim_Obj
*newargs
[ 10 ];
764 * argv[ 0] = ir length
765 * argv[ 1] = ir capture
767 * argv[ 3] = not actually used by anything but in the docs
771 command_print( cmd_ctx
, "OLD DEPRECATED SYNTAX: Please use the NEW syntax");
774 command_print( cmd_ctx
, "OLD SYNTAX: DEPRECATED - translating to new syntax");
775 command_print( cmd_ctx
, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s",
779 command_print( cmd_ctx
, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)");
780 command_print( cmd_ctx
, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\"");
781 command_print( cmd_ctx
, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\"");
782 command_print( cmd_ctx
, "And then refer to the taps by the dotted name.");
784 newargs
[0] = Jim_NewStringObj( interp
, "jtag", -1 );
785 newargs
[1] = Jim_NewStringObj( interp
, "newtap", -1 );
786 sprintf( buf
, "chip%d", jtag_tap_count() );
787 newargs
[2] = Jim_NewStringObj( interp
, buf
, -1 );
788 sprintf( buf
, "tap%d", jtag_tap_count() );
789 newargs
[3] = Jim_NewStringObj( interp
, buf
, -1 );
790 newargs
[4] = Jim_NewStringObj( interp
, "-irlen", -1 );
791 newargs
[5] = Jim_NewStringObj( interp
, args
[0], -1 );
792 newargs
[6] = Jim_NewStringObj( interp
, "-ircapture", -1 );
793 newargs
[7] = Jim_NewStringObj( interp
, args
[1], -1 );
794 newargs
[8] = Jim_NewStringObj( interp
, "-irmask", -1 );
795 newargs
[9] = Jim_NewStringObj( interp
, args
[2], -1 );
797 command_print( cmd_ctx
, "NEW COMMAND:");
798 sprintf( buf
, "%s %s %s %s %s %s %s %s %s %s",
799 Jim_GetString( newargs
[0], NULL
),
800 Jim_GetString( newargs
[1], NULL
),
801 Jim_GetString( newargs
[2], NULL
),
802 Jim_GetString( newargs
[3], NULL
),
803 Jim_GetString( newargs
[4], NULL
),
804 Jim_GetString( newargs
[5], NULL
),
805 Jim_GetString( newargs
[6], NULL
),
806 Jim_GetString( newargs
[7], NULL
),
807 Jim_GetString( newargs
[8], NULL
),
808 Jim_GetString( newargs
[9], NULL
) );
810 e
= jim_jtag_command( interp
, 10, newargs
);
812 command_print( cmd_ctx
, "%s", Jim_GetString( Jim_GetResult(interp
), NULL
) );
817 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
821 tap
= jtag_all_taps();
822 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
823 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
826 u32 expected
, expected_mask
, cur_instr
, ii
;
827 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
828 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
829 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
831 command_print(cmd_ctx
,
832 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
833 tap
->abs_chain_position
,
835 tap
->enabled
? 'Y' : 'n',
837 (tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
843 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
844 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
845 tap
->expected_ids
[ii
]);
854 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
860 return ERROR_COMMAND_SYNTAX_ERROR
;
862 /* Original versions cared about the order of these tokens:
863 * reset_config signals [combination [trst_type [srst_type]]]
864 * They also clobbered the previous configuration even on error.
866 * Here we don't care about the order, and only change values
867 * which have been explicitly specified.
869 for (; argc
; argc
--, args
++) {
874 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
875 if (strcmp(*args
, "none") == 0)
877 else if (strcmp(*args
, "trst_only") == 0)
878 tmp
= RESET_HAS_TRST
;
879 else if (strcmp(*args
, "srst_only") == 0)
880 tmp
= RESET_HAS_SRST
;
881 else if (strcmp(*args
, "trst_and_srst") == 0)
882 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
886 LOG_ERROR("extra reset_config %s spec (%s)",
888 return ERROR_INVALID_ARGUMENTS
;
893 /* combination (options for broken wiring) */
894 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
895 if (strcmp(*args
, "separate") == 0)
896 /* separate reset lines - default */;
897 else if (strcmp(*args
, "srst_pulls_trst") == 0)
898 tmp
|= RESET_SRST_PULLS_TRST
;
899 else if (strcmp(*args
, "trst_pulls_srst") == 0)
900 tmp
|= RESET_TRST_PULLS_SRST
;
901 else if (strcmp(*args
, "combined") == 0)
902 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
906 LOG_ERROR("extra reset_config %s spec (%s)",
907 "combination", *args
);
908 return ERROR_INVALID_ARGUMENTS
;
913 /* trst_type (NOP without HAS_TRST) */
914 m
= RESET_TRST_OPEN_DRAIN
;
915 if (strcmp(*args
, "trst_open_drain") == 0)
916 tmp
|= RESET_TRST_OPEN_DRAIN
;
917 else if (strcmp(*args
, "trst_push_pull") == 0)
918 /* push/pull from adapter - default */;
922 LOG_ERROR("extra reset_config %s spec (%s)",
924 return ERROR_INVALID_ARGUMENTS
;
929 /* srst_type (NOP without HAS_SRST) */
930 m
|= RESET_SRST_PUSH_PULL
;
931 if (strcmp(*args
, "srst_push_pull") == 0)
932 tmp
|= RESET_SRST_PUSH_PULL
;
933 else if (strcmp(*args
, "srst_open_drain") == 0)
934 /* open drain from adapter - default */;
938 LOG_ERROR("extra reset_config %s spec (%s)",
940 return ERROR_INVALID_ARGUMENTS
;
945 /* caller provided nonsense; fail */
946 LOG_ERROR("unknown reset_config flag (%s)", *args
);
947 return ERROR_INVALID_ARGUMENTS
;
950 /* Remember the bits which were specified (mask)
951 * and their new values (new_cfg).
957 /* clear previous values of those bits, save new values */
958 enum reset_types old_cfg
= jtag_get_reset_config();
961 jtag_set_reset_config(new_cfg
);
966 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
967 char *cmd
, char **args
, int argc
)
970 return ERROR_COMMAND_SYNTAX_ERROR
;
972 jtag_set_nsrst_delay(strtoul(args
[0], NULL
, 0));
973 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
977 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
978 char *cmd
, char **args
, int argc
)
981 return ERROR_COMMAND_SYNTAX_ERROR
;
983 jtag_set_ntrst_delay(strtoul(args
[0], NULL
, 0));
984 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
988 static int handle_jtag_speed_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
990 int retval
= ERROR_OK
;
993 return ERROR_COMMAND_SYNTAX_ERROR
;
996 LOG_DEBUG("handle jtag speed");
999 cur_speed
= strtoul(args
[0], NULL
, 0);
1000 retval
= jtag_set_speed(cur_speed
);
1003 command_print(cmd_ctx
, "jtag_speed: %d", jtag_get_speed());
1008 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1011 return ERROR_COMMAND_SYNTAX_ERROR
;
1013 int retval
= ERROR_OK
;
1016 retval
= jtag_config_khz(strtoul(args
[0], NULL
, 0));
1017 if (ERROR_OK
!= retval
)
1022 retval
= jtag_get_speed_readable(&cur_speed
);
1023 if (ERROR_OK
!= retval
)
1027 command_print(cmd_ctx
, "%d kHz", cur_speed
);
1029 command_print(cmd_ctx
, "RCLK - adaptive");
1034 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
1035 char *cmd
, char **args
, int argc
)
1038 return ERROR_COMMAND_SYNTAX_ERROR
;
1041 if (args
[0][0] == '1')
1043 else if (args
[0][0] == '0')
1046 return ERROR_COMMAND_SYNTAX_ERROR
;
1049 if (args
[1][0] == '1')
1051 else if (args
[1][0] == '0')
1054 return ERROR_COMMAND_SYNTAX_ERROR
;
1056 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
1057 return ERROR_JTAG_INIT_FAILED
;
1059 jtag_add_reset(trst
, srst
);
1060 jtag_execute_queue();
1065 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
1066 char *cmd
, char **args
, int argc
)
1069 return ERROR_COMMAND_SYNTAX_ERROR
;
1071 jtag_add_runtest(strtol(args
[0], NULL
, 0), jtag_get_end_state());
1072 jtag_execute_queue();
1078 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1079 * should be stable ... and *NOT* a shift state, otherwise free-running
1080 * jtag clocks could change the values latched by the update state.
1082 static bool scan_is_safe(tap_state_t state
)
1097 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1100 scan_field_t
*fields
;
1102 tap_state_t endstate
;
1104 if ((argc
< 2) || (argc
% 2))
1106 return ERROR_COMMAND_SYNTAX_ERROR
;
1109 /* optional "-endstate" "statename" at the end of the arguments,
1110 * so that e.g. IRPAUSE can let us load the data register before
1111 * entering RUN/IDLE to execute the instruction we load here.
1113 endstate
= TAP_IDLE
;
1116 /* have at least one pair of numbers. */
1117 /* is last pair the magic text? */
1118 if( 0 == strcmp( "-endstate", args
[ argc
- 2 ] ) ){
1121 cpA
= args
[ argc
-1 ];
1122 for( endstate
= 0 ; endstate
< TAP_NUM_STATES
; endstate
++ ){
1123 cpS
= tap_state_name( endstate
);
1124 if( 0 == strcmp( cpA
, cpS
) ){
1128 if( endstate
>= TAP_NUM_STATES
){
1129 return ERROR_COMMAND_SYNTAX_ERROR
;
1131 if (!scan_is_safe(endstate
))
1132 LOG_WARNING("irscan with unsafe "
1133 "endstate \"%s\"", cpA
);
1134 /* found - remove the last 2 args */
1140 int num_fields
= argc
/ 2;
1142 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
1144 for (i
= 0; i
< num_fields
; i
++)
1146 tap
= jtag_tap_by_string( args
[i
*2] );
1149 command_print( cmd_ctx
, "Tap: %s unknown", args
[i
*2] );
1152 int field_size
= tap
->ir_length
;
1153 fields
[i
].tap
= tap
;
1154 fields
[i
].num_bits
= field_size
;
1155 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
1156 buf_set_u32(fields
[i
].out_value
, 0, field_size
, strtoul(args
[i
*2+1], NULL
, 0));
1157 fields
[i
].in_value
= NULL
;
1160 /* did we have an endstate? */
1161 jtag_add_ir_scan(num_fields
, fields
, endstate
);
1163 int retval
=jtag_execute_queue();
1165 for (i
= 0; i
< num_fields
; i
++)
1166 free(fields
[i
].out_value
);
1173 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1176 scan_field_t
*fields
;
1178 int field_count
= 0;
1181 tap_state_t endstate
;
1184 * args[2] = num_bits
1185 * args[3] = hex string
1186 * ... repeat num bits and hex string ...
1189 * args[N-2] = "-endstate"
1190 * args[N-1] = statename
1192 if ((argc
< 4) || ((argc
% 2)!=0))
1194 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
1198 endstate
= TAP_IDLE
;
1200 /* validate arguments as numbers */
1202 for (i
= 2; i
< argc
; i
+=2)
1207 e
= Jim_GetLong(interp
, args
[i
], &bits
);
1208 /* If valid - try next arg */
1213 /* Not valid.. are we at the end? */
1214 if ( ((i
+2) != argc
) ){
1215 /* nope, then error */
1219 /* it could be: "-endstate FOO"
1220 * e.g. DRPAUSE so we can issue more instructions
1221 * before entering RUN/IDLE and executing them.
1224 /* get arg as a string. */
1225 cp
= Jim_GetString( args
[i
], NULL
);
1226 /* is it the magic? */
1227 if( 0 == strcmp( "-endstate", cp
) ){
1228 /* is the statename valid? */
1229 cp
= Jim_GetString( args
[i
+1], NULL
);
1231 /* see if it is a valid state name */
1232 endstate
= tap_state_by_name(cp
);
1234 /* update the error message */
1235 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
1237 if (!scan_is_safe(endstate
))
1238 LOG_WARNING("drscan with unsafe "
1239 "endstate \"%s\"", cp
);
1241 /* valid - so clear the error */
1243 /* and remove the last 2 args */
1248 /* Still an error? */
1250 return e
; /* too bad */
1252 } /* validate args */
1254 tap
= jtag_tap_by_jim_obj( interp
, args
[1] );
1259 num_fields
=(argc
-2)/2;
1260 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
1261 for (i
= 2; i
< argc
; i
+=2)
1267 Jim_GetLong(interp
, args
[i
], &bits
);
1268 str
= Jim_GetString(args
[i
+1], &len
);
1270 fields
[field_count
].tap
= tap
;
1271 fields
[field_count
].num_bits
= bits
;
1272 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
1273 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
1274 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
1278 jtag_add_dr_scan(num_fields
, fields
, endstate
);
1280 retval
= jtag_execute_queue();
1281 if (retval
!= ERROR_OK
)
1283 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
1288 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1289 for (i
= 2; i
< argc
; i
+=2)
1294 Jim_GetLong(interp
, args
[i
], &bits
);
1295 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
1296 free(fields
[field_count
].out_value
);
1298 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
1303 Jim_SetResult(interp
, list
);
1311 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1313 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
1319 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1322 return ERROR_COMMAND_SYNTAX_ERROR
;
1326 if (strcmp(args
[0], "enable") == 0)
1327 jtag_set_verify_capture_ir(true);
1328 else if (strcmp(args
[0], "disable") == 0)
1329 jtag_set_verify_capture_ir(false);
1331 return ERROR_COMMAND_SYNTAX_ERROR
;
1334 const char *status
= jtag_will_verify_capture_ir() ? "enabled": "disabled";
1335 command_print(cmd_ctx
, "verify Capture-IR is %s", status
);
1340 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1343 return ERROR_COMMAND_SYNTAX_ERROR
;
1347 if (strcmp(args
[0], "enable") == 0)
1348 jtag_set_verify(true);
1349 else if (strcmp(args
[0], "disable") == 0)
1350 jtag_set_verify(false);
1352 return ERROR_COMMAND_SYNTAX_ERROR
;
1355 const char *status
= jtag_will_verify() ? "enabled": "disabled";
1356 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
1361 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1364 return ERROR_COMMAND_SYNTAX_ERROR
;
1369 if (strcmp(args
[0], "short") == 0)
1370 use_new_table
= true;
1371 else if (strcmp(args
[0], "long") == 0)
1372 use_new_table
= false;
1374 return ERROR_COMMAND_SYNTAX_ERROR
;
1376 tap_use_new_tms_table(use_new_table
);
1379 command_print(cmd_ctx
, "tms sequence is %s",
1380 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)