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 extern env_t *env_ptr;
  38
  39 extern void env_relocate_spec (void);
  40 extern uchar env_get_char_spec(int);
  41
  42 static uchar env_get_char_init (int index);
  43
  44 /************************************************************************
  45  * Default settings to be used when no valid environment is found
  46  */
  47 #define XMK_STR(x)      #x
  48 #define MK_STR(x)       XMK_STR(x)
  49
  50 const uchar default_environment[] = {
  51 #ifdef  CONFIG_BOOTARGS
  52         "bootargs="     CONFIG_BOOTARGS                 "\0"
  53 #endif
  54 #ifdef  CONFIG_BOOTCOMMAND
  55         "bootcmd="      CONFIG_BOOTCOMMAND              "\0"
  56 #endif
  57 #ifdef  CONFIG_RAMBOOTCOMMAND
  58         "ramboot="      CONFIG_RAMBOOTCOMMAND           "\0"
  59 #endif
  60 #ifdef  CONFIG_NFSBOOTCOMMAND
  61         "nfsboot="      CONFIG_NFSBOOTCOMMAND           "\0"
  62 #endif
  63 #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
  64         "bootdelay="    MK_STR(CONFIG_BOOTDELAY)        "\0"
  65 #endif
  66 #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
  67         "baudrate="     MK_STR(CONFIG_BAUDRATE)         "\0"
  68 #endif
  69 #ifdef  CONFIG_LOADS_ECHO
  70         "loads_echo="   MK_STR(CONFIG_LOADS_ECHO)       "\0"
  71 #endif
  72 #ifdef  CONFIG_ETHADDR
  73         "ethaddr="      MK_STR(CONFIG_ETHADDR)          "\0"
  74 #endif
  75 #ifdef  CONFIG_ETH1ADDR
  76         "eth1addr="     MK_STR(CONFIG_ETH1ADDR)         "\0"
  77 #endif
  78 #ifdef  CONFIG_ETH2ADDR
  79         "eth2addr="     MK_STR(CONFIG_ETH2ADDR)         "\0"
  80 #endif
  81 #ifdef  CONFIG_ETH3ADDR
  82         "eth3addr="     MK_STR(CONFIG_ETH3ADDR)         "\0"
  83 #endif
  84 #ifdef  CONFIG_ETH4ADDR
  85         "eth4addr="     MK_STR(CONFIG_ETH4ADDR)         "\0"
  86 #endif
  87 #ifdef  CONFIG_ETH5ADDR
  88         "eth5addr="     MK_STR(CONFIG_ETH5ADDR)         "\0"
  89 #endif
  90 #ifdef  CONFIG_IPADDR
  91         "ipaddr="       MK_STR(CONFIG_IPADDR)           "\0"
  92 #endif
  93 #ifdef  CONFIG_SERVERIP
  94         "serverip="     MK_STR(CONFIG_SERVERIP)         "\0"
  95 #endif
  96 #ifdef  CONFIG_SYS_AUTOLOAD
  97         "autoload="     CONFIG_SYS_AUTOLOAD                     "\0"
  98 #endif
  99 #ifdef  CONFIG_PREBOOT
 100         "preboot="      CONFIG_PREBOOT                  "\0"
 101 #endif
 102 #ifdef  CONFIG_ROOTPATH
 103         "rootpath="     MK_STR(CONFIG_ROOTPATH)         "\0"
 104 #endif
 105 #ifdef  CONFIG_GATEWAYIP
 106         "gatewayip="    MK_STR(CONFIG_GATEWAYIP)        "\0"
 107 #endif
 108 #ifdef  CONFIG_NETMASK
 109         "netmask="      MK_STR(CONFIG_NETMASK)          "\0"
 110 #endif
 111 #ifdef  CONFIG_HOSTNAME
 112         "hostname="     MK_STR(CONFIG_HOSTNAME)         "\0"
 113 #endif
 114 #ifdef  CONFIG_BOOTFILE
 115         "bootfile="     MK_STR(CONFIG_BOOTFILE)         "\0"
 116 #endif
 117 #ifdef  CONFIG_LOADADDR
 118         "loadaddr="     MK_STR(CONFIG_LOADADDR)         "\0"
 119 #endif
 120 #ifdef  CONFIG_CLOCKS_IN_MHZ
 121         "clocks_in_mhz=1\0"
 122 #endif
 123 #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
 124         "pcidelay="     MK_STR(CONFIG_PCI_BOOTDELAY)    "\0"
 125 #endif
 126 #ifdef  CONFIG_EXTRA_ENV_SETTINGS
 127         CONFIG_EXTRA_ENV_SETTINGS
 128 #endif
 129         "\0"
 130 };
 131
 132 struct hsearch_data env_htab;
 133
 134 static uchar env_get_char_init (int index)
 135 {
 136         uchar c;
 137
 138         /* if crc was bad, use the default environment */
 139         if (gd->env_valid)
 140                 c = env_get_char_spec(index);
 141         else
 142                 c = default_environment[index];
 143
 144         return (c);
 145 }
 146
 147 uchar env_get_char_memory (int index)
 148 {
 149         return *env_get_addr(index);
 150 }
 151
 152 uchar env_get_char (int index)
 153 {
 154         uchar c;
 155
 156         /* if relocated to RAM */
 157         if (gd->flags & GD_FLG_RELOC)
 158                 c = env_get_char_memory(index);
 159         else
 160                 c = env_get_char_init(index);
 161
 162         return (c);
 163 }
 164
 165 const uchar *env_get_addr (int index)
 166 {
 167         if (gd->env_valid)
 168                 return (uchar *)(gd->env_addr + index);
 169         else
 170                 return &default_environment[index];
 171 }
 172
 173 void set_default_env(const char *s)
 174 {
 175         if (sizeof(default_environment) > ENV_SIZE) {
 176                 puts("*** Error - default environment is too large\n\n");
 177                 return;
 178         }
 179
 180         if (s) {
 181                 if (*s == '!') {
 182                         printf("*** Warning - %s, "
 183                                 "using default environment\n\n",
 184                                 s+1);
 185                 } else {
 186                         puts(s);
 187                 }
 188         } else {
 189                 puts("Using default environment\n\n");
 190         }
 191
 192         if (himport_r(&env_htab, (char *)default_environment,
 193                     sizeof(default_environment), '\0', 0) == 0) {
 194                 error("Environment import failed: errno = %d\n", errno);
 195         }
 196         gd->flags |= GD_FLG_ENV_READY;
 197 }
 198
 199 /*
 200  * Check if CRC is valid and (if yes) import the environment.
 201  * Note that "buf" may or may not be aligned.
 202  */
 203 int env_import(const char *buf, int check)
 204 {
 205         env_t *ep = (env_t *)buf;
 206
 207         if (check) {
 208                 uint32_t crc;
 209
 210                 memcpy(&crc, &ep->crc, sizeof(crc));
 211
 212                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
 213                         set_default_env("!bad CRC");
 214                         return 0;
 215                 }
 216         }
 217
 218         if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0)) {
 219                 gd->flags |= GD_FLG_ENV_READY;
 220                 return 1;
 221         }
 222
 223         error("Cannot import environment: errno = %d\n", errno);
 224
 225         set_default_env("!import failed");
 226
 227         return 0;
 228 }
 229
 230 void env_relocate (void)
 231 {
 232 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 233         extern void env_reloc(void);
 234
 235         env_reloc();
 236 #endif
 237         if (gd->env_valid == 0) {
 238 #if defined(CONFIG_ENV_IS_NOWHERE)      /* Environment not changable */
 239                 set_default_env(NULL);
 240 #else
 241                 show_boot_progress (-60);
 242                 set_default_env("!bad CRC");
 243 #endif
 244         } else {
 245                 env_relocate_spec ();
 246         }
 247 }
 248
 249 #ifdef CONFIG_AUTO_COMPLETE
 250 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
 251 {
 252         ENTRY *match;
 253         int found, idx;
 254
 255         idx = 0;
 256         found = 0;
 257         cmdv[0] = NULL;
 258
 259         while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
 260                 int vallen = strlen(match->key) + 1;
 261
 262                 if (found >= maxv - 2 || bufsz < vallen)
 263                         break;
 264
 265                 cmdv[found++] = buf;
 266                 memcpy(buf, match->key, vallen);
 267                 buf += vallen;
 268                 bufsz -= vallen;
 269         }
 270
 271         qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
 272
 273         if (idx)
 274                 cmdv[found++] = "...";
 275         cmdv[found] = NULL;
 276         return found;
 277 }
 278 #endif