drivers/mtd/devices/block2mtd.c

   1 /*
   2  * $Id: block2mtd.c,v 1.30 2005/11/29 14:48:32 gleixner Exp $
   3  *
   4  * block2mtd.c - create an mtd from a block device
   5  *
   6  * Copyright (C) 2001,2002      Simon Evans <spse@secret.org.uk>
   7  * Copyright (C) 2004-2006      Jörn Engel <joern@wh.fh-wedel.de>
   8  *
   9  * Licence: GPL
  10  */
  11 #include <linux/module.h>
  12 #include <linux/fs.h>
  13 #include <linux/blkdev.h>
  14 #include <linux/bio.h>
  15 #include <linux/pagemap.h>
  16 #include <linux/list.h>
  17 #include <linux/init.h>
  18 #include <linux/mtd/mtd.h>
  19 #include <linux/buffer_head.h>
  20 #include <linux/mutex.h>
  21
  22 #define VERSION "$Revision: 1.30 $"
  23
  24
  25 #define ERROR(fmt, args...) printk(KERN_ERR "block2mtd: " fmt "\n" , ## args)
  26 #define INFO(fmt, args...) printk(KERN_INFO "block2mtd: " fmt "\n" , ## args)
  27
  28
  29 /* Info for the block device */
  30 struct block2mtd_dev {
  31         struct list_head list;
  32         struct block_device *blkdev;
  33         struct mtd_info mtd;
  34         struct mutex write_mutex;
  35 };
  36
  37
  38 /* Static info about the MTD, used in cleanup_module */
  39 static LIST_HEAD(blkmtd_device_list);
  40
  41
  42 #define PAGE_READAHEAD 64
  43 static void cache_readahead(struct address_space *mapping, int index)
  44 {
  45         filler_t *filler = (filler_t*)mapping->a_ops->readpage;
  46         int i, pagei;
  47         unsigned ret = 0;
  48         unsigned long end_index;
  49         struct page *page;
  50         LIST_HEAD(page_pool);
  51         struct inode *inode = mapping->host;
  52         loff_t isize = i_size_read(inode);
  53
  54         if (!isize) {
  55                 INFO("iSize=0 in cache_readahead\n");
  56                 return;
  57         }
  58
  59         end_index = ((isize - 1) >> PAGE_CACHE_SHIFT);
  60
  61         read_lock_irq(&mapping->tree_lock);
  62         for (i = 0; i < PAGE_READAHEAD; i++) {
  63                 pagei = index + i;
  64                 if (pagei > end_index) {
  65                         INFO("Overrun end of disk in cache readahead\n");
  66                         break;
  67                 }
  68                 page = radix_tree_lookup(&mapping->page_tree, pagei);
  69                 if (page && (!i))
  70                         break;
  71                 if (page)
  72                         continue;
  73                 read_unlock_irq(&mapping->tree_lock);
  74                 page = page_cache_alloc_cold(mapping);
  75                 read_lock_irq(&mapping->tree_lock);
  76                 if (!page)
  77                         break;
  78                 page->index = pagei;
  79                 list_add(&page->lru, &page_pool);
  80                 ret++;
  81         }
  82         read_unlock_irq(&mapping->tree_lock);
  83         if (ret)
  84                 read_cache_pages(mapping, &page_pool, filler, NULL);
  85 }
  86
  87
  88 static struct page* page_readahead(struct address_space *mapping, int index)
  89 {
  90         filler_t *filler = (filler_t*)mapping->a_ops->readpage;
  91         cache_readahead(mapping, index);
  92         return read_cache_page(mapping, index, filler, NULL);
  93 }
  94
  95
  96 /* erase a specified part of the device */
  97 static int _block2mtd_erase(struct block2mtd_dev *dev, loff_t to, size_t len)
  98 {
  99         struct address_space *mapping = dev->blkdev->bd_inode->i_mapping;
 100         struct page *page;
 101         int index = to >> PAGE_SHIFT;   // page index
 102         int pages = len >> PAGE_SHIFT;
 103         u_long *p;
 104         u_long *max;
 105
 106         while (pages) {
 107                 page = page_readahead(mapping, index);
 108                 if (!page)
 109                         return -ENOMEM;
 110                 if (IS_ERR(page))
 111                         return PTR_ERR(page);
 112
 113                 max = (u_long*)page_address(page) + PAGE_SIZE;
 114                 for (p=(u_long*)page_address(page); p<max; p++)
 115                         if (*p != -1UL) {
 116                                 lock_page(page);
 117                                 memset(page_address(page), 0xff, PAGE_SIZE);
 118                                 set_page_dirty(page);
 119                                 unlock_page(page);
 120                                 break;
 121                         }
 122
 123                 page_cache_release(page);
 124                 pages--;
 125                 index++;
 126         }
 127         return 0;
 128 }
 129 static int block2mtd_erase(struct mtd_info *mtd, struct erase_info *instr)
 130 {
 131         struct block2mtd_dev *dev = mtd->priv;
 132         size_t from = instr->addr;
 133         size_t len = instr->len;
 134         int err;
 135
 136         instr->state = MTD_ERASING;
 137         mutex_lock(&dev->write_mutex);
 138         err = _block2mtd_erase(dev, from, len);
 139         mutex_unlock(&dev->write_mutex);
 140         if (err) {
 141                 ERROR("erase failed err = %d", err);
 142                 instr->state = MTD_ERASE_FAILED;
 143         } else
 144                 instr->state = MTD_ERASE_DONE;
 145
 146         instr->state = MTD_ERASE_DONE;
 147         mtd_erase_callback(instr);
 148         return err;
 149 }
 150
 151
 152 static int block2mtd_read(struct mtd_info *mtd, loff_t from, size_t len,
 153                 size_t *retlen, u_char *buf)
 154 {
 155         struct block2mtd_dev *dev = mtd->priv;
 156         struct page *page;
 157         int index = from >> PAGE_SHIFT;
 158         int offset = from & (PAGE_SIZE-1);
 159         int cpylen;
 160
 161         if (from > mtd->size)
 162                 return -EINVAL;
 163         if (from + len > mtd->size)
 164                 len = mtd->size - from;
 165
 166         if (retlen)
 167                 *retlen = 0;
 168
 169         while (len) {
 170                 if ((offset + len) > PAGE_SIZE)
 171                         cpylen = PAGE_SIZE - offset;    // multiple pages
 172                 else
 173                         cpylen = len;   // this page
 174                 len = len - cpylen;
 175
 176                 //      Get page
 177                 page = page_readahead(dev->blkdev->bd_inode->i_mapping, index);
 178                 if (!page)
 179                         return -ENOMEM;
 180                 if (IS_ERR(page))
 181                         return PTR_ERR(page);
 182
 183                 memcpy(buf, page_address(page) + offset, cpylen);
 184                 page_cache_release(page);
 185
 186                 if (retlen)
 187                         *retlen += cpylen;
 188                 buf += cpylen;
 189                 offset = 0;
 190                 index++;
 191         }
 192         return 0;
 193 }
 194
 195
 196 /* write data to the underlying device */
 197 static int _block2mtd_write(struct block2mtd_dev *dev, const u_char *buf,
 198                 loff_t to, size_t len, size_t *retlen)
 199 {
 200         struct page *page;
 201         struct address_space *mapping = dev->blkdev->bd_inode->i_mapping;
 202         int index = to >> PAGE_SHIFT;   // page index
 203         int offset = to & ~PAGE_MASK;   // page offset
 204         int cpylen;
 205
 206         if (retlen)
 207                 *retlen = 0;
 208         while (len) {
 209                 if ((offset+len) > PAGE_SIZE)
 210                         cpylen = PAGE_SIZE - offset;    // multiple pages
 211                 else
 212                         cpylen = len;                   // this page
 213                 len = len - cpylen;
 214
 215                 //      Get page
 216                 page = page_readahead(mapping, index);
 217                 if (!page)
 218                         return -ENOMEM;
 219                 if (IS_ERR(page))
 220                         return PTR_ERR(page);
 221
 222                 if (memcmp(page_address(page)+offset, buf, cpylen)) {
 223                         lock_page(page);
 224                         memcpy(page_address(page) + offset, buf, cpylen);
 225                         set_page_dirty(page);
 226                         unlock_page(page);
 227                 }
 228                 page_cache_release(page);
 229
 230                 if (retlen)
 231                         *retlen += cpylen;
 232
 233                 buf += cpylen;
 234                 offset = 0;
 235                 index++;
 236         }
 237         return 0;
 238 }
 239 static int block2mtd_write(struct mtd_info *mtd, loff_t to, size_t len,
 240                 size_t *retlen, const u_char *buf)
 241 {
 242         struct block2mtd_dev *dev = mtd->priv;
 243         int err;
 244
 245         if (!len)
 246                 return 0;
 247         if (to >= mtd->size)
 248                 return -ENOSPC;
 249         if (to + len > mtd->size)
 250                 len = mtd->size - to;
 251
 252         mutex_lock(&dev->write_mutex);
 253         err = _block2mtd_write(dev, buf, to, len, retlen);
 254         mutex_unlock(&dev->write_mutex);
 255         if (err > 0)
 256                 err = 0;
 257         return err;
 258 }
 259
 260
 261 /* sync the device - wait until the write queue is empty */
 262 static void block2mtd_sync(struct mtd_info *mtd)
 263 {
 264         struct block2mtd_dev *dev = mtd->priv;
 265         sync_blockdev(dev->blkdev);
 266         return;
 267 }
 268
 269
 270 static void block2mtd_free_device(struct block2mtd_dev *dev)
 271 {
 272         if (!dev)
 273                 return;
 274
 275         kfree(dev->mtd.name);
 276
 277         if (dev->blkdev) {
 278                 invalidate_inode_pages(dev->blkdev->bd_inode->i_mapping);
 279                 close_bdev_excl(dev->blkdev);
 280         }
 281
 282         kfree(dev);
 283 }
 284
 285
 286 /* FIXME: ensure that mtd->size % erase_size == 0 */
 287 static struct block2mtd_dev *add_device(char *devname, int erase_size)
 288 {
 289         struct block_device *bdev;
 290         struct block2mtd_dev *dev;
 291
 292         if (!devname)
 293                 return NULL;
 294
 295         dev = kmalloc(sizeof(struct block2mtd_dev), GFP_KERNEL);
 296         if (!dev)
 297                 return NULL;
 298         memset(dev, 0, sizeof(*dev));
 299
 300         /* Get a handle on the device */
 301         bdev = open_bdev_excl(devname, O_RDWR, NULL);
 302         if (IS_ERR(bdev)) {
 303                 ERROR("error: cannot open device %s", devname);
 304                 goto devinit_err;
 305         }
 306         dev->blkdev = bdev;
 307
 308         if (MAJOR(bdev->bd_dev) == MTD_BLOCK_MAJOR) {
 309                 ERROR("attempting to use an MTD device as a block device");
 310                 goto devinit_err;
 311         }
 312
 313         mutex_init(&dev->write_mutex);
 314
 315         /* Setup the MTD structure */
 316         /* make the name contain the block device in */
 317         dev->mtd.name = kmalloc(sizeof("block2mtd: ") + strlen(devname),
 318                         GFP_KERNEL);
 319         if (!dev->mtd.name)
 320                 goto devinit_err;
 321
 322         sprintf(dev->mtd.name, "block2mtd: %s", devname);
 323
 324         dev->mtd.size = dev->blkdev->bd_inode->i_size & PAGE_MASK;
 325         dev->mtd.erasesize = erase_size;
 326         dev->mtd.writesize = 1;
 327         dev->mtd.type = MTD_RAM;
 328         dev->mtd.flags = MTD_CAP_RAM;
 329         dev->mtd.erase = block2mtd_erase;
 330         dev->mtd.write = block2mtd_write;
 331         dev->mtd.writev = default_mtd_writev;
 332         dev->mtd.sync = block2mtd_sync;
 333         dev->mtd.read = block2mtd_read;
 334         dev->mtd.priv = dev;
 335         dev->mtd.owner = THIS_MODULE;
 336
 337         if (add_mtd_device(&dev->mtd)) {
 338                 /* Device didnt get added, so free the entry */
 339                 goto devinit_err;
 340         }
 341         list_add(&dev->list, &blkmtd_device_list);
 342         INFO("mtd%d: [%s] erase_size = %dKiB [%d]", dev->mtd.index,
 343                         dev->mtd.name + strlen("blkmtd: "),
 344                         dev->mtd.erasesize >> 10, dev->mtd.erasesize);
 345         return dev;
 346
 347 devinit_err:
 348         block2mtd_free_device(dev);
 349         return NULL;
 350 }
 351
 352
 353 /* This function works similar to reguler strtoul.  In addition, it
 354  * allows some suffixes for a more human-readable number format:
 355  * ki, Ki, kiB, KiB     - multiply result with 1024
 356  * Mi, MiB              - multiply result with 1024^2
 357  * Gi, GiB              - multiply result with 1024^3
 358  */
 359 static int ustrtoul(const char *cp, char **endp, unsigned int base)
 360 {
 361         unsigned long result = simple_strtoul(cp, endp, base);
 362         switch (**endp) {
 363         case 'G' :
 364                 result *= 1024;
 365         case 'M':
 366                 result *= 1024;
 367         case 'K':
 368         case 'k':
 369                 result *= 1024;
 370         /* By dwmw2 editorial decree, "ki", "Mi" or "Gi" are to be used. */
 371                 if ((*endp)[1] == 'i') {
 372                         if ((*endp)[2] == 'B')
 373                                 (*endp) += 3;
 374                         else
 375                                 (*endp) += 2;
 376                 }
 377         }
 378         return result;
 379 }
 380
 381
 382 static int parse_num(size_t *num, const char *token)
 383 {
 384         char *endp;
 385         size_t n;
 386
 387         n = (size_t) ustrtoul(token, &endp, 0);
 388         if (*endp)
 389                 return -EINVAL;
 390
 391         *num = n;
 392         return 0;
 393 }
 394
 395
 396 static int parse_name(char **pname, const char *token, size_t limit)
 397 {
 398         size_t len;
 399         char *name;
 400
 401         len = strlen(token) + 1;
 402         if (len > limit)
 403                 return -ENOSPC;
 404
 405         name = kmalloc(len, GFP_KERNEL);
 406         if (!name)
 407                 return -ENOMEM;
 408
 409         strcpy(name, token);
 410
 411         *pname = name;
 412         return 0;
 413 }
 414
 415
 416 static inline void kill_final_newline(char *str)
 417 {
 418         char *newline = strrchr(str, '\n');
 419         if (newline && !newline[1])
 420                 *newline = 0;
 421 }
 422
 423
 424 #define parse_err(fmt, args...) do {            \
 425         ERROR("block2mtd: " fmt "\n", ## args); \
 426         return 0;                               \
 427 } while (0)
 428
 429 static int block2mtd_setup(const char *val, struct kernel_param *kp)
 430 {
 431         char buf[80+12]; /* 80 for device, 12 for erase size */
 432         char *str = buf;
 433         char *token[2];
 434         char *name;
 435         size_t erase_size = PAGE_SIZE;
 436         int i, ret;
 437
 438         if (strnlen(val, sizeof(buf)) >= sizeof(buf))
 439                 parse_err("parameter too long");
 440
 441         strcpy(str, val);
 442         kill_final_newline(str);
 443
 444         for (i = 0; i < 2; i++)
 445                 token[i] = strsep(&str, ",");
 446
 447         if (str)
 448                 parse_err("too many arguments");
 449
 450         if (!token[0])
 451                 parse_err("no argument");
 452
 453         ret = parse_name(&name, token[0], 80);
 454         if (ret == -ENOMEM)
 455                 parse_err("out of memory");
 456         if (ret == -ENOSPC)
 457                 parse_err("name too long");
 458         if (ret)
 459                 return 0;
 460
 461         if (token[1]) {
 462                 ret = parse_num(&erase_size, token[1]);
 463                 if (ret) {
 464                         kfree(name);
 465                         parse_err("illegal erase size");
 466                 }
 467         }
 468
 469         add_device(name, erase_size);
 470
 471         return 0;
 472 }
 473
 474
 475 module_param_call(block2mtd, block2mtd_setup, NULL, NULL, 0200);
 476 MODULE_PARM_DESC(block2mtd, "Device to use. \"block2mtd=<dev>[,<erasesize>]\"");
 477
 478 static int __init block2mtd_init(void)
 479 {
 480         INFO("version " VERSION);
 481         return 0;
 482 }
 483
 484
 485 static void __devexit block2mtd_exit(void)
 486 {
 487         struct list_head *pos, *next;
 488
 489         /* Remove the MTD devices */
 490         list_for_each_safe(pos, next, &blkmtd_device_list) {
 491                 struct block2mtd_dev *dev = list_entry(pos, typeof(*dev), list);
 492                 block2mtd_sync(&dev->mtd);
 493                 del_mtd_device(&dev->mtd);
 494                 INFO("mtd%d: [%s] removed", dev->mtd.index,
 495                                 dev->mtd.name + strlen("blkmtd: "));
 496                 list_del(&dev->list);
 497                 block2mtd_free_device(dev);
 498         }
 499 }
 500
 501
 502 module_init(block2mtd_init);
 503 module_exit(block2mtd_exit);
 504
 505 MODULE_LICENSE("GPL");
 506 MODULE_AUTHOR("Simon Evans <spse@secret.org.uk> and others");
 507 MODULE_DESCRIPTION("Emulate an MTD using a block device");