]> git.sur5r.net Git - u-boot/blob - include/command.h
powerpc: add CONFIG_SECURE_BOOT condition into fsl_secure_boot.h
[u-boot] / include / command.h
1 /*
2  * (C) Copyright 2000-2009
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * SPDX-License-Identifier:     GPL-2.0+
6  */
7
8 /*
9  *  Definitions for Command Processor
10  */
11 #ifndef __COMMAND_H
12 #define __COMMAND_H
13
14 #include <config.h>
15 #include <linker_lists.h>
16
17 #ifndef NULL
18 #define NULL    0
19 #endif
20
21 /* 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
26 #ifndef __ASSEMBLY__
27 /*
28  * Monitor Command Table
29  */
30
31 struct cmd_tbl_s {
32         char            *name;          /* Command Name                 */
33         int             maxargs;        /* maximum number of arguments  */
34         int             repeatable;     /* autorepeat allowed?          */
35                                         /* Implementation function      */
36         int             (*cmd)(struct cmd_tbl_s *, int, int, char * const []);
37         char            *usage;         /* Usage message        (short) */
38 #ifdef  CONFIG_SYS_LONGHELP
39         char            *help;          /* Help  message        (long)  */
40 #endif
41 #ifdef CONFIG_AUTO_COMPLETE
42         /* do auto completion on the arguments */
43         int             (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
44 #endif
45 };
46
47 typedef struct cmd_tbl_s        cmd_tbl_t;
48
49
50 #if defined(CONFIG_CMD_RUN)
51 extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
52 #endif
53
54 /* common/command.c */
55 int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
56               flag, int argc, char * const argv[]);
57 cmd_tbl_t *find_cmd(const char *cmd);
58 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
59
60 extern int cmd_usage(const cmd_tbl_t *cmdtp);
61
62 #ifdef CONFIG_AUTO_COMPLETE
63 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
64 extern int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp);
65 #endif
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 * const argv[]);
73  */
74
75 #if defined(CONFIG_CMD_MEMORY)          \
76         || defined(CONFIG_CMD_I2C)      \
77         || defined(CONFIG_CMD_ITEST)    \
78         || defined(CONFIG_CMD_PCI)      \
79         || defined(CONFIG_CMD_PORTIO)
80 #define CMD_DATA_SIZE
81 extern int cmd_get_data_size(char* arg, int default_size);
82 #endif
83
84 #ifdef CONFIG_CMD_BOOTD
85 extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
86 #endif
87 #ifdef CONFIG_CMD_BOOTM
88 extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
89 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
90 #else
91 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd)
92 {
93         return 0;
94 }
95 #endif
96
97 extern int do_bootz(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
98
99 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
100                            char *const argv[]);
101
102 extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
103
104 /*
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  */
112 enum 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.
128  * @param ticks         If ticks is not null, this function set it to the
129  *                      number of ticks the command took to complete.
130  * @return 0 if the command succeeded, 1 if it failed
131  */
132 int cmd_process(int flag, int argc, char * const argv[],
133                                int *repeatable, unsigned long *ticks);
134
135 #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
143 #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
153
154 #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) }
158
159 #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)
162
163 #define U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, _comp) \
164         ll_entry_declare(cmd_tbl_t, _name, cmd) =                       \
165                 U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,  \
166                                                 _usage, _help, _comp);
167
168 #define U_BOOT_CMD(_name, _maxargs, _rep, _cmd, _usage, _help)          \
169         U_BOOT_CMD_COMPLETE(_name, _maxargs, _rep, _cmd, _usage, _help, NULL)
170
171 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
172 void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
173 #endif
174
175 #endif  /* __COMMAND_H */