[J-u-boot.git] / include / command.h

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

/*
 *  Definitions for Command Processor
 */
#ifndef __COMMAND_H
#define __COMMAND_H

#include <env.h>
#include <linker_lists.h>

#ifndef NULL
#define NULL	0
#endif

/* Default to a width of 8 characters for help message command width */
#ifndef CONFIG_SYS_HELP_CMD_WIDTH
#define CONFIG_SYS_HELP_CMD_WIDTH	10
#endif

#ifndef	__ASSEMBLY__
/*
 * Monitor Command Table
 */

struct cmd_tbl {
	char		*name;		/* Command Name			*/
	int		maxargs;	/* maximum number of arguments	*/
					/*
					 * Same as ->cmd() except the command
					 * tells us if it can be repeated.
					 * Replaces the old ->repeatable field
					 * which was not able to make
					 * repeatable property different for
					 * the main command and sub-commands.
					 */
	int		(*cmd_rep)(struct cmd_tbl *cmd, int flags, int argc,
				   char *const argv[], int *repeatable);
					/* Implementation function	*/
	int		(*cmd)(struct cmd_tbl *cmd, int flags, int argc,
			       char *const argv[]);
	char		*usage;		/* Usage message	(short)	*/
#ifdef	CONFIG_SYS_LONGHELP
	char		*help;		/* Help  message	(long)	*/
#endif
#ifdef CONFIG_AUTO_COMPLETE
	/* do auto completion on the arguments */
	int		(*complete)(int argc, char *const argv[],
				    char last_char, int maxv, char *cmdv[]);
#endif
};

#if defined(CONFIG_CMD_RUN)
int do_run(struct cmd_tbl *cmdtp, int flag, int argc,
	   char *const argv[]);
#endif

/* common/command.c */
int _do_help(struct cmd_tbl *cmd_start, int cmd_items, struct cmd_tbl *cmdtp,
	     int flag, int argc, char *const argv[]);
struct cmd_tbl *find_cmd(const char *cmd);
struct cmd_tbl *find_cmd_tbl(const char *cmd, struct cmd_tbl *table,
			     int table_len);
int complete_subcmdv(struct cmd_tbl *cmdtp, int count, int argc,
		     char *const argv[], char last_char, int maxv,
		     char *cmdv[]);

int cmd_usage(const struct cmd_tbl *cmdtp);

/* Dummy ->cmd and ->cmd_rep wrappers. */
int cmd_always_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
			  char *const argv[], int *repeatable);
int cmd_never_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
			 char *const argv[], int *repeatable);
int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
			   char *const argv[]);

static inline bool cmd_is_repeatable(struct cmd_tbl *cmdtp)
{
	return cmdtp->cmd_rep == cmd_always_repeatable;
}

#ifdef CONFIG_AUTO_COMPLETE
int var_complete(int argc, char *const argv[], char last_char, int maxv,
		 char *cmdv[]);
int cmd_auto_complete(const char *const prompt, char *buf, int *np,
		      int *colp);
#endif

/**
 * cmd_process_error() - report and process a possible error
 *
 * @cmdtp: Command which caused the error
 * @err: Error code (0 if none, -ve for error, like -EIO)
 * @return 0 (CMD_RET_SUCCESS) if there is not error,
 *	   1 (CMD_RET_FAILURE) if an error is found
 *	   -1 (CMD_RET_USAGE) if 'usage' error is found
 */
int cmd_process_error(struct cmd_tbl *cmdtp, int err);

/*
 * Monitor Command
 *
 * All commands use a common argument format:
 *
 * void function(struct cmd_tbl *cmdtp, int flag, int argc,
 *		 char *const argv[]);
 */

#if defined(CONFIG_CMD_MEMORY) || \
	defined(CONFIG_CMD_I2C) || \
	defined(CONFIG_CMD_ITEST) || \
	defined(CONFIG_CMD_PCI) || \
	defined(CONFIG_CMD_SETEXPR)
#define CMD_DATA_SIZE
#define CMD_DATA_SIZE_ERR	(-1)
#define CMD_DATA_SIZE_STR	(-2)

/**
 * cmd_get_data_size() - Get the data-size specifier from a command
 *
 * This reads a '.x' size specifier appended to a command. For example 'md.b'
 * is the 'md' command with a '.b' specifier, meaning that the command should
 * use bytes.
 *
 * Valid characters are:
 *
 *	b - byte
 *	w - word (16 bits)
 *	l - long (32 bits)
 *	q - quad (64 bits)
 *	s - string
 *
 * @arg: Pointers to the command to check. If a valid specifier is present it
 *	will be the last character of the string, following a '.'
 * @default_size: Default size to return if there is no specifier
 * @return data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid
 *	character, or CMD_DATA_SIZE_STR for a string
 */
int cmd_get_data_size(char *arg, int default_size);
#endif

#ifdef CONFIG_CMD_BOOTD
int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc,
	     char *const argv[]);
#endif
#ifdef CONFIG_CMD_BOOTM
int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc,
	     char *const argv[]);
int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd);
#else
static inline int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd)
{
	return 0;
}
#endif

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

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

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

int common_diskboot(struct cmd_tbl *cmdtp, const char *intf, int argc,
		    char *const argv[]);

int do_reset(struct cmd_tbl *cmdtp, int flag, int argc,
	     char *const argv[]);
int do_poweroff(struct cmd_tbl *cmdtp, int flag, int argc,
		char *const argv[]);

unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
			 char *const argv[]);

#if defined(CONFIG_CMD_NVEDIT_EFI)
int do_env_print_efi(struct cmd_tbl *cmdtp, int flag, int argc,
		     char *const argv[]);
int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc,
		   char *const argv[]);
#endif

/**
 * setexpr_regex_sub() - Replace a regex pattern with a string
 *
 * @data: Buffer containing the string to update
 * @data_size: Size of buffer (must be large enough for the new string)
 * @nbuf: Back-reference buffer
 * @nbuf_size: Size of back-reference buffer (must be larger enough for @s plus
 *	all back-reference expansions)
 * @r: Regular expression to find
 * @s: String to replace with
 * @global: true to replace all matches in @data, false to replace just the
 *	first
 * @return 0 if OK, 1 on error
 */
int setexpr_regex_sub(char *data, uint data_size, char *nbuf, uint nbuf_size,
		      const char *r, const char *s, bool global);

/*
 * Error codes that commands return to cmd_process(). We use the standard 0
 * and 1 for success and failure, but add one more case - failure with a
 * request to call cmd_usage(). But the cmd_process() function handles
 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
 * This is just a convenience for commands to avoid them having to call
 * cmd_usage() all over the place.
 */
enum command_ret_t {
	CMD_RET_SUCCESS,	/* 0 = Success */
	CMD_RET_FAILURE,	/* 1 = Failure */
	CMD_RET_USAGE = -1,	/* Failure, please report 'usage' error */
};

/**
 * Process a command with arguments. We look up the command and execute it
 * if valid. Otherwise we print a usage message.
 *
 * @param flag		Some flags normally 0 (see CMD_FLAG_.. above)
 * @param argc		Number of arguments (arg 0 must be the command text)
 * @param argv		Arguments
 * @param repeatable	This function sets this to 0 if the command is not
 *			repeatable. If the command is repeatable, the value
 *			is left unchanged.
 * @param ticks		If ticks is not null, this function set it to the
 *			number of ticks the command took to complete.
 * @return 0 if the command succeeded, 1 if it failed
 */
int cmd_process(int flag, int argc, char *const argv[], int *repeatable,
		unsigned long *ticks);

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

/**
 * board_run_command() - Fallback function to execute a command
 *
 * When no command line features are enabled in U-Boot, this function is
 * called to execute a command. Typically the function can look at the
 * command and perform a few very specific tasks, such as booting the
 * system in a particular way.
 *
 * This function is only used when CONFIG_CMDLINE is not enabled.
 *
 * In normal situations this function should not return, since U-Boot will
 * simply hang.
 *
 * @cmdline:	Command line string to execute
 * @return 0 if OK, 1 for error
 */
int board_run_command(const char *cmdline);

int run_command(const char *cmd, int flag);
int run_command_repeatable(const char *cmd, int flag);

/**
 * Run a list of commands separated by ; or even \0
 *
 * Note that if 'len' is not -1, then the command does not need to be nul
 * terminated, Memory will be allocated for the command in that case.
 *
 * @param cmd	List of commands to run, each separated bu semicolon
 * @param len	Length of commands excluding terminator if known (-1 if not)
 * @param flag	Execution flags (CMD_FLAG_...)
 * @return 0 on success, or != 0 on error.
 */
int run_command_list(const char *cmd, int len, int flag);
#endif	/* __ASSEMBLY__ */

/*
 * Command Flags:
 */
#define CMD_FLAG_REPEAT		0x0001	/* repeat last command		*/
#define CMD_FLAG_BOOTD		0x0002	/* command is from bootd	*/
#define CMD_FLAG_ENV		0x0004	/* command is from the environment */

#ifdef CONFIG_AUTO_COMPLETE
# define _CMD_COMPLETE(x) x,
#else
# define _CMD_COMPLETE(x)
#endif
#ifdef CONFIG_SYS_LONGHELP
# define _CMD_HELP(x) x,
#else
# define _CMD_HELP(x)
#endif

#ifdef CONFIG_NEEDS_MANUAL_RELOC
#define U_BOOT_SUBCMDS_RELOC(_cmdname)					\
	static void _cmdname##_subcmds_reloc(void)			\
	{								\
		static int relocated;					\
									\
		if (relocated)						\
			return;						\
									\
		fixup_cmdtable(_cmdname##_subcmds,			\
			       ARRAY_SIZE(_cmdname##_subcmds));		\
		relocated = 1;						\
	}
#else
#define U_BOOT_SUBCMDS_RELOC(_cmdname)					\
	static void _cmdname##_subcmds_reloc(void) { }
#endif

#define U_BOOT_SUBCMDS_DO_CMD(_cmdname)					\
	static int do_##_cmdname(struct cmd_tbl *cmdtp, int flag,	\
				 int argc, char *const argv[],		\
				 int *repeatable)			\
	{								\
		struct cmd_tbl *subcmd;					\
									\
		_cmdname##_subcmds_reloc();				\
									\
		/* We need at least the cmd and subcmd names. */	\
		if (argc < 2 || argc > CONFIG_SYS_MAXARGS)		\
			return CMD_RET_USAGE;				\
									\
		subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds,	\
				      ARRAY_SIZE(_cmdname##_subcmds));	\
		if (!subcmd || argc - 1 > subcmd->maxargs)		\
			return CMD_RET_USAGE;				\
									\
		if (flag == CMD_FLAG_REPEAT &&				\
		    !cmd_is_repeatable(subcmd))				\
			return CMD_RET_SUCCESS;				\
									\
		return subcmd->cmd_rep(subcmd, flag, argc - 1,		\
				       argv + 1, repeatable);		\
	}

#ifdef CONFIG_AUTO_COMPLETE
#define U_BOOT_SUBCMDS_COMPLETE(_cmdname)				\
	static int complete_##_cmdname(int argc, char *const argv[],	\
				       char last_char, int maxv,	\
				       char *cmdv[])			\
	{								\
		return complete_subcmdv(_cmdname##_subcmds,		\
					ARRAY_SIZE(_cmdname##_subcmds),	\
					argc - 1, argv + 1, last_char,	\
					maxv, cmdv);			\
	}
#else
#define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
#endif

#define U_BOOT_SUBCMDS(_cmdname, ...)					\
	static struct cmd_tbl _cmdname##_subcmds[] = { __VA_ARGS__ };	\
	U_BOOT_SUBCMDS_RELOC(_cmdname)					\
	U_BOOT_SUBCMDS_DO_CMD(_cmdname)					\
	U_BOOT_SUBCMDS_COMPLETE(_cmdname)

#ifdef CONFIG_CMDLINE
#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,		\
				     _usage, _help, _comp)		\
		{ #_name, _maxargs, _cmd_rep, cmd_discard_repeatable,	\
		  _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }

#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,		\
				_usage, _help, _comp)			\
		{ #_name, _maxargs,					\
		 _rep ? cmd_always_repeatable : cmd_never_repeatable,	\
		 _cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }

#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
	ll_entry_declare(struct cmd_tbl, _name, cmd) =			\
		U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,	\
						_usage, _help, _comp);

#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage,	\
			       _help, _comp)				\
	ll_entry_declare(struct cmd_tbl, _name, cmd) =			\
		U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,	\
					     _usage, _help, _comp)

#else
#define U_BOOT_SUBCMD_START(name)	static struct cmd_tbl name[] = {};
#define U_BOOT_SUBCMD_END

#define _CMD_REMOVE(_name, _cmd)					\
	int __remove_ ## _name(void)					\
	{								\
		if (0)							\
			_cmd(NULL, 0, 0, NULL);				\
		return 0;						\
	}

#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,		\
				     _usage, _help, _comp)		\
		{ #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage,	\
			_CMD_HELP(_help) _CMD_COMPLETE(_comp) }

#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage,	\
				  _help, _comp)				\
		{ #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage,	\
			_CMD_HELP(_help) _CMD_COMPLETE(_comp) }

#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help,	\
			    _comp)				\
	_CMD_REMOVE(sub_ ## _name, _cmd)

#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage,	\
			       _help, _comp)				\
	_CMD_REMOVE(sub_ ## _name, _cmd_rep)

#endif /* CONFIG_CMDLINE */

#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)		\
	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)

#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help)	\
	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,		\
					_usage, _help, NULL)

#define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,	\
				     _comp)				\
	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,	\
				  "", "", _comp)

#define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd)		\
	U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,	\
				     NULL)

#define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...)		\
	U_BOOT_SUBCMDS(_name, __VA_ARGS__)				\
	U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name,	\
			       _usage, _help, complete_##_name)

#endif	/* __COMMAND_H */
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
78f6622a	2	/*
2dce551e	3	* (C) Copyright 2000-2009
78f6622a	4	* Wolfgang Denk, DENX Software Engineering, [email protected].
78f6622a WD	5	*/
	6
	7	/*
	8	* Definitions for Command Processor
	9	*/
	10	#ifndef __COMMAND_H
	11	#define __COMMAND_H
	12
9fb625ce	13	#include <env.h>
6c7c946c	14	#include <linker_lists.h>
f2302d44	15
78f6622a WD	16	#ifndef NULL
	17	#define NULL 0
	18	#endif
	19
2fb2604d PT	20	/* Default to a width of 8 characters for help message command width */
2fb2604d PT	21	#ifndef CONFIG_SYS_HELP_CMD_WIDTH
9eebaba2	22	#define CONFIG_SYS_HELP_CMD_WIDTH 10
2fb2604d PT	23	#endif
2fb2604d PT	24
78f6622a WD	25	#ifndef __ASSEMBLY__
	26	/*
	27	* Monitor Command Table
	28	*/
	29
09140113	30	struct cmd_tbl {
78f6622a	31	char name; / Command Name */
78f6622a	32	int maxargs; /* maximum number of arguments */
80a48dd4 BB	33	/*
	34	* Same as ->cmd() except the command
	35	* tells us if it can be repeated.
	36	* Replaces the old ->repeatable field
	37	* which was not able to make
	38	* repeatable property different for
	39	* the main command and sub-commands.
	40	*/
09140113 SG	41	int (cmd_rep)(struct cmd_tbl cmd, int flags, int argc,
09140113 SG	42	char const argv[], int repeatable);
78f6622a	43	/* Implementation function */
09140113 SG	44	int (cmd)(struct cmd_tbl cmd, int flags, int argc,
09140113 SG	45	char *const argv[]);
78f6622a	46	char usage; / Usage message (short) */
6d0f6bcf	47	#ifdef CONFIG_SYS_LONGHELP
78f6622a WD	48	char help; / Help message (long) */
78f6622a WD	49	#endif
04a85b3b WD	50	#ifdef CONFIG_AUTO_COMPLETE
04a85b3b WD	51	/* do auto completion on the arguments */
09140113 SG	52	int (complete)(int argc, char const argv[],
09140113 SG	53	char last_char, int maxv, char *cmdv[]);
04a85b3b	54	#endif
78f6622a WD	55	};
78f6622a WD	56
d09b1787	57	#if defined(CONFIG_CMD_RUN)
d3a3d44f KM	58	int do_run(struct cmd_tbl *cmdtp, int flag, int argc,
d3a3d44f KM	59	char *const argv[]);
d09b1787	60	#endif
78f6622a WD	61
78f6622a WD	62	/* common/command.c */
09140113 SG	63	int _do_help(struct cmd_tbl cmd_start, int cmd_items, struct cmd_tbl cmdtp,
	64	int flag, int argc, char *const argv[]);
	65	struct cmd_tbl find_cmd(const char cmd);
	66	struct cmd_tbl find_cmd_tbl(const char cmd, struct cmd_tbl *table,
	67	int table_len);
	68	int complete_subcmdv(struct cmd_tbl *cmdtp, int count, int argc,
	69	char *const argv[], char last_char, int maxv,
6fb61445	70	char *cmdv[]);
78f6622a	71
d3a3d44f	72	int cmd_usage(const struct cmd_tbl *cmdtp);
62c3ae7c	73
80a48dd4	74	/* Dummy ->cmd and ->cmd_rep wrappers. */
09140113 SG	75	int cmd_always_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
	76	char const argv[], int repeatable);
	77	int cmd_never_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
	78	char const argv[], int repeatable);
	79	int cmd_discard_repeatable(struct cmd_tbl *cmdtp, int flag, int argc,
	80	char *const argv[]);
	81
	82	static inline bool cmd_is_repeatable(struct cmd_tbl *cmdtp)
80a48dd4 BB	83	{
	84	return cmdtp->cmd_rep == cmd_always_repeatable;
	85	}
	86
04a85b3b	87	#ifdef CONFIG_AUTO_COMPLETE
d3a3d44f KM	88	int var_complete(int argc, char *const argv[], char last_char, int maxv,
	89	char *cmdv[]);
	90	int cmd_auto_complete(const char const prompt, char buf, int *np,
	91	int *colp);
04a85b3b WD	92	#endif
04a85b3b WD	93
16ff9902 SG	94	/**
	95	* cmd_process_error() - report and process a possible error
	96	*
	97	* @cmdtp: Command which caused the error
	98	* @err: Error code (0 if none, -ve for error, like -EIO)
8a3d734b	99	* @return 0 (CMD_RET_SUCCESS) if there is not error,
27eb7bce MS	100	* 1 (CMD_RET_FAILURE) if an error is found
27eb7bce MS	101	* -1 (CMD_RET_USAGE) if 'usage' error is found
16ff9902	102	*/
09140113	103	int cmd_process_error(struct cmd_tbl *cmdtp, int err);
16ff9902	104
78f6622a WD	105	/*
	106	* Monitor Command
	107	*
	108	* All commands use a common argument format:
	109	*
09140113 SG	110	* void function(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	111	* char *const argv[]);
78f6622a WD	112	*/
78f6622a WD	113
6f62d7c4 SG	114	#if defined(CONFIG_CMD_MEMORY) \|\| \
	115	defined(CONFIG_CMD_I2C) \|\| \
	116	defined(CONFIG_CMD_ITEST) \|\| \
75846445 BG	117	defined(CONFIG_CMD_PCI) \|\| \
75846445 BG	118	defined(CONFIG_CMD_SETEXPR)
8a40fb14	119	#define CMD_DATA_SIZE
7526deec SG	120	#define CMD_DATA_SIZE_ERR (-1)
	121	#define CMD_DATA_SIZE_STR (-2)
	122
	123	/**
	124	* cmd_get_data_size() - Get the data-size specifier from a command
	125	*
	126	* This reads a '.x' size specifier appended to a command. For example 'md.b'
	127	* is the 'md' command with a '.b' specifier, meaning that the command should
	128	* use bytes.
	129	*
	130	* Valid characters are:
	131	*
	132	* b - byte
	133	* w - word (16 bits)
	134	* l - long (32 bits)
	135	* q - quad (64 bits)
	136	* s - string
	137	*
	138	* @arg: Pointers to the command to check. If a valid specifier is present it
	139	* will be the last character of the string, following a '.'
	140	* @default_size: Default size to return if there is no specifier
	141	* @return data size in bytes (1, 2, 4, 8) or CMD_DATA_SIZE_ERR for an invalid
	142	* character, or CMD_DATA_SIZE_STR for a string
	143	*/
	144	int cmd_get_data_size(char *arg, int default_size);
8a40fb14 JCPV	145	#endif
8a40fb14 JCPV	146
7842fb7c	147	#ifdef CONFIG_CMD_BOOTD
d3a3d44f KM	148	int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc,
d3a3d44f KM	149	char *const argv[]);
7842fb7c	150	#endif
67d668bf	151	#ifdef CONFIG_CMD_BOOTM
d3a3d44f KM	152	int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc,
	153	char *const argv[]);
	154	int bootm_maybe_autostart(struct cmd_tbl cmdtp, const char cmd);
67d668bf	155	#else
09140113	156	static inline int bootm_maybe_autostart(struct cmd_tbl cmdtp, const char cmd)
67d668bf MF	157	{
	158	return 0;
	159	}
	160	#endif
7405a133	161
d3a3d44f KM	162	int do_bootz(struct cmd_tbl *cmdtp, int flag, int argc,
d3a3d44f KM	163	char *const argv[]);
da620222	164
d3a3d44f KM	165	int do_booti(struct cmd_tbl *cmdtp, int flag, int argc,
d3a3d44f KM	166	char *const argv[]);
8b5c738b	167
18c25821 KM	168	int do_zboot_parent(struct cmd_tbl *cmdtp, int flag, int argc,
	169	char const argv[], int repeatable);
	170
d3a3d44f	171	int common_diskboot(struct cmd_tbl cmdtp, const char intf, int argc,
09140113	172	char *const argv[]);
36ebb787	173
d3a3d44f KM	174	int do_reset(struct cmd_tbl *cmdtp, int flag, int argc,
	175	char *const argv[]);
	176	int do_poweroff(struct cmd_tbl *cmdtp, int flag, int argc,
	177	char *const argv[]);
	178
	179	unsigned long do_go_exec(ulong (entry)(int, char const []), int argc,
	180	char *const argv[]);
49d81fdf AT	181
49d81fdf AT	182	#if defined(CONFIG_CMD_NVEDIT_EFI)
d3a3d44f KM	183	int do_env_print_efi(struct cmd_tbl *cmdtp, int flag, int argc,
	184	char *const argv[]);
	185	int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc,
	186	char *const argv[]);
49d81fdf AT	187	#endif
49d81fdf AT	188
d422c77a SG	189	/**
	190	* setexpr_regex_sub() - Replace a regex pattern with a string
	191	*
	192	* @data: Buffer containing the string to update
	193	* @data_size: Size of buffer (must be large enough for the new string)
	194	* @nbuf: Back-reference buffer
	195	* @nbuf_size: Size of back-reference buffer (must be larger enough for @s plus
	196	* all back-reference expansions)
	197	* @r: Regular expression to find
	198	* @s: String to replace with
	199	* @global: true to replace all matches in @data, false to replace just the
	200	* first
	201	* @return 0 if OK, 1 on error
	202	*/
	203	int setexpr_regex_sub(char data, uint data_size, char nbuf, uint nbuf_size,
	204	const char r, const char s, bool global);
	205
9d12d5d4 SG	206	/*
	207	* Error codes that commands return to cmd_process(). We use the standard 0
	208	* and 1 for success and failure, but add one more case - failure with a
	209	* request to call cmd_usage(). But the cmd_process() function handles
	210	* CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
	211	* This is just a convenience for commands to avoid them having to call
	212	* cmd_usage() all over the place.
	213	*/
	214	enum command_ret_t {
	215	CMD_RET_SUCCESS, /* 0 = Success */
	216	CMD_RET_FAILURE, /* 1 = Failure */
	217	CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
	218	};
	219
	220	/**
	221	* Process a command with arguments. We look up the command and execute it
	222	* if valid. Otherwise we print a usage message.
	223	*
	224	* @param flag Some flags normally 0 (see CMD_FLAG_.. above)
	225	* @param argc Number of arguments (arg 0 must be the command text)
	226	* @param argv Arguments
	227	* @param repeatable This function sets this to 0 if the command is not
	228	* repeatable. If the command is repeatable, the value
	229	* is left unchanged.
34765e88 RG	230	* @param ticks If ticks is not null, this function set it to the
34765e88 RG	231	* number of ticks the command took to complete.
9d12d5d4 SG	232	* @return 0 if the command succeeded, 1 if it failed
9d12d5d4 SG	233	*/
09140113 SG	234	int cmd_process(int flag, int argc, char const argv[], int repeatable,
09140113 SG	235	unsigned long *ticks);
bdf8e34b	236
09140113	237	void fixup_cmdtable(struct cmd_tbl *cmdtp, int size);
f8bb6964 SG	238
	239	/**
	240	* board_run_command() - Fallback function to execute a command
	241	*
	242	* When no command line features are enabled in U-Boot, this function is
	243	* called to execute a command. Typically the function can look at the
	244	* command and perform a few very specific tasks, such as booting the
	245	* system in a particular way.
	246	*
	247	* This function is only used when CONFIG_CMDLINE is not enabled.
	248	*
	249	* In normal situations this function should not return, since U-Boot will
	250	* simply hang.
	251	*
	252	* @cmdline: Command line string to execute
	253	* @return 0 if OK, 1 for error
	254	*/
	255	int board_run_command(const char *cmdline);
288b29e4 SG	256
	257	int run_command(const char *cmd, int flag);
	258	int run_command_repeatable(const char *cmd, int flag);
	259
	260	/**
	261	* Run a list of commands separated by ; or even \0
	262	*
	263	* Note that if 'len' is not -1, then the command does not need to be nul
	264	* terminated, Memory will be allocated for the command in that case.
	265	*
	266	* @param cmd List of commands to run, each separated bu semicolon
	267	* @param len Length of commands excluding terminator if known (-1 if not)
	268	* @param flag Execution flags (CMD_FLAG_...)
	269	* @return 0 on success, or != 0 on error.
	270	*/
	271	int run_command_list(const char *cmd, int len, int flag);
78f6622a WD	272	#endif /* __ASSEMBLY__ */
	273
	274	/*
	275	* Command Flags:
	276	*/
	277	#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
	278	#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
87b6398b	279	#define CMD_FLAG_ENV 0x0004 /* command is from the environment */
78f6622a	280
722b061b MF	281	#ifdef CONFIG_AUTO_COMPLETE
	282	# define _CMD_COMPLETE(x) x,
	283	#else
	284	# define _CMD_COMPLETE(x)
	285	#endif
	286	#ifdef CONFIG_SYS_LONGHELP
	287	# define _CMD_HELP(x) x,
	288	#else
	289	# define _CMD_HELP(x)
	290	#endif
8bde7f77	291
c0cf06e5 BB	292	#ifdef CONFIG_NEEDS_MANUAL_RELOC
	293	#define U_BOOT_SUBCMDS_RELOC(_cmdname) \
	294	static void _cmdname##_subcmds_reloc(void) \
	295	{ \
	296	static int relocated; \
	297	\
	298	if (relocated) \
	299	return; \
	300	\
	301	fixup_cmdtable(_cmdname##_subcmds, \
	302	ARRAY_SIZE(_cmdname##_subcmds)); \
	303	relocated = 1; \
	304	}
	305	#else
	306	#define U_BOOT_SUBCMDS_RELOC(_cmdname) \
	307	static void _cmdname##_subcmds_reloc(void) { }
	308	#endif
	309
	310	#define U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
09140113 SG	311	static int do_##_cmdname(struct cmd_tbl *cmdtp, int flag, \
	312	int argc, char *const argv[], \
	313	int *repeatable) \
c0cf06e5	314	{ \
09140113	315	struct cmd_tbl *subcmd; \
c0cf06e5 BB	316	\
	317	_cmdname##_subcmds_reloc(); \
	318	\
	319	/* We need at least the cmd and subcmd names. */ \
	320	if (argc < 2 \|\| argc > CONFIG_SYS_MAXARGS) \
	321	return CMD_RET_USAGE; \
	322	\
	323	subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds, \
	324	ARRAY_SIZE(_cmdname##_subcmds)); \
	325	if (!subcmd \|\| argc - 1 > subcmd->maxargs) \
	326	return CMD_RET_USAGE; \
	327	\
	328	if (flag == CMD_FLAG_REPEAT && \
	329	!cmd_is_repeatable(subcmd)) \
	330	return CMD_RET_SUCCESS; \
	331	\
	332	return subcmd->cmd_rep(subcmd, flag, argc - 1, \
	333	argv + 1, repeatable); \
	334	}
	335
	336	#ifdef CONFIG_AUTO_COMPLETE
	337	#define U_BOOT_SUBCMDS_COMPLETE(_cmdname) \
09140113	338	static int complete_##_cmdname(int argc, char *const argv[], \
c0cf06e5 BB	339	char last_char, int maxv, \
	340	char *cmdv[]) \
	341	{ \
	342	return complete_subcmdv(_cmdname##_subcmds, \
	343	ARRAY_SIZE(_cmdname##_subcmds), \
	344	argc - 1, argv + 1, last_char, \
	345	maxv, cmdv); \
	346	}
	347	#else
	348	#define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
	349	#endif
	350
	351	#define U_BOOT_SUBCMDS(_cmdname, ...) \
09140113	352	static struct cmd_tbl _cmdname##_subcmds[] = { __VA_ARGS__ }; \
c0cf06e5 BB	353	U_BOOT_SUBCMDS_RELOC(_cmdname) \
	354	U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
	355	U_BOOT_SUBCMDS_COMPLETE(_cmdname)
	356
fb24112c	357	#ifdef CONFIG_CMDLINE
80a48dd4 BB	358	#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	359	_usage, _help, _comp) \
	360	{ #_name, _maxargs, _cmd_rep, cmd_discard_repeatable, \
	361	_usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	362
6c7c946c MV	363	#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
6c7c946c MV	364	_usage, _help, _comp) \
80a48dd4 BB	365	{ #_name, _maxargs, \
	366	_rep ? cmd_always_repeatable : cmd_never_repeatable, \
	367	_cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
8bde7f77	368
6c7c946c	369	#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
09140113	370	ll_entry_declare(struct cmd_tbl, _name, cmd) = \
6c7c946c MV	371	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
6c7c946c MV	372	_usage, _help, _comp);
8bde7f77	373
80a48dd4 BB	374	#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
80a48dd4 BB	375	_help, _comp) \
09140113	376	ll_entry_declare(struct cmd_tbl, _name, cmd) = \
80a48dd4 BB	377	U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	378	_usage, _help, _comp)
	379
fb24112c	380	#else
09140113	381	#define U_BOOT_SUBCMD_START(name) static struct cmd_tbl name[] = {};
fb24112c SG	382	#define U_BOOT_SUBCMD_END
	383
	384	#define _CMD_REMOVE(_name, _cmd) \
	385	int __remove_ ## _name(void) \
	386	{ \
	387	if (0) \
	388	_cmd(NULL, 0, 0, NULL); \
	389	return 0; \
	390	}
80a48dd4 BB	391
	392	#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	393	_usage, _help, _comp) \
	394	{ #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage, \
	395	_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	396
fb24112c SG	397	#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
fb24112c SG	398	_help, _comp) \
80a48dd4	399	{ #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage, \
fb24112c SG	400	_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	401
	402	#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
	403	_comp) \
	404	_CMD_REMOVE(sub_ ## _name, _cmd)
	405
80a48dd4 BB	406	#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
	407	_help, _comp) \
	408	_CMD_REMOVE(sub_ ## _name, _cmd_rep)
	409
fb24112c SG	410	#endif /* CONFIG_CMDLINE */
fb24112c SG	411
6c7c946c MV	412	#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
6c7c946c MV	413	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
8bde7f77	414
fb24112c SG	415	#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
	416	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
	417	_usage, _help, NULL)
	418
c0cf06e5 BB	419	#define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	420	_comp) \
	421	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	422	"", "", _comp)
	423
	424	#define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd) \
	425	U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	426	NULL)
	427
	428	#define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...) \
	429	U_BOOT_SUBCMDS(_name, __VA_ARGS__) \
	430	U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name, \
	431	_usage, _help, complete_##_name)
	432
78f6622a	433	#endif /* __COMMAND_H */