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