ef0afa2b56bca06e5b88e13ce4c5ca2c97b4ec2b
[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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
28 ***************************************************************************/
29
30 #ifdef HAVE_CONFIG_H
31 #include "config.h"
32 #endif
33
34 /* see Embedder-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 = (struct log_capture_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 : JIM_ERR;
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(const char **words, unsigned nwords)
150 {
151 for (unsigned i = 0; i < nwords; i++)
152 free((void *)words[i]);
153 free(words);
154 }
155 static const char **script_command_args_alloc(
156 unsigned argc, Jim_Obj * const *argv, unsigned *nwords)
157 {
158 const char **words = malloc(argc * sizeof(char *));
159 if (NULL == words)
160 return NULL;
161
162 unsigned i;
163 for (i = 0; i < argc; i++) {
164 int len;
165 const char *w = Jim_GetString(argv[i], &len);
166 words[i] = strdup(w);
167 if (words[i] == NULL) {
168 script_command_args_free(words, i);
169 return NULL;
170 }
171 }
172 *nwords = i;
173 return words;
174 }
175
176 struct command_context *current_command_context(Jim_Interp *interp)
177 {
178 /* grab the command context from the associated data */
179 struct command_context *cmd_ctx = Jim_GetAssocData(interp, "context");
180 if (NULL == cmd_ctx) {
181 /* Tcl can invoke commands directly instead of via command_run_line(). This would
182 * happen when the Jim Tcl interpreter is provided by eCos or if we are running
183 * commands in a startup script.
184 *
185 * A telnet or gdb server would provide a non-default command context to
186 * handle piping of error output, have a separate current target, etc.
187 */
188 cmd_ctx = global_cmd_ctx;
189 }
190 return cmd_ctx;
191 }
192
193 static int script_command_run(Jim_Interp *interp,
194 int argc, Jim_Obj * const *argv, struct command *c, bool capture)
195 {
196 target_call_timer_callbacks_now();
197 LOG_USER_N("%s", ""); /* Keep GDB connection alive*/
198
199 unsigned nwords;
200 const char **words = script_command_args_alloc(argc, argv, &nwords);
201 if (NULL == words)
202 return JIM_ERR;
203
204 struct log_capture_state *state = NULL;
205 if (capture)
206 state = command_log_capture_start(interp);
207
208 struct command_context *cmd_ctx = current_command_context(interp);
209 int retval = run_command(cmd_ctx, c, (const char **)words, nwords);
210
211 command_log_capture_finish(state);
212
213 script_command_args_free(words, nwords);
214 return command_retval_set(interp, retval);
215 }
216
217 static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
218 {
219 /* the private data is stashed in the interp structure */
220
221 struct command *c = interp->cmdPrivData;
222 assert(c);
223 script_debug(interp, c->name, argc, argv);
224 return script_command_run(interp, argc, argv, c, true);
225 }
226
227 static struct command *command_root(struct command *c)
228 {
229 while (NULL != c->parent)
230 c = c->parent;
231 return c;
232 }
233
234 /**
235 * Find a command by name from a list of commands.
236 * @returns Returns the named command if it exists in the list.
237 * Returns NULL otherwise.
238 */
239 static struct command *command_find(struct command *head, const char *name)
240 {
241 for (struct command *cc = head; cc; cc = cc->next) {
242 if (strcmp(cc->name, name) == 0)
243 return cc;
244 }
245 return NULL;
246 }
247 struct command *command_find_in_context(struct command_context *cmd_ctx,
248 const char *name)
249 {
250 return command_find(cmd_ctx->commands, name);
251 }
252 struct command *command_find_in_parent(struct command *parent,
253 const char *name)
254 {
255 return command_find(parent->children, name);
256 }
257
258 /**
259 * Add the command into the linked list, sorted by name.
260 * @param head Address to head of command list pointer, which may be
261 * updated if @c c gets inserted at the beginning of the list.
262 * @param c The command to add to the list pointed to by @c head.
263 */
264 static void command_add_child(struct command **head, struct command *c)
265 {
266 assert(head);
267 if (NULL == *head) {
268 *head = c;
269 return;
270 }
271
272 while ((*head)->next && (strcmp(c->name, (*head)->name) > 0))
273 head = &(*head)->next;
274
275 if (strcmp(c->name, (*head)->name) > 0) {
276 c->next = (*head)->next;
277 (*head)->next = c;
278 } else {
279 c->next = *head;
280 *head = c;
281 }
282 }
283
284 static struct command **command_list_for_parent(
285 struct command_context *cmd_ctx, struct command *parent)
286 {
287 return parent ? &parent->children : &cmd_ctx->commands;
288 }
289
290 static void command_free(struct command *c)
291 {
292 /** @todo if command has a handler, unregister its jim command! */
293
294 while (NULL != c->children) {
295 struct command *tmp = c->children;
296 c->children = tmp->next;
297 command_free(tmp);
298 }
299
300 if (c->name)
301 free((void *)c->name);
302 if (c->help)
303 free((void *)c->help);
304 if (c->usage)
305 free((void *)c->usage);
306 free(c);
307 }
308
309 static struct command *command_new(struct command_context *cmd_ctx,
310 struct command *parent, const struct command_registration *cr)
311 {
312 assert(cr->name);
313
314 /*
315 * If it is a non-jim command with no .usage specified,
316 * log an error.
317 *
318 * strlen(.usage) == 0 means that the command takes no
319 * arguments.
320 */
321 if ((cr->jim_handler == NULL) && (cr->usage == NULL)) {
322 LOG_DEBUG("BUG: command '%s%s%s' does not have the "
323 "'.usage' field filled out",
324 parent && parent->name ? parent->name : "",
325 parent && parent->name ? " " : "",
326 cr->name);
327 }
328
329 struct command *c = calloc(1, sizeof(struct command));
330 if (NULL == c)
331 return NULL;
332
333 c->name = strdup(cr->name);
334 if (cr->help)
335 c->help = strdup(cr->help);
336 if (cr->usage)
337 c->usage = strdup(cr->usage);
338
339 if (!c->name || (cr->help && !c->help) || (cr->usage && !c->usage))
340 goto command_new_error;
341
342 c->parent = parent;
343 c->handler = cr->handler;
344 c->jim_handler = cr->jim_handler;
345 c->jim_handler_data = cr->jim_handler_data;
346 c->mode = cr->mode;
347
348 command_add_child(command_list_for_parent(cmd_ctx, parent), c);
349
350 return c;
351
352 command_new_error:
353 command_free(c);
354 return NULL;
355 }
356
357 static int command_unknown(Jim_Interp *interp, int argc, Jim_Obj *const *argv);
358
359 static int register_command_handler(struct command_context *cmd_ctx,
360 struct command *c)
361 {
362 Jim_Interp *interp = cmd_ctx->interp;
363 const char *ocd_name = alloc_printf("ocd_%s", c->name);
364 if (NULL == ocd_name)
365 return JIM_ERR;
366
367 LOG_DEBUG("registering '%s'...", ocd_name);
368
369 Jim_CmdProc func = c->handler ? &script_command : &command_unknown;
370 int retval = Jim_CreateCommand(interp, ocd_name, func, c, NULL);
371 free((void *)ocd_name);
372 if (JIM_OK != retval)
373 return retval;
374
375 /* we now need to add an overrideable proc */
376 const char *override_name = alloc_printf(
377 "proc %s {args} {eval ocd_bouncer %s $args}",
378 c->name, c->name);
379 if (NULL == override_name)
380 return JIM_ERR;
381
382 retval = Jim_Eval_Named(interp, override_name, 0, 0);
383 free((void *)override_name);
384
385 return retval;
386 }
387
388 struct command *register_command(struct command_context *context,
389 struct command *parent, const struct command_registration *cr)
390 {
391 if (!context || !cr->name)
392 return NULL;
393
394 const char *name = cr->name;
395 struct command **head = command_list_for_parent(context, parent);
396 struct command *c = command_find(*head, name);
397 if (NULL != c) {
398 /* TODO: originally we treated attempting to register a cmd twice as an error
399 * Sometimes we need this behaviour, such as with flash banks.
400 * http://www.mail-archive.com/openocd-development@lists.berlios.de/msg11152.html */
401 LOG_DEBUG("command '%s' is already registered in '%s' context",
402 name, parent ? parent->name : "<global>");
403 return c;
404 }
405
406 c = command_new(context, parent, cr);
407 if (NULL == c)
408 return NULL;
409
410 int retval = ERROR_OK;
411 if (NULL != cr->jim_handler && NULL == parent) {
412 retval = Jim_CreateCommand(context->interp, cr->name,
413 cr->jim_handler, cr->jim_handler_data, NULL);
414 } else if (NULL != cr->handler || NULL != parent)
415 retval = register_command_handler(context, command_root(c));
416
417 if (ERROR_OK != retval) {
418 unregister_command(context, parent, name);
419 c = NULL;
420 }
421 return c;
422 }
423
424 int register_commands(struct command_context *cmd_ctx, struct command *parent,
425 const struct command_registration *cmds)
426 {
427 int retval = ERROR_OK;
428 unsigned i;
429 for (i = 0; cmds[i].name || cmds[i].chain; i++) {
430 const struct command_registration *cr = cmds + i;
431
432 struct command *c = NULL;
433 if (NULL != cr->name) {
434 c = register_command(cmd_ctx, parent, cr);
435 if (NULL == c) {
436 retval = ERROR_FAIL;
437 break;
438 }
439 }
440 if (NULL != cr->chain) {
441 struct command *p = c ? : parent;
442 retval = register_commands(cmd_ctx, p, cr->chain);
443 if (ERROR_OK != retval)
444 break;
445 }
446 }
447 if (ERROR_OK != retval) {
448 for (unsigned j = 0; j < i; j++)
449 unregister_command(cmd_ctx, parent, cmds[j].name);
450 }
451 return retval;
452 }
453
454 int unregister_all_commands(struct command_context *context,
455 struct command *parent)
456 {
457 if (context == NULL)
458 return ERROR_OK;
459
460 struct command **head = command_list_for_parent(context, parent);
461 while (NULL != *head) {
462 struct command *tmp = *head;
463 *head = tmp->next;
464 command_free(tmp);
465 }
466
467 return ERROR_OK;
468 }
469
470 int unregister_command(struct command_context *context,
471 struct command *parent, const char *name)
472 {
473 if ((!context) || (!name))
474 return ERROR_COMMAND_SYNTAX_ERROR;
475
476 struct command *p = NULL;
477 struct command **head = command_list_for_parent(context, parent);
478 for (struct command *c = *head; NULL != c; p = c, c = c->next) {
479 if (strcmp(name, c->name) != 0)
480 continue;
481
482 if (p)
483 p->next = c->next;
484 else
485 *head = c->next;
486
487 command_free(c);
488 return ERROR_OK;
489 }
490
491 return ERROR_OK;
492 }
493
494 void command_set_handler_data(struct command *c, void *p)
495 {
496 if (NULL != c->handler || NULL != c->jim_handler)
497 c->jim_handler_data = p;
498 for (struct command *cc = c->children; NULL != cc; cc = cc->next)
499 command_set_handler_data(cc, p);
500 }
501
502 void command_output_text(struct command_context *context, const char *data)
503 {
504 if (context && context->output_handler && data)
505 context->output_handler(context, data);
506 }
507
508 void command_print_sameline(struct command_context *context, const char *format, ...)
509 {
510 char *string;
511
512 va_list ap;
513 va_start(ap, format);
514
515 string = alloc_vprintf(format, ap);
516 if (string != NULL) {
517 /* we want this collected in the log + we also want to pick it up as a tcl return
518 * value.
519 *
520 * The latter bit isn't precisely neat, but will do for now.
521 */
522 LOG_USER_N("%s", string);
523 /* We already printed it above
524 * command_output_text(context, string); */
525 free(string);
526 }
527
528 va_end(ap);
529 }
530
531 void command_print(struct command_context *context, const char *format, ...)
532 {
533 char *string;
534
535 va_list ap;
536 va_start(ap, format);
537
538 string = alloc_vprintf(format, ap);
539 if (string != NULL) {
540 strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one
541 *char longer */
542 /* we want this collected in the log + we also want to pick it up as a tcl return
543 * value.
544 *
545 * The latter bit isn't precisely neat, but will do for now.
546 */
547 LOG_USER_N("%s", string);
548 /* We already printed it above
549 * command_output_text(context, string); */
550 free(string);
551 }
552
553 va_end(ap);
554 }
555
556 static char *__command_name(struct command *c, char delim, unsigned extra)
557 {
558 char *name;
559 unsigned len = strlen(c->name);
560 if (NULL == c->parent) {
561 /* allocate enough for the name, child names, and '\0' */
562 name = malloc(len + extra + 1);
563 strcpy(name, c->name);
564 } else {
565 /* parent's extra must include both the space and name */
566 name = __command_name(c->parent, delim, 1 + len + extra);
567 char dstr[2] = { delim, 0 };
568 strcat(name, dstr);
569 strcat(name, c->name);
570 }
571 return name;
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_ERR) {
663 if (retval != ERROR_COMMAND_CLOSE_CONNECTION) {
664 /* We do not print the connection closed error message */
665 Jim_MakeErrorMessage(interp);
666 LOG_USER("%s", Jim_GetString(Jim_GetResult(interp), NULL));
667 }
668 if (retval == ERROR_OK) {
669 /* It wasn't a low level OpenOCD command that failed */
670 return ERROR_FAIL;
671 }
672 return retval;
673 } else if (retcode == JIM_EXIT) {
674 /* ignore.
675 * exit(Jim_GetExitCode(interp)); */
676 } else {
677 const char *result;
678 int reslen;
679
680 result = Jim_GetString(Jim_GetResult(interp), &reslen);
681 if (reslen > 0) {
682 int i;
683 char buff[256 + 1];
684 for (i = 0; i < reslen; i += 256) {
685 int chunk;
686 chunk = reslen - i;
687 if (chunk > 256)
688 chunk = 256;
689 strncpy(buff, result + i, chunk);
690 buff[chunk] = 0;
691 LOG_USER_N("%s", buff);
692 }
693 LOG_USER_N("\n");
694 }
695 retval = ERROR_OK;
696 }
697 return retval;
698 }
699
700 int command_run_linef(struct command_context *context, const char *format, ...)
701 {
702 int retval = ERROR_FAIL;
703 char *string;
704 va_list ap;
705 va_start(ap, format);
706 string = alloc_vprintf(format, ap);
707 if (string != NULL) {
708 retval = command_run_line(context, string);
709 free(string);
710 }
711 va_end(ap);
712 return retval;
713 }
714
715 void command_set_output_handler(struct command_context *context,
716 command_output_handler_t output_handler, void *priv)
717 {
718 context->output_handler = output_handler;
719 context->output_handler_priv = priv;
720 }
721
722 struct command_context *copy_command_context(struct command_context *context)
723 {
724 struct command_context *copy_context = malloc(sizeof(struct command_context));
725
726 *copy_context = *context;
727
728 return copy_context;
729 }
730
731 void command_done(struct command_context *cmd_ctx)
732 {
733 if (NULL == cmd_ctx)
734 return;
735
736 free(cmd_ctx);
737 }
738
739 /* find full path to file */
740 static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
741 {
742 if (argc != 2)
743 return JIM_ERR;
744 const char *file = Jim_GetString(argv[1], NULL);
745 char *full_path = find_file(file);
746 if (full_path == NULL)
747 return JIM_ERR;
748 Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
749 free(full_path);
750
751 Jim_SetResult(interp, result);
752 return JIM_OK;
753 }
754
755 COMMAND_HANDLER(jim_echo)
756 {
757 if (CMD_ARGC == 2 && !strcmp(CMD_ARGV[0], "-n")) {
758 LOG_USER_N("%s", CMD_ARGV[1]);
759 return JIM_OK;
760 }
761 if (CMD_ARGC != 1)
762 return JIM_ERR;
763 LOG_USER("%s", CMD_ARGV[0]);
764 return JIM_OK;
765 }
766
767 /* Capture progress output and return as tcl return value. If the
768 * progress output was empty, return tcl return value.
769 */
770 static int jim_capture(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
771 {
772 if (argc != 2)
773 return JIM_ERR;
774
775 struct log_capture_state *state = command_log_capture_start(interp);
776
777 /* disable polling during capture. This avoids capturing output
778 * from polling.
779 *
780 * This is necessary in order to avoid accidentially getting a non-empty
781 * string for tcl fn's.
782 */
783 bool save_poll = jtag_poll_get_enabled();
784
785 jtag_poll_set_enabled(false);
786
787 const char *str = Jim_GetString(argv[1], NULL);
788 int retcode = Jim_Eval_Named(interp, str, __THIS__FILE__, __LINE__);
789
790 jtag_poll_set_enabled(save_poll);
791
792 command_log_capture_finish(state);
793
794 return retcode;
795 }
796
797 static COMMAND_HELPER(command_help_find, struct command *head,
798 struct command **out)
799 {
800 if (0 == CMD_ARGC)
801 return ERROR_COMMAND_SYNTAX_ERROR;
802 *out = command_find(head, CMD_ARGV[0]);
803 if (NULL == *out && strncmp(CMD_ARGV[0], "ocd_", 4) == 0)
804 *out = command_find(head, CMD_ARGV[0] + 4);
805 if (NULL == *out)
806 return ERROR_COMMAND_SYNTAX_ERROR;
807 if (--CMD_ARGC == 0)
808 return ERROR_OK;
809 CMD_ARGV++;
810 return CALL_COMMAND_HANDLER(command_help_find, (*out)->children, out);
811 }
812
813 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
814 bool show_help, const char *match);
815
816 static COMMAND_HELPER(command_help_show_list, struct command *head, unsigned n,
817 bool show_help, const char *match)
818 {
819 for (struct command *c = head; NULL != c; c = c->next)
820 CALL_COMMAND_HANDLER(command_help_show, c, n, show_help, match);
821 return ERROR_OK;
822 }
823
824 #define HELP_LINE_WIDTH(_n) (int)(76 - (2 * _n))
825
826 static void command_help_show_indent(unsigned n)
827 {
828 for (unsigned i = 0; i < n; i++)
829 LOG_USER_N(" ");
830 }
831 static void command_help_show_wrap(const char *str, unsigned n, unsigned n2)
832 {
833 const char *cp = str, *last = str;
834 while (*cp) {
835 const char *next = last;
836 do {
837 cp = next;
838 do {
839 next++;
840 } while (*next != ' ' && *next != '\t' && *next != '\0');
841 } while ((next - last < HELP_LINE_WIDTH(n)) && *next != '\0');
842 if (next - last < HELP_LINE_WIDTH(n))
843 cp = next;
844 command_help_show_indent(n);
845 LOG_USER("%.*s", (int)(cp - last), last);
846 last = cp + 1;
847 n = n2;
848 }
849 }
850 static COMMAND_HELPER(command_help_show, struct command *c, unsigned n,
851 bool show_help, const char *match)
852 {
853 char *cmd_name = command_name(c, ' ');
854 if (NULL == cmd_name)
855 return -ENOMEM;
856
857 /* If the match string occurs anywhere, we print out
858 * stuff for this command. */
859 bool is_match = (strstr(cmd_name, match) != NULL) ||
860 ((c->usage != NULL) && (strstr(c->usage, match) != NULL)) ||
861 ((c->help != NULL) && (strstr(c->help, match) != NULL));
862
863 if (is_match) {
864 command_help_show_indent(n);
865 LOG_USER_N("%s", cmd_name);
866 }
867 free(cmd_name);
868
869 if (is_match) {
870 if (c->usage) {
871 LOG_USER_N(" ");
872 command_help_show_wrap(c->usage, 0, n + 5);
873 } else
874 LOG_USER_N("\n");
875 }
876
877 if (is_match && show_help) {
878 char *msg;
879
880 /* Normal commands are runtime-only; highlight exceptions */
881 if (c->mode != COMMAND_EXEC) {
882 const char *stage_msg = "";
883
884 switch (c->mode) {
885 case COMMAND_CONFIG:
886 stage_msg = " (configuration command)";
887 break;
888 case COMMAND_ANY:
889 stage_msg = " (command valid any time)";
890 break;
891 default:
892 stage_msg = " (?mode error?)";
893 break;
894 }
895 msg = alloc_printf("%s%s", c->help ? : "", stage_msg);
896 } else
897 msg = alloc_printf("%s", c->help ? : "");
898
899 if (NULL != msg) {
900 command_help_show_wrap(msg, n + 3, n + 3);
901 free(msg);
902 } else
903 return -ENOMEM;
904 }
905
906 if (++n > 5) {
907 LOG_ERROR("command recursion exceeded");
908 return ERROR_FAIL;
909 }
910
911 return CALL_COMMAND_HANDLER(command_help_show_list,
912 c->children, n, show_help, match);
913 }
914 COMMAND_HANDLER(handle_help_command)
915 {
916 bool full = strcmp(CMD_NAME, "help") == 0;
917 int retval;
918 struct command *c = CMD_CTX->commands;
919 char *match = NULL;
920
921 if (CMD_ARGC == 0)
922 match = "";
923 else if (CMD_ARGC >= 1) {
924 unsigned i;
925
926 for (i = 0; i < CMD_ARGC; ++i) {
927 if (NULL != match) {
928 char *prev = match;
929
930 match = alloc_printf("%s %s", match,
931 CMD_ARGV[i]);
932 free(prev);
933 if (NULL == match) {
934 LOG_ERROR("unable to build "
935 "search string");
936 return -ENOMEM;
937 }
938 } else {
939 match = alloc_printf("%s", CMD_ARGV[i]);
940 if (NULL == match) {
941 LOG_ERROR("unable to build "
942 "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, match);
952
953 if (CMD_ARGC >= 1)
954 free(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
1075 Jim_SetResultString(interp, "group", -1);
1076
1077 return JIM_OK;
1078 }
1079
1080 int help_add_command(struct command_context *cmd_ctx, struct command *parent,
1081 const char *cmd_name, const char *help_text, const char *usage)
1082 {
1083 struct command **head = command_list_for_parent(cmd_ctx, parent);
1084 struct command *nc = command_find(*head, cmd_name);
1085 if (NULL == nc) {
1086 /* add a new command with help text */
1087 struct command_registration cr = {
1088 .name = cmd_name,
1089 .mode = COMMAND_ANY,
1090 .help = help_text,
1091 .usage = usage,
1092 };
1093 nc = register_command(cmd_ctx, parent, &cr);
1094 if (NULL == nc) {
1095 LOG_ERROR("failed to add '%s' help text", cmd_name);
1096 return ERROR_FAIL;
1097 }
1098 LOG_DEBUG("added '%s' help text", cmd_name);
1099 return ERROR_OK;
1100 }
1101 if (help_text) {
1102 bool replaced = false;
1103 if (nc->help) {
1104 free((void *)nc->help);
1105 replaced = true;
1106 }
1107 nc->help = strdup(help_text);
1108 if (replaced)
1109 LOG_INFO("replaced existing '%s' help", cmd_name);
1110 else
1111 LOG_DEBUG("added '%s' help text", cmd_name);
1112 }
1113 if (usage) {
1114 bool replaced = false;
1115 if (nc->usage) {
1116 free((void *)nc->usage);
1117 replaced = true;
1118 }
1119 nc->usage = strdup(usage);
1120 if (replaced)
1121 LOG_INFO("replaced existing '%s' usage", cmd_name);
1122 else
1123 LOG_DEBUG("added '%s' usage text", cmd_name);
1124 }
1125 return ERROR_OK;
1126 }
1127
1128 COMMAND_HANDLER(handle_help_add_command)
1129 {
1130 if (CMD_ARGC < 2) {
1131 LOG_ERROR("%s: insufficient arguments", CMD_NAME);
1132 return ERROR_COMMAND_SYNTAX_ERROR;
1133 }
1134
1135 /* save help text and remove it from argument list */
1136 const char *str = CMD_ARGV[--CMD_ARGC];
1137 const char *help = !strcmp(CMD_NAME, "add_help_text") ? str : NULL;
1138 const char *usage = !strcmp(CMD_NAME, "add_usage_text") ? str : NULL;
1139 if (!help && !usage) {
1140 LOG_ERROR("command name '%s' is unknown", CMD_NAME);
1141 return ERROR_COMMAND_SYNTAX_ERROR;
1142 }
1143 /* likewise for the leaf command name */
1144 const char *cmd_name = CMD_ARGV[--CMD_ARGC];
1145
1146 struct command *c = NULL;
1147 if (CMD_ARGC > 0) {
1148 c = CMD_CTX->commands;
1149 int retval = CALL_COMMAND_HANDLER(command_help_find, c, &c);
1150 if (ERROR_OK != retval)
1151 return retval;
1152 }
1153 return help_add_command(CMD_CTX, c, cmd_name, help, usage);
1154 }
1155
1156 /* sleep command sleeps for <n> milliseconds
1157 * this is useful in target startup scripts
1158 */
1159 COMMAND_HANDLER(handle_sleep_command)
1160 {
1161 bool busy = false;
1162 if (CMD_ARGC == 2) {
1163 if (strcmp(CMD_ARGV[1], "busy") == 0)
1164 busy = true;
1165 else
1166 return ERROR_COMMAND_SYNTAX_ERROR;
1167 } else if (CMD_ARGC < 1 || CMD_ARGC > 2)
1168 return ERROR_COMMAND_SYNTAX_ERROR;
1169
1170 unsigned long duration = 0;
1171 int retval = parse_ulong(CMD_ARGV[0], &duration);
1172 if (ERROR_OK != retval)
1173 return retval;
1174
1175 if (!busy) {
1176 long long then = timeval_ms();
1177 while (timeval_ms() - then < (long long)duration) {
1178 target_call_timer_callbacks_now();
1179 usleep(1000);
1180 }
1181 } else
1182 busy_sleep(duration);
1183
1184 return ERROR_OK;
1185 }
1186
1187 static const struct command_registration command_subcommand_handlers[] = {
1188 {
1189 .name = "mode",
1190 .mode = COMMAND_ANY,
1191 .jim_handler = jim_command_mode,
1192 .usage = "[command_name ...]",
1193 .help = "Returns the command modes allowed by a command:"
1194 "'any', 'config', or 'exec'. If no command is"
1195 "specified, returns the current command mode. "
1196 "Returns 'unknown' if an unknown command is given. "
1197 "Command can be multiple tokens.",
1198 },
1199 {
1200 .name = "type",
1201 .mode = COMMAND_ANY,
1202 .jim_handler = jim_command_type,
1203 .usage = "command_name [...]",
1204 .help = "Returns the type of built-in command:"
1205 "'native', 'simple', 'group', or 'unknown'. "
1206 "Command can be multiple tokens.",
1207 },
1208 COMMAND_REGISTRATION_DONE
1209 };
1210
1211 static const struct command_registration command_builtin_handlers[] = {
1212 {
1213 .name = "echo",
1214 .handler = jim_echo,
1215 .mode = COMMAND_ANY,
1216 .help = "Logs a message at \"user\" priority. "
1217 "Output message to stdout. "
1218 "Option \"-n\" suppresses trailing newline",
1219 .usage = "[-n] string",
1220 },
1221 {
1222 .name = "add_help_text",
1223 .handler = handle_help_add_command,
1224 .mode = COMMAND_ANY,
1225 .help = "Add new command help text; "
1226 "Command can be multiple tokens.",
1227 .usage = "command_name helptext_string",
1228 },
1229 {
1230 .name = "add_usage_text",
1231 .handler = handle_help_add_command,
1232 .mode = COMMAND_ANY,
1233 .help = "Add new command usage text; "
1234 "command can be multiple tokens.",
1235 .usage = "command_name usage_string",
1236 },
1237 {
1238 .name = "sleep",
1239 .handler = handle_sleep_command,
1240 .mode = COMMAND_ANY,
1241 .help = "Sleep for specified number of milliseconds. "
1242 "\"busy\" will busy wait instead (avoid this).",
1243 .usage = "milliseconds ['busy']",
1244 },
1245 {
1246 .name = "help",
1247 .handler = handle_help_command,
1248 .mode = COMMAND_ANY,
1249 .help = "Show full command help; "
1250 "command can be multiple tokens.",
1251 .usage = "[command_name]",
1252 },
1253 {
1254 .name = "usage",
1255 .handler = handle_help_command,
1256 .mode = COMMAND_ANY,
1257 .help = "Show basic command usage; "
1258 "command can be multiple tokens.",
1259 .usage = "[command_name]",
1260 },
1261 {
1262 .name = "command",
1263 .mode = COMMAND_ANY,
1264 .help = "core command group (introspection)",
1265 .chain = command_subcommand_handlers,
1266 },
1267 COMMAND_REGISTRATION_DONE
1268 };
1269
1270 struct command_context *command_init(const char *startup_tcl, Jim_Interp *interp)
1271 {
1272 struct command_context *context = malloc(sizeof(struct command_context));
1273 const char *HostOs;
1274
1275 context->mode = COMMAND_EXEC;
1276 context->commands = NULL;
1277 context->current_target = 0;
1278 context->output_handler = NULL;
1279 context->output_handler_priv = NULL;
1280
1281 /* Create a jim interpreter if we were not handed one */
1282 if (interp == NULL) {
1283 /* Create an interpreter */
1284 interp = Jim_CreateInterp();
1285 /* Add all the Jim core commands */
1286 Jim_RegisterCoreCommands(interp);
1287 Jim_InitStaticExtensions(interp);
1288 }
1289
1290 context->interp = interp;
1291
1292 /* Stick to lowercase for HostOS strings. */
1293 #if defined(_MSC_VER)
1294 /* WinXX - is generic, the forward
1295 * looking problem is this:
1296 *
1297 * "win32" or "win64"
1298 *
1299 * "winxx" is generic.
1300 */
1301 HostOs = "winxx";
1302 #elif defined(__linux__)
1303 HostOs = "linux";
1304 #elif defined(__APPLE__) || defined(__DARWIN__)
1305 HostOs = "darwin";
1306 #elif defined(__CYGWIN__)
1307 HostOs = "cygwin";
1308 #elif defined(__MINGW32__)
1309 HostOs = "mingw32";
1310 #elif defined(__ECOS)
1311 HostOs = "ecos";
1312 #elif defined(__FreeBSD__)
1313 HostOs = "freebsd";
1314 #elif defined(__OpenBSD__)
1315 HostOs = "openbsd";
1316 #else
1317 #warning "Unrecognized host OS..."
1318 HostOs = "other";
1319 #endif
1320 Jim_SetGlobalVariableStr(interp, "ocd_HOSTOS",
1321 Jim_NewStringObj(interp, HostOs, strlen(HostOs)));
1322
1323 Jim_CreateCommand(interp, "ocd_find", jim_find, NULL, NULL);
1324 Jim_CreateCommand(interp, "capture", jim_capture, NULL, NULL);
1325
1326 register_commands(context, NULL, command_builtin_handlers);
1327
1328 Jim_SetAssocData(interp, "context", NULL, context);
1329 if (Jim_Eval_Named(interp, startup_tcl, "embedded:startup.tcl", 1) == JIM_ERR) {
1330 LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD)");
1331 Jim_MakeErrorMessage(interp);
1332 LOG_USER_N("%s", Jim_GetString(Jim_GetResult(interp), NULL));
1333 exit(-1);
1334 }
1335 Jim_DeleteAssocData(interp, "context");
1336
1337 return context;
1338 }
1339
1340 int command_context_mode(struct command_context *cmd_ctx, enum command_mode mode)
1341 {
1342 if (!cmd_ctx)
1343 return ERROR_COMMAND_SYNTAX_ERROR;
1344
1345 cmd_ctx->mode = mode;
1346 return ERROR_OK;
1347 }
1348
1349 void process_jim_events(struct command_context *cmd_ctx)
1350 {
1351 static int recursion;
1352 if (recursion)
1353 return;
1354
1355 recursion++;
1356 Jim_ProcessEvents(cmd_ctx->interp, JIM_ALL_EVENTS | JIM_DONT_WAIT);
1357 recursion--;
1358 }
1359
1360 #define DEFINE_PARSE_NUM_TYPE(name, type, func, min, max) \
1361 int parse ## name(const char *str, type * ul) \
1362 { \
1363 if (!*str) { \
1364 LOG_ERROR("Invalid command argument"); \
1365 return ERROR_COMMAND_ARGUMENT_INVALID; \
1366 } \
1367 char *end; \
1368 *ul = func(str, &end, 0); \
1369 if (*end) { \
1370 LOG_ERROR("Invalid command argument"); \
1371 return ERROR_COMMAND_ARGUMENT_INVALID; \
1372 } \
1373 if ((max == *ul) && (ERANGE == errno)) { \
1374 LOG_ERROR("Argument overflow"); \
1375 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1376 } \
1377 if (min && (min == *ul) && (ERANGE == errno)) { \
1378 LOG_ERROR("Argument underflow"); \
1379 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1380 } \
1381 return ERROR_OK; \
1382 }
1383 DEFINE_PARSE_NUM_TYPE(_ulong, unsigned long, strtoul, 0, ULONG_MAX)
1384 DEFINE_PARSE_NUM_TYPE(_ullong, unsigned long long, strtoull, 0, ULLONG_MAX)
1385 DEFINE_PARSE_NUM_TYPE(_long, long, strtol, LONG_MIN, LONG_MAX)
1386 DEFINE_PARSE_NUM_TYPE(_llong, long long, strtoll, LLONG_MIN, LLONG_MAX)
1387
1388 #define DEFINE_PARSE_WRAPPER(name, type, min, max, functype, funcname) \
1389 int parse ## name(const char *str, type * ul) \
1390 { \
1391 functype n; \
1392 int retval = parse ## funcname(str, &n); \
1393 if (ERROR_OK != retval) \
1394 return retval; \
1395 if (n > max) \
1396 return ERROR_COMMAND_ARGUMENT_OVERFLOW; \
1397 if (min) \
1398 return ERROR_COMMAND_ARGUMENT_UNDERFLOW; \
1399 *ul = n; \
1400 return ERROR_OK; \
1401 }
1402
1403 #define DEFINE_PARSE_ULONG(name, type, min, max) \
1404 DEFINE_PARSE_WRAPPER(name, type, min, max, unsigned long, _ulong)
1405 DEFINE_PARSE_ULONG(_uint, unsigned, 0, UINT_MAX)
1406 DEFINE_PARSE_ULONG(_u32, uint32_t, 0, UINT32_MAX)
1407 DEFINE_PARSE_ULONG(_u16, uint16_t, 0, UINT16_MAX)
1408 DEFINE_PARSE_ULONG(_u8, uint8_t, 0, UINT8_MAX)
1409
1410 #define DEFINE_PARSE_LONG(name, type, min, max) \
1411 DEFINE_PARSE_WRAPPER(name, type, min, max, long, _long)
1412 DEFINE_PARSE_LONG(_int, int, n < INT_MIN, INT_MAX)
1413 DEFINE_PARSE_LONG(_s32, int32_t, n < INT32_MIN, INT32_MAX)
1414 DEFINE_PARSE_LONG(_s16, int16_t, n < INT16_MIN, INT16_MAX)
1415 DEFINE_PARSE_LONG(_s8, int8_t, n < INT8_MIN, INT8_MAX)
1416
1417 static int command_parse_bool(const char *in, bool *out,
1418 const char *on, const char *off)
1419 {
1420 if (strcasecmp(in, on) == 0)
1421 *out = true;
1422 else if (strcasecmp(in, off) == 0)
1423 *out = false;
1424 else
1425 return ERROR_COMMAND_SYNTAX_ERROR;
1426 return ERROR_OK;
1427 }
1428
1429 int command_parse_bool_arg(const char *in, bool *out)
1430 {
1431 if (command_parse_bool(in, out, "on", "off") == ERROR_OK)
1432 return ERROR_OK;
1433 if (command_parse_bool(in, out, "enable", "disable") == ERROR_OK)
1434 return ERROR_OK;
1435 if (command_parse_bool(in, out, "true", "false") == ERROR_OK)
1436 return ERROR_OK;
1437 if (command_parse_bool(in, out, "yes", "no") == ERROR_OK)
1438 return ERROR_OK;
1439 if (command_parse_bool(in, out, "1", "0") == ERROR_OK)
1440 return ERROR_OK;
1441 return ERROR_COMMAND_SYNTAX_ERROR;
1442 }
1443
1444 COMMAND_HELPER(handle_command_parse_bool, bool *out, const char *label)
1445 {
1446 switch (CMD_ARGC) {
1447 case 1: {
1448 const char *in = CMD_ARGV[0];
1449 if (command_parse_bool_arg(in, out) != ERROR_OK) {
1450 LOG_ERROR("%s: argument '%s' is not valid", CMD_NAME, in);
1451 return ERROR_COMMAND_SYNTAX_ERROR;
1452 }
1453 /* fall through */
1454 }
1455 case 0:
1456 LOG_INFO("%s is %s", label, *out ? "enabled" : "disabled");
1457 break;
1458 default:
1459 return ERROR_COMMAND_SYNTAX_ERROR;
1460 }
1461 return ERROR_OK;
1462 }