env/common.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000-2010
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  *
   6  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   7  * Andreas Heppel <aheppel@sysgo.de>
   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 <asm/global_data.h>
  18 #include <linux/stddef.h>
  19 #include <search.h>
  20 #include <errno.h>
  21 #include <malloc.h>
  22 #include <u-boot/crc.h>
  23 #include <dm/ofnode.h>
  24 #include <net.h>
  25 #include <watchdog.h>
  26
  27 DECLARE_GLOBAL_DATA_PTR;
  28
  29 /************************************************************************
  30  * Default settings to be used when no valid environment is found
  31  */
  32 #include <env_default.h>
  33
  34 struct hsearch_data env_htab = {
  35         .change_ok = env_flags_validate,
  36 };
  37
  38 /*
  39  * This env_set() function is defined in cmd/nvedit.c, since it calls
  40  * _do_env_set(), whis is a static function in that file.
  41  *
  42  * int env_set(const char *varname, const char *varvalue);
  43  */
  44
  45 /**
  46  * Set an environment variable to an integer value
  47  *
  48  * @param varname       Environment variable to set
  49  * @param value         Value to set it to
  50  * @return 0 if ok, 1 on error
  51  */
  52 int env_set_ulong(const char *varname, ulong value)
  53 {
  54         /* TODO: this should be unsigned */
  55         char *str = simple_itoa(value);
  56
  57         return env_set(varname, str);
  58 }
  59
  60 /**
  61  * Set an environment variable to an value in hex
  62  *
  63  * @param varname       Environment variable to set
  64  * @param value         Value to set it to
  65  * @return 0 if ok, 1 on error
  66  */
  67 int env_set_hex(const char *varname, ulong value)
  68 {
  69         char str[17];
  70
  71         sprintf(str, "%lx", value);
  72         return env_set(varname, str);
  73 }
  74
  75 ulong env_get_hex(const char *varname, ulong default_val)
  76 {
  77         const char *s;
  78         ulong value;
  79         char *endp;
  80
  81         s = env_get(varname);
  82         if (s)
  83                 value = hextoul(s, &endp);
  84         if (!s || endp == s)
  85                 return default_val;
  86
  87         return value;
  88 }
  89
  90 int eth_env_get_enetaddr(const char *name, uint8_t *enetaddr)
  91 {
  92         string_to_enetaddr(env_get(name), enetaddr);
  93         return is_valid_ethaddr(enetaddr);
  94 }
  95
  96 int eth_env_set_enetaddr(const char *name, const uint8_t *enetaddr)
  97 {
  98         char buf[ARP_HLEN_ASCII + 1];
  99
 100         if (eth_env_get_enetaddr(name, (uint8_t *)buf))
 101                 return -EEXIST;
 102
 103         sprintf(buf, "%pM", enetaddr);
 104
 105         return env_set(name, buf);
 106 }
 107
 108 /*
 109  * Look up variable from environment,
 110  * return address of storage for that variable,
 111  * or NULL if not found
 112  */
 113 char *env_get(const char *name)
 114 {
 115         if (gd->flags & GD_FLG_ENV_READY) { /* after import into hashtable */
 116                 struct env_entry e, *ep;
 117
 118                 WATCHDOG_RESET();
 119
 120                 e.key   = name;
 121                 e.data  = NULL;
 122                 hsearch_r(e, ENV_FIND, &ep, &env_htab, 0);
 123
 124                 return ep ? ep->data : NULL;
 125         }
 126
 127         /* restricted capabilities before import */
 128         if (env_get_f(name, (char *)(gd->env_buf), sizeof(gd->env_buf)) > 0)
 129                 return (char *)(gd->env_buf);
 130
 131         return NULL;
 132 }
 133
 134 /*
 135  * Like env_get, but prints an error if envvar isn't defined in the
 136  * environment.  It always returns what env_get does, so it can be used in
 137  * place of env_get without changing error handling otherwise.
 138  */
 139 char *from_env(const char *envvar)
 140 {
 141         char *ret;
 142
 143         ret = env_get(envvar);
 144
 145         if (!ret)
 146                 printf("missing environment variable: %s\n", envvar);
 147
 148         return ret;
 149 }
 150
 151 /*
 152  * Look up variable from environment for restricted C runtime env.
 153  */
 154 int env_get_f(const char *name, char *buf, unsigned len)
 155 {
 156         const char *env, *p, *end;
 157         size_t name_len;
 158
 159         if (name == NULL || *name == '\0')
 160                 return -1;
 161
 162         name_len = strlen(name);
 163
 164         if (gd->env_valid == ENV_INVALID)
 165                 env = default_environment;
 166         else
 167                 env = (const char *)gd->env_addr;
 168
 169         for (p = env; *p != '\0'; p = end + 1) {
 170                 const char *value;
 171                 unsigned res;
 172
 173                 for (end = p; *end != '\0'; ++end)
 174                         if (end - env >= CONFIG_ENV_SIZE)
 175                                 return -1;
 176
 177                 if (strncmp(name, p, name_len) || p[name_len] != '=')
 178                         continue;
 179                 value = &p[name_len + 1];
 180
 181                 res = end - value;
 182                 memcpy(buf, value, min(len, res + 1));
 183
 184                 if (len <= res) {
 185                         buf[len - 1] = '\0';
 186                         printf("env_buf [%u bytes] too small for value of \"%s\"\n",
 187                                len, name);
 188                 }
 189
 190                 return res;
 191         }
 192
 193         return -1;
 194 }
 195
 196 /**
 197  * Decode the integer value of an environment variable and return it.
 198  *
 199  * @param name          Name of environment variable
 200  * @param base          Number base to use (normally 10, or 16 for hex)
 201  * @param default_val   Default value to return if the variable is not
 202  *                      found
 203  * @return the decoded value, or default_val if not found
 204  */
 205 ulong env_get_ulong(const char *name, int base, ulong default_val)
 206 {
 207         /*
 208          * We can use env_get() here, even before relocation, since the
 209          * environment variable value is an integer and thus short.
 210          */
 211         const char *str = env_get(name);
 212
 213         return str ? simple_strtoul(str, NULL, base) : default_val;
 214 }
 215
 216 /*
 217  * Read an environment variable as a boolean
 218  * Return -1 if variable does not exist (default to true)
 219  */
 220 int env_get_yesno(const char *var)
 221 {
 222         char *s = env_get(var);
 223
 224         if (s == NULL)
 225                 return -1;
 226         return (*s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T') ?
 227                 1 : 0;
 228 }
 229
 230 /*
 231  * Look up the variable from the default environment
 232  */
 233 char *env_get_default(const char *name)
 234 {
 235         char *ret_val;
 236         unsigned long really_valid = gd->env_valid;
 237         unsigned long real_gd_flags = gd->flags;
 238
 239         /* Pretend that the image is bad. */
 240         gd->flags &= ~GD_FLG_ENV_READY;
 241         gd->env_valid = ENV_INVALID;
 242         ret_val = env_get(name);
 243         gd->env_valid = really_valid;
 244         gd->flags = real_gd_flags;
 245         return ret_val;
 246 }
 247
 248 void env_set_default(const char *s, int flags)
 249 {
 250         if (s) {
 251                 if ((flags & H_INTERACTIVE) == 0) {
 252                         printf("*** Warning - %s, "
 253                                 "using default environment\n\n", s);
 254                 } else {
 255                         puts(s);
 256                 }
 257         } else {
 258                 debug("Using default environment\n");
 259         }
 260
 261         flags |= H_DEFAULT;
 262         if (himport_r(&env_htab, default_environment,
 263                         sizeof(default_environment), '\0', flags, 0,
 264                         0, NULL) == 0) {
 265                 pr_err("## Error: Environment import failed: errno = %d\n",
 266                        errno);
 267                 return;
 268         }
 269
 270         gd->flags |= GD_FLG_ENV_READY;
 271         gd->flags |= GD_FLG_ENV_DEFAULT;
 272 }
 273
 274
 275 /* [re]set individual variables to their value in the default environment */
 276 int env_set_default_vars(int nvars, char * const vars[], int flags)
 277 {
 278         /*
 279          * Special use-case: import from default environment
 280          * (and use \0 as a separator)
 281          */
 282         flags |= H_NOCLEAR | H_DEFAULT;
 283         return himport_r(&env_htab, default_environment,
 284                                 sizeof(default_environment), '\0',
 285                                 flags, 0, nvars, vars);
 286 }
 287
 288 /*
 289  * Check if CRC is valid and (if yes) import the environment.
 290  * Note that "buf" may or may not be aligned.
 291  */
 292 int env_import(const char *buf, int check, int flags)
 293 {
 294         env_t *ep = (env_t *)buf;
 295
 296         if (check) {
 297                 uint32_t crc;
 298
 299                 memcpy(&crc, &ep->crc, sizeof(crc));
 300
 301                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
 302                         env_set_default("bad CRC", 0);
 303                         return -ENOMSG; /* needed for env_load() */
 304                 }
 305         }
 306
 307         if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', flags, 0,
 308                         0, NULL)) {
 309                 gd->flags |= GD_FLG_ENV_READY;
 310                 return 0;
 311         }
 312
 313         pr_err("Cannot import environment: errno = %d\n", errno);
 314
 315         env_set_default("import failed", 0);
 316
 317         return -EIO;
 318 }
 319
 320 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 321 static unsigned char env_flags;
 322
 323 int env_check_redund(const char *buf1, int buf1_read_fail,
 324                      const char *buf2, int buf2_read_fail)
 325 {
 326         int crc1_ok = 0, crc2_ok = 0;
 327         env_t *tmp_env1, *tmp_env2;
 328
 329         tmp_env1 = (env_t *)buf1;
 330         tmp_env2 = (env_t *)buf2;
 331
 332         if (buf1_read_fail && buf2_read_fail) {
 333                 puts("*** Error - No Valid Environment Area found\n");
 334                 return -EIO;
 335         } else if (buf1_read_fail || buf2_read_fail) {
 336                 puts("*** Warning - some problems detected ");
 337                 puts("reading environment; recovered successfully\n");
 338         }
 339
 340         if (!buf1_read_fail)
 341                 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
 342                                 tmp_env1->crc;
 343         if (!buf2_read_fail)
 344                 crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) ==
 345                                 tmp_env2->crc;
 346
 347         if (!crc1_ok && !crc2_ok) {
 348                 return -ENOMSG; /* needed for env_load() */
 349         } else if (crc1_ok && !crc2_ok) {
 350                 gd->env_valid = ENV_VALID;
 351         } else if (!crc1_ok && crc2_ok) {
 352                 gd->env_valid = ENV_REDUND;
 353         } else {
 354                 /* both ok - check serial */
 355                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
 356                         gd->env_valid = ENV_REDUND;
 357                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
 358                         gd->env_valid = ENV_VALID;
 359                 else if (tmp_env1->flags > tmp_env2->flags)
 360                         gd->env_valid = ENV_VALID;
 361                 else if (tmp_env2->flags > tmp_env1->flags)
 362                         gd->env_valid = ENV_REDUND;
 363                 else /* flags are equal - almost impossible */
 364                         gd->env_valid = ENV_VALID;
 365         }
 366
 367         return 0;
 368 }
 369
 370 int env_import_redund(const char *buf1, int buf1_read_fail,
 371                       const char *buf2, int buf2_read_fail,
 372                       int flags)
 373 {
 374         env_t *ep;
 375         int ret;
 376
 377         ret = env_check_redund(buf1, buf1_read_fail, buf2, buf2_read_fail);
 378
 379         if (ret == -EIO) {
 380                 env_set_default("bad env area", 0);
 381                 return -EIO;
 382         } else if (ret == -ENOMSG) {
 383                 env_set_default("bad CRC", 0);
 384                 return -ENOMSG;
 385         }
 386
 387         if (gd->env_valid == ENV_VALID)
 388                 ep = (env_t *)buf1;
 389         else
 390                 ep = (env_t *)buf2;
 391
 392         env_flags = ep->flags;
 393
 394         return env_import((char *)ep, 0, flags);
 395 }
 396 #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
 397
 398 /* Export the environment and generate CRC for it. */
 399 int env_export(env_t *env_out)
 400 {
 401         char *res;
 402         ssize_t len;
 403
 404         res = (char *)env_out->data;
 405         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
 406         if (len < 0) {
 407                 pr_err("Cannot export environment: errno = %d\n", errno);
 408                 return 1;
 409         }
 410
 411         env_out->crc = crc32(0, env_out->data, ENV_SIZE);
 412
 413 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 414         env_out->flags = ++env_flags; /* increase the serial */
 415 #endif
 416
 417         return 0;
 418 }
 419
 420 void env_relocate(void)
 421 {
 422 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 423         env_reloc();
 424         env_fix_drivers();
 425         env_htab.change_ok += gd->reloc_off;
 426 #endif
 427         if (gd->env_valid == ENV_INVALID) {
 428 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
 429                 /* Environment not changable */
 430                 env_set_default(NULL, 0);
 431 #else
 432                 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
 433                 env_set_default("bad CRC", 0);
 434 #endif
 435         } else {
 436                 env_load();
 437         }
 438 }
 439
 440 #ifdef CONFIG_AUTO_COMPLETE
 441 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf,
 442                  bool dollar_comp)
 443 {
 444         struct env_entry *match;
 445         int found, idx;
 446
 447         if (dollar_comp) {
 448                 /*
 449                  * When doing $ completion, the first character should
 450                  * obviously be a '$'.
 451                  */
 452                 if (var[0] != '$')
 453                         return 0;
 454
 455                 var++;
 456
 457                 /*
 458                  * The second one, if present, should be a '{', as some
 459                  * configuration of the u-boot shell expand ${var} but not
 460                  * $var.
 461                  */
 462                 if (var[0] == '{')
 463                         var++;
 464                 else if (var[0] != '\0')
 465                         return 0;
 466         }
 467
 468         idx = 0;
 469         found = 0;
 470         cmdv[0] = NULL;
 471
 472
 473         while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
 474                 int vallen = strlen(match->key) + 1;
 475
 476                 if (found >= maxv - 2 ||
 477                     bufsz < vallen + (dollar_comp ? 3 : 0))
 478                         break;
 479
 480                 cmdv[found++] = buf;
 481
 482                 /* Add the '${' prefix to each var when doing $ completion. */
 483                 if (dollar_comp) {
 484                         strcpy(buf, "${");
 485                         buf += 2;
 486                         bufsz -= 3;
 487                 }
 488
 489                 memcpy(buf, match->key, vallen);
 490                 buf += vallen;
 491                 bufsz -= vallen;
 492
 493                 if (dollar_comp) {
 494                         /*
 495                          * This one is a bit odd: vallen already contains the
 496                          * '\0' character but we need to add the '}' suffix,
 497                          * hence the buf - 1 here. strcpy() will add the '\0'
 498                          * character just after '}'. buf is then incremented
 499                          * to account for the extra '}' we just added.
 500                          */
 501                         strcpy(buf - 1, "}");
 502                         buf++;
 503                 }
 504         }
 505
 506         qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
 507
 508         if (idx)
 509                 cmdv[found++] = dollar_comp ? "${...}" : "...";
 510
 511         cmdv[found] = NULL;
 512         return found;
 513 }
 514 #endif
 515
 516 #ifdef CONFIG_ENV_IMPORT_FDT
 517 void env_import_fdt(void)
 518 {
 519         const char *path;
 520         struct ofprop prop;
 521         ofnode node;
 522         int res;
 523
 524         path = env_get("env_fdt_path");
 525         if (!path || !path[0])
 526                 return;
 527
 528         node = ofnode_path(path);
 529         if (!ofnode_valid(node)) {
 530                 printf("Warning: device tree node '%s' not found\n", path);
 531                 return;
 532         }
 533
 534         for (res = ofnode_get_first_property(node, &prop);
 535              !res;
 536              res = ofnode_get_next_property(&prop)) {
 537                 const char *name, *val;
 538
 539                 val = ofnode_get_property_by_prop(&prop, &name, NULL);
 540                 env_set(name, val);
 541         }
 542 }
 543 #endif