[u-boot.git] / common / command.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2000-2009
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 */

/*
 *  Command Processor Table
 */

#include <common.h>
#include <compiler.h>
#include <command.h>
#include <console.h>
#include <env.h>
#include <log.h>
#include <asm/global_data.h>
#include <linux/ctype.h>

DECLARE_GLOBAL_DATA_PTR;

/*
 * Use puts() instead of printf() to avoid printf buffer overflow
 * for long help messages
 */

int _do_help(struct cmd_tbl *cmd_start, int cmd_items, struct cmd_tbl *cmdtp,
	     int flag, int argc, char *const argv[])
{
	int i;
	int rcode = 0;

	if (argc == 1) {	/* show list of commands */
		struct cmd_tbl *cmd_array[cmd_items];
		int i, j, swaps;

		/* Make array of commands from .uboot_cmd section */
		cmdtp = cmd_start;
		for (i = 0; i < cmd_items; i++) {
			cmd_array[i] = cmdtp++;
		}

		/* Sort command list (trivial bubble sort) */
		for (i = cmd_items - 1; i > 0; --i) {
			swaps = 0;
			for (j = 0; j < i; ++j) {
				if (strcmp(cmd_array[j]->name,
					   cmd_array[j + 1]->name) > 0) {
					struct cmd_tbl *tmp;
					tmp = cmd_array[j];
					cmd_array[j] = cmd_array[j + 1];
					cmd_array[j + 1] = tmp;
					++swaps;
				}
			}
			if (!swaps)
				break;
		}

		/* print short help (usage) */
		for (i = 0; i < cmd_items; i++) {
			const char *usage = cmd_array[i]->usage;

			/* allow user abort */
			if (ctrlc())
				return 1;
			if (usage == NULL)
				continue;
			printf("%-*s- %s\n", CONFIG_SYS_HELP_CMD_WIDTH,
			       cmd_array[i]->name, usage);
		}
		return 0;
	}
	/*
	 * command help (long version)
	 */
	for (i = 1; i < argc; ++i) {
		cmdtp = find_cmd_tbl(argv[i], cmd_start, cmd_items);
		if (cmdtp != NULL) {
			rcode |= cmd_usage(cmdtp);
		} else {
			printf("Unknown command '%s' - try 'help' without arguments for list of all known commands\n\n",
			       argv[i]);
			rcode = 1;
		}
	}
	return rcode;
}

/* find command table entry for a command */
struct cmd_tbl *find_cmd_tbl(const char *cmd, struct cmd_tbl *table,
			     int table_len)
{
#ifdef CONFIG_CMDLINE
	struct cmd_tbl *cmdtp;
	struct cmd_tbl *cmdtp_temp = table;	/* Init value */
	const char *p;
	int len;
	int n_found = 0;

	if (!cmd)
		return NULL;
	/*
	 * Some commands allow length modifiers (like "cp.b");
	 * compare command name only until first dot.
	 */
	len = ((p = strchr(cmd, '.')) == NULL) ? strlen (cmd) : (p - cmd);

	for (cmdtp = table; cmdtp != table + table_len; cmdtp++) {
		if (strncmp(cmd, cmdtp->name, len) == 0) {
			if (len == strlen(cmdtp->name))
				return cmdtp;	/* full match */

			cmdtp_temp = cmdtp;	/* abbreviated command ? */
			n_found++;
		}
	}
	if (n_found == 1) {			/* exactly one match */
		return cmdtp_temp;
	}
#endif /* CONFIG_CMDLINE */

	return NULL;	/* not found or ambiguous command */
}

struct cmd_tbl *find_cmd(const char *cmd)
{
	struct cmd_tbl *start = ll_entry_start(struct cmd_tbl, cmd);
	const int len = ll_entry_count(struct cmd_tbl, cmd);
	return find_cmd_tbl(cmd, start, len);
}

int cmd_usage(const struct cmd_tbl *cmdtp)
{
	printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);

#ifdef	CONFIG_SYS_LONGHELP
	printf("Usage:\n%s ", cmdtp->name);

	if (!cmdtp->help) {
		puts ("- No additional help available.\n");
		return 1;
	}

	puts(cmdtp->help);
	putc('\n');
#endif	/* CONFIG_SYS_LONGHELP */
	return 1;
}

#ifdef CONFIG_AUTO_COMPLETE
static char env_complete_buf[512];

int var_complete(int argc, char *const argv[], char last_char, int maxv,
		 char *cmdv[])
{
	int space;

	space = last_char == '\0' || isblank(last_char);

	if (space && argc == 1)
		return env_complete("", maxv, cmdv, sizeof(env_complete_buf),
				    env_complete_buf, false);

	if (!space && argc == 2)
		return env_complete(argv[1], maxv, cmdv,
				    sizeof(env_complete_buf),
				    env_complete_buf, false);

	return 0;
}

static int dollar_complete(int argc, char *const argv[], char last_char,
			   int maxv, char *cmdv[])
{
	/* Make sure the last argument starts with a $. */
	if (argc < 1 || argv[argc - 1][0] != '$' ||
	    last_char == '\0' || isblank(last_char))
		return 0;

	return env_complete(argv[argc - 1], maxv, cmdv, sizeof(env_complete_buf),
			    env_complete_buf, true);
}

/*************************************************************************************/

int complete_subcmdv(struct cmd_tbl *cmdtp, int count, int argc,
		     char *const argv[], char last_char,
		     int maxv, char *cmdv[])
{
#ifdef CONFIG_CMDLINE
	const struct cmd_tbl *cmdend = cmdtp + count;
	const char *p;
	int len, clen;
	int n_found = 0;
	const char *cmd;

	/* sanity? */
	if (maxv < 2)
		return -2;

	cmdv[0] = NULL;

	if (argc == 0) {
		/* output full list of commands */
		for (; cmdtp != cmdend; cmdtp++) {
			if (n_found >= maxv - 2) {
				cmdv[n_found++] = "...";
				break;
			}
			cmdv[n_found++] = cmdtp->name;
		}
		cmdv[n_found] = NULL;
		return n_found;
	}

	/* more than one arg or one but the start of the next */
	if (argc > 1 || last_char == '\0' || isblank(last_char)) {
		cmdtp = find_cmd_tbl(argv[0], cmdtp, count);
		if (cmdtp == NULL || cmdtp->complete == NULL) {
			cmdv[0] = NULL;
			return 0;
		}
		return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
	}

	cmd = argv[0];
	/*
	 * Some commands allow length modifiers (like "cp.b");
	 * compare command name only until first dot.
	 */
	p = strchr(cmd, '.');
	if (p == NULL)
		len = strlen(cmd);
	else
		len = p - cmd;

	/* return the partial matches */
	for (; cmdtp != cmdend; cmdtp++) {

		clen = strlen(cmdtp->name);
		if (clen < len)
			continue;

		if (memcmp(cmd, cmdtp->name, len) != 0)
			continue;

		/* too many! */
		if (n_found >= maxv - 2) {
			cmdv[n_found++] = "...";
			break;
		}

		cmdv[n_found++] = cmdtp->name;
	}

	cmdv[n_found] = NULL;
	return n_found;
#else
	return 0;
#endif
}

static int complete_cmdv(int argc, char *const argv[], char last_char,
			 int maxv, char *cmdv[])
{
#ifdef CONFIG_CMDLINE
	return complete_subcmdv(ll_entry_start(struct cmd_tbl, cmd),
				ll_entry_count(struct cmd_tbl, cmd), argc, argv,
				last_char, maxv, cmdv);
#else
	return 0;
#endif
}

static int make_argv(char *s, int argvsz, char *argv[])
{
	int argc = 0;

	/* split into argv */
	while (argc < argvsz - 1) {

		/* skip any white space */
		while (isblank(*s))
			++s;

		if (*s == '\0')	/* end of s, no more args	*/
			break;

		argv[argc++] = s;	/* begin of argument string	*/

		/* find end of string */
		while (*s && !isblank(*s))
			++s;

		if (*s == '\0')		/* end of s, no more args	*/
			break;

		*s++ = '\0';		/* terminate current arg	 */
	}
	argv[argc] = NULL;

	return argc;
}

static void print_argv(const char *banner, const char *leader, const char *sep,
		       int linemax, char *const argv[])
{
	int ll = leader != NULL ? strlen(leader) : 0;
	int sl = sep != NULL ? strlen(sep) : 0;
	int len, i;

	if (banner) {
		puts("\n");
		puts(banner);
	}

	i = linemax;	/* force leader and newline */
	while (*argv != NULL) {
		len = strlen(*argv) + sl;
		if (i + len >= linemax) {
			puts("\n");
			if (leader)
				puts(leader);
			i = ll - sl;
		} else if (sep)
			puts(sep);
		puts(*argv++);
		i += len;
	}
	printf("\n");
}

static int find_common_prefix(char *const argv[])
{
	int i, len;
	char *anchor, *s, *t;

	if (*argv == NULL)
		return 0;

	/* begin with max */
	anchor = *argv++;
	len = strlen(anchor);
	while ((t = *argv++) != NULL) {
		s = anchor;
		for (i = 0; i < len; i++, t++, s++) {
			if (*t != *s)
				break;
		}
		len = s - anchor;
	}
	return len;
}

static char tmp_buf[CONFIG_SYS_CBSIZE + 1];	/* copy of console I/O buffer */

int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
{
	int n = *np, col = *colp;
	char *argv[CONFIG_SYS_MAXARGS + 1];		/* NULL terminated	*/
	char *cmdv[20];
	char *s, *t;
	const char *sep;
	int i, j, k, len, seplen, argc;
	int cnt;
	char last_char;
#ifdef CONFIG_CMDLINE_PS_SUPPORT
	const char *ps_prompt = env_get("PS1");
#else
	const char *ps_prompt = CONFIG_SYS_PROMPT;
#endif

	if (strcmp(prompt, ps_prompt) != 0)
		return 0;	/* not in normal console */

	cnt = strlen(buf);
	if (cnt >= 1)
		last_char = buf[cnt - 1];
	else
		last_char = '\0';

	/* copy to secondary buffer which will be affected */
	strcpy(tmp_buf, buf);

	/* separate into argv */
	argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);

	/* first try a $ completion */
	i = dollar_complete(argc, argv, last_char,
			    sizeof(cmdv) / sizeof(cmdv[0]), cmdv);
	if (!i) {
		/* do the completion and return the possible completions */
		i = complete_cmdv(argc, argv, last_char,
				  sizeof(cmdv) / sizeof(cmdv[0]), cmdv);
	}

	/* no match; bell and out */
	if (i == 0) {
		if (argc > 1)	/* allow tab for non command */
			return 0;
		putc('\a');
		return 1;
	}

	s = NULL;
	len = 0;
	sep = NULL;
	seplen = 0;
	if (i == 1) { /* one match; perfect */
		if (last_char != '\0' && !isblank(last_char))
			k = strlen(argv[argc - 1]);
		else
			k = 0;

		s = cmdv[0] + k;
		len = strlen(s);
		sep = " ";
		seplen = 1;
	} else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
		if (last_char != '\0' && !isblank(last_char))
			k = strlen(argv[argc - 1]);
		else
			k = 0;

		j -= k;
		if (j > 0) {
			s = cmdv[0] + k;
			len = j;
		}
	}

	if (s != NULL) {
		k = len + seplen;
		/* make sure it fits */
		if (n + k >= CONFIG_SYS_CBSIZE - 2) {
			putc('\a');
			return 1;
		}

		t = buf + cnt;
		for (i = 0; i < len; i++)
			*t++ = *s++;
		if (sep != NULL)
			for (i = 0; i < seplen; i++)
				*t++ = sep[i];
		*t = '\0';
		n += k;
		col += k;
		puts(t - k);
		if (sep == NULL)
			putc('\a');
		*np = n;
		*colp = col;
	} else {
		print_argv(NULL, "  ", " ", 78, cmdv);

		puts(prompt);
		puts(buf);
	}
	return 1;
}

#endif

#ifdef CMD_DATA_SIZE
int cmd_get_data_size(char* arg, int default_size)
{
	/* Check for a size specification .b, .w or .l.
	 */
	int len = strlen(arg);
	if (len > 2 && arg[len-2] == '.') {
		switch (arg[len-1]) {
		case 'b':
			return 1;
		case 'w':
			return 2;
		case 'l':
			return 4;
		case 's':
			return CMD_DATA_SIZE_STR;
		case 'q':
			if (MEM_SUPPORT_64BIT_DATA)
				return 8;
			/* no break */
		default:
			return CMD_DATA_SIZE_ERR;
		}
	}
	return default_size;
}
#endif

void fixup_cmdtable(struct cmd_tbl *cmdtp, int size)
{
	int	i;

	if (gd->reloc_off == 0)
		return;

	for (i = 0; i < size; i++) {
		ulong addr;

		addr = (ulong)(cmdtp->cmd_rep) + gd->reloc_off;
		cmdtp->cmd_rep =
			(int (*)(struct cmd_tbl *, int, int,
				 char * const [], int *))addr;

		addr = (ulong)(cmdtp->cmd) + gd->reloc_off;
#ifdef DEBUG_COMMANDS
		printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
		       cmdtp->name, (ulong)(cmdtp->cmd), addr);
#endif
		cmdtp->cmd = (int (*)(struct cmd_tbl *, int, int,
				      char *const []))addr;
		addr = (ulong)(cmdtp->name) + gd->reloc_off;
		cmdtp->name = (char *)addr;
		if (cmdtp->usage) {
			addr = (ulong)(cmdtp->usage) + gd->reloc_off;
			cmdtp->usage = (char *)addr;
		}
#ifdef	CONFIG_SYS_LONGHELP
		if (cmdtp->help) {
			addr = (ulong)(cmdtp->help) + gd->reloc_off;
			cmdtp->help = (char *)addr;
		}
#endif
#ifdef CONFIG_AUTO_COMPLETE
		if (cmdtp->complete) {
			addr = (ulong)(cmdtp->complete) + gd->reloc_off;
			cmdtp->complete =
				(int (*)(int, char * const [], char, int, char * []))addr;
		}
#endif
		cmdtp++;
	}
}

int cmd_always_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
			  char *const argv[], int *repeatable)
{
	*repeatable = 1;

	return cmdtp->cmd(cmdtp, flag, argc, argv);
}

int cmd_never_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
			 char *const argv[], int *repeatable)
{
	*repeatable = 0;

	return cmdtp->cmd(cmdtp, flag, argc, argv);
}

int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
			   char *const argv[])
{
	int repeatable;

	return cmdtp->cmd_rep(cmdtp, flag, argc, argv, &repeatable);
}

/**
 * Call a command function. This should be the only route in U-Boot to call
 * a command, so that we can track whether we are waiting for input or
 * executing a command.
 *
 * @param cmdtp		Pointer to the command to execute
 * @param flag		Some flags normally 0 (see CMD_FLAG_.. above)
 * @param argc		Number of arguments (arg 0 must be the command text)
 * @param argv		Arguments
 * @param repeatable	Can the command be repeated
 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
 */
static int cmd_call(struct cmd_tbl *cmdtp, int flag, int argc,
		    char *const argv[], int *repeatable)
{
	int result;

	result = cmdtp->cmd_rep(cmdtp, flag, argc, argv, repeatable);
	if (result)
		debug("Command failed, result=%d\n", result);
	return result;
}

enum command_ret_t cmd_process(int flag, int argc, char *const argv[],
			       int *repeatable, ulong *ticks)
{
	enum command_ret_t rc = CMD_RET_SUCCESS;
	struct cmd_tbl *cmdtp;

#if defined(CONFIG_SYS_XTRACE)
	char *xtrace;

	xtrace = env_get("xtrace");
	if (xtrace) {
		puts("+");
		for (int i = 0; i < argc; i++) {
			puts(" ");
			puts(argv[i]);
		}
		puts("\n");
	}
#endif

	/* Look up command in command table */
	cmdtp = find_cmd(argv[0]);
	if (cmdtp == NULL) {
		printf("Unknown command '%s' - try 'help'\n", argv[0]);
		return 1;
	}

	/* found - check max args */
	if (argc > cmdtp->maxargs)
		rc = CMD_RET_USAGE;

#if defined(CONFIG_CMD_BOOTD)
	/* avoid "bootd" recursion */
	else if (cmdtp->cmd == do_bootd) {
		if (flag & CMD_FLAG_BOOTD) {
			puts("'bootd' recursion detected\n");
			rc = CMD_RET_FAILURE;
		} else {
			flag |= CMD_FLAG_BOOTD;
		}
	}
#endif

	/* If OK so far, then do the command */
	if (!rc) {
		int newrep;

		if (ticks)
			*ticks = get_timer(0);
		rc = cmd_call(cmdtp, flag, argc, argv, &newrep);
		if (ticks)
			*ticks = get_timer(*ticks);
		*repeatable &= newrep;
	}
	if (rc == CMD_RET_USAGE)
		rc = cmd_usage(cmdtp);
	return rc;
}

int cmd_process_error(struct cmd_tbl *cmdtp, int err)
{
	if (err == CMD_RET_USAGE)
		return CMD_RET_USAGE;

	if (err) {
		printf("Command '%s' failed: Error %d\n", cmdtp->name, err);
		return CMD_RET_FAILURE;
	}

	return CMD_RET_SUCCESS;
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
5dfa25f2	2	/*
2dce551e	3	* (C) Copyright 2000-2009
5dfa25f2	4	* Wolfgang Denk, DENX Software Engineering, [email protected].
5dfa25f2 WD	5	*/
	6
	7	/*
	8	* Command Processor Table
	9	*/
	10
	11	#include <common.h>
a33a8242	12	#include <compiler.h>
5dfa25f2	13	#include <command.h>
24b852a7	14	#include <console.h>
af95f206	15	#include <env.h>
f7ae49fc	16	#include <log.h>
401d1c4f	17	#include <asm/global_data.h>
4d91a6ec	18	#include <linux/ctype.h>
5dfa25f2	19
7cf5b405 HS	20	DECLARE_GLOBAL_DATA_PTR;
7cf5b405 HS	21
5dfa25f2 WD	22	/*
	23	* Use puts() instead of printf() to avoid printf buffer overflow
	24	* for long help messages
	25	*/
2dce551e	26
09140113 SG	27	int _do_help(struct cmd_tbl cmd_start, int cmd_items, struct cmd_tbl cmdtp,
09140113 SG	28	int flag, int argc, char *const argv[])
5dfa25f2 WD	29	{
	30	int i;
	31	int rcode = 0;
	32
616e2162	33	if (argc == 1) { /* show list of commands */
09140113	34	struct cmd_tbl *cmd_array[cmd_items];
9d2b18a0 WD	35	int i, j, swaps;
	36
	37	/* Make array of commands from .uboot_cmd section */
2dce551e	38	cmdtp = cmd_start;
9d2b18a0 WD	39	for (i = 0; i < cmd_items; i++) {
9d2b18a0 WD	40	cmd_array[i] = cmdtp++;
8bde7f77	41	}
8bde7f77	42
9d2b18a0 WD	43	/* Sort command list (trivial bubble sort) */
	44	for (i = cmd_items - 1; i > 0; --i) {
	45	swaps = 0;
	46	for (j = 0; j < i; ++j) {
616e2162 MY	47	if (strcmp(cmd_array[j]->name,
616e2162 MY	48	cmd_array[j + 1]->name) > 0) {
09140113	49	struct cmd_tbl *tmp;
9d2b18a0 WD	50	tmp = cmd_array[j];
	51	cmd_array[j] = cmd_array[j + 1];
	52	cmd_array[j + 1] = tmp;
	53	++swaps;
	54	}
8bde7f77	55	}
9d2b18a0 WD	56	if (!swaps)
9d2b18a0 WD	57	break;
8bde7f77	58	}
5dfa25f2	59
8bde7f77	60	/* print short help (usage) */
9d2b18a0 WD	61	for (i = 0; i < cmd_items; i++) {
	62	const char *usage = cmd_array[i]->usage;
	63
5dfa25f2	64	/* allow user abort */
616e2162	65	if (ctrlc())
5dfa25f2	66	return 1;
9d2b18a0	67	if (usage == NULL)
5dfa25f2	68	continue;
2fb2604d PT	69	printf("%-*s- %s\n", CONFIG_SYS_HELP_CMD_WIDTH,
2fb2604d PT	70	cmd_array[i]->name, usage);
5dfa25f2	71	}
5dfa25f2 WD	72	return 0;
5dfa25f2 WD	73	}
5dfa25f2 WD	74	/*
	75	* command help (long version)
	76	*/
8bde7f77	77	for (i = 1; i < argc; ++i) {
616e2162 MY	78	cmdtp = find_cmd_tbl(argv[i], cmd_start, cmd_items);
616e2162 MY	79	if (cmdtp != NULL) {
94796d85	80	rcode \|= cmd_usage(cmdtp);
71f95118	81	} else {
616e2162 MY	82	printf("Unknown command '%s' - try 'help' without arguments for list of all known commands\n\n",
616e2162 MY	83	argv[i]);
5dfa25f2 WD	84	rcode = 1;
	85	}
	86	}
	87	return rcode;
	88	}
	89
616e2162	90	/* find command table entry for a command */
09140113 SG	91	struct cmd_tbl find_cmd_tbl(const char cmd, struct cmd_tbl *table,
09140113 SG	92	int table_len)
5dfa25f2	93	{
f8bb6964	94	#ifdef CONFIG_CMDLINE
09140113 SG	95	struct cmd_tbl *cmdtp;
09140113 SG	96	struct cmd_tbl cmdtp_temp = table; / Init value */
9d2b18a0 WD	97	const char *p;
	98	int len;
	99	int n_found = 0;
	100
7013c061 TW	101	if (!cmd)
7013c061 TW	102	return NULL;
9d2b18a0 WD	103	/*
	104	* Some commands allow length modifiers (like "cp.b");
	105	* compare command name only until first dot.
	106	*/
	107	len = ((p = strchr(cmd, '.')) == NULL) ? strlen (cmd) : (p - cmd);
	108
616e2162 MY	109	for (cmdtp = table; cmdtp != table + table_len; cmdtp++) {
	110	if (strncmp(cmd, cmdtp->name, len) == 0) {
	111	if (len == strlen(cmdtp->name))
9d2b18a0 WD	112	return cmdtp; /* full match */
	113
	114	cmdtp_temp = cmdtp; /* abbreviated command ? */
	115	n_found++;
	116	}
5dfa25f2	117	}
9d2b18a0	118	if (n_found == 1) { /* exactly one match */
8bde7f77	119	return cmdtp_temp;
9d2b18a0	120	}
f8bb6964	121	#endif /* CONFIG_CMDLINE */
5dfa25f2	122
9d2b18a0	123	return NULL; /* not found or ambiguous command */
8bde7f77	124	}
04a85b3b	125
09140113	126	struct cmd_tbl find_cmd(const char cmd)
b799cb4c	127	{
09140113 SG	128	struct cmd_tbl *start = ll_entry_start(struct cmd_tbl, cmd);
09140113 SG	129	const int len = ll_entry_count(struct cmd_tbl, cmd);
6c7c946c	130	return find_cmd_tbl(cmd, start, len);
b799cb4c KG	131	}
b799cb4c KG	132
09140113	133	int cmd_usage(const struct cmd_tbl *cmdtp)
62c3ae7c	134	{
94796d85 WD	135	printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
	136
	137	#ifdef CONFIG_SYS_LONGHELP
	138	printf("Usage:\n%s ", cmdtp->name);
	139
	140	if (!cmdtp->help) {
	141	puts ("- No additional help available.\n");
	142	return 1;
	143	}
	144
616e2162 MY	145	puts(cmdtp->help);
616e2162 MY	146	putc('\n');
94796d85	147	#endif /* CONFIG_SYS_LONGHELP */
47e26b1b	148	return 1;
62c3ae7c PT	149	}
62c3ae7c PT	150
04a85b3b	151	#ifdef CONFIG_AUTO_COMPLETE
03dcf17d	152	static char env_complete_buf[512];
04a85b3b	153
09140113 SG	154	int var_complete(int argc, char *const argv[], char last_char, int maxv,
09140113 SG	155	char *cmdv[])
04a85b3b	156	{
04a85b3b WD	157	int space;
04a85b3b WD	158
4d91a6ec	159	space = last_char == '\0' \|\| isblank(last_char);
04a85b3b WD	160
04a85b3b WD	161	if (space && argc == 1)
03dcf17d BB	162	return env_complete("", maxv, cmdv, sizeof(env_complete_buf),
03dcf17d BB	163	env_complete_buf, false);
04a85b3b WD	164
04a85b3b WD	165	if (!space && argc == 2)
03dcf17d BB	166	return env_complete(argv[1], maxv, cmdv,
	167	sizeof(env_complete_buf),
	168	env_complete_buf, false);
560d424b	169
04a85b3b WD	170	return 0;
	171	}
	172
09140113	173	static int dollar_complete(int argc, char *const argv[], char last_char,
03dcf17d BB	174	int maxv, char *cmdv[])
	175	{
	176	/* Make sure the last argument starts with a $. */
	177	if (argc < 1 \|\| argv[argc - 1][0] != '$' \|\|
	178	last_char == '\0' \|\| isblank(last_char))
	179	return 0;
	180
	181	return env_complete(argv[argc - 1], maxv, cmdv, sizeof(env_complete_buf),
	182	env_complete_buf, true);
	183	}
	184
04a85b3b WD	185	/*************************************************************************************/
04a85b3b WD	186
09140113 SG	187	int complete_subcmdv(struct cmd_tbl *cmdtp, int count, int argc,
09140113 SG	188	char *const argv[], char last_char,
6fb61445	189	int maxv, char *cmdv[])
04a85b3b	190	{
f8bb6964	191	#ifdef CONFIG_CMDLINE
09140113	192	const struct cmd_tbl *cmdend = cmdtp + count;
04a85b3b WD	193	const char *p;
	194	int len, clen;
	195	int n_found = 0;
	196	const char *cmd;
	197
	198	/* sanity? */
	199	if (maxv < 2)
	200	return -2;
	201
	202	cmdv[0] = NULL;
	203
	204	if (argc == 0) {
	205	/* output full list of commands */
6c7c946c	206	for (; cmdtp != cmdend; cmdtp++) {
04a85b3b	207	if (n_found >= maxv - 2) {
9b438946	208	cmdv[n_found++] = "...";
04a85b3b WD	209	break;
04a85b3b WD	210	}
9b438946	211	cmdv[n_found++] = cmdtp->name;
04a85b3b WD	212	}
	213	cmdv[n_found] = NULL;
	214	return n_found;
	215	}
	216
	217	/* more than one arg or one but the start of the next */
616e2162	218	if (argc > 1 \|\| last_char == '\0' \|\| isblank(last_char)) {
6fb61445	219	cmdtp = find_cmd_tbl(argv[0], cmdtp, count);
04a85b3b WD	220	if (cmdtp == NULL \|\| cmdtp->complete == NULL) {
	221	cmdv[0] = NULL;
	222	return 0;
	223	}
	224	return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
	225	}
	226
	227	cmd = argv[0];
	228	/*
	229	* Some commands allow length modifiers (like "cp.b");
	230	* compare command name only until first dot.
	231	*/
	232	p = strchr(cmd, '.');
	233	if (p == NULL)
	234	len = strlen(cmd);
	235	else
	236	len = p - cmd;
	237
	238	/* return the partial matches */
6c7c946c	239	for (; cmdtp != cmdend; cmdtp++) {
04a85b3b WD	240
	241	clen = strlen(cmdtp->name);
	242	if (clen < len)
	243	continue;
	244
	245	if (memcmp(cmd, cmdtp->name, len) != 0)
	246	continue;
	247
	248	/* too many! */
	249	if (n_found >= maxv - 2) {
	250	cmdv[n_found++] = "...";
	251	break;
	252	}
	253
	254	cmdv[n_found++] = cmdtp->name;
	255	}
	256
	257	cmdv[n_found] = NULL;
	258	return n_found;
f8bb6964 SG	259	#else
	260	return 0;
	261	#endif
04a85b3b WD	262	}
04a85b3b WD	263
09140113	264	static int complete_cmdv(int argc, char *const argv[], char last_char,
6fb61445 BB	265	int maxv, char *cmdv[])
	266	{
	267	#ifdef CONFIG_CMDLINE
09140113 SG	268	return complete_subcmdv(ll_entry_start(struct cmd_tbl, cmd),
09140113 SG	269	ll_entry_count(struct cmd_tbl, cmd), argc, argv,
6fb61445 BB	270	last_char, maxv, cmdv);
	271	#else
	272	return 0;
	273	#endif
	274	}
	275
04a85b3b WD	276	static int make_argv(char s, int argvsz, char argv[])
	277	{
	278	int argc = 0;
	279
	280	/* split into argv */
	281	while (argc < argvsz - 1) {
	282
	283	/* skip any white space */
4d91a6ec	284	while (isblank(*s))
04a85b3b WD	285	++s;
04a85b3b WD	286
53677ef1	287	if (s == '\0') / end of s, no more args */
04a85b3b WD	288	break;
	289
	290	argv[argc++] = s; /* begin of argument string */
	291
	292	/* find end of string */
4d91a6ec	293	while (s && !isblank(s))
04a85b3b WD	294	++s;
	295
	296	if (s == '\0') / end of s, no more args */
	297	break;
	298
	299	s++ = '\0'; / terminate current arg */
	300	}
	301	argv[argc] = NULL;
	302
	303	return argc;
	304	}
	305
09140113 SG	306	static void print_argv(const char banner, const char leader, const char *sep,
09140113 SG	307	int linemax, char *const argv[])
04a85b3b WD	308	{
	309	int ll = leader != NULL ? strlen(leader) : 0;
	310	int sl = sep != NULL ? strlen(sep) : 0;
	311	int len, i;
	312
	313	if (banner) {
	314	puts("\n");
	315	puts(banner);
	316	}
	317
	318	i = linemax; /* force leader and newline */
	319	while (*argv != NULL) {
	320	len = strlen(*argv) + sl;
	321	if (i + len >= linemax) {
	322	puts("\n");
	323	if (leader)
	324	puts(leader);
	325	i = ll - sl;
	326	} else if (sep)
	327	puts(sep);
	328	puts(*argv++);
	329	i += len;
	330	}
	331	printf("\n");
	332	}
	333
09140113	334	static int find_common_prefix(char *const argv[])
04a85b3b WD	335	{
	336	int i, len;
	337	char anchor, s, *t;
	338
	339	if (*argv == NULL)
	340	return 0;
	341
	342	/* begin with max */
	343	anchor = *argv++;
	344	len = strlen(anchor);
	345	while ((t = *argv++) != NULL) {
	346	s = anchor;
	347	for (i = 0; i < len; i++, t++, s++) {
	348	if (t != s)
	349	break;
	350	}
	351	len = s - anchor;
	352	}
	353	return len;
	354	}
	355
2614a208	356	static char tmp_buf[CONFIG_SYS_CBSIZE + 1]; /* copy of console I/O buffer */
04a85b3b WD	357
	358	int cmd_auto_complete(const char const prompt, char buf, int np, int colp)
	359	{
	360	int n = np, col = colp;
6d0f6bcf	361	char argv[CONFIG_SYS_MAXARGS + 1]; / NULL terminated */
04a85b3b WD	362	char *cmdv[20];
	363	char s, t;
	364	const char *sep;
	365	int i, j, k, len, seplen, argc;
	366	int cnt;
	367	char last_char;
4225f830 MV	368	#ifdef CONFIG_CMDLINE_PS_SUPPORT
	369	const char *ps_prompt = env_get("PS1");
	370	#else
	371	const char *ps_prompt = CONFIG_SYS_PROMPT;
	372	#endif
04a85b3b	373
4225f830	374	if (strcmp(prompt, ps_prompt) != 0)
04a85b3b WD	375	return 0; /* not in normal console */
	376
	377	cnt = strlen(buf);
	378	if (cnt >= 1)
	379	last_char = buf[cnt - 1];
	380	else
	381	last_char = '\0';
	382
	383	/* copy to secondary buffer which will be affected */
	384	strcpy(tmp_buf, buf);
	385
	386	/* separate into argv */
	387	argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
	388
03dcf17d BB	389	/* first try a $ completion */
	390	i = dollar_complete(argc, argv, last_char,
	391	sizeof(cmdv) / sizeof(cmdv[0]), cmdv);
	392	if (!i) {
	393	/* do the completion and return the possible completions */
	394	i = complete_cmdv(argc, argv, last_char,
	395	sizeof(cmdv) / sizeof(cmdv[0]), cmdv);
	396	}
04a85b3b WD	397
	398	/* no match; bell and out */
	399	if (i == 0) {
	400	if (argc > 1) /* allow tab for non command */
	401	return 0;
	402	putc('\a');
	403	return 1;
	404	}
	405
	406	s = NULL;
	407	len = 0;
	408	sep = NULL;
	409	seplen = 0;
	410	if (i == 1) { /* one match; perfect */
cbe07ebe BB	411	if (last_char != '\0' && !isblank(last_char))
	412	k = strlen(argv[argc - 1]);
	413	else
	414	k = 0;
	415
04a85b3b WD	416	s = cmdv[0] + k;
	417	len = strlen(s);
	418	sep = " ";
	419	seplen = 1;
616e2162	420	} else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
cbe07ebe BB	421	if (last_char != '\0' && !isblank(last_char))
	422	k = strlen(argv[argc - 1]);
	423	else
	424	k = 0;
	425
04a85b3b WD	426	j -= k;
	427	if (j > 0) {
	428	s = cmdv[0] + k;
	429	len = j;
	430	}
	431	}
	432
	433	if (s != NULL) {
	434	k = len + seplen;
	435	/* make sure it fits */
6d0f6bcf	436	if (n + k >= CONFIG_SYS_CBSIZE - 2) {
04a85b3b WD	437	putc('\a');
	438	return 1;
	439	}
	440
	441	t = buf + cnt;
	442	for (i = 0; i < len; i++)
	443	t++ = s++;
	444	if (sep != NULL)
	445	for (i = 0; i < seplen; i++)
	446	*t++ = sep[i];
	447	*t = '\0';
	448	n += k;
	449	col += k;
	450	puts(t - k);
	451	if (sep == NULL)
	452	putc('\a');
	453	*np = n;
	454	*colp = col;
	455	} else {
	456	print_argv(NULL, " ", " ", 78, cmdv);
	457
	458	puts(prompt);
	459	puts(buf);
	460	}
	461	return 1;
	462	}
	463
	464	#endif
8a40fb14 JCPV	465
	466	#ifdef CMD_DATA_SIZE
	467	int cmd_get_data_size(char* arg, int default_size)
	468	{
	469	/* Check for a size specification .b, .w or .l.
	470	*/
	471	int len = strlen(arg);
	472	if (len > 2 && arg[len-2] == '.') {
616e2162	473	switch (arg[len-1]) {
8a40fb14 JCPV	474	case 'b':
	475	return 1;
	476	case 'w':
	477	return 2;
	478	case 'l':
	479	return 4;
	480	case 's':
7526deec	481	return CMD_DATA_SIZE_STR;
a33a8242 SG	482	case 'q':
	483	if (MEM_SUPPORT_64BIT_DATA)
	484	return 8;
	485	/* no break */
8a40fb14	486	default:
7526deec	487	return CMD_DATA_SIZE_ERR;
8a40fb14 JCPV	488	}
	489	}
	490	return default_size;
	491	}
	492	#endif
620f1f6a	493
09140113	494	void fixup_cmdtable(struct cmd_tbl *cmdtp, int size)
620f1f6a HS	495	{
	496	int i;
	497
	498	if (gd->reloc_off == 0)
	499	return;
	500
	501	for (i = 0; i < size; i++) {
	502	ulong addr;
	503
6f94daf9 MS	504	addr = (ulong)(cmdtp->cmd_rep) + gd->reloc_off;
6f94daf9 MS	505	cmdtp->cmd_rep =
09140113	506	(int ()(struct cmd_tbl , int, int,
6f94daf9 MS	507	char * const [], int *))addr;
6f94daf9 MS	508
616e2162	509	addr = (ulong)(cmdtp->cmd) + gd->reloc_off;
2e88bb28	510	#ifdef DEBUG_COMMANDS
620f1f6a	511	printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
616e2162	512	cmdtp->name, (ulong)(cmdtp->cmd), addr);
620f1f6a	513	#endif
09140113 SG	514	cmdtp->cmd = (int ()(struct cmd_tbl , int, int,
09140113 SG	515	char *const []))addr;
620f1f6a HS	516	addr = (ulong)(cmdtp->name) + gd->reloc_off;
	517	cmdtp->name = (char *)addr;
	518	if (cmdtp->usage) {
	519	addr = (ulong)(cmdtp->usage) + gd->reloc_off;
	520	cmdtp->usage = (char *)addr;
	521	}
	522	#ifdef CONFIG_SYS_LONGHELP
	523	if (cmdtp->help) {
	524	addr = (ulong)(cmdtp->help) + gd->reloc_off;
	525	cmdtp->help = (char *)addr;
	526	}
fa28bd2e DS	527	#endif
	528	#ifdef CONFIG_AUTO_COMPLETE
	529	if (cmdtp->complete) {
	530	addr = (ulong)(cmdtp->complete) + gd->reloc_off;
3668d8fa DS	531	cmdtp->complete =
3668d8fa DS	532	(int ()(int, char const [], char, int, char * []))addr;
fa28bd2e	533	}
620f1f6a HS	534	#endif
	535	cmdtp++;
	536	}
	537	}
bdf8e34b	538
09140113 SG	539	int cmd_always_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	540	char const argv[], int repeatable)
80a48dd4 BB	541	{
	542	*repeatable = 1;
	543
	544	return cmdtp->cmd(cmdtp, flag, argc, argv);
	545	}
	546
09140113 SG	547	int cmd_never_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	548	char const argv[], int repeatable)
80a48dd4 BB	549	{
	550	*repeatable = 0;
	551
	552	return cmdtp->cmd(cmdtp, flag, argc, argv);
	553	}
	554
09140113 SG	555	int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	556	char *const argv[])
80a48dd4 BB	557	{
	558	int repeatable;
	559
	560	return cmdtp->cmd_rep(cmdtp, flag, argc, argv, &repeatable);
	561	}
	562
bdf8e34b SG	563	/**
	564	* Call a command function. This should be the only route in U-Boot to call
	565	* a command, so that we can track whether we are waiting for input or
	566	* executing a command.
	567	*
	568	* @param cmdtp Pointer to the command to execute
	569	* @param flag Some flags normally 0 (see CMD_FLAG_.. above)
	570	* @param argc Number of arguments (arg 0 must be the command text)
	571	* @param argv Arguments
80a48dd4	572	* @param repeatable Can the command be repeated
bdf8e34b SG	573	* @return 0 if command succeeded, else non-zero (CMD_RET_...)
bdf8e34b SG	574	*/
09140113 SG	575	static int cmd_call(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	576	char const argv[], int repeatable)
bdf8e34b SG	577	{
	578	int result;
	579
80a48dd4	580	result = cmdtp->cmd_rep(cmdtp, flag, argc, argv, repeatable);
bdf8e34b	581	if (result)
58b6ad68	582	debug("Command failed, result=%d\n", result);
bdf8e34b SG	583	return result;
bdf8e34b SG	584	}
9d12d5d4	585
09140113	586	enum command_ret_t cmd_process(int flag, int argc, char *const argv[],
34765e88	587	int repeatable, ulong ticks)
9d12d5d4 SG	588	{
9d12d5d4 SG	589	enum command_ret_t rc = CMD_RET_SUCCESS;
09140113	590	struct cmd_tbl *cmdtp;
9d12d5d4	591
7ae31fcc CM	592	#if defined(CONFIG_SYS_XTRACE)
	593	char *xtrace;
	594
	595	xtrace = env_get("xtrace");
	596	if (xtrace) {
	597	puts("+");
	598	for (int i = 0; i < argc; i++) {
	599	puts(" ");
	600	puts(argv[i]);
	601	}
	602	puts("\n");
	603	}
	604	#endif
	605
9d12d5d4 SG	606	/* Look up command in command table */
	607	cmdtp = find_cmd(argv[0]);
	608	if (cmdtp == NULL) {
	609	printf("Unknown command '%s' - try 'help'\n", argv[0]);
	610	return 1;
	611	}
	612
	613	/* found - check max args */
	614	if (argc > cmdtp->maxargs)
	615	rc = CMD_RET_USAGE;
	616
	617	#if defined(CONFIG_CMD_BOOTD)
	618	/* avoid "bootd" recursion */
	619	else if (cmdtp->cmd == do_bootd) {
	620	if (flag & CMD_FLAG_BOOTD) {
	621	puts("'bootd' recursion detected\n");
	622	rc = CMD_RET_FAILURE;
	623	} else {
	624	flag \|= CMD_FLAG_BOOTD;
	625	}
	626	}
	627	#endif
	628
	629	/* If OK so far, then do the command */
	630	if (!rc) {
80a48dd4 BB	631	int newrep;
80a48dd4 BB	632
34765e88 RG	633	if (ticks)
34765e88 RG	634	*ticks = get_timer(0);
80a48dd4	635	rc = cmd_call(cmdtp, flag, argc, argv, &newrep);
34765e88 RG	636	if (ticks)
34765e88 RG	637	ticks = get_timer(ticks);
80a48dd4	638	*repeatable &= newrep;
9d12d5d4 SG	639	}
	640	if (rc == CMD_RET_USAGE)
	641	rc = cmd_usage(cmdtp);
	642	return rc;
	643	}
16ff9902	644
09140113	645	int cmd_process_error(struct cmd_tbl *cmdtp, int err)
16ff9902	646	{
27eb7bce MS	647	if (err == CMD_RET_USAGE)
	648	return CMD_RET_USAGE;
	649
16ff9902 SG	650	if (err) {
16ff9902 SG	651	printf("Command '%s' failed: Error %d\n", cmdtp->name, err);
37233240	652	return CMD_RET_FAILURE;
16ff9902 SG	653	}
16ff9902 SG	654
37233240	655	return CMD_RET_SUCCESS;
16ff9902	656	}