bootstage: Replace show_boot_progress/error() with bootstage_...()
[kernel/u-boot.git] / 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_EXTRA_ENV_SETTINGS
120         CONFIG_EXTRA_ENV_SETTINGS
121 #endif
122         "\0"
123 };
124
125 struct hsearch_data env_htab;
126
127 static uchar __env_get_char_spec(int index)
128 {
129         return *((uchar *)(gd->env_addr + index));
130 }
131 uchar env_get_char_spec(int)
132         __attribute__((weak, alias("__env_get_char_spec")));
133
134 static uchar env_get_char_init(int index)
135 {
136         /* if crc was bad, use the default environment */
137         if (gd->env_valid)
138                 return env_get_char_spec(index);
139         else
140                 return default_environment[index];
141 }
142
143 uchar env_get_char_memory(int index)
144 {
145         return *env_get_addr(index);
146 }
147
148 uchar env_get_char(int index)
149 {
150         /* if relocated to RAM */
151         if (gd->flags & GD_FLG_RELOC)
152                 return env_get_char_memory(index);
153         else
154                 return env_get_char_init(index);
155 }
156
157 const uchar *env_get_addr(int index)
158 {
159         if (gd->env_valid)
160                 return (uchar *)(gd->env_addr + index);
161         else
162                 return &default_environment[index];
163 }
164
165 void set_default_env(const char *s)
166 {
167         if (sizeof(default_environment) > ENV_SIZE) {
168                 puts("*** Error - default environment is too large\n\n");
169                 return;
170         }
171
172         if (s) {
173                 if (*s == '!') {
174                         printf("*** Warning - %s, "
175                                 "using default environment\n\n",
176                                 s + 1);
177                 } else {
178                         puts(s);
179                 }
180         } else {
181                 puts("Using default environment\n\n");
182         }
183
184         if (himport_r(&env_htab, (char *)default_environment,
185                         sizeof(default_environment), '\0', 0) == 0)
186                 error("Environment import failed: errno = %d\n", errno);
187
188         gd->flags |= GD_FLG_ENV_READY;
189 }
190
191 /*
192  * Check if CRC is valid and (if yes) import the environment.
193  * Note that "buf" may or may not be aligned.
194  */
195 int env_import(const char *buf, int check)
196 {
197         env_t *ep = (env_t *)buf;
198
199         if (check) {
200                 uint32_t crc;
201
202                 memcpy(&crc, &ep->crc, sizeof(crc));
203
204                 if (crc32(0, ep->data, ENV_SIZE) != crc) {
205                         set_default_env("!bad CRC");
206                         return 0;
207                 }
208         }
209
210         if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0)) {
211                 gd->flags |= GD_FLG_ENV_READY;
212                 return 1;
213         }
214
215         error("Cannot import environment: errno = %d\n", errno);
216
217         set_default_env("!import failed");
218
219         return 0;
220 }
221
222 void env_relocate(void)
223 {
224 #if defined(CONFIG_NEEDS_MANUAL_RELOC)
225         env_reloc();
226 #endif
227         if (gd->env_valid == 0) {
228 #if defined(CONFIG_ENV_IS_NOWHERE)      /* Environment not changable */
229                 set_default_env(NULL);
230 #else
231                 bootstage_error(BOOTSTAGE_ID_NET_CHECKSUM);
232                 set_default_env("!bad CRC");
233 #endif
234         } else {
235                 env_relocate_spec();
236         }
237 }
238
239 #ifdef CONFIG_AUTO_COMPLETE
240 int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
241 {
242         ENTRY *match;
243         int found, idx;
244
245         idx = 0;
246         found = 0;
247         cmdv[0] = NULL;
248
249         while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
250                 int vallen = strlen(match->key) + 1;
251
252                 if (found >= maxv - 2 || bufsz < vallen)
253                         break;
254
255                 cmdv[found++] = buf;
256                 memcpy(buf, match->key, vallen);
257                 buf += vallen;
258                 bufsz -= vallen;
259         }
260
261         qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
262
263         if (idx)
264                 cmdv[found++] = "...";
265
266         cmdv[found] = NULL;
267         return found;
268 }
269 #endif