Tcl exception codes cleanup, shutdown command amendments
[openocd.git] / src / helper / command.c
1 /***************************************************************************
2 * Copyright (C) 2005 by Dominic Rath *
3 * Dominic.Rath@gmx.de *
4 * *
5 * Copyright (C) 2007,2008 √ėyvind Harboe *
6 * oyvind.harboe@zylin.com *
7 * *
8 * Copyright (C) 2008, Duane Ellis *
9 * openocd@duaneeellis.com *
10 * *
11 * part of this file is taken from libcli (libcli.sourceforge.net) *
12 * Copyright (C) David Parrish (david@dparrish.com) *
13 * *
14 * This program is free software; you can redistribute it and/or modify *
15 * it under the terms of the GNU General Public License as published by *
16 * the Free Software Foundation; either version 2 of the License, or *
17 * (at your option) any later version. *
18 * *
19 * This program is distributed in the hope that it will be useful, *
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
22 * GNU General Public License for more details. *
23 * *
24 * You should have received a copy of the GNU General Public License *
25 * along with this program; if not, write to the *
26 * Free Software Foundation, Inc., *
27 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. *
28 ***************************************************************************/
29
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33
34 /* see Embedded-HOWTO.txt in Jim Tcl project hosted on BerliOS*/
35 #define JIM_EMBEDDED
36
37 /* @todo the inclusion of target.h here is a layering violation */
38 #include <jtag/jtag.h>
39 #include <target/target.h>
40 #include "command.h"
41 #include "configuration.h"
42 #include "log.h"
43 #include "time_support.h"
44 #include "jim-eventloop.h"
45
46 /* nice short description of source file */
47 #define __THIS__FILE__ "command.c"
48
49 static int run_command(struct command_context *context,
50 struct command *c, const char *words[], unsigned num_words);
51
52 struct log_capture_state {
53 Jim_Interp *interp;
54 Jim_Obj *output;
55 };
56
57 static void tcl_output(void *privData, const char *file, unsigned line,
58 const char *function, const char *string)
59 {
60 struct log_capture_state *state = privData;
61 Jim_AppendString(state->interp, state->output, string, strlen(string));
62 }
63
64 static struct log_capture_state *command_log_capture_start(Jim_Interp *interp)
65 {
66 /* capture log output and return it. A garbage collect can
67 * happen, so we need a reference count to this object */
68 Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
69 if (NULL == tclOutput)
70 return NULL;
71
72 struct log_capture_state *state = malloc(sizeof(*state));
73 if (NULL == state)
74 return NULL;
75
76 state->interp = interp;
77 Jim_IncrRefCount(tclOutput);
78 state->output = tclOutput;
79
80 log_add_callback(tcl_output, state);
81
82 return state;
83 }
84
85 /* Classic openocd commands provide progress output which we
86 * will capture and return as a Tcl return value.
87 *
88 * However, if a non-openocd command has been invoked, then it
89 * makes sense to return the tcl return value from that command.
90 *
91 * The tcl return value is empty for openocd commands that provide
92 * progress output.
93 *
94 * Therefore we set the tcl return value only if we actually
95 * captured output.
96 */
97 static void command_log_capture_finish(struct log_capture_state *state)
98 {
99 if (NULL == state)
100 return;
101
102 log_remove_callback(tcl_output, state);
103
104 int length;
105 Jim_GetString(state->output, &length);
106
107 if (length > 0)
108 Jim_SetResult(state->interp, state->output);
109 else {
110 /* No output captured, use tcl return value (which could
111 * be empty too). */
112 }
113 Jim_DecrRefCount(state->interp, state->output);
114
115 free(state);
116 }
117
118 static int command_retval_set(Jim_Interp *interp, int retval)
119 {
120 int *return_retval = Jim_GetAssocData(interp, "retval");
121 if (return_retval != NULL)
122 *return_retval = retval;
123
124 return (retval == ERROR_OK) ? JIM_OK : retval;
125 }
126
127 extern struct command_context *global_cmd_ctx;
128
129 /* dump a single line to the log for the command.
130 * Do nothing in case we are not at debug level 3 */
131 void script_debug(Jim_Interp *interp, const char *name,
132 unsigned argc, Jim_Obj * const *argv)
133 {
134 if (debug_level < LOG_LVL_DEBUG)
135 return;
136
137 char *dbg = alloc_printf("command - %s", name);
138 for (unsigned i = 0; i < argc; i++) {
139 int len;
140 const char *w = Jim_GetString(argv[i], &len);
141 char *t = alloc_printf("%s %s", dbg, w);
142 free(dbg);
143 dbg = t;
144 }
145 LOG_DEBUG("%s", dbg);
146 free(dbg);
147 }
148
149 static void script_command_args_free(char **words, unsigned nwords)
150 {
151 for (unsigned i = 0; i < nwords; i++)
152 free(words[i]);
153 free(words);
154 }
155
156 static char **script_command_args_alloc(
157 unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
158 {
159 char **words = malloc(argc * sizeof(char *));
160 if (NULL == words)
161 return NULL;
162
163 unsigned i;
164 for (i = 0; i < argc; i++) {
165 int len;
166 const char *w = Jim_GetString(argv[i], &len);
167 words[i] = strdup(w);
168 if (words[i] == NULL) {
169 script_command_args_free(words, i);
170 return NULL;
171 }
172 }
173 *nwords = i;
174 return words;
175 }
176
177 struct command_context *current_command_context(Jim_Interp *interp)
178 {
179 /* grab the command context from the associated data */
180 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
181 if (NULL == cmd_ctx) {
182 /* Tcl can invoke commands directly instead of via command_run_line(). This would
183 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
184 * commands in a startup script.
185 *
186 * A telnet or gdb server would provide a non-default command context to
187 * handle piping of error output, have a separate current target, etc.
188 */
189 cmd_ctx = global_cmd_ctx;
190 }
191 return cmd_ctx;
192 }
193
194 static int script_command_run(Jim_Interp *interp,
195 int argc, Jim_Obj * const *argv, struct command *c, bool capture)
196 {
197 target_call_timer_callbacks_now();
198 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
199
200 unsigned nwords;
201 char **words = script_command_args_alloc(argc, argv, &nwords);
202 if (NULL == words)
203 return JIM_ERR;
204
205 struct log_capture_state *state = NULL;
206 if (capture)
207 state = command_log_capture_start(interp);
208
209 struct command_context *cmd_ctx = current_command_context(interp);
210 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
211
212 command_log_capture_finish(state);
213
214 script_command_args_free(words, nwords);
215 return command_retval_set(interp, retval);
216 }
217
218 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
219 {
220 /* the private data is stashed in the interp structure */
221
222 struct command *c = interp->cmdPrivData;
223 assert(c);
224 script_debug(interp, c->name, argc, argv);
225 return script_command_run(interp, argc, argv, c, true);
226 }
227
228 static struct command *command_root(struct command *c)
229 {
230 while (NULL != c->parent)
231 c = c->parent;
232 return c;
233 }
234
235 /**
236 * Find a command by name from a list of commands.
237 * @returns Returns the named command if it exists in the list.
238 * Returns NULL otherwise.
239 */
240 static struct command *command_find(struct command *head, const char *name)
241 {
242 for (struct command *cc = head; cc; cc = cc->next) {
243 if (strcmp(cc->name, name) == 0)
244 return cc;
245 }
246 return NULL;
247 }
248
249 struct command *command_find_in_context(struct command_context *cmd_ctx,
250 const char *name)
251 {
252 return command_find(cmd_ctx->commands, name);
253 }
254 struct command *command_find_in_parent(struct command *parent,
255 const char *name)
256 {
257 return command_find(parent->children, name);
258 }
259
260 /**
261 * Add the command into the linked list, sorted by name.
262 * @param head Address to head of command list pointer, which may be
263 * updated if @c c gets inserted at the beginning of the list.
264 * @param c The command to add to the list pointed to by @c head.
265 */
266 static void command_add_child(struct command **head, struct command *c)
267 {
268 assert(head);
269 if (NULL == *head) {
270 *head = c;
271 return;
272 }
273
274 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
275 head = &(*head)->next;
276
277 if (strcmp(c->name, (*head)->name) > 0) {
278 c->next = (*head)->next;
279 (*head)->next = c;
280 } else {
281 c->next = *head;
282 *head = c;
283 }
284 }
285
286 static struct command **command_list_for_parent(
287 struct command_context *cmd_ctx, struct command *parent)
288 {
289 return parent ? &parent->children : &cmd_ctx->commands;
290 }
291
292 static void command_free(struct command *c)
293 {
294 /** @todo if command has a handler, unregister its jim command! */
295
296 while (NULL != c->children) {
297 struct command *tmp = c->children;
298 c->children = tmp->next;
299 command_free(tmp);
300 }
301
302 free(c->name);
303 free(c->help);
304 free(c->usage);
305 free(c);
306 }
307
308 static struct command *command_new(struct command_context *cmd_ctx,
309 struct command *parent, const struct command_registration *cr)
310 {
311 assert(cr->name);
312
313 /*
314 * If it is a non-jim command with no .usage specified,
315 * log an error.
316 *
317 * strlen(.usage) == 0 means that the command takes no
318 * arguments.
319 */
320 if ((cr->jim_handler == NULL) && (cr->usage == NULL)) {
321 LOG_DEBUG("BUG: command '%s%s%s' does not have the "
322 "'.usage' field filled out",
323 parent && parent->name ? parent->name : "",
324 parent && parent->name ? " " : "",
325 cr->name);
326 }
327
328 struct command *c = calloc(1, sizeof(struct command));
329 if (NULL == c)
330 return NULL;
331
332 c->name = strdup(cr->name);
333 if (cr->help)
334 c->help = strdup(cr->help);
335 if (cr->usage)
336 c->usage = strdup(cr->usage);
337
338 if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
339 goto command_new_error;
340
341 c->parent = parent;
342 c->handler = cr->handler;
343 c->jim_handler = cr->jim_handler;
344 c->jim_handler_data = cr->jim_handler_data;
345 c->mode = cr->mode;
346
347 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
348
349 return c;
350
351 command_new_error:
352 command_free(c);
353 return NULL;
354 }
355
356 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
357
358 static int register_command_handler(struct command_context *cmd_ctx,
359 struct command *c)
360 {
361 Jim_Interp *interp = cmd_ctx->interp;
362 char *ocd_name = alloc_printf("ocd_%s", c->name);
363 if (NULL == ocd_name)
364 return JIM_ERR;
365
366 LOG_DEBUG("registering '%s'...", ocd_name);
367
368 Jim_CmdProc *func = c->handler ? &script_command : &command_unknown;
369 int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
370 free(ocd_name);
371 if (JIM_OK != retval)
372 return retval;
373
374 /* we now need to add an overrideable proc */
375 char *override_name = alloc_printf(
376 "proc %s {args} {eval ocd_bouncer %s $args}",
377 c->name, c->name);
378 if (NULL == override_name)
379 return JIM_ERR;
380
381 retval = Jim_Eval_Named(interp, override_name, 0, 0);
382 free(override_name);
383
384 return retval;
385 }
386
387 struct command *register_command(struct command_context *context,
388 struct command *parent, const struct command_registration *cr)
389 {
390 if (!context || !cr->name)
391 return NULL;
392
393 const char *name = cr->name;
394 struct command **head = command_list_for_parent(context, parent);
395 struct command *c = command_find(*head, name);
396 if (NULL != c) {
397 /* TODO: originally we treated attempting to register a cmd twice as an error
398 * Sometimes we need this behaviour, such as with flash banks.
399 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
400 LOG_DEBUG("command '%s' is already registered in '%s' context",
401 name, parent ? parent->name : "<global>");
402 return c;
403 }
404
405 c = command_new(context, parent, cr);
406 if (NULL == c)
407 return NULL;
408
409 int retval = ERROR_OK;
410 if (NULL != cr->jim_handler && NULL == parent) {
411 retval = Jim_CreateCommand(context->interp, cr->name,
412 cr->jim_handler, cr->jim_handler_data, NULL);
413 } else if (NULL != cr->handler || NULL != parent)
414 retval = register_command_handler(context, command_root(c));
415
416 if (ERROR_OK != retval) {
417 unregister_command(context, parent, name);
418 c = NULL;
419 }
420 return c;
421 }
422
423 int register_commands(struct command_context *cmd_ctx, struct command *parent,
424 const struct command_registration *cmds)
425 {
426 int retval = ERROR_OK;
427 unsigned i;
428 for (i = 0; cmds[i].name || cmds[i].chain; i++) {
429 const struct command_registration *cr = cmds + i;
430
431 struct command *c = NULL;
432 if (NULL != cr->name) {
433 c = register_command(cmd_ctx, parent, cr);
434 if (NULL == c) {
435 retval = ERROR_FAIL;
436 break;
437 }
438 }
439 if (NULL != cr->chain) {
440 struct command *p = c ? : parent;
441 retval = register_commands(cmd_ctx, p, cr->chain);
442 if (ERROR_OK != retval)
443 break;
444 }
445 }
446 if (ERROR_OK != retval) {
447 for (unsigned j = 0; j < i; j++)
448 unregister_command(cmd_ctx, parent, cmds[j].name);
449 }
450 return retval;
451 }
452
453 int unregister_all_commands(struct command_context *context,
454 struct command *parent)
455 {
456 if (context == NULL)
457 return ERROR_OK;
458
459 struct command **head = command_list_for_parent(context, parent);
460 while (NULL != *head) {
461 struct command *tmp = *head;
462 *head = tmp->next;
463 command_free(tmp);
464 }
465
466 return ERROR_OK;
467 }
468
469 int unregister_command(struct command_context *context,
470 struct command *parent, const char *name)
471 {
472 if ((!context) || (!name))
473 return ERROR_COMMAND_SYNTAX_ERROR;
474
475 struct command *p = NULL;
476 struct command **head = command_list_for_parent(context, parent);
477 for (struct command *c = *head; NULL != c; p = c, c = c->next) {
478 if (strcmp(name, c->name) != 0)
479 continue;
480
481 if (p)
482 p->next = c->next;
483 else
484 *head = c->next;
485
486 command_free(c);
487 return ERROR_OK;
488 }
489
490 return ERROR_OK;
491 }
492
493 void command_set_handler_data(struct command *c, void *p)
494 {
495 if (NULL != c->handler || NULL != c->jim_handler)
496 c->jim_handler_data = p;
497 for (struct command *cc = c->children; NULL != cc; cc = cc->next)
498 command_set_handler_data(cc, p);
499 }
500
501 void command_output_text(struct command_context *context, const char *data)
502 {
503 if (context && context->output_handler && data)
504 context->output_handler(context, data);
505 }
506
507 void command_print_sameline(struct command_context *context, const char *format, ...)
508 {
509 char *string;
510
511 va_list ap;
512 va_start(ap, format);
513
514 string = alloc_vprintf(format, ap);
515 if (string != NULL) {
516 /* we want this collected in the log + we also want to pick it up as a tcl return
517 * value.
518 *
519 * The latter bit isn't precisely neat, but will do for now.
520 */
521 LOG_USER_N("%s", string);
522 /* We already printed it above
523 * command_output_text(context, string); */
524 free(string);
525 }
526
527 va_end(ap);
528 }
529
530 void command_print(struct command_context *context, const char *format, ...)
531 {
532 char *string;
533
534 va_list ap;
535 va_start(ap, format);
536
537 string = alloc_vprintf(format, ap);
538 if (string != NULL) {
539 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
540 *char longer */
541 /* we want this collected in the log + we also want to pick it up as a tcl return
542 * value.
543 *
544 * The latter bit isn't precisely neat, but will do for now.
545 */
546 LOG_USER_N("%s", string);
547 /* We already printed it above
548 * command_output_text(context, string); */
549 free(string);
550 }
551
552 va_end(ap);
553 }
554
555 static char *__command_name(struct command *c, char delim, unsigned extra)
556 {
557 char *name;
558 unsigned len = strlen(c->name);
559 if (NULL == c->parent) {
560 /* allocate enough for the name, child names, and '\0' */
561 name = malloc(len + extra + 1);
562 strcpy(name, c->name);
563 } else {
564 /* parent's extra must include both the space and name */
565 name = __command_name(c->parent, delim, 1 + len + extra);
566 char dstr[2] = { delim, 0 };
567 strcat(name, dstr);
568 strcat(name, c->name);
569 }
570 return name;
571 }
572
573 char *command_name(struct command *c, char delim)
574 {
575 return __command_name(c, delim, 0);
576 }
577
578 static bool command_can_run(struct command_context *cmd_ctx, struct command *c)
579 {
580 return c->mode == COMMAND_ANY || c->mode == cmd_ctx->mode;
581 }
582
583 static int run_command(struct command_context *context,
584 struct command *c, const char *words[], unsigned num_words)
585 {
586 if (!command_can_run(context, c)) {
587 /* Many commands may be run only before/after 'init' */
588 const char *when;
589 switch (c->mode) {
590 case COMMAND_CONFIG:
591 when = "before";
592 break;
593 case COMMAND_EXEC:
594 when = "after";
595 break;
596 /* handle the impossible with humor; it guarantees a bug report! */
597 default:
598 when = "if Cthulhu is summoned by";
599 break;
600 }
601 LOG_ERROR("The '%s' command must be used %s 'init'.",
602 c->name, when);
603 return ERROR_FAIL;
604 }
605
606 struct command_invocation cmd = {
607 .ctx = context,
608 .current = c,
609 .name = c->name,
610 .argc = num_words - 1,
611 .argv = words + 1,
612 };
613 int retval = c->handler(&cmd);
614 if (retval == ERROR_COMMAND_SYNTAX_ERROR) {
615 /* Print help for command */
616 char *full_name = command_name(c, ' ');
617 if (NULL != full_name) {
618 command_run_linef(context, "usage %s", full_name);
619 free(full_name);
620 } else
621 retval = -ENOMEM;
622 } else if (retval == ERROR_COMMAND_CLOSE_CONNECTION) {
623 /* just fall through for a shutdown request */
624 } else if (retval != ERROR_OK) {
625 /* we do not print out an error message because the command *should*
626 * have printed out an error
627 */
628 LOG_DEBUG("Command failed with error code %d", retval);
629 }
630
631 return retval;
632 }
633
634 int command_run_line(struct command_context *context, char *line)
635 {
636 /* all the parent commands have been registered with the interpreter
637 * so, can just evaluate the line as a script and check for
638 * results
639 */
640 /* run the line thru a script engine */
641 int retval = ERROR_FAIL;
642 int retcode;
643 /* Beware! This code needs to be reentrant. It is also possible
644 * for OpenOCD commands to be invoked directly from Tcl. This would
645 * happen when the Jim Tcl interpreter is provided by eCos for
646 * instance.
647 */
648 Jim_Interp *interp = context->interp;
649 Jim_DeleteAssocData(interp, "context");
650 retcode = Jim_SetAssocData(interp, "context", NULL, context);
651 if (retcode == JIM_OK) {
652 /* associated the return value */
653 Jim_DeleteAssocData(interp, "retval");
654 retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
655 if (retcode == JIM_OK) {
656 retcode = Jim_Eval_Named(interp, line, 0, 0);
657
658 Jim_DeleteAssocData(interp, "retval");
659 }
660 Jim_DeleteAssocData(interp, "context");
661 }
662 if (retcode == JIM_OK) {
663 const char *result;
664 int reslen;
665
666 result = Jim_GetString(Jim_GetResult(interp), &reslen);
667 if (reslen > 0) {
668 int i;
669 char buff[256 + 1];
670 for (i = 0; i < reslen; i += 256) {
671 int chunk;
672 chunk = reslen - i;
673 if (chunk > 256)
674 chunk = 256;
675 strncpy(buff, result + i, chunk);
676 buff[chunk] = 0;
677 LOG_USER_N("%s", buff);
678 }
679 LOG_USER_N("\n");
680 }
681 retval = ERROR_OK;
682 } else if (retcode == JIM_EXIT) {
683 /* ignore.
684 * exit(Jim_GetExitCode(interp)); */
685 } else if (retcode == ERROR_COMMAND_CLOSE_CONNECTION) {
686 return retcode;
687 } else {
688 Jim_MakeErrorMessage(interp);
689 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
690
691 if (retval == ERROR_OK) {
692 /* It wasn't a low level OpenOCD command that failed */
693 return ERROR_FAIL;
694 }
695 return retval;
696 }
697
698 return retval;
699 }
700
701 int command_run_linef(struct command_context *context, const char *format, ...)
702 {
703 int retval = ERROR_FAIL;
704 char *string;
705 va_list ap;
706 va_start(ap, format);
707 string = alloc_vprintf(format, ap);
708 if (string != NULL) {
709 retval = command_run_line(context, string);
710 free(string);
711 }
712 va_end(ap);
713 return retval;
714 }
715
716 void command_set_output_handler(struct command_context *context,
717 command_output_handler_t output_handler, void *priv)
718 {
719 context->output_handler = output_handler;
720 context->output_handler_priv = priv;
721 }
722
723 struct command_context *copy_command_context(struct command_context *context)
724 {
725 struct command_context *copy_context = malloc(sizeof(struct command_context));
726
727 *copy_context = *context;
728
729 return copy_context;
730 }
731
732 void command_done(struct command_context *cmd_ctx)
733 {
734 if (NULL == cmd_ctx)
735 return;
736
737 free(cmd_ctx);
738 }
739
740 /* find full path to file */
741 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
742 {
743 if (argc != 2)
744 return JIM_ERR;
745 const char *file = Jim_GetString(argv[1], NULL);
746 char *full_path = find_file(file);
747 if (full_path == NULL)
748 return JIM_ERR;
749 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
750 free(full_path);
751
752 Jim_SetResult(interp, result);
753 return JIM_OK;
754 }
755
756 COMMAND_HANDLER(jim_echo)
757 {
758 if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
759 LOG_USER_N("%s", CMD_ARGV[1]);
760 return JIM_OK;
761 }
762 if (CMD_ARGC != 1)
763 return JIM_ERR;
764 LOG_USER("%s", CMD_ARGV[0]);
765 return JIM_OK;
766 }
767
768 /* Capture progress output and return as tcl return value. If the
769 * progress output was empty, return tcl return value.
770 */
771 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
772 {
773 if (argc != 2)
774 return JIM_ERR;
775
776 struct log_capture_state *state = command_log_capture_start(interp);
777
778 /* disable polling during capture. This avoids capturing output
779 * from polling.
780 *
781 * This is necessary in order to avoid accidentally getting a non-empty
782 * string for tcl fn's.
783 */
784 bool save_poll = jtag_poll_get_enabled();
785
786 jtag_poll_set_enabled(false);
787
788 const char *str = Jim_GetString(argv[1], NULL);
789 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
790
791 jtag_poll_set_enabled(save_poll);
792
793 command_log_capture_finish(state);
794
795 return retcode;
796 }
797
798 static COMMAND_HELPER(command_help_find, struct command *head,
799 struct command **out)
800 {
801 if (0 == CMD_ARGC)
802 return ERROR_COMMAND_SYNTAX_ERROR;
803 *out = command_find(head, CMD_ARGV[0]);
804 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
805 *out = command_find(head, CMD_ARGV[0] + 4);
806 if (NULL == *out)
807 return ERROR_COMMAND_SYNTAX_ERROR;
808 if (--CMD_ARGC == 0)
809 return ERROR_OK;
810 CMD_ARGV++;
811 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
812 }
813
814 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
815 bool show_help, const char *cmd_match);
816
817 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
818 bool show_help, const char *cmd_match)
819 {
820 for (struct command *c = head; NULL != c; c = c->next)
821 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, cmd_match);
822 return ERROR_OK;
823 }
824
825 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
826
827 static void command_help_show_indent(unsigned n)
828 {
829 for (unsigned i = 0; i < n; i++)
830 LOG_USER_N(" ");
831 }
832 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
833 {
834 const char *cp = str, *last = str;
835 while (*cp) {
836 const char *next = last;
837 do {
838 cp = next;
839 do {
840 next++;
841 } while (*next != ' ' && *next != '\t' && *next != '\0');
842 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
843 if (next - last < HELP_LINE_WIDTH(n))
844 cp = next;
845 command_help_show_indent(n);
846 LOG_USER("%.*s", (int)(cp - last), last);
847 last = cp + 1;
848 n = n2;
849 }
850 }
851
852 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
853 bool show_help, const char *cmd_match)
854 {
855 char *cmd_name = command_name(c, ' ');
856 if (NULL == cmd_name)
857 return -ENOMEM;
858
859 /* If the match string occurs anywhere, we print out
860 * stuff for this command. */
861 bool is_match = (strstr(cmd_name, cmd_match) != NULL) ||
862 ((c->usage != NULL) && (strstr(c->usage, cmd_match) != NULL)) ||
863 ((c->help != NULL) && (strstr(c->help, cmd_match) != NULL));
864
865 if (is_match) {
866 command_help_show_indent(n);
867 LOG_USER_N("%s", cmd_name);
868 }
869 free(cmd_name);
870
871 if (is_match) {
872 if (c->usage && strlen(c->usage) > 0) {
873 LOG_USER_N(" ");
874 command_help_show_wrap(c->usage, 0, n + 5);
875 } else
876 LOG_USER_N("\n");
877 }
878
879 if (is_match && show_help) {
880 char *msg;
881
882 /* Normal commands are runtime-only; highlight exceptions */
883 if (c->mode != COMMAND_EXEC) {
884 const char *stage_msg = "";
885
886 switch (c->mode) {
887 case COMMAND_CONFIG:
888 stage_msg = " (configuration command)";
889 break;
890 case COMMAND_ANY:
891 stage_msg = " (command valid any time)";
892 break;
893 default:
894 stage_msg = " (?mode error?)";
895 break;
896 }
897 msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
898 } else
899 msg = alloc_printf("%s", c->help ? : "");
900
901 if (NULL != msg) {
902 command_help_show_wrap(msg, n + 3, n + 3);
903 free(msg);
904 } else
905 return -ENOMEM;
906 }
907
908 if (++n > 5) {
909 LOG_ERROR("command recursion exceeded");
910 return ERROR_FAIL;
911 }
912
913 return CALL_COMMAND_HANDLER(command_help_show_list,
914 c->children, n, show_help, cmd_match);
915 }
916
917 COMMAND_HANDLER(handle_help_command)
918 {
919 bool full = strcmp(CMD_NAME, "help") == 0;
920 int retval;
921 struct command *c = CMD_CTX->commands;
922 char *cmd_match = NULL;
923
924 if (CMD_ARGC == 0)
925 cmd_match = "";
926 else if (CMD_ARGC >= 1) {
927 unsigned i;
928
929 for (i = 0; i < CMD_ARGC; ++i) {
930 if (NULL != cmd_match) {
931 char *prev = cmd_match;
932
933 cmd_match = alloc_printf("%s %s", cmd_match, CMD_ARGV[i]);
934 free(prev);
935 if (NULL == cmd_match) {
936 LOG_ERROR("unable to build search string");
937 return -ENOMEM;
938 }
939 } else {
940 cmd_match = alloc_printf("%s", CMD_ARGV[i]);
941 if (NULL == cmd_match) {
942 LOG_ERROR("unable to build search string");
943 return -ENOMEM;
944 }
945 }
946 }
947 } else
948 return ERROR_COMMAND_SYNTAX_ERROR;
949
950 retval = CALL_COMMAND_HANDLER(command_help_show_list,
951 c, 0, full, cmd_match);
952
953 if (CMD_ARGC >= 1)
954 free(cmd_match);
955 return retval;
956 }
957
958 static int command_unknown_find(unsigned argc, Jim_Obj *const *argv,
959 struct command *head, struct command **out, bool top_level)
960 {
961 if (0 == argc)
962 return argc;
963 const char *cmd_name = Jim_GetString(argv[0], NULL);
964 struct command *c = command_find(head, cmd_name);
965 if (NULL == c && top_level && strncmp(cmd_name, "ocd_", 4) == 0)
966 c = command_find(head, cmd_name + 4);
967 if (NULL == c)
968 return argc;
969 *out = c;
970 return command_unknown_find(--argc, ++argv, (*out)->children, out, false);
971 }
972
973 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
974 {
975 const char *cmd_name = Jim_GetString(argv[0], NULL);
976 if (strcmp(cmd_name, "unknown") == 0) {
977 if (argc == 1)
978 return JIM_OK;
979 argc--;
980 argv++;
981 }
982 script_debug(interp, cmd_name, argc, argv);
983
984 struct command_context *cmd_ctx = current_command_context(interp);
985 struct command *c = cmd_ctx->commands;
986 int remaining = command_unknown_find(argc, argv, c, &c, true);
987 /* if nothing could be consumed, then it's really an unknown command */
988 if (remaining == argc) {
989 const char *cmd = Jim_GetString(argv[0], NULL);
990 LOG_ERROR("Unknown command:\n %s", cmd);
991 return JIM_OK;
992 }
993
994 bool found = true;
995 Jim_Obj *const *start;
996 unsigned count;
997 if (c->handler || c->jim_handler) {
998 /* include the command name in the list */
999 count = remaining + 1;
1000 start = argv + (argc - remaining - 1);
1001 } else {
1002 c = command_find(cmd_ctx->commands, "usage");
1003 if (NULL == c) {
1004 LOG_ERROR("unknown command, but usage is missing too");
1005 return JIM_ERR;
1006 }
1007 count = argc - remaining;
1008 start = argv;
1009 found = false;
1010 }
1011 /* pass the command through to the intended handler */
1012 if (c->jim_handler) {
1013 interp->cmdPrivData = c->jim_handler_data;
1014 return (*c->jim_handler)(interp, count, start);
1015 }
1016
1017 return script_command_run(interp, count, start, c, found);
1018 }
1019
1020 static int jim_command_mode(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1021 {
1022 struct command_context *cmd_ctx = current_command_context(interp);
1023 enum command_mode mode;
1024
1025 if (argc > 1) {
1026 struct command *c = cmd_ctx->commands;
1027 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1028 /* if nothing could be consumed, then it's an unknown command */
1029 if (remaining == argc - 1) {
1030 Jim_SetResultString(interp, "unknown", -1);
1031 return JIM_OK;
1032 }
1033 mode = c->mode;
1034 } else
1035 mode = cmd_ctx->mode;
1036
1037 const char *mode_str;
1038 switch (mode) {
1039 case COMMAND_ANY:
1040 mode_str = "any";
1041 break;
1042 case COMMAND_CONFIG:
1043 mode_str = "config";
1044 break;
1045 case COMMAND_EXEC:
1046 mode_str = "exec";
1047 break;
1048 default:
1049 mode_str = "unknown";
1050 break;
1051 }
1052 Jim_SetResultString(interp, mode_str, -1);
1053 return JIM_OK;
1054 }
1055
1056 static int jim_command_type(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
1057 {
1058 if (1 == argc)
1059 return JIM_ERR;
1060
1061 struct command_context *cmd_ctx = current_command_context(interp);
1062 struct command *c = cmd_ctx->commands;
1063 int remaining = command_unknown_find(argc - 1, argv + 1, c, &c, true);
1064 /* if nothing could be consumed, then it's an unknown command */
1065 if (remaining == argc - 1) {
1066 Jim_SetResultString(interp, "unknown", -1);
1067 return JIM_OK;
1068 }
1069
1070 if (c->jim_handler)
1071 Jim_SetResultString(interp, "native", -1);
1072 else if (c->handler)
1073 Jim_SetResultString(interp, "simple", -1);
1074 else if (remaining == 0)
1075 Jim_SetResultString(interp, "group", -1);
1076 else
1077 Jim_SetResultString(interp, "unknown", -1);
1078
1079 return JIM_OK;
1080 }
1081
1082 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1083 const char *cmd_name, const char *help_text, const char *usage)
1084 {
1085 struct command **head = command_list_for_parent(cmd_ctx, parent);
1086 struct command *nc = command_find(*head, cmd_name);
1087 if (NULL == nc) {
1088 /* add a new command with help text */
1089 struct command_registration cr = {
1090 .name = cmd_name,
1091 .mode = COMMAND_ANY,
1092 .help = help_text,
1093 .usage = usage,
1094 };
1095 nc = register_command(cmd_ctx, parent, &cr);
1096 if (NULL == nc) {
1097 LOG_ERROR("failed to add '%s' help text", cmd_name);
1098 return ERROR_FAIL;
1099 }
1100 LOG_DEBUG("added '%s' help text", cmd_name);
1101 return ERROR_OK;
1102 }
1103 if (help_text) {
1104 bool replaced = false;
1105 if (nc->help) {
1106 free(nc->help);
1107 replaced = true;
1108 }
1109 nc->help = strdup(help_text);
1110 if (replaced)
1111 LOG_INFO("replaced existing '%s' help", cmd_name);
1112 else
1113 LOG_DEBUG("added '%s' help text", cmd_name);
1114 }
1115 if (usage) {
1116 bool replaced = false;
1117 if (nc->usage) {
1118 free(nc->usage);
1119 replaced = true;
1120 }
1121 nc->usage = strdup(usage);
1122 if (replaced)
1123 LOG_INFO("replaced existing '%s' usage", cmd_name);
1124 else
1125 LOG_DEBUG("added '%s' usage text", cmd_name);
1126 }
1127 return ERROR_OK;
1128 }
1129
1130 COMMAND_HANDLER(handle_help_add_command)
1131 {
1132 if (CMD_ARGC < 2) {
1133 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1134 return ERROR_COMMAND_SYNTAX_ERROR;
1135 }
1136
1137 /* save help text and remove it from argument list */
1138 const char *str = CMD_ARGV[--CMD_ARGC];
1139 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1140 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1141 if (!help && !usage) {
1142 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1143 return ERROR_COMMAND_SYNTAX_ERROR;
1144 }
1145 /* likewise for the leaf command name */
1146 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1147
1148 struct command *c = NULL;
1149 if (CMD_ARGC > 0) {
1150 c = CMD_CTX->commands;
1151 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1152 if (ERROR_OK != retval)
1153 return retval;
1154 }
1155 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1156 }
1157
1158 /* sleep command sleeps for <n> milliseconds
1159 * this is useful in target startup scripts
1160 */
1161 COMMAND_HANDLER(handle_sleep_command)
1162 {
1163 bool busy = false;
1164 if (CMD_ARGC == 2) {
1165 if (strcmp(CMD_ARGV[1], "busy") == 0)
1166 busy = true;
1167 else
1168 return ERROR_COMMAND_SYNTAX_ERROR;
1169 } else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1170 return ERROR_COMMAND_SYNTAX_ERROR;
1171
1172 unsigned long duration = 0;
1173 int retval = parse_ulong(CMD_ARGV[0], &duration);
1174 if (ERROR_OK != retval)
1175 return retval;
1176
1177 if (!busy) {
1178 long long then = timeval_ms();
1179 while (timeval_ms() - then < (long long)duration) {
1180 target_call_timer_callbacks_now();
1181 usleep(1000);
1182 }
1183 } else
1184 busy_sleep(duration);
1185
1186 return ERROR_OK;
1187 }
1188
1189 static const struct command_registration command_subcommand_handlers[] = {
1190 {
1191 .name = "mode",
1192 .mode = COMMAND_ANY,
1193 .jim_handler = jim_command_mode,
1194 .usage = "[command_name ...]",
1195 .help = "Returns the command modes allowed by a command:"
1196 "'any', 'config', or 'exec'. If no command is"
1197 "specified, returns the current command mode. "
1198 "Returns 'unknown' if an unknown command is given. "
1199 "Command can be multiple tokens.",
1200 },
1201 {
1202 .name = "type",
1203 .mode = COMMAND_ANY,
1204 .jim_handler = jim_command_type,
1205 .usage = "command_name [...]",
1206 .help = "Returns the type of built-in command:"
1207 "'native', 'simple', 'group', or 'unknown'. "
1208 "Command can be multiple tokens.",
1209 },
1210 COMMAND_REGISTRATION_DONE
1211 };
1212
1213 static const struct command_registration command_builtin_handlers[] = {
1214 {
1215 .name = "echo",
1216 .handler = jim_echo,
1217 .mode = COMMAND_ANY,
1218 .help = "Logs a message at \"user\" priority. "
1219 "Output message to stdout. "
1220 "Option \"-n\" suppresses trailing newline",
1221 .usage = "[-n] string",
1222 },
1223 {
1224 .name = "add_help_text",
1225 .handler = handle_help_add_command,
1226 .mode = COMMAND_ANY,
1227 .help = "Add new command help text; "
1228 "Command can be multiple tokens.",
1229 .usage = "command_name helptext_string",
1230 },
1231 {
1232 .name = "add_usage_text",
1233 .handler = handle_help_add_command,
1234 .mode = COMMAND_ANY,
1235 .help = "Add new command usage text; "
1236 "command can be multiple tokens.",
1237 .usage = "command_name usage_string",
1238 },
1239 {
1240 .name = "sleep",
1241 .handler = handle_sleep_command,
1242 .mode = COMMAND_ANY,
1243 .help = "Sleep for specified number of milliseconds. "
1244 "\"busy\" will busy wait instead (avoid this).",
1245 .usage = "milliseconds ['busy']",
1246 },
1247 {
1248 .name = "help",
1249 .handler = handle_help_command,
1250 .mode = COMMAND_ANY,
1251 .help = "Show full command help; "
1252 "command can be multiple tokens.",
1253 .usage = "[command_name]",
1254 },
1255 {
1256 .name = "usage",
1257 .handler = handle_help_command,
1258 .mode = COMMAND_ANY,
1259 .help = "Show basic command usage; "
1260 "command can be multiple tokens.",
1261 .usage = "[command_name]",
1262 },
1263 {
1264 .name = "command",
1265 .mode = COMMAND_ANY,
1266 .help = "core command group (introspection)",
1267 .chain = command_subcommand_handlers,
1268 },
1269 COMMAND_REGISTRATION_DONE
1270 };
1271
1272 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
1273 {
1274 struct command_context *context = malloc(sizeof(struct command_context));
1275 const char *HostOs;
1276
1277 context->mode = COMMAND_EXEC;
1278 context->commands = NULL;
1279 context->current_target = 0;
1280 context->output_handler = NULL;
1281 context->output_handler_priv = NULL;
1282
1283 /* Create a jim interpreter if we were not handed one */
1284 if (interp == NULL) {
1285 /* Create an interpreter */
1286 interp = Jim_CreateInterp();
1287 /* Add all the Jim core commands */
1288 Jim_RegisterCoreCommands(interp);
1289 Jim_InitStaticExtensions(interp);
1290 }
1291
1292 context->interp = interp;
1293
1294 /* Stick to lowercase for HostOS strings. */
1295 #if defined(_MSC_VER)
1296 /* WinXX - is generic, the forward
1297 * looking problem is this:
1298 *
1299 * "win32" or "win64"
1300 *
1301 * "winxx" is generic.
1302 */
1303 HostOs = "winxx";
1304 #elif defined(__linux__)
1305 HostOs = "linux";
1306 #elif defined(__APPLE__) || defined(__DARWIN__)
1307 HostOs = "darwin";
1308 #elif defined(__CYGWIN__)
1309 HostOs = "cygwin";
1310 #elif defined(__MINGW32__)
1311 HostOs = "mingw32";
1312 #elif defined(__ECOS)
1313 HostOs = "ecos";
1314 #elif defined(__FreeBSD__)
1315 HostOs = "freebsd";
1316 #elif defined(__NetBSD__)
1317 HostOs = "netbsd";
1318 #elif defined(__OpenBSD__)
1319 HostOs = "openbsd";
1320 #else
1321 #warning "Unrecognized host OS..."
1322 HostOs = "other";
1323 #endif
1324 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1325 Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
1326
1327 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1328 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1329
1330 register_commands(context, NULL, command_builtin_handlers);
1331
1332 Jim_SetAssocData(interp, "context", NULL, context);
1333 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl", 1) == JIM_ERR) {
1334 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1335 Jim_MakeErrorMessage(interp);
1336 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
1337 exit(-1);
1338 }
1339 Jim_DeleteAssocData(interp, "context");
1340
1341 return context;
1342 }
1343
1344 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1345 {
1346 if (!cmd_ctx)
1347 return ERROR_COMMAND_SYNTAX_ERROR;
1348
1349 cmd_ctx->mode = mode;
1350 return ERROR_OK;
1351 }
1352
1353 void process_jim_events(struct command_context *cmd_ctx)
1354 {
1355 static int recursion;
1356 if (recursion)
1357 return;
1358
1359 recursion++;
1360 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1361 recursion--;
1362 }
1363
1364 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1365 int parse ## name(const char *str, type * ul) \
1366 { \
1367 if (!*str) { \
1368 LOG_ERROR("Invalid command argument"); \
1369 return ERROR_COMMAND_ARGUMENT_INVALID; \
1370 } \
1371 char *end; \
1372 *ul = func(str, &end, 0); \
1373 if (*end) { \
1374 LOG_ERROR("Invalid command argument"); \
1375 return ERROR_COMMAND_ARGUMENT_INVALID; \
1376 } \
1377 if ((max == *ul) && (ERANGE == errno)) { \
1378 LOG_ERROR("Argument overflow"); \
1379 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1380 } \
1381 if (min && (min == *ul) && (ERANGE == errno)) { \
1382 LOG_ERROR("Argument underflow"); \
1383 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1384 } \
1385 return ERROR_OK; \
1386 }
1387 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long, strtoul, 0, ULONG_MAX)
1388 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1389 DEFINE_PARSE_NUM_TYPE(_long, long, strtol, LONG_MIN, LONG_MAX)
1390 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1391
1392 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1393 int parse ## name(const char *str, type * ul) \
1394 { \
1395 functype n; \
1396 int retval = parse ## funcname(str, &n); \
1397 if (ERROR_OK != retval) \
1398 return retval; \
1399 if (n > max) \
1400 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1401 if (min) \
1402 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1403 *ul = n; \
1404 return ERROR_OK; \
1405 }
1406
1407 #define DEFINE_PARSE_ULONGLONG(name, type, min, max) \
1408 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long long, _ullong)
1409 DEFINE_PARSE_ULONGLONG(_uint, unsigned, 0, UINT_MAX)
1410 DEFINE_PARSE_ULONGLONG(_u64, uint64_t, 0, UINT64_MAX)
1411 DEFINE_PARSE_ULONGLONG(_u32, uint32_t, 0, UINT32_MAX)
1412 DEFINE_PARSE_ULONGLONG(_u16, uint16_t, 0, UINT16_MAX)
1413 DEFINE_PARSE_ULONGLONG(_u8, uint8_t, 0, UINT8_MAX)
1414
1415 #define DEFINE_PARSE_LONGLONG(name, type, min, max) \
1416 DEFINE_PARSE_WRAPPER(name, type, min, max, long long, _llong)
1417 DEFINE_PARSE_LONGLONG(_int, int, n < INT_MIN, INT_MAX)
1418 DEFINE_PARSE_LONGLONG(_s64, int64_t, n < INT64_MIN, INT64_MAX)
1419 DEFINE_PARSE_LONGLONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1420 DEFINE_PARSE_LONGLONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1421 DEFINE_PARSE_LONGLONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1422
1423 static int command_parse_bool(const char *in, bool *out,
1424 const char *on, const char *off)
1425 {
1426 if (strcasecmp(in, on) == 0)
1427 *out = true;
1428 else if (strcasecmp(in, off) == 0)
1429 *out = false;
1430 else
1431 return ERROR_COMMAND_SYNTAX_ERROR;
1432 return ERROR_OK;
1433 }
1434
1435 int command_parse_bool_arg(const char *in, bool *out)
1436 {
1437 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1438 return ERROR_OK;
1439 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1440 return ERROR_OK;
1441 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1442 return ERROR_OK;
1443 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1444 return ERROR_OK;
1445 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1446 return ERROR_OK;
1447 return ERROR_COMMAND_SYNTAX_ERROR;
1448 }
1449
1450 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1451 {
1452 switch (CMD_ARGC) {
1453 case 1: {
1454 const char *in = CMD_ARGV[0];
1455 if (command_parse_bool_arg(in, out) != ERROR_OK) {
1456 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1457 return ERROR_COMMAND_SYNTAX_ERROR;
1458 }
1459 /* fall through */
1460 }
1461 case 0:
1462 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1463 break;
1464 default:
1465 return ERROR_COMMAND_SYNTAX_ERROR;
1466 }
1467 return ERROR_OK;
1468 }

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)