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 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_USBNET_DEVADDR
 127         "usbnet_devaddr="       MK_STR(CONFIG_USBNET_DEVADDR)   "\0"
 128 #endif
 129 #ifdef CONFIG_USBNET_HOSTADDR
 130         "usbnet_hostaddr="MK_STR(CONFIG_USBNET_HOSTADDR)        "\0"
 131 #endif
 132 #ifdef MTDPARTS_DEFAULT
 133         "mtdparts=" MTDPARTS_DEFAULT    "\0"
 134 #endif
 135 #ifdef MTDIDS_DEFAULT
 136         "mtdids=" MTDIDS_DEFAULT        "\0"
 137 #endif
 138 #ifdef  CONFIG_EXTRA_ENV_SETTINGS
 139         CONFIG_EXTRA_ENV_SETTINGS
 140 #endif
 141         "\0"
 142 };
 143
 144 static uchar env_get_char_init (int index)
 145 {
 146         uchar c;
 147
 148         /* if crc was bad, use the default environment */
 149         if (gd->env_valid)
 150                 c = env_get_char_spec(index);
 151         else
 152                 c = default_environment[index];
 153
 154         return (c);
 155 }
 156
 157 uchar env_get_char_memory (int index)
 158 {
 159         return *env_get_addr(index);
 160 }
 161
 162 uchar env_get_char (int index)
 163 {
 164         uchar c;
 165
 166         /* if relocated to RAM */
 167         if (gd->flags & GD_FLG_RELOC)
 168                 c = env_get_char_memory(index);
 169         else
 170                 c = env_get_char_init(index);
 171
 172         return (c);
 173 }
 174
 175 uchar *env_get_addr (int index)
 176 {
 177         if (gd->env_valid)
 178                 return (uchar *)(gd->env_addr + index);
 179         else
 180                 return &default_environment[index];
 181 }
 182
 183 void set_default_env(const char *s)
 184 {
 185         if (sizeof(default_environment) > ENV_SIZE) {
 186                 puts("*** Error - default environment is too large\n\n");
 187                 return;
 188         }
 189
 190         if (s) {
 191                 if (*s == '!') {
 192                         printf("*** Warning - %s, "
 193                                 "using default environment\n\n",
 194                                 s+1);
 195                 } else {
 196                         puts(s);
 197                 }
 198         } else {
 199                 puts("Using default environment\n\n");
 200         }
 201
 202         if (himport((char *)default_environment,
 203                     sizeof(default_environment), '\0', 0) == 0) {
 204                 error("Environment import failed: errno = %d\n", errno);
 205         }
 206         gd->flags |= GD_FLG_ENV_READY;
 207 }
 208
 209 /*
 210  * Check if CRC is valid and (if yes) import the environment.
 211  * Note that "buf" may or may not be aligned.
 212  */
 213 int env_import(const char *buf, int check)
 214 {
 215         env_t *ep = (env_t *)buf;
 216
 217         if (check) {
 218                 uint32_t crc;
 219
 220                 memcpy(&crc, &ep->crc, sizeof(crc));
 221
 222                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
 223                         set_default_env("!bad CRC");
 224                         return 0;
 225                 }
 226         }
 227
 228         if (himport((char *)ep->data, ENV_SIZE, '\0', 0)) {
 229                 gd->flags |= GD_FLG_ENV_READY;
 230                 return 1;
 231         }
 232
 233         error("Cannot import environment: errno = %d\n", errno);
 234
 235         set_default_env("!import failed");
 236
 237         return 0;
 238 }
 239
 240 void env_relocate (void)
 241 {
 242 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
 243         extern void env_reloc(void);
 244
 245         env_reloc();
 246 #endif
 247         if (gd->env_valid == 0) {
 248 #if defined(CONFIG_ENV_IS_NOWHERE)      /* Environment not changable */
 249                 set_default_env(NULL);
 250 #else
 251                 show_boot_progress (-60);
 252                 set_default_env("!bad CRC");
 253 #endif
 254         } else {
 255                 env_relocate_spec ();
 256         }
 257 }
 258
 259 #if 0 /* need to reimplement - def CONFIG_AUTO_COMPLETE */
 260 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
 261 {
 262         int i, nxt, len, vallen, found;
 263         const char *lval, *rval;
 264
 265         found = 0;
 266         cmdv[0] = NULL;
 267
 268         len = strlen(var);
 269         /* now iterate over the variables and select those that match */
 270         for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
 271
 272                 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt)
 273                         ;
 274
 275                 lval = (char *)env_get_addr(i);
 276                 rval = strchr(lval, '=');
 277                 if (rval != NULL) {
 278                         vallen = rval - lval;
 279                         rval++;
 280                 } else
 281                         vallen = strlen(lval);
 282
 283                 if (len > 0 && (vallen < len || memcmp(lval, var, len) != 0))
 284                         continue;
 285
 286                 if (found >= maxv - 2 || bufsz < vallen + 1) {
 287                         cmdv[found++] = "...";
 288                         break;
 289                 }
 290                 cmdv[found++] = buf;
 291                 memcpy(buf, lval, vallen); buf += vallen; bufsz -= vallen;
 292                 *buf++ = '\0'; bufsz--;
 293         }
 294
 295         cmdv[found] = NULL;
 296         return found;
 297 }
 298 #endif