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

/*
 * (C) Copyright 2014, 2016 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 <stdlib.h>
#include <string.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) {
		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) {
				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_array[cmd_items];
		cmd_tbl_t *tp = tbl_start;
		uint_fast8_t max_len = 0;

		/* Make array of commands from .uboot_cmd section */
		for (int i = 0; i < cmd_items; i++) {
			cmd_array[i] = tp++;
			uint_fast8_t l = strlen_P(cmd_array[i]->name);
			if (l > max_len)
				max_len = l;
		}

		/* Sort command list */
		qsort(cmd_array, cmd_items, sizeof (cmd_tbl_t *), cmpstring_PP);

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

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