]> git.ipfire.org Git - people/ms/u-boot.git/blame - include/command.h
Initial revision
[people/ms/u-boot.git] / include / command.h
CommitLineData
78f6622a
WD
1/*
2 * (C) Copyright 2000
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
30#ifndef NULL
31#define NULL 0
32#endif
33
34#ifndef __ASSEMBLY__
35/*
36 * Monitor Command Table
37 */
38
39struct cmd_tbl_s {
40 char *name; /* Command Name */
41 int lmin; /* minimum abbreviated length */
42 int maxargs; /* maximum number of arguments */
43 int repeatable; /* autorepeat allowed? */
44 /* Implementation function */
45 int (*cmd)(struct cmd_tbl_s *, int, int, char *[]);
46 char *usage; /* Usage message (short) */
47#ifdef CFG_LONGHELP
48 char *help; /* Help message (long) */
49#endif
50};
51
52typedef struct cmd_tbl_s cmd_tbl_t;
53
54extern cmd_tbl_t cmd_tbl[];
55
56#ifdef CFG_LONGHELP
57#define MK_CMD_TBL_ENTRY(name,lmin,maxargs,rep,cmd,usage,help) \
58 { name, lmin, maxargs, rep, cmd, usage, help }
59#else /* no help info */
60#define MK_CMD_TBL_ENTRY(name,lmin,maxargs,rep,cmd,usage,help) \
61 { name, lmin, maxargs, rep, cmd, usage }
62#endif
63
64/* common/command.c */
65cmd_tbl_t *find_cmd(const char *cmd);
66
67/*
68 * Monitor Command
69 *
70 * All commands use a common argument format:
71 *
72 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[]);
73 */
74
75typedef void command_t (cmd_tbl_t *, int, int, char *[]);
76
77#endif /* __ASSEMBLY__ */
78
79/*
80 * Command Flags:
81 */
82#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
83#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
84
85/*
86 * Configurable monitor commands definitions have been moved
87 * to include/cmd_confdefs.h
88 */
89
90#endif /* __COMMAND_H */