common/env_common.c

   1 /*
   2  * (C) Copyright 2000-2010
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   6  * Andreas Heppel <aheppel@sysgo.de>
   7  *
   8  * See file CREDITS for list of people who contributed to this
   9  * project.
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License as
  13  * published by the Free Software Foundation; either version 2 of
  14  * the License, or (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program; if not, write to the Free Software
  23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  24  * MA 02111-1307 USA
  25  */
  26
  27 #include <common.h>
  28 #include <command.h>
  29 #include <environment.h>
  30 #include <linux/stddef.h>
  31 #include <search.h>
  32 #include <errno.h>
  33 #include <malloc.h>
  34
  35 DECLARE_GLOBAL_DATA_PTR;
  36
  37 /************************************************************************
  38  * Default settings to be used when no valid environment is found
  39  */
  40 #include <env_default.h>
  41
  42 struct hsearch_data env_htab = {
  43         .apply = env_check_apply,
  44 };
  45
  46 static uchar __env_get_char_spec(int index)
  47 {
  48         return *((uchar *)(gd->env_addr + index));
  49 }
  50 uchar env_get_char_spec(int)
  51         __attribute__((weak, alias("__env_get_char_spec")));
  52
  53 static uchar env_get_char_init(int index)
  54 {
  55         /* if crc was bad, use the default environment */
  56         if (gd->env_valid)
  57                 return env_get_char_spec(index);
  58         else
  59                 return default_environment[index];
  60 }
  61
  62 uchar env_get_char_memory(int index)
  63 {
  64         return *env_get_addr(index);
  65 }
  66
  67 uchar env_get_char(int index)
  68 {
  69         /* if relocated to RAM */
  70         if (gd->flags & GD_FLG_RELOC)
  71                 return env_get_char_memory(index);
  72         else
  73                 return env_get_char_init(index);
  74 }
  75
  76 const uchar *env_get_addr(int index)
  77 {
  78         if (gd->env_valid)
  79                 return (uchar *)(gd->env_addr + index);
  80         else
  81                 return &default_environment[index];
  82 }
  83
  84 void set_default_env(const char *s)
  85 {
  86         /*
  87          * By default, do not apply changes as they will eventually
  88          * be applied by someone else
  89          */
  90         int do_apply = 0;
  91         if (sizeof(default_environment) > ENV_SIZE) {
  92                 puts("*** Error - default environment is too large\n\n");
  93                 return;
  94         }
  95
  96         if (s) {
  97                 if (*s == '!') {
  98                         printf("*** Warning - %s, "
  99                                 "using default environment\n\n",
 100                                 s + 1);
 101                 } else {
 102                         /*
 103                          * This set_to_default was explicitly asked for
 104                          * by the user, as opposed to being a recovery
 105                          * mechanism.  Therefore we check every single
 106                          * variable and apply changes to the system
 107                          * right away (e.g. baudrate, console).
 108                          */
 109                         do_apply = 1;
 110                         puts(s);
 111                 }
 112         } else {
 113                 puts("Using default environment\n\n");
 114         }
 115
 116         if (himport_r(&env_htab, (char *)default_environment,
 117                         sizeof(default_environment), '\0', 0,
 118                         0, NULL, do_apply) == 0)
 119                 error("Environment import failed: errno = %d\n", errno);
 120
 121         gd->flags |= GD_FLG_ENV_READY;
 122 }
 123
 124
 125 /* [re]set individual variables to their value in the default environment */
 126 int set_default_vars(int nvars, char * const vars[])
 127 {
 128         /*
 129          * Special use-case: import from default environment
 130          * (and use \0 as a separator)
 131          */
 132         return himport_r(&env_htab, (const char *)default_environment,
 133                                 sizeof(default_environment), '\0', H_NOCLEAR,
 134                                 nvars, vars, 1 /* do_apply */);
 135 }
 136
 137 #ifndef CONFIG_SPL_BUILD
 138 /*
 139  * Check if CRC is valid and (if yes) import the environment.
 140  * Note that "buf" may or may not be aligned.
 141  */
 142 int env_import(const char *buf, int check)
 143 {
 144         env_t *ep = (env_t *)buf;
 145
 146         if (check) {
 147                 uint32_t crc;
 148
 149                 memcpy(&crc, &ep->crc, sizeof(crc));
 150
 151                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
 152                         set_default_env("!bad CRC");
 153                         return 0;
 154                 }
 155         }
 156
 157         if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0,
 158                         0, NULL, 0 /* do_apply */)) {
 159                 gd->flags |= GD_FLG_ENV_READY;
 160                 return 1;
 161         }
 162
 163         error("Cannot import environment: errno = %d\n", errno);
 164
 165         set_default_env("!import failed");
 166
 167         return 0;
 168 }
 169 #endif
 170
 171 void env_relocate(void)
 172 {
 173 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 174         env_reloc();
 175 #endif
 176         if (gd->env_valid == 0) {
 177 #if defined(CONFIG_ENV_IS_NOWHERE) || defined(CONFIG_SPL_BUILD)
 178                 /* Environment not changable */
 179                 set_default_env(NULL);
 180 #else
 181                 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
 182                 set_default_env("!bad CRC");
 183 #endif
 184         } else {
 185                 env_relocate_spec();
 186         }
 187 }
 188
 189 #if defined(CONFIG_AUTO_COMPLETE) && !defined(CONFIG_SPL_BUILD)
 190 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
 191 {
 192         ENTRY *match;
 193         int found, idx;
 194
 195         idx = 0;
 196         found = 0;
 197         cmdv[0] = NULL;
 198
 199         while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
 200                 int vallen = strlen(match->key) + 1;
 201
 202                 if (found >= maxv - 2 || bufsz < vallen)
 203                         break;
 204
 205                 cmdv[found++] = buf;
 206                 memcpy(buf, match->key, vallen);
 207                 buf += vallen;
 208                 bufsz -= vallen;
 209         }
 210
 211         qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
 212
 213         if (idx)
 214                 cmdv[found++] = "...";
 215
 216         cmdv[found] = NULL;
 217         return found;
 218 }
 219 #endif