env/common.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000-2010
   4  * Wolfgang Denk, DENX Software Engineering, [email protected].
   5  *
   6  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   7  * Andreas Heppel <[email protected]>
   8  */
   9
  10 #include <common.h>
  11 #include <bootstage.h>
  12 #include <command.h>
  13 #include <env.h>
  14 #include <env_internal.h>
  15 #include <log.h>
  16 #include <sort.h>
  17 #include <linux/stddef.h>
  18 #include <search.h>
  19 #include <errno.h>
  20 #include <malloc.h>
  21 #include <u-boot/crc.h>
  22
  23 DECLARE_GLOBAL_DATA_PTR;
  24
  25 /************************************************************************
  26  * Default settings to be used when no valid environment is found
  27  */
  28 #include <env_default.h>
  29
  30 struct hsearch_data env_htab = {
  31         .change_ok = env_flags_validate,
  32 };
  33
  34 /*
  35  * Read an environment variable as a boolean
  36  * Return -1 if variable does not exist (default to true)
  37  */
  38 int env_get_yesno(const char *var)
  39 {
  40         char *s = env_get(var);
  41
  42         if (s == NULL)
  43                 return -1;
  44         return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
  45                 1 : 0;
  46 }
  47
  48 /*
  49  * Look up the variable from the default environment
  50  */
  51 char *env_get_default(const char *name)
  52 {
  53         char *ret_val;
  54         unsigned long really_valid = gd->env_valid;
  55         unsigned long real_gd_flags = gd->flags;
  56
  57         /* Pretend that the image is bad. */
  58         gd->flags &= ~GD_FLG_ENV_READY;
  59         gd->env_valid = ENV_INVALID;
  60         ret_val = env_get(name);
  61         gd->env_valid = really_valid;
  62         gd->flags = real_gd_flags;
  63         return ret_val;
  64 }
  65
  66 void env_set_default(const char *s, int flags)
  67 {
  68         if (sizeof(default_environment) > ENV_SIZE) {
  69                 puts("*** Error - default environment is too large\n\n");
  70                 return;
  71         }
  72
  73         if (s) {
  74                 if ((flags & H_INTERACTIVE) == 0) {
  75                         printf("*** Warning - %s, "
  76                                 "using default environment\n\n", s);
  77                 } else {
  78                         puts(s);
  79                 }
  80         } else {
  81                 debug("Using default environment\n");
  82         }
  83
  84         flags |= H_DEFAULT;
  85         if (himport_r(&env_htab, (char *)default_environment,
  86                         sizeof(default_environment), '\0', flags, 0,
  87                         0, NULL) == 0)
  88                 pr_err("## Error: Environment import failed: errno = %d\n",
  89                        errno);
  90
  91         gd->flags |= GD_FLG_ENV_READY;
  92         gd->flags |= GD_FLG_ENV_DEFAULT;
  93 }
  94
  95
  96 /* [re]set individual variables to their value in the default environment */
  97 int env_set_default_vars(int nvars, char * const vars[], int flags)
  98 {
  99         /*
 100          * Special use-case: import from default environment
 101          * (and use \0 as a separator)
 102          */
 103         flags |= H_NOCLEAR | H_DEFAULT;
 104         return himport_r(&env_htab, (const char *)default_environment,
 105                                 sizeof(default_environment), '\0',
 106                                 flags, 0, nvars, vars);
 107 }
 108
 109 /*
 110  * Check if CRC is valid and (if yes) import the environment.
 111  * Note that "buf" may or may not be aligned.
 112  */
 113 int env_import(const char *buf, int check, int flags)
 114 {
 115         env_t *ep = (env_t *)buf;
 116
 117         if (check) {
 118                 uint32_t crc;
 119
 120                 memcpy(&crc, &ep->crc, sizeof(crc));
 121
 122                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
 123                         env_set_default("bad CRC", 0);
 124                         return -ENOMSG; /* needed for env_load() */
 125                 }
 126         }
 127
 128         if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', flags, 0,
 129                         0, NULL)) {
 130                 gd->flags |= GD_FLG_ENV_READY;
 131                 return 0;
 132         }
 133
 134         pr_err("Cannot import environment: errno = %d\n", errno);
 135
 136         env_set_default("import failed", 0);
 137
 138         return -EIO;
 139 }
 140
 141 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 142 static unsigned char env_flags;
 143
 144 int env_check_redund(const char *buf1, int buf1_read_fail,
 145                      const char *buf2, int buf2_read_fail)
 146 {
 147         int crc1_ok, crc2_ok;
 148         env_t *tmp_env1, *tmp_env2;
 149
 150         tmp_env1 = (env_t *)buf1;
 151         tmp_env2 = (env_t *)buf2;
 152
 153         if (buf1_read_fail && buf2_read_fail) {
 154                 puts("*** Error - No Valid Environment Area found\n");
 155         } else if (buf1_read_fail || buf2_read_fail) {
 156                 puts("*** Warning - some problems detected ");
 157                 puts("reading environment; recovered successfully\n");
 158         }
 159
 160         if (buf1_read_fail && buf2_read_fail) {
 161                 return -EIO;
 162         } else if (!buf1_read_fail && buf2_read_fail) {
 163                 gd->env_valid = ENV_VALID;
 164                 return -EINVAL;
 165         } else if (buf1_read_fail && !buf2_read_fail) {
 166                 gd->env_valid = ENV_REDUND;
 167                 return -ENOENT;
 168         }
 169
 170         crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
 171                         tmp_env1->crc;
 172         crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
 173                         tmp_env2->crc;
 174
 175         if (!crc1_ok && !crc2_ok) {
 176                 return -ENOMSG; /* needed for env_load() */
 177         } else if (crc1_ok && !crc2_ok) {
 178                 gd->env_valid = ENV_VALID;
 179         } else if (!crc1_ok && crc2_ok) {
 180                 gd->env_valid = ENV_REDUND;
 181         } else {
 182                 /* both ok - check serial */
 183                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
 184                         gd->env_valid = ENV_REDUND;
 185                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
 186                         gd->env_valid = ENV_VALID;
 187                 else if (tmp_env1->flags > tmp_env2->flags)
 188                         gd->env_valid = ENV_VALID;
 189                 else if (tmp_env2->flags > tmp_env1->flags)
 190                         gd->env_valid = ENV_REDUND;
 191                 else /* flags are equal - almost impossible */
 192                         gd->env_valid = ENV_VALID;
 193         }
 194
 195         return 0;
 196 }
 197
 198 int env_import_redund(const char *buf1, int buf1_read_fail,
 199                       const char *buf2, int buf2_read_fail,
 200                       int flags)
 201 {
 202         env_t *ep;
 203         int ret;
 204
 205         ret = env_check_redund(buf1, buf1_read_fail, buf2, buf2_read_fail);
 206
 207         if (ret == -EIO) {
 208                 env_set_default("bad env area", 0);
 209                 return -EIO;
 210         } else if (ret == -EINVAL) {
 211                 return env_import((char *)buf1, 1, flags);
 212         } else if (ret == -ENOENT) {
 213                 return env_import((char *)buf2, 1, flags);
 214         } else if (ret == -ENOMSG) {
 215                 env_set_default("bad CRC", 0);
 216                 return -ENOMSG;
 217         }
 218
 219         if (gd->env_valid == ENV_VALID)
 220                 ep = (env_t *)buf1;
 221         else
 222                 ep = (env_t *)buf2;
 223
 224         env_flags = ep->flags;
 225
 226         return env_import((char *)ep, 0, flags);
 227 }
 228 #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
 229
 230 /* Export the environment and generate CRC for it. */
 231 int env_export(env_t *env_out)
 232 {
 233         char *res;
 234         ssize_t len;
 235
 236         res = (char *)env_out->data;
 237         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
 238         if (len < 0) {
 239                 pr_err("Cannot export environment: errno = %d\n", errno);
 240                 return 1;
 241         }
 242
 243         env_out->crc = crc32(0, env_out->data, ENV_SIZE);
 244
 245 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 246         env_out->flags = ++env_flags; /* increase the serial */
 247 #endif
 248
 249         return 0;
 250 }
 251
 252 void env_relocate(void)
 253 {
 254 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 255         env_reloc();
 256         env_fix_drivers();
 257         env_htab.change_ok += gd->reloc_off;
 258 #endif
 259         if (gd->env_valid == ENV_INVALID) {
 260 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
 261                 /* Environment not changable */
 262                 env_set_default(NULL, 0);
 263 #else
 264                 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
 265                 env_set_default("bad CRC", 0);
 266 #endif
 267         } else {
 268                 env_load();
 269         }
 270 }
 271
 272 #ifdef CONFIG_AUTO_COMPLETE
 273 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf,
 274                  bool dollar_comp)
 275 {
 276         struct env_entry *match;
 277         int found, idx;
 278
 279         if (dollar_comp) {
 280                 /*
 281                  * When doing $ completion, the first character should
 282                  * obviously be a '$'.
 283                  */
 284                 if (var[0] != '$')
 285                         return 0;
 286
 287                 var++;
 288
 289                 /*
 290                  * The second one, if present, should be a '{', as some
 291                  * configuration of the u-boot shell expand ${var} but not
 292                  * $var.
 293                  */
 294                 if (var[0] == '{')
 295                         var++;
 296                 else if (var[0] != '\0')
 297                         return 0;
 298         }
 299
 300         idx = 0;
 301         found = 0;
 302         cmdv[0] = NULL;
 303
 304
 305         while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
 306                 int vallen = strlen(match->key) + 1;
 307
 308                 if (found >= maxv - 2 ||
 309                     bufsz < vallen + (dollar_comp ? 3 : 0))
 310                         break;
 311
 312                 cmdv[found++] = buf;
 313
 314                 /* Add the '${' prefix to each var when doing $ completion. */
 315                 if (dollar_comp) {
 316                         strcpy(buf, "${");
 317                         buf += 2;
 318                         bufsz -= 3;
 319                 }
 320
 321                 memcpy(buf, match->key, vallen);
 322                 buf += vallen;
 323                 bufsz -= vallen;
 324
 325                 if (dollar_comp) {
 326                         /*
 327                          * This one is a bit odd: vallen already contains the
 328                          * '\0' character but we need to add the '}' suffix,
 329                          * hence the buf - 1 here. strcpy() will add the '\0'
 330                          * character just after '}'. buf is then incremented
 331                          * to account for the extra '}' we just added.
 332                          */
 333                         strcpy(buf - 1, "}");
 334                         buf++;
 335                 }
 336         }
 337
 338         qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
 339
 340         if (idx)
 341                 cmdv[found++] = dollar_comp ? "${...}" : "...";
 342
 343         cmdv[found] = NULL;
 344         return found;
 345 }
 346 #endif