]> git.kernelconcepts.de Git - karo-tx-uboot.git/blob - common/env_nand.c
5a734a9321a9400a73ee8024f29bcdb17d546ee6
[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 #else /* ! ENV_IS_EMBEDDED */
48 env_t *env_ptr;
49 #endif /* ENV_IS_EMBEDDED */
50
51 DECLARE_GLOBAL_DATA_PTR;
52
53 /*
54  * This is called before nand_init() so we can't read NAND to
55  * validate env data.
56  *
57  * Mark it OK for now. env_relocate() in env_common.c will call our
58  * relocate function which does the real validation.
59  *
60  * When using a NAND boot image (like sequoia_nand), the environment
61  * can be embedded or attached to the U-Boot image in NAND flash.
62  * This way the SPL loads not only the U-Boot image from NAND but
63  * also the environment.
64  */
65 int env_init(void)
66 {
67 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
68         int crc1_ok = 0, crc2_ok = 0;
69         env_t *tmp_env1;
70
71 #ifdef CONFIG_ENV_OFFSET_REDUND
72         env_t *tmp_env2;
73
74         tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
75         crc2_ok = crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc;
76 #endif
77         tmp_env1 = env_ptr;
78         crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc;
79
80         if (!crc1_ok && !crc2_ok) {
81                 gd->env_addr    = 0;
82                 gd->env_valid   = 0;
83
84                 return 0;
85         } else if (crc1_ok && !crc2_ok) {
86                 gd->env_valid = 1;
87         }
88 #ifdef CONFIG_ENV_OFFSET_REDUND
89         else if (!crc1_ok && crc2_ok) {
90                 gd->env_valid = 2;
91         } else {
92                 /* both ok - check serial */
93                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
94                         gd->env_valid = 2;
95                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
96                         gd->env_valid = 1;
97                 else if (tmp_env1->flags > tmp_env2->flags)
98                         gd->env_valid = 1;
99                 else if (tmp_env2->flags > tmp_env1->flags)
100                         gd->env_valid = 2;
101                 else /* flags are equal - almost impossible */
102                         gd->env_valid = 1;
103         }
104
105         if (gd->env_valid == 2)
106                 env_ptr = tmp_env2;
107         else
108 #endif
109         if (gd->env_valid == 1)
110                 env_ptr = tmp_env1;
111
112         gd->env_addr = (ulong)env_ptr->data;
113
114 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
115         gd->env_addr    = (ulong)&default_environment[0];
116         gd->env_valid   = 1;
117 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
118
119         return 0;
120 }
121
122 #ifdef CMD_SAVEENV
123 /*
124  * The legacy NAND code saved the environment in the first NAND device i.e.,
125  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
126  */
127 int writeenv(size_t offset, u_char *buf)
128 {
129         size_t end = offset + CONFIG_ENV_RANGE;
130         size_t amount_saved = 0;
131         size_t blocksize, len;
132         u_char *char_ptr;
133
134         blocksize = nand_info[0].erasesize;
135         len = min(blocksize, CONFIG_ENV_SIZE);
136
137         while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
138                 if (nand_block_isbad(&nand_info[0], offset)) {
139                         offset += blocksize;
140                 } else {
141                         char_ptr = &buf[amount_saved];
142                         if (nand_write(&nand_info[0], offset, &len, char_ptr))
143                                 return 1;
144
145                         offset += blocksize;
146                         amount_saved += len;
147                 }
148         }
149         if (amount_saved != CONFIG_ENV_SIZE)
150                 return 1;
151
152         return 0;
153 }
154
155 struct env_location {
156         const char *name;
157         const nand_erase_options_t erase_opts;
158 };
159
160 static int erase_and_write_env(const struct env_location *location,
161                 u_char *env_new)
162 {
163         int ret = 0;
164
165         printf("Erasing %s...\n", location->name);
166         if (nand_erase_opts(&nand_info[0], &location->erase_opts))
167                 return 1;
168
169         printf("Writing to %s... ", location->name);
170         ret = writeenv(location->erase_opts.offset, env_new);
171         puts(ret ? "FAILED!\n" : "OK\n");
172
173         return ret;
174 }
175
176 #ifdef CONFIG_ENV_OFFSET_REDUND
177 static unsigned char env_flags;
178 #endif
179
180 int saveenv(void)
181 {
182         int     ret = 0;
183         ALLOC_CACHE_ALIGN_BUFFER(env_t, env_new, 1);
184         int     env_idx = 0;
185         static const struct env_location location[] = {
186                 {
187                         .name = "NAND",
188                         .erase_opts = {
189                                 .length = CONFIG_ENV_RANGE,
190                                 .offset = CONFIG_ENV_OFFSET,
191                         },
192                 },
193 #ifdef CONFIG_ENV_OFFSET_REDUND
194                 {
195                         .name = "redundant NAND",
196                         .erase_opts = {
197                                 .length = CONFIG_ENV_RANGE,
198                                 .offset = CONFIG_ENV_OFFSET_REDUND,
199                         },
200                 },
201 #endif
202         };
203
204
205         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
206                 return 1;
207
208         ret = env_export(env_new);
209         if (ret)
210                 return ret;
211
212 #ifdef CONFIG_ENV_OFFSET_REDUND
213         env_new->flags = ++env_flags; /* increase the serial */
214         env_idx = (gd->env_valid == 1);
215 #endif
216
217         ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
218 #ifdef CONFIG_ENV_OFFSET_REDUND
219         if (!ret) {
220                 /* preset other copy for next write */
221                 gd->env_valid = gd->env_valid == 2 ? 1 : 2;
222                 return ret;
223         }
224
225         env_idx = (env_idx + 1) & 1;
226         ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
227         if (!ret)
228                 printf("Warning: primary env write failed,"
229                                 " redundancy is lost!\n");
230 #endif
231
232         return ret;
233 }
234 #endif /* CMD_SAVEENV */
235
236 int readenv(size_t offset, u_char *buf)
237 {
238         size_t end = offset + CONFIG_ENV_RANGE;
239         size_t amount_loaded = 0;
240         size_t blocksize, len;
241         u_char *char_ptr;
242
243         blocksize = nand_info[0].erasesize;
244         if (!blocksize)
245                 return 1;
246
247         len = min(blocksize, CONFIG_ENV_SIZE);
248
249         while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
250                 if (nand_block_isbad(&nand_info[0], offset)) {
251                         offset += blocksize;
252                 } else {
253                         char_ptr = &buf[amount_loaded];
254                         if (nand_read_skip_bad(&nand_info[0], offset,
255                                                &len, NULL,
256                                                nand_info[0].size, char_ptr))
257                                 return 1;
258
259                         offset += blocksize;
260                         amount_loaded += len;
261                 }
262         }
263
264         if (amount_loaded != CONFIG_ENV_SIZE)
265                 return 1;
266
267         return 0;
268 }
269
270 #ifdef CONFIG_ENV_OFFSET_OOB
271 int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
272 {
273         struct mtd_oob_ops ops;
274         uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
275         int ret;
276
277         ops.datbuf      = NULL;
278         ops.mode        = MTD_OOB_AUTO;
279         ops.ooboffs     = 0;
280         ops.ooblen      = ENV_OFFSET_SIZE;
281         ops.oobbuf      = (void *)oob_buf;
282
283         ret = nand->read_oob(nand, ENV_OFFSET_SIZE, &ops);
284         if (ret) {
285                 printf("error reading OOB block 0\n");
286                 return ret;
287         }
288
289         if (oob_buf[0] == ENV_OOB_MARKER) {
290                 *result = oob_buf[1] * nand->erasesize;
291         } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
292                 *result = oob_buf[1];
293         } else {
294                 printf("No dynamic environment marker in OOB block 0\n");
295                 return -ENOENT;
296         }
297
298         return 0;
299 }
300 #endif
301
302 #ifdef CONFIG_ENV_OFFSET_REDUND
303 void env_relocate_spec(void)
304 {
305 #if !defined(ENV_IS_EMBEDDED)
306         int read1_fail = 0, read2_fail = 0;
307         int crc1_ok = 0, crc2_ok = 0;
308         env_t *ep, *tmp_env1, *tmp_env2;
309
310         tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
311         tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
312         if (tmp_env1 == NULL || tmp_env2 == NULL) {
313                 puts("Can't allocate buffers for environment\n");
314                 set_default_env("!malloc() failed");
315                 goto done;
316         }
317
318         read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
319         read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
320
321         if (read1_fail && read2_fail)
322                 puts("*** Error - No Valid Environment Area found\n");
323         else if (read1_fail || read2_fail)
324                 puts("*** Warning - some problems detected "
325                      "reading environment; recovered successfully\n");
326
327         crc1_ok = !read1_fail &&
328                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
329         crc2_ok = !read2_fail &&
330                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
331
332         if (!crc1_ok && !crc2_ok) {
333                 set_default_env("!bad CRC");
334                 goto done;
335         } else if (crc1_ok && !crc2_ok) {
336                 gd->env_valid = 1;
337         } else if (!crc1_ok && crc2_ok) {
338                 gd->env_valid = 2;
339         } else {
340                 /* both ok - check serial */
341                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
342                         gd->env_valid = 2;
343                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
344                         gd->env_valid = 1;
345                 else if (tmp_env1->flags > tmp_env2->flags)
346                         gd->env_valid = 1;
347                 else if (tmp_env2->flags > tmp_env1->flags)
348                         gd->env_valid = 2;
349                 else /* flags are equal - almost impossible */
350                         gd->env_valid = 1;
351         }
352
353         free(env_ptr);
354
355         if (gd->env_valid == 1)
356                 ep = tmp_env1;
357         else
358                 ep = tmp_env2;
359
360         env_flags = ep->flags;
361         env_import((char *)ep, 0);
362
363 done:
364         free(tmp_env1);
365         free(tmp_env2);
366
367 #endif /* ! ENV_IS_EMBEDDED */
368 }
369 #else /* ! CONFIG_ENV_OFFSET_REDUND */
370 /*
371  * The legacy NAND code saved the environment in the first NAND
372  * device i.e., nand_dev_desc + 0. This is also the behaviour using
373  * the new NAND code.
374  */
375 void env_relocate_spec(void)
376 {
377 #if !defined(ENV_IS_EMBEDDED)
378         int ret;
379         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
380
381 #if defined(CONFIG_ENV_OFFSET_OOB)
382         ret = get_nand_env_oob(&nand_info[0], &nand_env_oob_offset);
383         /*
384          * If unable to read environment offset from NAND OOB then fall through
385          * to the normal environment reading code below
386          */
387         if (!ret) {
388                 printf("Found Environment offset in OOB..\n");
389         } else {
390                 set_default_env("!no env offset in OOB");
391                 return;
392         }
393 #endif
394
395         ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
396         if (ret) {
397                 set_default_env("!readenv() failed");
398                 return;
399         }
400
401         env_import(buf, 1);
402 #endif /* ! ENV_IS_EMBEDDED */
403 }
404 #endif /* CONFIG_ENV_OFFSET_REDUND */