2 * (C) Copyright 2000-2009
3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5 * SPDX-License-Identifier: GPL-2.0+
9 * Command Processor Table
15 #include <linux/ctype.h>
18 * Use puts() instead of printf() to avoid printf buffer overflow
19 * for long help messages
22 int _do_help(cmd_tbl_t
*cmd_start
, int cmd_items
, cmd_tbl_t
*cmdtp
, int flag
,
23 int argc
, char * const argv
[])
28 if (argc
== 1) { /* show list of commands */
29 cmd_tbl_t
*cmd_array
[cmd_items
];
32 /* Make array of commands from .uboot_cmd section */
34 for (i
= 0; i
< cmd_items
; i
++) {
35 cmd_array
[i
] = cmdtp
++;
38 /* Sort command list (trivial bubble sort) */
39 for (i
= cmd_items
- 1; i
> 0; --i
) {
41 for (j
= 0; j
< i
; ++j
) {
42 if (strcmp(cmd_array
[j
]->name
,
43 cmd_array
[j
+ 1]->name
) > 0) {
46 cmd_array
[j
] = cmd_array
[j
+ 1];
47 cmd_array
[j
+ 1] = tmp
;
55 /* print short help (usage) */
56 for (i
= 0; i
< cmd_items
; i
++) {
57 const char *usage
= cmd_array
[i
]->usage
;
59 /* allow user abort */
64 printf("%-*s- %s\n", CONFIG_SYS_HELP_CMD_WIDTH
,
65 cmd_array
[i
]->name
, usage
);
70 * command help (long version)
72 for (i
= 1; i
< argc
; ++i
) {
73 cmdtp
= find_cmd_tbl(argv
[i
], cmd_start
, cmd_items
);
75 rcode
|= cmd_usage(cmdtp
);
77 printf("Unknown command '%s' - try 'help' without arguments for list of all known commands\n\n",
85 /* find command table entry for a command */
86 cmd_tbl_t
*find_cmd_tbl(const char *cmd
, cmd_tbl_t
*table
, int table_len
)
89 cmd_tbl_t
*cmdtp_temp
= table
; /* Init value */
97 * Some commands allow length modifiers (like "cp.b");
98 * compare command name only until first dot.
100 len
= ((p
= strchr(cmd
, '.')) == NULL
) ? strlen (cmd
) : (p
- cmd
);
102 for (cmdtp
= table
; cmdtp
!= table
+ table_len
; cmdtp
++) {
103 if (strncmp(cmd
, cmdtp
->name
, len
) == 0) {
104 if (len
== strlen(cmdtp
->name
))
105 return cmdtp
; /* full match */
107 cmdtp_temp
= cmdtp
; /* abbreviated command ? */
111 if (n_found
== 1) { /* exactly one match */
115 return NULL
; /* not found or ambiguous command */
118 cmd_tbl_t
*find_cmd(const char *cmd
)
120 cmd_tbl_t
*start
= ll_entry_start(cmd_tbl_t
, cmd
);
121 const int len
= ll_entry_count(cmd_tbl_t
, cmd
);
122 return find_cmd_tbl(cmd
, start
, len
);
125 int cmd_usage(const cmd_tbl_t
*cmdtp
)
127 printf("%s - %s\n\n", cmdtp
->name
, cmdtp
->usage
);
129 #ifdef CONFIG_SYS_LONGHELP
130 printf("Usage:\n%s ", cmdtp
->name
);
133 puts ("- No additional help available.\n");
139 #endif /* CONFIG_SYS_LONGHELP */
143 #ifdef CONFIG_AUTO_COMPLETE
145 int var_complete(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
147 static char tmp_buf
[512];
150 space
= last_char
== '\0' || isblank(last_char
);
152 if (space
&& argc
== 1)
153 return env_complete("", maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
155 if (!space
&& argc
== 2)
156 return env_complete(argv
[1], maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
161 /*************************************************************************************/
163 static int complete_cmdv(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
165 cmd_tbl_t
*cmdtp
= ll_entry_start(cmd_tbl_t
, cmd
);
166 const int count
= ll_entry_count(cmd_tbl_t
, cmd
);
167 const cmd_tbl_t
*cmdend
= cmdtp
+ count
;
180 /* output full list of commands */
181 for (; cmdtp
!= cmdend
; cmdtp
++) {
182 if (n_found
>= maxv
- 2) {
183 cmdv
[n_found
++] = "...";
186 cmdv
[n_found
++] = cmdtp
->name
;
188 cmdv
[n_found
] = NULL
;
192 /* more than one arg or one but the start of the next */
193 if (argc
> 1 || last_char
== '\0' || isblank(last_char
)) {
194 cmdtp
= find_cmd(argv
[0]);
195 if (cmdtp
== NULL
|| cmdtp
->complete
== NULL
) {
199 return (*cmdtp
->complete
)(argc
, argv
, last_char
, maxv
, cmdv
);
204 * Some commands allow length modifiers (like "cp.b");
205 * compare command name only until first dot.
207 p
= strchr(cmd
, '.');
213 /* return the partial matches */
214 for (; cmdtp
!= cmdend
; cmdtp
++) {
216 clen
= strlen(cmdtp
->name
);
220 if (memcmp(cmd
, cmdtp
->name
, len
) != 0)
224 if (n_found
>= maxv
- 2) {
225 cmdv
[n_found
++] = "...";
229 cmdv
[n_found
++] = cmdtp
->name
;
232 cmdv
[n_found
] = NULL
;
236 static int make_argv(char *s
, int argvsz
, char *argv
[])
240 /* split into argv */
241 while (argc
< argvsz
- 1) {
243 /* skip any white space */
247 if (*s
== '\0') /* end of s, no more args */
250 argv
[argc
++] = s
; /* begin of argument string */
252 /* find end of string */
253 while (*s
&& !isblank(*s
))
256 if (*s
== '\0') /* end of s, no more args */
259 *s
++ = '\0'; /* terminate current arg */
266 static void print_argv(const char *banner
, const char *leader
, const char *sep
, int linemax
, char * const argv
[])
268 int ll
= leader
!= NULL
? strlen(leader
) : 0;
269 int sl
= sep
!= NULL
? strlen(sep
) : 0;
277 i
= linemax
; /* force leader and newline */
278 while (*argv
!= NULL
) {
279 len
= strlen(*argv
) + sl
;
280 if (i
+ len
>= linemax
) {
293 static int find_common_prefix(char * const argv
[])
296 char *anchor
, *s
, *t
;
303 len
= strlen(anchor
);
304 while ((t
= *argv
++) != NULL
) {
306 for (i
= 0; i
< len
; i
++, t
++, s
++) {
315 static char tmp_buf
[CONFIG_SYS_CBSIZE
]; /* copy of console I/O buffer */
317 int cmd_auto_complete(const char *const prompt
, char *buf
, int *np
, int *colp
)
319 int n
= *np
, col
= *colp
;
320 char *argv
[CONFIG_SYS_MAXARGS
+ 1]; /* NULL terminated */
324 int i
, j
, k
, len
, seplen
, argc
;
328 if (strcmp(prompt
, CONFIG_SYS_PROMPT
) != 0)
329 return 0; /* not in normal console */
333 last_char
= buf
[cnt
- 1];
337 /* copy to secondary buffer which will be affected */
338 strcpy(tmp_buf
, buf
);
340 /* separate into argv */
341 argc
= make_argv(tmp_buf
, sizeof(argv
)/sizeof(argv
[0]), argv
);
343 /* do the completion and return the possible completions */
344 i
= complete_cmdv(argc
, argv
, last_char
,
345 sizeof(cmdv
) / sizeof(cmdv
[0]), cmdv
);
347 /* no match; bell and out */
349 if (argc
> 1) /* allow tab for non command */
359 if (i
== 1) { /* one match; perfect */
360 k
= strlen(argv
[argc
- 1]);
365 } else if (i
> 1 && (j
= find_common_prefix(cmdv
)) != 0) { /* more */
366 k
= strlen(argv
[argc
- 1]);
376 /* make sure it fits */
377 if (n
+ k
>= CONFIG_SYS_CBSIZE
- 2) {
383 for (i
= 0; i
< len
; i
++)
386 for (i
= 0; i
< seplen
; i
++)
397 print_argv(NULL
, " ", " ", 78, cmdv
);
408 int cmd_get_data_size(char* arg
, int default_size
)
410 /* Check for a size specification .b, .w or .l.
412 int len
= strlen(arg
);
413 if (len
> 2 && arg
[len
-2] == '.') {
414 switch (arg
[len
-1]) {
421 #ifdef CONFIG_SYS_SUPPORT_64BIT_DATA
435 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
436 DECLARE_GLOBAL_DATA_PTR
;
438 void fixup_cmdtable(cmd_tbl_t
*cmdtp
, int size
)
442 if (gd
->reloc_off
== 0)
445 for (i
= 0; i
< size
; i
++) {
448 addr
= (ulong
)(cmdtp
->cmd
) + gd
->reloc_off
;
449 #ifdef DEBUG_COMMANDS
450 printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
451 cmdtp
->name
, (ulong
)(cmdtp
->cmd
), addr
);
454 (int (*)(struct cmd_tbl_s
*, int, int, char * const []))addr
;
455 addr
= (ulong
)(cmdtp
->name
) + gd
->reloc_off
;
456 cmdtp
->name
= (char *)addr
;
458 addr
= (ulong
)(cmdtp
->usage
) + gd
->reloc_off
;
459 cmdtp
->usage
= (char *)addr
;
461 #ifdef CONFIG_SYS_LONGHELP
463 addr
= (ulong
)(cmdtp
->help
) + gd
->reloc_off
;
464 cmdtp
->help
= (char *)addr
;
467 #ifdef CONFIG_AUTO_COMPLETE
468 if (cmdtp
->complete
) {
469 addr
= (ulong
)(cmdtp
->complete
) + gd
->reloc_off
;
471 (int (*)(int, char * const [], char, int, char * []))addr
;
480 * Call a command function. This should be the only route in U-Boot to call
481 * a command, so that we can track whether we are waiting for input or
482 * executing a command.
484 * @param cmdtp Pointer to the command to execute
485 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
486 * @param argc Number of arguments (arg 0 must be the command text)
487 * @param argv Arguments
488 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
490 static int cmd_call(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
494 result
= (cmdtp
->cmd
)(cmdtp
, flag
, argc
, argv
);
496 debug("Command failed, result=%d\n", result
);
500 enum command_ret_t
cmd_process(int flag
, int argc
, char * const argv
[],
501 int *repeatable
, ulong
*ticks
)
503 enum command_ret_t rc
= CMD_RET_SUCCESS
;
506 /* Look up command in command table */
507 cmdtp
= find_cmd(argv
[0]);
509 printf("Unknown command '%s' - try 'help'\n", argv
[0]);
513 /* found - check max args */
514 if (argc
> cmdtp
->maxargs
)
517 #if defined(CONFIG_CMD_BOOTD)
518 /* avoid "bootd" recursion */
519 else if (cmdtp
->cmd
== do_bootd
) {
520 if (flag
& CMD_FLAG_BOOTD
) {
521 puts("'bootd' recursion detected\n");
522 rc
= CMD_RET_FAILURE
;
524 flag
|= CMD_FLAG_BOOTD
;
529 /* If OK so far, then do the command */
532 *ticks
= get_timer(0);
533 rc
= cmd_call(cmdtp
, flag
, argc
, argv
);
535 *ticks
= get_timer(*ticks
);
536 *repeatable
&= cmdtp
->repeatable
;
538 if (rc
== CMD_RET_USAGE
)
539 rc
= cmd_usage(cmdtp
);
543 int cmd_process_error(cmd_tbl_t
*cmdtp
, int err
)
546 printf("Command '%s' failed: Error %d\n", cmdtp
->name
, err
);