common: command: Fix manual relocation for repeatable command
[oweals/u-boot.git] / common / command.c
index 746b7e3f0e7da5c052b3de45e28569e4e7dad523..ceca992510762d1b2cea8df922f8d5310cfb1ce0 100644 (file)
@@ -1,8 +1,7 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2000-2009
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 /*
@@ -11,6 +10,8 @@
 
 #include <common.h>
 #include <command.h>
+#include <console.h>
+#include <env.h>
 #include <linux/ctype.h>
 
 /*
  * for long help messages
  */
 
-int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
-             flag, int argc, char * const argv[])
+int _do_help(cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t *cmdtp, int flag,
+            int argc, char * const argv[])
 {
        int i;
        int rcode = 0;
 
-       if (argc == 1) {        /*show list of commands */
+       if (argc == 1) {        /* show list of commands */
                cmd_tbl_t *cmd_array[cmd_items];
                int i, j, swaps;
 
@@ -38,8 +39,8 @@ int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
                for (i = cmd_items - 1; i > 0; --i) {
                        swaps = 0;
                        for (j = 0; j < i; ++j) {
-                               if (strcmp (cmd_array[j]->name,
-                                           cmd_array[j + 1]->name) > 0) {
+                               if (strcmp(cmd_array[j]->name,
+                                          cmd_array[j + 1]->name) > 0) {
                                        cmd_tbl_t *tmp;
                                        tmp = cmd_array[j];
                                        cmd_array[j] = cmd_array[j + 1];
@@ -56,7 +57,7 @@ int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
                        const char *usage = cmd_array[i]->usage;
 
                        /* allow user abort */
-                       if (ctrlc ())
+                       if (ctrlc())
                                return 1;
                        if (usage == NULL)
                                continue;
@@ -69,26 +70,24 @@ int _do_help (cmd_tbl_t *cmd_start, int cmd_items, cmd_tbl_t * cmdtp, int
         * command help (long version)
         */
        for (i = 1; i < argc; ++i) {
-               if ((cmdtp = find_cmd_tbl (argv[i], cmd_start, cmd_items )) != NULL) {
+               cmdtp = find_cmd_tbl(argv[i], cmd_start, cmd_items);
+               if (cmdtp != NULL) {
                        rcode |= cmd_usage(cmdtp);
                } else {
-                       printf ("Unknown command '%s' - try 'help'"
-                               " without arguments for list of all"
-                               " known commands\n\n", argv[i]
-                                       );
+                       printf("Unknown command '%s' - try 'help' without arguments for list of all known commands\n\n",
+                              argv[i]);
                        rcode = 1;
                }
        }
        return rcode;
 }
 
-/***************************************************************************
- * find command table entry for a command
- */
-cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len)
+/* find command table entry for a command */
+cmd_tbl_t *find_cmd_tbl(const char *cmd, cmd_tbl_t *table, int table_len)
 {
+#ifdef CONFIG_CMDLINE
        cmd_tbl_t *cmdtp;
-       cmd_tbl_t *cmdtp_temp = table;  /*Init value */
+       cmd_tbl_t *cmdtp_temp = table;  /* Init value */
        const char *p;
        int len;
        int n_found = 0;
@@ -101,11 +100,9 @@ cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len)
         */
        len = ((p = strchr(cmd, '.')) == NULL) ? strlen (cmd) : (p - cmd);
 
-       for (cmdtp = table;
-            cmdtp != table + table_len;
-            cmdtp++) {
-               if (strncmp (cmd, cmdtp->name, len) == 0) {
-                       if (len == strlen (cmdtp->name))
+       for (cmdtp = table; cmdtp != table + table_len; cmdtp++) {
+               if (strncmp(cmd, cmdtp->name, len) == 0) {
+                       if (len == strlen(cmdtp->name))
                                return cmdtp;   /* full match */
 
                        cmdtp_temp = cmdtp;     /* abbreviated command ? */
@@ -115,11 +112,12 @@ cmd_tbl_t *find_cmd_tbl (const char *cmd, cmd_tbl_t *table, int table_len)
        if (n_found == 1) {                     /* exactly one match */
                return cmdtp_temp;
        }
+#endif /* CONFIG_CMDLINE */
 
        return NULL;    /* not found or ambiguous command */
 }
 
-cmd_tbl_t *find_cmd (const char *cmd)
+cmd_tbl_t *find_cmd(const char *cmd)
 {
        cmd_tbl_t *start = ll_entry_start(cmd_tbl_t, cmd);
        const int len = ll_entry_count(cmd_tbl_t, cmd);
@@ -138,36 +136,52 @@ int cmd_usage(const cmd_tbl_t *cmdtp)
                return 1;
        }
 
-       puts (cmdtp->help);
-       putc ('\n');
+       puts(cmdtp->help);
+       putc('\n');
 #endif /* CONFIG_SYS_LONGHELP */
        return 1;
 }
 
 #ifdef CONFIG_AUTO_COMPLETE
+static char env_complete_buf[512];
 
 int var_complete(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
 {
-       static char tmp_buf[512];
        int space;
 
        space = last_char == '\0' || isblank(last_char);
 
        if (space && argc == 1)
-               return env_complete("", maxv, cmdv, sizeof(tmp_buf), tmp_buf);
+               return env_complete("", maxv, cmdv, sizeof(env_complete_buf),
+                                   env_complete_buf, false);
 
        if (!space && argc == 2)
-               return env_complete(argv[1], maxv, cmdv, sizeof(tmp_buf), tmp_buf);
+               return env_complete(argv[1], maxv, cmdv,
+                                   sizeof(env_complete_buf),
+                                   env_complete_buf, false);
 
        return 0;
 }
 
+static int dollar_complete(int argc, char * const argv[], char last_char,
+                          int maxv, char *cmdv[])
+{
+       /* Make sure the last argument starts with a $. */
+       if (argc < 1 || argv[argc - 1][0] != '$' ||
+           last_char == '\0' || isblank(last_char))
+               return 0;
+
+       return env_complete(argv[argc - 1], maxv, cmdv, sizeof(env_complete_buf),
+                           env_complete_buf, true);
+}
+
 /*************************************************************************************/
 
-static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv, char *cmdv[])
+int complete_subcmdv(cmd_tbl_t *cmdtp, int count, int argc,
+                    char * const argv[], char last_char,
+                    int maxv, char *cmdv[])
 {
-       cmd_tbl_t *cmdtp = ll_entry_start(cmd_tbl_t, cmd);
-       const int count = ll_entry_count(cmd_tbl_t, cmd);
+#ifdef CONFIG_CMDLINE
        const cmd_tbl_t *cmdend = cmdtp + count;
        const char *p;
        int len, clen;
@@ -194,8 +208,8 @@ static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv
        }
 
        /* more than one arg or one but the start of the next */
-       if (argc > 1 || (last_char == '\0' || isblank(last_char))) {
-               cmdtp = find_cmd(argv[0]);
+       if (argc > 1 || last_char == '\0' || isblank(last_char)) {
+               cmdtp = find_cmd_tbl(argv[0], cmdtp, count);
                if (cmdtp == NULL || cmdtp->complete == NULL) {
                        cmdv[0] = NULL;
                        return 0;
@@ -235,6 +249,21 @@ static int complete_cmdv(int argc, char * const argv[], char last_char, int maxv
 
        cmdv[n_found] = NULL;
        return n_found;
+#else
+       return 0;
+#endif
+}
+
+static int complete_cmdv(int argc, char * const argv[], char last_char,
+                        int maxv, char *cmdv[])
+{
+#ifdef CONFIG_CMDLINE
+       return complete_subcmdv(ll_entry_start(cmd_tbl_t, cmd),
+                               ll_entry_count(cmd_tbl_t, cmd), argc, argv,
+                               last_char, maxv, cmdv);
+#else
+       return 0;
+#endif
 }
 
 static int make_argv(char *s, int argvsz, char *argv[])
@@ -316,7 +345,7 @@ static int find_common_prefix(char * const argv[])
        return len;
 }
 
-static char tmp_buf[CONFIG_SYS_CBSIZE];        /* copy of console I/O buffer   */
+static char tmp_buf[CONFIG_SYS_CBSIZE + 1];    /* copy of console I/O buffer */
 
 int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
 {
@@ -328,8 +357,13 @@ int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
        int i, j, k, len, seplen, argc;
        int cnt;
        char last_char;
+#ifdef CONFIG_CMDLINE_PS_SUPPORT
+       const char *ps_prompt = env_get("PS1");
+#else
+       const char *ps_prompt = CONFIG_SYS_PROMPT;
+#endif
 
-       if (strcmp(prompt, CONFIG_SYS_PROMPT) != 0)
+       if (strcmp(prompt, ps_prompt) != 0)
                return 0;       /* not in normal console */
 
        cnt = strlen(buf);
@@ -344,8 +378,14 @@ int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
        /* separate into argv */
        argc = make_argv(tmp_buf, sizeof(argv)/sizeof(argv[0]), argv);
 
-       /* do the completion and return the possible completions */
-       i = complete_cmdv(argc, argv, last_char, sizeof(cmdv)/sizeof(cmdv[0]), cmdv);
+       /* first try a $ completion */
+       i = dollar_complete(argc, argv, last_char,
+                           sizeof(cmdv) / sizeof(cmdv[0]), cmdv);
+       if (!i) {
+               /* do the completion and return the possible completions */
+               i = complete_cmdv(argc, argv, last_char,
+                                 sizeof(cmdv) / sizeof(cmdv[0]), cmdv);
+       }
 
        /* no match; bell and out */
        if (i == 0) {
@@ -360,13 +400,21 @@ int cmd_auto_complete(const char *const prompt, char *buf, int *np, int *colp)
        sep = NULL;
        seplen = 0;
        if (i == 1) { /* one match; perfect */
-               k = strlen(argv[argc - 1]);
+               if (last_char != '\0' && !isblank(last_char))
+                       k = strlen(argv[argc - 1]);
+               else
+                       k = 0;
+
                s = cmdv[0] + k;
                len = strlen(s);
                sep = " ";
                seplen = 1;
-       } else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) {      /* more */
-               k = strlen(argv[argc - 1]);
+       } else if (i > 1 && (j = find_common_prefix(cmdv)) != 0) { /* more */
+               if (last_char != '\0' && !isblank(last_char))
+                       k = strlen(argv[argc - 1]);
+               else
+                       k = 0;
+
                j -= k;
                if (j > 0) {
                        s = cmdv[0] + k;
@@ -414,7 +462,7 @@ int cmd_get_data_size(char* arg, int default_size)
         */
        int len = strlen(arg);
        if (len > 2 && arg[len-2] == '.') {
-               switch(arg[len-1]) {
+               switch (arg[len-1]) {
                case 'b':
                        return 1;
                case 'w':
@@ -448,10 +496,15 @@ void fixup_cmdtable(cmd_tbl_t *cmdtp, int size)
        for (i = 0; i < size; i++) {
                ulong addr;
 
-               addr = (ulong) (cmdtp->cmd) + gd->reloc_off;
-#if DEBUG_COMMANDS
+               addr = (ulong)(cmdtp->cmd_rep) + gd->reloc_off;
+               cmdtp->cmd_rep =
+                       (int (*)(struct cmd_tbl_s *, int, int,
+                                char * const [], int *))addr;
+
+               addr = (ulong)(cmdtp->cmd) + gd->reloc_off;
+#ifdef DEBUG_COMMANDS
                printf("Command \"%s\": 0x%08lx => 0x%08lx\n",
-                      cmdtp->name, (ulong) (cmdtp->cmd), addr);
+                      cmdtp->name, (ulong)(cmdtp->cmd), addr);
 #endif
                cmdtp->cmd =
                        (int (*)(struct cmd_tbl_s *, int, int, char * const []))addr;
@@ -479,6 +532,30 @@ void fixup_cmdtable(cmd_tbl_t *cmdtp, int size)
 }
 #endif
 
+int cmd_always_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
+                         char * const argv[], int *repeatable)
+{
+       *repeatable = 1;
+
+       return cmdtp->cmd(cmdtp, flag, argc, argv);
+}
+
+int cmd_never_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
+                        char * const argv[], int *repeatable)
+{
+       *repeatable = 0;
+
+       return cmdtp->cmd(cmdtp, flag, argc, argv);
+}
+
+int cmd_discard_repeatable(cmd_tbl_t *cmdtp, int flag, int argc,
+                          char * const argv[])
+{
+       int repeatable;
+
+       return cmdtp->cmd_rep(cmdtp, flag, argc, argv, &repeatable);
+}
+
 /**
  * Call a command function. This should be the only route in U-Boot to call
  * a command, so that we can track whether we are waiting for input or
@@ -488,15 +565,17 @@ void fixup_cmdtable(cmd_tbl_t *cmdtp, int size)
  * @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   Can the command be repeated
  * @return 0 if command succeeded, else non-zero (CMD_RET_...)
  */
-static int cmd_call(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
+static int cmd_call(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
+                   int *repeatable)
 {
        int result;
 
-       result = (cmdtp->cmd)(cmdtp, flag, argc, argv);
+       result = cmdtp->cmd_rep(cmdtp, flag, argc, argv, repeatable);
        if (result)
-               debug("Command failed, result=%d", result);
+               debug("Command failed, result=%d\n", result);
        return result;
 }
 
@@ -506,6 +585,20 @@ enum command_ret_t cmd_process(int flag, int argc, char * const argv[],
        enum command_ret_t rc = CMD_RET_SUCCESS;
        cmd_tbl_t *cmdtp;
 
+#if defined(CONFIG_SYS_XTRACE)
+       char *xtrace;
+
+       xtrace = env_get("xtrace");
+       if (xtrace) {
+               puts("+");
+               for (int i = 0; i < argc; i++) {
+                       puts(" ");
+                       puts(argv[i]);
+               }
+               puts("\n");
+       }
+#endif
+
        /* Look up command in command table */
        cmdtp = find_cmd(argv[0]);
        if (cmdtp == NULL) {
@@ -531,12 +624,14 @@ enum command_ret_t cmd_process(int flag, int argc, char * const argv[],
 
        /* If OK so far, then do the command */
        if (!rc) {
+               int newrep;
+
                if (ticks)
                        *ticks = get_timer(0);
-               rc = cmd_call(cmdtp, flag, argc, argv);
+               rc = cmd_call(cmdtp, flag, argc, argv, &newrep);
                if (ticks)
                        *ticks = get_timer(*ticks);
-               *repeatable &= cmdtp->repeatable;
+               *repeatable &= newrep;
        }
        if (rc == CMD_RET_USAGE)
                rc = cmd_usage(cmdtp);
@@ -545,10 +640,13 @@ enum command_ret_t cmd_process(int flag, int argc, char * const argv[],
 
 int cmd_process_error(cmd_tbl_t *cmdtp, int err)
 {
+       if (err == CMD_RET_USAGE)
+               return CMD_RET_USAGE;
+
        if (err) {
                printf("Command '%s' failed: Error %d\n", cmdtp->name, err);
-               return 1;
+               return CMD_RET_FAILURE;
        }
 
-       return 0;
+       return CMD_RET_SUCCESS;
 }