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 <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         if (himport_r(&env_htab, (char *)default_environment,
  85                         sizeof(default_environment), '\0', flags, 0,
  86                         0, NULL) == 0)
  87                 pr_err("## Error: Environment import failed: errno = %d\n",
  88                        errno);
  89
  90         gd->flags |= GD_FLG_ENV_READY;
  91         gd->flags |= GD_FLG_ENV_DEFAULT;
  92 }
  93
  94
  95 /* [re]set individual variables to their value in the default environment */
  96 int env_set_default_vars(int nvars, char * const vars[], int flags)
  97 {
  98         /*
  99          * Special use-case: import from default environment
 100          * (and use \0 as a separator)
 101          */
 102         flags |= H_NOCLEAR;
 103         return himport_r(&env_htab, (const char *)default_environment,
 104                                 sizeof(default_environment), '\0',
 105                                 flags, 0, nvars, vars);
 106 }
 107
 108 /*
 109  * Check if CRC is valid and (if yes) import the environment.
 110  * Note that "buf" may or may not be aligned.
 111  */
 112 int env_import(const char *buf, int check)
 113 {
 114         env_t *ep = (env_t *)buf;
 115
 116         if (check) {
 117                 uint32_t crc;
 118
 119                 memcpy(&crc, &ep->crc, sizeof(crc));
 120
 121                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
 122                         env_set_default("bad CRC", 0);
 123                         return -ENOMSG; /* needed for env_load() */
 124                 }
 125         }
 126
 127         if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0, 0,
 128                         0, NULL)) {
 129                 gd->flags |= GD_FLG_ENV_READY;
 130                 return 0;
 131         }
 132
 133         pr_err("Cannot import environment: errno = %d\n", errno);
 134
 135         env_set_default("import failed", 0);
 136
 137         return -EIO;
 138 }
 139
 140 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 141 static unsigned char env_flags;
 142
 143 int env_import_redund(const char *buf1, int buf1_read_fail,
 144                       const char *buf2, int buf2_read_fail)
 145 {
 146         int crc1_ok, crc2_ok;
 147         env_t *ep, *tmp_env1, *tmp_env2;
 148
 149         tmp_env1 = (env_t *)buf1;
 150         tmp_env2 = (env_t *)buf2;
 151
 152         if (buf1_read_fail && buf2_read_fail) {
 153                 puts("*** Error - No Valid Environment Area found\n");
 154         } else if (buf1_read_fail || buf2_read_fail) {
 155                 puts("*** Warning - some problems detected ");
 156                 puts("reading environment; recovered successfully\n");
 157         }
 158
 159         if (buf1_read_fail && buf2_read_fail) {
 160                 env_set_default("bad env area", 0);
 161                 return -EIO;
 162         } else if (!buf1_read_fail && buf2_read_fail) {
 163                 gd->env_valid = ENV_VALID;
 164                 return env_import((char *)tmp_env1, 1);
 165         } else if (buf1_read_fail && !buf2_read_fail) {
 166                 gd->env_valid = ENV_REDUND;
 167                 return env_import((char *)tmp_env2, 1);
 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                 env_set_default("bad CRC", 0);
 177                 return -ENOMSG; /* needed for env_load() */
 178         } else if (crc1_ok && !crc2_ok) {
 179                 gd->env_valid = ENV_VALID;
 180         } else if (!crc1_ok && crc2_ok) {
 181                 gd->env_valid = ENV_REDUND;
 182         } else {
 183                 /* both ok - check serial */
 184                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
 185                         gd->env_valid = ENV_REDUND;
 186                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
 187                         gd->env_valid = ENV_VALID;
 188                 else if (tmp_env1->flags > tmp_env2->flags)
 189                         gd->env_valid = ENV_VALID;
 190                 else if (tmp_env2->flags > tmp_env1->flags)
 191                         gd->env_valid = ENV_REDUND;
 192                 else /* flags are equal - almost impossible */
 193                         gd->env_valid = ENV_VALID;
 194         }
 195
 196         if (gd->env_valid == ENV_VALID)
 197                 ep = tmp_env1;
 198         else
 199                 ep = tmp_env2;
 200
 201         env_flags = ep->flags;
 202         return env_import((char *)ep, 0);
 203 }
 204 #endif /* CONFIG_SYS_REDUNDAND_ENVIRONMENT */
 205
 206 /* Export the environment and generate CRC for it. */
 207 int env_export(env_t *env_out)
 208 {
 209         char *res;
 210         ssize_t len;
 211
 212         res = (char *)env_out->data;
 213         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
 214         if (len < 0) {
 215                 pr_err("Cannot export environment: errno = %d\n", errno);
 216                 return 1;
 217         }
 218
 219         env_out->crc = crc32(0, env_out->data, ENV_SIZE);
 220
 221 #ifdef CONFIG_SYS_REDUNDAND_ENVIRONMENT
 222         env_out->flags = ++env_flags; /* increase the serial */
 223 #endif
 224
 225         return 0;
 226 }
 227
 228 void env_relocate(void)
 229 {
 230 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 231         env_reloc();
 232         env_fix_drivers();
 233         env_htab.change_ok += gd->reloc_off;
 234 #endif
 235         if (gd->env_valid == ENV_INVALID) {
 236 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
 237                 /* Environment not changable */
 238                 env_set_default(NULL, 0);
 239 #else
 240                 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
 241                 env_set_default("bad CRC", 0);
 242 #endif
 243         } else {
 244                 env_load();
 245         }
 246 }
 247
 248 #ifdef CONFIG_AUTO_COMPLETE
 249 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf,
 250                  bool dollar_comp)
 251 {
 252         struct env_entry *match;
 253         int found, idx;
 254
 255         if (dollar_comp) {
 256                 /*
 257                  * When doing $ completion, the first character should
 258                  * obviously be a '$'.
 259                  */
 260                 if (var[0] != '$')
 261                         return 0;
 262
 263                 var++;
 264
 265                 /*
 266                  * The second one, if present, should be a '{', as some
 267                  * configuration of the u-boot shell expand ${var} but not
 268                  * $var.
 269                  */
 270                 if (var[0] == '{')
 271                         var++;
 272                 else if (var[0] != '\0')
 273                         return 0;
 274         }
 275
 276         idx = 0;
 277         found = 0;
 278         cmdv[0] = NULL;
 279
 280
 281         while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
 282                 int vallen = strlen(match->key) + 1;
 283
 284                 if (found >= maxv - 2 ||
 285                     bufsz < vallen + (dollar_comp ? 3 : 0))
 286                         break;
 287
 288                 cmdv[found++] = buf;
 289
 290                 /* Add the '${' prefix to each var when doing $ completion. */
 291                 if (dollar_comp) {
 292                         strcpy(buf, "${");
 293                         buf += 2;
 294                         bufsz -= 3;
 295                 }
 296
 297                 memcpy(buf, match->key, vallen);
 298                 buf += vallen;
 299                 bufsz -= vallen;
 300
 301                 if (dollar_comp) {
 302                         /*
 303                          * This one is a bit odd: vallen already contains the
 304                          * '\0' character but we need to add the '}' suffix,
 305                          * hence the buf - 1 here. strcpy() will add the '\0'
 306                          * character just after '}'. buf is then incremented
 307                          * to account for the extra '}' we just added.
 308                          */
 309                         strcpy(buf - 1, "}");
 310                         buf++;
 311                 }
 312         }
 313
 314         qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
 315
 316         if (idx)
 317                 cmdv[found++] = dollar_comp ? "${...}" : "...";
 318
 319         cmdv[found] = NULL;
 320         return found;
 321 }
 322 #endif