blob: f782779d8bdf6847745dbf056fcfe04aa42b681f [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 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
wdenk78f66222002-08-27 10:27:51 +00006 */
7
8/*
9 * Definitions for Command Processor
10 */
11#ifndef __COMMAND_H
12#define __COMMAND_H
13
Stefan Roesef2302d42008-08-06 14:05:38 +020014#include <config.h>
Marek Vasut6c7c9462012-10-12 10:27:04 +000015#include <linker_lists.h>
Stefan Roesef2302d42008-08-06 14:05:38 +020016
wdenk78f66222002-08-27 10:27:51 +000017#ifndef NULL
18#define NULL 0
19#endif
20
Peter Tyser2fb26042009-01-27 18:03:12 -060021/* Default to a width of 8 characters for help message command width */
22#ifndef CONFIG_SYS_HELP_CMD_WIDTH
23#define CONFIG_SYS_HELP_CMD_WIDTH 8
24#endif
25
wdenk78f66222002-08-27 10:27:51 +000026#ifndef __ASSEMBLY__
27/*
28 * Monitor Command Table
29 */
30
31struct cmd_tbl_s {
32 char *name; /* Command Name */
wdenk78f66222002-08-27 10:27:51 +000033 int maxargs; /* maximum number of arguments */
34 int repeatable; /* autorepeat allowed? */
35 /* Implementation function */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020036 int (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
wdenk78f66222002-08-27 10:27:51 +000037 char *usage; /* Usage message (short) */
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020038#ifdef CONFIG_SYS_LONGHELP
wdenk78f66222002-08-27 10:27:51 +000039 char *help; /* Help message (long) */
40#endif
wdenk04a85b32004-04-15 18:22:41 +000041#ifdef CONFIG_AUTO_COMPLETE
42 /* do auto completion on the arguments */
Wolfgang Denk54841ab2010-06-28 22:00:46 +020043 int (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000044#endif
wdenk78f66222002-08-27 10:27:51 +000045};
46
47typedef struct cmd_tbl_s cmd_tbl_t;
48
wdenk78f66222002-08-27 10:27:51 +000049
Igor Grinbergd09b1782011-11-07 01:13:59 +000050#if defined(CONFIG_CMD_RUN)
51extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
52#endif
wdenk78f66222002-08-27 10:27:51 +000053
54/* common/command.c */
Detlev Zundel2dce5512009-03-25 17:27:52 +010055int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
Wolfgang Denk54841ab2010-06-28 22:00:46 +020056 flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000057cmd_tbl_t *find_cmd(const char *cmd);
Kumar Galab799cb42008-09-23 10:05:02 -050058cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
wdenk78f66222002-08-27 10:27:51 +000059
Mike Frysingere84ffdd2011-04-23 23:43:24 +000060extern int cmd_usage(const cmd_tbl_t *cmdtp);
Peter Tyser62c3ae72009-01-27 18:03:10 -060061
wdenk04a85b32004-04-15 18:22:41 +000062#ifdef CONFIG_AUTO_COMPLETE
Mike Frysinger722b0612010-10-20 03:52:39 -040063extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
wdenk04a85b32004-04-15 18:22:41 +000064extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
65#endif
66
wdenk78f66222002-08-27 10:27:51 +000067/*
68 * Monitor Command
69 *
70 * All commands use a common argument format:
71 *
Wolfgang Denk54841ab2010-06-28 22:00:46 +020072 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
wdenk78f66222002-08-27 10:27:51 +000073 */
74
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020075#if defined(CONFIG_CMD_MEMORY) \
Vadim Bendebury9ad557b2012-12-05 14:46:42 +000076 || defined(CONFIG_CMD_I2C) \
77 || defined(CONFIG_CMD_ITEST) \
78 || defined(CONFIG_CMD_PCI) \
79 || defined(CONFIG_CMD_PORTIO)
Jean-Christophe PLAGNIOL-VILLARD8a40fb12008-09-10 22:48:05 +020080#define CMD_DATA_SIZE
81extern int cmd_get_data_size(char* arg, int default_size);
82#endif
83
Mike Frysinger7842fb72010-10-20 03:36:26 -040084#ifdef CONFIG_CMD_BOOTD
85extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
86#endif
Mike Frysinger67d668b2011-06-05 13:43:02 +000087#ifdef CONFIG_CMD_BOOTM
Mike Frysinger36ebb782010-10-20 03:35:39 -040088extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger67d668b2011-06-05 13:43:02 +000089extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
90#else
91static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
92{
93 return 0;
94}
95#endif
Rob Herring7405a132012-09-21 04:02:30 +000096
Rob Herringda620222012-12-02 21:00:23 -060097extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
98
Rob Herring7405a132012-09-21 04:02:30 +000099extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
100 char *const argv[]);
101
Mike Frysinger882b7d72010-10-20 03:41:17 -0400102extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
Mike Frysinger36ebb782010-10-20 03:35:39 -0400103
Simon Glass9d12d5d2012-02-14 19:59:25 +0000104/*
105 * Error codes that commands return to cmd_process(). We use the standard 0
106 * and 1 for success and failure, but add one more case - failure with a
107 * request to call cmd_usage(). But the cmd_process() function handles
108 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
109 * This is just a convenience for commands to avoid them having to call
110 * cmd_usage() all over the place.
111 */
112enum command_ret_t {
113 CMD_RET_SUCCESS, /* 0 = Success */
114 CMD_RET_FAILURE, /* 1 = Failure */
115 CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */
116};
117
118/**
119 * Process a command with arguments. We look up the command and execute it
120 * if valid. Otherwise we print a usage message.
121 *
122 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
123 * @param argc Number of arguments (arg 0 must be the command text)
124 * @param argv Arguments
125 * @param repeatable This function sets this to 0 if the command is not
126 * repeatable. If the command is repeatable, the value
127 * is left unchanged.
Richard Genoud34765e82012-12-03 06:28:28 +0000128 * @param ticks If ticks is not null, this function set it to the
129 * number of ticks the command took to complete.
Simon Glass9d12d5d2012-02-14 19:59:25 +0000130 * @return 0 if the command succeeded, 1 if it failed
131 */
132int cmd_process(int flag, int argc, char * const argv[],
Richard Genoud34765e82012-12-03 06:28:28 +0000133 int *repeatable, unsigned long *ticks);
Simon Glassbdf8e342012-02-14 19:59:23 +0000134
wdenk78f66222002-08-27 10:27:51 +0000135#endif /* __ASSEMBLY__ */
136
137/*
138 * Command Flags:
139 */
140#define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
141#define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
142
Mike Frysinger722b0612010-10-20 03:52:39 -0400143#ifdef CONFIG_AUTO_COMPLETE
144# define _CMD_COMPLETE(x) x,
145#else
146# define _CMD_COMPLETE(x)
147#endif
148#ifdef CONFIG_SYS_LONGHELP
149# define _CMD_HELP(x) x,
150#else
151# define _CMD_HELP(x)
152#endif
wdenk8bde7f72003-06-27 21:31:46 +0000153
Marek Vasut6c7c9462012-10-12 10:27:04 +0000154#define U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
155 _usage, _help, _comp) \
156 { #_name, _maxargs, _rep, _cmd, _usage, \
157 _CMD_HELP(_help) _CMD_COMPLETE(_comp) }
wdenk8bde7f72003-06-27 21:31:46 +0000158
Marek Vasut6c7c9462012-10-12 10:27:04 +0000159#define U_BOOT_CMD_MKENT(_name, _maxargs, _rep, _cmd, _usage, _help) \
160 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
161 _usage, _help, NULL)
Kumar Galab799cb42008-09-23 10:05:02 -0500162
Marek Vasut6c7c9462012-10-12 10:27:04 +0000163#define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
Albert ARIBAUDef123c52013-02-25 00:59:00 +0000164 ll_entry_declare(cmd_tbl_t, _name, cmd) = \
Marek Vasut6c7c9462012-10-12 10:27:04 +0000165 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd, \
166 _usage, _help, _comp);
wdenk8bde7f72003-06-27 21:31:46 +0000167
Marek Vasut6c7c9462012-10-12 10:27:04 +0000168#define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help) \
169 U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
wdenk8bde7f72003-06-27 21:31:46 +0000170
Wolfgang Denk2e5167c2010-10-28 20:00:11 +0200171#if defined(CONFIG_NEEDS_MANUAL_RELOC)
Heiko Schocher620f1f62010-09-17 13:10:33 +0200172void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
173#endif
Simon Glassbdf8e342012-02-14 19:59:23 +0000174
wdenk78f66222002-08-27 10:27:51 +0000175#endif /* __COMMAND_H */