Merge branch 'master' of git://git.denx.de/u-boot-nand-flash
[platform/kernel/u-boot.git] / common / env_nand.c
1 /*
2  * (C) Copyright 2008
3  * Stuart Wood, Lab X Technologies <stuart.wood@labxtechnologies.com>
4  *
5  * (C) Copyright 2004
6  * Jian Zhang, Texas Instruments, jzhang@ti.com.
7
8  * (C) Copyright 2000-2006
9  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
10  *
11  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
12  * Andreas Heppel <aheppel@sysgo.de>
13
14  * See file CREDITS for list of people who contributed to this
15  * project.
16  *
17  * This program is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU General Public License as
19  * published by the Free Software Foundation; either version 2 of
20  * the License, or (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30  * MA 02111-1307 USA
31  */
32
33 /* #define DEBUG */
34
35 #include <common.h>
36 #include <command.h>
37 #include <environment.h>
38 #include <linux/stddef.h>
39 #include <malloc.h>
40 #include <nand.h>
41
42 #if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_NAND)
43 #define CMD_SAVEENV
44 #elif defined(CONFIG_ENV_OFFSET_REDUND)
45 #error Cannot use CONFIG_ENV_OFFSET_REDUND without CONFIG_CMD_SAVEENV & CONFIG_CMD_NAND
46 #endif
47
48 #if defined(CONFIG_ENV_SIZE_REDUND) && (CONFIG_ENV_SIZE_REDUND != CONFIG_ENV_SIZE)
49 #error CONFIG_ENV_SIZE_REDUND should be the same as CONFIG_ENV_SIZE
50 #endif
51
52 #ifdef CONFIG_INFERNO
53 #error CONFIG_INFERNO not supported yet
54 #endif
55
56 #ifndef CONFIG_ENV_RANGE
57 #define CONFIG_ENV_RANGE        CONFIG_ENV_SIZE
58 #endif
59
60 /* references to names in env_common.c */
61 extern uchar default_environment[];
62
63 char * env_name_spec = "NAND";
64
65
66 #if defined(ENV_IS_EMBEDDED)
67 extern uchar environment[];
68 env_t *env_ptr = (env_t *)(&environment[0]);
69 #elif defined(CONFIG_NAND_ENV_DST)
70 env_t *env_ptr = (env_t *)CONFIG_NAND_ENV_DST;
71 #else /* ! ENV_IS_EMBEDDED */
72 env_t *env_ptr = 0;
73 #endif /* ENV_IS_EMBEDDED */
74
75
76 /* local functions */
77 #if !defined(ENV_IS_EMBEDDED)
78 static void use_default(void);
79 #endif
80
81 DECLARE_GLOBAL_DATA_PTR;
82
83 uchar env_get_char_spec (int index)
84 {
85         return ( *((uchar *)(gd->env_addr + index)) );
86 }
87
88
89 /* this is called before nand_init()
90  * so we can't read Nand to validate env data.
91  * Mark it OK for now. env_relocate() in env_common.c
92  * will call our relocate function which does the real
93  * validation.
94  *
95  * When using a NAND boot image (like sequoia_nand), the environment
96  * can be embedded or attached to the U-Boot image in NAND flash. This way
97  * the SPL loads not only the U-Boot image from NAND but also the
98  * environment.
99  */
100 int env_init(void)
101 {
102 #if defined(ENV_IS_EMBEDDED) || defined(CONFIG_NAND_ENV_DST)
103         int crc1_ok = 0, crc2_ok = 0;
104         env_t *tmp_env1;
105
106 #ifdef CONFIG_ENV_OFFSET_REDUND
107         env_t *tmp_env2;
108
109         tmp_env2 = (env_t *)((ulong)env_ptr + CONFIG_ENV_SIZE);
110         crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
111 #endif
112
113         tmp_env1 = env_ptr;
114
115         crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
116
117         if (!crc1_ok && !crc2_ok) {
118                 gd->env_addr  = 0;
119                 gd->env_valid = 0;
120
121                 return 0;
122         } else if (crc1_ok && !crc2_ok) {
123                 gd->env_valid = 1;
124         }
125 #ifdef CONFIG_ENV_OFFSET_REDUND
126         else if (!crc1_ok && crc2_ok) {
127                 gd->env_valid = 2;
128         } else {
129                 /* both ok - check serial */
130                 if(tmp_env1->flags == 255 && tmp_env2->flags == 0)
131                         gd->env_valid = 2;
132                 else if(tmp_env2->flags == 255 && tmp_env1->flags == 0)
133                         gd->env_valid = 1;
134                 else if(tmp_env1->flags > tmp_env2->flags)
135                         gd->env_valid = 1;
136                 else if(tmp_env2->flags > tmp_env1->flags)
137                         gd->env_valid = 2;
138                 else /* flags are equal - almost impossible */
139                         gd->env_valid = 1;
140         }
141
142         if (gd->env_valid == 2)
143                 env_ptr = tmp_env2;
144         else
145 #endif
146         if (gd->env_valid == 1)
147                 env_ptr = tmp_env1;
148
149         gd->env_addr = (ulong)env_ptr->data;
150
151 #else /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
152         gd->env_addr  = (ulong)&default_environment[0];
153         gd->env_valid = 1;
154 #endif /* ENV_IS_EMBEDDED || CONFIG_NAND_ENV_DST */
155
156         return (0);
157 }
158
159 #ifdef CMD_SAVEENV
160 /*
161  * The legacy NAND code saved the environment in the first NAND device i.e.,
162  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
163  */
164 int writeenv(size_t offset, u_char *buf)
165 {
166         size_t end = offset + CONFIG_ENV_RANGE;
167         size_t amount_saved = 0;
168         size_t blocksize, len;
169
170         u_char *char_ptr;
171
172         blocksize = nand_info[0].erasesize;
173         len = min(blocksize, CONFIG_ENV_SIZE);
174
175         while (amount_saved < CONFIG_ENV_SIZE && offset < end) {
176                 if (nand_block_isbad(&nand_info[0], offset)) {
177                         offset += blocksize;
178                 } else {
179                         char_ptr = &buf[amount_saved];
180                         if (nand_write(&nand_info[0], offset, &len,
181                                         char_ptr))
182                                 return 1;
183                         offset += blocksize;
184                         amount_saved += len;
185                 }
186         }
187         if (amount_saved != CONFIG_ENV_SIZE)
188                 return 1;
189
190         return 0;
191 }
192 #ifdef CONFIG_ENV_OFFSET_REDUND
193 int saveenv(void)
194 {
195         int ret = 0;
196         nand_erase_options_t nand_erase_options;
197
198         env_ptr->flags++;
199
200         nand_erase_options.length = CONFIG_ENV_RANGE;
201         nand_erase_options.quiet = 0;
202         nand_erase_options.jffs2 = 0;
203         nand_erase_options.scrub = 0;
204
205         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
206                 return 1;
207         if(gd->env_valid == 1) {
208                 puts ("Erasing redundant Nand...\n");
209                 nand_erase_options.offset = CONFIG_ENV_OFFSET_REDUND;
210                 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
211                         return 1;
212
213                 puts ("Writing to redundant Nand... ");
214                 ret = writeenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) env_ptr);
215         } else {
216                 puts ("Erasing Nand...\n");
217                 nand_erase_options.offset = CONFIG_ENV_OFFSET;
218                 if (nand_erase_opts(&nand_info[0], &nand_erase_options))
219                         return 1;
220
221                 puts ("Writing to Nand... ");
222                 ret = writeenv(CONFIG_ENV_OFFSET, (u_char *) env_ptr);
223         }
224         if (ret) {
225                 puts("FAILED!\n");
226                 return 1;
227         }
228
229         puts ("done\n");
230         gd->env_valid = (gd->env_valid == 2 ? 1 : 2);
231         return ret;
232 }
233 #else /* ! CONFIG_ENV_OFFSET_REDUND */
234 int saveenv(void)
235 {
236         int ret = 0;
237         nand_erase_options_t nand_erase_options;
238
239         nand_erase_options.length = CONFIG_ENV_RANGE;
240         nand_erase_options.quiet = 0;
241         nand_erase_options.jffs2 = 0;
242         nand_erase_options.scrub = 0;
243         nand_erase_options.offset = CONFIG_ENV_OFFSET;
244
245         if (CONFIG_ENV_RANGE < CONFIG_ENV_SIZE)
246                 return 1;
247         puts ("Erasing Nand...\n");
248         if (nand_erase_opts(&nand_info[0], &nand_erase_options))
249                 return 1;
250
251         puts ("Writing to Nand... ");
252         if (writeenv(CONFIG_ENV_OFFSET, (u_char *) env_ptr)) {
253                 puts("FAILED!\n");
254                 return 1;
255         }
256
257         puts ("done\n");
258         return ret;
259 }
260 #endif /* CONFIG_ENV_OFFSET_REDUND */
261 #endif /* CMD_SAVEENV */
262
263 int readenv (size_t offset, u_char * buf)
264 {
265         size_t end = offset + CONFIG_ENV_RANGE;
266         size_t amount_loaded = 0;
267         size_t blocksize, len;
268
269         u_char *char_ptr;
270
271         blocksize = nand_info[0].erasesize;
272         len = min(blocksize, CONFIG_ENV_SIZE);
273
274         while (amount_loaded < CONFIG_ENV_SIZE && offset < end) {
275                 if (nand_block_isbad(&nand_info[0], offset)) {
276                         offset += blocksize;
277                 } else {
278                         char_ptr = &buf[amount_loaded];
279                         if (nand_read(&nand_info[0], offset, &len, char_ptr))
280                                 return 1;
281                         offset += blocksize;
282                         amount_loaded += len;
283                 }
284         }
285         if (amount_loaded != CONFIG_ENV_SIZE)
286                 return 1;
287
288         return 0;
289 }
290
291 #ifdef CONFIG_ENV_OFFSET_REDUND
292 void env_relocate_spec (void)
293 {
294 #if !defined(ENV_IS_EMBEDDED)
295         int crc1_ok = 0, crc2_ok = 0;
296         env_t *tmp_env1, *tmp_env2;
297
298         tmp_env1 = (env_t *) malloc(CONFIG_ENV_SIZE);
299         tmp_env2 = (env_t *) malloc(CONFIG_ENV_SIZE);
300
301         if ((tmp_env1 == NULL) || (tmp_env2 == NULL)) {
302                 puts("Can't allocate buffers for environment\n");
303                 free (tmp_env1);
304                 free (tmp_env2);
305                 return use_default();
306         }
307
308         if (readenv(CONFIG_ENV_OFFSET, (u_char *) tmp_env1))
309                 puts("No Valid Environment Area Found\n");
310         if (readenv(CONFIG_ENV_OFFSET_REDUND, (u_char *) tmp_env2))
311                 puts("No Valid Reundant Environment Area Found\n");
312
313         crc1_ok = (crc32(0, tmp_env1->data, ENV_SIZE) == tmp_env1->crc);
314         crc2_ok = (crc32(0, tmp_env2->data, ENV_SIZE) == tmp_env2->crc);
315
316         if(!crc1_ok && !crc2_ok) {
317                 free(tmp_env1);
318                 free(tmp_env2);
319                 return use_default();
320         } else if(crc1_ok && !crc2_ok)
321                 gd->env_valid = 1;
322         else if(!crc1_ok && crc2_ok)
323                 gd->env_valid = 2;
324         else {
325                 /* both ok - check serial */
326                 if(tmp_env1->flags == 255 && tmp_env2->flags == 0)
327                         gd->env_valid = 2;
328                 else if(tmp_env2->flags == 255 && tmp_env1->flags == 0)
329                         gd->env_valid = 1;
330                 else if(tmp_env1->flags > tmp_env2->flags)
331                         gd->env_valid = 1;
332                 else if(tmp_env2->flags > tmp_env1->flags)
333                         gd->env_valid = 2;
334                 else /* flags are equal - almost impossible */
335                         gd->env_valid = 1;
336
337         }
338
339         free(env_ptr);
340         if(gd->env_valid == 1) {
341                 env_ptr = tmp_env1;
342                 free(tmp_env2);
343         } else {
344                 env_ptr = tmp_env2;
345                 free(tmp_env1);
346         }
347
348 #endif /* ! ENV_IS_EMBEDDED */
349 }
350 #else /* ! CONFIG_ENV_OFFSET_REDUND */
351 /*
352  * The legacy NAND code saved the environment in the first NAND device i.e.,
353  * nand_dev_desc + 0. This is also the behaviour using the new NAND code.
354  */
355 void env_relocate_spec (void)
356 {
357 #if !defined(ENV_IS_EMBEDDED)
358         int ret;
359
360         ret = readenv(CONFIG_ENV_OFFSET, (u_char *) env_ptr);
361         if (ret)
362                 return use_default();
363
364         if (crc32(0, env_ptr->data, ENV_SIZE) != env_ptr->crc)
365                 return use_default();
366 #endif /* ! ENV_IS_EMBEDDED */
367 }
368 #endif /* CONFIG_ENV_OFFSET_REDUND */
369
370 #if !defined(ENV_IS_EMBEDDED)
371 static void use_default()
372 {
373         puts ("*** Warning - bad CRC or NAND, using default environment\n\n");
374         set_default_env();
375 }
376 #endif