]> git.kernelconcepts.de Git - karo-tx-uboot.git/blob - common/env_nand.c
merged kc master branch
[karo-tx-uboot.git] / common / env_nand.c
1 /*
2  * (C) Copyright 2000-2010
3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
4  *
5  * (C) Copyright 2008
6  * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
7  *
8  * (C) Copyright 2004
9  * Jian Zhang, Texas Instruments, jzhang@ti.com.
10  *
11  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
12  * Andreas Heppel <aheppel@sysgo.de>
13  *
14  * SPDX-License-Identifier:     GPL-2.0+ 
15  */
16
17 #include <common.h>
18 #include <command.h>
19 #include <environment.h>
20 #include <linux/stddef.h>
21 #include <malloc.h>
22 #include <nand.h>
23 #include <search.h>
24 #include <errno.h>
25
26 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
27 #define CMD_SAVEENV
28 #elif defined(CONFIG_ENV_OFFSET_REDUND)
29 #error CONFIG_ENV_OFFSET_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
30 #endif
31
32 #if defined(CONFIG_ENV_SIZE_REDUND) &&  \
33         (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
34 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
35 #endif
36
37 #ifndef CONFIG_ENV_RANGE
38 #define CONFIG_ENV_RANGE        CONFIG_ENV_SIZE
39 #endif
40
41 char *env_name_spec = "NAND";
42
43 #if defined(ENV_IS_EMBEDDED)
44 env_t *env_ptr = &environment;
45 #elif defined(CONFIG_NAND_ENV_DST)
46 env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
47 #endif /* ENV_IS_EMBEDDED */
48
49 DECLARE_GLOBAL_DATA_PTR;
50
51 /*
52  * This is called before nand_init() so we can't read NAND to
53  * validate env data.
54  *
55  * Mark it OK for now. env_relocate() in env_common.c will call our
56  * relocate function which does the real validation.
57  *
58  * When using a NAND boot image (like sequoia_nand), the environment
59  * can be embedded or attached to the U-Boot image in NAND flash.
60  * This way the SPL loads not only the U-Boot image from NAND but
61  * also the environment.
62  */
63 int env_init(void)
64 {
65 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
66         int crc1_ok = 0, crc2_ok = 0;
67         env_t *tmp_env1;
68
69 #ifdef CONFIG_ENV_OFFSET_REDUND
70         env_t *tmp_env2;
71
72         tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
73         crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
74 #endif
75         tmp_env1 = env_ptr;
76         crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
77
78         if (!crc1_ok && !crc2_ok) {
79                 gd->env_addr    = 0;
80                 gd->env_valid   = 0;
81
82                 return 0;
83         } else if (crc1_ok && !crc2_ok) {
84                 gd->env_valid = 1;
85         }
86 #ifdef CONFIG_ENV_OFFSET_REDUND
87         else if (!crc1_ok && crc2_ok) {
88                 gd->env_valid = 2;
89         } else {
90                 /* both ok - check serial */
91                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
92                         gd->env_valid = 2;
93                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
94                         gd->env_valid = 1;
95                 else if (tmp_env1->flags > tmp_env2->flags)
96                         gd->env_valid = 1;
97                 else if (tmp_env2->flags > tmp_env1->flags)
98                         gd->env_valid = 2;
99                 else /* flags are equal - almost impossible */
100                         gd->env_valid = 1;
101         }
102
103         if (gd->env_valid == 2)
104                 env_ptr = tmp_env2;
105         else
106 #endif
107         if (gd->env_valid == 1)
108                 env_ptr = tmp_env1;
109
110         gd->env_addr = (ulong)env_ptr->data;
111
112 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
113         gd->env_addr    = (ulong)&default_environment[0];
114         gd->env_valid   = 1;
115 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
116
117         return 0;
118 }
119
120 #ifdef CMD_SAVEENV
121 /*
122  * The legacy NAND code saved the environment in the first NAND device i.e.,
123  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
124  */
125 int writeenv(size_t offset, u_char *buf)
126 {
127         size_t end = offset + CONFIG_ENV_RANGE;
128         size_t amount_saved = 0;
129         size_t blocksize, len;
130         u_char *char_ptr;
131
132         blocksize = nand_info[0].erasesize;
133         len = min(blocksize, CONFIG_ENV_SIZE);
134
135         while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
136                 if (nand_block_isbad(&nand_info[0], offset)) {
137                         offset += blocksize;
138                 } else {
139                         char_ptr = &buf[amount_saved];
140                         if (nand_write(&nand_info[0], offset, &len, char_ptr))
141                                 return 1;
142
143                         offset += blocksize;
144                         amount_saved += len;
145                 }
146         }
147         if (amount_saved != CONFIG_ENV_SIZE)
148                 return 1;
149
150         return 0;
151 }
152
153 #ifdef CONFIG_ENV_OFFSET_REDUND
154 static unsigned char env_flags;
155
156 int saveenv(void)
157 {
158         env_t   env_new;
159         ssize_t len;
160         char    *res;
161         int     ret = 0;
162         nand_erase_options_t nand_erase_options;
163
164         memset(&nand_erase_options, 0, sizeof(nand_erase_options));
165         nand_erase_options.length = CONFIG_ENV_RANGE;
166
167         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
168                 return 1;
169
170         res = (char *)&env_new.data;
171         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
172         if (len < 0) {
173                 error("Cannot export environment: errno = %d\n", errno);
174                 return 1;
175         }
176         env_new.crc     = crc32(0, env_new.data, ENV_SIZE);
177         env_new.flags   = ++env_flags; /* increase the serial */
178
179         if (gd->env_valid == 1) {
180                 puts("Erasing redundant NAND...\n");
181                 nand_erase_options.offset = CONFIG_ENV_OFFSET_REDUND;
182                 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
183                         return 1;
184
185                 puts("Writing to redundant NAND... ");
186                 ret = writeenv(CONFIG_ENV_OFFSET_REDUND, (u_char *)&env_new);
187         } else {
188                 puts("Erasing NAND...\n");
189                 nand_erase_options.offset = CONFIG_ENV_OFFSET;
190                 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
191                         return 1;
192
193                 puts("Writing to NAND... ");
194                 ret = writeenv(CONFIG_ENV_OFFSET, (u_char *)&env_new);
195         }
196         if (ret) {
197                 puts("FAILED!\n");
198                 return 1;
199         }
200
201         puts("done\n");
202
203         gd->env_valid = gd->env_valid == 2 ? 1 : 2;
204
205         return ret;
206 }
207 #else /* ! CONFIG_ENV_OFFSET_REDUND */
208 int saveenv(void)
209 {
210         int     ret = 0;
211         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
212         ssize_t len;
213         char    *res;
214         nand_erase_options_t nand_erase_options;
215
216         memset(&nand_erase_options, 0, sizeof(nand_erase_options));
217         nand_erase_options.length = CONFIG_ENV_RANGE;
218         nand_erase_options.offset = CONFIG_ENV_OFFSET;
219
220         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
221                 return 1;
222
223         res = (char *)&env_new->data;
224         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
225         if (len < 0) {
226                 error("Cannot export environment: errno = %d\n", errno);
227                 return 1;
228         }
229         env_new->crc = crc32(0, env_new->data, ENV_SIZE);
230
231         puts("Erasing Nand...\n");
232         if (nand_erase_opts(&nand_info[0], &nand_erase_options))
233                 return 1;
234
235         puts("Writing to Nand... ");
236         if (writeenv(CONFIG_ENV_OFFSET, (u_char *)env_new)) {
237                 puts("FAILED!\n");
238                 return 1;
239         }
240
241         puts("done\n");
242         return ret;
243 }
244 #endif /* CONFIG_ENV_OFFSET_REDUND */
245 #endif /* CMD_SAVEENV */
246
247 int readenv(size_t offset, u_char *buf)
248 {
249         size_t end = offset + CONFIG_ENV_RANGE;
250         size_t amount_loaded = 0;
251         size_t blocksize, len;
252         u_char *char_ptr;
253
254         blocksize = nand_info[0].erasesize;
255         if (!blocksize)
256                 return 1;
257
258         len = min(blocksize, CONFIG_ENV_SIZE);
259
260         while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
261                 if (nand_block_isbad(&nand_info[0], offset)) {
262                         offset += blocksize;
263                 } else {
264                         char_ptr = &buf[amount_loaded];
265                         if (nand_read_skip_bad(&nand_info[0], offset,
266                                                &len, NULL,
267                                                nand_info[0].size, char_ptr))
268                                 return 1;
269
270                         offset += blocksize;
271                         amount_loaded += len;
272                 }
273         }
274
275         if (amount_loaded != CONFIG_ENV_SIZE)
276                 return 1;
277
278         return 0;
279 }
280
281 #ifdef CONFIG_ENV_OFFSET_OOB
282 int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
283 {
284         struct mtd_oob_ops ops;
285         uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
286         int ret;
287
288         ops.datbuf      = NULL;
289         ops.mode        = MTD_OOB_AUTO;
290         ops.ooboffs     = 0;
291         ops.ooblen      = ENV_OFFSET_SIZE;
292         ops.oobbuf      = (void *)oob_buf;
293
294         ret = nand->read_oob(nand, ENV_OFFSET_SIZE, &ops);
295         if (ret) {
296                 printf("error reading OOB block 0\n");
297                 return ret;
298         }
299
300         if (oob_buf[0] == ENV_OOB_MARKER) {
301                 *result = oob_buf[1] * nand->erasesize;
302         } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
303                 *result = oob_buf[1];
304         } else {
305                 printf("No dynamic environment marker in OOB block 0\n");
306                 return -ENOENT;
307         }
308
309         return 0;
310 }
311 #endif
312
313 #ifdef CONFIG_ENV_OFFSET_REDUND
314 void env_relocate_spec(void)
315 {
316 #if !defined(ENV_IS_EMBEDDED)
317         int read1_fail = 0, read2_fail = 0;
318         int crc1_ok = 0, crc2_ok = 0;
319         env_t *ep, *tmp_env1, *tmp_env2;
320
321         tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
322         tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
323         if (tmp_env1 == NULL || tmp_env2 == NULL) {
324                 puts("Can't allocate buffers for environment\n");
325                 set_default_env("!malloc() failed");
326                 goto done;
327         }
328
329         read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
330         read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
331
332         if (read1_fail && read2_fail)
333                 puts("*** Error - No Valid Environment Area found\n");
334         else if (read1_fail || read2_fail)
335                 puts("*** Warning - some problems detected "
336                      "reading environment; recovered successfully\n");
337
338         crc1_ok = !read1_fail &&
339                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
340         crc2_ok = !read2_fail &&
341                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
342
343         if (!crc1_ok && !crc2_ok) {
344                 set_default_env("!bad CRC");
345                 goto done;
346         } else if (crc1_ok && !crc2_ok) {
347                 gd->env_valid = 1;
348         } else if (!crc1_ok && crc2_ok) {
349                 gd->env_valid = 2;
350         } else {
351                 /* both ok - check serial */
352                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
353                         gd->env_valid = 2;
354                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
355                         gd->env_valid = 1;
356                 else if (tmp_env1->flags > tmp_env2->flags)
357                         gd->env_valid = 1;
358                 else if (tmp_env2->flags > tmp_env1->flags)
359                         gd->env_valid = 2;
360                 else /* flags are equal - almost impossible */
361                         gd->env_valid = 1;
362         }
363
364 #ifdef CONFIG_NAND_ENV_DST
365         free(env_ptr);
366 #endif
367
368         if (gd->env_valid == 1)
369                 ep = tmp_env1;
370         else
371                 ep = tmp_env2;
372
373         env_flags = ep->flags;
374         env_import((char *)ep, 0);
375
376 done:
377         free(tmp_env1);
378         free(tmp_env2);
379
380 #endif /* ! ENV_IS_EMBEDDED */
381 }
382 #else /* ! CONFIG_ENV_OFFSET_REDUND */
383 /*
384  * The legacy NAND code saved the environment in the first NAND
385  * device i.e., nand_dev_desc + 0. This is also the behaviour using
386  * the new NAND code.
387  */
388 void env_relocate_spec(void)
389 {
390 #if !defined(ENV_IS_EMBEDDED)
391         int ret;
392         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
393
394 #if defined(CONFIG_ENV_OFFSET_OOB)
395         ret = get_nand_env_oob(&nand_info[0], &nand_env_oob_offset);
396         /*
397          * If unable to read environment offset from NAND OOB then fall through
398          * to the normal environment reading code below
399          */
400         if (!ret) {
401                 printf("Found Environment offset in OOB..\n");
402         } else {
403                 set_default_env("!no env offset in OOB");
404                 return;
405         }
406 #endif
407
408         ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
409         if (ret) {
410                 set_default_env("!readenv() failed");
411                 return;
412         }
413
414         env_import(buf, 1);
415 #endif /* ! ENV_IS_EMBEDDED */
416 }
417 #endif /* CONFIG_ENV_OFFSET_REDUND */