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
145 static char env_complete_buf
[512];
147 int var_complete(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[])
151 space
= last_char
== '\0' || isblank(last_char
);
153 if (space
&& argc
== 1)
154 return env_complete("", maxv
, cmdv
, sizeof(env_complete_buf
),
155 env_complete_buf
, false);
157 if (!space
&& argc
== 2)
158 return env_complete(argv
[1], maxv
, cmdv
,
159 sizeof(env_complete_buf
),
160 env_complete_buf
, false);
165 static int dollar_complete(int argc
, char * const argv
[], char last_char
,
166 int maxv
, char *cmdv
[])
168 /* Make sure the last argument starts with a $. */
169 if (argc
< 1 || argv
[argc
- 1][0] != '$' ||
170 last_char
== '\0' || isblank(last_char
))
173 return env_complete(argv
[argc
- 1], maxv
, cmdv
, sizeof(env_complete_buf
),
174 env_complete_buf
, true);
177 /*************************************************************************************/
179 int complete_subcmdv(cmd_tbl_t
*cmdtp
, int count
, int argc
,
180 char * const argv
[], char last_char
,
181 int maxv
, char *cmdv
[])
183 #ifdef CONFIG_CMDLINE
184 const cmd_tbl_t
*cmdend
= cmdtp
+ count
;
197 /* output full list of commands */
198 for (; cmdtp
!= cmdend
; cmdtp
++) {
199 if (n_found
>= maxv
- 2) {
200 cmdv
[n_found
++] = "...";
203 cmdv
[n_found
++] = cmdtp
->name
;
205 cmdv
[n_found
] = NULL
;
209 /* more than one arg or one but the start of the next */
210 if (argc
> 1 || last_char
== '\0' || isblank(last_char
)) {
211 cmdtp
= find_cmd_tbl(argv
[0], cmdtp
, count
);
212 if (cmdtp
== NULL
|| cmdtp
->complete
== NULL
) {
216 return (*cmdtp
->complete
)(argc
, argv
, last_char
, maxv
, cmdv
);
221 * Some commands allow length modifiers (like "cp.b");
222 * compare command name only until first dot.
224 p
= strchr(cmd
, '.');
230 /* return the partial matches */
231 for (; cmdtp
!= cmdend
; cmdtp
++) {
233 clen
= strlen(cmdtp
->name
);
237 if (memcmp(cmd
, cmdtp
->name
, len
) != 0)
241 if (n_found
>= maxv
- 2) {
242 cmdv
[n_found
++] = "...";
246 cmdv
[n_found
++] = cmdtp
->name
;
249 cmdv
[n_found
] = NULL
;
256 static int complete_cmdv(int argc
, char * const argv
[], char last_char
,
257 int maxv
, char *cmdv
[])
259 #ifdef CONFIG_CMDLINE
260 return complete_subcmdv(ll_entry_start(cmd_tbl_t
, cmd
),
261 ll_entry_count(cmd_tbl_t
, cmd
), argc
, argv
,
262 last_char
, maxv
, cmdv
);
268 static int make_argv(char *s
, int argvsz
, char *argv
[])
272 /* split into argv */
273 while (argc
< argvsz
- 1) {
275 /* skip any white space */
279 if (*s
== '\0') /* end of s, no more args */
282 argv
[argc
++] = s
; /* begin of argument string */
284 /* find end of string */
285 while (*s
&& !isblank(*s
))
288 if (*s
== '\0') /* end of s, no more args */
291 *s
++ = '\0'; /* terminate current arg */
298 static void print_argv(const char *banner
, const char *leader
, const char *sep
, int linemax
, char * const argv
[])
300 int ll
= leader
!= NULL
? strlen(leader
) : 0;
301 int sl
= sep
!= NULL
? strlen(sep
) : 0;
309 i
= linemax
; /* force leader and newline */
310 while (*argv
!= NULL
) {
311 len
= strlen(*argv
) + sl
;
312 if (i
+ len
>= linemax
) {
325 static int find_common_prefix(char * const argv
[])
328 char *anchor
, *s
, *t
;
335 len
= strlen(anchor
);
336 while ((t
= *argv
++) != NULL
) {
338 for (i
= 0; i
< len
; i
++, t
++, s
++) {
347 static char tmp_buf
[CONFIG_SYS_CBSIZE
+ 1]; /* copy of console I/O buffer */
349 int cmd_auto_complete(const char *const prompt
, char *buf
, int *np
, int *colp
)
351 int n
= *np
, col
= *colp
;
352 char *argv
[CONFIG_SYS_MAXARGS
+ 1]; /* NULL terminated */
356 int i
, j
, k
, len
, seplen
, argc
;
360 if (strcmp(prompt
, CONFIG_SYS_PROMPT
) != 0)
361 return 0; /* not in normal console */
365 last_char
= buf
[cnt
- 1];
369 /* copy to secondary buffer which will be affected */
370 strcpy(tmp_buf
, buf
);
372 /* separate into argv */
373 argc
= make_argv(tmp_buf
, sizeof(argv
)/sizeof(argv
[0]), argv
);
375 /* first try a $ completion */
376 i
= dollar_complete(argc
, argv
, last_char
,
377 sizeof(cmdv
) / sizeof(cmdv
[0]), cmdv
);
379 /* do the completion and return the possible completions */
380 i
= complete_cmdv(argc
, argv
, last_char
,
381 sizeof(cmdv
) / sizeof(cmdv
[0]), cmdv
);
384 /* no match; bell and out */
386 if (argc
> 1) /* allow tab for non command */
396 if (i
== 1) { /* one match; perfect */
397 if (last_char
!= '\0' && !isblank(last_char
))
398 k
= strlen(argv
[argc
- 1]);
406 } else if (i
> 1 && (j
= find_common_prefix(cmdv
)) != 0) { /* more */
407 if (last_char
!= '\0' && !isblank(last_char
))
408 k
= strlen(argv
[argc
- 1]);
421 /* make sure it fits */
422 if (n
+ k
>= CONFIG_SYS_CBSIZE
- 2) {
428 for (i
= 0; i
< len
; i
++)
431 for (i
= 0; i
< seplen
; i
++)
442 print_argv(NULL
, " ", " ", 78, cmdv
);
453 int cmd_get_data_size(char* arg
, int default_size
)
455 /* Check for a size specification .b, .w or .l.
457 int len
= strlen(arg
);
458 if (len
> 2 && arg
[len
-2] == '.') {
459 switch (arg
[len
-1]) {
466 #ifdef CONFIG_SYS_SUPPORT_64BIT_DATA
480 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
481 DECLARE_GLOBAL_DATA_PTR
;
483 void fixup_cmdtable(cmd_tbl_t
*cmdtp
, int size
)
487 if (gd
->reloc_off
== 0)
490 for (i
= 0; i
< size
; i
++) {
493 addr
= (ulong
)(cmdtp
->cmd
) + gd
->reloc_off
;
494 #ifdef DEBUG_COMMANDS
495 printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
496 cmdtp
->name
, (ulong
)(cmdtp
->cmd
), addr
);
499 (int (*)(struct cmd_tbl_s
*, int, int, char * const []))addr
;
500 addr
= (ulong
)(cmdtp
->name
) + gd
->reloc_off
;
501 cmdtp
->name
= (char *)addr
;
503 addr
= (ulong
)(cmdtp
->usage
) + gd
->reloc_off
;
504 cmdtp
->usage
= (char *)addr
;
506 #ifdef CONFIG_SYS_LONGHELP
508 addr
= (ulong
)(cmdtp
->help
) + gd
->reloc_off
;
509 cmdtp
->help
= (char *)addr
;
512 #ifdef CONFIG_AUTO_COMPLETE
513 if (cmdtp
->complete
) {
514 addr
= (ulong
)(cmdtp
->complete
) + gd
->reloc_off
;
516 (int (*)(int, char * const [], char, int, char * []))addr
;
524 int cmd_always_repeatable(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
525 char * const argv
[], int *repeatable
)
529 return cmdtp
->cmd(cmdtp
, flag
, argc
, argv
);
532 int cmd_never_repeatable(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
533 char * const argv
[], int *repeatable
)
537 return cmdtp
->cmd(cmdtp
, flag
, argc
, argv
);
540 int cmd_discard_repeatable(cmd_tbl_t
*cmdtp
, int flag
, int argc
,
545 return cmdtp
->cmd_rep(cmdtp
, flag
, argc
, argv
, &repeatable
);
549 * Call a command function. This should be the only route in U-Boot to call
550 * a command, so that we can track whether we are waiting for input or
551 * executing a command.
553 * @param cmdtp Pointer to the command to execute
554 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
555 * @param argc Number of arguments (arg 0 must be the command text)
556 * @param argv Arguments
557 * @param repeatable Can the command be repeated
558 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
560 static int cmd_call(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[],
565 result
= cmdtp
->cmd_rep(cmdtp
, flag
, argc
, argv
, repeatable
);
567 debug("Command failed, result=%d\n", result
);
571 enum command_ret_t
cmd_process(int flag
, int argc
, char * const argv
[],
572 int *repeatable
, ulong
*ticks
)
574 enum command_ret_t rc
= CMD_RET_SUCCESS
;
577 #if defined(CONFIG_SYS_XTRACE)
580 xtrace
= env_get("xtrace");
583 for (int i
= 0; i
< argc
; i
++) {
591 /* Look up command in command table */
592 cmdtp
= find_cmd(argv
[0]);
594 printf("Unknown command '%s' - try 'help'\n", argv
[0]);
598 /* found - check max args */
599 if (argc
> cmdtp
->maxargs
)
602 #if defined(CONFIG_CMD_BOOTD)
603 /* avoid "bootd" recursion */
604 else if (cmdtp
->cmd
== do_bootd
) {
605 if (flag
& CMD_FLAG_BOOTD
) {
606 puts("'bootd' recursion detected\n");
607 rc
= CMD_RET_FAILURE
;
609 flag
|= CMD_FLAG_BOOTD
;
614 /* If OK so far, then do the command */
619 *ticks
= get_timer(0);
620 rc
= cmd_call(cmdtp
, flag
, argc
, argv
, &newrep
);
622 *ticks
= get_timer(*ticks
);
623 *repeatable
&= newrep
;
625 if (rc
== CMD_RET_USAGE
)
626 rc
= cmd_usage(cmdtp
);
630 int cmd_process_error(cmd_tbl_t
*cmdtp
, int err
)
632 if (err
== CMD_RET_USAGE
)
633 return CMD_RET_USAGE
;
636 printf("Command '%s' failed: Error %d\n", cmdtp
->name
, err
);
637 return CMD_RET_FAILURE
;
640 return CMD_RET_SUCCESS
;