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