]> cloudbase.mooo.com Git - z180-stamp.git/blame - avr/command.c
Enable monitor debugging commands only, if env var 'cmd' is set to 'debug'.
[z180-stamp.git] / avr / command.c
CommitLineData
35edb766 1/*
ccb6ffb9 2 * (C) Copyright 2014, 2016 Leo C. <erbl259-lmu@yahoo.de>
35edb766
L
3 *
4 * (C) Copyright 2000-2009
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
6 *
ccb6ffb9 7 * SPDX-License-Identifier: GPL-2.0
35edb766
L
8 */
9
d684c216
L
10/*
11 * Command Processor Table
12 */
13
14#include "common.h"
8f23e84c 15#include <stdlib.h>
d684c216
L
16#include <string.h>
17#include <ctype.h>
d684c216
L
18
19#include "config.h"
8f23e84c 20#include "print-utils.h"
d684c216
L
21#include "con-utils.h"
22#include "env.h"
8f23e84c 23#include "debug.h"
d684c216
L
24#include "command.h"
25
26
deb08cb6
L
27static void print_usage_line(const FLASH char *name, int width,
28 const FLASH char *usage)
d684c216 29{
deb08cb6
L
30 width -= strlen_P(name);
31 if (width < 0)
32 width = 0;
d684c216 33 my_puts_P(name);
deb08cb6 34 print_blanks(width);
d684c216
L
35 my_puts_P(PSTR(" - "));
36 my_puts_P(usage);
37 my_puts_P(PSTR("\n"));
38}
39
40int strcmp_PP(const FLASH char *s1, const FLASH char *s2)
41{
42 unsigned char c1, c2;
43
c79c80b4 44 while ((c1 = *(const FLASH unsigned char *)s1++)
d684c216
L
45 == (c2 = *(const FLASH unsigned char *)s2++))
46 if (c1 == 0)
47 return 0;
48
49 return c1 - c2;
50}
51
c79c80b4 52int cmpstring_PP(const void *p1, const void *p2)
d684c216 53{
c79c80b4 54 return strcmp_PP((*(const FLASH cmd_tbl_t **) p1)->name,
d684c216
L
55 (*(const FLASH cmd_tbl_t **) p2)->name);
56}
57
58int cmd_tbl_item_count(void)
59{
60 cmd_tbl_t * p = cmd_tbl;
61 int count = 0;
62
63 while (p->name != NULL) {
64 p++; count++;
65 }
66 return count;
67}
68
69/*
70 * Use puts() instead of printf() to avoid printf buffer overflow
71 * for long help messages
72 */
73
d0581f88 74command_ret_t _do_help(cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp,
d684c216
L
75 int flag, int argc, char * const argv[])
76{
deb08cb6 77 uint_fast8_t i, max_len = 0;
d0581f88 78 command_ret_t rcode = CMD_RET_SUCCESS;
d684c216
L
79
80 (void) flag;
81
ccb6ffb9
L
82 char *optenv = getenv_str(PSTR("cmd"));
83 bool opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
84
d684c216
L
85 if (argc == 1) { /*show list of commands */
86 cmd_tbl_t *cmd_array[cmd_items];
87 int i;
88
89 /* Make array of commands from .uboot_cmd section */
90 cmdtp = cmd_start;
91 for (i = 0; i < cmd_items; i++) {
92 cmd_array[i] = cmdtp++;
deb08cb6
L
93 uint_fast8_t l = strlen_P(cmd_array[i]->name);
94 if (l > max_len)
95 max_len = l;
d684c216
L
96 }
97
98 /* Sort command list */
c79c80b4 99 qsort(cmd_array, cmd_items, sizeof (cmd_tbl_t *), cmpstring_PP);
d684c216
L
100
101 /* print short help (usage) */
102 for (i = 0; i < cmd_items; i++) {
ccb6ffb9
L
103 if (opt_debug || cmd_array[i]->name[0] != '!') {
104 const FLASH char *usage = cmd_array[i]->usage;
105
106 /* allow user abort */
107 if (ctrlc ())
108 return CMD_RET_FAILURE;
109 if (usage == NULL)
110 continue;
c79c80b4 111#ifdef GCC_BUG_61443
ccb6ffb9 112 print_usage_line(cmd_array[i]->name, max_len, usage);
d684c216 113#else
ccb6ffb9
L
114 printf_P(PSTR("%-" stringify(8) /*FIXME*/ "S - %S\n"),
115 cmd_array[i]->name, usage);
d684c216 116#endif
ccb6ffb9 117 }
d684c216 118 }
d0581f88 119 return CMD_RET_SUCCESS;
d684c216
L
120 }
121 /*
122 * command help (long version)
123 */
124 for (i = 1; i < argc; ++i) {
ccb6ffb9
L
125 if ((cmdtp = find_cmd_tbl (argv[i], cmd_start, cmd_items )) != NULL &&
126 (opt_debug || cmdtp->name[0] != '!')) {
3f858d9f 127 cmd_usage(cmdtp);
d684c216
L
128 } else {
129 printf_P(PSTR("Unknown command '%s' - try 'help'"
130 " without arguments.\n\n"), argv[i]
131 );
d0581f88 132 rcode = CMD_RET_FAILURE;
d684c216
L
133 }
134 }
135 return rcode;
136}
137
138/***************************************************************************
139 * find command table entry for a command
140 */
141cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len)
142{
143 cmd_tbl_t *cmdtp;
144 cmd_tbl_t *cmdtp_temp = table; /*Init value */
323398b1 145 size_t len;
d684c216
L
146 uint_fast8_t n_found = 0;
147
ccb6ffb9
L
148 char *optenv = getenv_str(PSTR("cmd"));
149 bool opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
150
d684c216
L
151 if (!cmd)
152 return NULL;
153
154 len = strlen(cmd);
155
156 for (cmdtp = table;
157 cmdtp != table + table_len;
158 cmdtp++) {
ccb6ffb9
L
159 if (strncmp_P(cmd, cmdtp->name, len) == 0 &&
160 (opt_debug || cmdtp->name[0] != '!')) {
5480dc65 161 if (len == strlen_P(cmdtp->name))
d684c216
L
162 return cmdtp; /* full match */
163
164 cmdtp_temp = cmdtp; /* abbreviated command ? */
165 n_found++;
166 }
167 }
ccb6ffb9 168 if (n_found == 1) /* exactly one match */
d684c216 169 return cmdtp_temp;
d684c216
L
170
171 return NULL; /* not found or ambiguous command */
172}
173
174
175cmd_tbl_t *find_cmd (const char *cmd)
176{
177 return find_cmd_tbl(cmd, cmd_tbl, cmd_tbl_item_count());
178}
179
180
d0581f88 181command_ret_t cmd_usage(const FLASH cmd_tbl_t *cmdtp)
d684c216
L
182{
183// printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
deb08cb6 184 print_usage_line(cmdtp->name, 0, cmdtp->usage);
d684c216
L
185#if 0
186 my_puts_P(cmdtp->name);
deb08cb6 187 print_blanks(/*FIXME*/ 8 - strlen_P(cmdtp->name));
d684c216
L
188 my_puts_P(PSTR(" - "));
189 my_puts_P(cmdtp->usage);
190 my_puts_P(PSTR("\n\n"));
191#endif
192#ifdef CONFIG_SYS_LONGHELP
193// printf("Usage:\n%s ", cmdtp->name);
194 my_puts_P(PSTR("Usage:\n"));
195 my_puts_P(cmdtp->name);
f338df2a 196 my_puts_P(PSTR(" "));
d684c216
L
197
198 if (!cmdtp->help) {
199 my_puts_P(PSTR(" - No additional help available.\n"));
d0581f88 200 return CMD_RET_FAILURE;
d684c216
L
201 }
202
203 my_puts_P(cmdtp->help);
204 my_puts_P(PSTR("\n"));
205#endif /* CONFIG_SYS_LONGHELP */
d0581f88 206 return CMD_RET_FAILURE;
d684c216
L
207}
208
209#ifdef CONFIG_AUTO_COMPLETE
210
211int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
212{
dea9a315 213 static char tmp_buf[CONFIG_SYS_CBSIZE];
d684c216
L
214 int space;
215
216 space = last_char == '\0' || isblank(last_char);
217
218 if (space && argc == 1)
219 return env_complete("", maxv, cmdv, sizeof(tmp_buf), tmp_buf);
220
221 if (!space && argc == 2)
222 return env_complete(argv[1], maxv, cmdv, sizeof(tmp_buf), tmp_buf);
223
224 return 0;
225}
226
227/*************************************************************************************/
228
dea9a315
L
229/* TODO: cmdtp points to FLASH */
230
d684c216
L
231static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
232{
233 cmd_tbl_t *cmdtp = cmd_tbl;
234// const int count = ARRAY_SIZE(cmd_tbl);
235// const cmd_tbl_t *cmdend = cmdtp + count;
236// const char *p;
237 int len, clen;
238 int n_found = 0;
239 const char *cmd;
240
241 /* sanity? */
242 if (maxv < 2)
243 return -2;
244
245 cmdv[0] = NULL;
246
247 if (argc == 0) {
248 /* output full list of commands */
249 for (; cmdtp->name[0] != '\0'; cmdtp++) {
250 if (n_found >= maxv - 2) {
251 cmdv[n_found++] = "...";
252 break;
253 }
254 cmdv[n_found++] = cmdtp->name;
255 }
256 cmdv[n_found] = NULL;
257 return n_found;
258 }
259
260 /* more than one arg or one but the start of the next */
261 if (argc > 1 || (last_char == '\0' || isblank(last_char))) {
262 cmdtp = find_cmd(argv[0]);
263 if (cmdtp == NULL || cmdtp->complete == NULL) {
264 cmdv[0] = NULL;
265 return 0;
266 }
267 return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
268 }
269
270 cmd = argv[0];
271
272 len = strlen(cmd);
273
274 /* return the partial matches */
275 for (; cmdtp->name[0] != '\0'; cmdtp++) {
276
277 clen = strlen(cmdtp->name);
278 if (clen < len)
279 continue;
280
281 if (memcmp(cmd, cmdtp->name, len) != 0)
282 continue;
283
284 /* too many! */
285 if (n_found >= maxv - 2) {
286 cmdv[n_found++] = "...";
287 break;
288 }
289
290 cmdv[n_found++] = cmdtp->name;
291 }
292
293 cmdv[n_found] = NULL;
294 return n_found;
295}
296
297static int make_argv(char *s, int argvsz, char *argv[])
298{
299 int argc = 0;
300
301 /* split into argv */
302 while (argc < argvsz - 1) {
303
304 /* skip any white space */
305 while (isblank(*s))
306 ++s;
307
308 if (*s == '\0') /* end of s, no more args */
309 break;
310
311 argv[argc++] = s; /* begin of argument string */
312
313 /* find end of string */
314 while (*s && !isblank(*s))
315 ++s;
316
317 if (*s == '\0') /* end of s, no more args */
318 break;
319
320 *s++ = '\0'; /* terminate current arg */
321 }
322 argv[argc] = NULL;
323
324 return argc;
325}
326
327static void print_argv(const char *banner, const char *leader, const char *sep, int linemax, char * const argv[])
328{
329 int ll = leader != NULL ? strlen(leader) : 0;
330 int sl = sep != NULL ? strlen(sep) : 0;
331 int len, i;
332
333 if (banner) {
334 my_puts_P(PSTR("\n"));
335 my_puts(banner);
336 }
337
338 i = linemax; /* force leader and newline */
339 while (*argv != NULL) {
340 len = strlen(*argv) + sl;
341 if (i + len >= linemax) {
342 my_puts_P(PSTR("\n"));
343 if (leader)
344 my_puts(leader);
345 i = ll - sl;
346 } else if (sep)
347 my_puts(sep);
348 my_puts(*argv++);
349 i += len;
350 }
351 my_puts_P(PSTR("\n"));
352}
353
354static int find_common_prefix(char * const argv[])
355{
356 int i, len;
357 char *anchor, *s, *t;
358
359 if (*argv == NULL)
360 return 0;
361
362 /* begin with max */
363 anchor = *argv++;
364 len = strlen(anchor);
365 while ((t = *argv++) != NULL) {
366 s = anchor;
367 for (i = 0; i < len; i++, t++, s++) {
368 if (*t != *s)
369 break;
370 }
371 len = s - anchor;
372 }
373 return len;
374}
375
376static char tmp_buf[CONFIG_SYS_CBSIZE]; /* copy of console I/O buffer */
377
dea9a315 378
d684c216
L
379int cmd_auto_complete(const FLASH char *const prompt, char *buf, int *np, int *colp)
380{
381 int n = *np, col = *colp;
382 char *argv[CONFIG_SYS_MAXARGS + 1]; /* NULL terminated */
383 char *cmdv[20];
384 char *s, *t;
385 const char *sep;
386 int i, j, k, len, seplen, argc;
387 int cnt;
388 char last_char;
389
390 if (strcmp_PP(prompt, CONFIG_SYS_PROMPT) != 0)
391 return 0; /* not in normal console */
392
393 cnt = strlen(buf);
394 if (cnt >= 1)
395 last_char = buf[cnt - 1];
396 else
397 last_char = '\0';
398
399 /* copy to secondary buffer which will be affected */
400 strcpy(tmp_buf, buf);
401
402 /* separate into argv */
403 argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
404
405 /* do the completion and return the possible completions */
406 i = complete_cmdv(argc, argv, last_char, sizeof(cmdv)/sizeof(cmdv[0]), cmdv);
407
408 /* no match; bell and out */
409 if (i == 0) {
410 if (argc > 1) /* allow tab for non command */
411 return 0;
412 putchar('\a');
413 return 1;
414 }
415
416 s = NULL;
417 len = 0;
418 sep = NULL;
419 seplen = 0;
420 if (i == 1) { /* one match; perfect */
421 k = strlen(argv[argc - 1]);
422 s = cmdv[0] + k;
423 len = strlen(s);
424 sep = " ";
425 seplen = 1;
426 } else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
427 k = strlen(argv[argc - 1]);
428 j -= k;
429 if (j > 0) {
430 s = cmdv[0] + k;
431 len = j;
432 }
433 }
434
435 if (s != NULL) {
436 k = len + seplen;
437 /* make sure it fits */
438 if (n + k >= CONFIG_SYS_CBSIZE - 2) {
439 putchar('\a');
440 return 1;
441 }
442
443 t = buf + cnt;
444 for (i = 0; i < len; i++)
445 *t++ = *s++;
446 if (sep != NULL)
447 for (i = 0; i < seplen; i++)
448 *t++ = sep[i];
449 *t = '\0';
450 n += k;
451 col += k;
452 my_puts(t - k);
453 if (sep == NULL)
454 putchar('\a');
455 *np = n;
456 *colp = col;
457 } else {
458 print_argv(NULL, " ", " ", 78, cmdv);
459
460 my_puts_P(prompt);
461 my_puts(buf);
462 }
463 return 1;
464}
465
466#endif /* CONFIG_AUTO_COMPLETE */
467
468
469
470/**
471 * Call a command function. This should be the only route in U-Boot to call
472 * a command, so that we can track whether we are waiting for input or
473 * executing a command.
474 *
475 * @param cmdtp Pointer to the command to execute
476 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
477 * @param argc Number of arguments (arg 0 must be the command text)
478 * @param argv Arguments
479 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
480 */
d0581f88 481command_ret_t cmd_call(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
d684c216 482{
d0581f88 483 command_ret_t result;
d684c216
L
484
485 result = (cmdtp->cmd)(cmdtp, flag, argc, argv);
13e88ed5
L
486// if (result != CMD_RET_SUCCESS)
487// debug("Command failed, result=%d\n", result);
d684c216
L
488 return result;
489}
490
d0581f88 491command_ret_t cmd_process(int flag, int argc, char * const argv[],
d684c216
L
492 uint_fast8_t *repeatable)
493{
d0581f88 494 command_ret_t rc = CMD_RET_SUCCESS;
d684c216
L
495 cmd_tbl_t *cmdtp;
496
497 /* Look up command in command table */
498 cmdtp = find_cmd(argv[0]);
499 if (cmdtp == NULL) {
500 printf_P(PSTR("Unknown command '%s' - try 'help'\n"), argv[0]);
d0581f88 501 return CMD_RET_FAILURE;
d684c216
L
502 }
503 if (!cmdtp->cmd) {
504 debug("### Command '%s' found, but ->cmd == NULL \n", argv[0]);
d0581f88 505 return CMD_RET_FAILURE;
d684c216
L
506 }
507
508 /* found - check max args */
509 if (argc > cmdtp->maxargs)
510 rc = CMD_RET_USAGE;
511
512#if defined(CONFIG_CMD_BOOTD)
513 /* avoid "bootd" recursion */
514 else if (cmdtp->cmd == do_bootd) {
515 if (flag & CMD_FLAG_BOOTD) {
516 my_puts_P(PSTR("'bootd' recursion detected\n"));
517 rc = CMD_RET_FAILURE;
518 } else {
519 flag |= CMD_FLAG_BOOTD;
520 }
521 }
522#endif
523
524 /* If OK so far, then do the command */
525 if (!rc) {
526 rc = cmd_call(cmdtp, flag, argc, argv);
527 *repeatable &= cmdtp->repeatable;
528 }
529 if (rc == CMD_RET_USAGE)
530 rc = cmd_usage(cmdtp);
531 return rc;
532}
533
534int cmd_process_error(cmd_tbl_t *cmdtp, int err)
535{
536 char buf[strlen_P(cmdtp->name) + 1];
537 strcpy_P(buf, cmdtp->name);
538
539 if (err) {
540 printf_P(PSTR("Command '%s' failed: Error %d\n"), buf, err);
541 return 1;
542 }
543
544 return 0;
545}