diff options
Diffstat (limited to 'avr/command.h')
| -rw-r--r-- | avr/command.h | 75 |
1 files changed, 38 insertions, 37 deletions
diff --git a/avr/command.h b/avr/command.h index 82b83ba..4e96903 100644 --- a/avr/command.h +++ b/avr/command.h @@ -18,6 +18,20 @@ #endif /* + * Error codes that commands return to cmd_process(). We use the standard 0 + * and 1 for success and failure, but add one more case - failure with a + * request to call cmd_usage(). But the cmd_process() function handles + * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1. + * This is just a convenience for commands to avoid them having to call + * cmd_usage() all over the place. + */ +typedef enum { + CMD_RET_SUCCESS, /* 0 = Success */ + CMD_RET_FAILURE, /* 1 = Failure */ + CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */ +} command_ret_t; + +/* * Monitor Command Table */ @@ -26,7 +40,7 @@ struct cmd_tbl_s { int maxargs; /* maximum number of arguments */ int repeatable; /* autorepeat allowed? */ /* Implementation function */ - int (*cmd)(const FLASH struct cmd_tbl_s *, int, int, char * const []); + command_ret_t (*cmd)(const FLASH struct cmd_tbl_s *, int, int, char * const []); const FLASH char *usage; /* Usage message (short) */ #ifdef CONFIG_SYS_LONGHELP const FLASH char *help; /* Help message (long) */ @@ -39,16 +53,32 @@ struct cmd_tbl_s { typedef const FLASH struct cmd_tbl_s cmd_tbl_t; -extern int do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); +extern command_ret_t do_run(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); + +/** + * Process a command with arguments. We look up the command and execute it + * if valid. Otherwise we print a usage message. + * + * @param flag Some flags normally 0 (see CMD_FLAG_.. above) + * @param argc Number of arguments (arg 0 must be the command text) + * @param argv Arguments + * @param repeatable This function sets this to 0 if the command is not + * repeatable. If the command is repeatable, the value + * is left unchanged. + * @return 0 if the command succeeded, 1 if it failed + */ +command_ret_t +cmd_process(int flag, int argc, char * const argv[], uint_fast8_t *repeatable); + /* command.c */ -int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int +command_ret_t _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[]); cmd_tbl_t *find_cmd(const char *cmd); cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len); int cmd_tbl_item_count(void); -int cmd_usage(cmd_tbl_t *cmdtp); +command_ret_t cmd_usage(cmd_tbl_t *cmdtp); #ifdef CONFIG_AUTO_COMPLETE extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]); @@ -74,10 +104,10 @@ int cmd_process_error(cmd_tbl_t *cmdtp, int err); #ifdef CONFIG_CMD_BOOTD -extern int do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); +extern command_ret_t do_bootd(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); #endif #ifdef CONFIG_CMD_BOOTM -extern int do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); +extern command_ret_t do_bootm(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd); #else static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd) @@ -91,36 +121,7 @@ static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd) extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc, char *const argv[]); -extern int do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); - -/* - * Error codes that commands return to cmd_process(). We use the standard 0 - * and 1 for success and failure, but add one more case - failure with a - * request to call cmd_usage(). But the cmd_process() function handles - * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1. - * This is just a convenience for commands to avoid them having to call - * cmd_usage() all over the place. - */ -enum command_ret_t { - CMD_RET_SUCCESS, /* 0 = Success */ - CMD_RET_FAILURE, /* 1 = Failure */ - CMD_RET_USAGE = -1, /* Failure, please report 'usage' error */ -}; - -/** - * Process a command with arguments. We look up the command and execute it - * if valid. Otherwise we print a usage message. - * - * @param flag Some flags normally 0 (see CMD_FLAG_.. above) - * @param argc Number of arguments (arg 0 must be the command text) - * @param argv Arguments - * @param repeatable This function sets this to 0 if the command is not - * repeatable. If the command is repeatable, the value - * is left unchanged. - * @return 0 if the command succeeded, 1 if it failed - */ -int cmd_process(int flag, int argc, char * const argv[], uint_fast8_t *repeatable); - +extern command_ret_t do_reset(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]); /* * Command Flags: @@ -149,7 +150,7 @@ int cmd_process(int flag, int argc, char * const argv[], uint_fast8_t *repeatabl CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd, \ _usage, _help, NULL) -typedef int (*do_cmd_t)(cmd_tbl_t *, int, int, char * const []); +typedef command_ret_t (*do_cmd_t)(cmd_tbl_t *, int, int, char * const []); extern cmd_tbl_t cmd_tbl[]; |