rockchip: add common tpl board file
[oweals/u-boot.git] / cmd / nvedit.c
index 4e79d03856fec3117e6614c8b544c5022531562a..46b1e60f0ad92372409fe738902fd2c18ceb3f9a 100644 (file)
@@ -1,3 +1,4 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2000-2013
  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
@@ -6,8 +7,6 @@
  * Andreas Heppel <aheppel@sysgo.de>
  *
  * Copyright 2011 Freescale Semiconductor, Inc.
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 /*
 
 DECLARE_GLOBAL_DATA_PTR;
 
-#if    !defined(CONFIG_ENV_IS_IN_EEPROM)       && \
-       !defined(CONFIG_ENV_IS_IN_FLASH)        && \
-       !defined(CONFIG_ENV_IS_IN_MMC)          && \
-       !defined(CONFIG_ENV_IS_IN_FAT)          && \
-       !defined(CONFIG_ENV_IS_IN_EXT4)         && \
-       !defined(CONFIG_ENV_IS_IN_NAND)         && \
-       !defined(CONFIG_ENV_IS_IN_NVRAM)        && \
-       !defined(CONFIG_ENV_IS_IN_ONENAND)      && \
-       !defined(CONFIG_ENV_IS_IN_SATA)         && \
-       !defined(CONFIG_ENV_IS_IN_SPI_FLASH)    && \
-       !defined(CONFIG_ENV_IS_IN_REMOTE)       && \
-       !defined(CONFIG_ENV_IS_IN_UBI)          && \
+#if    defined(CONFIG_ENV_IS_IN_EEPROM)        || \
+       defined(CONFIG_ENV_IS_IN_FLASH)         || \
+       defined(CONFIG_ENV_IS_IN_MMC)           || \
+       defined(CONFIG_ENV_IS_IN_FAT)           || \
+       defined(CONFIG_ENV_IS_IN_EXT4)          || \
+       defined(CONFIG_ENV_IS_IN_NAND)          || \
+       defined(CONFIG_ENV_IS_IN_NVRAM)         || \
+       defined(CONFIG_ENV_IS_IN_ONENAND)       || \
+       defined(CONFIG_ENV_IS_IN_SATA)          || \
+       defined(CONFIG_ENV_IS_IN_SPI_FLASH)     || \
+       defined(CONFIG_ENV_IS_IN_REMOTE)        || \
+       defined(CONFIG_ENV_IS_IN_UBI)
+
+#define ENV_IS_IN_DEVICE
+
+#endif
+
+#if    !defined(ENV_IS_IN_DEVICE)              && \
        !defined(CONFIG_ENV_IS_NOWHERE)
 # error Define one of CONFIG_ENV_IS_IN_{EEPROM|FLASH|MMC|FAT|EXT4|\
 NAND|NVRAM|ONENAND|SATA|SPI_FLASH|REMOTE|UBI} or CONFIG_ENV_IS_NOWHERE
@@ -120,6 +125,11 @@ static int do_env_print(cmd_tbl_t *cmdtp, int flag, int argc,
        int rcode = 0;
        int env_flag = H_HIDE_DOT;
 
+#if defined(CONFIG_CMD_NVEDIT_EFI)
+       if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'e')
+               return do_env_print_efi(cmdtp, flag, --argc, ++argv);
+#endif
+
        if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'a') {
                argc--;
                argv++;
@@ -217,6 +227,12 @@ static int _do_env_set(int flag, int argc, char * const argv[], int env_flag)
        ENTRY e, *ep;
 
        debug("Initial value for argc=%d\n", argc);
+
+#if CONFIG_IS_ENABLED(CMD_NVEDIT_EFI)
+       if (argc > 1 && argv[1][0] == '-' && argv[1][1] == 'e')
+               return do_env_set_efi(NULL, flag, --argc, ++argv);
+#endif
+
        while (argc > 1 && **(argv + 1) == '-') {
                char *arg = *++argv;
 
@@ -341,6 +357,36 @@ ulong env_get_hex(const char *varname, ulong default_val)
        return value;
 }
 
+void eth_parse_enetaddr(const char *addr, uint8_t *enetaddr)
+{
+       char *end;
+       int i;
+
+       for (i = 0; i < 6; ++i) {
+               enetaddr[i] = addr ? simple_strtoul(addr, &end, 16) : 0;
+               if (addr)
+                       addr = (*end) ? end + 1 : end;
+       }
+}
+
+int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr)
+{
+       eth_parse_enetaddr(env_get(name), enetaddr);
+       return is_valid_ethaddr(enetaddr);
+}
+
+int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr)
+{
+       char buf[ARP_HLEN_ASCII + 1];
+
+       if (eth_env_get_enetaddr(name, (uint8_t *)buf))
+               return -EEXIST;
+
+       sprintf(buf, "%pM", enetaddr);
+
+       return env_set(name, buf);
+}
+
 #ifndef CONFIG_SPL_BUILD
 static int do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 {
@@ -650,12 +696,14 @@ char *env_get(const char *name)
  */
 int env_get_f(const char *name, char *buf, unsigned len)
 {
-       int i, nxt;
+       int i, nxt, c;
 
        for (i = 0; env_get_char(i) != '\0'; i = nxt + 1) {
                int val, n;
 
-               for (nxt = i; env_get_char(nxt) != '\0'; ++nxt) {
+               for (nxt = i; (c = env_get_char(nxt)) != '\0'; ++nxt) {
+                       if (c < 0)
+                               return c;
                        if (nxt >= CONFIG_ENV_SIZE)
                                return -1;
                }
@@ -666,7 +714,10 @@ int env_get_f(const char *name, char *buf, unsigned len)
 
                /* found; copy out */
                for (n = 0; n < len; ++n, ++buf) {
-                       *buf = env_get_char(val++);
+                       c = env_get_char(val++);
+                       if (c < 0)
+                               return c;
+                       *buf = c;
                        if (*buf == '\0')
                                return n;
                }
@@ -674,8 +725,8 @@ int env_get_f(const char *name, char *buf, unsigned len)
                if (n)
                        *--buf = '\0';
 
-               printf("env_buf [%d bytes] too small for value of \"%s\"\n",
-                       len, name);
+               printf("env_buf [%u bytes] too small for value of \"%s\"\n",
+                      len, name);
 
                return n;
        }
@@ -686,7 +737,7 @@ int env_get_f(const char *name, char *buf, unsigned len)
 /**
  * Decode the integer value of an environment variable and return it.
  *
- * @param name         Name of environemnt variable
+ * @param name         Name of environment variable
  * @param base         Number base to use (normally 10, or 16 for hex)
  * @param default_val  Default value to return if the variable is not
  *                     found
@@ -704,14 +755,10 @@ ulong env_get_ulong(const char *name, int base, ulong default_val)
 }
 
 #ifndef CONFIG_SPL_BUILD
-#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
+#if defined(CONFIG_CMD_SAVEENV) && defined(ENV_IS_IN_DEVICE)
 static int do_env_save(cmd_tbl_t *cmdtp, int flag, int argc,
                       char * const argv[])
 {
-       struct env_driver *env = env_driver_lookup_default();
-
-       printf("Saving Environment to %s...\n", env->name);
-
        return env_save() ? 1 : 0;
 }
 
@@ -720,6 +767,20 @@ U_BOOT_CMD(
        "save environment variables to persistent storage",
        ""
 );
+
+#if defined(CONFIG_CMD_ERASEENV)
+static int do_env_erase(cmd_tbl_t *cmdtp, int flag, int argc,
+                       char * const argv[])
+{
+       return env_erase() ? 1 : 0;
+}
+
+U_BOOT_CMD(
+       eraseenv, 1, 0, do_env_erase,
+       "erase environment variables from persistent storage",
+       ""
+);
+#endif
 #endif
 #endif /* CONFIG_SPL_BUILD */
 
@@ -747,10 +808,10 @@ int envmatch(uchar *s1, int i2)
 }
 
 #ifndef CONFIG_SPL_BUILD
-static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
+static int do_env_default(cmd_tbl_t *cmdtp, int flag,
                          int argc, char * const argv[])
 {
-       int all = 0, flag = 0;
+       int all = 0, env_flag = H_INTERACTIVE;
 
        debug("Initial value for argc=%d\n", argc);
        while (--argc > 0 && **++argv == '-') {
@@ -762,7 +823,7 @@ static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
                                all = 1;
                                break;
                        case 'f':               /* force */
-                               flag |= H_FORCE;
+                               env_flag |= H_FORCE;
                                break;
                        default:
                                return cmd_usage(cmdtp);
@@ -772,12 +833,13 @@ static int do_env_default(cmd_tbl_t *cmdtp, int __flag,
        debug("Final value for argc=%d\n", argc);
        if (all && (argc == 0)) {
                /* Reset the whole environment */
-               set_default_env("## Resetting to default environment\n");
+               set_default_env("## Resetting to default environment\n",
+                               env_flag);
                return 0;
        }
        if (!all && (argc > 0)) {
                /* Reset individual variables */
-               set_default_vars(argc, argv);
+               set_default_vars(argc, argv, env_flag);
                return 0;
        }
 
@@ -929,7 +991,8 @@ NXTARG:             ;
                                H_MATCH_KEY | H_MATCH_IDENT,
                                &ptr, size, argc, argv);
                if (len < 0) {
-                       pr_err("Cannot export environment: errno = %d\n", errno);
+                       pr_err("## Error: Cannot export environment: errno = %d\n",
+                              errno);
                        return 1;
                }
                sprintf(buf, "%zX", (size_t)len);
@@ -949,12 +1012,14 @@ NXTARG:          ;
                        H_MATCH_KEY | H_MATCH_IDENT,
                        &res, ENV_SIZE, argc, argv);
        if (len < 0) {
-               pr_err("Cannot export environment: errno = %d\n", errno);
+               pr_err("## Error: Cannot export environment: errno = %d\n",
+                      errno);
                return 1;
        }
 
        if (chk) {
-               envp->crc = crc32(0, envp->data, ENV_SIZE);
+               envp->crc = crc32(0, envp->data,
+                               size ? size - offsetof(env_t, data) : ENV_SIZE);
 #ifdef CONFIG_ENV_ADDR_REDUND
                envp->flags = ACTIVE_FLAG;
 #endif
@@ -964,15 +1029,19 @@ NXTARG:          ;
        return 0;
 
 sep_err:
-       printf("## %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n", cmd);
+       printf("## Error: %s: only one of \"-b\", \"-c\" or \"-t\" allowed\n",
+              cmd);
        return 1;
 }
 #endif
 
 #ifdef CONFIG_CMD_IMPORTENV
 /*
- * env import [-d] [-t [-r] | -b | -c] addr [size]
- *     -d:     delete existing environment before importing;
+ * env import [-d] [-t [-r] | -b | -c] addr [size] [var ...]
+ *     -d:     delete existing environment before importing if no var is
+ *             passed; if vars are passed, if one var is in the current
+ *             environment but not in the environment at addr, delete var from
+ *             current environment;
  *             otherwise overwrite / append to existing definitions
  *     -t:     assume text format; either "size" must be given or the
  *             text data must be '\0' terminated
@@ -985,6 +1054,11 @@ sep_err:
  *     addr:   memory address to read from
  *     size:   length of input data; if missing, proper '\0'
  *             termination is mandatory
+ *             if var is set and size should be missing (i.e. '\0'
+ *             termination), set size to '-'
+ *     var...  List of the names of the only variables that get imported from
+ *             the environment at address 'addr'. Without arguments, the whole
+ *             environment gets imported.
  */
 static int do_env_import(cmd_tbl_t *cmdtp, int flag,
                         int argc, char * const argv[])
@@ -996,6 +1070,7 @@ static int do_env_import(cmd_tbl_t *cmdtp, int flag,
        int     fmt = 0;
        int     del = 0;
        int     crlf_is_lf = 0;
+       int     wl = 0;
        size_t  size;
 
        cmd = *argv;
@@ -1044,9 +1119,9 @@ static int do_env_import(cmd_tbl_t *cmdtp, int flag,
        addr = simple_strtoul(argv[0], NULL, 16);
        ptr = map_sysmem(addr, 0);
 
-       if (argc == 2) {
+       if (argc >= 2 && strcmp(argv[1], "-")) {
                size = simple_strtoul(argv[1], NULL, 16);
-       } else if (argc == 1 && chk) {
+       } else if (chk) {
                puts("## Error: external checksum format must pass size\n");
                return CMD_RET_FAILURE;
        } else {
@@ -1068,6 +1143,9 @@ static int do_env_import(cmd_tbl_t *cmdtp, int flag,
                printf("## Info: input data size = %zu = 0x%zX\n", size, size);
        }
 
+       if (argc > 2)
+               wl = 1;
+
        if (chk) {
                uint32_t crc;
                env_t *ep = (env_t *)ptr;
@@ -1082,9 +1160,10 @@ static int do_env_import(cmd_tbl_t *cmdtp, int flag,
                ptr = (char *)ep->data;
        }
 
-       if (himport_r(&env_htab, ptr, size, sep, del ? 0 : H_NOCLEAR,
-                       crlf_is_lf, 0, NULL) == 0) {
-               pr_err("Environment import failed: errno = %d\n", errno);
+       if (!himport_r(&env_htab, ptr, size, sep, del ? 0 : H_NOCLEAR,
+                      crlf_is_lf, wl ? argc - 2 : 0, wl ? &argv[2] : NULL)) {
+               pr_err("## Error: Environment import failed: errno = %d\n",
+                      errno);
                return 1;
        }
        gd->flags |= GD_FLG_ENV_READY;
@@ -1098,6 +1177,106 @@ sep_err:
 }
 #endif
 
+#if defined(CONFIG_CMD_NVEDIT_INFO)
+/*
+ * print_env_info - print environment information
+ */
+static int print_env_info(void)
+{
+       const char *value;
+
+       /* print environment validity value */
+       switch (gd->env_valid) {
+       case ENV_INVALID:
+               value = "invalid";
+               break;
+       case ENV_VALID:
+               value = "valid";
+               break;
+       case ENV_REDUND:
+               value = "redundant";
+               break;
+       default:
+               value = "unknown";
+               break;
+       }
+       printf("env_valid = %s\n", value);
+
+       /* print environment ready flag */
+       value = gd->flags & GD_FLG_ENV_READY ? "true" : "false";
+       printf("env_ready = %s\n", value);
+
+       /* print environment using default flag */
+       value = gd->flags & GD_FLG_ENV_DEFAULT ? "true" : "false";
+       printf("env_use_default = %s\n", value);
+
+       return CMD_RET_SUCCESS;
+}
+
+#define ENV_INFO_IS_DEFAULT    BIT(0) /* default environment bit mask */
+#define ENV_INFO_IS_PERSISTED  BIT(1) /* environment persistence bit mask */
+
+/*
+ * env info - display environment information
+ * env info [-d] - evaluate whether default environment is used
+ * env info [-p] - evaluate whether environment can be persisted
+ */
+static int do_env_info(cmd_tbl_t *cmdtp, int flag,
+                      int argc, char * const argv[])
+{
+       int eval_flags = 0;
+       int eval_results = 0;
+
+       /* display environment information */
+       if (argc <= 1)
+               return print_env_info();
+
+       /* process options */
+       while (--argc > 0 && **++argv == '-') {
+               char *arg = *argv;
+
+               while (*++arg) {
+                       switch (*arg) {
+                       case 'd':
+                               eval_flags |= ENV_INFO_IS_DEFAULT;
+                               break;
+                       case 'p':
+                               eval_flags |= ENV_INFO_IS_PERSISTED;
+                               break;
+                       default:
+                               return CMD_RET_USAGE;
+                       }
+               }
+       }
+
+       /* evaluate whether default environment is used */
+       if (eval_flags & ENV_INFO_IS_DEFAULT) {
+               if (gd->flags & GD_FLG_ENV_DEFAULT) {
+                       printf("Default environment is used\n");
+                       eval_results |= ENV_INFO_IS_DEFAULT;
+               } else {
+                       printf("Environment was loaded from persistent storage\n");
+               }
+       }
+
+       /* evaluate whether environment can be persisted */
+       if (eval_flags & ENV_INFO_IS_PERSISTED) {
+#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
+               printf("Environment can be persisted\n");
+               eval_results |= ENV_INFO_IS_PERSISTED;
+#else
+               printf("Environment cannot be persisted\n");
+#endif
+       }
+
+       /* The result of evaluations is combined with AND */
+       if (eval_flags != eval_results)
+               return CMD_RET_FAILURE;
+
+       return CMD_RET_SUCCESS;
+}
+#endif
+
 #if defined(CONFIG_CMD_ENV_EXISTS)
 static int do_env_exists(cmd_tbl_t *cmdtp, int flag, int argc,
                       char * const argv[])
@@ -1141,13 +1320,19 @@ static cmd_tbl_t cmd_env_sub[] = {
 #endif
 #if defined(CONFIG_CMD_IMPORTENV)
        U_BOOT_CMD_MKENT(import, 5, 0, do_env_import, "", ""),
+#endif
+#if defined(CONFIG_CMD_NVEDIT_INFO)
+       U_BOOT_CMD_MKENT(info, 2, 0, do_env_info, "", ""),
 #endif
        U_BOOT_CMD_MKENT(print, CONFIG_SYS_MAXARGS, 1, do_env_print, "", ""),
 #if defined(CONFIG_CMD_RUN)
        U_BOOT_CMD_MKENT(run, CONFIG_SYS_MAXARGS, 1, do_run, "", ""),
 #endif
-#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
+#if defined(CONFIG_CMD_SAVEENV) && defined(ENV_IS_IN_DEVICE)
        U_BOOT_CMD_MKENT(save, 1, 0, do_env_save, "", ""),
+#if defined(CONFIG_CMD_ERASEENV)
+       U_BOOT_CMD_MKENT(erase, 1, 0, do_env_erase, "", ""),
+#endif
 #endif
        U_BOOT_CMD_MKENT(set, CONFIG_SYS_MAXARGS, 0, do_env_set, "", ""),
 #if defined(CONFIG_CMD_ENV_EXISTS)
@@ -1212,14 +1397,28 @@ static char env_help_text[] =
 #endif
 #endif
 #if defined(CONFIG_CMD_IMPORTENV)
-       "env import [-d] [-t [-r] | -b | -c] addr [size] - import environment\n"
+       "env import [-d] [-t [-r] | -b | -c] addr [size] [var ...] - import environment\n"
+#endif
+#if defined(CONFIG_CMD_NVEDIT_INFO)
+       "env info - display environment information\n"
+       "env info [-d] - whether default environment is used\n"
+       "env info [-p] - whether environment can be persisted\n"
 #endif
        "env print [-a | name ...] - print environment\n"
+#if defined(CONFIG_CMD_NVEDIT_EFI)
+       "env print -e [name ...] - print UEFI environment\n"
+#endif
 #if defined(CONFIG_CMD_RUN)
        "env run var [...] - run commands in an environment variable\n"
 #endif
-#if defined(CONFIG_CMD_SAVEENV) && !defined(CONFIG_ENV_IS_NOWHERE)
+#if defined(CONFIG_CMD_SAVEENV) && defined(ENV_IS_IN_DEVICE)
        "env save - save environment\n"
+#if defined(CONFIG_CMD_ERASEENV)
+       "env erase - erase environment\n"
+#endif
+#endif
+#if defined(CONFIG_CMD_NVEDIT_EFI)
+       "env set -e name [arg ...] - set UEFI variable; unset if 'arg' not specified\n"
 #endif
        "env set [-f] name [arg ...]\n";
 #endif
@@ -1247,6 +1446,10 @@ U_BOOT_CMD_COMPLETE(
        printenv, CONFIG_SYS_MAXARGS, 1,        do_env_print,
        "print environment variables",
        "[-a]\n    - print [all] values of all environment variables\n"
+#if defined(CONFIG_CMD_NVEDIT_EFI)
+       "printenv -e [name ...]\n"
+       "    - print UEFI variable 'name' or all the variables\n"
+#endif
        "printenv name ...\n"
        "    - print value of environment variable 'name'",
        var_complete
@@ -1274,7 +1477,13 @@ U_BOOT_CMD_COMPLETE(
 U_BOOT_CMD_COMPLETE(
        setenv, CONFIG_SYS_MAXARGS, 0,  do_env_set,
        "set environment variables",
-       "[-f] name value ...\n"
+#if defined(CONFIG_CMD_NVEDIT_EFI)
+       "-e [-nv] name [value ...]\n"
+       "    - set UEFI variable 'name' to 'value' ...'\n"
+       "      'nv' option makes the variable non-volatile\n"
+       "    - delete UEFI variable 'name' if 'value' not specified\n"
+#endif
+       "setenv [-f] name value ...\n"
        "    - [forcibly] set environment variable 'name' to 'value ...'\n"
        "setenv [-f] name\n"
        "    - [forcibly] delete environment variable 'name'",