[z180-stamp.git] / avr / command.c

/*
 * (C) Copyright 2014, 2016, 2018 Leo C. <erbl259-lmu@yahoo.de>
 *
 * (C) Copyright 2000-2009
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * SPDX-License-Identifier:	GPL-2.0
 */

/*
 *  Command Processor Table
 */

#include "command.h"
#include "common.h"
#include <ctype.h>
#include <setjmp.h>

#include "config.h"
#include "print-utils.h"
#include "con-utils.h"
#include "env.h"
#include "debug.h"

#define DEBUG_CMD	1	/* set to 1 to debug */

#define debug_cmd(fmt, args...)		                                              \
	debug_cond(DEBUG_CMD, fmt, ##args)


jmp_buf cmd_jbuf;


static void print_usage_line(const FLASH char *name, int width,
				const FLASH char *usage)
{
	width -= strlen_P(name);
	if (width < 0)
		width = 0;
	my_puts_P(name);
	print_blanks(width);
	my_puts_P(PSTR(" - "));
	my_puts_P(usage);
	my_puts_P(PSTR("\n"));
}

int strcmp_PP(const FLASH char *s1, const FLASH char *s2)
{
	unsigned char c1, c2;

	while ((c1 = *(const FLASH unsigned char *)s1++)
			== (c2 = *(const FLASH unsigned char *)s2++))
		if (c1 == 0)
			return 0;

	return c1 - c2;
}

int cmpstring_PP(const void *p1, const void *p2)
{
	return strcmp_PP((*(const FLASH cmd_tbl_t **) p1)->name,
		         (*(const FLASH cmd_tbl_t **) p2)->name);
}

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

int cmd_tbl_item_count(cmd_tbl_t *p)
{
	int count = 0;

	while (p->name != NULL) {
		if (p->subcmd) {
			cmd_tbl_t *sub = p->subcmd;
			while (sub->name != NULL) {
				if (sub->flags & CTBL_SUBCMDAUTO)
					count++;
				sub++;
			}
		}
		if ((p->flags & CTBL_SUBCMDAUTO) == 0)
			count++;
		p++;
	}
	return count;
}


cmd_tbl_t *get_cmd_tbl_base(cmd_tbl_t  *cmdtp)
{
	cmd_tbl_t *p = cmdtp;

	while (p->name != NULL)
		++p;

	return p->subcmd;
}

/*
 * find command table entry for a command
 */
typedef struct {
		size_t len;
		uint_fast8_t level;
		bool opt_debug;
	} find_cmd_para_t;

cmd_tbl_t *_find_cmd (const char *cmd, cmd_tbl_t *table, find_cmd_para_t *para)
{
	cmd_tbl_t *cmdtp_ret = NULL;
	uint_fast8_t n_found = 0, sub_found = 0;

	for (cmd_tbl_t *cmdtp = table; cmdtp->name != NULL; cmdtp++) {
		if (strncmp_P(cmd, cmdtp->name, para->len) == 0 &&
					(para->opt_debug || !(cmdtp->flags & CTBL_DBG))) {
			if (para->len == strlen_P(cmdtp->name))
				return cmdtp;	/* full match */

			cmdtp_ret = cmdtp;	/* abbreviated command ? */
			n_found++;
		} else if (cmdtp->subcmd) {
			cmd_tbl_t *sub = _find_cmd(cmd, cmdtp->subcmd, para);
			if (sub && sub->flags & CTBL_SUBCMDAUTO) {
				cmdtp_ret = sub;
				++n_found;
			}
		}
	}
	if (n_found == 1) {			/* exactly one match */
		if (sub_found)
			para->level++;
		return cmdtp_ret;
	}

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


cmd_tbl_t *find_cmd (const char *cmd, cmd_tbl_t *table, uint_fast8_t *cmdlevel)
{
	find_cmd_para_t para;

	if (!cmd)
		return NULL;

	char *optenv = getenv_str(PSTR("cmd"));
	para.level = 0;
	para.opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
	para.len = strlen(cmd);

	cmd_tbl_t *cmdtp = _find_cmd(cmd, table, &para);

	if (cmdlevel)
		*cmdlevel = para.level;
	return cmdtp;
}

cmd_tbl_t *find_cmd_sub(const char *cmd, cmd_tbl_t *table)
{
	cmd_tbl_t *entry = NULL;

	for (cmd_tbl_t *tp = get_cmd_tbl_base(table); tp->name && entry == NULL; tp++)
		if (tp->subcmd && tp->flags & CTBL_SUBCMDAUTO)
			entry = find_cmd(cmd, tp->subcmd, NULL);

	return entry;
}

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

command_ret_t do_help(cmd_tbl_t *cmdtp, uint_fast8_t flag UNUSED, int argc, char * const argv[])
{
	cmd_tbl_t *tbl_start = get_cmd_tbl_base(cmdtp);

	char *optenv = getenv_str(PSTR("cmd"));
	bool opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;

	if (argc == 1) {	/*show list of commands */
		int cmd_items = cmd_tbl_item_count(tbl_start);
		cmd_tbl_t **cmd_list = (cmd_tbl_t **) malloc(cmd_items * sizeof(cmd_tbl_t *));
		uint_fast8_t maxlen_cmd = 0;

		/* Make array of commands */
		cmd_tbl_t *tp = tbl_start;
		int i = 0;
		while (tp->name != NULL) {
			if (tp->subcmd) {
				cmd_tbl_t *sub = tp->subcmd;
				while (sub->name != NULL) {
					if (sub->flags & CTBL_SUBCMDAUTO) {
						uint_fast8_t len = strlen_P(sub->name);
						if (len > maxlen_cmd)
							maxlen_cmd = len;
						cmd_list[i++] = sub;
					}
					sub++;
				}
			}
			if ((tp->flags & CTBL_SUBCMDAUTO) == 0) {
				uint_fast8_t len = strlen_P(tp->name);
				if (len > maxlen_cmd)
					maxlen_cmd = len;
					cmd_list[i++] = tp;
			}
			tp++;
		}
		/* Sort command list */
		qsort(cmd_list, cmd_items, sizeof (cmd_tbl_t *), cmpstring_PP);

		/* print short help (usage) */
		for (int i = 0; i < cmd_items; i++) {
			if (opt_debug || !(cmd_list[i]->flags & CTBL_DBG)) {
				const FLASH char *usage = cmd_list[i]->usage;

				/* allow user abort */
				if (ctrlc ()) {
					free(cmd_list);
					return CMD_RET_FAILURE;
				}
				if (usage == NULL)
					continue;
#if defined(GCC_BUG_61443) || 1
				print_usage_line(cmd_list[i]->name, maxlen_cmd, usage);
#else
				printf_P(PSTR("%-" stringify(8) /*FIXME*/ "S - %S\n"),
						cmd_list[i]->name, usage);
#endif
			}
		}
		free(cmd_list);
		return CMD_RET_SUCCESS;
	}

	/*
	 * command help (long version)
	 */
	for (uint8_t i = 1; i < argc; ++i) {
		if ((cmdtp = find_cmd(argv[i], tbl_start, NULL)) != NULL &&
					(opt_debug || !(cmdtp->flags & CTBL_DBG))) {
			cmd_usage(cmdtp);
		} else {
			printf_P(PSTR("Unknown command '%s' - try 'help'"
				" without arguments.\n\n"), argv[i]
				);
			return CMD_RET_FAILURE;
		}
	}

	return CMD_RET_SUCCESS;
}


command_ret_t cmd_usage(cmd_tbl_t *cmdtp)
{
//	printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
	print_usage_line(cmdtp->name, 0, cmdtp->usage);
#if 0
	my_puts_P(cmdtp->name);
	print_blanks(/*FIXME*/ 8 - strlen_P(cmdtp->name));
	my_puts_P(PSTR(" - "));
	my_puts_P(cmdtp->usage);
	my_puts_P(PSTR("\n\n"));
#endif
#ifdef	CONFIG_SYS_LONGHELP
//	printf("Usage:\n%s ", cmdtp->name);
	my_puts_P(PSTR("Usage:\n"));
	my_puts_P(cmdtp->name);
	my_puts_P(PSTR(" "));

	if (!cmdtp->help) {
		my_puts_P(PSTR(" - No additional help available.\n"));
		return CMD_RET_FAILURE;
	}

	my_puts_P(cmdtp->help);
	my_puts_P(PSTR("\n"));
#endif	/* CONFIG_SYS_LONGHELP */
	return CMD_RET_FAILURE;
}

#ifdef CONFIG_AUTO_COMPLETE

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

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

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

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

	return 0;
}

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

/* TODO: cmdtp points to FLASH */

static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
{
	cmd_tbl_t *cmdtp = cmd_tbl;
//	const int count = ARRAY_SIZE(cmd_tbl);
//	const cmd_tbl_t *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->name[0] != '\0'; 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(argv[0], cmd_tbl);
		if (cmdtp == NULL || cmdtp->complete == NULL) {
			cmdv[0] = NULL;
			return 0;
		}
		return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
	}

	cmd = argv[0];

	len = strlen(cmd);

	/* return the partial matches */
	for (; cmdtp->name[0] != '\0'; 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;
}

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) {
		my_puts_P(PSTR("\n"));
		my_puts(banner);
	}

	i = linemax;	/* force leader and newline */
	while (*argv != NULL) {
		len = strlen(*argv) + sl;
		if (i + len >= linemax) {
			my_puts_P(PSTR("\n"));
			if (leader)
				my_puts(leader);
			i = ll - sl;
		} else if (sep)
			my_puts(sep);
		my_puts(*argv++);
		i += len;
	}
	my_puts_P(PSTR("\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];	/* copy of console I/O buffer	*/


int cmd_auto_complete(const FLASH 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;

	if (strcmp_PP(prompt, CONFIG_SYS_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);

	/* 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;
		putchar('\a');
		return 1;
	}

	s = NULL;
	len = 0;
	sep = NULL;
	seplen = 0;
	if (i == 1) { /* one match; perfect */
		k = strlen(argv[argc - 1]);
		s = cmdv[0] + k;
		len = strlen(s);
		sep = " ";
		seplen = 1;
	} else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) {	/* more */
		k = strlen(argv[argc - 1]);
		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) {
			putchar('\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;
		my_puts(t - k);
		if (sep == NULL)
			putchar('\a');
		*np = n;
		*colp = col;
	} else {
		print_argv(NULL, "  ", " ", 78, cmdv);

		my_puts_P(prompt);
		my_puts(buf);
	}
	return 1;
}

#endif /* CONFIG_AUTO_COMPLETE */


/**
 * 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
 * @return 0 if command succeeded, else non-zero (CMD_RET_...)
 */
command_ret_t cmd_call(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[])
{
	command_ret_t result;

	result = (cmdtp->cmd)(cmdtp, flag, argc, argv);
//	if (result != CMD_RET_SUCCESS)
//		debug("Command failed, result=%d\n", result);
	return result;
}

#pragma GCC diagnostic ignored "-Wclobbered"

command_ret_t cmd_process(uint_fast8_t flag, int argc, char * const argv[],
			       uint_fast8_t *repeatable)
{
	command_ret_t rc = CMD_RET_SUCCESS;
	cmd_tbl_t *cmdtp;
	uint_fast8_t cmdlevel;

	/* Look up command in command table */
	cmdtp = find_cmd(argv[0], cmd_tbl, &cmdlevel);
	if (cmdtp != NULL) {
		/* Check if this command has subcommands */
		if (cmdtp->subcmd && argc > 1) {

			/* Look up subcommand in subcommand table */
			cmd_tbl_t *cmdtpsub = find_cmd(argv[1], cmdtp->subcmd, &cmdlevel);
			if (cmdtpsub == NULL) {
				printf_P(PSTR("Unknown '%s' subcommand '%s' - try '%s help'\n"), argv[0], argv[1], argv[0]);
				return CMD_RET_FAILURE;
			}
			cmdtp = cmdtpsub;
			--argc;
			++argv;
		}
	}
#if 0
	 else {
		/* Search subcommands */
		cmdtp = find_cmd_sub(argv[0], cmd_tbl, &cmdlevel);
	}
#endif

	if (cmdtp == NULL) {
		printf_P(PSTR("Unknown command '%s' - try 'help'\n"), argv[0]);
		return CMD_RET_FAILURE;
	}

	/* 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) {
			my_puts_P(PSTR("'bootd' recursion detected\n"));
			rc = CMD_RET_FAILURE;
		} else {
			flag |= CMD_FLAG_BOOTD;
		}
	}
#endif

	if (setjmp(cmd_jbuf) != 0)
		return CMD_RET_FAILURE;

	/* If OK so far, then do the command */
	if (!rc) {
		rc = cmd_call(cmdtp, flag, argc, argv);
		*repeatable &= (cmdtp->flags & CTBL_RPT) != 0;
	}
	if (rc == CMD_RET_USAGE)
		rc = cmd_usage(cmdtp);
	return rc;
}

int cmd_process_error(cmd_tbl_t *cmdtp, int err)
{
	char buf[strlen_P(cmdtp->name) + 1];
	strcpy_P(buf, cmdtp->name);

	if (err) {
		printf_P(PSTR("Command '%s' failed: Error %d\n"), buf, err);
		return 1;
	}

	return 0;
}
Commit	Line	Data
35edb766	1	/*
04f84937	2	* (C) Copyright 2014, 2016, 2018 Leo C. <erbl259-lmu@yahoo.de>
35edb766 L	3	*
	4	* (C) Copyright 2000-2009
	5	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	6	*
ccb6ffb9	7	* SPDX-License-Identifier: GPL-2.0
35edb766 L	8	*/
35edb766 L	9
d684c216 L	10	/*
	11	* Command Processor Table
	12	*/
	13
fcd2239e	14	#include "command.h"
d684c216	15	#include "common.h"
d684c216	16	#include <ctype.h>
fcd2239e	17	#include <setjmp.h>
d684c216 L	18
d684c216 L	19	#include "config.h"
8f23e84c	20	#include "print-utils.h"
d684c216 L	21	#include "con-utils.h"
d684c216 L	22	#include "env.h"
8f23e84c	23	#include "debug.h"
fcd2239e	24
dab74a42 L	25	#define DEBUG_CMD 1 /* set to 1 to debug */
	26
	27	#define debug_cmd(fmt, args...) \
	28	debug_cond(DEBUG_CMD, fmt, ##args)
	29
fcd2239e L	30
fcd2239e L	31	jmp_buf cmd_jbuf;
d684c216 L	32
d684c216 L	33
deb08cb6 L	34	static void print_usage_line(const FLASH char *name, int width,
deb08cb6 L	35	const FLASH char *usage)
d684c216	36	{
deb08cb6 L	37	width -= strlen_P(name);
	38	if (width < 0)
	39	width = 0;
d684c216	40	my_puts_P(name);
deb08cb6	41	print_blanks(width);
d684c216 L	42	my_puts_P(PSTR(" - "));
	43	my_puts_P(usage);
	44	my_puts_P(PSTR("\n"));
	45	}
	46
	47	int strcmp_PP(const FLASH char s1, const FLASH char s2)
	48	{
	49	unsigned char c1, c2;
	50
c79c80b4	51	while ((c1 = (const FLASH unsigned char )s1++)
d684c216 L	52	== (c2 = (const FLASH unsigned char )s2++))
	53	if (c1 == 0)
	54	return 0;
	55
	56	return c1 - c2;
	57	}
	58
c79c80b4	59	int cmpstring_PP(const void p1, const void p2)
d684c216	60	{
c79c80b4	61	return strcmp_PP(((const FLASH cmd_tbl_t *) p1)->name,
d684c216 L	62	((const FLASH cmd_tbl_t *) p2)->name);
	63	}
	64
9d6c43fa L	65	/****************************************************************************/
9d6c43fa L	66
8da60ec5	67	int cmd_tbl_item_count(cmd_tbl_t *p)
d684c216	68	{
d684c216 L	69	int count = 0;
	70
	71	while (p->name != NULL) {
dab74a42	72	if (p->subcmd) {
04f84937 L	73	cmd_tbl_t *sub = p->subcmd;
	74	while (sub->name != NULL) {
	75	if (sub->flags & CTBL_SUBCMDAUTO)
	76	count++;
	77	sub++;
	78	}
	79	}
dab74a42 L	80	if ((p->flags & CTBL_SUBCMDAUTO) == 0)
	81	count++;
	82	p++;
d684c216 L	83	}
	84	return count;
	85	}
	86
9d6c43fa L	87
	88	cmd_tbl_t get_cmd_tbl_base(cmd_tbl_t cmdtp)
	89	{
	90	cmd_tbl_t *p = cmdtp;
	91
	92	while (p->name != NULL)
	93	++p;
	94
	95	return p->subcmd;
	96	}
	97
	98	/*
5caa8c2b L	99	* find command table entry for a command
5caa8c2b L	100	*/
7a1ed620 L	101	typedef struct {
	102	size_t len;
	103	uint_fast8_t level;
	104	bool opt_debug;
	105	} find_cmd_para_t;
5caa8c2b	106
7a1ed620 L	107	cmd_tbl_t _find_cmd (const char cmd, cmd_tbl_t table, find_cmd_para_t para)
	108	{
	109	cmd_tbl_t *cmdtp_ret = NULL;
	110	uint_fast8_t n_found = 0, sub_found = 0;
5caa8c2b	111
7a1ed620 L	112	for (cmd_tbl_t *cmdtp = table; cmdtp->name != NULL; cmdtp++) {
	113	if (strncmp_P(cmd, cmdtp->name, para->len) == 0 &&
	114	(para->opt_debug \|\| !(cmdtp->flags & CTBL_DBG))) {
	115	if (para->len == strlen_P(cmdtp->name))
5caa8c2b L	116	return cmdtp; /* full match */
5caa8c2b L	117
7a1ed620	118	cmdtp_ret = cmdtp; /* abbreviated command ? */
5caa8c2b	119	n_found++;
dab74a42	120	} else if (cmdtp->subcmd) {
7a1ed620	121	cmd_tbl_t *sub = _find_cmd(cmd, cmdtp->subcmd, para);
04f84937	122	if (sub && sub->flags & CTBL_SUBCMDAUTO) {
7a1ed620 L	123	cmdtp_ret = sub;
	124	++n_found;
	125	}
5caa8c2b L	126	}
5caa8c2b L	127	}
7a1ed620 L	128	if (n_found == 1) { /* exactly one match */
	129	if (sub_found)
	130	para->level++;
	131	return cmdtp_ret;
	132	}
5caa8c2b L	133
	134	return NULL; /* not found or ambiguous command */
	135	}
	136
7a1ed620 L	137
	138	cmd_tbl_t find_cmd (const char cmd, cmd_tbl_t table, uint_fast8_t cmdlevel)
	139	{
	140	find_cmd_para_t para;
	141
	142	if (!cmd)
	143	return NULL;
	144
	145	char *optenv = getenv_str(PSTR("cmd"));
	146	para.level = 0;
	147	para.opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
	148	para.len = strlen(cmd);
	149
	150	cmd_tbl_t *cmdtp = _find_cmd(cmd, table, &para);
	151
	152	if (cmdlevel)
	153	*cmdlevel = para.level;
	154	return cmdtp;
	155	}
	156
9d6c43fa	157	cmd_tbl_t find_cmd_sub(const char cmd, cmd_tbl_t *table)
5caa8c2b	158	{
9d6c43fa	159	cmd_tbl_t *entry = NULL;
5caa8c2b	160
9d6c43fa L	161	for (cmd_tbl_t *tp = get_cmd_tbl_base(table); tp->name && entry == NULL; tp++)
9d6c43fa L	162	if (tp->subcmd && tp->flags & CTBL_SUBCMDAUTO)
7a1ed620	163	entry = find_cmd(cmd, tp->subcmd, NULL);
5caa8c2b	164
9d6c43fa	165	return entry;
5caa8c2b L	166	}
5caa8c2b L	167
d684c216 L	168	/*
	169	* Use puts() instead of printf() to avoid printf buffer overflow
	170	* for long help messages
	171	*/
	172
7a1ed620	173	command_ret_t do_help(cmd_tbl_t cmdtp, uint_fast8_t flag UNUSED, int argc, char const argv[])
d684c216	174	{
9d6c43fa	175	cmd_tbl_t *tbl_start = get_cmd_tbl_base(cmdtp);
5caa8c2b	176
ccb6ffb9 L	177	char *optenv = getenv_str(PSTR("cmd"));
	178	bool opt_debug = optenv && strstr_P(optenv, PSTR("debug")) != NULL;
	179
d684c216	180	if (argc == 1) { /show list of commands /
8da60ec5	181	int cmd_items = cmd_tbl_item_count(tbl_start);
292f0519 L	182	cmd_tbl_t cmd_list = (cmd_tbl_t ) malloc(cmd_items * sizeof(cmd_tbl_t *));
292f0519 L	183	uint_fast8_t maxlen_cmd = 0;
d684c216	184
292f0519 L	185	/* Make array of commands */
292f0519 L	186	cmd_tbl_t *tp = tbl_start;
04f84937 L	187	int i = 0;
04f84937 L	188	while (tp->name != NULL) {
dab74a42	189	if (tp->subcmd) {
04f84937 L	190	cmd_tbl_t *sub = tp->subcmd;
	191	while (sub->name != NULL) {
	192	if (sub->flags & CTBL_SUBCMDAUTO) {
dab74a42	193	uint_fast8_t len = strlen_P(sub->name);
04f84937 L	194	if (len > maxlen_cmd)
	195	maxlen_cmd = len;
	196	cmd_list[i++] = sub;
	197	}
	198	sub++;
	199	}
	200	}
dab74a42 L	201	if ((tp->flags & CTBL_SUBCMDAUTO) == 0) {
	202	uint_fast8_t len = strlen_P(tp->name);
	203	if (len > maxlen_cmd)
	204	maxlen_cmd = len;
	205	cmd_list[i++] = tp;
	206	}
	207	tp++;
d684c216	208	}
d684c216	209	/* Sort command list */
292f0519	210	qsort(cmd_list, cmd_items, sizeof (cmd_tbl_t *), cmpstring_PP);
d684c216 L	211
d684c216 L	212	/* print short help (usage) */
8da60ec5	213	for (int i = 0; i < cmd_items; i++) {
292f0519 L	214	if (opt_debug \|\| !(cmd_list[i]->flags & CTBL_DBG)) {
292f0519 L	215	const FLASH char *usage = cmd_list[i]->usage;
ccb6ffb9 L	216
ccb6ffb9 L	217	/* allow user abort */
292f0519 L	218	if (ctrlc ()) {
292f0519 L	219	free(cmd_list);
ccb6ffb9	220	return CMD_RET_FAILURE;
292f0519	221	}
ccb6ffb9 L	222	if (usage == NULL)
ccb6ffb9 L	223	continue;
8da60ec5	224	#if defined(GCC_BUG_61443) \|\| 1
292f0519	225	print_usage_line(cmd_list[i]->name, maxlen_cmd, usage);
d684c216	226	#else
ccb6ffb9	227	printf_P(PSTR("%-" stringify(8) /FIXME/ "S - %S\n"),
292f0519	228	cmd_list[i]->name, usage);
d684c216	229	#endif
ccb6ffb9	230	}
d684c216	231	}
292f0519	232	free(cmd_list);
d0581f88	233	return CMD_RET_SUCCESS;
d684c216	234	}
8da60ec5	235
d684c216 L	236	/*
	237	* command help (long version)
	238	*/
8da60ec5	239	for (uint8_t i = 1; i < argc; ++i) {
7a1ed620	240	if ((cmdtp = find_cmd(argv[i], tbl_start, NULL)) != NULL &&
04f84937	241	(opt_debug \|\| !(cmdtp->flags & CTBL_DBG))) {
3f858d9f	242	cmd_usage(cmdtp);
d684c216 L	243	} else {
	244	printf_P(PSTR("Unknown command '%s' - try 'help'"
	245	" without arguments.\n\n"), argv[i]
	246	);
8da60ec5	247	return CMD_RET_FAILURE;
d684c216 L	248	}
d684c216 L	249	}
8da60ec5 L	250
8da60ec5 L	251	return CMD_RET_SUCCESS;
d684c216 L	252	}
d684c216 L	253
d684c216	254
04f84937	255	command_ret_t cmd_usage(cmd_tbl_t *cmdtp)
d684c216 L	256	{
d684c216 L	257	// printf("%s - %s\n\n", cmdtp->name, cmdtp->usage);
deb08cb6	258	print_usage_line(cmdtp->name, 0, cmdtp->usage);
d684c216 L	259	#if 0
d684c216 L	260	my_puts_P(cmdtp->name);
deb08cb6	261	print_blanks(/FIXME/ 8 - strlen_P(cmdtp->name));
d684c216 L	262	my_puts_P(PSTR(" - "));
	263	my_puts_P(cmdtp->usage);
	264	my_puts_P(PSTR("\n\n"));
	265	#endif
	266	#ifdef CONFIG_SYS_LONGHELP
	267	// printf("Usage:\n%s ", cmdtp->name);
	268	my_puts_P(PSTR("Usage:\n"));
	269	my_puts_P(cmdtp->name);
f338df2a	270	my_puts_P(PSTR(" "));
d684c216 L	271
	272	if (!cmdtp->help) {
	273	my_puts_P(PSTR(" - No additional help available.\n"));
d0581f88	274	return CMD_RET_FAILURE;
d684c216 L	275	}
	276
	277	my_puts_P(cmdtp->help);
	278	my_puts_P(PSTR("\n"));
	279	#endif /* CONFIG_SYS_LONGHELP */
d0581f88	280	return CMD_RET_FAILURE;
d684c216 L	281	}
	282
	283	#ifdef CONFIG_AUTO_COMPLETE
	284
	285	int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
	286	{
dea9a315	287	static char tmp_buf[CONFIG_SYS_CBSIZE];
d684c216 L	288	int space;
	289
	290	space = last_char == '\0' \|\| isblank(last_char);
	291
	292	if (space && argc == 1)
	293	return env_complete("", maxv, cmdv, sizeof(tmp_buf), tmp_buf);
	294
	295	if (!space && argc == 2)
	296	return env_complete(argv[1], maxv, cmdv, sizeof(tmp_buf), tmp_buf);
	297
	298	return 0;
	299	}
	300
	301	/*************************************************************************************/
	302
dea9a315 L	303	/* TODO: cmdtp points to FLASH */
dea9a315 L	304
d684c216 L	305	static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
	306	{
	307	cmd_tbl_t *cmdtp = cmd_tbl;
	308	// const int count = ARRAY_SIZE(cmd_tbl);
	309	// const cmd_tbl_t *cmdend = cmdtp + count;
	310	// const char *p;
	311	int len, clen;
	312	int n_found = 0;
	313	const char *cmd;
	314
	315	/* sanity? */
	316	if (maxv < 2)
	317	return -2;
	318
	319	cmdv[0] = NULL;
	320
	321	if (argc == 0) {
	322	/* output full list of commands */
	323	for (; cmdtp->name[0] != '\0'; cmdtp++) {
	324	if (n_found >= maxv - 2) {
	325	cmdv[n_found++] = "...";
	326	break;
	327	}
	328	cmdv[n_found++] = cmdtp->name;
	329	}
	330	cmdv[n_found] = NULL;
	331	return n_found;
	332	}
	333
	334	/* more than one arg or one but the start of the next */
	335	if (argc > 1 \|\| (last_char == '\0' \|\| isblank(last_char))) {
8da60ec5	336	cmdtp = find_cmd(argv[0], cmd_tbl);
d684c216 L	337	if (cmdtp == NULL \|\| cmdtp->complete == NULL) {
	338	cmdv[0] = NULL;
	339	return 0;
	340	}
	341	return (*cmdtp->complete)(argc, argv, last_char, maxv, cmdv);
	342	}
	343
	344	cmd = argv[0];
	345
	346	len = strlen(cmd);
	347
	348	/* return the partial matches */
	349	for (; cmdtp->name[0] != '\0'; cmdtp++) {
	350
	351	clen = strlen(cmdtp->name);
	352	if (clen < len)
	353	continue;
	354
	355	if (memcmp(cmd, cmdtp->name, len) != 0)
	356	continue;
	357
	358	/* too many! */
	359	if (n_found >= maxv - 2) {
	360	cmdv[n_found++] = "...";
	361	break;
	362	}
	363
	364	cmdv[n_found++] = cmdtp->name;
	365	}
	366
	367	cmdv[n_found] = NULL;
	368	return n_found;
	369	}
	370
	371	static int make_argv(char s, int argvsz, char argv[])
	372	{
	373	int argc = 0;
	374
	375	/* split into argv */
	376	while (argc < argvsz - 1) {
	377
	378	/* skip any white space */
	379	while (isblank(*s))
	380	++s;
	381
	382	if (s == '\0') / end of s, no more args */
	383	break;
	384
	385	argv[argc++] = s; /* begin of argument string */
	386
	387	/* find end of string */
	388	while (s && !isblank(s))
	389	++s;
	390
	391	if (s == '\0') / end of s, no more args */
	392	break;
	393
	394	s++ = '\0'; / terminate current arg */
	395	}
	396	argv[argc] = NULL;
	397
	398	return argc;
	399	}
	400
401	static void print_argv(const char banner, const char leader, const char sep, int linemax, char const argv[])
402	{
403	int ll = leader != NULL ? strlen(leader) : 0;
404	int sl = sep != NULL ? strlen(sep) : 0;
405	int len, i;
406
407	if (banner) {
408	my_puts_P(PSTR("\n"));
409	my_puts(banner);
410	}
411
412	i = linemax; /* force leader and newline */
413	while (*argv != NULL) {
414	len = strlen(*argv) + sl;
415	if (i + len >= linemax) {
416	my_puts_P(PSTR("\n"));
417	if (leader)
418	my_puts(leader);
419	i = ll - sl;
420	} else if (sep)
421	my_puts(sep);
422	my_puts(*argv++);
423	i += len;
424	}
425	my_puts_P(PSTR("\n"));
426	}
427
428	static int find_common_prefix(char * const argv[])
429	{
430	int i, len;
431	char anchor, s, *t;
432
433	if (*argv == NULL)
434	return 0;
435
436	/* begin with max */
437	anchor = *argv++;
438	len = strlen(anchor);
439	while ((t = *argv++) != NULL) {
440	s = anchor;
441	for (i = 0; i < len; i++, t++, s++) {
442	if (t != s)
443	break;
444	}
445	len = s - anchor;
446	}
447	return len;
448	}
449
450	static char tmp_buf[CONFIG_SYS_CBSIZE]; /* copy of console I/O buffer */
451
dea9a315	452
d684c216 L	453	int cmd_auto_complete(const FLASH char const prompt, char buf, int np, int colp)
	454	{
	455	int n = np, col = colp;
	456	char argv[CONFIG_SYS_MAXARGS + 1]; / NULL terminated */
	457	char *cmdv[20];
	458	char s, t;
	459	const char *sep;
	460	int i, j, k, len, seplen, argc;
	461	int cnt;
	462	char last_char;
	463
	464	if (strcmp_PP(prompt, CONFIG_SYS_PROMPT) != 0)
	465	return 0; /* not in normal console */
	466
	467	cnt = strlen(buf);
	468	if (cnt >= 1)
	469	last_char = buf[cnt - 1];
	470	else
	471	last_char = '\0';
	472
	473	/* copy to secondary buffer which will be affected */
	474	strcpy(tmp_buf, buf);
	475
	476	/* separate into argv */
	477	argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
	478
	479	/* do the completion and return the possible completions */
	480	i = complete_cmdv(argc, argv, last_char, sizeof(cmdv)/sizeof(cmdv[0]), cmdv);
	481
	482	/* no match; bell and out */
	483	if (i == 0) {
	484	if (argc > 1) /* allow tab for non command */
	485	return 0;
	486	putchar('\a');
	487	return 1;
	488	}
	489
	490	s = NULL;
	491	len = 0;
	492	sep = NULL;
	493	seplen = 0;
	494	if (i == 1) { /* one match; perfect */
	495	k = strlen(argv[argc - 1]);
	496	s = cmdv[0] + k;
	497	len = strlen(s);
	498	sep = " ";
	499	seplen = 1;
	500	} else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
	501	k = strlen(argv[argc - 1]);
	502	j -= k;
	503	if (j > 0) {
	504	s = cmdv[0] + k;
	505	len = j;
	506	}
	507	}
	508
	509	if (s != NULL) {
	510	k = len + seplen;
	511	/* make sure it fits */
	512	if (n + k >= CONFIG_SYS_CBSIZE - 2) {
	513	putchar('\a');
	514	return 1;
	515	}
	516
517	t = buf + cnt;
518	for (i = 0; i < len; i++)
519	t++ = s++;
520	if (sep != NULL)
521	for (i = 0; i < seplen; i++)
522	*t++ = sep[i];
523	*t = '\0';
524	n += k;
525	col += k;
526	my_puts(t - k);
527	if (sep == NULL)
528	putchar('\a');
529	*np = n;
530	*colp = col;
531	} else {
532	print_argv(NULL, " ", " ", 78, cmdv);
533
534	my_puts_P(prompt);
535	my_puts(buf);
536	}
537	return 1;
538	}
539
540	#endif /* CONFIG_AUTO_COMPLETE */
541
542
543
544	/**
545	* Call a command function. This should be the only route in U-Boot to call
546	* a command, so that we can track whether we are waiting for input or
547	* executing a command.
548	*
549	* @param cmdtp Pointer to the command to execute
550	* @param flag Some flags normally 0 (see CMD_FLAG_.. above)
551	* @param argc Number of arguments (arg 0 must be the command text)
552	* @param argv Arguments
553	* @return 0 if command succeeded, else non-zero (CMD_RET_...)
554	*/
fcf1d5b3	555	command_ret_t cmd_call(cmd_tbl_t cmdtp, uint_fast8_t flag, int argc, char const argv[])
d684c216	556	{
d0581f88	557	command_ret_t result;
d684c216 L	558
d684c216 L	559	result = (cmdtp->cmd)(cmdtp, flag, argc, argv);
13e88ed5 L	560	// if (result != CMD_RET_SUCCESS)
13e88ed5 L	561	// debug("Command failed, result=%d\n", result);
d684c216 L	562	return result;
	563	}
	564
7eecbdac L	565	#pragma GCC diagnostic ignored "-Wclobbered"
7eecbdac L	566
fcf1d5b3	567	command_ret_t cmd_process(uint_fast8_t flag, int argc, char * const argv[],
d684c216 L	568	uint_fast8_t *repeatable)
d684c216 L	569	{
d0581f88	570	command_ret_t rc = CMD_RET_SUCCESS;
d684c216	571	cmd_tbl_t *cmdtp;
7a1ed620	572	uint_fast8_t cmdlevel;
d684c216 L	573
d684c216 L	574	/* Look up command in command table */
7a1ed620	575	cmdtp = find_cmd(argv[0], cmd_tbl, &cmdlevel);
9d6c43fa L	576	if (cmdtp != NULL) {
	577	/* Check if this command has subcommands */
	578	if (cmdtp->subcmd && argc > 1) {
	579
	580	/* Look up subcommand in subcommand table */
7a1ed620	581	cmd_tbl_t *cmdtpsub = find_cmd(argv[1], cmdtp->subcmd, &cmdlevel);
9d6c43fa L	582	if (cmdtpsub == NULL) {
	583	printf_P(PSTR("Unknown '%s' subcommand '%s' - try '%s help'\n"), argv[0], argv[1], argv[0]);
	584	return CMD_RET_FAILURE;
	585	}
	586	cmdtp = cmdtpsub;
	587	--argc;
	588	++argv;
	589	}
7a1ed620 L	590	}
	591	#if 0
	592	else {
9d6c43fa	593	/* Search subcommands */
7a1ed620	594	cmdtp = find_cmd_sub(argv[0], cmd_tbl, &cmdlevel);
9d6c43fa	595	}
7a1ed620	596	#endif
9d6c43fa	597
d684c216 L	598	if (cmdtp == NULL) {
d684c216 L	599	printf_P(PSTR("Unknown command '%s' - try 'help'\n"), argv[0]);
d0581f88	600	return CMD_RET_FAILURE;
d684c216	601	}
8da60ec5	602
d684c216 L	603	/* found - check max args */
	604	if (argc > cmdtp->maxargs)
	605	rc = CMD_RET_USAGE;
	606
	607	#if defined(CONFIG_CMD_BOOTD)
	608	/* avoid "bootd" recursion */
	609	else if (cmdtp->cmd == do_bootd) {
	610	if (flag & CMD_FLAG_BOOTD) {
	611	my_puts_P(PSTR("'bootd' recursion detected\n"));
	612	rc = CMD_RET_FAILURE;
	613	} else {
	614	flag \|= CMD_FLAG_BOOTD;
	615	}
	616	}
	617	#endif
	618
fcd2239e L	619	if (setjmp(cmd_jbuf) != 0)
	620	return CMD_RET_FAILURE;
	621
d684c216 L	622	/* If OK so far, then do the command */
	623	if (!rc) {
	624	rc = cmd_call(cmdtp, flag, argc, argv);
7a1ed620	625	*repeatable &= (cmdtp->flags & CTBL_RPT) != 0;
d684c216 L	626	}
	627	if (rc == CMD_RET_USAGE)
	628	rc = cmd_usage(cmdtp);
	629	return rc;
	630	}
	631
	632	int cmd_process_error(cmd_tbl_t *cmdtp, int err)
	633	{
	634	char buf[strlen_P(cmdtp->name) + 1];
	635	strcpy_P(buf, cmdtp->name);
	636
	637	if (err) {
	638	printf_P(PSTR("Command '%s' failed: Error %d\n"), buf, err);
	639	return 1;
	640	}
	641
	642	return 0;
	643	}