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