]> git.sur5r.net Git - u-boot/blob - drivers/mtd/nand/nand_util.c
f48775607101f50a239f6c00abbd11da8712526f
[u-boot] / drivers / mtd / nand / nand_util.c
1 /*
2  * drivers/mtd/nand/nand_util.c
3  *
4  * Copyright (C) 2006 by Weiss-Electronic GmbH.
5  * All rights reserved.
6  *
7  * @author:     Guido Classen <clagix@gmail.com>
8  * @descr:      NAND Flash support
9  * @references: borrowed heavily from Linux mtd-utils code:
10  *              flash_eraseall.c by Arcom Control System Ltd
11  *              nandwrite.c by Steven J. Hill (sjhill@realitydiluted.com)
12  *                             and Thomas Gleixner (tglx@linutronix.de)
13  *
14  * Copyright (C) 2008 Nokia Corporation: drop_ffs() function by
15  * Artem Bityutskiy <dedekind1@gmail.com> from mtd-utils
16  *
17  * Copyright 2010 Freescale Semiconductor
18  *
19  * SPDX-License-Identifier:     GPL-2.0
20  */
21
22 #include <common.h>
23 #include <command.h>
24 #include <watchdog.h>
25 #include <malloc.h>
26 #include <div64.h>
27
28 #include <asm/errno.h>
29 #include <linux/mtd/mtd.h>
30 #include <nand.h>
31 #include <jffs2/jffs2.h>
32
33 typedef struct erase_info       erase_info_t;
34 typedef struct mtd_info         mtd_info_t;
35
36 /* support only for native endian JFFS2 */
37 #define cpu_to_je16(x) (x)
38 #define cpu_to_je32(x) (x)
39
40 /**
41  * nand_erase_opts: - erase NAND flash with support for various options
42  *                    (jffs2 formatting)
43  *
44  * @param meminfo       NAND device to erase
45  * @param opts          options,  @see struct nand_erase_options
46  * @return              0 in case of success
47  *
48  * This code is ported from flash_eraseall.c from Linux mtd utils by
49  * Arcom Control System Ltd.
50  */
51 int nand_erase_opts(nand_info_t *meminfo, const nand_erase_options_t *opts)
52 {
53         struct jffs2_unknown_node cleanmarker;
54         erase_info_t erase;
55         unsigned long erase_length, erased_length; /* in blocks */
56         int result;
57         int percent_complete = -1;
58         const char *mtd_device = meminfo->name;
59         struct mtd_oob_ops oob_opts;
60         struct nand_chip *chip = meminfo->priv;
61
62         if ((opts->offset & (meminfo->erasesize - 1)) != 0) {
63                 printf("Attempt to erase non block-aligned data\n");
64                 return -1;
65         }
66
67         memset(&erase, 0, sizeof(erase));
68         memset(&oob_opts, 0, sizeof(oob_opts));
69
70         erase.mtd = meminfo;
71         erase.len  = meminfo->erasesize;
72         erase.addr = opts->offset;
73         erase_length = lldiv(opts->length + meminfo->erasesize - 1,
74                              meminfo->erasesize);
75
76         cleanmarker.magic = cpu_to_je16(JFFS2_MAGIC_BITMASK);
77         cleanmarker.nodetype = cpu_to_je16(JFFS2_NODETYPE_CLEANMARKER);
78         cleanmarker.totlen = cpu_to_je32(8);
79
80         /* scrub option allows to erase badblock. To prevent internal
81          * check from erase() method, set block check method to dummy
82          * and disable bad block table while erasing.
83          */
84         if (opts->scrub) {
85                 erase.scrub = opts->scrub;
86                 /*
87                  * We don't need the bad block table anymore...
88                  * after scrub, there are no bad blocks left!
89                  */
90                 if (chip->bbt) {
91                         kfree(chip->bbt);
92                 }
93                 chip->bbt = NULL;
94                 chip->options &= ~NAND_BBT_SCANNED;
95         }
96
97         for (erased_length = 0;
98              erased_length < erase_length;
99              erase.addr += meminfo->erasesize) {
100
101                 WATCHDOG_RESET();
102
103                 if (opts->lim && (erase.addr >= (opts->offset + opts->lim))) {
104                         puts("Size of erase exceeds limit\n");
105                         return -EFBIG;
106                 }
107                 if (!opts->scrub) {
108                         int ret = mtd_block_isbad(meminfo, erase.addr);
109                         if (ret > 0) {
110                                 if (!opts->quiet)
111                                         printf("\rSkipping bad block at  "
112                                                "0x%08llx                 "
113                                                "                         \n",
114                                                erase.addr);
115
116                                 if (!opts->spread)
117                                         erased_length++;
118
119                                 continue;
120
121                         } else if (ret < 0) {
122                                 printf("\n%s: MTD get bad block failed: %d\n",
123                                        mtd_device,
124                                        ret);
125                                 return -1;
126                         }
127                 }
128
129                 erased_length++;
130
131                 result = mtd_erase(meminfo, &erase);
132                 if (result != 0) {
133                         printf("\n%s: MTD Erase failure: %d\n",
134                                mtd_device, result);
135                         continue;
136                 }
137
138                 /* format for JFFS2 ? */
139                 if (opts->jffs2 && chip->ecc.layout->oobavail >= 8) {
140                         struct mtd_oob_ops ops;
141                         ops.ooblen = 8;
142                         ops.datbuf = NULL;
143                         ops.oobbuf = (uint8_t *)&cleanmarker;
144                         ops.ooboffs = 0;
145                         ops.mode = MTD_OPS_AUTO_OOB;
146
147                         result = mtd_write_oob(meminfo,
148                                                     erase.addr,
149                                                     &ops);
150                         if (result != 0) {
151                                 printf("\n%s: MTD writeoob failure: %d\n",
152                                        mtd_device, result);
153                                 continue;
154                         }
155                 }
156
157                 if (!opts->quiet) {
158                         unsigned long long n = erased_length * 100ULL;
159                         int percent;
160
161                         do_div(n, erase_length);
162                         percent = (int)n;
163
164                         /* output progress message only at whole percent
165                          * steps to reduce the number of messages printed
166                          * on (slow) serial consoles
167                          */
168                         if (percent != percent_complete) {
169                                 percent_complete = percent;
170
171                                 printf("\rErasing at 0x%llx -- %3d%% complete.",
172                                        erase.addr, percent);
173
174                                 if (opts->jffs2 && result == 0)
175                                         printf(" Cleanmarker written at 0x%llx.",
176                                                erase.addr);
177                         }
178                 }
179         }
180         if (!opts->quiet)
181                 printf("\n");
182
183         return 0;
184 }
185
186 #ifdef CONFIG_CMD_NAND_LOCK_UNLOCK
187
188 #define NAND_CMD_LOCK_TIGHT     0x2c
189 #define NAND_CMD_LOCK_STATUS    0x7a
190  
191 /******************************************************************************
192  * Support for locking / unlocking operations of some NAND devices
193  *****************************************************************************/
194
195 /**
196  * nand_lock: Set all pages of NAND flash chip to the LOCK or LOCK-TIGHT
197  *            state
198  *
199  * @param mtd           nand mtd instance
200  * @param tight         bring device in lock tight mode
201  *
202  * @return              0 on success, -1 in case of error
203  *
204  * The lock / lock-tight command only applies to the whole chip. To get some
205  * parts of the chip lock and others unlocked use the following sequence:
206  *
207  * - Lock all pages of the chip using nand_lock(mtd, 0) (or the lockpre pin)
208  * - Call nand_unlock() once for each consecutive area to be unlocked
209  * - If desired: Bring the chip to the lock-tight state using nand_lock(mtd, 1)
210  *
211  *   If the device is in lock-tight state software can't change the
212  *   current active lock/unlock state of all pages. nand_lock() / nand_unlock()
213  *   calls will fail. It is only posible to leave lock-tight state by
214  *   an hardware signal (low pulse on _WP pin) or by power down.
215  */
216 int nand_lock(struct mtd_info *mtd, int tight)
217 {
218         int ret = 0;
219         int status;
220         struct nand_chip *chip = mtd->priv;
221
222         /* select the NAND device */
223         chip->select_chip(mtd, 0);
224
225         /* check the Lock Tight Status */
226         chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, 0);
227         if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
228                 printf("nand_lock: Device is locked tight!\n");
229                 ret = -1;
230                 goto out;
231         }
232
233         chip->cmdfunc(mtd,
234                       (tight ? NAND_CMD_LOCK_TIGHT : NAND_CMD_LOCK),
235                       -1, -1);
236
237         /* call wait ready function */
238         status = chip->waitfunc(mtd, chip);
239
240         /* see if device thinks it succeeded */
241         if (status & 0x01) {
242                 ret = -1;
243         }
244
245  out:
246         /* de-select the NAND device */
247         chip->select_chip(mtd, -1);
248         return ret;
249 }
250
251 /**
252  * nand_get_lock_status: - query current lock state from one page of NAND
253  *                         flash
254  *
255  * @param mtd           nand mtd instance
256  * @param offset        page address to query (must be page-aligned!)
257  *
258  * @return              -1 in case of error
259  *                      >0 lock status:
260  *                        bitfield with the following combinations:
261  *                        NAND_LOCK_STATUS_TIGHT: page in tight state
262  *                        NAND_LOCK_STATUS_UNLOCK: page unlocked
263  *
264  */
265 int nand_get_lock_status(struct mtd_info *mtd, loff_t offset)
266 {
267         int ret = 0;
268         int chipnr;
269         int page;
270         struct nand_chip *chip = mtd->priv;
271
272         /* select the NAND device */
273         chipnr = (int)(offset >> chip->chip_shift);
274         chip->select_chip(mtd, chipnr);
275
276
277         if ((offset & (mtd->writesize - 1)) != 0) {
278                 printf("nand_get_lock_status: "
279                         "Start address must be beginning of "
280                         "nand page!\n");
281                 ret = -1;
282                 goto out;
283         }
284
285         /* check the Lock Status */
286         page = (int)(offset >> chip->page_shift);
287         chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
288
289         ret = chip->read_byte(mtd) & (NAND_LOCK_STATUS_TIGHT
290                                           | NAND_LOCK_STATUS_UNLOCK);
291
292  out:
293         /* de-select the NAND device */
294         chip->select_chip(mtd, -1);
295         return ret;
296 }
297
298 /**
299  * nand_unlock: - Unlock area of NAND pages
300  *                only one consecutive area can be unlocked at one time!
301  *
302  * @param mtd           nand mtd instance
303  * @param start         start byte address
304  * @param length        number of bytes to unlock (must be a multiple of
305  *                      page size nand->writesize)
306  * @param allexcept     if set, unlock everything not selected
307  *
308  * @return              0 on success, -1 in case of error
309  */
310 int nand_unlock(struct mtd_info *mtd, loff_t start, size_t length,
311         int allexcept)
312 {
313         int ret = 0;
314         int chipnr;
315         int status;
316         int page;
317         struct nand_chip *chip = mtd->priv;
318
319         debug("nand_unlock%s: start: %08llx, length: %zd!\n",
320                 allexcept ? " (allexcept)" : "", start, length);
321
322         /* select the NAND device */
323         chipnr = (int)(start >> chip->chip_shift);
324         chip->select_chip(mtd, chipnr);
325
326         /* check the WP bit */
327         chip->cmdfunc(mtd, NAND_CMD_STATUS, -1, -1);
328         if (!(chip->read_byte(mtd) & NAND_STATUS_WP)) {
329                 printf("nand_unlock: Device is write protected!\n");
330                 ret = -1;
331                 goto out;
332         }
333
334         /* check the Lock Tight Status */
335         page = (int)(start >> chip->page_shift);
336         chip->cmdfunc(mtd, NAND_CMD_LOCK_STATUS, -1, page & chip->pagemask);
337         if (chip->read_byte(mtd) & NAND_LOCK_STATUS_TIGHT) {
338                 printf("nand_unlock: Device is locked tight!\n");
339                 ret = -1;
340                 goto out;
341         }
342
343         if ((start & (mtd->erasesize - 1)) != 0) {
344                 printf("nand_unlock: Start address must be beginning of "
345                         "nand block!\n");
346                 ret = -1;
347                 goto out;
348         }
349
350         if (length == 0 || (length & (mtd->erasesize - 1)) != 0) {
351                 printf("nand_unlock: Length must be a multiple of nand block "
352                         "size %08x!\n", mtd->erasesize);
353                 ret = -1;
354                 goto out;
355         }
356
357         /*
358          * Set length so that the last address is set to the
359          * starting address of the last block
360          */
361         length -= mtd->erasesize;
362
363         /* submit address of first page to unlock */
364         chip->cmdfunc(mtd, NAND_CMD_UNLOCK1, -1, page & chip->pagemask);
365
366         /* submit ADDRESS of LAST page to unlock */
367         page += (int)(length >> chip->page_shift);
368
369         /*
370          * Page addresses for unlocking are supposed to be block-aligned.
371          * At least some NAND chips use the low bit to indicate that the
372          * page range should be inverted.
373          */
374         if (allexcept)
375                 page |= 1;
376
377         chip->cmdfunc(mtd, NAND_CMD_UNLOCK2, -1, page & chip->pagemask);
378
379         /* call wait ready function */
380         status = chip->waitfunc(mtd, chip);
381         /* see if device thinks it succeeded */
382         if (status & 0x01) {
383                 /* there was an error */
384                 ret = -1;
385                 goto out;
386         }
387
388  out:
389         /* de-select the NAND device */
390         chip->select_chip(mtd, -1);
391         return ret;
392 }
393 #endif
394
395 /**
396  * check_skip_len
397  *
398  * Check if there are any bad blocks, and whether length including bad
399  * blocks fits into device
400  *
401  * @param nand NAND device
402  * @param offset offset in flash
403  * @param length image length
404  * @param used length of flash needed for the requested length
405  * @return 0 if the image fits and there are no bad blocks
406  *         1 if the image fits, but there are bad blocks
407  *        -1 if the image does not fit
408  */
409 static int check_skip_len(nand_info_t *nand, loff_t offset, size_t length,
410                 size_t *used)
411 {
412         size_t len_excl_bad = 0;
413         int ret = 0;
414
415         while (len_excl_bad < length) {
416                 size_t block_len, block_off;
417                 loff_t block_start;
418
419                 if (offset >= nand->size)
420                         return -1;
421
422                 block_start = offset & ~(loff_t)(nand->erasesize - 1);
423                 block_off = offset & (nand->erasesize - 1);
424                 block_len = nand->erasesize - block_off;
425
426                 if (!nand_block_isbad(nand, block_start))
427                         len_excl_bad += block_len;
428                 else
429                         ret = 1;
430
431                 offset += block_len;
432                 *used += block_len;
433         }
434
435         /* If the length is not a multiple of block_len, adjust. */
436         if (len_excl_bad > length)
437                 *used -= (len_excl_bad - length);
438
439         return ret;
440 }
441
442 #ifdef CONFIG_CMD_NAND_TRIMFFS
443 static size_t drop_ffs(const nand_info_t *nand, const u_char *buf,
444                         const size_t *len)
445 {
446         size_t l = *len;
447         ssize_t i;
448
449         for (i = l - 1; i >= 0; i--)
450                 if (buf[i] != 0xFF)
451                         break;
452
453         /* The resulting length must be aligned to the minimum flash I/O size */
454         l = i + 1;
455         l = (l + nand->writesize - 1) / nand->writesize;
456         l *=  nand->writesize;
457
458         /*
459          * since the input length may be unaligned, prevent access past the end
460          * of the buffer
461          */
462         return min(l, *len);
463 }
464 #endif
465
466 /**
467  * nand_verify_page_oob:
468  *
469  * Verify a page of NAND flash, including the OOB.
470  * Reads page of NAND and verifies the contents and OOB against the
471  * values in ops.
472  *
473  * @param nand          NAND device
474  * @param ops           MTD operations, including data to verify
475  * @param ofs           offset in flash
476  * @return              0 in case of success
477  */
478 int nand_verify_page_oob(nand_info_t *nand, struct mtd_oob_ops *ops, loff_t ofs)
479 {
480         int rval;
481         struct mtd_oob_ops vops;
482         size_t verlen = nand->writesize + nand->oobsize;
483
484         memcpy(&vops, ops, sizeof(vops));
485
486         vops.datbuf = malloc(verlen);
487
488         if (!vops.datbuf)
489                 return -ENOMEM;
490
491         vops.oobbuf = vops.datbuf + nand->writesize;
492
493         rval = mtd_read_oob(nand, ofs, &vops);
494         if (!rval)
495                 rval = memcmp(ops->datbuf, vops.datbuf, vops.len);
496         if (!rval)
497                 rval = memcmp(ops->oobbuf, vops.oobbuf, vops.ooblen);
498
499         free(vops.datbuf);
500
501         return rval ? -EIO : 0;
502 }
503
504 /**
505  * nand_verify:
506  *
507  * Verify a region of NAND flash.
508  * Reads NAND in page-sized chunks and verifies the contents against
509  * the contents of a buffer.  The offset into the NAND must be
510  * page-aligned, and the function doesn't handle skipping bad blocks.
511  *
512  * @param nand          NAND device
513  * @param ofs           offset in flash
514  * @param len           buffer length
515  * @param buf           buffer to read from
516  * @return              0 in case of success
517  */
518 int nand_verify(nand_info_t *nand, loff_t ofs, size_t len, u_char *buf)
519 {
520         int rval = 0;
521         size_t verofs;
522         size_t verlen = nand->writesize;
523         uint8_t *verbuf = malloc(verlen);
524
525         if (!verbuf)
526                 return -ENOMEM;
527
528         /* Read the NAND back in page-size groups to limit malloc size */
529         for (verofs = ofs; verofs < ofs + len;
530              verofs += verlen, buf += verlen) {
531                 verlen = min(nand->writesize, (uint32_t)(ofs + len - verofs));
532                 rval = nand_read(nand, verofs, &verlen, verbuf);
533                 if (!rval || (rval == -EUCLEAN))
534                         rval = memcmp(buf, verbuf, verlen);
535
536                 if (rval)
537                         break;
538         }
539
540         free(verbuf);
541
542         return rval ? -EIO : 0;
543 }
544
545
546
547 /**
548  * nand_write_skip_bad:
549  *
550  * Write image to NAND flash.
551  * Blocks that are marked bad are skipped and the is written to the next
552  * block instead as long as the image is short enough to fit even after
553  * skipping the bad blocks.  Due to bad blocks we may not be able to
554  * perform the requested write.  In the case where the write would
555  * extend beyond the end of the NAND device, both length and actual (if
556  * not NULL) are set to 0.  In the case where the write would extend
557  * beyond the limit we are passed, length is set to 0 and actual is set
558  * to the required length.
559  *
560  * @param nand          NAND device
561  * @param offset        offset in flash
562  * @param length        buffer length
563  * @param actual        set to size required to write length worth of
564  *                      buffer or 0 on error, if not NULL
565  * @param lim           maximum size that actual may be in order to not
566  *                      exceed the buffer
567  * @param buffer        buffer to read from
568  * @param flags         flags modifying the behaviour of the write to NAND
569  * @return              0 in case of success
570  */
571 int nand_write_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
572                 size_t *actual, loff_t lim, u_char *buffer, int flags)
573 {
574         int rval = 0, blocksize;
575         size_t left_to_write = *length;
576         size_t used_for_write = 0;
577         u_char *p_buffer = buffer;
578         int need_skip;
579
580         if (actual)
581                 *actual = 0;
582
583 #ifdef CONFIG_CMD_NAND_YAFFS
584         if (flags & WITH_YAFFS_OOB) {
585                 if (flags & (~WITH_YAFFS_OOB & ~WITH_WR_VERIFY))
586                         return -EINVAL;
587
588                 int pages;
589                 pages = nand->erasesize / nand->writesize;
590                 blocksize = (pages * nand->oobsize) + nand->erasesize;
591                 if (*length % (nand->writesize + nand->oobsize)) {
592                         printf("Attempt to write incomplete page"
593                                 " in yaffs mode\n");
594                         return -EINVAL;
595                 }
596         } else
597 #endif
598         {
599                 blocksize = nand->erasesize;
600         }
601
602         /*
603          * nand_write() handles unaligned, partial page writes.
604          *
605          * We allow length to be unaligned, for convenience in
606          * using the $filesize variable.
607          *
608          * However, starting at an unaligned offset makes the
609          * semantics of bad block skipping ambiguous (really,
610          * you should only start a block skipping access at a
611          * partition boundary).  So don't try to handle that.
612          */
613         if ((offset & (nand->writesize - 1)) != 0) {
614                 printf("Attempt to write non page-aligned data\n");
615                 *length = 0;
616                 return -EINVAL;
617         }
618
619         need_skip = check_skip_len(nand, offset, *length, &used_for_write);
620
621         if (actual)
622                 *actual = used_for_write;
623
624         if (need_skip < 0) {
625                 printf("Attempt to write outside the flash area\n");
626                 *length = 0;
627                 return -EINVAL;
628         }
629
630         if (used_for_write > lim) {
631                 puts("Size of write exceeds partition or device limit\n");
632                 *length = 0;
633                 return -EFBIG;
634         }
635
636         if (!need_skip && !(flags & WITH_DROP_FFS)) {
637                 rval = nand_write(nand, offset, length, buffer);
638
639                 if ((flags & WITH_WR_VERIFY) && !rval)
640                         rval = nand_verify(nand, offset, *length, buffer);
641
642                 if (rval == 0)
643                         return 0;
644
645                 *length = 0;
646                 printf("NAND write to offset %llx failed %d\n",
647                         offset, rval);
648                 return rval;
649         }
650
651         while (left_to_write > 0) {
652                 size_t block_offset = offset & (nand->erasesize - 1);
653                 size_t write_size, truncated_write_size;
654
655                 WATCHDOG_RESET();
656
657                 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
658                         printf("Skip bad block 0x%08llx\n",
659                                 offset & ~(nand->erasesize - 1));
660                         offset += nand->erasesize - block_offset;
661                         continue;
662                 }
663
664                 if (left_to_write < (blocksize - block_offset))
665                         write_size = left_to_write;
666                 else
667                         write_size = blocksize - block_offset;
668
669 #ifdef CONFIG_CMD_NAND_YAFFS
670                 if (flags & WITH_YAFFS_OOB) {
671                         int page, pages;
672                         size_t pagesize = nand->writesize;
673                         size_t pagesize_oob = pagesize + nand->oobsize;
674                         struct mtd_oob_ops ops;
675
676                         ops.len = pagesize;
677                         ops.ooblen = nand->oobsize;
678                         ops.mode = MTD_OPS_AUTO_OOB;
679                         ops.ooboffs = 0;
680
681                         pages = write_size / pagesize_oob;
682                         for (page = 0; page < pages; page++) {
683                                 WATCHDOG_RESET();
684
685                                 ops.datbuf = p_buffer;
686                                 ops.oobbuf = ops.datbuf + pagesize;
687
688                                 rval = mtd_write_oob(nand, offset, &ops);
689
690                                 if ((flags & WITH_WR_VERIFY) && !rval)
691                                         rval = nand_verify_page_oob(nand,
692                                                         &ops, offset);
693
694                                 if (rval != 0)
695                                         break;
696
697                                 offset += pagesize;
698                                 p_buffer += pagesize_oob;
699                         }
700                 }
701                 else
702 #endif
703                 {
704                         truncated_write_size = write_size;
705 #ifdef CONFIG_CMD_NAND_TRIMFFS
706                         if (flags & WITH_DROP_FFS)
707                                 truncated_write_size = drop_ffs(nand, p_buffer,
708                                                 &write_size);
709 #endif
710
711                         rval = nand_write(nand, offset, &truncated_write_size,
712                                         p_buffer);
713
714                         if ((flags & WITH_WR_VERIFY) && !rval)
715                                 rval = nand_verify(nand, offset,
716                                         truncated_write_size, p_buffer);
717
718                         offset += write_size;
719                         p_buffer += write_size;
720                 }
721
722                 if (rval != 0) {
723                         printf("NAND write to offset %llx failed %d\n",
724                                 offset, rval);
725                         *length -= left_to_write;
726                         return rval;
727                 }
728
729                 left_to_write -= write_size;
730         }
731
732         return 0;
733 }
734
735 /**
736  * nand_read_skip_bad:
737  *
738  * Read image from NAND flash.
739  * Blocks that are marked bad are skipped and the next block is read
740  * instead as long as the image is short enough to fit even after
741  * skipping the bad blocks.  Due to bad blocks we may not be able to
742  * perform the requested read.  In the case where the read would extend
743  * beyond the end of the NAND device, both length and actual (if not
744  * NULL) are set to 0.  In the case where the read would extend beyond
745  * the limit we are passed, length is set to 0 and actual is set to the
746  * required length.
747  *
748  * @param nand NAND device
749  * @param offset offset in flash
750  * @param length buffer length, on return holds number of read bytes
751  * @param actual set to size required to read length worth of buffer or 0
752  * on error, if not NULL
753  * @param lim maximum size that actual may be in order to not exceed the
754  * buffer
755  * @param buffer buffer to write to
756  * @return 0 in case of success
757  */
758 int nand_read_skip_bad(nand_info_t *nand, loff_t offset, size_t *length,
759                 size_t *actual, loff_t lim, u_char *buffer)
760 {
761         int rval;
762         size_t left_to_read = *length;
763         size_t used_for_read = 0;
764         u_char *p_buffer = buffer;
765         int need_skip;
766
767         if ((offset & (nand->writesize - 1)) != 0) {
768                 printf("Attempt to read non page-aligned data\n");
769                 *length = 0;
770                 if (actual)
771                         *actual = 0;
772                 return -EINVAL;
773         }
774
775         need_skip = check_skip_len(nand, offset, *length, &used_for_read);
776
777         if (actual)
778                 *actual = used_for_read;
779
780         if (need_skip < 0) {
781                 printf("Attempt to read outside the flash area\n");
782                 *length = 0;
783                 return -EINVAL;
784         }
785
786         if (used_for_read > lim) {
787                 puts("Size of read exceeds partition or device limit\n");
788                 *length = 0;
789                 return -EFBIG;
790         }
791
792         if (!need_skip) {
793                 rval = nand_read(nand, offset, length, buffer);
794                 if (!rval || rval == -EUCLEAN)
795                         return 0;
796
797                 *length = 0;
798                 printf("NAND read from offset %llx failed %d\n",
799                         offset, rval);
800                 return rval;
801         }
802
803         while (left_to_read > 0) {
804                 size_t block_offset = offset & (nand->erasesize - 1);
805                 size_t read_length;
806
807                 WATCHDOG_RESET();
808
809                 if (nand_block_isbad(nand, offset & ~(nand->erasesize - 1))) {
810                         printf("Skipping bad block 0x%08llx\n",
811                                 offset & ~(nand->erasesize - 1));
812                         offset += nand->erasesize - block_offset;
813                         continue;
814                 }
815
816                 if (left_to_read < (nand->erasesize - block_offset))
817                         read_length = left_to_read;
818                 else
819                         read_length = nand->erasesize - block_offset;
820
821                 rval = nand_read(nand, offset, &read_length, p_buffer);
822                 if (rval && rval != -EUCLEAN) {
823                         printf("NAND read from offset %llx failed %d\n",
824                                 offset, rval);
825                         *length -= left_to_read;
826                         return rval;
827                 }
828
829                 left_to_read -= read_length;
830                 offset       += read_length;
831                 p_buffer     += read_length;
832         }
833
834         return 0;
835 }
836
837 #ifdef CONFIG_CMD_NAND_TORTURE
838
839 /**
840  * check_pattern:
841  *
842  * Check if buffer contains only a certain byte pattern.
843  *
844  * @param buf buffer to check
845  * @param patt the pattern to check
846  * @param size buffer size in bytes
847  * @return 1 if there are only patt bytes in buf
848  *         0 if something else was found
849  */
850 static int check_pattern(const u_char *buf, u_char patt, int size)
851 {
852         int i;
853
854         for (i = 0; i < size; i++)
855                 if (buf[i] != patt)
856                         return 0;
857         return 1;
858 }
859
860 /**
861  * nand_torture:
862  *
863  * Torture a block of NAND flash.
864  * This is useful to determine if a block that caused a write error is still
865  * good or should be marked as bad.
866  *
867  * @param nand NAND device
868  * @param offset offset in flash
869  * @return 0 if the block is still good
870  */
871 int nand_torture(nand_info_t *nand, loff_t offset)
872 {
873         u_char patterns[] = {0xa5, 0x5a, 0x00};
874         struct erase_info instr = {
875                 .mtd = nand,
876                 .addr = offset,
877                 .len = nand->erasesize,
878         };
879         size_t retlen;
880         int err, ret = -1, i, patt_count;
881         u_char *buf;
882
883         if ((offset & (nand->erasesize - 1)) != 0) {
884                 puts("Attempt to torture a block at a non block-aligned offset\n");
885                 return -EINVAL;
886         }
887
888         if (offset + nand->erasesize > nand->size) {
889                 puts("Attempt to torture a block outside the flash area\n");
890                 return -EINVAL;
891         }
892
893         patt_count = ARRAY_SIZE(patterns);
894
895         buf = malloc(nand->erasesize);
896         if (buf == NULL) {
897                 puts("Out of memory for erase block buffer\n");
898                 return -ENOMEM;
899         }
900
901         for (i = 0; i < patt_count; i++) {
902                 err = nand->erase(nand, &instr);
903                 if (err) {
904                         printf("%s: erase() failed for block at 0x%llx: %d\n",
905                                 nand->name, instr.addr, err);
906                         goto out;
907                 }
908
909                 /* Make sure the block contains only 0xff bytes */
910                 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
911                 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
912                         printf("%s: read() failed for block at 0x%llx: %d\n",
913                                 nand->name, instr.addr, err);
914                         goto out;
915                 }
916
917                 err = check_pattern(buf, 0xff, nand->erasesize);
918                 if (!err) {
919                         printf("Erased block at 0x%llx, but a non-0xff byte was found\n",
920                                 offset);
921                         ret = -EIO;
922                         goto out;
923                 }
924
925                 /* Write a pattern and check it */
926                 memset(buf, patterns[i], nand->erasesize);
927                 err = nand->write(nand, offset, nand->erasesize, &retlen, buf);
928                 if (err || retlen != nand->erasesize) {
929                         printf("%s: write() failed for block at 0x%llx: %d\n",
930                                 nand->name, instr.addr, err);
931                         goto out;
932                 }
933
934                 err = nand->read(nand, offset, nand->erasesize, &retlen, buf);
935                 if ((err && err != -EUCLEAN) || retlen != nand->erasesize) {
936                         printf("%s: read() failed for block at 0x%llx: %d\n",
937                                 nand->name, instr.addr, err);
938                         goto out;
939                 }
940
941                 err = check_pattern(buf, patterns[i], nand->erasesize);
942                 if (!err) {
943                         printf("Pattern 0x%.2x checking failed for block at "
944                                         "0x%llx\n", patterns[i], offset);
945                         ret = -EIO;
946                         goto out;
947                 }
948         }
949
950         ret = 0;
951
952 out:
953         free(buf);
954         return ret;
955 }
956
957 #endif