[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"


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