command.h 3.55 KB
Newer Older
wdenk's avatar
wdenk committed
1
/*
2
 * (C) Copyright 2000-2009
wdenk's avatar
wdenk committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 * 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

Stefan Roese's avatar
Stefan Roese committed
30 31
#include <config.h>

wdenk's avatar
wdenk committed
32 33 34 35
#ifndef NULL
#define NULL	0
#endif

Peter Tyser's avatar
Peter Tyser committed
36 37 38 39 40
/* 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

wdenk's avatar
wdenk committed
41 42 43 44 45 46 47 48 49 50 51 52
#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 *[]);
	char		*usage;		/* Usage message	(short)	*/
53
#ifdef	CONFIG_SYS_LONGHELP
wdenk's avatar
wdenk committed
54 55
	char		*help;		/* Help  message	(long)	*/
#endif
56 57 58 59
#ifdef CONFIG_AUTO_COMPLETE
	/* do auto completion on the arguments */
	int		(*complete)(int argc, char *argv[], char last_char, int maxv, char *cmdv[]);
#endif
wdenk's avatar
wdenk committed
60 61 62 63
};

typedef struct cmd_tbl_s	cmd_tbl_t;

wdenk's avatar
wdenk committed
64 65
extern cmd_tbl_t  __u_boot_cmd_start;
extern cmd_tbl_t  __u_boot_cmd_end;
wdenk's avatar
wdenk committed
66 67 68


/* common/command.c */
69 70
int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
	      flag, int argc, char *argv[]);
wdenk's avatar
wdenk committed
71
cmd_tbl_t *find_cmd(const char *cmd);
72
cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
wdenk's avatar
wdenk committed
73

74
extern int cmd_usage(cmd_tbl_t *cmdtp);
75

76 77 78 79 80
#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

wdenk's avatar
wdenk committed
81 82 83 84 85 86 87 88
/*
 * Monitor Command
 *
 * All commands use a common argument format:
 *
 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[]);
 */

Wolfgang Denk's avatar
Wolfgang Denk committed
89
typedef	void	command_t (cmd_tbl_t *, int, int, char *[]);
wdenk's avatar
wdenk committed
90

91 92 93 94 95 96 97 98 99
#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

wdenk's avatar
wdenk committed
100 101 102 103 104 105 106 107
#endif	/* __ASSEMBLY__ */

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

wdenk's avatar
wdenk committed
108 109
#define Struct_Section  __attribute__ ((unused,section (".u_boot_cmd")))

110
#ifdef  CONFIG_SYS_LONGHELP
wdenk's avatar
wdenk committed
111

112 113
#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}
wdenk's avatar
wdenk committed
114

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

wdenk's avatar
wdenk committed
118 119
#else	/* no long help info */

120 121
#define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
cmd_tbl_t __u_boot_cmd_##name Struct_Section = {#name, maxargs, rep, cmd, usage}
wdenk's avatar
wdenk committed
122

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

126
#endif	/* CONFIG_SYS_LONGHELP */
wdenk's avatar
wdenk committed
127

wdenk's avatar
wdenk committed
128
#endif	/* __COMMAND_H */