[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>

#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;

extern cmd_tbl_t  __u_boot_cmd_start;
extern cmd_tbl_t  __u_boot_cmd_end;


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

#ifdef CONFIG_AUTO_COMPLETE
extern void install_auto_complete(void);
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[]);
 */

typedef	void	command_t (cmd_tbl_t *, int, int, char *[]);

#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

#endif	/* __ASSEMBLY__ */

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

#define Struct_Section  __attribute__ ((unused,section (".u_boot_cmd")))

#ifdef  CONFIG_SYS_LONGHELP

#define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage, help}

#define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
{#name, maxargs, rep, cmd, usage, help}

#else	/* no long help info */

#define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage}

#define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
{#name, maxargs, rep, cmd, usage}

#endif	/* CONFIG_SYS_LONGHELP */

#if !defined(CONFIG_RELOC_FIXUP_WORKS)
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 SR	30	#include <config.h>
f2302d44 SR	31
78f6622a WD	32	#ifndef NULL
	33	#define NULL 0
	34	#endif
	35
2fb2604d PT	36	/* Default to a width of 8 characters for help message command width */
	37	#ifndef CONFIG_SYS_HELP_CMD_WIDTH
	38	#define CONFIG_SYS_HELP_CMD_WIDTH 8
	39	#endif
	40
78f6622a WD	41	#ifndef __ASSEMBLY__
	42	/*
	43	* Monitor Command Table
	44	*/
	45
	46	struct cmd_tbl_s {
	47	char name; / Command Name */
78f6622a WD	48	int maxargs; /* maximum number of arguments */
	49	int repeatable; /* autorepeat allowed? */
	50	/* Implementation function */
54841ab5	51	int (cmd)(struct cmd_tbl_s , int, int, char * const []);
78f6622a	52	char usage; / Usage message (short) */
6d0f6bcf	53	#ifdef CONFIG_SYS_LONGHELP
78f6622a WD	54	char help; / Help message (long) */
78f6622a WD	55	#endif
04a85b3b WD	56	#ifdef CONFIG_AUTO_COMPLETE
04a85b3b WD	57	/* do auto completion on the arguments */
54841ab5	58	int (complete)(int argc, char const argv[], char last_char, int maxv, char *cmdv[]);
04a85b3b	59	#endif
78f6622a WD	60	};
	61
	62	typedef struct cmd_tbl_s cmd_tbl_t;
	63
8bde7f77 WD	64	extern cmd_tbl_t __u_boot_cmd_start;
8bde7f77 WD	65	extern cmd_tbl_t __u_boot_cmd_end;
78f6622a	66
78f6622a WD	67
78f6622a WD	68	/* common/command.c */
2dce551e	69	int _do_help (cmd_tbl_t cmd_start, int cmd_items, cmd_tbl_t cmdtp, int
54841ab5	70	flag, int argc, char * const argv[]);
78f6622a	71	cmd_tbl_t find_cmd(const char cmd);
b799cb4c	72	cmd_tbl_t find_cmd_tbl (const char cmd, cmd_tbl_t *table, int table_len);
78f6622a	73
94796d85	74	extern int cmd_usage(cmd_tbl_t *cmdtp);
62c3ae7c	75
04a85b3b WD	76	#ifdef CONFIG_AUTO_COMPLETE
	77	extern void install_auto_complete(void);
	78	extern int cmd_auto_complete(const char const prompt, char buf, int np, int colp);
	79	#endif
	80
78f6622a WD	81	/*
	82	* Monitor Command
	83	*
	84	* All commands use a common argument format:
	85	*
54841ab5	86	* void function (cmd_tbl_t cmdtp, int flag, int argc, char const argv[]);
78f6622a WD	87	*/
78f6622a WD	88
53677ef1	89	typedef void command_t (cmd_tbl_t , int, int, char []);
78f6622a	90
8a40fb14 JCPV	91	#if defined(CONFIG_CMD_MEMORY) \
	92	\|\| defined(CONFIG_CMD_I2C) \
	93	\|\| defined(CONFIG_CMD_ITEST) \
	94	\|\| defined(CONFIG_CMD_PCI) \
	95	\|\| defined(CONFIG_CMD_PORTIO)
	96	#define CMD_DATA_SIZE
	97	extern int cmd_get_data_size(char* arg, int default_size);
	98	#endif
	99
78f6622a WD	100	#endif /* __ASSEMBLY__ */
	101
	102	/*
	103	* Command Flags:
	104	*/
	105	#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
	106	#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
	107
8bde7f77	108	#define Struct_Section __attribute__ ((unused,section (".u_boot_cmd")))
8bde7f77	109
6d0f6bcf	110	#ifdef CONFIG_SYS_LONGHELP
8bde7f77	111
0d498393 WD	112	#define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
0d498393 WD	113	cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage, help}
8bde7f77	114
b799cb4c KG	115	#define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
	116	{#name, maxargs, rep, cmd, usage, help}
	117
8bde7f77 WD	118	#else /* no long help info */
8bde7f77 WD	119
0d498393 WD	120	#define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
0d498393 WD	121	cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage}
8bde7f77	122
b799cb4c KG	123	#define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
	124	{#name, maxargs, rep, cmd, usage}
	125
6d0f6bcf	126	#endif /* CONFIG_SYS_LONGHELP */
8bde7f77	127
620f1f6a HS	128	#if !defined(CONFIG_RELOC_FIXUP_WORKS)
	129	void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
	130	#endif
78f6622a	131	#endif /* __COMMAND_H */