[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_s {
	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_s *cmd, int flags, int argc,
				   char * const argv[], int *repeatable);
					/* Implementation function	*/
	int		(*cmd)(struct cmd_tbl_s *, int, int, char * const []);
	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
};

typedef struct cmd_tbl_s	cmd_tbl_t;


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

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

extern int cmd_usage(const cmd_tbl_t *cmdtp);

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

static inline bool cmd_is_repeatable(cmd_tbl_t *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(cmd_tbl_t *cmdtp, int err);

/*
 * Monitor Command
 *
 * All commands use a common argument format:
 *
 * void function (cmd_tbl_t *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(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
#endif
#ifdef CONFIG_CMD_BOOTM
extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
#else
static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
{
	return 0;
}
#endif

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

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

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

extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
extern int do_poweroff(cmd_tbl_t *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(cmd_tbl_t *cmdtp, int flag, int argc,
			    char * const argv[]);
extern int do_env_set_efi(cmd_tbl_t *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(cmd_tbl_t *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(cmd_tbl_t *cmdtp, int flag, int argc,	\
				 char * const argv[], int *repeatable)	\
	{								\
		cmd_tbl_t *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 cmd_tbl_t _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(cmd_tbl_t, _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(cmd_tbl_t, _name, cmd) =			\
		U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,	\
					     _usage, _help, _comp)

#else
#define U_BOOT_SUBCMD_START(name)	static cmd_tbl_t 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
	30	struct cmd_tbl_s {
	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	*/
	41	int (cmd_rep)(struct cmd_tbl_s cmd, int flags, int argc,
	42	char * const argv[], int *repeatable);
78f6622a	43	/* Implementation function */
54841ab5	44	int (cmd)(struct cmd_tbl_s , int, int, char * const []);
78f6622a	45	char usage; / Usage message (short) */
6d0f6bcf	46	#ifdef CONFIG_SYS_LONGHELP
78f6622a WD	47	char help; / Help message (long) */
78f6622a WD	48	#endif
04a85b3b WD	49	#ifdef CONFIG_AUTO_COMPLETE
04a85b3b WD	50	/* do auto completion on the arguments */
54841ab5	51	int (complete)(int argc, char const argv[], char last_char, int maxv, char *cmdv[]);
04a85b3b	52	#endif
78f6622a WD	53	};
	54
	55	typedef struct cmd_tbl_s cmd_tbl_t;
	56
78f6622a	57
d09b1787 IG	58	#if defined(CONFIG_CMD_RUN)
	59	extern int do_run(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
	60	#endif
78f6622a WD	61
78f6622a WD	62	/* common/command.c */
2dce551e	63	int _do_help (cmd_tbl_t cmd_start, int cmd_items, cmd_tbl_t cmdtp, int
54841ab5	64	flag, int argc, char * const argv[]);
78f6622a	65	cmd_tbl_t find_cmd(const char cmd);
b799cb4c	66	cmd_tbl_t find_cmd_tbl (const char cmd, cmd_tbl_t *table, int table_len);
6fb61445 BB	67	int complete_subcmdv(cmd_tbl_t *cmdtp, int count, int argc,
	68	char * const argv[], char last_char, int maxv,
	69	char *cmdv[]);
78f6622a	70
e84ffddb	71	extern int cmd_usage(const cmd_tbl_t *cmdtp);
62c3ae7c	72
80a48dd4 BB	73	/* Dummy ->cmd and ->cmd_rep wrappers. */
	74	int cmd_always_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
	75	char * const argv[], int *repeatable);
	76	int cmd_never_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
	77	char * const argv[], int *repeatable);
	78	int cmd_discard_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
	79	char * const argv[]);
	80
	81	static inline bool cmd_is_repeatable(cmd_tbl_t *cmdtp)
	82	{
	83	return cmdtp->cmd_rep == cmd_always_repeatable;
	84	}
	85
04a85b3b	86	#ifdef CONFIG_AUTO_COMPLETE
722b061b	87	extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
04a85b3b WD	88	extern int cmd_auto_complete(const char const prompt, char buf, int np, int colp);
	89	#endif
	90
16ff9902 SG	91	/**
	92	* cmd_process_error() - report and process a possible error
	93	*
	94	* @cmdtp: Command which caused the error
	95	* @err: Error code (0 if none, -ve for error, like -EIO)
8a3d734b	96	* @return 0 (CMD_RET_SUCCESS) if there is not error,
27eb7bce MS	97	* 1 (CMD_RET_FAILURE) if an error is found
27eb7bce MS	98	* -1 (CMD_RET_USAGE) if 'usage' error is found
16ff9902 SG	99	*/
	100	int cmd_process_error(cmd_tbl_t *cmdtp, int err);
	101
78f6622a WD	102	/*
	103	* Monitor Command
	104	*
	105	* All commands use a common argument format:
	106	*
54841ab5	107	* void function (cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
78f6622a WD	108	*/
78f6622a WD	109
6f62d7c4 SG	110	#if defined(CONFIG_CMD_MEMORY) \|\| \
	111	defined(CONFIG_CMD_I2C) \|\| \
	112	defined(CONFIG_CMD_ITEST) \|\| \
75846445 BG	113	defined(CONFIG_CMD_PCI) \|\| \
75846445 BG	114	defined(CONFIG_CMD_SETEXPR)
8a40fb14 JCPV	115	#define CMD_DATA_SIZE
	116	extern int cmd_get_data_size(char* arg, int default_size);
	117	#endif
	118
7842fb7c MF	119	#ifdef CONFIG_CMD_BOOTD
	120	extern int do_bootd(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
	121	#endif
67d668bf	122	#ifdef CONFIG_CMD_BOOTM
36ebb787	123	extern int do_bootm(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
67d668bf MF	124	extern int bootm_maybe_autostart(cmd_tbl_t cmdtp, const char cmd);
	125	#else
	126	static inline int bootm_maybe_autostart(cmd_tbl_t cmdtp, const char cmd)
	127	{
	128	return 0;
	129	}
	130	#endif
7405a133	131
da620222 RH	132	extern int do_bootz(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
da620222 RH	133
8b5c738b SW	134	extern int do_booti(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
8b5c738b SW	135
7405a133 RH	136	extern int common_diskboot(cmd_tbl_t cmdtp, const char intf, int argc,
	137	char *const argv[]);
	138
882b7d72	139	extern int do_reset(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
4e42e29f	140	extern int do_poweroff(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
36ebb787	141
51916864 NJ	142	extern unsigned long do_go_exec(ulong (entry)(int, char const []), int argc,
51916864 NJ	143	char * const argv[]);
49d81fdf AT	144
	145	#if defined(CONFIG_CMD_NVEDIT_EFI)
	146	extern int do_env_print_efi(cmd_tbl_t *cmdtp, int flag, int argc,
	147	char * const argv[]);
	148	extern int do_env_set_efi(cmd_tbl_t *cmdtp, int flag, int argc,
	149	char * const argv[]);
	150	#endif
	151
9d12d5d4 SG	152	/*
	153	* Error codes that commands return to cmd_process(). We use the standard 0
	154	* and 1 for success and failure, but add one more case - failure with a
	155	* request to call cmd_usage(). But the cmd_process() function handles
	156	* CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
	157	* This is just a convenience for commands to avoid them having to call
	158	* cmd_usage() all over the place.
	159	*/
	160	enum command_ret_t {
	161	CMD_RET_SUCCESS, /* 0 = Success */
	162	CMD_RET_FAILURE, /* 1 = Failure */
	163	CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
	164	};
	165
	166	/**
	167	* Process a command with arguments. We look up the command and execute it
	168	* if valid. Otherwise we print a usage message.
	169	*
	170	* @param flag Some flags normally 0 (see CMD_FLAG_.. above)
	171	* @param argc Number of arguments (arg 0 must be the command text)
	172	* @param argv Arguments
	173	* @param repeatable This function sets this to 0 if the command is not
	174	* repeatable. If the command is repeatable, the value
	175	* is left unchanged.
34765e88 RG	176	* @param ticks If ticks is not null, this function set it to the
34765e88 RG	177	* number of ticks the command took to complete.
9d12d5d4 SG	178	* @return 0 if the command succeeded, 1 if it failed
	179	*/
	180	int cmd_process(int flag, int argc, char * const argv[],
34765e88	181	int repeatable, unsigned long ticks);
bdf8e34b	182
cbb2df20	183	void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
f8bb6964 SG	184
	185	/**
	186	* board_run_command() - Fallback function to execute a command
	187	*
	188	* When no command line features are enabled in U-Boot, this function is
	189	* called to execute a command. Typically the function can look at the
	190	* command and perform a few very specific tasks, such as booting the
	191	* system in a particular way.
	192	*
	193	* This function is only used when CONFIG_CMDLINE is not enabled.
	194	*
	195	* In normal situations this function should not return, since U-Boot will
	196	* simply hang.
	197	*
	198	* @cmdline: Command line string to execute
	199	* @return 0 if OK, 1 for error
	200	*/
	201	int board_run_command(const char *cmdline);
288b29e4 SG	202
	203	int run_command(const char *cmd, int flag);
	204	int run_command_repeatable(const char *cmd, int flag);
	205
	206	/**
	207	* Run a list of commands separated by ; or even \0
	208	*
	209	* Note that if 'len' is not -1, then the command does not need to be nul
	210	* terminated, Memory will be allocated for the command in that case.
	211	*
	212	* @param cmd List of commands to run, each separated bu semicolon
	213	* @param len Length of commands excluding terminator if known (-1 if not)
	214	* @param flag Execution flags (CMD_FLAG_...)
	215	* @return 0 on success, or != 0 on error.
	216	*/
	217	int run_command_list(const char *cmd, int len, int flag);
78f6622a WD	218	#endif /* __ASSEMBLY__ */
	219
	220	/*
	221	* Command Flags:
	222	*/
	223	#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
	224	#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
87b6398b	225	#define CMD_FLAG_ENV 0x0004 /* command is from the environment */
78f6622a	226
722b061b MF	227	#ifdef CONFIG_AUTO_COMPLETE
	228	# define _CMD_COMPLETE(x) x,
	229	#else
	230	# define _CMD_COMPLETE(x)
	231	#endif
	232	#ifdef CONFIG_SYS_LONGHELP
	233	# define _CMD_HELP(x) x,
	234	#else
	235	# define _CMD_HELP(x)
	236	#endif
8bde7f77	237
c0cf06e5 BB	238	#ifdef CONFIG_NEEDS_MANUAL_RELOC
	239	#define U_BOOT_SUBCMDS_RELOC(_cmdname) \
	240	static void _cmdname##_subcmds_reloc(void) \
	241	{ \
	242	static int relocated; \
	243	\
	244	if (relocated) \
	245	return; \
	246	\
	247	fixup_cmdtable(_cmdname##_subcmds, \
	248	ARRAY_SIZE(_cmdname##_subcmds)); \
	249	relocated = 1; \
	250	}
	251	#else
	252	#define U_BOOT_SUBCMDS_RELOC(_cmdname) \
	253	static void _cmdname##_subcmds_reloc(void) { }
	254	#endif
	255
	256	#define U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
	257	static int do_##_cmdname(cmd_tbl_t *cmdtp, int flag, int argc, \
	258	char * const argv[], int *repeatable) \
	259	{ \
	260	cmd_tbl_t *subcmd; \
	261	\
	262	_cmdname##_subcmds_reloc(); \
	263	\
	264	/* We need at least the cmd and subcmd names. */ \
	265	if (argc < 2 \|\| argc > CONFIG_SYS_MAXARGS) \
	266	return CMD_RET_USAGE; \
	267	\
	268	subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds, \
	269	ARRAY_SIZE(_cmdname##_subcmds)); \
	270	if (!subcmd \|\| argc - 1 > subcmd->maxargs) \
	271	return CMD_RET_USAGE; \
	272	\
	273	if (flag == CMD_FLAG_REPEAT && \
	274	!cmd_is_repeatable(subcmd)) \
	275	return CMD_RET_SUCCESS; \
	276	\
	277	return subcmd->cmd_rep(subcmd, flag, argc - 1, \
	278	argv + 1, repeatable); \
	279	}
	280
	281	#ifdef CONFIG_AUTO_COMPLETE
	282	#define U_BOOT_SUBCMDS_COMPLETE(_cmdname) \
	283	static int complete_##_cmdname(int argc, char * const argv[], \
	284	char last_char, int maxv, \
	285	char *cmdv[]) \
	286	{ \
	287	return complete_subcmdv(_cmdname##_subcmds, \
	288	ARRAY_SIZE(_cmdname##_subcmds), \
	289	argc - 1, argv + 1, last_char, \
	290	maxv, cmdv); \
	291	}
	292	#else
	293	#define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
	294	#endif
	295
	296	#define U_BOOT_SUBCMDS(_cmdname, ...) \
	297	static cmd_tbl_t _cmdname##_subcmds[] = { __VA_ARGS__ }; \
	298	U_BOOT_SUBCMDS_RELOC(_cmdname) \
	299	U_BOOT_SUBCMDS_DO_CMD(_cmdname) \
	300	U_BOOT_SUBCMDS_COMPLETE(_cmdname)
	301
fb24112c	302	#ifdef CONFIG_CMDLINE
80a48dd4 BB	303	#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	304	_usage, _help, _comp) \
	305	{ #_name, _maxargs, _cmd_rep, cmd_discard_repeatable, \
	306	_usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	307
6c7c946c MV	308	#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
6c7c946c MV	309	_usage, _help, _comp) \
80a48dd4 BB	310	{ #_name, _maxargs, \
	311	_rep ? cmd_always_repeatable : cmd_never_repeatable, \
	312	_cmd, _usage, _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
8bde7f77	313
6c7c946c	314	#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
ef123c52	315	ll_entry_declare(cmd_tbl_t, _name, cmd) = \
6c7c946c MV	316	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
6c7c946c MV	317	_usage, _help, _comp);
8bde7f77	318
80a48dd4 BB	319	#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
	320	_help, _comp) \
	321	ll_entry_declare(cmd_tbl_t, _name, cmd) = \
	322	U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	323	_usage, _help, _comp)
	324
fb24112c SG	325	#else
	326	#define U_BOOT_SUBCMD_START(name) static cmd_tbl_t name[] = {};
	327	#define U_BOOT_SUBCMD_END
	328
	329	#define _CMD_REMOVE(_name, _cmd) \
	330	int __remove_ ## _name(void) \
	331	{ \
	332	if (0) \
	333	_cmd(NULL, 0, 0, NULL); \
	334	return 0; \
	335	}
80a48dd4 BB	336
	337	#define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep, \
	338	_usage, _help, _comp) \
	339	{ #_name, _maxargs, 0 ? _cmd_rep : NULL, NULL, _usage, \
	340	_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	341
fb24112c SG	342	#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, \
fb24112c SG	343	_help, _comp) \
80a48dd4	344	{ #_name, _maxargs, NULL, 0 ? _cmd : NULL, _usage, \
fb24112c SG	345	_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
	346
	347	#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, \
	348	_comp) \
	349	_CMD_REMOVE(sub_ ## _name, _cmd)
	350
80a48dd4 BB	351	#define U_BOOT_CMDREP_COMPLETE(_name, _maxargs, _cmd_rep, _usage, \
	352	_help, _comp) \
	353	_CMD_REMOVE(sub_ ## _name, _cmd_rep)
	354
fb24112c SG	355	#endif /* CONFIG_CMDLINE */
fb24112c SG	356
6c7c946c MV	357	#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
6c7c946c MV	358	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
8bde7f77	359
fb24112c SG	360	#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
	361	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
	362	_usage, _help, NULL)
	363
c0cf06e5 BB	364	#define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	365	_comp) \
	366	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	367	"", "", _comp)
	368
	369	#define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd) \
	370	U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd, \
	371	NULL)
	372
	373	#define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...) \
	374	U_BOOT_SUBCMDS(_name, __VA_ARGS__) \
	375	U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name, \
	376	_usage, _help, complete_##_name)
	377
78f6622a	378	#endif /* __COMMAND_H */