drivers/mtd/maps/physmap-core.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Normal mappings of chips in physical memory
   4  *
   5  * Copyright (C) 2003 MontaVista Software Inc.
   6  * Author: Jun Sun, [email protected] or [email protected]
   7  *
   8  * 031022 - [jsun] add run-time configure and partition setup
   9  *
  10  * Device tree support:
  11  *    Copyright (C) 2006 MontaVista Software Inc.
  12  *    Author: Vitaly Wool <[email protected]>
  13  *
  14  *    Revised to handle newer style flash binding by:
  15  *    Copyright (C) 2007 David Gibson, IBM Corporation.
  16  *
  17  * GPIO address extension:
  18  *    Handle the case where a flash device is mostly addressed using physical
  19  *    line and supplemented by GPIOs.  This way you can hook up say a 8MiB flash
  20  *    to a 2MiB memory range and use the GPIOs to select a particular range.
  21  *
  22  *    Copyright © 2000 Nicolas Pitre <[email protected]>
  23  *    Copyright © 2005-2009 Analog Devices Inc.
  24  */
  25
  26 #include <linux/module.h>
  27 #include <linux/types.h>
  28 #include <linux/kernel.h>
  29 #include <linux/init.h>
  30 #include <linux/slab.h>
  31 #include <linux/device.h>
  32 #include <linux/platform_device.h>
  33 #include <linux/mtd/mtd.h>
  34 #include <linux/mtd/map.h>
  35 #include <linux/mtd/partitions.h>
  36 #include <linux/mtd/physmap.h>
  37 #include <linux/mtd/concat.h>
  38 #include <linux/mtd/cfi_endian.h>
  39 #include <linux/io.h>
  40 #include <linux/of_device.h>
  41 #include <linux/pm_runtime.h>
  42 #include <linux/gpio/consumer.h>
  43
  44 #include "physmap-bt1-rom.h"
  45 #include "physmap-gemini.h"
  46 #include "physmap-ixp4xx.h"
  47 #include "physmap-versatile.h"
  48
  49 struct physmap_flash_info {
  50         unsigned int            nmaps;
  51         struct mtd_info         **mtds;
  52         struct mtd_info         *cmtd;
  53         struct map_info         *maps;
  54         spinlock_t              vpp_lock;
  55         int                     vpp_refcnt;
  56         const char              *probe_type;
  57         const char * const      *part_types;
  58         unsigned int            nparts;
  59         const struct mtd_partition *parts;
  60         struct gpio_descs       *gpios;
  61         unsigned int            gpio_values;
  62         unsigned int            win_order;
  63 };
  64
  65 static int physmap_flash_remove(struct platform_device *dev)
  66 {
  67         struct physmap_flash_info *info;
  68         struct physmap_flash_data *physmap_data;
  69         int i;
  70
  71         info = platform_get_drvdata(dev);
  72
  73         if (info->cmtd) {
  74                 WARN_ON(mtd_device_unregister(info->cmtd));
  75
  76                 if (info->cmtd != info->mtds[0])
  77                         mtd_concat_destroy(info->cmtd);
  78         }
  79
  80         for (i = 0; i < info->nmaps; i++) {
  81                 if (info->mtds[i])
  82                         map_destroy(info->mtds[i]);
  83         }
  84
  85         physmap_data = dev_get_platdata(&dev->dev);
  86         if (physmap_data && physmap_data->exit)
  87                 physmap_data->exit(dev);
  88
  89         pm_runtime_put(&dev->dev);
  90         pm_runtime_disable(&dev->dev);
  91         return 0;
  92 }
  93
  94 static void physmap_set_vpp(struct map_info *map, int state)
  95 {
  96         struct platform_device *pdev;
  97         struct physmap_flash_data *physmap_data;
  98         struct physmap_flash_info *info;
  99         unsigned long flags;
 100
 101         pdev = (struct platform_device *)map->map_priv_1;
 102         physmap_data = dev_get_platdata(&pdev->dev);
 103
 104         if (!physmap_data->set_vpp)
 105                 return;
 106
 107         info = platform_get_drvdata(pdev);
 108
 109         spin_lock_irqsave(&info->vpp_lock, flags);
 110         if (state) {
 111                 if (++info->vpp_refcnt == 1)    /* first nested 'on' */
 112                         physmap_data->set_vpp(pdev, 1);
 113         } else {
 114                 if (--info->vpp_refcnt == 0)    /* last nested 'off' */
 115                         physmap_data->set_vpp(pdev, 0);
 116         }
 117         spin_unlock_irqrestore(&info->vpp_lock, flags);
 118 }
 119
 120 #if IS_ENABLED(CONFIG_MTD_PHYSMAP_GPIO_ADDR)
 121 static void physmap_set_addr_gpios(struct physmap_flash_info *info,
 122                                    unsigned long ofs)
 123 {
 124         unsigned int i;
 125
 126         ofs >>= info->win_order;
 127         if (info->gpio_values == ofs)
 128                 return;
 129
 130         for (i = 0; i < info->gpios->ndescs; i++) {
 131                 if ((BIT(i) & ofs) == (BIT(i) & info->gpio_values))
 132                         continue;
 133
 134                 gpiod_set_value(info->gpios->desc[i], !!(BIT(i) & ofs));
 135         }
 136
 137         info->gpio_values = ofs;
 138 }
 139
 140 #define win_mask(order)         (BIT(order) - 1)
 141
 142 static map_word physmap_addr_gpios_read(struct map_info *map,
 143                                         unsigned long ofs)
 144 {
 145         struct platform_device *pdev;
 146         struct physmap_flash_info *info;
 147         map_word mw;
 148         u16 word;
 149
 150         pdev = (struct platform_device *)map->map_priv_1;
 151         info = platform_get_drvdata(pdev);
 152         physmap_set_addr_gpios(info, ofs);
 153
 154         word = readw(map->virt + (ofs & win_mask(info->win_order)));
 155         mw.x[0] = word;
 156         return mw;
 157 }
 158
 159 static void physmap_addr_gpios_copy_from(struct map_info *map, void *buf,
 160                                          unsigned long ofs, ssize_t len)
 161 {
 162         struct platform_device *pdev;
 163         struct physmap_flash_info *info;
 164
 165         pdev = (struct platform_device *)map->map_priv_1;
 166         info = platform_get_drvdata(pdev);
 167
 168         while (len) {
 169                 unsigned int winofs = ofs & win_mask(info->win_order);
 170                 unsigned int chunklen = min_t(unsigned int, len,
 171                                               BIT(info->win_order) - winofs);
 172
 173                 physmap_set_addr_gpios(info, ofs);
 174                 memcpy_fromio(buf, map->virt + winofs, chunklen);
 175                 len -= chunklen;
 176                 buf += chunklen;
 177                 ofs += chunklen;
 178         }
 179 }
 180
 181 static void physmap_addr_gpios_write(struct map_info *map, map_word mw,
 182                                      unsigned long ofs)
 183 {
 184         struct platform_device *pdev;
 185         struct physmap_flash_info *info;
 186         u16 word;
 187
 188         pdev = (struct platform_device *)map->map_priv_1;
 189         info = platform_get_drvdata(pdev);
 190         physmap_set_addr_gpios(info, ofs);
 191
 192         word = mw.x[0];
 193         writew(word, map->virt + (ofs & win_mask(info->win_order)));
 194 }
 195
 196 static void physmap_addr_gpios_copy_to(struct map_info *map, unsigned long ofs,
 197                                        const void *buf, ssize_t len)
 198 {
 199         struct platform_device *pdev;
 200         struct physmap_flash_info *info;
 201
 202         pdev = (struct platform_device *)map->map_priv_1;
 203         info = platform_get_drvdata(pdev);
 204
 205         while (len) {
 206                 unsigned int winofs = ofs & win_mask(info->win_order);
 207                 unsigned int chunklen = min_t(unsigned int, len,
 208                                               BIT(info->win_order) - winofs);
 209
 210                 physmap_set_addr_gpios(info, ofs);
 211                 memcpy_toio(map->virt + winofs, buf, chunklen);
 212                 len -= chunklen;
 213                 buf += chunklen;
 214                 ofs += chunklen;
 215         }
 216 }
 217
 218 static int physmap_addr_gpios_map_init(struct map_info *map)
 219 {
 220         map->phys = NO_XIP;
 221         map->read = physmap_addr_gpios_read;
 222         map->copy_from = physmap_addr_gpios_copy_from;
 223         map->write = physmap_addr_gpios_write;
 224         map->copy_to = physmap_addr_gpios_copy_to;
 225
 226         return 0;
 227 }
 228 #else
 229 static int physmap_addr_gpios_map_init(struct map_info *map)
 230 {
 231         return -ENOTSUPP;
 232 }
 233 #endif
 234
 235 #if IS_ENABLED(CONFIG_MTD_PHYSMAP_OF)
 236 static const struct of_device_id of_flash_match[] = {
 237         {
 238                 .compatible = "cfi-flash",
 239                 .data = "cfi_probe",
 240         },
 241         {
 242                 /*
 243                  * FIXME: JEDEC chips can't be safely and reliably
 244                  * probed, although the mtd code gets it right in
 245                  * practice most of the time.  We should use the
 246                  * vendor and device ids specified by the binding to
 247                  * bypass the heuristic probe code, but the mtd layer
 248                  * provides, at present, no interface for doing so
 249                  * :(.
 250                  */
 251                 .compatible = "jedec-flash",
 252                 .data = "jedec_probe",
 253         },
 254         {
 255                 .compatible = "mtd-ram",
 256                 .data = "map_ram",
 257         },
 258         {
 259                 .compatible = "mtd-rom",
 260                 .data = "map_rom",
 261         },
 262         {
 263                 .type = "rom",
 264                 .compatible = "direct-mapped"
 265         },
 266         { /* sentinel */ },
 267 };
 268 MODULE_DEVICE_TABLE(of, of_flash_match);
 269
 270 static const char * const of_default_part_probes[] = {
 271         "cmdlinepart", "RedBoot", "ofpart", "ofoldpart", NULL
 272 };
 273
 274 static const char * const *of_get_part_probes(struct platform_device *dev)
 275 {
 276         struct device_node *dp = dev->dev.of_node;
 277         const char **res;
 278         int count;
 279
 280         count = of_property_count_strings(dp, "linux,part-probe");
 281         if (count < 0)
 282                 return of_default_part_probes;
 283
 284         res = devm_kcalloc(&dev->dev, count + 1, sizeof(*res), GFP_KERNEL);
 285         if (!res)
 286                 return NULL;
 287
 288         count = of_property_read_string_array(dp, "linux,part-probe", res,
 289                                               count);
 290         if (count < 0)
 291                 return NULL;
 292
 293         return res;
 294 }
 295
 296 static const char *of_select_probe_type(struct platform_device *dev)
 297 {
 298         struct device_node *dp = dev->dev.of_node;
 299         const struct of_device_id *match;
 300         const char *probe_type;
 301
 302         match = of_match_device(of_flash_match, &dev->dev);
 303         probe_type = match->data;
 304         if (probe_type)
 305                 return probe_type;
 306
 307         dev_warn(&dev->dev,
 308                  "Device tree uses obsolete \"direct-mapped\" flash binding\n");
 309
 310         of_property_read_string(dp, "probe-type", &probe_type);
 311         if (!probe_type)
 312                 return NULL;
 313
 314         if (!strcmp(probe_type, "CFI")) {
 315                 probe_type = "cfi_probe";
 316         } else if (!strcmp(probe_type, "JEDEC")) {
 317                 probe_type = "jedec_probe";
 318         } else if (!strcmp(probe_type, "ROM")) {
 319                 probe_type = "map_rom";
 320         } else {
 321                 dev_warn(&dev->dev,
 322                          "obsolete_probe: don't know probe type '%s', mapping as rom\n",
 323                          probe_type);
 324                 probe_type = "map_rom";
 325         }
 326
 327         return probe_type;
 328 }
 329
 330 static int physmap_flash_of_init(struct platform_device *dev)
 331 {
 332         struct physmap_flash_info *info = platform_get_drvdata(dev);
 333         struct device_node *dp = dev->dev.of_node;
 334         const char *mtd_name = NULL;
 335         int err, swap = 0;
 336         bool map_indirect;
 337         unsigned int i;
 338         u32 bankwidth;
 339
 340         if (!dp)
 341                 return -EINVAL;
 342
 343         info->probe_type = of_select_probe_type(dev);
 344
 345         info->part_types = of_get_part_probes(dev);
 346         if (!info->part_types)
 347                 return -ENOMEM;
 348
 349         of_property_read_string(dp, "linux,mtd-name", &mtd_name);
 350
 351         map_indirect = of_property_read_bool(dp, "no-unaligned-direct-access");
 352
 353         err = of_property_read_u32(dp, "bank-width", &bankwidth);
 354         if (err) {
 355                 dev_err(&dev->dev, "Can't get bank width from device tree\n");
 356                 return err;
 357         }
 358
 359         if (of_property_read_bool(dp, "big-endian"))
 360                 swap = CFI_BIG_ENDIAN;
 361         else if (of_property_read_bool(dp, "little-endian"))
 362                 swap = CFI_LITTLE_ENDIAN;
 363
 364         for (i = 0; i < info->nmaps; i++) {
 365                 info->maps[i].name = mtd_name;
 366                 info->maps[i].swap = swap;
 367                 info->maps[i].bankwidth = bankwidth;
 368                 info->maps[i].device_node = dp;
 369
 370                 err = of_flash_probe_bt1_rom(dev, dp, &info->maps[i]);
 371                 if (err)
 372                         return err;
 373
 374                 err = of_flash_probe_gemini(dev, dp, &info->maps[i]);
 375                 if (err)
 376                         return err;
 377
 378                 err = of_flash_probe_ixp4xx(dev, dp, &info->maps[i]);
 379                 if (err)
 380                         return err;
 381
 382                 err = of_flash_probe_versatile(dev, dp, &info->maps[i]);
 383                 if (err)
 384                         return err;
 385
 386                 /*
 387                  * On some platforms (e.g. MPC5200) a direct 1:1 mapping
 388                  * may cause problems with JFFS2 usage, as the local bus (LPB)
 389                  * doesn't support unaligned accesses as implemented in the
 390                  * JFFS2 code via memcpy(). By setting NO_XIP, the
 391                  * flash will not be exposed directly to the MTD users
 392                  * (e.g. JFFS2) any more.
 393                  */
 394                 if (map_indirect)
 395                         info->maps[i].phys = NO_XIP;
 396         }
 397
 398         return 0;
 399 }
 400 #else /* IS_ENABLED(CONFIG_MTD_PHYSMAP_OF) */
 401 #define of_flash_match NULL
 402
 403 static int physmap_flash_of_init(struct platform_device *dev)
 404 {
 405         return -ENOTSUPP;
 406 }
 407 #endif /* IS_ENABLED(CONFIG_MTD_PHYSMAP_OF) */
 408
 409 static const char * const rom_probe_types[] = {
 410         "cfi_probe", "jedec_probe", "qinfo_probe", "map_rom",
 411 };
 412
 413 static const char * const part_probe_types[] = {
 414         "cmdlinepart", "RedBoot", "afs", NULL
 415 };
 416
 417 static int physmap_flash_pdata_init(struct platform_device *dev)
 418 {
 419         struct physmap_flash_info *info = platform_get_drvdata(dev);
 420         struct physmap_flash_data *physmap_data;
 421         unsigned int i;
 422         int err;
 423
 424         physmap_data = dev_get_platdata(&dev->dev);
 425         if (!physmap_data)
 426                 return -EINVAL;
 427
 428         info->probe_type = physmap_data->probe_type;
 429         info->part_types = physmap_data->part_probe_types ? : part_probe_types;
 430         info->parts = physmap_data->parts;
 431         info->nparts = physmap_data->nr_parts;
 432
 433         if (physmap_data->init) {
 434                 err = physmap_data->init(dev);
 435                 if (err)
 436                         return err;
 437         }
 438
 439         for (i = 0; i < info->nmaps; i++) {
 440                 info->maps[i].bankwidth = physmap_data->width;
 441                 info->maps[i].pfow_base = physmap_data->pfow_base;
 442                 info->maps[i].set_vpp = physmap_set_vpp;
 443         }
 444
 445         return 0;
 446 }
 447
 448 static int physmap_flash_probe(struct platform_device *dev)
 449 {
 450         struct physmap_flash_info *info;
 451         int err = 0;
 452         int i;
 453
 454         if (!dev->dev.of_node && !dev_get_platdata(&dev->dev))
 455                 return -EINVAL;
 456
 457         info = devm_kzalloc(&dev->dev, sizeof(*info), GFP_KERNEL);
 458         if (!info)
 459                 return -ENOMEM;
 460
 461         while (platform_get_resource(dev, IORESOURCE_MEM, info->nmaps))
 462                 info->nmaps++;
 463
 464         if (!info->nmaps)
 465                 return -ENODEV;
 466
 467         info->maps = devm_kzalloc(&dev->dev,
 468                                   sizeof(*info->maps) * info->nmaps,
 469                                   GFP_KERNEL);
 470         if (!info->maps)
 471                 return -ENOMEM;
 472
 473         info->mtds = devm_kzalloc(&dev->dev,
 474                                   sizeof(*info->mtds) * info->nmaps,
 475                                   GFP_KERNEL);
 476         if (!info->mtds)
 477                 return -ENOMEM;
 478
 479         platform_set_drvdata(dev, info);
 480
 481         info->gpios = devm_gpiod_get_array_optional(&dev->dev, "addr",
 482                                                     GPIOD_OUT_LOW);
 483         if (IS_ERR(info->gpios))
 484                 return PTR_ERR(info->gpios);
 485
 486         if (info->gpios && info->nmaps > 1) {
 487                 dev_err(&dev->dev, "addr-gpios only supported for nmaps == 1\n");
 488                 return -EINVAL;
 489         }
 490
 491         pm_runtime_enable(&dev->dev);
 492         pm_runtime_get_sync(&dev->dev);
 493
 494         if (dev->dev.of_node)
 495                 err = physmap_flash_of_init(dev);
 496         else
 497                 err = physmap_flash_pdata_init(dev);
 498
 499         if (err) {
 500                 pm_runtime_put(&dev->dev);
 501                 pm_runtime_disable(&dev->dev);
 502                 return err;
 503         }
 504
 505         for (i = 0; i < info->nmaps; i++) {
 506                 struct resource *res;
 507
 508                 res = platform_get_resource(dev, IORESOURCE_MEM, i);
 509                 info->maps[i].virt = devm_ioremap_resource(&dev->dev, res);
 510                 if (IS_ERR(info->maps[i].virt)) {
 511                         err = PTR_ERR(info->maps[i].virt);
 512                         goto err_out;
 513                 }
 514
 515                 dev_notice(&dev->dev, "physmap platform flash device: %pR\n",
 516                            res);
 517
 518                 if (!info->maps[i].name)
 519                         info->maps[i].name = dev_name(&dev->dev);
 520
 521                 if (!info->maps[i].phys)
 522                         info->maps[i].phys = res->start;
 523
 524                 info->win_order = get_bitmask_order(resource_size(res)) - 1;
 525                 info->maps[i].size = BIT(info->win_order +
 526                                          (info->gpios ?
 527                                           info->gpios->ndescs : 0));
 528
 529                 info->maps[i].map_priv_1 = (unsigned long)dev;
 530
 531                 if (info->gpios) {
 532                         err = physmap_addr_gpios_map_init(&info->maps[i]);
 533                         if (err)
 534                                 goto err_out;
 535                 }
 536
 537 #ifdef CONFIG_MTD_COMPLEX_MAPPINGS
 538                 /*
 539                  * Only use the simple_map implementation if map hooks are not
 540                  * implemented. Since map->read() is mandatory checking for its
 541                  * presence is enough.
 542                  */
 543                 if (!info->maps[i].read)
 544                         simple_map_init(&info->maps[i]);
 545 #else
 546                 simple_map_init(&info->maps[i]);
 547 #endif
 548
 549                 if (info->probe_type) {
 550                         info->mtds[i] = do_map_probe(info->probe_type,
 551                                                      &info->maps[i]);
 552                 } else {
 553                         int j;
 554
 555                         for (j = 0; j < ARRAY_SIZE(rom_probe_types); j++) {
 556                                 info->mtds[i] = do_map_probe(rom_probe_types[j],
 557                                                              &info->maps[i]);
 558                                 if (info->mtds[i])
 559                                         break;
 560                         }
 561                 }
 562
 563                 if (!info->mtds[i]) {
 564                         dev_err(&dev->dev, "map_probe failed\n");
 565                         err = -ENXIO;
 566                         goto err_out;
 567                 }
 568                 info->mtds[i]->dev.parent = &dev->dev;
 569         }
 570
 571         if (info->nmaps == 1) {
 572                 info->cmtd = info->mtds[0];
 573         } else {
 574                 /*
 575                  * We detected multiple devices. Concatenate them together.
 576                  */
 577                 info->cmtd = mtd_concat_create(info->mtds, info->nmaps,
 578                                                dev_name(&dev->dev));
 579                 if (!info->cmtd)
 580                         err = -ENXIO;
 581         }
 582         if (err)
 583                 goto err_out;
 584
 585         spin_lock_init(&info->vpp_lock);
 586
 587         mtd_set_of_node(info->cmtd, dev->dev.of_node);
 588         err = mtd_device_parse_register(info->cmtd, info->part_types, NULL,
 589                                         info->parts, info->nparts);
 590         if (err)
 591                 goto err_out;
 592
 593         return 0;
 594
 595 err_out:
 596         physmap_flash_remove(dev);
 597         return err;
 598 }
 599
 600 #ifdef CONFIG_PM
 601 static void physmap_flash_shutdown(struct platform_device *dev)
 602 {
 603         struct physmap_flash_info *info = platform_get_drvdata(dev);
 604         int i;
 605
 606         for (i = 0; i < info->nmaps && info->mtds[i]; i++)
 607                 if (mtd_suspend(info->mtds[i]) == 0)
 608                         mtd_resume(info->mtds[i]);
 609 }
 610 #else
 611 #define physmap_flash_shutdown NULL
 612 #endif
 613
 614 static struct platform_driver physmap_flash_driver = {
 615         .probe          = physmap_flash_probe,
 616         .remove         = physmap_flash_remove,
 617         .shutdown       = physmap_flash_shutdown,
 618         .driver         = {
 619                 .name   = "physmap-flash",
 620                 .of_match_table = of_flash_match,
 621         },
 622 };
 623
 624 #ifdef CONFIG_MTD_PHYSMAP_COMPAT
 625 static struct physmap_flash_data physmap_flash_data = {
 626         .width          = CONFIG_MTD_PHYSMAP_BANKWIDTH,
 627 };
 628
 629 static struct resource physmap_flash_resource = {
 630         .start          = CONFIG_MTD_PHYSMAP_START,
 631         .end            = CONFIG_MTD_PHYSMAP_START + CONFIG_MTD_PHYSMAP_LEN - 1,
 632         .flags          = IORESOURCE_MEM,
 633 };
 634
 635 static struct platform_device physmap_flash = {
 636         .name           = "physmap-flash",
 637         .id             = 0,
 638         .dev            = {
 639                 .platform_data  = &physmap_flash_data,
 640         },
 641         .num_resources  = 1,
 642         .resource       = &physmap_flash_resource,
 643 };
 644 #endif
 645
 646 static int __init physmap_init(void)
 647 {
 648         int err;
 649
 650         err = platform_driver_register(&physmap_flash_driver);
 651 #ifdef CONFIG_MTD_PHYSMAP_COMPAT
 652         if (err == 0) {
 653                 err = platform_device_register(&physmap_flash);
 654                 if (err)
 655                         platform_driver_unregister(&physmap_flash_driver);
 656         }
 657 #endif
 658
 659         return err;
 660 }
 661
 662 static void __exit physmap_exit(void)
 663 {
 664 #ifdef CONFIG_MTD_PHYSMAP_COMPAT
 665         platform_device_unregister(&physmap_flash);
 666 #endif
 667         platform_driver_unregister(&physmap_flash_driver);
 668 }
 669
 670 module_init(physmap_init);
 671 module_exit(physmap_exit);
 672
 673 MODULE_LICENSE("GPL");
 674 MODULE_AUTHOR("David Woodhouse <[email protected]>");
 675 MODULE_AUTHOR("Vitaly Wool <[email protected]>");
 676 MODULE_AUTHOR("Mike Frysinger <[email protected]>");
 677 MODULE_DESCRIPTION("Generic configurable MTD map driver");
 678
 679 /* legacy platform drivers can't hotplug or coldplg */
 680 #ifndef CONFIG_MTD_PHYSMAP_COMPAT
 681 /* work with hotplug and coldplug */
 682 MODULE_ALIAS("platform:physmap-flash");
 683 #endif