blob: 1f06aa1819023c0869b5c30ddeff4fe949becf19 [file] [log] [blame]
wdenk78f66222002-08-27 10:27:51 +00001/*
Detlev Zundel2dce5512009-03-25 17:27:52 +01002 * (C) Copyright 2000-2009
wdenk78f66222002-08-27 10:27:51 +00003 * 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
Stefan Roesef2302d42008-08-06 14:05:38 +020030#include <config.h>
31
wdenk78f66222002-08-27 10:27:51 +000032#ifndef NULL
33#define NULL 0
34#endif
35
Peter Tyser2fb26042009-01-27 18:03:12 -060036/* 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
wdenk78f66222002-08-27 10:27:51 +000041#ifndef __ASSEMBLY__
42/*
43 * Monitor Command Table
44 */
45
46struct cmd_tbl_s {
47 char *name; /* Command Name */
wdenk78f66222002-08-27 10:27:51 +000048 int maxargs; /* maximum number of arguments */
49 int repeatable; /* autorepeat allowed? */
50 /* Implementation function */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020051 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
wdenk78f66222002-08-27 10:27:51 +000052 char *usage; /* Usage message (short) */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020053#ifdef CONFIG_SYS_LONGHELP
wdenk78f66222002-08-27 10:27:51 +000054 char *help; /* Help message (long) */
55#endif
wdenk04a85b32004-04-15 18:22:41 +000056#ifdef CONFIG_AUTO_COMPLETE
57 /* do auto completion on the arguments */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020058 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000059#endif
wdenk78f66222002-08-27 10:27:51 +000060};
61
62typedef struct cmd_tbl_s cmd_tbl_t;
63
wdenk8bde7f72003-06-27 21:31:46 +000064extern cmd_tbl_t __u_boot_cmd_start;
65extern cmd_tbl_t __u_boot_cmd_end;
wdenk78f66222002-08-27 10:27:51 +000066
Igor Grinbergd09b1782011-11-07 01:13:59 +000067#if defined(CONFIG_CMD_RUN)
68extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
69#endif
wdenk78f66222002-08-27 10:27:51 +000070
71/* common/command.c */
Detlev Zundel2dce5512009-03-25 17:27:52 +010072int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
Wolfgang Denk54841ab2010-06-28 22:00:46 +020073 flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000074cmd_tbl_t *find_cmd(const char *cmd);
Kumar Galab799cb42008-09-23 10:05:02 -050075cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
wdenk78f66222002-08-27 10:27:51 +000076
Mike Frysingere84ffdd2011-04-23 23:43:24 +000077extern int cmd_usage(const cmd_tbl_t *cmdtp);
Peter Tyser62c3ae72009-01-27 18:03:10 -060078
wdenk04a85b32004-04-15 18:22:41 +000079#ifdef CONFIG_AUTO_COMPLETE
Mike Frysinger722b0612010-10-20 03:52:39 -040080extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000081extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
82#endif
83
wdenk78f66222002-08-27 10:27:51 +000084/*
85 * Monitor Command
86 *
87 * All commands use a common argument format:
88 *
Wolfgang Denk54841ab2010-06-28 22:00:46 +020089 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000090 */
91
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020092#if defined(CONFIG_CMD_MEMORY) \
93 || defined(CONFIG_CMD_I2C) \
94 || defined(CONFIG_CMD_ITEST) \
95 || defined(CONFIG_CMD_PCI) \
96 || defined(CONFIG_CMD_PORTIO)
97#define CMD_DATA_SIZE
98extern int cmd_get_data_size(char* arg, int default_size);
99#endif
100
Mike Frysinger7842fb72010-10-20 03:36:26 -0400101#ifdef CONFIG_CMD_BOOTD
102extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
103#endif
Mike Frysinger67d668b2011-06-05 13:43:02 +0000104#ifdef CONFIG_CMD_BOOTM
Mike Frysinger36ebb782010-10-20 03:35:39 -0400105extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger67d668b2011-06-05 13:43:02 +0000106extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
107#else
108static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
109{
110 return 0;
111}
112#endif
Rob Herring7405a132012-09-21 04:02:30 +0000113
114extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
115 char *const argv[]);
116
Mike Frysinger882b7d72010-10-20 03:41:17 -0400117extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger36ebb782010-10-20 03:35:39 -0400118
Simon Glass9d12d5d2012-02-14 19:59:25 +0000119/*
120 * Error codes that commands return to cmd_process(). We use the standard 0
121 * and 1 for success and failure, but add one more case - failure with a
122 * request to call cmd_usage(). But the cmd_process() function handles
123 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
124 * This is just a convenience for commands to avoid them having to call
125 * cmd_usage() all over the place.
126 */
127enum command_ret_t {
128 CMD_RET_SUCCESS, /* 0 = Success */
129 CMD_RET_FAILURE, /* 1 = Failure */
130 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
131};
132
133/**
134 * Process a command with arguments. We look up the command and execute it
135 * if valid. Otherwise we print a usage message.
136 *
137 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
138 * @param argc Number of arguments (arg 0 must be the command text)
139 * @param argv Arguments
140 * @param repeatable This function sets this to 0 if the command is not
141 * repeatable. If the command is repeatable, the value
142 * is left unchanged.
143 * @return 0 if the command succeeded, 1 if it failed
144 */
145int cmd_process(int flag, int argc, char * const argv[],
146 int *repeatable);
Simon Glassbdf8e342012-02-14 19:59:23 +0000147
wdenk78f66222002-08-27 10:27:51 +0000148#endif /* __ASSEMBLY__ */
149
150/*
151 * Command Flags:
152 */
153#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
154#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
155
Simon Glass8edf8442011-09-17 06:48:51 +0000156#define Struct_Section __attribute__((unused, section(".u_boot_cmd"), \
157 aligned(4)))
wdenk8bde7f72003-06-27 21:31:46 +0000158
Mike Frysinger722b0612010-10-20 03:52:39 -0400159#ifdef CONFIG_AUTO_COMPLETE
160# define _CMD_COMPLETE(x) x,
161#else
162# define _CMD_COMPLETE(x)
163#endif
164#ifdef CONFIG_SYS_LONGHELP
165# define _CMD_HELP(x) x,
166#else
167# define _CMD_HELP(x)
168#endif
wdenk8bde7f72003-06-27 21:31:46 +0000169
Mike Frysinger722b0612010-10-20 03:52:39 -0400170#define U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,comp) \
171 {#name, maxargs, rep, cmd, usage, _CMD_HELP(help) _CMD_COMPLETE(comp)}
wdenk8bde7f72003-06-27 21:31:46 +0000172
Kumar Galab799cb42008-09-23 10:05:02 -0500173#define U_BOOT_CMD_MKENT(name,maxargs,rep,cmd,usage,help) \
Mike Frysinger722b0612010-10-20 03:52:39 -0400174 U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,NULL)
Kumar Galab799cb42008-09-23 10:05:02 -0500175
Mike Frysinger722b0612010-10-20 03:52:39 -0400176#define U_BOOT_CMD_COMPLETE(name,maxargs,rep,cmd,usage,help,comp) \
177 cmd_tbl_t __u_boot_cmd_##name Struct_Section = \
178 U_BOOT_CMD_MKENT_COMPLETE(name,maxargs,rep,cmd,usage,help,comp)
wdenk8bde7f72003-06-27 21:31:46 +0000179
wdenk0d498392003-07-01 21:06:45 +0000180#define U_BOOT_CMD(name,maxargs,rep,cmd,usage,help) \
Mike Frysinger722b0612010-10-20 03:52:39 -0400181 U_BOOT_CMD_COMPLETE(name,maxargs,rep,cmd,usage,help,NULL)
wdenk8bde7f72003-06-27 21:31:46 +0000182
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200183#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher620f1f62010-09-17 13:10:33 +0200184void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
185#endif
Simon Glassbdf8e342012-02-14 19:59:23 +0000186
wdenk78f66222002-08-27 10:27:51 +0000187#endif /* __COMMAND_H */