include/command.h

   1 /*
   2  * (C) Copyright 2014-2016 Leo C. <erbl259-lmu@yahoo.de>
   3  *
   4  * (C) Copyright 2000-2009
   5  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   6  *
   7  * SPDX-License-Identifier:     GPL-2.0
   8  */
   9
  10 /*
  11  *  Definitions for Command Processor
  12  */
  13 #ifndef __COMMAND_H
  14 #define __COMMAND_H
  15
  16 #include "common.h"
  17 #include "config.h"
  18 #include <setjmp.h>
  19
  20 #ifndef NULL
  21 #define NULL    0
  22 #endif
  23
  24 /* Default to a width of 8 characters for help message command width */
  25 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
  26 #define CONFIG_SYS_HELP_CMD_WIDTH       8
  27 #endif
  28
  29 /*
  30  * Error codes that commands return to cmd_process(). We use the standard 0
  31  * and 1 for success and failure, but add one more case - failure with a
  32  * request to call cmd_usage(). But the cmd_process() function handles
  33  * CMD_RET_USAGE itself and after calling cmd_usage() it will return 1.
  34  * This is just a convenience for commands to avoid them having to call
  35  * cmd_usage() all over the place.
  36  */
  37 typedef enum {
  38         CMD_RET_SUCCESS = 0,    /* Success */
  39         CMD_RET_FAILURE = 1,    /* Failure */
  40         CMD_RET_USAGE = -1,     /* Failure, please report 'usage' error */
  41 } command_ret_t;
  42
  43 /*
  44  * Monitor Command Table
  45  */
  46
  47 struct cmd_tbl_s {
  48         const FLASH char *name;         /* Command Name                 */
  49         uint8_t         maxargs;                        /* maximum number of arguments  */
  50         uint8_t         flags;                  /* autorepeat allowed?          */
  51                                                                 /* Implementation function      */
  52         command_ret_t   (*cmd)(const FLASH struct cmd_tbl_s *, uint_fast8_t, int, char * const []);
  53         const FLASH char *usage;        /* Usage message        (short) */
  54 #ifdef  CONFIG_SYS_LONGHELP
  55         const FLASH char *help;         /* Help  message        (long)  */
  56 #endif
  57 #ifdef CONFIG_AUTO_COMPLETE
  58         /* do auto completion on the arguments */
  59         int             (*complete)(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
  60 #endif
  61 };
  62
  63 typedef const FLASH struct cmd_tbl_s cmd_tbl_t;
  64
  65 /**
  66  * Process a command with arguments. We look up the command and execute it
  67  * if valid. Otherwise we print a usage message.
  68  *
  69  * @param flag          Some flags normally 0 (see CMD_FLAG_.. above)
  70  * @param argc          Number of arguments (arg 0 must be the command text)
  71  * @param argv          Arguments
  72  * @param repeatable    This function sets this to 0 if the command is not
  73  *                      repeatable. If the command is repeatable, the value
  74  *                      is left unchanged.
  75  * @return 0 if the command succeeded, 1 if it failed
  76  */
  77 command_ret_t
  78 cmd_process(uint_fast8_t flag, int argc, char * const argv[], uint_fast8_t *repeatable);
  79
  80
  81 /* command.c */
  82 command_ret_t _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
  83 cmd_tbl_t *find_cmd(const char *cmd);
  84 cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len);
  85
  86 int cmd_tbl_item_count(void);
  87 command_ret_t cmd_usage(cmd_tbl_t *cmdtp);
  88
  89 #ifdef CONFIG_AUTO_COMPLETE
  90 extern int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[]);
  91 extern int cmd_auto_complete(const FLASH char *const prompt, char *buf, int *np, int *colp);
  92 #endif
  93
  94 /**
  95  * cmd_process_error() - report and process a possible error
  96  *
  97  * @cmdtp: Command which caused the error
  98  * @err: Error code (0 if none, -ve for error, like -EIO)
  99  * @return 0 if there is not error, 1 (CMD_RET_FAILURE) if an error is found
 100  */
 101 int cmd_process_error(cmd_tbl_t *cmdtp, int err);
 102
 103 /*
 104  * Monitor Command
 105  *
 106  * All commands use a common argument format:
 107  *
 108  * void function (cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
 109  */
 110
 111
 112 #ifdef CONFIG_CMD_BOOTD
 113 extern command_ret_t do_bootd(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
 114 #endif
 115 #ifdef CONFIG_CMD_BOOTM
 116 extern command_ret_t do_bootm(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
 117 extern int bootm_maybe_autostart(cmd_tbl_t *cmdtp, const char *cmd);
 118 #else
 119 static inline int bootm_maybe_autostart(cmd_tbl_t *cmdtp UNUSED, const char *cmd UNUSED)
 120 {
 121         return 0;
 122 }
 123 #endif
 124
 125 extern int common_diskboot(cmd_tbl_t *cmdtp, const char *intf, int argc,
 126                            char *const argv[]);
 127
 128 extern command_ret_t do_reset(cmd_tbl_t *cmdtp, uint_fast8_t flag, int argc, char * const argv[]);
 129
 130 /*
 131  * Command Flags:
 132  */
 133 #define CMD_FLAG_REPEAT         0x01    /* repeat last command          */
 134 #define CMD_FLAG_BOOTD          0x02    /* command is from bootd        */
 135
 136 /*
 137  * Flags for command table:
 138  */
 139 #define CTBL_REPEAT                     0x01    /* command is repeatable        */
 140 #define CTBL_SUBCMD                     0x02    /* command has subcommands      */
 141
 142 #ifdef CONFIG_AUTO_COMPLETE
 143 # define _CMD_COMPLETE(x) x,
 144 #else
 145 # define _CMD_COMPLETE(x)
 146 #endif
 147 #ifdef CONFIG_SYS_LONGHELP
 148 # define _CMD_HELP(x) x,
 149 #else
 150 # define _CMD_HELP(x)
 151 #endif
 152
 153
 154 #define CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd,              \
 155                                 _usage, _help, _comp)                   \
 156                 { FSTR(#_name), _maxargs, _rep, _cmd, FSTR(_usage),     \
 157                         _CMD_HELP(FSTR(_help)) _CMD_COMPLETE(_comp) }
 158
 159 #define CMD_TBL_ITEM(_name, _maxargs, _rep, _cmd, _usage, _help)        \
 160         CMD_TBL_ITEM_COMPLETE(_name, _maxargs, _rep, _cmd,              \
 161                                         _usage, _help, NULL)
 162
 163 typedef command_ret_t (*do_cmd_t)(cmd_tbl_t *, uint_fast8_t, int, char * const []);
 164
 165 extern  cmd_tbl_t cmd_tbl[];
 166
 167 extern jmp_buf cmd_jbuf;
 168
 169
 170 #endif  /* __COMMAND_H */