lib: charset: correct function descriptions

[oweals/u-boot.git] / include / command.h

diff --git a/include/command.h b/include/command.h
index bb93f022c5145c284e3d3d00f973276ec92db4c0..d1063774ce567dff15b6823b6ae10fdf72ba773d 100644 (file)
--- a/include/command.h
+++ b/include/command.h
@@ -10,6 +10,7 @@
 #ifndef __COMMAND_H
 #define __COMMAND_H
 
+#include <env.h>
 #include <linker_lists.h>
 
 #ifndef NULL
@@ -18,7 +19,7 @@
 
 /* Default to a width of 8 characters for help message command width */
 #ifndef CONFIG_SYS_HELP_CMD_WIDTH
-#define CONFIG_SYS_HELP_CMD_WIDTH      8
+#define CONFIG_SYS_HELP_CMD_WIDTH      10
 #endif
 
 #ifndef        __ASSEMBLY__
@@ -109,7 +110,8 @@ int cmd_process_error(cmd_tbl_t *cmdtp, int err);
 #if defined(CONFIG_CMD_MEMORY) || \
        defined(CONFIG_CMD_I2C) || \
        defined(CONFIG_CMD_ITEST) || \
-       defined(CONFIG_CMD_PCI)
+       defined(CONFIG_CMD_PCI) || \
+       defined(CONFIG_CMD_SETEXPR)
 #define CMD_DATA_SIZE
 extern int cmd_get_data_size(char* arg, int default_size);
 #endif
@@ -139,6 +141,14 @@ extern int do_poweroff(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]
 
 extern unsigned long do_go_exec(ulong (*entry)(int, char * const []), int argc,
                                char * const argv[]);
+
+#if defined(CONFIG_CMD_NVEDIT_EFI)
+extern int do_env_print_efi(cmd_tbl_t *cmdtp, int flag, int argc,
+                           char * const argv[]);
+extern int do_env_set_efi(cmd_tbl_t *cmdtp, int flag, int argc,
+                         char * const argv[]);
+#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
@@ -189,6 +199,22 @@ void fixup_cmdtable(cmd_tbl_t *cmdtp, int size);
  * @return 0 if OK, 1 for error
  */
 int board_run_command(const char *cmdline);
+
+int run_command(const char *cmd, int flag);
+int run_command_repeatable(const char *cmd, int flag);
+
+/**
+ * Run a list of commands separated by ; or even \0
+ *
+ * Note that if 'len' is not -1, then the command does not need to be nul
+ * terminated, Memory will be allocated for the command in that case.
+ *
+ * @param cmd  List of commands to run, each separated bu semicolon
+ * @param len  Length of commands excluding terminator if known (-1 if not)
+ * @param flag Execution flags (CMD_FLAG_...)
+ * @return 0 on success, or != 0 on error.
+ */
+int run_command_list(const char *cmd, int len, int flag);
 #endif /* __ASSEMBLY__ */
 
 /*
@@ -209,6 +235,70 @@ int board_run_command(const char *cmdline);
 # define _CMD_HELP(x)
 #endif
 
+#ifdef CONFIG_NEEDS_MANUAL_RELOC
+#define U_BOOT_SUBCMDS_RELOC(_cmdname)                                 \
+       static void _cmdname##_subcmds_reloc(void)                      \
+       {                                                               \
+               static int relocated;                                   \
+                                                                       \
+               if (relocated)                                          \
+                       return;                                         \
+                                                                       \
+               fixup_cmdtable(_cmdname##_subcmds,                      \
+                              ARRAY_SIZE(_cmdname##_subcmds));         \
+               relocated = 1;                                          \
+       }
+#else
+#define U_BOOT_SUBCMDS_RELOC(_cmdname)                                 \
+       static void _cmdname##_subcmds_reloc(void) { }
+#endif
+
+#define U_BOOT_SUBCMDS_DO_CMD(_cmdname)                                        \
+       static int do_##_cmdname(cmd_tbl_t *cmdtp, int flag, int argc,  \
+                                char * const argv[], int *repeatable)  \
+       {                                                               \
+               cmd_tbl_t *subcmd;                                      \
+                                                                       \
+               _cmdname##_subcmds_reloc();                             \
+                                                                       \
+               /* We need at least the cmd and subcmd names. */        \
+               if (argc < 2 || argc > CONFIG_SYS_MAXARGS)              \
+                       return CMD_RET_USAGE;                           \
+                                                                       \
+               subcmd = find_cmd_tbl(argv[1], _cmdname##_subcmds,      \
+                                     ARRAY_SIZE(_cmdname##_subcmds));  \
+               if (!subcmd || argc - 1 > subcmd->maxargs)              \
+                       return CMD_RET_USAGE;                           \
+                                                                       \
+               if (flag == CMD_FLAG_REPEAT &&                          \
+                   !cmd_is_repeatable(subcmd))                         \
+                       return CMD_RET_SUCCESS;                         \
+                                                                       \
+               return subcmd->cmd_rep(subcmd, flag, argc - 1,          \
+                                      argv + 1, repeatable);           \
+       }
+
+#ifdef CONFIG_AUTO_COMPLETE
+#define U_BOOT_SUBCMDS_COMPLETE(_cmdname)                              \
+       static int complete_##_cmdname(int argc, char * const argv[],   \
+                                      char last_char, int maxv,        \
+                                      char *cmdv[])                    \
+       {                                                               \
+               return complete_subcmdv(_cmdname##_subcmds,             \
+                                       ARRAY_SIZE(_cmdname##_subcmds), \
+                                       argc - 1, argv + 1, last_char,  \
+                                       maxv, cmdv);                    \
+       }
+#else
+#define U_BOOT_SUBCMDS_COMPLETE(_cmdname)
+#endif
+
+#define U_BOOT_SUBCMDS(_cmdname, ...)                                  \
+       static cmd_tbl_t _cmdname##_subcmds[] = { __VA_ARGS__ };        \
+       U_BOOT_SUBCMDS_RELOC(_cmdname)                                  \
+       U_BOOT_SUBCMDS_DO_CMD(_cmdname)                                 \
+       U_BOOT_SUBCMDS_COMPLETE(_cmdname)
+
 #ifdef CONFIG_CMDLINE
 #define U_BOOT_CMDREP_MKENT_COMPLETE(_name, _maxargs, _cmd_rep,                \
                                     _usage, _help, _comp)              \
@@ -271,4 +361,18 @@ int board_run_command(const char *cmdline);
        U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _cmd,          \
                                        _usage, _help, NULL)
 
+#define U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,   \
+                                    _comp)                             \
+       U_BOOT_CMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,       \
+                                 "", "", _comp)
+
+#define U_BOOT_SUBCMD_MKENT(_name, _maxargs, _rep, _do_cmd)            \
+       U_BOOT_SUBCMD_MKENT_COMPLETE(_name, _maxargs, _rep, _do_cmd,    \
+                                    NULL)
+
+#define U_BOOT_CMD_WITH_SUBCMDS(_name, _usage, _help, ...)             \
+       U_BOOT_SUBCMDS(_name, __VA_ARGS__)                              \
+       U_BOOT_CMDREP_COMPLETE(_name, CONFIG_SYS_MAXARGS, do_##_name,   \
+                              _usage, _help, complete_##_name)
+
 #endif /* __COMMAND_H */