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

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * (C) Copyright 2000-2009
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 */

/*
 *  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)
extern 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[]);

extern 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
extern int var_complete(int argc, char *const argv[], char last_char, int maxv,
			char *cmdv[]);
extern 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
extern int cmd_get_data_size(char* arg, int default_size);
#endif

#ifdef CONFIG_CMD_BOOTD
extern int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc,
		    char *const argv[]);
#endif
#ifdef CONFIG_CMD_BOOTM
extern int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc,
		    char *const argv[]);
extern 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

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

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

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

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

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

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

/*
 * 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, wd@denx.de.
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)
09140113 SG	58	extern int do_run(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	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
09140113	72	extern 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
09140113 SG	88	extern int var_complete(int argc, char *const argv[], char last_char, int maxv,
	89	char *cmdv[]);
	90	extern 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 JCPV	119	#define CMD_DATA_SIZE
	120	extern int cmd_get_data_size(char* arg, int default_size);
	121	#endif
	122
7842fb7c	123	#ifdef CONFIG_CMD_BOOTD
09140113 SG	124	extern int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	125	char *const argv[]);
7842fb7c	126	#endif
67d668bf	127	#ifdef CONFIG_CMD_BOOTM
09140113 SG	128	extern int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc,
	129	char *const argv[]);
	130	extern int bootm_maybe_autostart(struct cmd_tbl cmdtp, const char cmd);
67d668bf	131	#else
09140113	132	static inline int bootm_maybe_autostart(struct cmd_tbl cmdtp, const char cmd)
67d668bf MF	133	{
	134	return 0;
	135	}
	136	#endif
7405a133	137
09140113 SG	138	extern int do_bootz(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	139	char *const argv[]);
da620222	140
09140113 SG	141	extern int do_booti(struct cmd_tbl *cmdtp, int flag, int argc,
09140113 SG	142	char *const argv[]);
8b5c738b	143
09140113	144	extern int common_diskboot(struct cmd_tbl cmdtp, const char intf, int argc,
7405a133 RH	145	char *const argv[]);
7405a133 RH	146
09140113 SG	147	extern int do_reset(struct cmd_tbl *cmdtp, int flag, int argc,
	148	char *const argv[]);
	149	extern int do_poweroff(struct cmd_tbl *cmdtp, int flag, int argc,
	150	char *const argv[]);
36ebb787	151
51916864	152	extern unsigned long do_go_exec(ulong (entry)(int, char const []), int argc,
09140113	153	char *const argv[]);
49d81fdf AT	154
49d81fdf AT	155	#if defined(CONFIG_CMD_NVEDIT_EFI)
09140113 SG	156	extern int do_env_print_efi(struct cmd_tbl *cmdtp, int flag, int argc,
	157	char *const argv[]);
	158	extern int do_env_set_efi(struct cmd_tbl *cmdtp, int flag, int argc,
	159	char *const argv[]);
49d81fdf AT	160	#endif
49d81fdf AT	161
9d12d5d4 SG	162	/*
	163	* Error codes that commands return to cmd_process(). We use the standard 0
	164	* and 1 for success and failure, but add one more case - failure with a
	165	* request to call cmd_usage(). But the cmd_process() function handles
	166	* CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
	167	* This is just a convenience for commands to avoid them having to call
	168	* cmd_usage() all over the place.
	169	*/
	170	enum command_ret_t {
	171	CMD_RET_SUCCESS, /* 0 = Success */
	172	CMD_RET_FAILURE, /* 1 = Failure */
	173	CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
	174	};
	175
	176	/**
	177	* Process a command with arguments. We look up the command and execute it
	178	* if valid. Otherwise we print a usage message.
	179	*
	180	* @param flag Some flags normally 0 (see CMD_FLAG_.. above)
	181	* @param argc Number of arguments (arg 0 must be the command text)
	182	* @param argv Arguments
	183	* @param repeatable This function sets this to 0 if the command is not
	184	* repeatable. If the command is repeatable, the value
	185	* is left unchanged.
34765e88 RG	186	* @param ticks If ticks is not null, this function set it to the
34765e88 RG	187	* number of ticks the command took to complete.
9d12d5d4 SG	188	* @return 0 if the command succeeded, 1 if it failed
9d12d5d4 SG	189	*/
09140113 SG	190	int cmd_process(int flag, int argc, char const argv[], int repeatable,
09140113 SG	191	unsigned long *ticks);
bdf8e34b	192
09140113	193	void fixup_cmdtable(struct cmd_tbl *cmdtp, int size);
f8bb6964 SG	194
	195	/**
	196	* board_run_command() - Fallback function to execute a command
	197	*
	198	* When no command line features are enabled in U-Boot, this function is
	199	* called to execute a command. Typically the function can look at the
	200	* command and perform a few very specific tasks, such as booting the
	201	* system in a particular way.
	202	*
	203	* This function is only used when CONFIG_CMDLINE is not enabled.
	204	*
	205	* In normal situations this function should not return, since U-Boot will
	206	* simply hang.
	207	*
	208	* @cmdline: Command line string to execute
	209	* @return 0 if OK, 1 for error
	210	*/
	211	int board_run_command(const char *cmdline);
288b29e4 SG	212
	213	int run_command(const char *cmd, int flag);
	214	int run_command_repeatable(const char *cmd, int flag);
	215
	216	/**
	217	* Run a list of commands separated by ; or even \0
	218	*
	219	* Note that if 'len' is not -1, then the command does not need to be nul
	220	* terminated, Memory will be allocated for the command in that case.
	221	*
	222	* @param cmd List of commands to run, each separated bu semicolon
	223	* @param len Length of commands excluding terminator if known (-1 if not)
	224	* @param flag Execution flags (CMD_FLAG_...)
	225	* @return 0 on success, or != 0 on error.
	226	*/
	227	int run_command_list(const char *cmd, int len, int flag);
78f6622a WD	228	#endif /* __ASSEMBLY__ */
	229
	230	/*
	231	* Command Flags:
	232	*/
	233	#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
	234	#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
87b6398b	235	#define CMD_FLAG_ENV 0x0004 /* command is from the environment */
78f6622a	236
722b061b MF	237	#ifdef CONFIG_AUTO_COMPLETE
	238	# define _CMD_COMPLETE(x) x,
	239	#else
	240	# define _CMD_COMPLETE(x)
	241	#endif
	242	#ifdef CONFIG_SYS_LONGHELP
	243	# define _CMD_HELP(x) x,
	244	#else
	245	# define _CMD_HELP(x)
	246	#endif
8bde7f77	247
c0cf06e5 BB	248	#ifdef CONFIG_NEEDS_MANUAL_RELOC
	249	#define U_BOOT_SUBCMDS_RELOC(_cmdname) \
	250	static void _cmdname##_subcmds_reloc(void) \
	251	{ \
	252	static int relocated; \
	253	\
	254	if (relocated) \
	255	return; \
	256	\
	257	fixup_cmdtable(_cmdname##_subcmds, \
	258	ARRAY_SIZE(_cmdname##_subcmds)); \
	259	relocated = 1; \
	260	}
	261	#else
	262	#define U_BOOT_SUBCMDS_RELOC(_cmdname) \
	263	static void _cmdname##_subcmds_reloc(void) { }
	264	#endif
	265
	266	#define U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
09140113 SG	267	static int do_##_cmdname(struct cmd_tbl *cmdtp, int flag, \
	268	int argc, char *const argv[], \
	269	int *repeatable) \
c0cf06e5	270	{ \
09140113	271	struct cmd_tbl *subcmd; \
c0cf06e5 BB	272	\
	273	_cmdname##_subcmds_reloc(); \
	274	\
	275	/* We need at least the cmd and subcmd names. */ \
	276	if (argc < 2 \|\| argc > CONFIG_SYS_MAXARGS) \
	277	return CMD_RET_USAGE; \
	278	\
	279	subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds, \
	280	ARRAY_SIZE(_cmdname##_subcmds)); \
	281	if (!subcmd \|\| argc - 1 > subcmd->maxargs) \
	282	return CMD_RET_USAGE; \
	283	\
	284	if (flag == CMD_FLAG_REPEAT && \
	285	!cmd_is_repeatable(subcmd)) \
	286	return CMD_RET_SUCCESS; \
	287	\
	288	return subcmd->cmd_rep(subcmd, flag, argc - 1, \
	289	argv + 1, repeatable); \
	290	}
	291
	292	#ifdef CONFIG_AUTO_COMPLETE
	293	#define U_BOOT_SUBCMDS_COMPLETE(_cmdname) \
09140113	294	static int complete_##_cmdname(int argc, char *const argv[], \
c0cf06e5 BB	295	char last_char, int maxv, \
	296	char *cmdv[]) \
	297	{ \
	298	return complete_subcmdv(_cmdname##_subcmds, \
	299	ARRAY_SIZE(_cmdname##_subcmds), \
	300	argc - 1, argv + 1, last_char, \
	301	maxv, cmdv); \
	302	}
	303	#else
	304	#define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
	305	#endif
	306
	307	#define U_BOOT_SUBCMDS(_cmdname, ...) \
09140113	308	static struct cmd_tbl _cmdname##_subcmds[] = { __VA_ARGS__ }; \
c0cf06e5 BB	309	U_BOOT_SUBCMDS_RELOC(_cmdname) \
	310	U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
	311	U_BOOT_SUBCMDS_COMPLETE(_cmdname)
	312
fb24112c	313	#ifdef CONFIG_CMDLINE
80a48dd4 BB	314	#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	315	_usage, _help, _comp) \
	316	{ #_name, _maxargs, _cmd_rep, cmd_discard_repeatable, \
	317	_usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	318
6c7c946c MV	319	#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
6c7c946c MV	320	_usage, _help, _comp) \
80a48dd4 BB	321	{ #_name, _maxargs, \
	322	_rep ? cmd_always_repeatable : cmd_never_repeatable, \
	323	_cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
8bde7f77	324
6c7c946c	325	#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
09140113	326	ll_entry_declare(struct cmd_tbl, _name, cmd) = \
6c7c946c MV	327	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
6c7c946c MV	328	_usage, _help, _comp);
8bde7f77	329
80a48dd4 BB	330	#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
80a48dd4 BB	331	_help, _comp) \
09140113	332	ll_entry_declare(struct cmd_tbl, _name, cmd) = \
80a48dd4 BB	333	U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	334	_usage, _help, _comp)
	335
fb24112c	336	#else
09140113	337	#define U_BOOT_SUBCMD_START(name) static struct cmd_tbl name[] = {};
fb24112c SG	338	#define U_BOOT_SUBCMD_END
	339
	340	#define _CMD_REMOVE(_name, _cmd) \
	341	int __remove_ ## _name(void) \
	342	{ \
	343	if (0) \
	344	_cmd(NULL, 0, 0, NULL); \
	345	return 0; \
	346	}
80a48dd4 BB	347
	348	#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	349	_usage, _help, _comp) \
	350	{ #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage, \
	351	_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	352
fb24112c SG	353	#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
fb24112c SG	354	_help, _comp) \
80a48dd4	355	{ #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage, \
fb24112c SG	356	_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	357
	358	#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
	359	_comp) \
	360	_CMD_REMOVE(sub_ ## _name, _cmd)
	361
80a48dd4 BB	362	#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
	363	_help, _comp) \
	364	_CMD_REMOVE(sub_ ## _name, _cmd_rep)
	365
fb24112c SG	366	#endif /* CONFIG_CMDLINE */
fb24112c SG	367
6c7c946c MV	368	#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
6c7c946c MV	369	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
8bde7f77	370
fb24112c SG	371	#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
	372	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
	373	_usage, _help, NULL)
	374
c0cf06e5 BB	375	#define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	376	_comp) \
	377	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	378	"", "", _comp)
	379
	380	#define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd) \
	381	U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	382	NULL)
	383
	384	#define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...) \
	385	U_BOOT_SUBCMDS(_name, __VA_ARGS__) \
	386	U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name, \
	387	_usage, _help, complete_##_name)
	388
78f6622a	389	#endif /* __COMMAND_H */