1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
8 * 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
)
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 */
114 #endif /* CONFIG_CMDLINE */
116 return NULL
; /* not found or ambiguous command */
119 cmd_tbl_t
*find_cmd(const char *cmd
)
121 cmd_tbl_t
*start
= ll_entry_start(cmd_tbl_t
, cmd
);
122 const int len
= ll_entry_count(cmd_tbl_t
, cmd
);
123 return find_cmd_tbl(cmd
, start
, len
);
126 int cmd_usage(const cmd_tbl_t
*cmdtp
)
128 printf("%s - %s\n\n", cmdtp
->name
, cmdtp
->usage
);
130 #ifdef CONFIG_SYS_LONGHELP
131 printf("Usage:\n%s ", cmdtp
->name
);
134 puts ("- No additional help available.\n");
140 #endif /* CONFIG_SYS_LONGHELP */
144 #ifdef CONFIG_AUTO_COMPLETE
146 int var_complete(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
148 static char tmp_buf
[512];
151 space
= last_char
== '\0' || isblank(last_char
);
153 if (space
&& argc
== 1)
154 return env_complete("", maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
156 if (!space
&& argc
== 2)
157 return env_complete(argv
[1], maxv
, cmdv
, sizeof(tmp_buf
), tmp_buf
);
162 /*************************************************************************************/
164 static int complete_cmdv(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
166 #ifdef CONFIG_CMDLINE
167 cmd_tbl_t
*cmdtp
= ll_entry_start(cmd_tbl_t
, cmd
);
168 const int count
= ll_entry_count(cmd_tbl_t
, cmd
);
169 const cmd_tbl_t
*cmdend
= cmdtp
+ count
;
182 /* output full list of commands */
183 for (; cmdtp
!= cmdend
; cmdtp
++) {
184 if (n_found
>= maxv
- 2) {
185 cmdv
[n_found
++] = "...";
188 cmdv
[n_found
++] = cmdtp
->name
;
190 cmdv
[n_found
] = NULL
;
194 /* more than one arg or one but the start of the next */
195 if (argc
> 1 || last_char
== '\0' || isblank(last_char
)) {
196 cmdtp
= find_cmd(argv
[0]);
197 if (cmdtp
== NULL
|| cmdtp
->complete
== NULL
) {
201 return (*cmdtp
->complete
)(argc
, argv
, last_char
, maxv
, cmdv
);
206 * Some commands allow length modifiers (like "cp.b");
207 * compare command name only until first dot.
209 p
= strchr(cmd
, '.');
215 /* return the partial matches */
216 for (; cmdtp
!= cmdend
; cmdtp
++) {
218 clen
= strlen(cmdtp
->name
);
222 if (memcmp(cmd
, cmdtp
->name
, len
) != 0)
226 if (n_found
>= maxv
- 2) {
227 cmdv
[n_found
++] = "...";
231 cmdv
[n_found
++] = cmdtp
->name
;
234 cmdv
[n_found
] = NULL
;
241 static int make_argv(char *s
, int argvsz
, char *argv
[])
245 /* split into argv */
246 while (argc
< argvsz
- 1) {
248 /* skip any white space */
252 if (*s
== '\0') /* end of s, no more args */
255 argv
[argc
++] = s
; /* begin of argument string */
257 /* find end of string */
258 while (*s
&& !isblank(*s
))
261 if (*s
== '\0') /* end of s, no more args */
264 *s
++ = '\0'; /* terminate current arg */
271 static void print_argv(const char *banner
, const char *leader
, const char *sep
, int linemax
, char * const argv
[])
273 int ll
= leader
!= NULL
? strlen(leader
) : 0;
274 int sl
= sep
!= NULL
? strlen(sep
) : 0;
282 i
= linemax
; /* force leader and newline */
283 while (*argv
!= NULL
) {
284 len
= strlen(*argv
) + sl
;
285 if (i
+ len
>= linemax
) {
298 static int find_common_prefix(char * const argv
[])
301 char *anchor
, *s
, *t
;
308 len
= strlen(anchor
);
309 while ((t
= *argv
++) != NULL
) {
311 for (i
= 0; i
< len
; i
++, t
++, s
++) {
320 static char tmp_buf
[CONFIG_SYS_CBSIZE
+ 1]; /* copy of console I/O buffer */
322 int cmd_auto_complete(const char *const prompt
, char *buf
, int *np
, int *colp
)
324 int n
= *np
, col
= *colp
;
325 char *argv
[CONFIG_SYS_MAXARGS
+ 1]; /* NULL terminated */
329 int i
, j
, k
, len
, seplen
, argc
;
333 if (strcmp(prompt
, CONFIG_SYS_PROMPT
) != 0)
334 return 0; /* not in normal console */
338 last_char
= buf
[cnt
- 1];
342 /* copy to secondary buffer which will be affected */
343 strcpy(tmp_buf
, buf
);
345 /* separate into argv */
346 argc
= make_argv(tmp_buf
, sizeof(argv
)/sizeof(argv
[0]), argv
);
348 /* do the completion and return the possible completions */
349 i
= complete_cmdv(argc
, argv
, last_char
,
350 sizeof(cmdv
) / sizeof(cmdv
[0]), cmdv
);
352 /* no match; bell and out */
354 if (argc
> 1) /* allow tab for non command */
364 if (i
== 1) { /* one match; perfect */
365 k
= strlen(argv
[argc
- 1]);
370 } else if (i
> 1 && (j
= find_common_prefix(cmdv
)) != 0) { /* more */
371 k
= strlen(argv
[argc
- 1]);
381 /* make sure it fits */
382 if (n
+ k
>= CONFIG_SYS_CBSIZE
- 2) {
388 for (i
= 0; i
< len
; i
++)
391 for (i
= 0; i
< seplen
; i
++)
402 print_argv(NULL
, " ", " ", 78, cmdv
);
413 int cmd_get_data_size(char* arg
, int default_size
)
415 /* Check for a size specification .b, .w or .l.
417 int len
= strlen(arg
);
418 if (len
> 2 && arg
[len
-2] == '.') {
419 switch (arg
[len
-1]) {
426 #ifdef CONFIG_SYS_SUPPORT_64BIT_DATA
440 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
441 DECLARE_GLOBAL_DATA_PTR
;
443 void fixup_cmdtable(cmd_tbl_t
*cmdtp
, int size
)
447 if (gd
->reloc_off
== 0)
450 for (i
= 0; i
< size
; i
++) {
453 addr
= (ulong
)(cmdtp
->cmd
) + gd
->reloc_off
;
454 #ifdef DEBUG_COMMANDS
455 printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
456 cmdtp
->name
, (ulong
)(cmdtp
->cmd
), addr
);
459 (int (*)(struct cmd_tbl_s
*, int, int, char * const []))addr
;
460 addr
= (ulong
)(cmdtp
->name
) + gd
->reloc_off
;
461 cmdtp
->name
= (char *)addr
;
463 addr
= (ulong
)(cmdtp
->usage
) + gd
->reloc_off
;
464 cmdtp
->usage
= (char *)addr
;
466 #ifdef CONFIG_SYS_LONGHELP
468 addr
= (ulong
)(cmdtp
->help
) + gd
->reloc_off
;
469 cmdtp
->help
= (char *)addr
;
472 #ifdef CONFIG_AUTO_COMPLETE
473 if (cmdtp
->complete
) {
474 addr
= (ulong
)(cmdtp
->complete
) + gd
->reloc_off
;
476 (int (*)(int, char * const [], char, int, char * []))addr
;
485 * Call a command function. This should be the only route in U-Boot to call
486 * a command, so that we can track whether we are waiting for input or
487 * executing a command.
489 * @param cmdtp Pointer to the command to execute
490 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
491 * @param argc Number of arguments (arg 0 must be the command text)
492 * @param argv Arguments
493 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
495 static int cmd_call(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
499 result
= (cmdtp
->cmd
)(cmdtp
, flag
, argc
, argv
);
501 debug("Command failed, result=%d\n", result
);
505 enum command_ret_t
cmd_process(int flag
, int argc
, char * const argv
[],
506 int *repeatable
, ulong
*ticks
)
508 enum command_ret_t rc
= CMD_RET_SUCCESS
;
511 /* Look up command in command table */
512 cmdtp
= find_cmd(argv
[0]);
514 printf("Unknown command '%s' - try 'help'\n", argv
[0]);
518 /* found - check max args */
519 if (argc
> cmdtp
->maxargs
)
522 #if defined(CONFIG_CMD_BOOTD)
523 /* avoid "bootd" recursion */
524 else if (cmdtp
->cmd
== do_bootd
) {
525 if (flag
& CMD_FLAG_BOOTD
) {
526 puts("'bootd' recursion detected\n");
527 rc
= CMD_RET_FAILURE
;
529 flag
|= CMD_FLAG_BOOTD
;
534 /* If OK so far, then do the command */
537 *ticks
= get_timer(0);
538 rc
= cmd_call(cmdtp
, flag
, argc
, argv
);
540 *ticks
= get_timer(*ticks
);
541 *repeatable
&= cmdtp
->repeatable
;
543 if (rc
== CMD_RET_USAGE
)
544 rc
= cmd_usage(cmdtp
);
548 int cmd_process_error(cmd_tbl_t
*cmdtp
, int err
)
551 printf("Command '%s' failed: Error %d\n", cmdtp
->name
, err
);