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
14 #include <linux/ctype.h>
17 * Use puts() instead of printf() to avoid printf buffer overflow
18 * for long help messages
21 int _do_help(cmd_tbl_t
*cmd_start
, int cmd_items
, cmd_tbl_t
*cmdtp
, int flag
,
22 int argc
, char * const argv
[])
27 if (argc
== 1) { /* show list of commands */
28 cmd_tbl_t
*cmd_array
[cmd_items
];
31 /* Make array of commands from .uboot_cmd section */
33 for (i
= 0; i
< cmd_items
; i
++) {
34 cmd_array
[i
] = cmdtp
++;
37 /* Sort command list (trivial bubble sort) */
38 for (i
= cmd_items
- 1; i
> 0; --i
) {
40 for (j
= 0; j
< i
; ++j
) {
41 if (strcmp(cmd_array
[j
]->name
,
42 cmd_array
[j
+ 1]->name
) > 0) {
45 cmd_array
[j
] = cmd_array
[j
+ 1];
46 cmd_array
[j
+ 1] = tmp
;
54 /* print short help (usage) */
55 for (i
= 0; i
< cmd_items
; i
++) {
56 const char *usage
= cmd_array
[i
]->usage
;
58 /* allow user abort */
63 printf("%-*s- %s\n", CONFIG_SYS_HELP_CMD_WIDTH
,
64 cmd_array
[i
]->name
, usage
);
69 * command help (long version)
71 for (i
= 1; i
< argc
; ++i
) {
72 cmdtp
= find_cmd_tbl(argv
[i
], cmd_start
, cmd_items
);
74 rcode
|= cmd_usage(cmdtp
);
76 printf("Unknown command '%s' - try 'help' without arguments for list of all known commands\n\n",
84 /* find command table entry for a command */
85 cmd_tbl_t
*find_cmd_tbl(const char *cmd
, cmd_tbl_t
*table
, int table_len
)
88 cmd_tbl_t
*cmdtp_temp
= table
; /* Init value */
96 * Some commands allow length modifiers (like "cp.b");
97 * compare command name only until first dot.
99 len
= ((p
= strchr(cmd
, '.')) == NULL
) ? strlen (cmd
) : (p
- cmd
);
101 for (cmdtp
= table
; cmdtp
!= table
+ table_len
; cmdtp
++) {
102 if (strncmp(cmd
, cmdtp
->name
, len
) == 0) {
103 if (len
== strlen(cmdtp
->name
))
104 return cmdtp
; /* full match */
106 cmdtp_temp
= cmdtp
; /* abbreviated command ? */
110 if (n_found
== 1) { /* exactly one match */
114 return NULL
; /* not found or ambiguous command */
117 cmd_tbl_t
*find_cmd(const char *cmd
)
119 cmd_tbl_t
*start
= ll_entry_start(cmd_tbl_t
, cmd
);
120 const int len
= ll_entry_count(cmd_tbl_t
, cmd
);
121 return find_cmd_tbl(cmd
, start
, len
);
124 int cmd_usage(const cmd_tbl_t
*cmdtp
)
126 printf("%s - %s\n\n", cmdtp
->name
, cmdtp
->usage
);
128 #ifdef CONFIG_SYS_LONGHELP
129 printf("Usage:\n%s ", cmdtp
->name
);
132 puts ("- No additional help available.\n");
138 #endif /* CONFIG_SYS_LONGHELP */
142 #ifdef CONFIG_AUTO_COMPLETE
144 int var_complete(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
146 static char tmp_buf
[512];
149 space
= last_char
== '\0' || isblank(last_char
);
151 if (space
&& argc
== 1)
152 return env_complete("", maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
154 if (!space
&& argc
== 2)
155 return env_complete(argv
[1], maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
160 /*************************************************************************************/
162 static int complete_cmdv(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
164 cmd_tbl_t
*cmdtp
= ll_entry_start(cmd_tbl_t
, cmd
);
165 const int count
= ll_entry_count(cmd_tbl_t
, cmd
);
166 const cmd_tbl_t
*cmdend
= cmdtp
+ count
;
179 /* output full list of commands */
180 for (; cmdtp
!= cmdend
; cmdtp
++) {
181 if (n_found
>= maxv
- 2) {
182 cmdv
[n_found
++] = "...";
185 cmdv
[n_found
++] = cmdtp
->name
;
187 cmdv
[n_found
] = NULL
;
191 /* more than one arg or one but the start of the next */
192 if (argc
> 1 || last_char
== '\0' || isblank(last_char
)) {
193 cmdtp
= find_cmd(argv
[0]);
194 if (cmdtp
== NULL
|| cmdtp
->complete
== NULL
) {
198 return (*cmdtp
->complete
)(argc
, argv
, last_char
, maxv
, cmdv
);
203 * Some commands allow length modifiers (like "cp.b");
204 * compare command name only until first dot.
206 p
= strchr(cmd
, '.');
212 /* return the partial matches */
213 for (; cmdtp
!= cmdend
; cmdtp
++) {
215 clen
= strlen(cmdtp
->name
);
219 if (memcmp(cmd
, cmdtp
->name
, len
) != 0)
223 if (n_found
>= maxv
- 2) {
224 cmdv
[n_found
++] = "...";
228 cmdv
[n_found
++] = cmdtp
->name
;
231 cmdv
[n_found
] = NULL
;
235 static int make_argv(char *s
, int argvsz
, char *argv
[])
239 /* split into argv */
240 while (argc
< argvsz
- 1) {
242 /* skip any white space */
246 if (*s
== '\0') /* end of s, no more args */
249 argv
[argc
++] = s
; /* begin of argument string */
251 /* find end of string */
252 while (*s
&& !isblank(*s
))
255 if (*s
== '\0') /* end of s, no more args */
258 *s
++ = '\0'; /* terminate current arg */
265 static void print_argv(const char *banner
, const char *leader
, const char *sep
, int linemax
, char * const argv
[])
267 int ll
= leader
!= NULL
? strlen(leader
) : 0;
268 int sl
= sep
!= NULL
? strlen(sep
) : 0;
276 i
= linemax
; /* force leader and newline */
277 while (*argv
!= NULL
) {
278 len
= strlen(*argv
) + sl
;
279 if (i
+ len
>= linemax
) {
292 static int find_common_prefix(char * const argv
[])
295 char *anchor
, *s
, *t
;
302 len
= strlen(anchor
);
303 while ((t
= *argv
++) != NULL
) {
305 for (i
= 0; i
< len
; i
++, t
++, s
++) {
314 static char tmp_buf
[CONFIG_SYS_CBSIZE
]; /* copy of console I/O buffer */
316 int cmd_auto_complete(const char *const prompt
, char *buf
, int *np
, int *colp
)
318 int n
= *np
, col
= *colp
;
319 char *argv
[CONFIG_SYS_MAXARGS
+ 1]; /* NULL terminated */
323 int i
, j
, k
, len
, seplen
, argc
;
327 if (strcmp(prompt
, CONFIG_SYS_PROMPT
) != 0)
328 return 0; /* not in normal console */
332 last_char
= buf
[cnt
- 1];
336 /* copy to secondary buffer which will be affected */
337 strcpy(tmp_buf
, buf
);
339 /* separate into argv */
340 argc
= make_argv(tmp_buf
, sizeof(argv
)/sizeof(argv
[0]), argv
);
342 /* do the completion and return the possible completions */
343 i
= complete_cmdv(argc
, argv
, last_char
,
344 sizeof(cmdv
) / sizeof(cmdv
[0]), cmdv
);
346 /* no match; bell and out */
348 if (argc
> 1) /* allow tab for non command */
358 if (i
== 1) { /* one match; perfect */
359 k
= strlen(argv
[argc
- 1]);
364 } else if (i
> 1 && (j
= find_common_prefix(cmdv
)) != 0) { /* more */
365 k
= strlen(argv
[argc
- 1]);
375 /* make sure it fits */
376 if (n
+ k
>= CONFIG_SYS_CBSIZE
- 2) {
382 for (i
= 0; i
< len
; i
++)
385 for (i
= 0; i
< seplen
; i
++)
396 print_argv(NULL
, " ", " ", 78, cmdv
);
407 int cmd_get_data_size(char* arg
, int default_size
)
409 /* Check for a size specification .b, .w or .l.
411 int len
= strlen(arg
);
412 if (len
> 2 && arg
[len
-2] == '.') {
413 switch (arg
[len
-1]) {
420 #ifdef CONFIG_SYS_SUPPORT_64BIT_DATA
434 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
435 DECLARE_GLOBAL_DATA_PTR
;
437 void fixup_cmdtable(cmd_tbl_t
*cmdtp
, int size
)
441 if (gd
->reloc_off
== 0)
444 for (i
= 0; i
< size
; i
++) {
447 addr
= (ulong
)(cmdtp
->cmd
) + gd
->reloc_off
;
448 #ifdef DEBUG_COMMANDS
449 printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
450 cmdtp
->name
, (ulong
)(cmdtp
->cmd
), addr
);
453 (int (*)(struct cmd_tbl_s
*, int, int, char * const []))addr
;
454 addr
= (ulong
)(cmdtp
->name
) + gd
->reloc_off
;
455 cmdtp
->name
= (char *)addr
;
457 addr
= (ulong
)(cmdtp
->usage
) + gd
->reloc_off
;
458 cmdtp
->usage
= (char *)addr
;
460 #ifdef CONFIG_SYS_LONGHELP
462 addr
= (ulong
)(cmdtp
->help
) + gd
->reloc_off
;
463 cmdtp
->help
= (char *)addr
;
466 #ifdef CONFIG_AUTO_COMPLETE
467 if (cmdtp
->complete
) {
468 addr
= (ulong
)(cmdtp
->complete
) + gd
->reloc_off
;
470 (int (*)(int, char * const [], char, int, char * []))addr
;
479 * Call a command function. This should be the only route in U-Boot to call
480 * a command, so that we can track whether we are waiting for input or
481 * executing a command.
483 * @param cmdtp Pointer to the command to execute
484 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
485 * @param argc Number of arguments (arg 0 must be the command text)
486 * @param argv Arguments
487 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
489 static int cmd_call(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
493 result
= (cmdtp
->cmd
)(cmdtp
, flag
, argc
, argv
);
495 debug("Command failed, result=%d\n", result
);
499 enum command_ret_t
cmd_process(int flag
, int argc
, char * const argv
[],
500 int *repeatable
, ulong
*ticks
)
502 enum command_ret_t rc
= CMD_RET_SUCCESS
;
505 /* Look up command in command table */
506 cmdtp
= find_cmd(argv
[0]);
508 printf("Unknown command '%s' - try 'help'\n", argv
[0]);
512 /* found - check max args */
513 if (argc
> cmdtp
->maxargs
)
516 #if defined(CONFIG_CMD_BOOTD)
517 /* avoid "bootd" recursion */
518 else if (cmdtp
->cmd
== do_bootd
) {
519 if (flag
& CMD_FLAG_BOOTD
) {
520 puts("'bootd' recursion detected\n");
521 rc
= CMD_RET_FAILURE
;
523 flag
|= CMD_FLAG_BOOTD
;
528 /* If OK so far, then do the command */
531 *ticks
= get_timer(0);
532 rc
= cmd_call(cmdtp
, flag
, argc
, argv
);
534 *ticks
= get_timer(*ticks
);
535 *repeatable
&= cmdtp
->repeatable
;
537 if (rc
== CMD_RET_USAGE
)
538 rc
= cmd_usage(cmdtp
);
542 int cmd_process_error(cmd_tbl_t
*cmdtp
, int err
)
545 printf("Command '%s' failed: Error %d\n", cmdtp
->name
, err
);