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