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