]>
cloudbase.mooo.com Git - z180-stamp.git/blob - include/command.h
2 * (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
4 * (C) Copyright 2000-2009
5 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
7 * SPDX-License-Identifier: GPL-2.0+
11 * Definitions for Command Processor
23 /* Default to a width of 8 characters for help message command width */
24 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
25 #define CONFIG_SYS_HELP_CMD_WIDTH 8
29 * Error codes that commands return to cmd_process(). We use the standard 0
30 * and 1 for success and failure, but add one more case - failure with a
31 * request to call cmd_usage(). But the cmd_process() function handles
32 * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
33 * This is just a convenience for commands to avoid them having to call
34 * cmd_usage() all over the place.
37 CMD_RET_SUCCESS
= 0, /* Success */
38 CMD_RET_FAILURE
= 1, /* Failure */
39 CMD_RET_USAGE
= -1, /* Failure, please report 'usage' error */
43 * Monitor Command Table
47 const FLASH
char *name
; /* Command Name */
48 int maxargs
; /* maximum number of arguments */
49 int repeatable
; /* autorepeat allowed? */
50 /* Implementation function */
51 command_ret_t (*cmd
)(const FLASH
struct cmd_tbl_s
*, int, int, char * const []);
52 const FLASH
char *usage
; /* Usage message (short) */
53 #ifdef CONFIG_SYS_LONGHELP
54 const FLASH
char *help
; /* Help message (long) */
56 #ifdef CONFIG_AUTO_COMPLETE
57 /* do auto completion on the arguments */
58 int (*complete
)(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[]);
62 typedef const FLASH
struct cmd_tbl_s cmd_tbl_t
;
64 extern command_ret_t
do_run(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[]);
67 * Process a command with arguments. We look up the command and execute it
68 * if valid. Otherwise we print a usage message.
70 * @param flag Some flags normally 0 (see CMD_FLAG_.. above)
71 * @param argc Number of arguments (arg 0 must be the command text)
72 * @param argv Arguments
73 * @param repeatable This function sets this to 0 if the command is not
74 * repeatable. If the command is repeatable, the value
76 * @return 0 if the command succeeded, 1 if it failed
79 cmd_process(int flag
, int argc
, char * const argv
[], uint_fast8_t *repeatable
);
83 command_ret_t
_do_help (cmd_tbl_t
*cmd_start
, int cmd_items
, cmd_tbl_t
* cmdtp
, int
84 flag
, int argc
, char * const argv
[]);
85 cmd_tbl_t
*find_cmd(const char *cmd
);
86 cmd_tbl_t
*find_cmd_tbl (const char *cmd
, cmd_tbl_t
*table
, int table_len
);
88 int cmd_tbl_item_count(void);
89 command_ret_t
cmd_usage(cmd_tbl_t
*cmdtp
);
91 #ifdef CONFIG_AUTO_COMPLETE
92 extern int var_complete(int argc
, char * const argv
[], char last_char
, int maxv
, char *cmdv
[]);
93 extern int cmd_auto_complete(const FLASH
char *const prompt
, char *buf
, int *np
, int *colp
);
97 * cmd_process_error() - report and process a possible error
99 * @cmdtp: Command which caused the error
100 * @err: Error code (0 if none, -ve for error, like -EIO)
101 * @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found
103 int cmd_process_error(cmd_tbl_t
*cmdtp
, int err
);
108 * All commands use a common argument format:
110 * void function (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
114 #ifdef CONFIG_CMD_BOOTD
115 extern command_ret_t
do_bootd(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[]);
117 #ifdef CONFIG_CMD_BOOTM
118 extern command_ret_t
do_bootm(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[]);
119 extern int bootm_maybe_autostart(cmd_tbl_t
*cmdtp
, const char *cmd
);
121 static inline int bootm_maybe_autostart(cmd_tbl_t
*cmdtp
, const char *cmd
)
123 (void) cmdtp
; (void) cmd
;
129 extern int common_diskboot(cmd_tbl_t
*cmdtp
, const char *intf
, int argc
,
132 extern command_ret_t
do_reset(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[]);
137 #define CMD_FLAG_REPEAT 0x0001 /* repeat last command */
138 #define CMD_FLAG_BOOTD 0x0002 /* command is from bootd */
140 #ifdef CONFIG_AUTO_COMPLETE
141 # define _CMD_COMPLETE(x) x,
143 # define _CMD_COMPLETE(x)
145 #ifdef CONFIG_SYS_LONGHELP
146 # define _CMD_HELP(x) x,
148 # define _CMD_HELP(x)
152 #define CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd, \
153 _usage, _help, _comp) \
154 { FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage), \
155 _CMD_HELP(FSTR(_help)) _CMD_COMPLETE(_comp) }
157 #define CMD_TBL_ITEM(_name, _maxargs, _rep, _cmd, _usage, _help) \
158 CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd, \
161 typedef command_ret_t (*do_cmd_t
)(cmd_tbl_t
*, int, int, char * const []);
163 extern cmd_tbl_t cmd_tbl
[];
166 #endif /* __COMMAND_H */