common/env_common.c

   1 /*
   2  * (C) Copyright 2000-2002
   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 <malloc.h>
  32
  33 #ifdef CFG_PREBOOT_OVERRIDE
  34 extern char *preboot_override;
  35 #endif
  36
  37 #ifdef CFG_ENV_OVERRIDE
  38 extern void *env_override;
  39 #endif
  40
  41 DECLARE_GLOBAL_DATA_PTR;
  42
  43 #ifdef CONFIG_AMIGAONEG3SE
  44         extern void enable_nvram(void);
  45         extern void disable_nvram(void);
  46 #endif
  47
  48 #undef DEBUG_ENV
  49 #ifdef DEBUG_ENV
  50 #define DEBUGF(fmt,args...) printf(fmt ,##args)
  51 #else
  52 #define DEBUGF(fmt,args...)
  53 #endif
  54
  55 extern env_t *env_ptr;
  56
  57 extern void env_relocate_spec (void);
  58 extern uchar env_get_char_spec(int);
  59
  60 static uchar env_get_char_init (int index);
  61 uchar (*env_get_char)(int) = env_get_char_init;
  62
  63 /************************************************************************
  64  * Default settings to be used when no valid environment is found
  65  */
  66 #define XMK_STR(x)      #x
  67 #define MK_STR(x)       XMK_STR(x)
  68
  69 uchar default_environment[] = {
  70 #ifdef  CONFIG_BOOTARGS
  71         "bootargs="     CONFIG_BOOTARGS                 "\0"
  72 #endif
  73 #ifdef  CONFIG_BOOTCOMMAND
  74         "bootcmd="      CONFIG_BOOTCOMMAND              "\0"
  75 #endif
  76 #ifdef  CONFIG_RAMBOOTCOMMAND
  77         "ramboot="      CONFIG_RAMBOOTCOMMAND           "\0"
  78 #endif
  79 #ifdef  CONFIG_NFSBOOTCOMMAND
  80         "nfsboot="      CONFIG_NFSBOOTCOMMAND           "\0"
  81 #endif
  82 #if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
  83         "bootdelay="    MK_STR(CONFIG_BOOTDELAY)        "\0"
  84 #endif
  85 #if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
  86         "baudrate="     MK_STR(CONFIG_BAUDRATE)         "\0"
  87 #endif
  88 #ifdef  CONFIG_LOADS_ECHO
  89         "loads_echo="   MK_STR(CONFIG_LOADS_ECHO)       "\0"
  90 #endif
  91 #ifdef  CONFIG_ETHADDR
  92         "ethaddr="      MK_STR(CONFIG_ETHADDR)          "\0"
  93 #endif
  94 #ifdef  CONFIG_ETH1ADDR
  95         "eth1addr="     MK_STR(CONFIG_ETH1ADDR)         "\0"
  96 #endif
  97 #ifdef  CONFIG_ETH2ADDR
  98         "eth2addr="     MK_STR(CONFIG_ETH2ADDR)         "\0"
  99 #endif
 100 #ifdef  CONFIG_ETH3ADDR
 101         "eth3addr="     MK_STR(CONFIG_ETH3ADDR)         "\0"
 102 #endif
 103 #ifdef  CONFIG_IPADDR
 104         "ipaddr="       MK_STR(CONFIG_IPADDR)           "\0"
 105 #endif
 106 #ifdef  CONFIG_SERVERIP
 107         "serverip="     MK_STR(CONFIG_SERVERIP)         "\0"
 108 #endif
 109 #ifdef  CFG_AUTOLOAD
 110         "autoload="     CFG_AUTOLOAD                    "\0"
 111 #endif
 112 #ifdef  CONFIG_PREBOOT
 113         "preboot="      CONFIG_PREBOOT                  "\0"
 114 #endif
 115 #ifdef  CONFIG_ROOTPATH
 116         "rootpath="     MK_STR(CONFIG_ROOTPATH)         "\0"
 117 #endif
 118 #ifdef  CONFIG_GATEWAYIP
 119         "gatewayip="    MK_STR(CONFIG_GATEWAYIP)        "\0"
 120 #endif
 121 #ifdef  CONFIG_NETMASK
 122         "netmask="      MK_STR(CONFIG_NETMASK)          "\0"
 123 #endif
 124 #ifdef  CONFIG_HOSTNAME
 125         "hostname="     MK_STR(CONFIG_HOSTNAME)         "\0"
 126 #endif
 127 #ifdef  CONFIG_BOOTFILE
 128         "bootfile="     MK_STR(CONFIG_BOOTFILE)         "\0"
 129 #endif
 130 #ifdef  CONFIG_LOADADDR
 131         "loadaddr="     MK_STR(CONFIG_LOADADDR)         "\0"
 132 #endif
 133 #ifdef  CONFIG_CLOCKS_IN_MHZ
 134         "clocks_in_mhz=1\0"
 135 #endif
 136 #if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
 137         "pcidelay="     MK_STR(CONFIG_PCI_BOOTDELAY)    "\0"
 138 #endif
 139 #ifdef  CONFIG_EXTRA_ENV_SETTINGS
 140         CONFIG_EXTRA_ENV_SETTINGS
 141 #endif
 142         "\0"
 143 };
 144
 145 #if defined(CFG_ENV_IS_IN_NAND)         /* Environment is in Nand Flash */
 146 int default_environment_size = sizeof(default_environment);
 147 #endif
 148
 149 void env_crc_update (void)
 150 {
 151         env_ptr->crc = crc32(0, env_ptr->data, ENV_SIZE);
 152 }
 153
 154 static uchar env_get_char_init (int index)
 155 {
 156         uchar c;
 157
 158         /* if crc was bad, use the default environment */
 159         if (gd->env_valid)
 160         {
 161                 c = env_get_char_spec(index);
 162         } else {
 163                 c = default_environment[index];
 164         }
 165
 166         return (c);
 167 }
 168
 169 #ifdef CONFIG_AMIGAONEG3SE
 170 uchar env_get_char_memory (int index)
 171 {
 172         uchar retval;
 173         enable_nvram();
 174         if (gd->env_valid) {
 175                 retval = ( *((uchar *)(gd->env_addr + index)) );
 176         } else {
 177                 retval = ( default_environment[index] );
 178         }
 179         disable_nvram();
 180         return retval;
 181 }
 182 #else
 183 uchar env_get_char_memory (int index)
 184 {
 185         if (gd->env_valid) {
 186                 return ( *((uchar *)(gd->env_addr + index)) );
 187         } else {
 188                 return ( default_environment[index] );
 189         }
 190 }
 191 #endif
 192
 193 uchar *env_get_addr (int index)
 194 {
 195         if (gd->env_valid) {
 196                 return ( ((uchar *)(gd->env_addr + index)) );
 197         } else {
 198                 return (&default_environment[index]);
 199         }
 200 }
 201
 202 void default_env(void)
 203 {
 204         if (sizeof(default_environment) > ENV_SIZE)
 205         {
 206                 puts ("*** Error - default environment is too large\n\n");
 207                 return;
 208         }
 209
 210         memset (env_ptr, 0, sizeof(env_t));
 211         memcpy (env_ptr->data,
 212                 default_environment,
 213                 sizeof(default_environment));
 214
 215 #ifdef CFG_ENV_OVERRIDE
 216         if (env_override)
 217                 memcpy(env_ptr->data, env_override, ENV_SIZE);
 218 #endif
 219
 220 #ifdef CFG_REDUNDAND_ENVIRONMENT
 221         env_ptr->flags = 0xFF;
 222 #endif
 223         env_crc_update ();
 224         gd->env_valid = 1;
 225 }
 226
 227 void env_relocate (void)
 228 {
 229         DEBUGF ("%s[%d] offset = 0x%lx\n", __FUNCTION__,__LINE__,
 230                 gd->reloc_off);
 231
 232 #ifdef CONFIG_AMIGAONEG3SE
 233         enable_nvram();
 234 #endif
 235
 236 #ifdef ENV_IS_EMBEDDED
 237         /*
 238          * The environment buffer is embedded with the text segment,
 239          * just relocate the environment pointer
 240          */
 241         env_ptr = (env_t *)((ulong)env_ptr + gd->reloc_off);
 242         DEBUGF ("%s[%d] embedded ENV at %p\n", __FUNCTION__,__LINE__,env_ptr);
 243 #else
 244         /*
 245          * We must allocate a buffer for the environment
 246          */
 247         env_ptr = (env_t *)malloc (CFG_ENV_SIZE);
 248         DEBUGF ("%s[%d] malloced ENV at %p\n", __FUNCTION__,__LINE__,env_ptr);
 249 #endif
 250
 251         /*
 252          * After relocation to RAM, we can always use the "memory" functions
 253          */
 254         env_get_char = env_get_char_memory;
 255
 256         if (gd->env_valid == 0) {
 257 #if defined(CONFIG_GTH) || defined(CFG_ENV_IS_NOWHERE)  /* Environment not changable */
 258                 puts ("Using default environment\n\n");
 259 #else
 260                 puts ("*** Warning - bad CRC, using default environment\n\n");
 261                 show_boot_progress (-60);
 262 #endif
 263         }
 264
 265 #ifdef CFG_PREBOOT_OVERRIDE
 266         if (preboot_override)
 267                 gd->env_valid = 0;
 268 #endif
 269
 270         if (gd->env_valid == 0)
 271                 default_env();
 272         else {
 273                 env_relocate_spec ();
 274         }
 275         gd->env_addr = (ulong)&(env_ptr->data);
 276
 277 #ifdef CONFIG_AMIGAONEG3SE
 278         disable_nvram();
 279 #endif
 280 }
 281
 282 #ifdef CONFIG_AUTO_COMPLETE
 283 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
 284 {
 285         int i, nxt, len, vallen, found;
 286         const char *lval, *rval;
 287
 288         found = 0;
 289         cmdv[0] = NULL;
 290
 291         len = strlen(var);
 292         /* now iterate over the variables and select those that match */
 293         for (i=0; env_get_char(i) != '\0'; i=nxt+1) {
 294
 295                 for (nxt=i; env_get_char(nxt) != '\0'; ++nxt)
 296                         ;
 297
 298                 lval = (char *)env_get_addr(i);
 299                 rval = strchr(lval, '=');
 300                 if (rval != NULL) {
 301                         vallen = rval - lval;
 302                         rval++;
 303                 } else
 304                         vallen = strlen(lval);
 305
 306                 if (len > 0 && (vallen < len || memcmp(lval, var, len) != 0))
 307                         continue;
 308
 309                 if (found >= maxv - 2 || bufsz < vallen + 1) {
 310                         cmdv[found++] = "...";
 311                         break;
 312                 }
 313                 cmdv[found++] = buf;
 314                 memcpy(buf, lval, vallen); buf += vallen; bufsz -= vallen;
 315                 *buf++ = '\0'; bufsz--;
 316         }
 317
 318         cmdv[found] = NULL;
 319         return found;
 320 }
 321 #endif