[people/ms/u-boot.git] / include / command.h

/*
 * (C) Copyright 2000-2009
 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

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

#include <config.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	8
#endif

#ifndef	__ASSEMBLY__
/*
 * Monitor Command Table
 */

struct cmd_tbl_s {
	char		*name;		/* Command Name			*/
	int		maxargs;	/* maximum number of arguments	*/
	int		repeatable;	/* autorepeat allowed?		*/
					/* 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);

extern int cmd_usage(const cmd_tbl_t *cmdtp);

#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

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

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

#endif	/* __ASSEMBLY__ */

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

#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

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

#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_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_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)		\
	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)

#if defined(CONFIG_NEEDS_MANUAL_RELOC)
void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
#endif

#endif	/* __COMMAND_H */
Commit	Line	Data
78f6622a	1	/*
2dce551e	2	* (C) Copyright 2000-2009
78f6622a WD	3	* Wolfgang Denk, DENX Software Engineering, wd@denx.de.
	4	*
	5	* See file CREDITS for list of people who contributed to this
	6	* project.
	7	*
	8	* This program is free software; you can redistribute it and/or
	9	* modify it under the terms of the GNU General Public License as
	10	* published by the Free Software Foundation; either version 2 of
	11	* the License, or (at your option) any later version.
	12	*
	13	* This program is distributed in the hope that it will be useful,
	14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	* GNU General Public License for more details.
	17	*
	18	* You should have received a copy of the GNU General Public License
	19	* along with this program; if not, write to the Free Software
	20	* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
	21	* MA 02111-1307 USA
	22	*/
	23
	24	/*
	25	* Definitions for Command Processor
	26	*/
	27	#ifndef __COMMAND_H
	28	#define __COMMAND_H
	29
f2302d44	30	#include <config.h>
6c7c946c	31	#include <linker_lists.h>
f2302d44	32
78f6622a WD	33	#ifndef NULL
	34	#define NULL 0
	35	#endif
	36
2fb2604d PT	37	/* Default to a width of 8 characters for help message command width */
	38	#ifndef CONFIG_SYS_HELP_CMD_WIDTH
	39	#define CONFIG_SYS_HELP_CMD_WIDTH 8
	40	#endif
	41
78f6622a WD	42	#ifndef __ASSEMBLY__
	43	/*
	44	* Monitor Command Table
	45	*/
	46
	47	struct cmd_tbl_s {
	48	char name; / Command Name */
78f6622a WD	49	int maxargs; /* maximum number of arguments */
	50	int repeatable; /* autorepeat allowed? */
	51	/* Implementation function */
54841ab5	52	int (cmd)(struct cmd_tbl_s , int, int, char * const []);
78f6622a	53	char usage; / Usage message (short) */
6d0f6bcf	54	#ifdef CONFIG_SYS_LONGHELP
78f6622a WD	55	char help; / Help message (long) */
78f6622a WD	56	#endif
04a85b3b WD	57	#ifdef CONFIG_AUTO_COMPLETE
04a85b3b WD	58	/* do auto completion on the arguments */
54841ab5	59	int (complete)(int argc, char const argv[], char last_char, int maxv, char *cmdv[]);
04a85b3b	60	#endif
78f6622a WD	61	};
	62
	63	typedef struct cmd_tbl_s cmd_tbl_t;
	64
78f6622a	65
d09b1787 IG	66	#if defined(CONFIG_CMD_RUN)
	67	extern int do_run(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
	68	#endif
78f6622a WD	69
78f6622a WD	70	/* common/command.c */
2dce551e	71	int _do_help (cmd_tbl_t cmd_start, int cmd_items, cmd_tbl_t cmdtp, int
54841ab5	72	flag, int argc, char * const argv[]);
78f6622a	73	cmd_tbl_t find_cmd(const char cmd);
b799cb4c	74	cmd_tbl_t find_cmd_tbl (const char cmd, cmd_tbl_t *table, int table_len);
78f6622a	75
e84ffddb	76	extern int cmd_usage(const cmd_tbl_t *cmdtp);
62c3ae7c	77
04a85b3b	78	#ifdef CONFIG_AUTO_COMPLETE
722b061b	79	extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
04a85b3b WD	80	extern int cmd_auto_complete(const char const prompt, char buf, int np, int colp);
	81	#endif
	82
78f6622a WD	83	/*
	84	* Monitor Command
	85	*
	86	* All commands use a common argument format:
	87	*
54841ab5	88	* void function (cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
78f6622a WD	89	*/
78f6622a WD	90
8a40fb14	91	#if defined(CONFIG_CMD_MEMORY) \
9ad557be VB	92	\|\| defined(CONFIG_CMD_I2C) \
	93	\|\| defined(CONFIG_CMD_ITEST) \
	94	\|\| defined(CONFIG_CMD_PCI) \
	95	\|\| defined(CONFIG_CMD_PORTIO)
8a40fb14 JCPV	96	#define CMD_DATA_SIZE
	97	extern int cmd_get_data_size(char* arg, int default_size);
	98	#endif
	99
7842fb7c MF	100	#ifdef CONFIG_CMD_BOOTD
	101	extern int do_bootd(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
	102	#endif
67d668bf	103	#ifdef CONFIG_CMD_BOOTM
36ebb787	104	extern int do_bootm(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
67d668bf MF	105	extern int bootm_maybe_autostart(cmd_tbl_t cmdtp, const char cmd);
	106	#else
	107	static inline int bootm_maybe_autostart(cmd_tbl_t cmdtp, const char cmd)
	108	{
	109	return 0;
	110	}
	111	#endif
7405a133 RH	112
	113	extern int common_diskboot(cmd_tbl_t cmdtp, const char intf, int argc,
	114	char *const argv[]);
	115
882b7d72	116	extern int do_reset(cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
36ebb787	117
9d12d5d4 SG	118	/*
	119	* Error codes that commands return to cmd_process(). We use the standard 0
	120	* and 1 for success and failure, but add one more case - failure with a
	121	* request to call cmd_usage(). But the cmd_process() function handles
	122	* CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
	123	* This is just a convenience for commands to avoid them having to call
	124	* cmd_usage() all over the place.
	125	*/
	126	enum command_ret_t {
	127	CMD_RET_SUCCESS, /* 0 = Success */
	128	CMD_RET_FAILURE, /* 1 = Failure */
	129	CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
	130	};
	131
	132	/**
	133	* Process a command with arguments. We look up the command and execute it
	134	* if valid. Otherwise we print a usage message.
	135	*
	136	* @param flag Some flags normally 0 (see CMD_FLAG_.. above)
	137	* @param argc Number of arguments (arg 0 must be the command text)
	138	* @param argv Arguments
	139	* @param repeatable This function sets this to 0 if the command is not
	140	* repeatable. If the command is repeatable, the value
	141	* is left unchanged.
34765e88 RG	142	* @param ticks If ticks is not null, this function set it to the
34765e88 RG	143	* number of ticks the command took to complete.
9d12d5d4 SG	144	* @return 0 if the command succeeded, 1 if it failed
	145	*/
	146	int cmd_process(int flag, int argc, char * const argv[],
34765e88	147	int repeatable, unsigned long ticks);
bdf8e34b	148
78f6622a WD	149	#endif /* __ASSEMBLY__ */
	150
	151	/*
	152	* Command Flags:
	153	*/
	154	#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
	155	#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
	156
722b061b MF	157	#ifdef CONFIG_AUTO_COMPLETE
	158	# define _CMD_COMPLETE(x) x,
	159	#else
	160	# define _CMD_COMPLETE(x)
	161	#endif
	162	#ifdef CONFIG_SYS_LONGHELP
	163	# define _CMD_HELP(x) x,
	164	#else
	165	# define _CMD_HELP(x)
	166	#endif
8bde7f77	167
6c7c946c MV	168	#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
	169	_usage, _help, _comp) \
	170	{ #_name, _maxargs, _rep, _cmd, _usage, \
	171	_CMD_HELP(_help) _CMD_COMPLETE(_comp) }
8bde7f77	172
6c7c946c MV	173	#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
	174	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
	175	_usage, _help, NULL)
b799cb4c	176
6c7c946c	177	#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
ef123c52	178	ll_entry_declare(cmd_tbl_t, _name, cmd) = \
6c7c946c MV	179	U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
6c7c946c MV	180	_usage, _help, _comp);
8bde7f77	181
6c7c946c MV	182	#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
6c7c946c MV	183	U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
8bde7f77	184
2e5167cc	185	#if defined(CONFIG_NEEDS_MANUAL_RELOC)
620f1f6a HS	186	void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
620f1f6a HS	187	#endif
bdf8e34b	188
78f6622a	189	#endif /* __COMMAND_H */