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_TRST_ASSERTED
, .name
= "post-reset" },
45 { .value
= JTAG_TAP_EVENT_SETUP
, .name
= "setup" },
46 { .value
= JTAG_TAP_EVENT_ENABLE
, .name
= "tap-enable" },
47 { .value
= JTAG_TAP_EVENT_DISABLE
, .name
= "tap-disable" },
49 { .name
= NULL
, .value
= -1 }
52 extern jtag_interface_t
*jtag_interface
;
54 enum jtag_tap_cfg_param
{
58 static Jim_Nvp nvp_config_opts
[] = {
59 { .name
= "-event", .value
= JCFG_EVENT
},
61 { .name
= NULL
, .value
= -1 }
64 static int jtag_tap_configure_cmd(Jim_GetOptInfo
*goi
, jtag_tap_t
* tap
)
70 /* parse config or cget options */
71 while (goi
->argc
> 0) {
72 Jim_SetEmptyResult (goi
->interp
);
74 e
= Jim_GetOpt_Nvp(goi
, nvp_config_opts
, &n
);
76 Jim_GetOpt_NvpUnknown(goi
, nvp_config_opts
, 0);
83 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ...");
87 e
= Jim_GetOpt_Nvp(goi
, nvp_jtag_tap_event
, &n
);
89 Jim_GetOpt_NvpUnknown(goi
, nvp_jtag_tap_event
, 1);
93 if (goi
->isconfigure
) {
95 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name? ?EVENT-BODY?");
100 Jim_WrongNumArgs(goi
->interp
, goi
->argc
, goi
->argv
, "-event ?event-name?");
106 jtag_tap_event_action_t
*jteap
;
108 jteap
= tap
->event_action
;
109 /* replace existing? */
111 if (jteap
->event
== (enum jtag_event
)n
->value
) {
117 if (goi
->isconfigure
) {
121 jteap
= calloc(1, sizeof (*jteap
));
124 jteap
->event
= n
->value
;
125 Jim_GetOpt_Obj(goi
, &o
);
127 Jim_DecrRefCount(interp
, jteap
->body
);
129 jteap
->body
= Jim_DuplicateObj(goi
->interp
, o
);
130 Jim_IncrRefCount(jteap
->body
);
134 /* add to head of event list */
135 jteap
->next
= tap
->event_action
;
136 tap
->event_action
= jteap
;
138 Jim_SetEmptyResult(goi
->interp
);
142 Jim_SetEmptyResult(goi
->interp
);
144 Jim_SetResult(goi
->interp
, Jim_DuplicateObj(goi
->interp
, jteap
->body
));
151 } /* while (goi->argc) */
156 static int is_bad_irval(int ir_length
, jim_wide w
)
166 static int jim_newtap_cmd(Jim_GetOptInfo
*goi
)
174 const Jim_Nvp opts
[] = {
175 #define NTAP_OPT_IRLEN 0
176 { .name
= "-irlen" , .value
= NTAP_OPT_IRLEN
},
177 #define NTAP_OPT_IRMASK 1
178 { .name
= "-irmask" , .value
= NTAP_OPT_IRMASK
},
179 #define NTAP_OPT_IRCAPTURE 2
180 { .name
= "-ircapture" , .value
= NTAP_OPT_IRCAPTURE
},
181 #define NTAP_OPT_ENABLED 3
182 { .name
= "-enable" , .value
= NTAP_OPT_ENABLED
},
183 #define NTAP_OPT_DISABLED 4
184 { .name
= "-disable" , .value
= NTAP_OPT_DISABLED
},
185 #define NTAP_OPT_EXPECTED_ID 5
186 { .name
= "-expected-id" , .value
= NTAP_OPT_EXPECTED_ID
},
187 { .name
= NULL
, .value
= -1 },
190 pTap
= calloc(1, sizeof(jtag_tap_t
));
192 Jim_SetResult_sprintf(goi
->interp
, "no memory");
197 * we expect CHIP + TAP + OPTIONS
200 Jim_SetResult_sprintf(goi
->interp
, "Missing CHIP TAP OPTIONS ....");
204 Jim_GetOpt_String(goi
, &cp
, NULL
);
205 pTap
->chip
= strdup(cp
);
207 Jim_GetOpt_String(goi
, &cp
, NULL
);
208 pTap
->tapname
= strdup(cp
);
210 /* name + dot + name + null */
211 x
= strlen(pTap
->chip
) + 1 + strlen(pTap
->tapname
) + 1;
213 sprintf(cp
, "%s.%s", pTap
->chip
, pTap
->tapname
);
214 pTap
->dotted_name
= cp
;
216 LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params",
217 pTap
->chip
, pTap
->tapname
, pTap
->dotted_name
, goi
->argc
);
219 /* IEEE specifies that the two LSBs of an IR scan are 01, so make
220 * that the default. The "-irlen" and "-irmask" options are only
221 * needed to cope with nonstandard TAPs, or to specify more bits.
223 pTap
->ir_capture_mask
= 0x03;
224 pTap
->ir_capture_value
= 0x01;
227 e
= Jim_GetOpt_Nvp(goi
, opts
, &n
);
229 Jim_GetOpt_NvpUnknown(goi
, opts
, 0);
230 free((void *)pTap
->dotted_name
);
234 LOG_DEBUG("Processing option: %s", n
->name
);
236 case NTAP_OPT_ENABLED
:
237 pTap
->disabled_after_reset
= false;
239 case NTAP_OPT_DISABLED
:
240 pTap
->disabled_after_reset
= true;
242 case NTAP_OPT_EXPECTED_ID
:
244 uint32_t *new_expected_ids
;
246 e
= Jim_GetOpt_Wide(goi
, &w
);
248 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
249 free((void *)pTap
->dotted_name
);
254 new_expected_ids
= malloc(sizeof(uint32_t) * (pTap
->expected_ids_cnt
+ 1));
255 if (new_expected_ids
== NULL
) {
256 Jim_SetResult_sprintf(goi
->interp
, "no memory");
257 free((void *)pTap
->dotted_name
);
262 memcpy(new_expected_ids
, pTap
->expected_ids
, sizeof(uint32_t) * pTap
->expected_ids_cnt
);
264 new_expected_ids
[pTap
->expected_ids_cnt
] = w
;
266 free(pTap
->expected_ids
);
267 pTap
->expected_ids
= new_expected_ids
;
268 pTap
->expected_ids_cnt
++;
272 case NTAP_OPT_IRMASK
:
273 case NTAP_OPT_IRCAPTURE
:
274 e
= Jim_GetOpt_Wide(goi
, &w
);
276 Jim_SetResult_sprintf(goi
->interp
, "option: %s bad parameter", n
->name
);
277 free((void *)pTap
->dotted_name
);
283 if (w
> (jim_wide
) (8 * sizeof(pTap
->ir_capture_value
)))
284 LOG_WARNING("%s: huge IR length %d",
289 case NTAP_OPT_IRMASK
:
290 if (is_bad_irval(pTap
->ir_length
, w
)) {
291 LOG_ERROR("%s: IR mask %x too big",
294 free((void *)pTap
->dotted_name
);
299 LOG_WARNING("%s: nonstandard IR mask",
301 pTap
->ir_capture_mask
= w
;
303 case NTAP_OPT_IRCAPTURE
:
304 if (is_bad_irval(pTap
->ir_length
, w
)) {
305 LOG_ERROR("%s: IR capture %x too big",
308 free((void *)pTap
->dotted_name
);
313 LOG_WARNING("%s: nonstandard IR value",
315 pTap
->ir_capture_value
= w
;
318 } /* switch (n->value) */
319 } /* while (goi->argc) */
321 /* default is enabled-after-reset */
322 pTap
->enabled
= !pTap
->disabled_after_reset
;
324 /* Did all the required option bits get cleared? */
325 if (pTap
->ir_length
!= 0)
331 Jim_SetResult_sprintf(goi
->interp
,
332 "newtap: %s missing IR length",
338 static void jtag_tap_handle_event(jtag_tap_t
*tap
, enum jtag_event e
)
340 jtag_tap_event_action_t
* jteap
;
342 for (jteap
= tap
->event_action
; jteap
!= NULL
; jteap
= jteap
->next
) {
343 if (jteap
->event
== e
) {
344 LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s",
347 Jim_Nvp_value2name_simple(nvp_jtag_tap_event
, e
)->name
,
348 Jim_GetString(jteap
->body
, NULL
));
349 if (Jim_EvalObj(interp
, jteap
->body
) != JIM_OK
) {
350 Jim_PrintErrorMessage(interp
);
352 case JTAG_TAP_EVENT_ENABLE
:
353 case JTAG_TAP_EVENT_DISABLE
:
354 /* NOTE: we currently assume the handlers
355 * can't fail. Right here is where we should
356 * really be verifying the scan chains ...
358 tap
->enabled
= (e
== JTAG_TAP_EVENT_ENABLE
);
359 LOG_INFO("JTAG tap: %s %s", tap
->dotted_name
,
360 tap
->enabled
? "enabled" : "disabled");
370 static int jim_jtag_command(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *argv
)
376 struct command_context_s
*context
;
385 JTAG_CMD_TAPISENABLED
,
391 const Jim_Nvp jtag_cmds
[] = {
392 { .name
= "interface" , .value
= JTAG_CMD_INTERFACE
},
393 { .name
= "arp_init" , .value
= JTAG_CMD_INIT
},
394 { .name
= "arp_init-reset", .value
= JTAG_CMD_INIT_RESET
},
395 { .name
= "newtap" , .value
= JTAG_CMD_NEWTAP
},
396 { .name
= "tapisenabled" , .value
= JTAG_CMD_TAPISENABLED
},
397 { .name
= "tapenable" , .value
= JTAG_CMD_TAPENABLE
},
398 { .name
= "tapdisable" , .value
= JTAG_CMD_TAPDISABLE
},
399 { .name
= "configure" , .value
= JTAG_CMD_CONFIGURE
},
400 { .name
= "cget" , .value
= JTAG_CMD_CGET
},
401 { .name
= "names" , .value
= JTAG_CMD_NAMES
},
403 { .name
= NULL
, .value
= -1 },
406 context
= Jim_GetAssocData(interp
, "context");
407 /* go past the command */
408 Jim_GetOpt_Setup(&goi
, interp
, argc
-1, argv
+ 1);
410 e
= Jim_GetOpt_Nvp(&goi
, jtag_cmds
, &n
);
412 Jim_GetOpt_NvpUnknown(&goi
, jtag_cmds
, 0);
415 Jim_SetEmptyResult(goi
.interp
);
417 case JTAG_CMD_INTERFACE
:
418 /* return the name of the interface */
419 /* TCL code might need to know the exact type... */
420 /* FUTURE: we allow this as a means to "set" the interface. */
422 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
425 Jim_SetResultString(goi
.interp
, jtag_interface
->name
, -1);
429 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
432 e
= jtag_init_inner(context
);
434 Jim_SetResult_sprintf(goi
.interp
, "error: %d", e
);
438 case JTAG_CMD_INIT_RESET
:
440 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
-1, "(no params)");
443 e
= jtag_init_reset(context
);
445 Jim_SetResult_sprintf(goi
.interp
, "error: %d", e
);
449 case JTAG_CMD_NEWTAP
:
450 return jim_newtap_cmd(&goi
);
452 case JTAG_CMD_TAPISENABLED
:
453 case JTAG_CMD_TAPENABLE
:
454 case JTAG_CMD_TAPDISABLE
:
456 Jim_SetResultString(goi
.interp
, "Too many parameters",-1);
463 t
= jtag_tap_by_jim_obj(goi
.interp
, goi
.argv
[0]);
468 case JTAG_CMD_TAPISENABLED
:
470 case JTAG_CMD_TAPENABLE
:
473 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_ENABLE
);
477 /* FIXME add JTAG sanity checks, w/o TLR
478 * - scan chain length grew by one (this)
479 * - IDs and IR lengths are as expected
482 jtag_call_event_callbacks(JTAG_TAP_EVENT_ENABLE
);
484 case JTAG_CMD_TAPDISABLE
:
487 jtag_tap_handle_event(t
, JTAG_TAP_EVENT_DISABLE
);
491 /* FIXME add JTAG sanity checks, w/o TLR
492 * - scan chain length shrank by one (this)
493 * - IDs and IR lengths are as expected
496 jtag_call_event_callbacks(JTAG_TAP_EVENT_DISABLE
);
500 Jim_SetResult(goi
.interp
, Jim_NewIntObj(goi
.interp
, e
));
507 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
508 "cget tap_name queryparm");
515 Jim_GetOpt_Obj(&goi
, &o
);
516 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
522 return jtag_tap_configure_cmd(&goi
, t
);
526 case JTAG_CMD_CONFIGURE
:
528 Jim_WrongNumArgs(goi
.interp
, 0, NULL
,
529 "configure tap_name attribute value ...");
536 Jim_GetOpt_Obj(&goi
, &o
);
537 t
= jtag_tap_by_jim_obj(goi
.interp
, o
);
543 return jtag_tap_configure_cmd(&goi
, t
);
549 Jim_WrongNumArgs(goi
.interp
, 1, goi
.argv
, "Too many parameters");
552 Jim_SetResult(goi
.interp
, Jim_NewListObj(goi
.interp
, NULL
, 0));
556 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
) {
557 Jim_ListAppendElement(goi
.interp
,
558 Jim_GetResult(goi
.interp
),
559 Jim_NewStringObj(goi
.interp
,
560 tap
->dotted_name
, -1));
572 void jtag_notify_event(enum jtag_event event
)
576 for (tap
= jtag_all_taps(); tap
; tap
= tap
->next_tap
)
577 jtag_tap_handle_event(tap
, event
);
581 static int default_khz(int khz
, int *jtag_speed
)
583 LOG_ERROR("Translation from khz to jtag_speed not implemented");
587 static int default_speed_div(int speed
, int *khz
)
589 LOG_ERROR("Translation from jtag_speed to khz not implemented");
593 static int default_power_dropout(int *dropout
)
595 *dropout
= 0; /* by default we can't detect power dropout */
599 static int default_srst_asserted(int *srst_asserted
)
601 *srst_asserted
= 0; /* by default we can't detect srst asserted */
605 static int handle_interface_list_command(struct command_context_s
*cmd_ctx
,
606 char *cmd
, char **args
, int argc
)
608 if (strcmp(cmd
, "interface_list") == 0 && argc
> 0)
609 return ERROR_COMMAND_SYNTAX_ERROR
;
611 command_print(cmd_ctx
, "The following JTAG interfaces are available:");
612 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
614 const char *name
= jtag_interfaces
[i
]->name
;
615 command_print(cmd_ctx
, "%u: %s", i
+ 1, name
);
621 static int handle_interface_command(struct command_context_s
*cmd_ctx
,
622 char *cmd
, char **args
, int argc
)
624 /* check whether the interface is already configured */
627 LOG_WARNING("Interface already configured, ignoring");
631 /* interface name is a mandatory argument */
632 if (argc
!= 1 || args
[0][0] == '\0')
633 return ERROR_COMMAND_SYNTAX_ERROR
;
635 for (unsigned i
= 0; NULL
!= jtag_interfaces
[i
]; i
++)
637 if (strcmp(args
[0], jtag_interfaces
[i
]->name
) != 0)
640 int retval
= jtag_interfaces
[i
]->register_commands(cmd_ctx
);
641 if (ERROR_OK
!= retval
)
644 jtag_interface
= jtag_interfaces
[i
];
646 if (jtag_interface
->khz
== NULL
)
647 jtag_interface
->khz
= default_khz
;
648 if (jtag_interface
->speed_div
== NULL
)
649 jtag_interface
->speed_div
= default_speed_div
;
650 if (jtag_interface
->power_dropout
== NULL
)
651 jtag_interface
->power_dropout
= default_power_dropout
;
652 if (jtag_interface
->srst_asserted
== NULL
)
653 jtag_interface
->srst_asserted
= default_srst_asserted
;
658 /* no valid interface was found (i.e. the configuration option,
659 * didn't match one of the compiled-in interfaces
661 LOG_ERROR("The specified JTAG interface was not found (%s)", args
[0]);
662 handle_interface_list_command(cmd_ctx
, cmd
, args
, argc
);
663 return ERROR_JTAG_INVALID_INTERFACE
;
666 static int handle_scan_chain_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
670 tap
= jtag_all_taps();
671 command_print(cmd_ctx
, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr ");
672 command_print(cmd_ctx
, "---|--------------------|---------|------------|------------|------|------|------|---------");
675 uint32_t expected
, expected_mask
, cur_instr
, ii
;
676 expected
= buf_get_u32(tap
->expected
, 0, tap
->ir_length
);
677 expected_mask
= buf_get_u32(tap
->expected_mask
, 0, tap
->ir_length
);
678 cur_instr
= buf_get_u32(tap
->cur_instr
, 0, tap
->ir_length
);
680 command_print(cmd_ctx
,
681 "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x",
682 tap
->abs_chain_position
,
684 tap
->enabled
? 'Y' : 'n',
685 (unsigned int)(tap
->idcode
),
686 (unsigned int)(tap
->expected_ids_cnt
> 0 ? tap
->expected_ids
[0] : 0),
687 (unsigned int)(tap
->ir_length
),
688 (unsigned int)(expected
),
689 (unsigned int)(expected_mask
),
690 (unsigned int)(cur_instr
));
692 for (ii
= 1; ii
< tap
->expected_ids_cnt
; ii
++) {
693 command_print(cmd_ctx
, " | | | | 0x%08x | | | | ",
694 (unsigned int)(tap
->expected_ids
[ii
]));
703 static int handle_reset_config_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
708 /* Original versions cared about the order of these tokens:
709 * reset_config signals [combination [trst_type [srst_type]]]
710 * They also clobbered the previous configuration even on error.
712 * Here we don't care about the order, and only change values
713 * which have been explicitly specified.
715 for (; argc
; argc
--, args
++) {
720 m
= RESET_SRST_NO_GATING
;
721 if (strcmp(*args
, "srst_gates_jtag") == 0)
722 /* default: don't use JTAG while SRST asserted */;
723 else if (strcmp(*args
, "srst_nogate") == 0)
724 tmp
= RESET_SRST_NO_GATING
;
728 LOG_ERROR("extra reset_config %s spec (%s)",
730 return ERROR_INVALID_ARGUMENTS
;
736 m
= RESET_HAS_TRST
| RESET_HAS_SRST
;
737 if (strcmp(*args
, "none") == 0)
739 else if (strcmp(*args
, "trst_only") == 0)
740 tmp
= RESET_HAS_TRST
;
741 else if (strcmp(*args
, "srst_only") == 0)
742 tmp
= RESET_HAS_SRST
;
743 else if (strcmp(*args
, "trst_and_srst") == 0)
744 tmp
= RESET_HAS_TRST
| RESET_HAS_SRST
;
748 LOG_ERROR("extra reset_config %s spec (%s)",
750 return ERROR_INVALID_ARGUMENTS
;
755 /* combination (options for broken wiring) */
756 m
= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
757 if (strcmp(*args
, "separate") == 0)
758 /* separate reset lines - default */;
759 else if (strcmp(*args
, "srst_pulls_trst") == 0)
760 tmp
|= RESET_SRST_PULLS_TRST
;
761 else if (strcmp(*args
, "trst_pulls_srst") == 0)
762 tmp
|= RESET_TRST_PULLS_SRST
;
763 else if (strcmp(*args
, "combined") == 0)
764 tmp
|= RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
;
768 LOG_ERROR("extra reset_config %s spec (%s)",
769 "combination", *args
);
770 return ERROR_INVALID_ARGUMENTS
;
775 /* trst_type (NOP without HAS_TRST) */
776 m
= RESET_TRST_OPEN_DRAIN
;
777 if (strcmp(*args
, "trst_open_drain") == 0)
778 tmp
|= RESET_TRST_OPEN_DRAIN
;
779 else if (strcmp(*args
, "trst_push_pull") == 0)
780 /* push/pull from adapter - default */;
784 LOG_ERROR("extra reset_config %s spec (%s)",
786 return ERROR_INVALID_ARGUMENTS
;
791 /* srst_type (NOP without HAS_SRST) */
792 m
|= RESET_SRST_PUSH_PULL
;
793 if (strcmp(*args
, "srst_push_pull") == 0)
794 tmp
|= RESET_SRST_PUSH_PULL
;
795 else if (strcmp(*args
, "srst_open_drain") == 0)
796 /* open drain from adapter - default */;
800 LOG_ERROR("extra reset_config %s spec (%s)",
802 return ERROR_INVALID_ARGUMENTS
;
807 /* caller provided nonsense; fail */
808 LOG_ERROR("unknown reset_config flag (%s)", *args
);
809 return ERROR_INVALID_ARGUMENTS
;
812 /* Remember the bits which were specified (mask)
813 * and their new values (new_cfg).
819 /* clear previous values of those bits, save new values */
821 int old_cfg
= jtag_get_reset_config();
825 jtag_set_reset_config(new_cfg
);
827 new_cfg
= jtag_get_reset_config();
831 * Display the (now-)current reset mode
835 /* minimal JTAG has neither SRST nor TRST (so that's the default) */
836 switch (new_cfg
& (RESET_HAS_TRST
| RESET_HAS_SRST
)) {
838 modes
[0] = "srst_only";
841 modes
[0] = "trst_only";
843 case RESET_TRST_AND_SRST
:
844 modes
[0] = "trst_and_srst";
851 /* normally SRST and TRST are decoupled; but bugs happen ... */
852 switch (new_cfg
& (RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
)) {
853 case RESET_SRST_PULLS_TRST
:
854 modes
[1] = "srst_pulls_trst";
856 case RESET_TRST_PULLS_SRST
:
857 modes
[1] = "trst_pulls_srst";
859 case RESET_SRST_PULLS_TRST
| RESET_TRST_PULLS_SRST
:
860 modes
[1] = "combined";
863 modes
[1] = "separate";
867 /* TRST-less connectors include Altera, Xilinx, and minimal JTAG */
868 if (new_cfg
& RESET_HAS_TRST
) {
869 if (new_cfg
& RESET_TRST_OPEN_DRAIN
)
870 modes
[3] = " trst_open_drain";
872 modes
[3] = " trst_push_pull";
876 /* SRST-less connectors include TI-14, Xilinx, and minimal JTAG */
877 if (new_cfg
& RESET_HAS_SRST
) {
878 if (new_cfg
& RESET_SRST_NO_GATING
)
879 modes
[2] = " srst_nogate";
881 modes
[2] = " srst_gates_jtag";
883 if (new_cfg
& RESET_SRST_PUSH_PULL
)
884 modes
[4] = " srst_push_pull";
886 modes
[4] = " srst_open_drain";
892 command_print(cmd_ctx
, "%s %s%s%s%s",
894 modes
[2], modes
[3], modes
[4]);
899 static int handle_jtag_nsrst_delay_command(struct command_context_s
*cmd_ctx
,
900 char *cmd
, char **args
, int argc
)
903 return ERROR_COMMAND_SYNTAX_ERROR
;
907 COMMAND_PARSE_NUMBER(uint
, args
[0], delay
);
909 jtag_set_nsrst_delay(delay
);
911 command_print(cmd_ctx
, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay());
915 static int handle_jtag_ntrst_delay_command(struct command_context_s
*cmd_ctx
,
916 char *cmd
, char **args
, int argc
)
919 return ERROR_COMMAND_SYNTAX_ERROR
;
923 COMMAND_PARSE_NUMBER(uint
, args
[0], delay
);
925 jtag_set_ntrst_delay(delay
);
927 command_print(cmd_ctx
, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay());
931 static int handle_jtag_nsrst_assert_width_command(struct command_context_s
*cmd_ctx
,
932 char *cmd
, char **args
, int argc
)
935 return ERROR_COMMAND_SYNTAX_ERROR
;
939 COMMAND_PARSE_NUMBER(uint
, args
[0], delay
);
941 jtag_set_nsrst_assert_width(delay
);
943 command_print(cmd_ctx
, "jtag_nsrst_assert_width: %u", jtag_get_nsrst_assert_width());
947 static int handle_jtag_ntrst_assert_width_command(struct command_context_s
*cmd_ctx
,
948 char *cmd
, char **args
, int argc
)
951 return ERROR_COMMAND_SYNTAX_ERROR
;
955 COMMAND_PARSE_NUMBER(uint
, args
[0], delay
);
957 jtag_set_ntrst_assert_width(delay
);
959 command_print(cmd_ctx
, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width());
963 static int handle_jtag_khz_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
966 return ERROR_COMMAND_SYNTAX_ERROR
;
968 int retval
= ERROR_OK
;
972 COMMAND_PARSE_NUMBER(uint
, args
[0], khz
);
974 retval
= jtag_config_khz(khz
);
975 if (ERROR_OK
!= retval
)
979 int cur_speed
= jtag_get_speed_khz();
980 retval
= jtag_get_speed_readable(&cur_speed
);
981 if (ERROR_OK
!= retval
)
985 command_print(cmd_ctx
, "%d kHz", cur_speed
);
987 command_print(cmd_ctx
, "RCLK - adaptive");
992 static int handle_jtag_rclk_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
995 return ERROR_COMMAND_SYNTAX_ERROR
;
997 int retval
= ERROR_OK
;
1001 COMMAND_PARSE_NUMBER(uint
, args
[0], khz
);
1003 retval
= jtag_config_rclk(khz
);
1004 if (ERROR_OK
!= retval
)
1008 int cur_khz
= jtag_get_speed_khz();
1009 retval
= jtag_get_speed_readable(&cur_khz
);
1010 if (ERROR_OK
!= retval
)
1014 command_print(cmd_ctx
, "RCLK not supported - fallback to %d kHz", cur_khz
);
1016 command_print(cmd_ctx
, "RCLK - adaptive");
1021 static int handle_jtag_reset_command(struct command_context_s
*cmd_ctx
,
1022 char *cmd
, char **args
, int argc
)
1025 return ERROR_COMMAND_SYNTAX_ERROR
;
1028 if (args
[0][0] == '1')
1030 else if (args
[0][0] == '0')
1033 return ERROR_COMMAND_SYNTAX_ERROR
;
1036 if (args
[1][0] == '1')
1038 else if (args
[1][0] == '0')
1041 return ERROR_COMMAND_SYNTAX_ERROR
;
1043 if (jtag_interface_init(cmd_ctx
) != ERROR_OK
)
1044 return ERROR_JTAG_INIT_FAILED
;
1046 jtag_add_reset(trst
, srst
);
1047 return jtag_execute_queue();
1050 static int handle_runtest_command(struct command_context_s
*cmd_ctx
,
1051 char *cmd
, char **args
, int argc
)
1054 return ERROR_COMMAND_SYNTAX_ERROR
;
1056 unsigned num_clocks
;
1057 COMMAND_PARSE_NUMBER(uint
, args
[0], num_clocks
);
1059 jtag_add_runtest(num_clocks
, TAP_IDLE
);
1060 return jtag_execute_queue();
1064 * For "irscan" or "drscan" commands, the "end" (really, "next") state
1065 * should be stable ... and *NOT* a shift state, otherwise free-running
1066 * jtag clocks could change the values latched by the update state.
1067 * Not surprisingly, this is the same constraint as SVF; the "irscan"
1068 * and "drscan" commands are a write-only subset of what SVF provides.
1070 static bool scan_is_safe(tap_state_t state
)
1085 static int handle_irscan_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1088 scan_field_t
*fields
;
1090 tap_state_t endstate
;
1092 if ((argc
< 2) || (argc
% 2))
1094 return ERROR_COMMAND_SYNTAX_ERROR
;
1097 /* optional "-endstate" "statename" at the end of the arguments,
1098 * so that e.g. IRPAUSE can let us load the data register before
1099 * entering RUN/IDLE to execute the instruction we load here.
1101 endstate
= TAP_IDLE
;
1104 /* have at least one pair of numbers. */
1105 /* is last pair the magic text? */
1106 if (strcmp("-endstate", args
[argc
- 2]) == 0) {
1107 endstate
= tap_state_by_name(args
[argc
- 1]);
1108 if (endstate
== TAP_INVALID
)
1109 return ERROR_COMMAND_SYNTAX_ERROR
;
1110 if (!scan_is_safe(endstate
))
1111 LOG_WARNING("unstable irscan endstate \"%s\"",
1117 int num_fields
= argc
/ 2;
1118 size_t fields_len
= sizeof(scan_field_t
) * num_fields
;
1119 fields
= malloc(fields_len
);
1120 memset(fields
, 0, fields_len
);
1123 for (i
= 0; i
< num_fields
; i
++)
1125 tap
= jtag_tap_by_string(args
[i
*2]);
1129 for (j
= 0; j
< i
; j
++)
1130 free(fields
[j
].out_value
);
1132 command_print(cmd_ctx
, "Tap: %s unknown", args
[i
*2]);
1136 int field_size
= tap
->ir_length
;
1137 fields
[i
].tap
= tap
;
1138 fields
[i
].num_bits
= field_size
;
1139 fields
[i
].out_value
= malloc(CEIL(field_size
, 8));
1142 retval
= parse_u32(args
[i
* 2 + 1], &value
);
1143 if (ERROR_OK
!= retval
)
1145 buf_set_u32(fields
[i
].out_value
, 0, field_size
, value
);
1146 fields
[i
].in_value
= NULL
;
1149 /* did we have an endstate? */
1150 jtag_add_ir_scan(num_fields
, fields
, endstate
);
1152 retval
= jtag_execute_queue();
1155 for (i
= 0; i
< num_fields
; i
++)
1157 if (NULL
!= fields
[i
].out_value
)
1158 free(fields
[i
].out_value
);
1166 static int Jim_Command_drscan(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1169 scan_field_t
*fields
;
1171 int field_count
= 0;
1174 tap_state_t endstate
;
1177 * args[2] = num_bits
1178 * args[3] = hex string
1179 * ... repeat num bits and hex string ...
1182 * args[N-2] = "-endstate"
1183 * args[N-1] = statename
1185 if ((argc
< 4) || ((argc
% 2) != 0))
1187 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
1191 endstate
= TAP_IDLE
;
1193 script_debug(interp
, "drscan", argc
, args
);
1195 /* validate arguments as numbers */
1197 for (i
= 2; i
< argc
; i
+= 2)
1202 e
= Jim_GetLong(interp
, args
[i
], &bits
);
1203 /* If valid - try next arg */
1208 /* Not valid.. are we at the end? */
1209 if (((i
+ 2) != argc
)) {
1210 /* nope, then error */
1214 /* it could be: "-endstate FOO"
1215 * e.g. DRPAUSE so we can issue more instructions
1216 * before entering RUN/IDLE and executing them.
1219 /* get arg as a string. */
1220 cp
= Jim_GetString(args
[i
], NULL
);
1221 /* is it the magic? */
1222 if (0 == strcmp("-endstate", cp
)) {
1223 /* is the statename valid? */
1224 cp
= Jim_GetString(args
[i
+ 1], NULL
);
1226 /* see if it is a valid state name */
1227 endstate
= tap_state_by_name(cp
);
1229 /* update the error message */
1230 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
1232 if (!scan_is_safe(endstate
))
1233 LOG_WARNING("drscan with unsafe "
1234 "endstate \"%s\"", cp
);
1236 /* valid - so clear the error */
1238 /* and remove the last 2 args */
1243 /* Still an error? */
1245 return e
; /* too bad */
1247 } /* validate args */
1249 tap
= jtag_tap_by_jim_obj(interp
, args
[1]);
1254 num_fields
= (argc
-2)/2;
1255 fields
= malloc(sizeof(scan_field_t
) * num_fields
);
1256 for (i
= 2; i
< argc
; i
+= 2)
1262 Jim_GetLong(interp
, args
[i
], &bits
);
1263 str
= Jim_GetString(args
[i
+ 1], &len
);
1265 fields
[field_count
].tap
= tap
;
1266 fields
[field_count
].num_bits
= bits
;
1267 fields
[field_count
].out_value
= malloc(CEIL(bits
, 8));
1268 str_to_buf(str
, len
, fields
[field_count
].out_value
, bits
, 0);
1269 fields
[field_count
].in_value
= fields
[field_count
].out_value
;
1273 jtag_add_dr_scan(num_fields
, fields
, endstate
);
1275 retval
= jtag_execute_queue();
1276 if (retval
!= ERROR_OK
)
1278 Jim_SetResultString(interp
, "drscan: jtag execute failed",-1);
1283 Jim_Obj
*list
= Jim_NewListObj(interp
, NULL
, 0);
1284 for (i
= 2; i
< argc
; i
+= 2)
1289 Jim_GetLong(interp
, args
[i
], &bits
);
1290 str
= buf_to_str(fields
[field_count
].in_value
, bits
, 16);
1291 free(fields
[field_count
].out_value
);
1293 Jim_ListAppendElement(interp
, list
, Jim_NewStringObj(interp
, str
, strlen(str
)));
1298 Jim_SetResult(interp
, list
);
1306 static int Jim_Command_pathmove(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1308 tap_state_t states
[8];
1310 if ((argc
< 2) || ((size_t)argc
> (sizeof(states
)/sizeof(*states
) + 1)))
1312 Jim_WrongNumArgs(interp
, 1, args
, "wrong arguments");
1316 script_debug(interp
, "pathmove", argc
, args
);
1319 for (i
= 0; i
< argc
-1; i
++)
1322 cp
= Jim_GetString(args
[i
+ 1], NULL
);
1323 states
[i
] = tap_state_by_name(cp
);
1326 /* update the error message */
1327 Jim_SetResult_sprintf(interp
,"endstate: %s invalid", cp
);
1332 if ((jtag_add_statemove(states
[0]) != ERROR_OK
) || (jtag_execute_queue()!= ERROR_OK
))
1334 Jim_SetResultString(interp
, "pathmove: jtag execute failed",-1);
1338 jtag_add_pathmove(argc
-2, states
+ 1);
1340 if (jtag_execute_queue()!= ERROR_OK
)
1342 Jim_SetResultString(interp
, "pathmove: failed",-1);
1350 static int Jim_Command_flush_count(Jim_Interp
*interp
, int argc
, Jim_Obj
*const *args
)
1352 script_debug(interp
, "flush_count", argc
, args
);
1354 Jim_SetResult(interp
, Jim_NewIntObj(interp
, jtag_get_flush_queue_count()));
1360 static int handle_verify_ircapture_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1363 return ERROR_COMMAND_SYNTAX_ERROR
;
1367 if (strcmp(args
[0], "enable") == 0)
1368 jtag_set_verify_capture_ir(true);
1369 else if (strcmp(args
[0], "disable") == 0)
1370 jtag_set_verify_capture_ir(false);
1372 return ERROR_COMMAND_SYNTAX_ERROR
;
1375 const char *status
= jtag_will_verify_capture_ir() ? "enabled": "disabled";
1376 command_print(cmd_ctx
, "verify Capture-IR is %s", status
);
1381 static int handle_verify_jtag_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1384 return ERROR_COMMAND_SYNTAX_ERROR
;
1388 if (strcmp(args
[0], "enable") == 0)
1389 jtag_set_verify(true);
1390 else if (strcmp(args
[0], "disable") == 0)
1391 jtag_set_verify(false);
1393 return ERROR_COMMAND_SYNTAX_ERROR
;
1396 const char *status
= jtag_will_verify() ? "enabled": "disabled";
1397 command_print(cmd_ctx
, "verify jtag capture is %s", status
);
1402 static int handle_tms_sequence_command(struct command_context_s
*cmd_ctx
, char *cmd
, char **args
, int argc
)
1405 return ERROR_COMMAND_SYNTAX_ERROR
;
1410 if (strcmp(args
[0], "short") == 0)
1411 use_new_table
= true;
1412 else if (strcmp(args
[0], "long") == 0)
1413 use_new_table
= false;
1415 return ERROR_COMMAND_SYNTAX_ERROR
;
1417 tap_use_new_tms_table(use_new_table
);
1420 command_print(cmd_ctx
, "tms sequence is %s",
1421 tap_uses_new_tms_table() ? "short": "long");
1426 int jtag_register_commands(struct command_context_s
*cmd_ctx
)
1428 register_jim(cmd_ctx
, "jtag", jim_jtag_command
,
1429 "perform jtag tap actions");
1431 register_command(cmd_ctx
, NULL
, "interface",
1432 handle_interface_command
, COMMAND_CONFIG
,
1433 "try to configure interface");
1434 register_command(cmd_ctx
, NULL
, "interface_list",
1435 &handle_interface_list_command
, COMMAND_ANY
,
1436 "list all built-in interfaces");
1438 register_command(cmd_ctx
, NULL
, "jtag_khz",
1439 handle_jtag_khz_command
, COMMAND_ANY
,
1440 "set maximum jtag speed (if supported); "
1441 "parameter is maximum khz, or 0 for adaptive clocking (RTCK).");
1442 register_command(cmd_ctx
, NULL
, "jtag_rclk",
1443 handle_jtag_rclk_command
, COMMAND_ANY
,
1444 "fallback_speed_khz - set JTAG speed to RCLK or use fallback speed");
1445 register_command(cmd_ctx
, NULL
, "reset_config",
1446 handle_reset_config_command
, COMMAND_ANY
,
1448 "[none|trst_only|srst_only|trst_and_srst] "
1449 "[srst_pulls_trst|trst_pulls_srst|combined|separate] "
1450 "[srst_gates_jtag|srst_nogate] "
1451 "[trst_push_pull|trst_open_drain] "
1452 "[srst_push_pull|srst_open_drain]");
1454 register_command(cmd_ctx
, NULL
, "jtag_nsrst_delay",
1455 handle_jtag_nsrst_delay_command
, COMMAND_ANY
,
1456 "jtag_nsrst_delay <ms> "
1457 "- delay after deasserting srst in ms");
1458 register_command(cmd_ctx
, NULL
, "jtag_ntrst_delay",
1459 handle_jtag_ntrst_delay_command
, COMMAND_ANY
,
1460 "jtag_ntrst_delay <ms> "
1461 "- delay after deasserting trst in ms");
1463 register_command(cmd_ctx
, NULL
, "jtag_nsrst_assert_width",
1464 handle_jtag_nsrst_assert_width_command
, COMMAND_ANY
,
1465 "jtag_nsrst_assert_width <ms> "
1466 "- delay after asserting srst in ms");
1467 register_command(cmd_ctx
, NULL
, "jtag_ntrst_assert_width",
1468 handle_jtag_ntrst_assert_width_command
, COMMAND_ANY
,
1469 "jtag_ntrst_assert_width <ms> "
1470 "- delay after asserting trst in ms");
1472 register_command(cmd_ctx
, NULL
, "scan_chain",
1473 handle_scan_chain_command
, COMMAND_EXEC
,
1474 "print current scan chain configuration");
1476 register_command(cmd_ctx
, NULL
, "jtag_reset",
1477 handle_jtag_reset_command
, COMMAND_EXEC
,
1478 "toggle reset lines <trst> <srst>");
1479 register_command(cmd_ctx
, NULL
, "runtest",
1480 handle_runtest_command
, COMMAND_EXEC
,
1481 "move to Run-Test/Idle, and execute <num_cycles>");
1482 register_command(cmd_ctx
, NULL
, "irscan",
1483 handle_irscan_command
, COMMAND_EXEC
,
1484 "execute IR scan <device> <instr> [dev2] [instr2] ...");
1486 register_jim(cmd_ctx
, "drscan", Jim_Command_drscan
,
1487 "execute DR scan <device> "
1488 "<num_bits> <value> <num_bits1> <value2> ...");
1490 register_jim(cmd_ctx
, "flush_count", Jim_Command_flush_count
,
1491 "returns number of times the JTAG queue has been flushed");
1493 register_jim(cmd_ctx
, "pathmove", Jim_Command_pathmove
,
1494 "<state1>,<state2>,<state3>... "
1495 "- move JTAG to state1 then to state2, state3, etc.");
1497 register_command(cmd_ctx
, NULL
, "verify_ircapture",
1498 handle_verify_ircapture_command
, COMMAND_ANY
,
1499 "verify value captured during Capture-IR <enable | disable>");
1500 register_command(cmd_ctx
, NULL
, "verify_jtag",
1501 handle_verify_jtag_command
, COMMAND_ANY
,
1502 "verify value capture <enable | disable>");
1504 register_command(cmd_ctx
, NULL
, "tms_sequence",
1505 handle_tms_sequence_command
, COMMAND_ANY
,
1506 "choose short(default) or long tms_sequence <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)