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