1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Simple MTD partitioning layer 4 * 5 * Copyright © 2000 Nicolas Pitre <nico@fluxnic.net> 6 * Copyright © 2002 Thomas Gleixner <gleixner@linutronix.de> 7 * Copyright © 2000-2010 David Woodhouse <dwmw2@infradead.org> 8 */ 9 10 #include <linux/module.h> 11 #include <linux/types.h> 12 #include <linux/kernel.h> 13 #include <linux/slab.h> 14 #include <linux/list.h> 15 #include <linux/kmod.h> 16 #include <linux/mtd/mtd.h> 17 #include <linux/mtd/partitions.h> 18 #include <linux/err.h> 19 #include <linux/of.h> 20 #include <linux/of_platform.h> 21 22 #include "mtdcore.h" 23 24 /* 25 * MTD methods which simply translate the effective address and pass through 26 * to the _real_ device. 27 */ 28 29 static inline void free_partition(struct mtd_info *mtd) 30 { 31 kfree(mtd->name); 32 kfree(mtd); 33 } 34 35 static struct mtd_info *allocate_partition(struct mtd_info *parent, 36 const struct mtd_partition *part, 37 int partno, uint64_t cur_offset) 38 { 39 struct mtd_info *master = mtd_get_master(parent); 40 int wr_alignment = (parent->flags & MTD_NO_ERASE) ? 41 master->writesize : master->erasesize; 42 u64 parent_size = mtd_is_partition(parent) ? 43 parent->part.size : parent->size; 44 struct mtd_info *child; 45 u32 remainder; 46 char *name; 47 u64 tmp; 48 49 /* allocate the partition structure */ 50 child = kzalloc(sizeof(*child), GFP_KERNEL); 51 name = kstrdup(part->name, GFP_KERNEL); 52 if (!name || !child) { 53 printk(KERN_ERR"memory allocation error while creating partitions for \"%s\"\n", 54 parent->name); 55 kfree(name); 56 kfree(child); 57 return ERR_PTR(-ENOMEM); 58 } 59 60 /* set up the MTD object for this partition */ 61 child->type = parent->type; 62 child->part.flags = parent->flags & ~part->mask_flags; 63 child->part.flags |= part->add_flags; 64 child->flags = child->part.flags; 65 child->part.size = part->size; 66 child->writesize = parent->writesize; 67 child->writebufsize = parent->writebufsize; 68 child->oobsize = parent->oobsize; 69 child->oobavail = parent->oobavail; 70 child->subpage_sft = parent->subpage_sft; 71 72 child->name = name; 73 child->owner = parent->owner; 74 75 /* NOTE: Historically, we didn't arrange MTDs as a tree out of 76 * concern for showing the same data in multiple partitions. 77 * However, it is very useful to have the master node present, 78 * so the MTD_PARTITIONED_MASTER option allows that. The master 79 * will have device nodes etc only if this is set, so make the 80 * parent conditional on that option. Note, this is a way to 81 * distinguish between the parent and its partitions in sysfs. 82 */ 83 child->dev.parent = IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER) || mtd_is_partition(parent) ? 84 &parent->dev : parent->dev.parent; 85 child->dev.of_node = part->of_node; 86 child->parent = parent; 87 child->part.offset = part->offset; 88 INIT_LIST_HEAD(&child->partitions); 89 90 if (child->part.offset == MTDPART_OFS_APPEND) 91 child->part.offset = cur_offset; 92 if (child->part.offset == MTDPART_OFS_NXTBLK) { 93 tmp = cur_offset; 94 child->part.offset = cur_offset; 95 remainder = do_div(tmp, wr_alignment); 96 if (remainder) { 97 child->part.offset += wr_alignment - remainder; 98 printk(KERN_NOTICE "Moving partition %d: " 99 "0x%012llx -> 0x%012llx\n", partno, 100 (unsigned long long)cur_offset, 101 child->part.offset); 102 } 103 } 104 if (child->part.offset == MTDPART_OFS_RETAIN) { 105 child->part.offset = cur_offset; 106 if (parent_size - child->part.offset >= child->part.size) { 107 child->part.size = parent_size - child->part.offset - 108 child->part.size; 109 } else { 110 printk(KERN_ERR "mtd partition \"%s\" doesn't have enough space: %#llx < %#llx, disabled\n", 111 part->name, parent_size - child->part.offset, 112 child->part.size); 113 /* register to preserve ordering */ 114 goto out_register; 115 } 116 } 117 if (child->part.size == MTDPART_SIZ_FULL) 118 child->part.size = parent_size - child->part.offset; 119 120 printk(KERN_NOTICE "0x%012llx-0x%012llx : \"%s\"\n", 121 child->part.offset, child->part.offset + child->part.size, 122 child->name); 123 124 /* let's do some sanity checks */ 125 if (child->part.offset >= parent_size) { 126 /* let's register it anyway to preserve ordering */ 127 child->part.offset = 0; 128 child->part.size = 0; 129 130 /* Initialize ->erasesize to make add_mtd_device() happy. */ 131 child->erasesize = parent->erasesize; 132 printk(KERN_ERR"mtd: partition \"%s\" is out of reach -- disabled\n", 133 part->name); 134 goto out_register; 135 } 136 if (child->part.offset + child->part.size > parent->size) { 137 child->part.size = parent_size - child->part.offset; 138 printk(KERN_WARNING"mtd: partition \"%s\" extends beyond the end of device \"%s\" -- size truncated to %#llx\n", 139 part->name, parent->name, child->part.size); 140 } 141 142 if (parent->numeraseregions > 1) { 143 /* Deal with variable erase size stuff */ 144 int i, max = parent->numeraseregions; 145 u64 end = child->part.offset + child->part.size; 146 struct mtd_erase_region_info *regions = parent->eraseregions; 147 148 /* Find the first erase regions which is part of this 149 * partition. */ 150 for (i = 0; i < max && regions[i].offset <= child->part.offset; 151 i++) 152 ; 153 /* The loop searched for the region _behind_ the first one */ 154 if (i > 0) 155 i--; 156 157 /* Pick biggest erasesize */ 158 for (; i < max && regions[i].offset < end; i++) { 159 if (child->erasesize < regions[i].erasesize) 160 child->erasesize = regions[i].erasesize; 161 } 162 BUG_ON(child->erasesize == 0); 163 } else { 164 /* Single erase size */ 165 child->erasesize = master->erasesize; 166 } 167 168 /* 169 * Child erasesize might differ from the parent one if the parent 170 * exposes several regions with different erasesize. Adjust 171 * wr_alignment accordingly. 172 */ 173 if (!(child->flags & MTD_NO_ERASE)) 174 wr_alignment = child->erasesize; 175 176 tmp = mtd_get_master_ofs(child, 0); 177 remainder = do_div(tmp, wr_alignment); 178 if ((child->flags & MTD_WRITEABLE) && remainder) { 179 /* Doesn't start on a boundary of major erase size */ 180 /* FIXME: Let it be writable if it is on a boundary of 181 * _minor_ erase size though */ 182 child->flags &= ~MTD_WRITEABLE; 183 printk(KERN_WARNING"mtd: partition \"%s\" doesn't start on an erase/write block boundary -- force read-only\n", 184 part->name); 185 } 186 187 tmp = mtd_get_master_ofs(child, 0) + child->part.size; 188 remainder = do_div(tmp, wr_alignment); 189 if ((child->flags & MTD_WRITEABLE) && remainder) { 190 child->flags &= ~MTD_WRITEABLE; 191 printk(KERN_WARNING"mtd: partition \"%s\" doesn't end on an erase/write block -- force read-only\n", 192 part->name); 193 } 194 195 child->size = child->part.size; 196 child->ecc_step_size = parent->ecc_step_size; 197 child->ecc_strength = parent->ecc_strength; 198 child->bitflip_threshold = parent->bitflip_threshold; 199 200 if (master->_block_isbad) { 201 uint64_t offs = 0; 202 203 while (offs < child->part.size) { 204 if (mtd_block_isreserved(child, offs)) 205 child->ecc_stats.bbtblocks++; 206 else if (mtd_block_isbad(child, offs)) 207 child->ecc_stats.badblocks++; 208 offs += child->erasesize; 209 } 210 } 211 212 out_register: 213 return child; 214 } 215 216 static ssize_t offset_show(struct device *dev, 217 struct device_attribute *attr, char *buf) 218 { 219 struct mtd_info *mtd = dev_get_drvdata(dev); 220 221 return sysfs_emit(buf, "%lld\n", mtd->part.offset); 222 } 223 static DEVICE_ATTR_RO(offset); /* mtd partition offset */ 224 225 static const struct attribute *mtd_partition_attrs[] = { 226 &dev_attr_offset.attr, 227 NULL 228 }; 229 230 static int mtd_add_partition_attrs(struct mtd_info *new) 231 { 232 int ret = sysfs_create_files(&new->dev.kobj, mtd_partition_attrs); 233 if (ret) 234 printk(KERN_WARNING 235 "mtd: failed to create partition attrs, err=%d\n", ret); 236 return ret; 237 } 238 239 int mtd_add_partition(struct mtd_info *parent, const char *name, 240 long long offset, long long length) 241 { 242 struct mtd_info *master = mtd_get_master(parent); 243 u64 parent_size = mtd_is_partition(parent) ? 244 parent->part.size : parent->size; 245 struct mtd_partition part; 246 struct mtd_info *child; 247 int ret = 0; 248 249 /* the direct offset is expected */ 250 if (offset == MTDPART_OFS_APPEND || 251 offset == MTDPART_OFS_NXTBLK) 252 return -EINVAL; 253 254 if (length == MTDPART_SIZ_FULL) 255 length = parent_size - offset; 256 257 if (length <= 0) 258 return -EINVAL; 259 260 memset(&part, 0, sizeof(part)); 261 part.name = name; 262 part.size = length; 263 part.offset = offset; 264 265 child = allocate_partition(parent, &part, -1, offset); 266 if (IS_ERR(child)) 267 return PTR_ERR(child); 268 269 mutex_lock(&master->master.partitions_lock); 270 list_add_tail(&child->part.node, &parent->partitions); 271 mutex_unlock(&master->master.partitions_lock); 272 273 ret = add_mtd_device(child); 274 if (ret) 275 goto err_remove_part; 276 277 mtd_add_partition_attrs(child); 278 279 return 0; 280 281 err_remove_part: 282 mutex_lock(&master->master.partitions_lock); 283 list_del(&child->part.node); 284 mutex_unlock(&master->master.partitions_lock); 285 286 free_partition(child); 287 288 return ret; 289 } 290 EXPORT_SYMBOL_GPL(mtd_add_partition); 291 292 /** 293 * __mtd_del_partition - delete MTD partition 294 * 295 * @mtd: MTD structure to be deleted 296 * 297 * This function must be called with the partitions mutex locked. 298 */ 299 static int __mtd_del_partition(struct mtd_info *mtd) 300 { 301 struct mtd_info *child, *next; 302 int err; 303 304 list_for_each_entry_safe(child, next, &mtd->partitions, part.node) { 305 err = __mtd_del_partition(child); 306 if (err) 307 return err; 308 } 309 310 sysfs_remove_files(&mtd->dev.kobj, mtd_partition_attrs); 311 312 err = del_mtd_device(mtd); 313 if (err) 314 return err; 315 316 list_del(&mtd->part.node); 317 free_partition(mtd); 318 319 return 0; 320 } 321 322 /* 323 * This function unregisters and destroy all slave MTD objects which are 324 * attached to the given MTD object, recursively. 325 */ 326 static int __del_mtd_partitions(struct mtd_info *mtd) 327 { 328 struct mtd_info *child, *next; 329 int ret, err = 0; 330 331 list_for_each_entry_safe(child, next, &mtd->partitions, part.node) { 332 if (mtd_has_partitions(child)) 333 __del_mtd_partitions(child); 334 335 pr_info("Deleting %s MTD partition\n", child->name); 336 ret = del_mtd_device(child); 337 if (ret < 0) { 338 pr_err("Error when deleting partition \"%s\" (%d)\n", 339 child->name, ret); 340 err = ret; 341 continue; 342 } 343 344 list_del(&child->part.node); 345 free_partition(child); 346 } 347 348 return err; 349 } 350 351 int del_mtd_partitions(struct mtd_info *mtd) 352 { 353 struct mtd_info *master = mtd_get_master(mtd); 354 int ret; 355 356 pr_info("Deleting MTD partitions on \"%s\":\n", mtd->name); 357 358 mutex_lock(&master->master.partitions_lock); 359 ret = __del_mtd_partitions(mtd); 360 mutex_unlock(&master->master.partitions_lock); 361 362 return ret; 363 } 364 365 int mtd_del_partition(struct mtd_info *mtd, int partno) 366 { 367 struct mtd_info *child, *master = mtd_get_master(mtd); 368 int ret = -EINVAL; 369 370 mutex_lock(&master->master.partitions_lock); 371 list_for_each_entry(child, &mtd->partitions, part.node) { 372 if (child->index == partno) { 373 ret = __mtd_del_partition(child); 374 break; 375 } 376 } 377 mutex_unlock(&master->master.partitions_lock); 378 379 return ret; 380 } 381 EXPORT_SYMBOL_GPL(mtd_del_partition); 382 383 /* 384 * This function, given a parent MTD object and a partition table, creates 385 * and registers the child MTD objects which are bound to the parent according 386 * to the partition definitions. 387 * 388 * For historical reasons, this function's caller only registers the parent 389 * if the MTD_PARTITIONED_MASTER config option is set. 390 */ 391 392 int add_mtd_partitions(struct mtd_info *parent, 393 const struct mtd_partition *parts, 394 int nbparts) 395 { 396 struct mtd_info *child, *master = mtd_get_master(parent); 397 uint64_t cur_offset = 0; 398 int i, ret; 399 400 printk(KERN_NOTICE "Creating %d MTD partitions on \"%s\":\n", 401 nbparts, parent->name); 402 403 for (i = 0; i < nbparts; i++) { 404 child = allocate_partition(parent, parts + i, i, cur_offset); 405 if (IS_ERR(child)) { 406 ret = PTR_ERR(child); 407 goto err_del_partitions; 408 } 409 410 mutex_lock(&master->master.partitions_lock); 411 list_add_tail(&child->part.node, &parent->partitions); 412 mutex_unlock(&master->master.partitions_lock); 413 414 ret = add_mtd_device(child); 415 if (ret) { 416 mutex_lock(&master->master.partitions_lock); 417 list_del(&child->part.node); 418 mutex_unlock(&master->master.partitions_lock); 419 420 free_partition(child); 421 goto err_del_partitions; 422 } 423 424 mtd_add_partition_attrs(child); 425 426 /* Look for subpartitions */ 427 parse_mtd_partitions(child, parts[i].types, NULL); 428 429 cur_offset = child->part.offset + child->part.size; 430 } 431 432 return 0; 433 434 err_del_partitions: 435 del_mtd_partitions(master); 436 437 return ret; 438 } 439 440 static DEFINE_SPINLOCK(part_parser_lock); 441 static LIST_HEAD(part_parsers); 442 443 static struct mtd_part_parser *mtd_part_parser_get(const char *name) 444 { 445 struct mtd_part_parser *p, *ret = NULL; 446 447 spin_lock(&part_parser_lock); 448 449 list_for_each_entry(p, &part_parsers, list) 450 if (!strcmp(p->name, name) && try_module_get(p->owner)) { 451 ret = p; 452 break; 453 } 454 455 spin_unlock(&part_parser_lock); 456 457 return ret; 458 } 459 460 static inline void mtd_part_parser_put(const struct mtd_part_parser *p) 461 { 462 module_put(p->owner); 463 } 464 465 /* 466 * Many partition parsers just expected the core to kfree() all their data in 467 * one chunk. Do that by default. 468 */ 469 static void mtd_part_parser_cleanup_default(const struct mtd_partition *pparts, 470 int nr_parts) 471 { 472 kfree(pparts); 473 } 474 475 int __register_mtd_parser(struct mtd_part_parser *p, struct module *owner) 476 { 477 p->owner = owner; 478 479 if (!p->cleanup) 480 p->cleanup = &mtd_part_parser_cleanup_default; 481 482 spin_lock(&part_parser_lock); 483 list_add(&p->list, &part_parsers); 484 spin_unlock(&part_parser_lock); 485 486 return 0; 487 } 488 EXPORT_SYMBOL_GPL(__register_mtd_parser); 489 490 void deregister_mtd_parser(struct mtd_part_parser *p) 491 { 492 spin_lock(&part_parser_lock); 493 list_del(&p->list); 494 spin_unlock(&part_parser_lock); 495 } 496 EXPORT_SYMBOL_GPL(deregister_mtd_parser); 497 498 /* 499 * Do not forget to update 'parse_mtd_partitions()' kerneldoc comment if you 500 * are changing this array! 501 */ 502 static const char * const default_mtd_part_types[] = { 503 "cmdlinepart", 504 "ofpart", 505 NULL 506 }; 507 508 /* Check DT only when looking for subpartitions. */ 509 static const char * const default_subpartition_types[] = { 510 "ofpart", 511 NULL 512 }; 513 514 static int mtd_part_do_parse(struct mtd_part_parser *parser, 515 struct mtd_info *master, 516 struct mtd_partitions *pparts, 517 struct mtd_part_parser_data *data) 518 { 519 int ret; 520 521 ret = (*parser->parse_fn)(master, &pparts->parts, data); 522 pr_debug("%s: parser %s: %i\n", master->name, parser->name, ret); 523 if (ret <= 0) 524 return ret; 525 526 pr_notice("%d %s partitions found on MTD device %s\n", ret, 527 parser->name, master->name); 528 529 pparts->nr_parts = ret; 530 pparts->parser = parser; 531 532 return ret; 533 } 534 535 /** 536 * mtd_part_get_compatible_parser - find MTD parser by a compatible string 537 * 538 * @compat: compatible string describing partitions in a device tree 539 * 540 * MTD parsers can specify supported partitions by providing a table of 541 * compatibility strings. This function finds a parser that advertises support 542 * for a passed value of "compatible". 543 */ 544 static struct mtd_part_parser *mtd_part_get_compatible_parser(const char *compat) 545 { 546 struct mtd_part_parser *p, *ret = NULL; 547 548 spin_lock(&part_parser_lock); 549 550 list_for_each_entry(p, &part_parsers, list) { 551 const struct of_device_id *matches; 552 553 matches = p->of_match_table; 554 if (!matches) 555 continue; 556 557 for (; matches->compatible[0]; matches++) { 558 if (!strcmp(matches->compatible, compat) && 559 try_module_get(p->owner)) { 560 ret = p; 561 break; 562 } 563 } 564 565 if (ret) 566 break; 567 } 568 569 spin_unlock(&part_parser_lock); 570 571 return ret; 572 } 573 574 static int mtd_part_of_parse(struct mtd_info *master, 575 struct mtd_partitions *pparts) 576 { 577 struct mtd_part_parser *parser; 578 struct device_node *np; 579 struct device_node *child; 580 struct property *prop; 581 struct device *dev; 582 const char *compat; 583 const char *fixed = "fixed-partitions"; 584 int ret, err = 0; 585 586 dev = &master->dev; 587 /* Use parent device (controller) if the top level MTD is not registered */ 588 if (!IS_ENABLED(CONFIG_MTD_PARTITIONED_MASTER) && !mtd_is_partition(master)) 589 dev = master->dev.parent; 590 591 np = mtd_get_of_node(master); 592 if (mtd_is_partition(master)) 593 of_node_get(np); 594 else 595 np = of_get_child_by_name(np, "partitions"); 596 597 /* 598 * Don't create devices that are added to a bus but will never get 599 * probed. That'll cause fw_devlink to block probing of consumers of 600 * this partition until the partition device is probed. 601 */ 602 for_each_child_of_node(np, child) 603 if (of_device_is_compatible(child, "nvmem-cells")) 604 of_node_set_flag(child, OF_POPULATED); 605 606 of_property_for_each_string(np, "compatible", prop, compat) { 607 parser = mtd_part_get_compatible_parser(compat); 608 if (!parser) 609 continue; 610 ret = mtd_part_do_parse(parser, master, pparts, NULL); 611 if (ret > 0) { 612 of_platform_populate(np, NULL, NULL, dev); 613 of_node_put(np); 614 return ret; 615 } 616 mtd_part_parser_put(parser); 617 if (ret < 0 && !err) 618 err = ret; 619 } 620 of_platform_populate(np, NULL, NULL, dev); 621 of_node_put(np); 622 623 /* 624 * For backward compatibility we have to try the "fixed-partitions" 625 * parser. It supports old DT format with partitions specified as a 626 * direct subnodes of a flash device DT node without any compatibility 627 * specified we could match. 628 */ 629 parser = mtd_part_parser_get(fixed); 630 if (!parser && !request_module("%s", fixed)) 631 parser = mtd_part_parser_get(fixed); 632 if (parser) { 633 ret = mtd_part_do_parse(parser, master, pparts, NULL); 634 if (ret > 0) 635 return ret; 636 mtd_part_parser_put(parser); 637 if (ret < 0 && !err) 638 err = ret; 639 } 640 641 return err; 642 } 643 644 /** 645 * parse_mtd_partitions - parse and register MTD partitions 646 * 647 * @master: the master partition (describes whole MTD device) 648 * @types: names of partition parsers to try or %NULL 649 * @data: MTD partition parser-specific data 650 * 651 * This function tries to find & register partitions on MTD device @master. It 652 * uses MTD partition parsers, specified in @types. However, if @types is %NULL, 653 * then the default list of parsers is used. The default list contains only the 654 * "cmdlinepart" and "ofpart" parsers ATM. 655 * Note: If there are more then one parser in @types, the kernel only takes the 656 * partitions parsed out by the first parser. 657 * 658 * This function may return: 659 * o a negative error code in case of failure 660 * o number of found partitions otherwise 661 */ 662 int parse_mtd_partitions(struct mtd_info *master, const char *const *types, 663 struct mtd_part_parser_data *data) 664 { 665 struct mtd_partitions pparts = { }; 666 struct mtd_part_parser *parser; 667 int ret, err = 0; 668 669 if (!types) 670 types = mtd_is_partition(master) ? default_subpartition_types : 671 default_mtd_part_types; 672 673 for ( ; *types; types++) { 674 /* 675 * ofpart is a special type that means OF partitioning info 676 * should be used. It requires a bit different logic so it is 677 * handled in a separated function. 678 */ 679 if (!strcmp(*types, "ofpart")) { 680 ret = mtd_part_of_parse(master, &pparts); 681 } else { 682 pr_debug("%s: parsing partitions %s\n", master->name, 683 *types); 684 parser = mtd_part_parser_get(*types); 685 if (!parser && !request_module("%s", *types)) 686 parser = mtd_part_parser_get(*types); 687 pr_debug("%s: got parser %s\n", master->name, 688 parser ? parser->name : NULL); 689 if (!parser) 690 continue; 691 ret = mtd_part_do_parse(parser, master, &pparts, data); 692 if (ret <= 0) 693 mtd_part_parser_put(parser); 694 } 695 /* Found partitions! */ 696 if (ret > 0) { 697 err = add_mtd_partitions(master, pparts.parts, 698 pparts.nr_parts); 699 mtd_part_parser_cleanup(&pparts); 700 return err ? err : pparts.nr_parts; 701 } 702 /* 703 * Stash the first error we see; only report it if no parser 704 * succeeds 705 */ 706 if (ret < 0 && !err) 707 err = ret; 708 } 709 return err; 710 } 711 712 void mtd_part_parser_cleanup(struct mtd_partitions *parts) 713 { 714 const struct mtd_part_parser *parser; 715 716 if (!parts) 717 return; 718 719 parser = parts->parser; 720 if (parser) { 721 if (parser->cleanup) 722 parser->cleanup(parts->parts, parts->nr_parts); 723 724 mtd_part_parser_put(parser); 725 } 726 } 727 728 /* Returns the size of the entire flash chip */ 729 uint64_t mtd_get_device_size(const struct mtd_info *mtd) 730 { 731 struct mtd_info *master = mtd_get_master((struct mtd_info *)mtd); 732 733 return master->size; 734 } 735 EXPORT_SYMBOL_GPL(mtd_get_device_size); 736