X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fjtag%2Ftcl.c;h=e755dd7ef2b7ff983bf892f26ead0b128dd9643c;hp=ad4d886aceb4feda014c71d8347c8e4580ce3631;hb=4946925bea77a4aace6c310b2b724cf2095c6719;hpb=8d8937f1a68e1b050b92f91b1d264bf4bd3af489 diff --git a/src/jtag/tcl.c b/src/jtag/tcl.c index ad4d886ace..e755dd7ef2 100644 --- a/src/jtag/tcl.c +++ b/src/jtag/tcl.c @@ -2,7 +2,7 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2007,2008 Øyvind Harboe * * oyvind.harboe@zylin.com * * * * Copyright (C) 2009 SoftPLC Corporation * @@ -34,170 +34,22 @@ #include "jtag.h" #include "minidriver.h" #include "interface.h" +#include "interfaces.h" #ifdef HAVE_STRINGS_H #include #endif static const Jim_Nvp nvp_jtag_tap_event[] = { + { .value = JTAG_TRST_ASSERTED, .name = "post-reset" }, + { .value = JTAG_TAP_EVENT_SETUP, .name = "setup" }, { .value = JTAG_TAP_EVENT_ENABLE, .name = "tap-enable" }, { .value = JTAG_TAP_EVENT_DISABLE, .name = "tap-disable" }, { .name = NULL, .value = -1 } }; -/* jtag interfaces (parport, FTDI-USB, TI-USB, ...) - */ - -#if BUILD_ZY1000 == 1 - extern jtag_interface_t zy1000_interface; -#elif defined(BUILD_MINIDRIVER_DUMMY) - extern jtag_interface_t minidummy_interface; -#else // standard drivers -#if BUILD_PARPORT == 1 - extern jtag_interface_t parport_interface; -#endif - -#if BUILD_DUMMY == 1 - extern jtag_interface_t dummy_interface; -#endif - -#if BUILD_FT2232_FTD2XX == 1 - extern jtag_interface_t ft2232_interface; -#endif - -#if BUILD_FT2232_LIBFTDI == 1 - extern jtag_interface_t ft2232_interface; -#endif - -#if BUILD_AMTJTAGACCEL == 1 - extern jtag_interface_t amt_jtagaccel_interface; -#endif - -#if BUILD_EP93XX == 1 - extern jtag_interface_t ep93xx_interface; -#endif - -#if BUILD_AT91RM9200 == 1 - extern jtag_interface_t at91rm9200_interface; -#endif - -#if BUILD_GW16012 == 1 - extern jtag_interface_t gw16012_interface; -#endif - -#if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1 - extern jtag_interface_t presto_interface; -#endif - -#if BUILD_USBPROG == 1 - extern jtag_interface_t usbprog_interface; -#endif - -#if BUILD_JLINK == 1 - extern jtag_interface_t jlink_interface; -#endif - -#if BUILD_VSLLINK == 1 - extern jtag_interface_t vsllink_interface; -#endif - -#if BUILD_RLINK == 1 - extern jtag_interface_t rlink_interface; -#endif - -#if BUILD_ARMJTAGEW == 1 - extern jtag_interface_t armjtagew_interface; -#endif -#endif // standard drivers - -/** - * The list of built-in JTAG interfaces, containing entries for those - * drivers that were enabled by the @c configure script. - * - * The list should be defined to contain either one minidriver interface - * or some number of standard driver interfaces, never both. - */ -jtag_interface_t *jtag_interfaces[] = { -#if BUILD_ZY1000 == 1 - &zy1000_interface, -#elif defined(BUILD_MINIDRIVER_DUMMY) - &minidummy_interface, -#else // standard drivers -#if BUILD_PARPORT == 1 - &parport_interface, -#endif -#if BUILD_DUMMY == 1 - &dummy_interface, -#endif -#if BUILD_FT2232_FTD2XX == 1 - &ft2232_interface, -#endif -#if BUILD_FT2232_LIBFTDI == 1 - &ft2232_interface, -#endif -#if BUILD_AMTJTAGACCEL == 1 - &amt_jtagaccel_interface, -#endif -#if BUILD_EP93XX == 1 - &ep93xx_interface, -#endif -#if BUILD_AT91RM9200 == 1 - &at91rm9200_interface, -#endif -#if BUILD_GW16012 == 1 - &gw16012_interface, -#endif -#if BUILD_PRESTO_LIBFTDI == 1 || BUILD_PRESTO_FTD2XX == 1 - &presto_interface, -#endif -#if BUILD_USBPROG == 1 - &usbprog_interface, -#endif -#if BUILD_JLINK == 1 - &jlink_interface, -#endif -#if BUILD_VSLLINK == 1 - &vsllink_interface, -#endif -#if BUILD_RLINK == 1 - &rlink_interface, -#endif -#if BUILD_ARMJTAGEW == 1 - &armjtagew_interface, -#endif -#endif // standard drivers - NULL, -}; - -extern jtag_interface_t *jtag_interface; - -/* jtag commands */ -static int handle_interface_list_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc); -static int handle_interface_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); - -static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); - -static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_runtest_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *argv); -static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *argv); -static int Jim_Command_flush_count(Jim_Interp *interp, int argc, Jim_Obj *const *args); - -static int handle_verify_ircapture_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); -static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc); - -extern int jtag_examine_chain(void); -extern int jtag_validate_chain(void); +extern struct jtag_interface *jtag_interface; enum jtag_tap_cfg_param { JCFG_EVENT @@ -209,7 +61,7 @@ static Jim_Nvp nvp_config_opts[] = { { .name = NULL, .value = -1 } }; -static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap) +static int jtag_tap_configure_cmd(Jim_GetOptInfo *goi, struct jtag_tap * tap) { Jim_Nvp *n; Jim_Obj *o; @@ -228,11 +80,11 @@ static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap) switch (n->value) { case JCFG_EVENT: if (goi->argc == 0) { - Jim_WrongNumArgs( goi->interp, goi->argc, goi->argv, "-event ?event-name? ..." ); + Jim_WrongNumArgs(goi->interp, goi->argc, goi->argv, "-event ?event-name? ..."); return JIM_ERR; } - e = Jim_GetOpt_Nvp( goi, nvp_jtag_tap_event, &n ); + e = Jim_GetOpt_Nvp(goi, nvp_jtag_tap_event, &n); if (e != JIM_OK) { Jim_GetOpt_NvpUnknown(goi, nvp_jtag_tap_event, 1); return e; @@ -251,7 +103,7 @@ static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap) } { - jtag_tap_event_action_t *jteap; + struct jtag_tap_event_action *jteap; jteap = tap->event_action; /* replace existing? */ @@ -263,21 +115,26 @@ static int jtag_tap_configure_cmd( Jim_GetOptInfo *goi, jtag_tap_t * tap) } if (goi->isconfigure) { + bool replace = true; if (jteap == NULL) { /* create new */ jteap = calloc(1, sizeof (*jteap)); + replace = false; } jteap->event = n->value; - Jim_GetOpt_Obj( goi, &o); + Jim_GetOpt_Obj(goi, &o); if (jteap->body) { Jim_DecrRefCount(interp, jteap->body); } jteap->body = Jim_DuplicateObj(goi->interp, o); Jim_IncrRefCount(jteap->body); - /* add to head of event list */ - jteap->next = tap->event_action; - tap->event_action = jteap; + if (!replace) + { + /* add to head of event list */ + jteap->next = tap->event_action; + tap->event_action = jteap; + } Jim_SetEmptyResult(goi->interp); } else { /* get */ @@ -306,13 +163,12 @@ static int is_bad_irval(int ir_length, jim_wide w) return (w & v) != 0; } -static int jim_newtap_cmd( Jim_GetOptInfo *goi ) +static int jim_newtap_cmd(Jim_GetOptInfo *goi) { - jtag_tap_t *pTap; + struct jtag_tap *pTap; jim_wide w; int x; int e; - int reqbits; Jim_Nvp *n; char *cp; const Jim_Nvp opts[] = { @@ -331,7 +187,7 @@ static int jim_newtap_cmd( Jim_GetOptInfo *goi ) { .name = NULL , .value = -1 }, }; - pTap = calloc(1, sizeof(jtag_tap_t)); + pTap = calloc(1, sizeof(struct jtag_tap)); if (!pTap) { Jim_SetResult_sprintf(goi->interp, "no memory"); return JIM_ERR; @@ -340,41 +196,43 @@ static int jim_newtap_cmd( Jim_GetOptInfo *goi ) /* * we expect CHIP + TAP + OPTIONS * */ - if( goi->argc < 3 ){ + if (goi->argc < 3) { Jim_SetResult_sprintf(goi->interp, "Missing CHIP TAP OPTIONS ...."); + free(pTap); return JIM_ERR; } - Jim_GetOpt_String( goi, &cp, NULL ); + Jim_GetOpt_String(goi, &cp, NULL); pTap->chip = strdup(cp); - Jim_GetOpt_String( goi, &cp, NULL ); + Jim_GetOpt_String(goi, &cp, NULL); pTap->tapname = strdup(cp); /* name + dot + name + null */ x = strlen(pTap->chip) + 1 + strlen(pTap->tapname) + 1; - cp = malloc( x ); - sprintf( cp, "%s.%s", pTap->chip, pTap->tapname ); + cp = malloc(x); + sprintf(cp, "%s.%s", pTap->chip, pTap->tapname); pTap->dotted_name = cp; LOG_DEBUG("Creating New Tap, Chip: %s, Tap: %s, Dotted: %s, %d params", pTap->chip, pTap->tapname, pTap->dotted_name, goi->argc); - /* deal with options */ -#define NTREQ_IRLEN 1 -#define NTREQ_IRCAPTURE 2 -#define NTREQ_IRMASK 4 - - /* clear them as we find them */ - reqbits = (NTREQ_IRLEN | NTREQ_IRCAPTURE | NTREQ_IRMASK); + /* IEEE specifies that the two LSBs of an IR scan are 01, so make + * that the default. The "-irlen" and "-irmask" options are only + * needed to cope with nonstandard TAPs, or to specify more bits. + */ + pTap->ir_capture_mask = 0x03; + pTap->ir_capture_value = 0x01; - while( goi->argc ){ - e = Jim_GetOpt_Nvp( goi, opts, &n ); - if( e != JIM_OK ){ - Jim_GetOpt_NvpUnknown( goi, opts, 0 ); + while (goi->argc) { + e = Jim_GetOpt_Nvp(goi, opts, &n); + if (e != JIM_OK) { + Jim_GetOpt_NvpUnknown(goi, opts, 0); + free((void *)pTap->dotted_name); + free(pTap); return e; } - LOG_DEBUG("Processing option: %s", n->name ); - switch( n->value ){ + LOG_DEBUG("Processing option: %s", n->name); + switch (n->value) { case NTAP_OPT_ENABLED: pTap->disabled_after_reset = false; break; @@ -383,21 +241,25 @@ static int jim_newtap_cmd( Jim_GetOptInfo *goi ) break; case NTAP_OPT_EXPECTED_ID: { - u32 *new_expected_ids; + uint32_t *new_expected_ids; - e = Jim_GetOpt_Wide( goi, &w ); - if( e != JIM_OK) { + e = Jim_GetOpt_Wide(goi, &w); + if (e != JIM_OK) { Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name); + free((void *)pTap->dotted_name); + free(pTap); return e; } - new_expected_ids = malloc(sizeof(u32) * (pTap->expected_ids_cnt + 1)); + new_expected_ids = malloc(sizeof(uint32_t) * (pTap->expected_ids_cnt + 1)); if (new_expected_ids == NULL) { - Jim_SetResult_sprintf( goi->interp, "no memory"); + Jim_SetResult_sprintf(goi->interp, "no memory"); + free((void *)pTap->dotted_name); + free(pTap); return JIM_ERR; } - memcpy(new_expected_ids, pTap->expected_ids, sizeof(u32) * pTap->expected_ids_cnt); + memcpy(new_expected_ids, pTap->expected_ids, sizeof(uint32_t) * pTap->expected_ids_cnt); new_expected_ids[pTap->expected_ids_cnt] = w; @@ -409,116 +271,126 @@ static int jim_newtap_cmd( Jim_GetOptInfo *goi ) case NTAP_OPT_IRLEN: case NTAP_OPT_IRMASK: case NTAP_OPT_IRCAPTURE: - e = Jim_GetOpt_Wide( goi, &w ); - if( e != JIM_OK ){ - Jim_SetResult_sprintf( goi->interp, "option: %s bad parameter", n->name ); + e = Jim_GetOpt_Wide(goi, &w); + if (e != JIM_OK) { + Jim_SetResult_sprintf(goi->interp, "option: %s bad parameter", n->name); + free((void *)pTap->dotted_name); + free(pTap); return e; } - switch(n->value){ + switch (n->value) { case NTAP_OPT_IRLEN: if (w > (jim_wide) (8 * sizeof(pTap->ir_capture_value))) - LOG_WARNING("huge IR length %d", (int) w); + LOG_WARNING("%s: huge IR length %d", + pTap->dotted_name, + (int) w); pTap->ir_length = w; - reqbits &= (~(NTREQ_IRLEN)); break; case NTAP_OPT_IRMASK: if (is_bad_irval(pTap->ir_length, w)) { - LOG_ERROR("IR mask %x too big", + LOG_ERROR("%s: IR mask %x too big", + pTap->dotted_name, (int) w); + free((void *)pTap->dotted_name); + free(pTap); return ERROR_FAIL; } + if ((w & 3) != 3) + LOG_WARNING("%s: nonstandard IR mask", + pTap->dotted_name); pTap->ir_capture_mask = w; - reqbits &= (~(NTREQ_IRMASK)); break; case NTAP_OPT_IRCAPTURE: if (is_bad_irval(pTap->ir_length, w)) { - LOG_ERROR("IR capture %x too big", + LOG_ERROR("%s: IR capture %x too big", + pTap->dotted_name, (int) w); + free((void *)pTap->dotted_name); + free(pTap); return ERROR_FAIL; } + if ((w & 3) != 1) + LOG_WARNING("%s: nonstandard IR value", + pTap->dotted_name); pTap->ir_capture_value = w; - reqbits &= (~(NTREQ_IRCAPTURE)); break; } - } /* switch(n->value) */ - } /* while( goi->argc ) */ + } /* switch (n->value) */ + } /* while (goi->argc) */ /* default is enabled-after-reset */ pTap->enabled = !pTap->disabled_after_reset; /* Did all the required option bits get cleared? */ - if (0 == reqbits) + if (pTap->ir_length != 0) { jtag_tap_init(pTap); return ERROR_OK; } Jim_SetResult_sprintf(goi->interp, - "newtap: %s missing required parameters", + "newtap: %s missing IR length", pTap->dotted_name); jtag_tap_free(pTap); return JIM_ERR; } -static void jtag_tap_handle_event(jtag_tap_t *tap, enum jtag_event e) +static void jtag_tap_handle_event(struct jtag_tap *tap, enum jtag_event e) { - jtag_tap_event_action_t * jteap; - int done; - - jteap = tap->event_action; + struct jtag_tap_event_action * jteap; - done = 0; - while (jteap) { + for (jteap = tap->event_action; jteap != NULL; jteap = jteap->next) { if (jteap->event == e) { - done = 1; - LOG_DEBUG( "JTAG tap: %s event: %d (%s) action: %s\n", + LOG_DEBUG("JTAG tap: %s event: %d (%s)\n\taction: %s", tap->dotted_name, e, Jim_Nvp_value2name_simple(nvp_jtag_tap_event, e)->name, - Jim_GetString(jteap->body, NULL) ); + Jim_GetString(jteap->body, NULL)); if (Jim_EvalObj(interp, jteap->body) != JIM_OK) { Jim_PrintErrorMessage(interp); - } else { + } else switch (e) { + case JTAG_TAP_EVENT_ENABLE: + case JTAG_TAP_EVENT_DISABLE: /* NOTE: we currently assume the handlers - * can't fail. That presumes later code - * will be verifying the scan chains ... + * can't fail. Right here is where we should + * really be verifying the scan chains ... */ tap->enabled = (e == JTAG_TAP_EVENT_ENABLE); + LOG_INFO("JTAG tap: %s %s", tap->dotted_name, + tap->enabled ? "enabled" : "disabled"); + break; + default: + break; } } - - jteap = jteap->next; - } - - if (!done) { - LOG_DEBUG( "event %d %s - no action", - e, - Jim_Nvp_value2name_simple( nvp_jtag_tap_event, e)->name); } } -static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv ) +static int jim_jtag_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv) { Jim_GetOptInfo goi; int e; Jim_Nvp *n; Jim_Obj *o; - struct command_context_s *context; + struct command_context *context; enum { JTAG_CMD_INTERFACE, + JTAG_CMD_INIT, JTAG_CMD_INIT_RESET, JTAG_CMD_NEWTAP, JTAG_CMD_TAPENABLE, JTAG_CMD_TAPDISABLE, JTAG_CMD_TAPISENABLED, JTAG_CMD_CONFIGURE, - JTAG_CMD_CGET + JTAG_CMD_CGET, + JTAG_CMD_NAMES, }; const Jim_Nvp jtag_cmds[] = { { .name = "interface" , .value = JTAG_CMD_INTERFACE }, + { .name = "arp_init" , .value = JTAG_CMD_INIT }, { .name = "arp_init-reset", .value = JTAG_CMD_INIT_RESET }, { .name = "newtap" , .value = JTAG_CMD_NEWTAP }, { .name = "tapisenabled" , .value = JTAG_CMD_TAPISENABLED }, @@ -526,55 +398,68 @@ static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv { .name = "tapdisable" , .value = JTAG_CMD_TAPDISABLE }, { .name = "configure" , .value = JTAG_CMD_CONFIGURE }, { .name = "cget" , .value = JTAG_CMD_CGET }, + { .name = "names" , .value = JTAG_CMD_NAMES }, { .name = NULL, .value = -1 }, }; context = Jim_GetAssocData(interp, "context"); /* go past the command */ - Jim_GetOpt_Setup( &goi, interp, argc-1, argv+1 ); + Jim_GetOpt_Setup(&goi, interp, argc-1, argv + 1); - e = Jim_GetOpt_Nvp( &goi, jtag_cmds, &n ); - if( e != JIM_OK ){ - Jim_GetOpt_NvpUnknown( &goi, jtag_cmds, 0 ); + e = Jim_GetOpt_Nvp(&goi, jtag_cmds, &n); + if (e != JIM_OK) { + Jim_GetOpt_NvpUnknown(&goi, jtag_cmds, 0); return e; } - Jim_SetEmptyResult( goi.interp ); - switch( n->value ){ + Jim_SetEmptyResult(goi.interp); + switch (n->value) { case JTAG_CMD_INTERFACE: /* return the name of the interface */ /* TCL code might need to know the exact type... */ /* FUTURE: we allow this as a means to "set" the interface. */ - if( goi.argc != 0 ){ - Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)"); + if (goi.argc != 0) { + Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)"); + return JIM_ERR; + } + const char *name = jtag_interface ? jtag_interface->name : NULL; + Jim_SetResultString(goi.interp, name ? : "undefined", -1); + return JIM_OK; + case JTAG_CMD_INIT: + if (goi.argc != 0) { + Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)"); + return JIM_ERR; + } + e = jtag_init_inner(context); + if (e != ERROR_OK) { + Jim_SetResult_sprintf(goi.interp, "error: %d", e); return JIM_ERR; } - Jim_SetResultString( goi.interp, jtag_interface->name, -1 ); return JIM_OK; case JTAG_CMD_INIT_RESET: - if( goi.argc != 0 ){ - Jim_WrongNumArgs( goi.interp, 1, goi.argv-1, "(no params)"); + if (goi.argc != 0) { + Jim_WrongNumArgs(goi.interp, 1, goi.argv-1, "(no params)"); return JIM_ERR; } e = jtag_init_reset(context); - if( e != ERROR_OK ){ - Jim_SetResult_sprintf( goi.interp, "error: %d", e); + if (e != ERROR_OK) { + Jim_SetResult_sprintf(goi.interp, "error: %d", e); return JIM_ERR; } return JIM_OK; case JTAG_CMD_NEWTAP: - return jim_newtap_cmd( &goi ); + return jim_newtap_cmd(&goi); break; case JTAG_CMD_TAPISENABLED: case JTAG_CMD_TAPENABLE: case JTAG_CMD_TAPDISABLE: - if( goi.argc != 1 ){ - Jim_SetResultString( goi.interp, "Too many parameters",-1 ); + if (goi.argc != 1) { + Jim_SetResultString(goi.interp, "Too many parameters",-1); return JIM_ERR; } { - jtag_tap_t *t; + struct jtag_tap *t; t = jtag_tap_by_jim_obj(goi.interp, goi.argv[0]); if (t == NULL) @@ -619,94 +504,81 @@ static int jim_jtag_command( Jim_Interp *interp, int argc, Jim_Obj *const *argv break; case JTAG_CMD_CGET: - if( goi.argc < 2 ){ - Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ..."); + if (goi.argc < 2) { + Jim_WrongNumArgs(goi.interp, 0, NULL, + "cget tap_name queryparm"); return JIM_ERR; } { - jtag_tap_t *t; + struct jtag_tap *t; Jim_GetOpt_Obj(&goi, &o); - t = jtag_tap_by_jim_obj( goi.interp, o ); - if( t == NULL ){ + t = jtag_tap_by_jim_obj(goi.interp, o); + if (t == NULL) { return JIM_ERR; } goi.isconfigure = 0; - return jtag_tap_configure_cmd( &goi, t); + return jtag_tap_configure_cmd(&goi, t); } break; case JTAG_CMD_CONFIGURE: - if( goi.argc < 3 ){ - Jim_WrongNumArgs( goi.interp, 0, NULL, "?tap-name? -option ?VALUE? ..."); + if (goi.argc < 3) { + Jim_WrongNumArgs(goi.interp, 0, NULL, + "configure tap_name attribute value ..."); return JIM_ERR; } { - jtag_tap_t *t; + struct jtag_tap *t; Jim_GetOpt_Obj(&goi, &o); - t = jtag_tap_by_jim_obj( goi.interp, o ); - if( t == NULL ){ + t = jtag_tap_by_jim_obj(goi.interp, o); + if (t == NULL) { return JIM_ERR; } goi.isconfigure = 1; - return jtag_tap_configure_cmd( &goi, t); + return jtag_tap_configure_cmd(&goi, t); + } + break; + + case JTAG_CMD_NAMES: + if (goi.argc != 0) { + Jim_WrongNumArgs(goi.interp, 1, goi.argv, "Too many parameters"); + return JIM_ERR; } + Jim_SetResult(goi.interp, Jim_NewListObj(goi.interp, NULL, 0)); + { + struct jtag_tap *tap; + + for (tap = jtag_all_taps(); tap; tap = tap->next_tap) { + Jim_ListAppendElement(goi.interp, + Jim_GetResult(goi.interp), + Jim_NewStringObj(goi.interp, + tap->dotted_name, -1)); + } + return JIM_OK; + } + break; + } return JIM_ERR; } -int jtag_register_commands(struct command_context_s *cmd_ctx) + +void jtag_notify_event(enum jtag_event event) { - register_jim( cmd_ctx, "jtag", jim_jtag_command, "perform jtag tap actions"); - - register_command(cmd_ctx, NULL, "interface", handle_interface_command, - COMMAND_CONFIG, "try to configure interface"); - register_command(cmd_ctx, NULL, - "interface_list", &handle_interface_list_command, - COMMAND_ANY, "list all built-in interfaces"); - register_command(cmd_ctx, NULL, "jtag_speed", handle_jtag_speed_command, - COMMAND_ANY, "(DEPRECATED) set jtag speed (if supported)"); - register_command(cmd_ctx, NULL, "jtag_khz", handle_jtag_khz_command, - COMMAND_ANY, "set maximum jtag speed (if supported); " - "parameter is maximum khz, or 0 for adaptive clocking (RTCK)."); - register_command(cmd_ctx, NULL, "jtag_device", handle_jtag_device_command, - COMMAND_CONFIG, "(DEPRECATED) jtag_device "); - register_command(cmd_ctx, NULL, "reset_config", handle_reset_config_command, - COMMAND_ANY, - "[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]"); - register_command(cmd_ctx, NULL, "jtag_nsrst_delay", handle_jtag_nsrst_delay_command, - COMMAND_ANY, "jtag_nsrst_delay - delay after deasserting srst in ms"); - register_command(cmd_ctx, NULL, "jtag_ntrst_delay", handle_jtag_ntrst_delay_command, - COMMAND_ANY, "jtag_ntrst_delay - delay after deasserting trst in ms"); - - register_command(cmd_ctx, NULL, "scan_chain", handle_scan_chain_command, - COMMAND_EXEC, "print current scan chain configuration"); - - register_command(cmd_ctx, NULL, "jtag_reset", handle_jtag_reset_command, - COMMAND_EXEC, "toggle reset lines "); - register_command(cmd_ctx, NULL, "runtest", handle_runtest_command, - COMMAND_EXEC, "move to Run-Test/Idle, and execute "); - register_command(cmd_ctx, NULL, "irscan", handle_irscan_command, - COMMAND_EXEC, "execute IR scan [dev2] [instr2] ..."); - register_jim(cmd_ctx, "drscan", Jim_Command_drscan, "execute DR scan ..."); - register_jim(cmd_ctx, "flush_count", Jim_Command_flush_count, "returns number of times the JTAG queue has been flushed"); - register_jim(cmd_ctx, "pathmove", Jim_Command_pathmove, "move JTAG to state1 then to state2, state3, etc. ,,..."); - - register_command(cmd_ctx, NULL, "verify_ircapture", handle_verify_ircapture_command, - COMMAND_ANY, "verify value captured during Capture-IR "); - register_command(cmd_ctx, NULL, "verify_jtag", handle_verify_jtag_command, - COMMAND_ANY, "verify value capture "); - register_command(cmd_ctx, NULL, "tms_sequence", handle_tms_sequence_command, - COMMAND_ANY, "choose short(default) or long tms_sequence "); - return ERROR_OK; + struct jtag_tap *tap; + + for (tap = jtag_all_taps(); tap; tap = tap->next_tap) + jtag_tap_handle_event(tap, event); } + static int default_khz(int khz, int *jtag_speed) { LOG_ERROR("Translation from khz to jtag_speed not implemented"); @@ -721,18 +593,32 @@ static int default_speed_div(int speed, int *khz) static int default_power_dropout(int *dropout) { - *dropout=0; /* by default we can't detect power dropout */ + *dropout = 0; /* by default we can't detect power dropout */ return ERROR_OK; } static int default_srst_asserted(int *srst_asserted) { - *srst_asserted=0; /* by default we can't detect srst asserted */ + *srst_asserted = 0; /* by default we can't detect srst asserted */ return ERROR_OK; } -static int handle_interface_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_interface_list_command) +{ + if (strcmp(CMD_NAME, "interface_list") == 0 && CMD_ARGC > 0) + return ERROR_COMMAND_SYNTAX_ERROR; + + command_print(CMD_CTX, "The following JTAG interfaces are available:"); + for (unsigned i = 0; NULL != jtag_interfaces[i]; i++) + { + const char *name = jtag_interfaces[i]->name; + command_print(CMD_CTX, "%u: %s", i + 1, name); + } + + return ERROR_OK; +} + +COMMAND_HANDLER(handle_interface_command) { /* check whether the interface is already configured */ if (jtag_interface) @@ -742,17 +628,21 @@ static int handle_interface_command(struct command_context_s *cmd_ctx, } /* interface name is a mandatory argument */ - if (argc != 1 || args[0][0] == '\0') + if (CMD_ARGC != 1 || CMD_ARGV[0][0] == '\0') return ERROR_COMMAND_SYNTAX_ERROR; for (unsigned i = 0; NULL != jtag_interfaces[i]; i++) { - if (strcmp(args[0], jtag_interfaces[i]->name) != 0) + if (strcmp(CMD_ARGV[0], jtag_interfaces[i]->name) != 0) continue; - int retval = jtag_interfaces[i]->register_commands(cmd_ctx); - if (ERROR_OK != retval) + if (NULL != jtag_interfaces[i]->commands) + { + int retval = register_commands(CMD_CTX, NULL, + jtag_interfaces[i]->commands); + if (ERROR_OK != retval) return retval; + } jtag_interface = jtag_interfaces[i]; @@ -771,117 +661,40 @@ static int handle_interface_command(struct command_context_s *cmd_ctx, /* no valid interface was found (i.e. the configuration option, * didn't match one of the compiled-in interfaces */ - LOG_ERROR("The specified JTAG interface was not found (%s)", args[0]); - handle_interface_list_command(cmd_ctx, cmd, args, argc); + LOG_ERROR("The specified JTAG interface was not found (%s)", CMD_ARGV[0]); + CALL_COMMAND_HANDLER(handle_interface_list_command); return ERROR_JTAG_INVALID_INTERFACE; } -static int handle_interface_list_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) -{ - if (strcmp(cmd, "interface_list") == 0 && argc > 0) - return ERROR_COMMAND_SYNTAX_ERROR; - - command_print(cmd_ctx, "The following JTAG interfaces are available:"); - for (unsigned i = 0; NULL != jtag_interfaces[i]; i++) - { - const char *name = jtag_interfaces[i]->name; - command_print(cmd_ctx, "%u: %s", i + 1, name); - } - - return ERROR_OK; -} - -static int handle_jtag_device_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_scan_chain_command) { - int e; - char buf[1024]; - Jim_Obj *newargs[ 10 ]; - /* - * CONVERT SYNTAX - * argv[-1] = command - * argv[ 0] = ir length - * argv[ 1] = ir capture - * argv[ 2] = ir mask - * argv[ 3] = not actually used by anything but in the docs - */ - - if( argc < 4 ){ - command_print( cmd_ctx, "OLD DEPRECATED SYNTAX: Please use the NEW syntax"); - return ERROR_OK; - } - command_print( cmd_ctx, "OLD SYNTAX: DEPRECATED - translating to new syntax"); - command_print( cmd_ctx, "jtag newtap CHIP TAP -irlen %s -ircapture %s -irvalue %s", - args[0], - args[1], - args[2] ); - command_print( cmd_ctx, "Example: STM32 has 2 taps, the cortexM3(len4) + boundaryscan(len5)"); - command_print( cmd_ctx, "jtag newtap stm32 cortexm3 ....., thus creating the tap: \"stm32.cortexm3\""); - command_print( cmd_ctx, "jtag newtap stm32 boundary ....., and the tap: \"stm32.boundary\""); - command_print( cmd_ctx, "And then refer to the taps by the dotted name."); - - newargs[0] = Jim_NewStringObj( interp, "jtag", -1 ); - newargs[1] = Jim_NewStringObj( interp, "newtap", -1 ); - sprintf( buf, "chip%d", jtag_tap_count() ); - newargs[2] = Jim_NewStringObj( interp, buf, -1 ); - sprintf( buf, "tap%d", jtag_tap_count() ); - newargs[3] = Jim_NewStringObj( interp, buf, -1 ); - newargs[4] = Jim_NewStringObj( interp, "-irlen", -1 ); - newargs[5] = Jim_NewStringObj( interp, args[0], -1 ); - newargs[6] = Jim_NewStringObj( interp, "-ircapture", -1 ); - newargs[7] = Jim_NewStringObj( interp, args[1], -1 ); - newargs[8] = Jim_NewStringObj( interp, "-irmask", -1 ); - newargs[9] = Jim_NewStringObj( interp, args[2], -1 ); - - command_print( cmd_ctx, "NEW COMMAND:"); - sprintf( buf, "%s %s %s %s %s %s %s %s %s %s", - Jim_GetString( newargs[0], NULL ), - Jim_GetString( newargs[1], NULL ), - Jim_GetString( newargs[2], NULL ), - Jim_GetString( newargs[3], NULL ), - Jim_GetString( newargs[4], NULL ), - Jim_GetString( newargs[5], NULL ), - Jim_GetString( newargs[6], NULL ), - Jim_GetString( newargs[7], NULL ), - Jim_GetString( newargs[8], NULL ), - Jim_GetString( newargs[9], NULL ) ); - - e = jim_jtag_command( interp, 10, newargs ); - if( e != JIM_OK ){ - command_print( cmd_ctx, "%s", Jim_GetString( Jim_GetResult(interp), NULL ) ); - } - return e; -} - -static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) -{ - jtag_tap_t *tap; + struct jtag_tap *tap; tap = jtag_all_taps(); - command_print(cmd_ctx, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr "); - command_print(cmd_ctx, "---|--------------------|---------|------------|------------|------|------|------|---------"); + command_print(CMD_CTX, " TapName | Enabled | IdCode Expected IrLen IrCap IrMask Instr "); + command_print(CMD_CTX, "---|--------------------|---------|------------|------------|------|------|------|---------"); - while( tap ){ - u32 expected, expected_mask, cur_instr, ii; + while (tap) { + uint32_t expected, expected_mask, cur_instr, ii; expected = buf_get_u32(tap->expected, 0, tap->ir_length); expected_mask = buf_get_u32(tap->expected_mask, 0, tap->ir_length); cur_instr = buf_get_u32(tap->cur_instr, 0, tap->ir_length); - command_print(cmd_ctx, + command_print(CMD_CTX, "%2d | %-18s | %c | 0x%08x | 0x%08x | 0x%02x | 0x%02x | 0x%02x | 0x%02x", tap->abs_chain_position, tap->dotted_name, tap->enabled ? 'Y' : 'n', - tap->idcode, - (tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0), - tap->ir_length, - expected, - expected_mask, - cur_instr); + (unsigned int)(tap->idcode), + (unsigned int)(tap->expected_ids_cnt > 0 ? tap->expected_ids[0] : 0), + (unsigned int)(tap->ir_length), + (unsigned int)(expected), + (unsigned int)(expected_mask), + (unsigned int)(cur_instr)); for (ii = 1; ii < tap->expected_ids_cnt; ii++) { - command_print(cmd_ctx, " | | | | 0x%08x | | | | ", - tap->expected_ids[ii]); + command_print(CMD_CTX, " | | | | 0x%08x | | | | ", + (unsigned int)(tap->expected_ids[ii])); } tap = tap->next_tap; @@ -890,14 +703,11 @@ static int handle_scan_chain_command(struct command_context_s *cmd_ctx, char *cm return ERROR_OK; } -static int handle_reset_config_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_reset_config_command) { int new_cfg = 0; int mask = 0; - if (argc < 1) - return ERROR_COMMAND_SYNTAX_ERROR; - /* Original versions cared about the order of these tokens: * reset_config signals [combination [trst_type [srst_type]]] * They also clobbered the previous configuration even on error. @@ -905,25 +715,41 @@ static int handle_reset_config_command(struct command_context_s *cmd_ctx, char * * Here we don't care about the order, and only change values * which have been explicitly specified. */ - for (; argc; argc--, args++) { + for (; CMD_ARGC; CMD_ARGC--, CMD_ARGV++) { int tmp = 0; int m; + /* gating */ + m = RESET_SRST_NO_GATING; + if (strcmp(*CMD_ARGV, "srst_gates_jtag") == 0) + /* default: don't use JTAG while SRST asserted */; + else if (strcmp(*CMD_ARGV, "srst_nogate") == 0) + tmp = RESET_SRST_NO_GATING; + else + m = 0; + if (mask & m) { + LOG_ERROR("extra reset_config %s spec (%s)", + "gating", *CMD_ARGV); + return ERROR_INVALID_ARGUMENTS; + } + if (m) + goto next; + /* signals */ m = RESET_HAS_TRST | RESET_HAS_SRST; - if (strcmp(*args, "none") == 0) + if (strcmp(*CMD_ARGV, "none") == 0) tmp = RESET_NONE; - else if (strcmp(*args, "trst_only") == 0) + else if (strcmp(*CMD_ARGV, "trst_only") == 0) tmp = RESET_HAS_TRST; - else if (strcmp(*args, "srst_only") == 0) + else if (strcmp(*CMD_ARGV, "srst_only") == 0) tmp = RESET_HAS_SRST; - else if (strcmp(*args, "trst_and_srst") == 0) + else if (strcmp(*CMD_ARGV, "trst_and_srst") == 0) tmp = RESET_HAS_TRST | RESET_HAS_SRST; else m = 0; if (mask & m) { LOG_ERROR("extra reset_config %s spec (%s)", - "signal", *args); + "signal", *CMD_ARGV); return ERROR_INVALID_ARGUMENTS; } if (m) @@ -931,19 +757,19 @@ static int handle_reset_config_command(struct command_context_s *cmd_ctx, char * /* combination (options for broken wiring) */ m = RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST; - if (strcmp(*args, "separate") == 0) + if (strcmp(*CMD_ARGV, "separate") == 0) /* separate reset lines - default */; - else if (strcmp(*args, "srst_pulls_trst") == 0) + else if (strcmp(*CMD_ARGV, "srst_pulls_trst") == 0) tmp |= RESET_SRST_PULLS_TRST; - else if (strcmp(*args, "trst_pulls_srst") == 0) + else if (strcmp(*CMD_ARGV, "trst_pulls_srst") == 0) tmp |= RESET_TRST_PULLS_SRST; - else if (strcmp(*args, "combined") == 0) + else if (strcmp(*CMD_ARGV, "combined") == 0) tmp |= RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST; else m = 0; if (mask & m) { LOG_ERROR("extra reset_config %s spec (%s)", - "combination", *args); + "combination", *CMD_ARGV); return ERROR_INVALID_ARGUMENTS; } if (m) @@ -951,15 +777,15 @@ static int handle_reset_config_command(struct command_context_s *cmd_ctx, char * /* trst_type (NOP without HAS_TRST) */ m = RESET_TRST_OPEN_DRAIN; - if (strcmp(*args, "trst_open_drain") == 0) + if (strcmp(*CMD_ARGV, "trst_open_drain") == 0) tmp |= RESET_TRST_OPEN_DRAIN; - else if (strcmp(*args, "trst_push_pull") == 0) + else if (strcmp(*CMD_ARGV, "trst_push_pull") == 0) /* push/pull from adapter - default */; else m = 0; if (mask & m) { LOG_ERROR("extra reset_config %s spec (%s)", - "trst_type", *args); + "trst_type", *CMD_ARGV); return ERROR_INVALID_ARGUMENTS; } if (m) @@ -967,22 +793,22 @@ static int handle_reset_config_command(struct command_context_s *cmd_ctx, char * /* srst_type (NOP without HAS_SRST) */ m |= RESET_SRST_PUSH_PULL; - if (strcmp(*args, "srst_push_pull") == 0) + if (strcmp(*CMD_ARGV, "srst_push_pull") == 0) tmp |= RESET_SRST_PUSH_PULL; - else if (strcmp(*args, "srst_open_drain") == 0) + else if (strcmp(*CMD_ARGV, "srst_open_drain") == 0) /* open drain from adapter - default */; else m = 0; if (mask & m) { LOG_ERROR("extra reset_config %s spec (%s)", - "srst_type", *args); + "srst_type", *CMD_ARGV); return ERROR_INVALID_ARGUMENTS; } if (m) goto next; /* caller provided nonsense; fail */ - LOG_ERROR("unknown reset_config flag (%s)", *args); + LOG_ERROR("unknown reset_config flag (%s)", *CMD_ARGV); return ERROR_INVALID_ARGUMENTS; next: @@ -994,82 +820,156 @@ next: } /* clear previous values of those bits, save new values */ - enum reset_types old_cfg = jtag_get_reset_config(); - old_cfg &= ~mask; - new_cfg |= old_cfg; - jtag_set_reset_config(new_cfg); + if (mask) { + int old_cfg = jtag_get_reset_config(); + + old_cfg &= ~mask; + new_cfg |= old_cfg; + jtag_set_reset_config(new_cfg); + } else + new_cfg = jtag_get_reset_config(); + + + /* + * Display the (now-)current reset mode + */ + char *modes[5]; + + /* minimal JTAG has neither SRST nor TRST (so that's the default) */ + switch (new_cfg & (RESET_HAS_TRST | RESET_HAS_SRST)) { + case RESET_HAS_SRST: + modes[0] = "srst_only"; + break; + case RESET_HAS_TRST: + modes[0] = "trst_only"; + break; + case RESET_TRST_AND_SRST: + modes[0] = "trst_and_srst"; + break; + default: + modes[0] = "none"; + break; + } + + /* normally SRST and TRST are decoupled; but bugs happen ... */ + switch (new_cfg & (RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST)) { + case RESET_SRST_PULLS_TRST: + modes[1] = "srst_pulls_trst"; + break; + case RESET_TRST_PULLS_SRST: + modes[1] = "trst_pulls_srst"; + break; + case RESET_SRST_PULLS_TRST | RESET_TRST_PULLS_SRST: + modes[1] = "combined"; + break; + default: + modes[1] = "separate"; + break; + } + + /* TRST-less connectors include Altera, Xilinx, and minimal JTAG */ + if (new_cfg & RESET_HAS_TRST) { + if (new_cfg & RESET_TRST_OPEN_DRAIN) + modes[3] = " trst_open_drain"; + else + modes[3] = " trst_push_pull"; + } else + modes[3] = ""; + + /* SRST-less connectors include TI-14, Xilinx, and minimal JTAG */ + if (new_cfg & RESET_HAS_SRST) { + if (new_cfg & RESET_SRST_NO_GATING) + modes[2] = " srst_nogate"; + else + modes[2] = " srst_gates_jtag"; + + if (new_cfg & RESET_SRST_PUSH_PULL) + modes[4] = " srst_push_pull"; + else + modes[4] = " srst_open_drain"; + } else { + modes[2] = ""; + modes[4] = ""; + } + + command_print(CMD_CTX, "%s %s%s%s%s", + modes[0], modes[1], + modes[2], modes[3], modes[4]); return ERROR_OK; } -static int handle_jtag_nsrst_delay_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_jtag_nsrst_delay_command) { - if (argc > 1) + if (CMD_ARGC > 1) return ERROR_COMMAND_SYNTAX_ERROR; - if (argc == 1) + if (CMD_ARGC == 1) { unsigned delay; - int retval = parse_uint(args[0], &delay); - if (ERROR_OK != retval) - return retval; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay); + jtag_set_nsrst_delay(delay); } - command_print(cmd_ctx, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay()); + command_print(CMD_CTX, "jtag_nsrst_delay: %u", jtag_get_nsrst_delay()); return ERROR_OK; } -static int handle_jtag_ntrst_delay_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_jtag_ntrst_delay_command) { - if (argc > 1) + if (CMD_ARGC > 1) return ERROR_COMMAND_SYNTAX_ERROR; - if (argc == 1) + if (CMD_ARGC == 1) { unsigned delay; - int retval = parse_uint(args[0], &delay); - if (ERROR_OK != retval) - return retval; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay); + jtag_set_ntrst_delay(delay); } - command_print(cmd_ctx, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay()); + command_print(CMD_CTX, "jtag_ntrst_delay: %u", jtag_get_ntrst_delay()); return ERROR_OK; } -static int handle_jtag_speed_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_jtag_nsrst_assert_width_command) { - int retval = ERROR_OK; - - if (argc > 1) + if (CMD_ARGC > 1) return ERROR_COMMAND_SYNTAX_ERROR; - if (argc == 1) + if (CMD_ARGC == 1) { - LOG_DEBUG("handle jtag speed"); - - unsigned cur_speed = 0; - int retval = parse_uint(args[0], &cur_speed); - if (ERROR_OK != retval) - return retval; - retval = jtag_set_speed(cur_speed); + unsigned delay; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay); + jtag_set_nsrst_assert_width(delay); } - command_print(cmd_ctx, "jtag_speed: %d", jtag_get_speed()); + command_print(CMD_CTX, "jtag_nsrst_assert_width: %u", jtag_get_nsrst_assert_width()); + return ERROR_OK; +} - return retval; +COMMAND_HANDLER(handle_jtag_ntrst_assert_width_command) +{ + if (CMD_ARGC > 1) + return ERROR_COMMAND_SYNTAX_ERROR; + if (CMD_ARGC == 1) + { + unsigned delay; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], delay); + + jtag_set_ntrst_assert_width(delay); + } + command_print(CMD_CTX, "jtag_ntrst_assert_width: %u", jtag_get_ntrst_assert_width()); + return ERROR_OK; } -static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_jtag_khz_command) { - if (argc > 1) + if (CMD_ARGC > 1) return ERROR_COMMAND_SYNTAX_ERROR; int retval = ERROR_OK; - if (argc == 1) + if (CMD_ARGC == 1) { unsigned khz = 0; - int retval = parse_uint(args[0], &khz); - if (ERROR_OK != retval) - return retval; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz); + retval = jtag_config_khz(khz); if (ERROR_OK != retval) return retval; @@ -1081,65 +981,88 @@ static int handle_jtag_khz_command(struct command_context_s *cmd_ctx, char *cmd, return retval; if (cur_speed) - command_print(cmd_ctx, "%d kHz", cur_speed); + command_print(CMD_CTX, "%d kHz", cur_speed); else - command_print(cmd_ctx, "RCLK - adaptive"); + command_print(CMD_CTX, "RCLK - adaptive"); return retval; } -static int handle_jtag_reset_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_jtag_rclk_command) { - if (argc != 2) + if (CMD_ARGC > 1) + return ERROR_COMMAND_SYNTAX_ERROR; + + int retval = ERROR_OK; + if (CMD_ARGC == 1) + { + unsigned khz = 0; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], khz); + + retval = jtag_config_rclk(khz); + if (ERROR_OK != retval) + return retval; + } + + int cur_khz = jtag_get_speed_khz(); + retval = jtag_get_speed_readable(&cur_khz); + if (ERROR_OK != retval) + return retval; + + if (cur_khz) + command_print(CMD_CTX, "RCLK not supported - fallback to %d kHz", cur_khz); + else + command_print(CMD_CTX, "RCLK - adaptive"); + + return retval; +} + +COMMAND_HANDLER(handle_jtag_reset_command) +{ + if (CMD_ARGC != 2) return ERROR_COMMAND_SYNTAX_ERROR; int trst = -1; - if (args[0][0] == '1') + if (CMD_ARGV[0][0] == '1') trst = 1; - else if (args[0][0] == '0') + else if (CMD_ARGV[0][0] == '0') trst = 0; else return ERROR_COMMAND_SYNTAX_ERROR; int srst = -1; - if (args[1][0] == '1') + if (CMD_ARGV[1][0] == '1') srst = 1; - else if (args[1][0] == '0') + else if (CMD_ARGV[1][0] == '0') srst = 0; else return ERROR_COMMAND_SYNTAX_ERROR; - if (jtag_interface_init(cmd_ctx) != ERROR_OK) + if (jtag_interface_init(CMD_CTX) != ERROR_OK) return ERROR_JTAG_INIT_FAILED; jtag_add_reset(trst, srst); - jtag_execute_queue(); - - return ERROR_OK; + return jtag_execute_queue(); } -static int handle_runtest_command(struct command_context_s *cmd_ctx, - char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_runtest_command) { - if (argc != 1) + if (CMD_ARGC != 1) return ERROR_COMMAND_SYNTAX_ERROR; unsigned num_clocks; - int retval = parse_uint(args[0], &num_clocks); - if (ERROR_OK != retval) - return retval; + COMMAND_PARSE_NUMBER(uint, CMD_ARGV[0], num_clocks); jtag_add_runtest(num_clocks, TAP_IDLE); - jtag_execute_queue(); - - return ERROR_OK; + return jtag_execute_queue(); } /* * For "irscan" or "drscan" commands, the "end" (really, "next") state * should be stable ... and *NOT* a shift state, otherwise free-running * jtag clocks could change the values latched by the update state. + * Not surprisingly, this is the same constraint as SVF; the "irscan" + * and "drscan" commands are a write-only subset of what SVF provides. */ static bool scan_is_safe(tap_state_t state) { @@ -1156,14 +1079,14 @@ static bool scan_is_safe(tap_state_t state) } -static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_irscan_command) { int i; - scan_field_t *fields; - jtag_tap_t *tap; + struct scan_field *fields; + struct jtag_tap *tap; tap_state_t endstate; - if ((argc < 2) || (argc % 2)) + if ((CMD_ARGC < 2) || (CMD_ARGC % 2)) { return ERROR_COMMAND_SYNTAX_ERROR; } @@ -1174,52 +1097,46 @@ static int handle_irscan_command(struct command_context_s *cmd_ctx, char *cmd, c */ endstate = TAP_IDLE; - if( argc >= 4 ){ + if (CMD_ARGC >= 4) { /* have at least one pair of numbers. */ /* is last pair the magic text? */ - if( 0 == strcmp( "-endstate", args[ argc - 2 ] ) ){ - const char *cpA; - const char *cpS; - cpA = args[ argc-1 ]; - for( endstate = 0 ; endstate < TAP_NUM_STATES ; endstate++ ){ - cpS = tap_state_name( endstate ); - if( 0 == strcmp( cpA, cpS ) ){ - break; - } - } - if( endstate >= TAP_NUM_STATES ){ + if (strcmp("-endstate", CMD_ARGV[CMD_ARGC - 2]) == 0) { + endstate = tap_state_by_name(CMD_ARGV[CMD_ARGC - 1]); + if (endstate == TAP_INVALID) return ERROR_COMMAND_SYNTAX_ERROR; - } else { - if (!scan_is_safe(endstate)) - LOG_WARNING("irscan with unsafe " - "endstate \"%s\"", cpA); - /* found - remove the last 2 args */ - argc -= 2; - } + if (!scan_is_safe(endstate)) + LOG_WARNING("unstable irscan endstate \"%s\"", + CMD_ARGV[CMD_ARGC - 1]); + CMD_ARGC -= 2; } } - int num_fields = argc / 2; - size_t fields_len = sizeof(scan_field_t) * num_fields; + int num_fields = CMD_ARGC / 2; + size_t fields_len = sizeof(struct scan_field) * num_fields; fields = malloc(fields_len); memset(fields, 0, fields_len); int retval; for (i = 0; i < num_fields; i++) { - tap = jtag_tap_by_string( args[i*2] ); - if (tap==NULL) + tap = jtag_tap_by_string(CMD_ARGV[i*2]); + if (tap == NULL) { - command_print( cmd_ctx, "Tap: %s unknown", args[i*2] ); + int j; + for (j = 0; j < i; j++) + free(fields[j].out_value); + free(fields); + command_print(CMD_CTX, "Tap: %s unknown", CMD_ARGV[i*2]); + return ERROR_FAIL; } int field_size = tap->ir_length; fields[i].tap = tap; fields[i].num_bits = field_size; - fields[i].out_value = malloc(CEIL(field_size, 8)); + fields[i].out_value = malloc(DIV_ROUND_UP(field_size, 8)); - u32 value; - retval = parse_u32(args[i * 2 + 1], &value); + uint32_t value; + retval = parse_u32(CMD_ARGV[i * 2 + 1], &value); if (ERROR_OK != retval) goto error_return; buf_set_u32(fields[i].out_value, 0, field_size, value); @@ -1246,11 +1163,11 @@ error_return: static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args) { int retval; - scan_field_t *fields; + struct scan_field *fields; int num_fields; int field_count = 0; int i, e; - jtag_tap_t *tap; + struct jtag_tap *tap; tap_state_t endstate; /* args[1] = device @@ -1262,7 +1179,7 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args * args[N-2] = "-endstate" * args[N-1] = statename */ - if ((argc < 4) || ((argc % 2)!=0)) + if ((argc < 4) || ((argc % 2) != 0)) { Jim_WrongNumArgs(interp, 1, args, "wrong arguments"); return JIM_ERR; @@ -1274,19 +1191,19 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args /* validate arguments as numbers */ e = JIM_OK; - for (i = 2; i < argc; i+=2) + for (i = 2; i < argc; i += 2) { long bits; const char *cp; e = Jim_GetLong(interp, args[i], &bits); /* If valid - try next arg */ - if( e == JIM_OK ){ + if (e == JIM_OK) { continue; } /* Not valid.. are we at the end? */ - if ( ((i+2) != argc) ){ + if (((i + 2) != argc)) { /* nope, then error */ return e; } @@ -1297,17 +1214,17 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args */ /* get arg as a string. */ - cp = Jim_GetString( args[i], NULL ); + cp = Jim_GetString(args[i], NULL); /* is it the magic? */ - if( 0 == strcmp( "-endstate", cp ) ){ + if (0 == strcmp("-endstate", cp)) { /* is the statename valid? */ - cp = Jim_GetString( args[i+1], NULL ); + cp = Jim_GetString(args[i + 1], NULL); /* see if it is a valid state name */ endstate = tap_state_by_name(cp); - if( endstate < 0 ){ + if (endstate < 0) { /* update the error message */ - Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp ); + Jim_SetResult_sprintf(interp,"endstate: %s invalid", cp); } else { if (!scan_is_safe(endstate)) LOG_WARNING("drscan with unsafe " @@ -1321,30 +1238,30 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args } /* Still an error? */ - if( e != JIM_OK ){ + if (e != JIM_OK) { return e; /* too bad */ } } /* validate args */ - tap = jtag_tap_by_jim_obj( interp, args[1] ); - if( tap == NULL ){ + tap = jtag_tap_by_jim_obj(interp, args[1]); + if (tap == NULL) { return JIM_ERR; } - num_fields=(argc-2)/2; - fields = malloc(sizeof(scan_field_t) * num_fields); - for (i = 2; i < argc; i+=2) + num_fields = (argc-2)/2; + fields = malloc(sizeof(struct scan_field) * num_fields); + for (i = 2; i < argc; i += 2) { long bits; int len; const char *str; Jim_GetLong(interp, args[i], &bits); - str = Jim_GetString(args[i+1], &len); + str = Jim_GetString(args[i + 1], &len); fields[field_count].tap = tap; fields[field_count].num_bits = bits; - fields[field_count].out_value = malloc(CEIL(bits, 8)); + fields[field_count].out_value = malloc(DIV_ROUND_UP(bits, 8)); str_to_buf(str, len, fields[field_count].out_value, bits, 0); fields[field_count].in_value = fields[field_count].out_value; field_count++; @@ -1359,9 +1276,9 @@ static int Jim_Command_drscan(Jim_Interp *interp, int argc, Jim_Obj *const *args return JIM_ERR; } - field_count=0; + field_count = 0; Jim_Obj *list = Jim_NewListObj(interp, NULL, 0); - for (i = 2; i < argc; i+=2) + for (i = 2; i < argc; i += 2) { long bits; char *str; @@ -1387,7 +1304,7 @@ static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *ar { tap_state_t states[8]; - if ((argc < 2) || ((size_t)argc > (sizeof(states)/sizeof(*states)+1))) + if ((argc < 2) || ((size_t)argc > (ARRAY_SIZE(states) + 1))) { Jim_WrongNumArgs(interp, 1, args, "wrong arguments"); return JIM_ERR; @@ -1396,26 +1313,26 @@ static int Jim_Command_pathmove(Jim_Interp *interp, int argc, Jim_Obj *const *ar script_debug(interp, "pathmove", argc, args); int i; - for (i=0; i 1) + if (CMD_ARGC > 1) return ERROR_COMMAND_SYNTAX_ERROR; - if (argc == 1) + if (CMD_ARGC == 1) { - if (strcmp(args[0], "enable") == 0) - jtag_set_verify_capture_ir(true); - else if (strcmp(args[0], "disable") == 0) - jtag_set_verify_capture_ir(false); - else - return ERROR_COMMAND_SYNTAX_ERROR; + bool enable; + COMMAND_PARSE_ENABLE(CMD_ARGV[0], enable); + jtag_set_verify_capture_ir(enable); } const char *status = jtag_will_verify_capture_ir() ? "enabled": "disabled"; - command_print(cmd_ctx, "verify Capture-IR is %s", status); + command_print(CMD_CTX, "verify Capture-IR is %s", status); return ERROR_OK; } -static int handle_verify_jtag_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_verify_jtag_command) { - if (argc > 1) + if (CMD_ARGC > 1) return ERROR_COMMAND_SYNTAX_ERROR; - if (argc == 1) + if (CMD_ARGC == 1) { - if (strcmp(args[0], "enable") == 0) - jtag_set_verify(true); - else if (strcmp(args[0], "disable") == 0) - jtag_set_verify(false); - else - return ERROR_COMMAND_SYNTAX_ERROR; + bool enable; + COMMAND_PARSE_ENABLE(CMD_ARGV[0], enable); + jtag_set_verify(enable); } const char *status = jtag_will_verify() ? "enabled": "disabled"; - command_print(cmd_ctx, "verify jtag capture is %s", status); + command_print(CMD_CTX, "verify jtag capture is %s", status); return ERROR_OK; } -static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc) +COMMAND_HANDLER(handle_tms_sequence_command) { - if (argc > 1) + if (CMD_ARGC > 1) return ERROR_COMMAND_SYNTAX_ERROR; - if (argc == 1) + if (CMD_ARGC == 1) { bool use_new_table; - if (strcmp(args[0], "short") == 0) + if (strcmp(CMD_ARGV[0], "short") == 0) use_new_table = true; - else if (strcmp(args[0], "long") == 0) + else if (strcmp(CMD_ARGV[0], "long") == 0) use_new_table = false; else return ERROR_COMMAND_SYNTAX_ERROR; @@ -1497,9 +1408,158 @@ static int handle_tms_sequence_command(struct command_context_s *cmd_ctx, char * tap_use_new_tms_table(use_new_table); } - command_print(cmd_ctx, "tms sequence is %s", + command_print(CMD_CTX, "tms sequence is %s", tap_uses_new_tms_table() ? "short": "long"); return ERROR_OK; } +static const struct command_registration jtag_command_handlers[] = { + { + .name = "interface", + .handler = &handle_interface_command, + .mode = COMMAND_CONFIG, + .help = "select a JTAG interface", + .usage = "", + }, + { + .name = "interface_list", + .handler = &handle_interface_list_command, + .mode = COMMAND_ANY, + .help = "list all built-in interfaces", + }, + { + .name = "jtag_khz", + .handler = &handle_jtag_khz_command, + .mode = COMMAND_ANY, + .help = "set maximum jtag speed (if supported)", + .usage = "", + }, + { + .name = "jtag_rclk", + .handler = &handle_jtag_rclk_command, + .mode = COMMAND_ANY, + .help = "set JTAG speed to RCLK or use fallback speed", + .usage = "", + }, + { + .name = "reset_config", + .handler = &handle_reset_config_command, + .mode = COMMAND_ANY, + .help = "configure JTAG reset behavior", + .usage = "[none|trst_only|srst_only|trst_and_srst] " + "[srst_pulls_trst|trst_pulls_srst|combined|separate] " + "[srst_gates_jtag|srst_nogate] " + "[trst_push_pull|trst_open_drain] " + "[srst_push_pull|srst_open_drain]", + }, + { + .name = "jtag_nsrst_delay", + .handler = &handle_jtag_nsrst_delay_command, + .mode = COMMAND_ANY, + .help = "delay after deasserting srst in ms", + .usage = "", + }, + { + .name = "jtag_ntrst_delay", + .handler = &handle_jtag_ntrst_delay_command, + .mode = COMMAND_ANY, + .help = "delay after deasserting trst in ms", + .usage = "" + }, + { + .name = "jtag_nsrst_assert_width", + .handler = &handle_jtag_nsrst_assert_width_command, + .mode = COMMAND_ANY, + .help = "delay after asserting srst in ms", + .usage = "" + }, + { + .name = "jtag_ntrst_assert_width", + .handler = &handle_jtag_ntrst_assert_width_command, + .mode = COMMAND_ANY, + .help = "delay after asserting trst in ms", + .usage = "" + }, + { + .name = "scan_chain", + .handler = &handle_scan_chain_command, + .mode = COMMAND_EXEC, + .help = "print current scan chain configuration", + }, + { + .name = "jtag_reset", + .handler = &handle_jtag_reset_command, + .mode = COMMAND_EXEC, + .help = "toggle reset lines", + .usage = " ", + }, + { + .name = "runtest", + .handler = &handle_runtest_command, + .mode = COMMAND_EXEC, + .help = "move to Run-Test/Idle, and execute ", + .usage = "" + }, + { + .name = "irscan", + .handler = &handle_irscan_command, + .mode = COMMAND_EXEC, + .help = "execute IR scan", + .usage = " [dev2] [instr2] ...", + }, + { + .name = "verify_ircapture", + .handler = &handle_verify_ircapture_command, + .mode = COMMAND_ANY, + .help = "verify value captured during Capture-IR", + .usage = "", + }, + { + .name = "verify_jtag", + .handler = &handle_verify_jtag_command, + .mode = COMMAND_ANY, + .help = "verify value capture", + .usage = "", + }, + { + .name = "tms_sequence", + .handler = &handle_tms_sequence_command, + .mode = COMMAND_ANY, + .help = "choose short(default) or long tms_sequence", + .usage = "", + }, + // jim commands + { + .name = "jtag", + .mode = COMMAND_ANY, + .jim_handler = &jim_jtag_command, + .help = "perform jtag tap actions", + }, + { + .name = "drscan", + .mode = COMMAND_EXEC, + .jim_handler = &Jim_Command_drscan, + .help = "execute DR scan " + " ...", + }, + { + .name = "flush_count", + .mode = COMMAND_EXEC, + .jim_handler = &Jim_Command_flush_count, + .help = "returns number of times the JTAG queue has been flushed", + }, + { + .name = "pathmove", + .mode = COMMAND_EXEC, + .jim_handler = &Jim_Command_pathmove, + .usage = ",,... ", + .help = "move JTAG to state1 then to state2, state3, etc.", + }, + COMMAND_REGISTRATION_DONE +}; + +int jtag_register_commands(struct command_context *cmd_ctx) +{ + return register_commands(cmd_ctx, NULL, jtag_command_handlers); +}