]> git.sur5r.net Git - u-boot/blob - common/env_nand.c
695a9eebb01e68e3f11a7a545d96ac68507eebbc
[u-boot] / 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         ssize_t len;
185         char    *res;
186         int     env_idx = 0;
187         static const struct env_location location[] = {
188                 {
189                         .name = "NAND",
190                         .erase_opts = {
191                                 .length = CONFIG_ENV_RANGE,
192                                 .offset = CONFIG_ENV_OFFSET,
193                         },
194                 },
195 #ifdef CONFIG_ENV_OFFSET_REDUND
196                 {
197                         .name = "redundant NAND",
198                         .erase_opts = {
199                                 .length = CONFIG_ENV_RANGE,
200                                 .offset = CONFIG_ENV_OFFSET_REDUND,
201                         },
202                 },
203 #endif
204         };
205
206
207         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
208                 return 1;
209
210         res = (char *)&env_new->data;
211         len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
212         if (len < 0) {
213                 error("Cannot export environment: errno = %d\n", errno);
214                 return 1;
215         }
216         env_new->crc   = crc32(0, env_new->data, ENV_SIZE);
217 #ifdef CONFIG_ENV_OFFSET_REDUND
218         env_new->flags = ++env_flags; /* increase the serial */
219         env_idx = (gd->env_valid == 1);
220 #endif
221
222         ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
223 #ifdef CONFIG_ENV_OFFSET_REDUND
224         if (!ret) {
225                 /* preset other copy for next write */
226                 gd->env_valid = gd->env_valid == 2 ? 1 : 2;
227                 return ret;
228         }
229
230         env_idx = (env_idx + 1) & 1;
231         ret = erase_and_write_env(&location[env_idx], (u_char *)env_new);
232         if (!ret)
233                 printf("Warning: primary env write failed,"
234                                 " redundancy is lost!\n");
235 #endif
236
237         return ret;
238 }
239 #endif /* CMD_SAVEENV */
240
241 int readenv(size_t offset, u_char *buf)
242 {
243         size_t end = offset + CONFIG_ENV_RANGE;
244         size_t amount_loaded = 0;
245         size_t blocksize, len;
246         u_char *char_ptr;
247
248         blocksize = nand_info[0].erasesize;
249         if (!blocksize)
250                 return 1;
251
252         len = min(blocksize, CONFIG_ENV_SIZE);
253
254         while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
255                 if (nand_block_isbad(&nand_info[0], offset)) {
256                         offset += blocksize;
257                 } else {
258                         char_ptr = &buf[amount_loaded];
259                         if (nand_read_skip_bad(&nand_info[0], offset,
260                                                &len, NULL,
261                                                nand_info[0].size, char_ptr))
262                                 return 1;
263
264                         offset += blocksize;
265                         amount_loaded += len;
266                 }
267         }
268
269         if (amount_loaded != CONFIG_ENV_SIZE)
270                 return 1;
271
272         return 0;
273 }
274
275 #ifdef CONFIG_ENV_OFFSET_OOB
276 int get_nand_env_oob(nand_info_t *nand, unsigned long *result)
277 {
278         struct mtd_oob_ops ops;
279         uint32_t oob_buf[ENV_OFFSET_SIZE / sizeof(uint32_t)];
280         int ret;
281
282         ops.datbuf      = NULL;
283         ops.mode        = MTD_OOB_AUTO;
284         ops.ooboffs     = 0;
285         ops.ooblen      = ENV_OFFSET_SIZE;
286         ops.oobbuf      = (void *)oob_buf;
287
288         ret = nand->read_oob(nand, ENV_OFFSET_SIZE, &ops);
289         if (ret) {
290                 printf("error reading OOB block 0\n");
291                 return ret;
292         }
293
294         if (oob_buf[0] == ENV_OOB_MARKER) {
295                 *result = oob_buf[1] * nand->erasesize;
296         } else if (oob_buf[0] == ENV_OOB_MARKER_OLD) {
297                 *result = oob_buf[1];
298         } else {
299                 printf("No dynamic environment marker in OOB block 0\n");
300                 return -ENOENT;
301         }
302
303         return 0;
304 }
305 #endif
306
307 #ifdef CONFIG_ENV_OFFSET_REDUND
308 void env_relocate_spec(void)
309 {
310 #if !defined(ENV_IS_EMBEDDED)
311         int read1_fail = 0, read2_fail = 0;
312         int crc1_ok = 0, crc2_ok = 0;
313         env_t *ep, *tmp_env1, *tmp_env2;
314
315         tmp_env1 = (env_t *)malloc(CONFIG_ENV_SIZE);
316         tmp_env2 = (env_t *)malloc(CONFIG_ENV_SIZE);
317         if (tmp_env1 == NULL || tmp_env2 == NULL) {
318                 puts("Can't allocate buffers for environment\n");
319                 set_default_env("!malloc() failed");
320                 goto done;
321         }
322
323         read1_fail = readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1);
324         read2_fail = readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2);
325
326         if (read1_fail && read2_fail)
327                 puts("*** Error - No Valid Environment Area found\n");
328         else if (read1_fail || read2_fail)
329                 puts("*** Warning - some problems detected "
330                      "reading environment; recovered successfully\n");
331
332         crc1_ok = !read1_fail &&
333                 (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
334         crc2_ok = !read2_fail &&
335                 (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
336
337         if (!crc1_ok && !crc2_ok) {
338                 set_default_env("!bad CRC");
339                 goto done;
340         } else if (crc1_ok && !crc2_ok) {
341                 gd->env_valid = 1;
342         } else if (!crc1_ok && crc2_ok) {
343                 gd->env_valid = 2;
344         } else {
345                 /* both ok - check serial */
346                 if (tmp_env1->flags == 255 && tmp_env2->flags == 0)
347                         gd->env_valid = 2;
348                 else if (tmp_env2->flags == 255 && tmp_env1->flags == 0)
349                         gd->env_valid = 1;
350                 else if (tmp_env1->flags > tmp_env2->flags)
351                         gd->env_valid = 1;
352                 else if (tmp_env2->flags > tmp_env1->flags)
353                         gd->env_valid = 2;
354                 else /* flags are equal - almost impossible */
355                         gd->env_valid = 1;
356         }
357
358         free(env_ptr);
359
360         if (gd->env_valid == 1)
361                 ep = tmp_env1;
362         else
363                 ep = tmp_env2;
364
365         env_flags = ep->flags;
366         env_import((char *)ep, 0);
367
368 done:
369         free(tmp_env1);
370         free(tmp_env2);
371
372 #endif /* ! ENV_IS_EMBEDDED */
373 }
374 #else /* ! CONFIG_ENV_OFFSET_REDUND */
375 /*
376  * The legacy NAND code saved the environment in the first NAND
377  * device i.e., nand_dev_desc + 0. This is also the behaviour using
378  * the new NAND code.
379  */
380 void env_relocate_spec(void)
381 {
382 #if !defined(ENV_IS_EMBEDDED)
383         int ret;
384         ALLOC_CACHE_ALIGN_BUFFER(char, buf, CONFIG_ENV_SIZE);
385
386 #if defined(CONFIG_ENV_OFFSET_OOB)
387         ret = get_nand_env_oob(&nand_info[0], &nand_env_oob_offset);
388         /*
389          * If unable to read environment offset from NAND OOB then fall through
390          * to the normal environment reading code below
391          */
392         if (!ret) {
393                 printf("Found Environment offset in OOB..\n");
394         } else {
395                 set_default_env("!no env offset in OOB");
396                 return;
397         }
398 #endif
399
400         ret = readenv(CONFIG_ENV_OFFSET, (u_char *)buf);
401         if (ret) {
402                 set_default_env("!readenv() failed");
403                 return;
404         }
405
406         env_import(buf, 1);
407 #endif /* ! ENV_IS_EMBEDDED */
408 }
409 #endif /* CONFIG_ENV_OFFSET_REDUND */