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