]>
cloudbase.mooo.com Git - z180-stamp.git/blob - avr/command.c
8a4ca02886706005b3aa8b672cb402c7a16d597f
2 * (C) Copyright 2014, 2016, 2018 Leo C. <erbl259-lmu@yahoo.de>
4 * (C) Copyright 2000-2009
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * SPDX-License-Identifier: GPL-2.0
11 * Command Processor Table
19 #include "print-utils.h"
20 #include "con-utils.h"
23 #include "getopt-min.h"
26 #define DEBUG_CMD 0 /* set to 1 to debug */
28 #define debug_cmd(fmt, args...) \
29 debug_cond(DEBUG_CMD, fmt, ##args)
34 char *strcasestr_P2(const FLASH
char *haystack
, const char *needle
)
36 int nlen
= strlen(needle
);
37 int hlen
= strlen_P(haystack
) - nlen
+ 1;
40 for (i
= 0; i
< hlen
; i
++) {
42 for (j
= 0; j
< nlen
; j
++) {
43 unsigned char c1
= haystack
[i
+j
];
44 unsigned char c2
= needle
[j
];
45 if (toupper(c1
) != toupper(c2
))
48 return (char *) haystack
+ i
;
57 static int cmd_tbl_item_count(cmd_tbl_t
*p
)
61 while (p
->name
!= NULL
) {
63 cmd_tbl_t
*sub
= p
->subcmd
;
64 while (sub
->name
!= NULL
) {
65 if (sub
->flags
& CTBL_SUBCMDAUTO
)
70 if ((p
->flags
& CTBL_SUBCMDAUTO
) == 0)
78 static cmd_tbl_t
*get_cmd_tbl_base(cmd_tbl_t
*cmdtp
)
82 while (p
->name
!= NULL
)
88 static cmd_tbl_t
*get_cmd_tbl_parent(cmd_tbl_t
*child
)
90 if ((child
->flags
& CTBL_SUBCMDAUTO
) == 0) {
92 cmd_tbl_t
*tbl_start
= get_cmd_tbl_base(child
);
93 if (tbl_start
!= cmd_tbl
) {
94 cmd_tbl_t
*top
= cmd_tbl
;
95 while (top
->subcmd
!= tbl_start
)
103 static int print_nameprefix(cmd_tbl_t
*p
)
105 cmd_tbl_t
*top
= get_cmd_tbl_parent(p
);
109 width
= printf_P(PSTR("%S "), top
->name
);
115 static int print_prefixed_name(cmd_tbl_t
*p
)
119 len
= print_nameprefix(p
);
120 len
+= strlen_P(p
->name
);
126 static void print_usage_line(cmd_tbl_t
*p
, int width
)
128 width
-= print_prefixed_name(p
);
132 my_puts_P(PSTR(" - "));
137 static int strcmp_PP(const FLASH
char *s1
, const FLASH
char *s2
)
139 unsigned char c1
, c2
;
141 while ((c1
= *(const FLASH
unsigned char *)s1
++)
142 == (c2
= *(const FLASH
unsigned char *)s2
++))
151 static int cmpstring_PP(const void *p1
, const void *p2
)
153 char s1
[21] = {'\0'};
154 char s2
[21] = {'\0'};
155 cmd_tbl_t
*cp1
= *(cmd_tbl_t
**) p1
;
156 cmd_tbl_t
*cp2
= *(cmd_tbl_t
**) p2
;
157 cmd_tbl_t
*top1
= get_cmd_tbl_parent(*(cmd_tbl_t
**) p1
);
158 cmd_tbl_t
*top2
= get_cmd_tbl_parent(*(cmd_tbl_t
**) p2
);
161 strlcpy_P(s1
, top1
->name
, 21);
163 strlcpy_P(s2
, top2
->name
, 21);
165 strlcat_P(s1
, cp1
->name
, 21);
166 strlcat_P(s2
, cp2
->name
, 21);
168 return strcmp(s1
, s2
);
171 static int cmpstring_PP(const void *p1
, const void *p2
)
173 cmd_tbl_t
*cp1
= *(cmd_tbl_t
**) p1
;
174 cmd_tbl_t
*cp2
= *(cmd_tbl_t
**) p2
;
175 cmd_tbl_t
*top1
= get_cmd_tbl_parent(*(cmd_tbl_t
**) p1
);
176 cmd_tbl_t
*top2
= get_cmd_tbl_parent(*(cmd_tbl_t
**) p2
);
180 res
= strcmp_PP(top1
->name
, top2
->name
);
182 res
= strcmp_PP(cp1
->name
, cp2
->name
);
186 res
= strcmp_PP(top1
->name
, cp2
->name
);
188 res
= strcmp_PP(cp1
->name
, cp2
->name
);
192 res
= strcmp_PP(cp1
->name
, top2
->name
);
194 res
= strcmp_PP(cp1
->name
, cp2
->name
);
197 return strcmp_PP(cp1
->name
, cp2
->name
);
201 /****************************************************************************/
204 * find command table entry for a command
207 static cmd_tbl_t
*find_cmd (const char *cmd
, cmd_tbl_t
*table
)
212 char *optenv
= getenv_str(PSTR("cmd"));
213 uint8_t opt_debug
= optenv
&& strstr_P(optenv
, PSTR("debug")) != NULL
;
215 cmd_tbl_t
*cmdtp_ret
= NULL
;
216 uint_fast8_t n_found
= 0;
217 uint_fast8_t len
= strlen(cmd
);
219 for (cmd_tbl_t
*cmdtp
= table
; cmdtp
->name
!= NULL
; cmdtp
++) {
221 for (cmd_tbl_t
*sub
= cmdtp
->subcmd
; sub
->name
!= NULL
; sub
++) {
222 if (sub
->flags
& CTBL_SUBCMDAUTO
&&
223 strncmp_P(cmd
, sub
->name
, len
) == 0 &&
224 (opt_debug
|| !(sub
->flags
& CTBL_DBG
))) {
225 if (len
== strlen_P(sub
->name
))
226 return sub
; /* full match */
227 cmdtp_ret
= sub
; /* abbreviated command ? */
232 if ((cmdtp
->flags
& CTBL_SUBCMDAUTO
) == 0 &&
233 strncmp_P(cmd
, cmdtp
->name
, len
) == 0 &&
234 (opt_debug
|| !(cmdtp
->flags
& CTBL_DBG
))) {
235 if (len
== strlen_P(cmdtp
->name
))
236 return cmdtp
; /* full match */
237 cmdtp_ret
= cmdtp
; /* abbreviated command ? */
243 return cmdtp_ret
; /* exactly one match */
245 return NULL
; /* not found or ambiguous command */
249 * Use puts() instead of printf() to avoid printf buffer overflow
250 * for long help messages
253 command_ret_t
do_help(cmd_tbl_t
*cmdtp
, uint_fast8_t flag UNUSED
, int argc
, char * const argv
[])
255 cmd_tbl_t
*tbl_start
= get_cmd_tbl_base(cmdtp
);
256 command_ret_t res
= CMD_RET_SUCCESS
;
257 uint_fast8_t options
= 0;
258 #define OPT_DBG_CMDS 0x01
260 #define OPT_NAME 0x04
261 #define OPT_USAGE 0x08
262 #define OPT_LONG 0x10
265 while ((opt
= getopt(argc
, argv
, PSTR("afk"))) != -1) {
271 options
|= OPT_NAME
| OPT_ALL
;
274 options
|= OPT_USAGE
| OPT_ALL
;
277 return CMD_RET_USAGE
;
281 /* remaining arguments */
285 if ((options
& (OPT_USAGE
|OPT_NAME
)) == (OPT_USAGE
|OPT_NAME
)) {
286 puts_P(PSTR("Inkompatible options: -f -k\n"
288 return CMD_RET_USAGE
;
290 if (options
& OPT_USAGE
)
293 if ((options
& (OPT_NAME
| OPT_USAGE
)) == 0 && argc
> 0)
296 char *optenv
= getenv_str(PSTR("cmd"));
297 if (optenv
&& strstr_P(optenv
, PSTR("debug")) != NULL
)
298 options
|= OPT_DBG_CMDS
;
300 uint_fast8_t maxlen_cmd
;
302 cmd_tbl_t
**cmd_list
= NULL
;
303 for (uint_fast8_t pass
= 0; pass
< 2; ++pass
) {
308 cmd_list
= (cmd_tbl_t
**) malloc(cmd_items
* sizeof(cmd_tbl_t
*));
309 /* TODO: Check error */
312 /* Make array of commands */
313 cmd_tbl_t
*tp
= tbl_start
;
315 while (tp
->name
!= NULL
) {
317 cmd_tbl_t
*sub
= tp
->subcmd
;
318 while (sub
->name
!= NULL
) {
319 if (options
& OPT_ALL
|| sub
->flags
& CTBL_SUBCMDAUTO
) {
324 uint_fast8_t len
= strlen_P(sub
->name
);
325 if ((sub
->flags
& CTBL_SUBCMDAUTO
) == 0) {
326 len
+= strlen_P(tp
->name
) + 1;
328 if (len
> maxlen_cmd
) {
331 //debug_cmd("### i:%3d, maxlen:%3d, tp: '%S', sub: '%S'\n", i, maxlen_cmd, tp->name, sub->name);
337 if ((tp
->flags
& CTBL_SUBCMDAUTO
) == 0) {
342 uint_fast8_t len
= strlen_P(tp
->name
);
343 cmd_tbl_t
*top
= get_cmd_tbl_parent(tp
);
345 len
+= strlen_P(top
->name
) + 1;
346 if (len
> maxlen_cmd
)
352 //debug_cmd("### pass: %d, cmd_items: %d, i: %d, maxlen_cmd: %d\n", pass, cmd_items, i, maxlen_cmd);
355 /* Sort command list */
356 qsort(cmd_list
, cmd_items
, sizeof (cmd_tbl_t
*), cmpstring_PP
);
358 if ((options
& OPT_LONG
) == 0) {
359 /* print short help (usage) */
360 for (uint_fast8_t cmdi
= 0; cmdi
< cmd_items
; cmdi
++) {
362 /* allow user abort */
364 res
= CMD_RET_FAILURE
;
367 if ((cmd_list
[cmdi
]->flags
& CTBL_DBG
) && !(options
& OPT_DBG_CMDS
))
369 if (cmd_list
[cmdi
]->usage
== NULL
)
373 print_usage_line(cmd_list
[cmdi
], maxlen_cmd
);
375 for (uint_fast8_t argi
= 0; argi
< argc
; argi
++) {
376 if (((options
& OPT_NAME
) &&
377 strcasestr_P2(cmd_list
[cmdi
]->name
, argv
[argi
])) ||
378 ((options
& OPT_USAGE
) &&
379 strcasestr_P2(cmd_list
[cmdi
]->usage
, argv
[argi
]))) {
380 print_usage_line(cmd_list
[cmdi
], maxlen_cmd
);
386 /* command help (long version) */
387 for (uint_fast8_t argi
= 0; argi
< argc
; ++argi
) {
388 uint_fast8_t got
= 0;
389 cmd_tbl_t
*tp
= find_cmd(argv
[argi
], tbl_start
);
394 if (options
& OPT_ALL
) {
395 for (cmd_tbl_t
*sub
= tbl_start
; sub
->name
!= NULL
; sub
++) {
397 tp
= find_cmd(argv
[argi
], sub
->subcmd
);
406 printf_P(PSTR("Unknown command '%s' - try 'help help'\n"),
408 res
= CMD_RET_FAILURE
;
418 command_ret_t
cmd_usage(cmd_tbl_t
*cmdtp
)
420 print_usage_line(cmdtp
, 0);
421 #ifdef CONFIG_SYS_LONGHELP
422 my_puts_P(PSTR("Usage:\n"));
423 print_prefixed_name(cmdtp
);
424 my_puts_P(PSTR(" "));
426 if (cmdtp
->help
&& *cmdtp
->help
!= '\0')
429 my_puts_P(PSTR(" - No additional help available.\n"));
430 #endif /* CONFIG_SYS_LONGHELP */
431 return CMD_RET_FAILURE
;
434 #ifdef CONFIG_AUTO_COMPLETE
436 int var_complete(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
438 static char tmp_buf
[CONFIG_SYS_CBSIZE
];
441 space
= last_char
== '\0' || isblank(last_char
);
443 if (space
&& argc
== 1)
444 return env_complete("", maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
446 if (!space
&& argc
== 2)
447 return env_complete(argv
[1], maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
452 /*************************************************************************************/
454 /* TODO: cmdtp points to FLASH */
456 static int complete_cmdv(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
458 cmd_tbl_t
*cmdtp
= cmd_tbl
;
459 // const int count = ARRAY_SIZE(cmd_tbl);
460 // const cmd_tbl_t *cmdend = cmdtp + count;
473 /* output full list of commands */
474 for (; cmdtp
->name
[0] != '\0'; cmdtp
++) {
475 if (n_found
>= maxv
- 2) {
476 cmdv
[n_found
++] = "...";
479 cmdv
[n_found
++] = cmdtp
->name
;
481 cmdv
[n_found
] = NULL
;
485 /* more than one arg or one but the start of the next */
486 if (argc
> 1 || (last_char
== '\0' || isblank(last_char
))) {
487 cmdtp
= find_cmd(argv
[0], cmd_tbl
);
488 if (cmdtp
== NULL
|| cmdtp
->complete
== NULL
) {
492 return (*cmdtp
->complete
)(argc
, argv
, last_char
, maxv
, cmdv
);
499 /* return the partial matches */
500 for (; cmdtp
->name
[0] != '\0'; cmdtp
++) {
502 clen
= strlen(cmdtp
->name
);
506 if (memcmp(cmd
, cmdtp
->name
, len
) != 0)
510 if (n_found
>= maxv
- 2) {
511 cmdv
[n_found
++] = "...";
515 cmdv
[n_found
++] = cmdtp
->name
;
518 cmdv
[n_found
] = NULL
;
522 static int make_argv(char *s
, int argvsz
, char *argv
[])
526 /* split into argv */
527 while (argc
< argvsz
- 1) {
529 /* skip any white space */
533 if (*s
== '\0') /* end of s, no more args */
536 argv
[argc
++] = s
; /* begin of argument string */
538 /* find end of string */
539 while (*s
&& !isblank(*s
))
542 if (*s
== '\0') /* end of s, no more args */
545 *s
++ = '\0'; /* terminate current arg */
552 static void print_argv(const char *banner
, const char *leader
, const char *sep
, int linemax
, char * const argv
[])
554 int ll
= leader
!= NULL
? strlen(leader
) : 0;
555 int sl
= sep
!= NULL
? strlen(sep
) : 0;
559 my_puts_P(PSTR("\n"));
563 i
= linemax
; /* force leader and newline */
564 while (*argv
!= NULL
) {
565 len
= strlen(*argv
) + sl
;
566 if (i
+ len
>= linemax
) {
567 my_puts_P(PSTR("\n"));
576 my_puts_P(PSTR("\n"));
579 static int find_common_prefix(char * const argv
[])
582 char *anchor
, *s
, *t
;
589 len
= strlen(anchor
);
590 while ((t
= *argv
++) != NULL
) {
592 for (i
= 0; i
< len
; i
++, t
++, s
++) {
601 static char tmp_buf
[CONFIG_SYS_CBSIZE
]; /* copy of console I/O buffer */
604 int cmd_auto_complete(const FLASH
char *const prompt
, char *buf
, int *np
, int *colp
)
606 int n
= *np
, col
= *colp
;
607 char *argv
[CONFIG_SYS_MAXARGS
+ 1]; /* NULL terminated */
611 int i
, j
, k
, len
, seplen
, argc
;
615 if (strcmp_PP(prompt
, CONFIG_SYS_PROMPT
) != 0)
616 return 0; /* not in normal console */
620 last_char
= buf
[cnt
- 1];
624 /* copy to secondary buffer which will be affected */
625 strcpy(tmp_buf
, buf
);
627 /* separate into argv */
628 argc
= make_argv(tmp_buf
, sizeof(argv
)/sizeof(argv
[0]), argv
);
630 /* do the completion and return the possible completions */
631 i
= complete_cmdv(argc
, argv
, last_char
, sizeof(cmdv
)/sizeof(cmdv
[0]), cmdv
);
633 /* no match; bell and out */
635 if (argc
> 1) /* allow tab for non command */
645 if (i
== 1) { /* one match; perfect */
646 k
= strlen(argv
[argc
- 1]);
651 } else if (i
> 1 && (j
= find_common_prefix(cmdv
)) != 0) { /* more */
652 k
= strlen(argv
[argc
- 1]);
662 /* make sure it fits */
663 if (n
+ k
>= CONFIG_SYS_CBSIZE
- 2) {
669 for (i
= 0; i
< len
; i
++)
672 for (i
= 0; i
< seplen
; i
++)
683 print_argv(NULL
, " ", " ", 78, cmdv
);
691 #endif /* CONFIG_AUTO_COMPLETE */
694 static cmd_tbl_t
*cmd_invocation_ptr
;
697 * Call a command function. This should be the only route in U-Boot to call
698 * a command, so that we can track whether we are waiting for input or
699 * executing a command.
701 * @param cmdtp Pointer to the command to execute
702 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
703 * @param argc Number of arguments (arg 0 must be the command text)
704 * @param argv Arguments
705 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
707 static command_ret_t
cmd_call(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
, int argc
, char * const argv
[])
709 command_ret_t result
;
711 result
= (cmdtp
->cmd
)(cmdtp
, flag
, argc
, argv
);
712 // if (result != CMD_RET_SUCCESS)
713 // debug("Command failed, result=%d\n", result);
717 #pragma GCC diagnostic ignored "-Wclobbered"
719 command_ret_t
cmd_process(uint_fast8_t flag
, int argc
, char * const argv
[],
720 uint_fast8_t *repeatable
)
722 command_ret_t rc
= CMD_RET_SUCCESS
;
725 /* Look up command in command table */
726 cmdtp
= find_cmd(argv
[0], cmd_tbl
);
728 /* Check if this command has subcommands */
729 if (cmdtp
->subcmd
&& argc
> 1) {
731 /* Look up subcommand in subcommand table */
732 cmd_tbl_t
*cmdtpsub
= find_cmd(argv
[1], cmdtp
->subcmd
);
733 if (cmdtpsub
== NULL
) {
734 printf_P(PSTR("Unknown '%s' subcommand '%s' - try '%s help'\n"), argv
[0], argv
[1], argv
[0]);
735 return CMD_RET_FAILURE
;
744 printf_P(PSTR("Unknown command '%s' - try 'help'\n"), argv
[0]);
745 return CMD_RET_FAILURE
;
748 /* found - check max args */
749 if (argc
> cmdtp
->maxargs
)
752 #if defined(CONFIG_CMD_BOOTD)
753 /* avoid "bootd" recursion */
754 else if (cmdtp
->cmd
== do_bootd
) {
755 if (flag
& CMD_FLAG_BOOTD
) {
756 my_puts_P(PSTR("'bootd' recursion detected\n"));
757 rc
= CMD_RET_FAILURE
;
759 flag
|= CMD_FLAG_BOOTD
;
764 if (setjmp(cmd_jbuf
) != 0)
765 return CMD_RET_FAILURE
;
767 /* If OK so far, then do the command */
769 optind
= 0; /* reset getopt() */
770 cmd_invocation_ptr
= cmdtp
;
771 rc
= cmd_call(cmdtp
, flag
, argc
, argv
);
772 *repeatable
&= (cmdtp
->flags
& CTBL_RPT
) != 0;
774 if (rc
== CMD_RET_USAGE
)
775 rc
= cmd_usage(cmdtp
);
779 int cmd_process_error(cmd_tbl_t
*cmdtp
, int err
)
781 char buf
[strlen_P(cmdtp
->name
) + 1];
782 strcpy_P(buf
, cmdtp
->name
);
785 printf_P(PSTR("Command '%s' failed: Error %d\n"), buf
, err
);
792 void cmd_error(int status
, int errnum
, const char *fmt
, ...)
796 print_prefixed_name(cmd_invocation_ptr
);
798 my_puts_P(PSTR(": "));
799 vfprintf_P(stdout
, fmt
, ap
);
804 printf_P(PSTR(": %S"), my_strerror_P(errnum
));
810 longjmp(cmd_jbuf
, 1);