drivers/mtd/mtdpart.c

   1 /*
   2  * Simple MTD partitioning layer
   3  *
   4  * (C) 2000 Nicolas Pitre <nico@cam.org>
   5  *
   6  * This code is GPL
   7  *
   8  * $Id: mtdpart.c,v 1.46 2004/07/12 13:28:07 dwmw2 Exp $
   9  *
  10  *      02-21-2002      Thomas Gleixner <gleixner@autronix.de>
  11  *                      added support for read_oob, write_oob
  12  */
  13
  14 #include <linux/module.h>
  15 #include <linux/types.h>
  16 #include <linux/kernel.h>
  17 #include <linux/slab.h>
  18 #include <linux/list.h>
  19 #include <linux/config.h>
  20 #include <linux/kmod.h>
  21 #include <linux/mtd/mtd.h>
  22 #include <linux/mtd/partitions.h>
  23 #include <linux/mtd/compatmac.h>
  24
  25 /* Our partition linked list */
  26 static LIST_HEAD(mtd_partitions);
  27
  28 /* Our partition node structure */
  29 struct mtd_part {
  30         struct mtd_info mtd;
  31         struct mtd_info *master;
  32         u_int32_t offset;
  33         int index;
  34         struct list_head list;
  35         int registered;
  36 };
  37
  38 /*
  39  * Given a pointer to the MTD object in the mtd_part structure, we can retrieve
  40  * the pointer to that structure with this macro.
  41  */
  42 #define PART(x)  ((struct mtd_part *)(x))
  43
  44
  45 /*
  46  * MTD methods which simply translate the effective address and pass through
  47  * to the _real_ device.
  48  */
  49
  50 static int part_read (struct mtd_info *mtd, loff_t from, size_t len,
  51                         size_t *retlen, u_char *buf)
  52 {
  53         struct mtd_part *part = PART(mtd);
  54         if (from >= mtd->size)
  55                 len = 0;
  56         else if (from + len > mtd->size)
  57                 len = mtd->size - from;
  58         if (part->master->read_ecc == NULL)
  59                 return part->master->read (part->master, from + part->offset,
  60                                         len, retlen, buf);
  61         else
  62                 return part->master->read_ecc (part->master, from + part->offset,
  63                                         len, retlen, buf, NULL, &mtd->oobinfo);
  64 }
  65
  66 static int part_point (struct mtd_info *mtd, loff_t from, size_t len,
  67                         size_t *retlen, u_char **buf)
  68 {
  69         struct mtd_part *part = PART(mtd);
  70         if (from >= mtd->size)
  71                 len = 0;
  72         else if (from + len > mtd->size)
  73                 len = mtd->size - from;
  74         return part->master->point (part->master, from + part->offset,
  75                                     len, retlen, buf);
  76 }
  77 static void part_unpoint (struct mtd_info *mtd, u_char *addr, loff_t from, size_t len)
  78 {
  79         struct mtd_part *part = PART(mtd);
  80
  81         part->master->unpoint (part->master, addr, from + part->offset, len);
  82 }
  83
  84
  85 static int part_read_ecc (struct mtd_info *mtd, loff_t from, size_t len,
  86                         size_t *retlen, u_char *buf, u_char *eccbuf, struct nand_oobinfo *oobsel)
  87 {
  88         struct mtd_part *part = PART(mtd);
  89         if (oobsel == NULL)
  90                 oobsel = &mtd->oobinfo;
  91         if (from >= mtd->size)
  92                 len = 0;
  93         else if (from + len > mtd->size)
  94                 len = mtd->size - from;
  95         return part->master->read_ecc (part->master, from + part->offset,
  96                                         len, retlen, buf, eccbuf, oobsel);
  97 }
  98
  99 static int part_read_oob (struct mtd_info *mtd, loff_t from, size_t len,
 100                         size_t *retlen, u_char *buf)
 101 {
 102         struct mtd_part *part = PART(mtd);
 103         if (from >= mtd->size)
 104                 len = 0;
 105         else if (from + len > mtd->size)
 106                 len = mtd->size - from;
 107         return part->master->read_oob (part->master, from + part->offset,
 108                                         len, retlen, buf);
 109 }
 110
 111 static int part_read_user_prot_reg (struct mtd_info *mtd, loff_t from, size_t len,
 112                         size_t *retlen, u_char *buf)
 113 {
 114         struct mtd_part *part = PART(mtd);
 115         return part->master->read_user_prot_reg (part->master, from,
 116                                         len, retlen, buf);
 117 }
 118
 119 static int part_read_fact_prot_reg (struct mtd_info *mtd, loff_t from, size_t len,
 120                         size_t *retlen, u_char *buf)
 121 {
 122         struct mtd_part *part = PART(mtd);
 123         return part->master->read_fact_prot_reg (part->master, from,
 124                                         len, retlen, buf);
 125 }
 126
 127 static int part_write (struct mtd_info *mtd, loff_t to, size_t len,
 128                         size_t *retlen, const u_char *buf)
 129 {
 130         struct mtd_part *part = PART(mtd);
 131         if (!(mtd->flags & MTD_WRITEABLE))
 132                 return -EROFS;
 133         if (to >= mtd->size)
 134                 len = 0;
 135         else if (to + len > mtd->size)
 136                 len = mtd->size - to;
 137         if (part->master->write_ecc == NULL)
 138                 return part->master->write (part->master, to + part->offset,
 139                                         len, retlen, buf);
 140         else
 141                 return part->master->write_ecc (part->master, to + part->offset,
 142                                         len, retlen, buf, NULL, &mtd->oobinfo);
 143
 144 }
 145
 146 static int part_write_ecc (struct mtd_info *mtd, loff_t to, size_t len,
 147                         size_t *retlen, const u_char *buf,
 148                          u_char *eccbuf, struct nand_oobinfo *oobsel)
 149 {
 150         struct mtd_part *part = PART(mtd);
 151         if (!(mtd->flags & MTD_WRITEABLE))
 152                 return -EROFS;
 153         if (oobsel == NULL)
 154                 oobsel = &mtd->oobinfo;
 155         if (to >= mtd->size)
 156                 len = 0;
 157         else if (to + len > mtd->size)
 158                 len = mtd->size - to;
 159         return part->master->write_ecc (part->master, to + part->offset,
 160                                         len, retlen, buf, eccbuf, oobsel);
 161 }
 162
 163 static int part_write_oob (struct mtd_info *mtd, loff_t to, size_t len,
 164                         size_t *retlen, const u_char *buf)
 165 {
 166         struct mtd_part *part = PART(mtd);
 167         if (!(mtd->flags & MTD_WRITEABLE))
 168                 return -EROFS;
 169         if (to >= mtd->size)
 170                 len = 0;
 171         else if (to + len > mtd->size)
 172                 len = mtd->size - to;
 173         return part->master->write_oob (part->master, to + part->offset,
 174                                         len, retlen, buf);
 175 }
 176
 177 static int part_write_user_prot_reg (struct mtd_info *mtd, loff_t from, size_t len,
 178                         size_t *retlen, u_char *buf)
 179 {
 180         struct mtd_part *part = PART(mtd);
 181         return part->master->write_user_prot_reg (part->master, from,
 182                                         len, retlen, buf);
 183 }
 184
 185 static int part_writev (struct mtd_info *mtd,  const struct kvec *vecs,
 186                          unsigned long count, loff_t to, size_t *retlen)
 187 {
 188         struct mtd_part *part = PART(mtd);
 189         if (!(mtd->flags & MTD_WRITEABLE))
 190                 return -EROFS;
 191         if (part->master->writev_ecc == NULL)
 192                 return part->master->writev (part->master, vecs, count,
 193                                         to + part->offset, retlen);
 194         else
 195                 return part->master->writev_ecc (part->master, vecs, count,
 196                                         to + part->offset, retlen,
 197                                         NULL, &mtd->oobinfo);
 198 }
 199
 200 static int part_readv (struct mtd_info *mtd,  struct kvec *vecs,
 201                          unsigned long count, loff_t from, size_t *retlen)
 202 {
 203         struct mtd_part *part = PART(mtd);
 204         if (part->master->readv_ecc == NULL)
 205                 return part->master->readv (part->master, vecs, count,
 206                                         from + part->offset, retlen);
 207         else
 208                 return part->master->readv_ecc (part->master, vecs, count,
 209                                         from + part->offset, retlen,
 210                                         NULL, &mtd->oobinfo);
 211 }
 212
 213 static int part_writev_ecc (struct mtd_info *mtd,  const struct kvec *vecs,
 214                          unsigned long count, loff_t to, size_t *retlen,
 215                          u_char *eccbuf,  struct nand_oobinfo *oobsel)
 216 {
 217         struct mtd_part *part = PART(mtd);
 218         if (!(mtd->flags & MTD_WRITEABLE))
 219                 return -EROFS;
 220         if (oobsel == NULL)
 221                 oobsel = &mtd->oobinfo;
 222         return part->master->writev_ecc (part->master, vecs, count,
 223                                         to + part->offset, retlen,
 224                                         eccbuf, oobsel);
 225 }
 226
 227 static int part_readv_ecc (struct mtd_info *mtd,  struct kvec *vecs,
 228                          unsigned long count, loff_t from, size_t *retlen,
 229                          u_char *eccbuf,  struct nand_oobinfo *oobsel)
 230 {
 231         struct mtd_part *part = PART(mtd);
 232         if (oobsel == NULL)
 233                 oobsel = &mtd->oobinfo;
 234         return part->master->readv_ecc (part->master, vecs, count,
 235                                         from + part->offset, retlen,
 236                                         eccbuf, oobsel);
 237 }
 238
 239 static int part_erase (struct mtd_info *mtd, struct erase_info *instr)
 240 {
 241         struct mtd_part *part = PART(mtd);
 242         int ret;
 243         if (!(mtd->flags & MTD_WRITEABLE))
 244                 return -EROFS;
 245         if (instr->addr >= mtd->size)
 246                 return -EINVAL;
 247         instr->addr += part->offset;
 248         ret = part->master->erase(part->master, instr);
 249         if (instr->fail_addr != 0xffffffff)
 250                 instr->fail_addr -= part->offset;
 251         return ret;
 252 }
 253
 254 static int part_lock (struct mtd_info *mtd, loff_t ofs, size_t len)
 255 {
 256         struct mtd_part *part = PART(mtd);
 257         if ((len + ofs) > mtd->size)
 258                 return -EINVAL;
 259         return part->master->lock(part->master, ofs + part->offset, len);
 260 }
 261
 262 static int part_unlock (struct mtd_info *mtd, loff_t ofs, size_t len)
 263 {
 264         struct mtd_part *part = PART(mtd);
 265         if ((len + ofs) > mtd->size)
 266                 return -EINVAL;
 267         return part->master->unlock(part->master, ofs + part->offset, len);
 268 }
 269
 270 static void part_sync(struct mtd_info *mtd)
 271 {
 272         struct mtd_part *part = PART(mtd);
 273         part->master->sync(part->master);
 274 }
 275
 276 static int part_suspend(struct mtd_info *mtd)
 277 {
 278         struct mtd_part *part = PART(mtd);
 279         return part->master->suspend(part->master);
 280 }
 281
 282 static void part_resume(struct mtd_info *mtd)
 283 {
 284         struct mtd_part *part = PART(mtd);
 285         part->master->resume(part->master);
 286 }
 287
 288 static int part_block_isbad (struct mtd_info *mtd, loff_t ofs)
 289 {
 290         struct mtd_part *part = PART(mtd);
 291         if (ofs >= mtd->size)
 292                 return -EINVAL;
 293         ofs += part->offset;
 294         return part->master->block_isbad(part->master, ofs);
 295 }
 296
 297 static int part_block_markbad (struct mtd_info *mtd, loff_t ofs)
 298 {
 299         struct mtd_part *part = PART(mtd);
 300         if (!(mtd->flags & MTD_WRITEABLE))
 301                 return -EROFS;
 302         if (ofs >= mtd->size)
 303                 return -EINVAL;
 304         ofs += part->offset;
 305         return part->master->block_markbad(part->master, ofs);
 306 }
 307
 308 /*
 309  * This function unregisters and destroy all slave MTD objects which are
 310  * attached to the given master MTD object.
 311  */
 312
 313 int del_mtd_partitions(struct mtd_info *master)
 314 {
 315         struct list_head *node;
 316         struct mtd_part *slave;
 317
 318         for (node = mtd_partitions.next;
 319              node != &mtd_partitions;
 320              node = node->next) {
 321                 slave = list_entry(node, struct mtd_part, list);
 322                 if (slave->master == master) {
 323                         struct list_head *prev = node->prev;
 324                         __list_del(prev, node->next);
 325                         if(slave->registered)
 326                                 del_mtd_device(&slave->mtd);
 327                         kfree(slave);
 328                         node = prev;
 329                 }
 330         }
 331
 332         return 0;
 333 }
 334
 335 /*
 336  * This function, given a master MTD object and a partition table, creates
 337  * and registers slave MTD objects which are bound to the master according to
 338  * the partition definitions.
 339  * (Q: should we register the master MTD object as well?)
 340  */
 341
 342 int add_mtd_partitions(struct mtd_info *master,
 343                        const struct mtd_partition *parts,
 344                        int nbparts)
 345 {
 346         struct mtd_part *slave;
 347         u_int32_t cur_offset = 0;
 348         int i;
 349
 350         printk (KERN_NOTICE "Creating %d MTD partitions on \"%s\":\n", nbparts, master->name);
 351
 352         for (i = 0; i < nbparts; i++) {
 353
 354                 /* allocate the partition structure */
 355                 slave = kmalloc (sizeof(*slave), GFP_KERNEL);
 356                 if (!slave) {
 357                         printk ("memory allocation error while creating partitions for \"%s\"\n",
 358                                 master->name);
 359                         del_mtd_partitions(master);
 360                         return -ENOMEM;
 361                 }
 362                 memset(slave, 0, sizeof(*slave));
 363                 list_add(&slave->list, &mtd_partitions);
 364
 365                 /* set up the MTD object for this partition */
 366                 slave->mtd.type = master->type;
 367                 slave->mtd.flags = master->flags & ~parts[i].mask_flags;
 368                 slave->mtd.size = parts[i].size;
 369                 slave->mtd.oobblock = master->oobblock;
 370                 slave->mtd.oobsize = master->oobsize;
 371                 slave->mtd.ecctype = master->ecctype;
 372                 slave->mtd.eccsize = master->eccsize;
 373
 374                 slave->mtd.name = parts[i].name;
 375                 slave->mtd.bank_size = master->bank_size;
 376                 slave->mtd.owner = master->owner;
 377
 378                 slave->mtd.read = part_read;
 379                 slave->mtd.write = part_write;
 380
 381                 if(master->point && master->unpoint){
 382                         slave->mtd.point = part_point;
 383                         slave->mtd.unpoint = part_unpoint;
 384                 }
 385
 386                 if (master->read_ecc)
 387                         slave->mtd.read_ecc = part_read_ecc;
 388                 if (master->write_ecc)
 389                         slave->mtd.write_ecc = part_write_ecc;
 390                 if (master->read_oob)
 391                         slave->mtd.read_oob = part_read_oob;
 392                 if (master->write_oob)
 393                         slave->mtd.write_oob = part_write_oob;
 394                 if(master->read_user_prot_reg)
 395                         slave->mtd.read_user_prot_reg = part_read_user_prot_reg;
 396                 if(master->read_fact_prot_reg)
 397                         slave->mtd.read_fact_prot_reg = part_read_fact_prot_reg;
 398                 if(master->write_user_prot_reg)
 399                         slave->mtd.write_user_prot_reg = part_write_user_prot_reg;
 400                 if (master->sync)
 401                         slave->mtd.sync = part_sync;
 402                 if (!i && master->suspend && master->resume) {
 403                                 slave->mtd.suspend = part_suspend;
 404                                 slave->mtd.resume = part_resume;
 405                 }
 406                 if (master->writev)
 407                         slave->mtd.writev = part_writev;
 408                 if (master->readv)
 409                         slave->mtd.readv = part_readv;
 410                 if (master->writev_ecc)
 411                         slave->mtd.writev_ecc = part_writev_ecc;
 412                 if (master->readv_ecc)
 413                         slave->mtd.readv_ecc = part_readv_ecc;
 414                 if (master->lock)
 415                         slave->mtd.lock = part_lock;
 416                 if (master->unlock)
 417                         slave->mtd.unlock = part_unlock;
 418                 if (master->block_isbad)
 419                         slave->mtd.block_isbad = part_block_isbad;
 420                 if (master->block_markbad)
 421                         slave->mtd.block_markbad = part_block_markbad;
 422                 slave->mtd.erase = part_erase;
 423                 slave->master = master;
 424                 slave->offset = parts[i].offset;
 425                 slave->index = i;
 426
 427                 if (slave->offset == MTDPART_OFS_APPEND)
 428                         slave->offset = cur_offset;
 429                 if (slave->offset == MTDPART_OFS_NXTBLK) {
 430                         u_int32_t emask = master->erasesize-1;
 431                         slave->offset = (cur_offset + emask) & ~emask;
 432                         if (slave->offset != cur_offset) {
 433                                 printk(KERN_NOTICE "Moving partition %d: "
 434                                        "0x%08x -> 0x%08x\n", i,
 435                                        cur_offset, slave->offset);
 436                         }
 437                 }
 438                 if (slave->mtd.size == MTDPART_SIZ_FULL)
 439                         slave->mtd.size = master->size - slave->offset;
 440                 cur_offset = slave->offset + slave->mtd.size;
 441
 442                 printk (KERN_NOTICE "0x%08x-0x%08x : \"%s\"\n", slave->offset,
 443                         slave->offset + slave->mtd.size, slave->mtd.name);
 444
 445                 /* let's do some sanity checks */
 446                 if (slave->offset >= master->size) {
 447                                 /* let's register it anyway to preserve ordering */
 448                         slave->offset = 0;
 449                         slave->mtd.size = 0;
 450                         printk ("mtd: partition \"%s\" is out of reach -- disabled\n",
 451                                 parts[i].name);
 452                 }
 453                 if (slave->offset + slave->mtd.size > master->size) {
 454                         slave->mtd.size = master->size - slave->offset;
 455                         printk ("mtd: partition \"%s\" extends beyond the end of device \"%s\" -- size truncated to %#x\n",
 456                                 parts[i].name, master->name, slave->mtd.size);
 457                 }
 458                 if (master->numeraseregions>1) {
 459                         /* Deal with variable erase size stuff */
 460                         int i;
 461                         struct mtd_erase_region_info *regions = master->eraseregions;
 462
 463                         /* Find the first erase regions which is part of this partition. */
 464                         for (i=0; i < master->numeraseregions && slave->offset >= regions[i].offset; i++)
 465                                 ;
 466
 467                         for (i--; i < master->numeraseregions && slave->offset + slave->mtd.size > regions[i].offset; i++) {
 468                                 if (slave->mtd.erasesize < regions[i].erasesize) {
 469                                         slave->mtd.erasesize = regions[i].erasesize;
 470                                 }
 471                         }
 472                 } else {
 473                         /* Single erase size */
 474                         slave->mtd.erasesize = master->erasesize;
 475                 }
 476
 477                 if ((slave->mtd.flags & MTD_WRITEABLE) &&
 478                     (slave->offset % slave->mtd.erasesize)) {
 479                         /* Doesn't start on a boundary of major erase size */
 480                         /* FIXME: Let it be writable if it is on a boundary of _minor_ erase size though */
 481                         slave->mtd.flags &= ~MTD_WRITEABLE;
 482                         printk ("mtd: partition \"%s\" doesn't start on an erase block boundary -- force read-only\n",
 483                                 parts[i].name);
 484                 }
 485                 if ((slave->mtd.flags & MTD_WRITEABLE) &&
 486                     (slave->mtd.size % slave->mtd.erasesize)) {
 487                         slave->mtd.flags &= ~MTD_WRITEABLE;
 488                         printk ("mtd: partition \"%s\" doesn't end on an erase block -- force read-only\n",
 489                                 parts[i].name);
 490                 }
 491
 492                 /* copy oobinfo from master */
 493                 memcpy(&slave->mtd.oobinfo, &master->oobinfo, sizeof(slave->mtd.oobinfo));
 494
 495                 if(parts[i].mtdp)
 496                 {       /* store the object pointer (caller may or may not register it */
 497                         *parts[i].mtdp = &slave->mtd;
 498                         slave->registered = 0;
 499                 }
 500                 else
 501                 {
 502                         /* register our partition */
 503                         add_mtd_device(&slave->mtd);
 504                         slave->registered = 1;
 505                 }
 506         }
 507
 508         return 0;
 509 }
 510
 511 EXPORT_SYMBOL(add_mtd_partitions);
 512 EXPORT_SYMBOL(del_mtd_partitions);
 513
 514 static spinlock_t part_parser_lock = SPIN_LOCK_UNLOCKED;
 515 static LIST_HEAD(part_parsers);
 516
 517 struct mtd_part_parser *get_partition_parser(const char *name)
 518 {
 519         struct list_head *this;
 520         void *ret = NULL;
 521         spin_lock(&part_parser_lock);
 522
 523         list_for_each(this, &part_parsers) {
 524                 struct mtd_part_parser *p = list_entry(this, struct mtd_part_parser, list);
 525
 526                 if (!strcmp(p->name, name) && try_module_get(p->owner)) {
 527                         ret = p;
 528                         break;
 529                 }
 530         }
 531         spin_unlock(&part_parser_lock);
 532
 533         return ret;
 534 }
 535
 536 int register_mtd_parser(struct mtd_part_parser *p)
 537 {
 538         spin_lock(&part_parser_lock);
 539         list_add(&p->list, &part_parsers);
 540         spin_unlock(&part_parser_lock);
 541
 542         return 0;
 543 }
 544
 545 int deregister_mtd_parser(struct mtd_part_parser *p)
 546 {
 547         spin_lock(&part_parser_lock);
 548         list_del(&p->list);
 549         spin_unlock(&part_parser_lock);
 550         return 0;
 551 }
 552
 553 int parse_mtd_partitions(struct mtd_info *master, const char **types,
 554                          struct mtd_partition **pparts, unsigned long origin)
 555 {
 556         struct mtd_part_parser *parser;
 557         int ret = 0;
 558
 559         for ( ; ret <= 0 && *types; types++) {
 560                 parser = get_partition_parser(*types);
 561 #ifdef CONFIG_KMOD
 562                 if (!parser && !request_module("%s", *types))
 563                                 parser = get_partition_parser(*types);
 564 #endif
 565                 if (!parser) {
 566                         printk(KERN_NOTICE "%s partition parsing not available\n",
 567                                *types);
 568                         continue;
 569                 }
 570                 ret = (*parser->parse_fn)(master, pparts, origin);
 571                 if (ret > 0) {
 572                         printk(KERN_NOTICE "%d %s partitions found on MTD device %s\n",
 573                                ret, parser->name, master->name);
 574                 }
 575                 put_partition_parser(parser);
 576         }
 577         return ret;
 578 }
 579
 580 EXPORT_SYMBOL_GPL(parse_mtd_partitions);
 581 EXPORT_SYMBOL_GPL(register_mtd_parser);
 582 EXPORT_SYMBOL_GPL(deregister_mtd_parser);
 583
 584 MODULE_LICENSE("GPL");
 585 MODULE_AUTHOR("Nicolas Pitre <nico@cam.org>");
 586 MODULE_DESCRIPTION("Generic support for partitioning of MTD devices");
 587