drivers/mtd/tests/mtd_readtest.c

   1 /*
   2  * Copyright (C) 2006-2008 Nokia Corporation
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms of the GNU General Public License version 2 as published by
   6  * the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program; see the file COPYING. If not, write to the Free Software
  15  * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  16  *
  17  * Check MTD device read.
  18  *
  19  * Author: Adrian Hunter <ext-adrian.hunter@nokia.com>
  20  */
  21
  22 #include <linux/init.h>
  23 #include <linux/module.h>
  24 #include <linux/moduleparam.h>
  25 #include <linux/err.h>
  26 #include <linux/mtd/mtd.h>
  27 #include <linux/sched.h>
  28
  29 #define PRINT_PREF KERN_INFO "mtd_readtest: "
  30
  31 static int dev;
  32 module_param(dev, int, S_IRUGO);
  33 MODULE_PARM_DESC(dev, "MTD device number to use");
  34
  35 static struct mtd_info *mtd;
  36 static unsigned char *iobuf;
  37 static unsigned char *iobuf1;
  38 static unsigned char *bbt;
  39
  40 static int pgsize;
  41 static int ebcnt;
  42 static int pgcnt;
  43
  44 static int read_eraseblock_by_page(int ebnum)
  45 {
  46         size_t read = 0;
  47         int i, ret, err = 0;
  48         loff_t addr = ebnum * mtd->erasesize;
  49         void *buf = iobuf;
  50         void *oobbuf = iobuf1;
  51
  52         for (i = 0; i < pgcnt; i++) {
  53                 memset(buf, 0 , pgcnt);
  54                 ret = mtd->read(mtd, addr, pgsize, &read, buf);
  55                 if (ret == -EUCLEAN)
  56                         ret = 0;
  57                 if (ret || read != pgsize) {
  58                         printk(PRINT_PREF "error: read failed at %#llx\n",
  59                                (long long)addr);
  60                         if (!err)
  61                                 err = ret;
  62                         if (!err)
  63                                 err = -EINVAL;
  64                 }
  65                 if (mtd->oobsize) {
  66                         struct mtd_oob_ops ops;
  67
  68                         ops.mode      = MTD_OOB_PLACE;
  69                         ops.len       = 0;
  70                         ops.retlen    = 0;
  71                         ops.ooblen    = mtd->oobsize;
  72                         ops.oobretlen = 0;
  73                         ops.ooboffs   = 0;
  74                         ops.datbuf    = NULL;
  75                         ops.oobbuf    = oobbuf;
  76                         ret = mtd->read_oob(mtd, addr, &ops);
  77                         if (ret || ops.oobretlen != mtd->oobsize) {
  78                                 printk(PRINT_PREF "error: read oob failed at "
  79                                                   "%#llx\n", (long long)addr);
  80                                 if (!err)
  81                                         err = ret;
  82                                 if (!err)
  83                                         err = -EINVAL;
  84                         }
  85                         oobbuf += mtd->oobsize;
  86                 }
  87                 addr += pgsize;
  88                 buf += pgsize;
  89         }
  90
  91         return err;
  92 }
  93
  94 static void dump_eraseblock(int ebnum)
  95 {
  96         int i, j, n;
  97         char line[128];
  98         int pg, oob;
  99
 100         printk(PRINT_PREF "dumping eraseblock %d\n", ebnum);
 101         n = mtd->erasesize;
 102         for (i = 0; i < n;) {
 103                 char *p = line;
 104
 105                 p += sprintf(p, "%05x: ", i);
 106                 for (j = 0; j < 32 && i < n; j++, i++)
 107                         p += sprintf(p, "%02x", (unsigned int)iobuf[i]);
 108                 printk(KERN_CRIT "%s\n", line);
 109                 cond_resched();
 110         }
 111         if (!mtd->oobsize)
 112                 return;
 113         printk(PRINT_PREF "dumping oob from eraseblock %d\n", ebnum);
 114         n = mtd->oobsize;
 115         for (pg = 0, i = 0; pg < pgcnt; pg++)
 116                 for (oob = 0; oob < n;) {
 117                         char *p = line;
 118
 119                         p += sprintf(p, "%05x: ", i);
 120                         for (j = 0; j < 32 && oob < n; j++, oob++, i++)
 121                                 p += sprintf(p, "%02x",
 122                                              (unsigned int)iobuf1[i]);
 123                         printk(KERN_CRIT "%s\n", line);
 124                         cond_resched();
 125                 }
 126 }
 127
 128 static int is_block_bad(int ebnum)
 129 {
 130         loff_t addr = ebnum * mtd->erasesize;
 131         int ret;
 132
 133         ret = mtd->block_isbad(mtd, addr);
 134         if (ret)
 135                 printk(PRINT_PREF "block %d is bad\n", ebnum);
 136         return ret;
 137 }
 138
 139 static int scan_for_bad_eraseblocks(void)
 140 {
 141         int i, bad = 0;
 142
 143         bbt = kmalloc(ebcnt, GFP_KERNEL);
 144         if (!bbt) {
 145                 printk(PRINT_PREF "error: cannot allocate memory\n");
 146                 return -ENOMEM;
 147         }
 148         memset(bbt, 0 , ebcnt);
 149
 150         /* NOR flash does not implement block_isbad */
 151         if (mtd->block_isbad == NULL)
 152                 return 0;
 153
 154         printk(PRINT_PREF "scanning for bad eraseblocks\n");
 155         for (i = 0; i < ebcnt; ++i) {
 156                 bbt[i] = is_block_bad(i) ? 1 : 0;
 157                 if (bbt[i])
 158                         bad += 1;
 159                 cond_resched();
 160         }
 161         printk(PRINT_PREF "scanned %d eraseblocks, %d are bad\n", i, bad);
 162         return 0;
 163 }
 164
 165 static int __init mtd_readtest_init(void)
 166 {
 167         uint64_t tmp;
 168         int err, i;
 169
 170         printk(KERN_INFO "\n");
 171         printk(KERN_INFO "=================================================\n");
 172         printk(PRINT_PREF "MTD device: %d\n", dev);
 173
 174         mtd = get_mtd_device(NULL, dev);
 175         if (IS_ERR(mtd)) {
 176                 err = PTR_ERR(mtd);
 177                 printk(PRINT_PREF "error: Cannot get MTD device\n");
 178                 return err;
 179         }
 180
 181         if (mtd->writesize == 1) {
 182                 printk(PRINT_PREF "not NAND flash, assume page size is 512 "
 183                        "bytes.\n");
 184                 pgsize = 512;
 185         } else
 186                 pgsize = mtd->writesize;
 187
 188         tmp = mtd->size;
 189         do_div(tmp, mtd->erasesize);
 190         ebcnt = tmp;
 191         pgcnt = mtd->erasesize / pgsize;
 192
 193         printk(PRINT_PREF "MTD device size %llu, eraseblock size %u, "
 194                "page size %u, count of eraseblocks %u, pages per "
 195                "eraseblock %u, OOB size %u\n",
 196                (unsigned long long)mtd->size, mtd->erasesize,
 197                pgsize, ebcnt, pgcnt, mtd->oobsize);
 198
 199         err = -ENOMEM;
 200         iobuf = kmalloc(mtd->erasesize, GFP_KERNEL);
 201         if (!iobuf) {
 202                 printk(PRINT_PREF "error: cannot allocate memory\n");
 203                 goto out;
 204         }
 205         iobuf1 = kmalloc(mtd->erasesize, GFP_KERNEL);
 206         if (!iobuf1) {
 207                 printk(PRINT_PREF "error: cannot allocate memory\n");
 208                 goto out;
 209         }
 210
 211         err = scan_for_bad_eraseblocks();
 212         if (err)
 213                 goto out;
 214
 215         /* Read all eraseblocks 1 page at a time */
 216         printk(PRINT_PREF "testing page read\n");
 217         for (i = 0; i < ebcnt; ++i) {
 218                 int ret;
 219
 220                 if (bbt[i])
 221                         continue;
 222                 ret = read_eraseblock_by_page(i);
 223                 if (ret) {
 224                         dump_eraseblock(i);
 225                         if (!err)
 226                                 err = ret;
 227                 }
 228                 cond_resched();
 229         }
 230
 231         if (err)
 232                 printk(PRINT_PREF "finished with errors\n");
 233         else
 234                 printk(PRINT_PREF "finished\n");
 235
 236 out:
 237
 238         kfree(iobuf);
 239         kfree(iobuf1);
 240         kfree(bbt);
 241         put_mtd_device(mtd);
 242         if (err)
 243                 printk(PRINT_PREF "error %d occurred\n", err);
 244         printk(KERN_INFO "=================================================\n");
 245         return err;
 246 }
 247 module_init(mtd_readtest_init);
 248
 249 static void __exit mtd_readtest_exit(void)
 250 {
 251         return;
 252 }
 253 module_exit(mtd_readtest_exit);
 254
 255 MODULE_DESCRIPTION("Read test module");
 256 MODULE_AUTHOR("Adrian Hunter");
 257 MODULE_LICENSE("GPL");