target/linux/adm5120/files/drivers/mtd/maps/adm5120-flash.c

   1 /*
   2  *  $Id$
   3  *
   4  *  Platform driver for NOR flash devices on ADM5120 based boards
   5  *
   6  *  Copyright (C) 2007 OpenWrt.org
   7  *  Copyright (C) 2007 Gabor Juhos <juhosg at openwrt.org>
   8  *
   9  *  This file was derived from: drivers/mtd/map/physmap.c
  10  *      Copyright (C) 2003 MontaVista Software Inc.
  11  *      Author: Jun Sun, jsun@mvista.com or jsun@junsun.net
  12  *
  13  *  This program is free software; you can redistribute it and/or
  14  *  modify it under the terms of the GNU General Public License
  15  *  as published by the Free Software Foundation; either version 2
  16  *  of the License, or (at your option) any later version.
  17  *
  18  *  This program is distributed in the hope that it will be useful,
  19  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  *  GNU General Public License for more details.
  22  *
  23  *  You should have received a copy of the GNU General Public License
  24  *  along with this program; if not, write to the
  25  *  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  26  *  Boston, MA  02110-1301, USA.
  27  *
  28  */
  29
  30 #include <linux/module.h>
  31 #include <linux/types.h>
  32 #include <linux/kernel.h>
  33 #include <linux/init.h>
  34 #include <linux/slab.h>
  35 #include <linux/io.h>
  36 #include <linux/device.h>
  37 #include <linux/platform_device.h>
  38
  39 #include <linux/mtd/mtd.h>
  40 #include <linux/mtd/map.h>
  41 #include <linux/mtd/partitions.h>
  42
  43 #include <adm5120_defs.h>
  44 #include <adm5120_switch.h>
  45 #include <adm5120_mpmc.h>
  46 #include <adm5120_platform.h>
  47
  48 #define DRV_NAME        "adm5120-flash"
  49 #define DRV_DESC        "ADM5120 flash MAP driver"
  50 #define MAX_PARSED_PARTS 8
  51
  52 #ifdef ADM5120_FLASH_DEBUG
  53 #define MAP_DBG(m, f, a...)     printk(KERN_INFO "%s: " f, (m->name) , ## a)
  54 #else
  55 #define MAP_DBG(m, f, a...)     do {} while (0)
  56 #endif
  57 #define MAP_ERR(m, f, a...)     printk(KERN_ERR "%s: " f, (m->name) , ## a)
  58 #define MAP_INFO(m, f, a...)    printk(KERN_INFO "%s: " f, (m->name) , ## a)
  59
  60 struct adm5120_map_info {
  61         struct map_info map;
  62         void            (*switch_bank)(unsigned);
  63         unsigned long   window_size;
  64 };
  65
  66 struct adm5120_flash_info {
  67         struct mtd_info         *mtd;
  68         struct resource         *res;
  69         struct platform_device  *dev;
  70         struct adm5120_map_info amap;
  71 #ifdef CONFIG_MTD_PARTITIONS
  72         int                     nr_parts;
  73         struct mtd_partition    *parts[MAX_PARSED_PARTS];
  74 #endif
  75 };
  76
  77 struct flash_desc {
  78         u32     phys;
  79         u32     srs_shift;
  80 };
  81
  82 /*
  83  * Globals
  84  */
  85 static DEFINE_SPINLOCK(adm5120_flash_spin);
  86 #define FLASH_LOCK()    spin_lock(&adm5120_flash_spin)
  87 #define FLASH_UNLOCK()  spin_unlock(&adm5120_flash_spin)
  88
  89 static u32 flash_bankwidths[4] = { 1, 2, 4, 0 };
  90
  91 static u32 flash_sizes[8] = {
  92         0, 512*1024, 1024*1024, 2*1024*1024,
  93         4*1024*1024, 0, 0, 0
  94 };
  95
  96 static struct flash_desc flash_descs[2] = {
  97         {
  98                 .phys           = ADM5120_SRAM0_BASE,
  99                 .srs_shift      = MEMCTRL_SRS0_SHIFT,
 100         }, {
 101                 .phys           = ADM5120_SRAM1_BASE,
 102                 .srs_shift      = MEMCTRL_SRS1_SHIFT,
 103         }
 104 };
 105
 106 static const char *probe_types[] = {
 107         "cfi_probe",
 108         "jedec_probe",
 109         "map_rom",
 110         NULL
 111 };
 112
 113 #ifdef CONFIG_MTD_PARTITIONS
 114 static const char *parse_types[] = {
 115         "cmdlinepart",
 116 #ifdef CONFIG_MTD_REDBOOT_PARTS
 117         "RedBoot",
 118 #endif
 119 #ifdef CONFIG_MTD_MYLOADER_PARTS
 120         "MyLoader",
 121 #endif
 122 };
 123 #endif
 124
 125 #define BANK_SIZE       (2<<20)
 126 #define BANK_SIZE_MAX   (4<<20)
 127 #define BANK_OFFS_MASK  (BANK_SIZE-1)
 128 #define BANK_START_MASK (~BANK_OFFS_MASK)
 129
 130 static inline struct adm5120_map_info *map_to_amap(struct map_info *map)
 131 {
 132         return (struct adm5120_map_info *)map;
 133 }
 134
 135 static void adm5120_flash_switchbank(struct map_info *map,
 136                 unsigned long ofs)
 137 {
 138         struct adm5120_map_info *amap = map_to_amap(map);
 139         unsigned bank;
 140
 141         if (amap->switch_bank == NULL)
 142                 return;
 143
 144         bank = (ofs & BANK_START_MASK) >> 21;
 145         if (bank > 1)
 146                 BUG();
 147
 148         MAP_DBG(map, "switching to bank %u, ofs=%lX\n", bank, ofs);
 149         amap->switch_bank(bank);
 150 }
 151
 152 static map_word adm5120_flash_read(struct map_info *map, unsigned long ofs)
 153 {
 154         struct adm5120_map_info *amap = map_to_amap(map);
 155         map_word ret;
 156
 157         MAP_DBG(map, "reading from ofs %lX\n", ofs);
 158
 159         if (ofs >= amap->window_size)
 160                 return map_word_ff(map);
 161
 162         FLASH_LOCK();
 163         adm5120_flash_switchbank(map, ofs);
 164         ret = inline_map_read(map, (ofs & (amap->window_size-1)));
 165         FLASH_UNLOCK();
 166
 167         return ret;
 168 }
 169
 170 static void adm5120_flash_write(struct map_info *map, const map_word datum,
 171                 unsigned long ofs)
 172 {
 173         struct adm5120_map_info *amap = map_to_amap(map);
 174
 175         MAP_DBG(map, "writing to ofs %lX\n", ofs);
 176
 177         if (ofs > amap->window_size)
 178                 return;
 179
 180         FLASH_LOCK();
 181         adm5120_flash_switchbank(map, ofs);
 182         inline_map_write(map, datum, (ofs & (amap->window_size-1)));
 183         FLASH_UNLOCK();
 184 }
 185
 186 static void adm5120_flash_copy_from(struct map_info *map, void *to,
 187                 unsigned long from, ssize_t len)
 188 {
 189         struct adm5120_map_info *amap = map_to_amap(map);
 190         char *p;
 191         ssize_t t;
 192
 193         MAP_DBG(map, "copy_from, to=%lX, from=%lX, len=%lX\n",
 194                 (unsigned long)to, from, (unsigned long)len);
 195
 196         if (from > amap->window_size)
 197                 return;
 198
 199         p = (char *)to;
 200         while (len > 0) {
 201                 t = len;
 202                 if ((from < BANK_SIZE) && ((from+len) > BANK_SIZE))
 203                         t = BANK_SIZE-from;
 204
 205                 FLASH_LOCK();
 206                 MAP_DBG(map, "copying %lu byte(s) from %lX to %lX\n",
 207                         (unsigned long)t, (from & (amap->window_size-1)),
 208                         (unsigned long)p);
 209                 adm5120_flash_switchbank(map, from);
 210                 inline_map_copy_from(map, p, (from & (amap->window_size-1)), t);
 211                 FLASH_UNLOCK();
 212                 p += t;
 213                 from += t;
 214                 len -= t;
 215         }
 216 }
 217
 218 static int adm5120_flash_initres(struct adm5120_flash_info *info)
 219 {
 220         struct map_info *map = &info->amap.map;
 221         int err = 0;
 222
 223         info->res = request_mem_region(map->phys, info->amap.window_size,
 224                         map->name);
 225         if (info->res == NULL) {
 226                 MAP_ERR(map, "could not reserve memory region\n");
 227                 err = -ENOMEM;
 228                 goto out;
 229         }
 230
 231         map->virt = ioremap_nocache(map->phys, info->amap.window_size);
 232         if (map->virt == NULL) {
 233                 MAP_ERR(map, "failed to ioremap flash region\n");
 234                 err = -ENOMEM;
 235                 goto out;
 236         }
 237
 238 out:
 239         return err;
 240 }
 241
 242 static int adm5120_flash_initinfo(struct adm5120_flash_info *info,
 243                 struct platform_device *dev)
 244 {
 245         struct map_info *map = &info->amap.map;
 246         struct adm5120_flash_platform_data *pdata = dev->dev.platform_data;
 247         struct flash_desc *fdesc;
 248         u32 t = 0;
 249
 250         map->name = dev->dev.bus_id;
 251
 252         if (dev->id > 1) {
 253                 MAP_ERR(map, "invalid flash id\n");
 254                 goto err_out;
 255         }
 256
 257         fdesc = &flash_descs[dev->id];
 258
 259         if (pdata)
 260                 info->amap.window_size = pdata->window_size;
 261
 262         if (info->amap.window_size == 0) {
 263                 /* get memory window size */
 264                 t = SW_READ_REG(SWITCH_REG_MEMCTRL) >> fdesc->srs_shift;
 265                 t &= MEMCTRL_SRS_MASK;
 266                 info->amap.window_size = flash_sizes[t];
 267         }
 268
 269         if (info->amap.window_size == 0) {
 270                 MAP_ERR(map, "unable to determine window size\n");
 271                 goto err_out;
 272         }
 273
 274         /* get flash bus width */
 275         switch (dev->id) {
 276         case 0:
 277                 t = MPMC_READ_REG(SC1) & SC_MW_MASK;
 278                 break;
 279         case 1:
 280                 t = MPMC_READ_REG(SC0) & SC_MW_MASK;
 281                 break;
 282         }
 283         map->bankwidth = flash_bankwidths[t];
 284         if (map->bankwidth == 0) {
 285                 MAP_ERR(map, "invalid bus width detected\n");
 286                 goto err_out;
 287         }
 288
 289         map->phys = fdesc->phys;
 290         map->size = BANK_SIZE_MAX;
 291
 292         simple_map_init(map);
 293         map->read = adm5120_flash_read;
 294         map->write = adm5120_flash_write;
 295         map->copy_from = adm5120_flash_copy_from;
 296
 297         if (pdata) {
 298                 map->set_vpp = pdata->set_vpp;
 299                 info->amap.switch_bank = pdata->switch_bank;
 300         }
 301
 302         info->dev = dev;
 303
 304         MAP_INFO(map, "probing at 0x%lX, size:%ldKiB, width:%d bits\n",
 305                 (unsigned long)map->phys,
 306                 (unsigned long)info->amap.window_size >> 10,
 307                 map->bankwidth*8);
 308
 309         return 0;
 310
 311 err_out:
 312         return -ENODEV;
 313 }
 314
 315 static void adm5120_flash_initbanks(struct adm5120_flash_info *info)
 316 {
 317         struct map_info *map = &info->amap.map;
 318
 319         if (info->mtd->size <= BANK_SIZE)
 320                 /* no bank switching needed */
 321                 return;
 322
 323         if (info->amap.switch_bank) {
 324                 info->amap.window_size = info->mtd->size;
 325                 return;
 326         }
 327
 328         MAP_ERR(map, "reduce visibility from %ldKiB to %ldKiB\n",
 329                 (unsigned long)map->size >> 10,
 330                 (unsigned long)info->mtd->size >> 10);
 331
 332         info->mtd->size = info->amap.window_size;
 333 }
 334
 335 #ifdef CONFIG_MTD_PARTITIONS
 336 static int adm5120_flash_initparts(struct adm5120_flash_info *info)
 337 {
 338         struct adm5120_flash_platform_data *pdata;
 339         struct map_info *map = &info->amap.map;
 340         int num_parsers;
 341         const char *parser[2];
 342         int err = 0;
 343         int nr_parts;
 344         int i;
 345
 346         info->nr_parts = 0;
 347
 348         pdata = info->dev->dev.platform_data;
 349         if (pdata == NULL)
 350                 goto out;
 351
 352         if (pdata->nr_parts) {
 353                 MAP_INFO(map, "adding static partitions\n");
 354                 err = add_mtd_partitions(info->mtd, pdata->parts,
 355                         pdata->nr_parts);
 356                 if (err == 0) {
 357                         info->nr_parts += pdata->nr_parts;
 358                         goto out;
 359                 }
 360         }
 361
 362         num_parsers = ARRAY_SIZE(parse_types);
 363         if (num_parsers > MAX_PARSED_PARTS)
 364                 num_parsers = MAX_PARSED_PARTS;
 365
 366         parser[1] = NULL;
 367         for (i = 0; i < num_parsers; i++) {
 368                 parser[0] = parse_types[i];
 369
 370                 MAP_INFO(map, "parsing \"%s\" partitions\n",
 371                         parser[0]);
 372                 nr_parts = parse_mtd_partitions(info->mtd, parser,
 373                         &info->parts[i], 0);
 374
 375                 if (nr_parts <= 0)
 376                         continue;
 377
 378                 MAP_INFO(map, "adding \"%s\" partitions\n",
 379                         parser[0]);
 380
 381                 err = add_mtd_partitions(info->mtd, info->parts[i], nr_parts);
 382                 if (err)
 383                         break;
 384
 385                 info->nr_parts += nr_parts;
 386         }
 387 out:
 388         return err;
 389 }
 390 #else
 391 static int adm5120_flash_initparts(struct adm5120_flash_info *info)
 392 {
 393         return 0;
 394 }
 395 #endif /* CONFIG_MTD_PARTITIONS */
 396
 397 #ifdef CONFIG_MTD_PARTITIONS
 398 static void adm5120_flash_remove_mtd(struct adm5120_flash_info *info)
 399 {
 400         int i;
 401
 402         if (info->nr_parts) {
 403                 del_mtd_partitions(info->mtd);
 404                 for (i = 0; i < MAX_PARSED_PARTS; i++)
 405                         if (info->parts[i] != NULL)
 406                                 kfree(info->parts[i]);
 407         } else {
 408                 del_mtd_device(info->mtd);
 409         }
 410 }
 411 #else
 412 static void adm5120_flash_remove_mtd(struct adm5120_flash_info *info)
 413 {
 414         del_mtd_device(info->mtd);
 415 }
 416 #endif
 417
 418 static int adm5120_flash_remove(struct platform_device *dev)
 419 {
 420         struct adm5120_flash_info *info;
 421
 422         info = platform_get_drvdata(dev);
 423         if (info == NULL)
 424                 return 0;
 425
 426         platform_set_drvdata(dev, NULL);
 427
 428         if (info->mtd != NULL) {
 429                 adm5120_flash_remove_mtd(info);
 430                 map_destroy(info->mtd);
 431         }
 432
 433         if (info->amap.map.virt != NULL)
 434                 iounmap(info->amap.map.virt);
 435
 436         if (info->res != NULL) {
 437                 release_resource(info->res);
 438                 kfree(info->res);
 439         }
 440
 441         return 0;
 442 }
 443
 444 static int adm5120_flash_probe(struct platform_device *dev)
 445 {
 446         struct adm5120_flash_info *info;
 447         struct map_info *map;
 448         const char **probe_type;
 449         int err;
 450
 451         info = kzalloc(sizeof(*info), GFP_KERNEL);
 452         if (info == NULL) {
 453                 err = -ENOMEM;
 454                 goto err_out;
 455         }
 456
 457         platform_set_drvdata(dev, info);
 458
 459         err = adm5120_flash_initinfo(info, dev);
 460         if (err)
 461                 goto err_out;
 462
 463         err = adm5120_flash_initres(info);
 464         if (err)
 465                 goto err_out;
 466
 467         map = &info->amap.map;
 468         for (probe_type = probe_types; info->mtd == NULL && *probe_type != NULL;
 469                 probe_type++)
 470                 info->mtd = do_map_probe(*probe_type, map);
 471
 472         if (info->mtd == NULL) {
 473                 MAP_ERR(map, "map_probe failed\n");
 474                 err = -ENXIO;
 475                 goto err_out;
 476         }
 477
 478         adm5120_flash_initbanks(info);
 479
 480         if (info->mtd->size < info->amap.window_size) {
 481                 /* readjust resources */
 482                 iounmap(map->virt);
 483                 release_resource(info->res);
 484                 kfree(info->res);
 485
 486                 info->amap.window_size = info->mtd->size;
 487                 map->size = info->mtd->size;
 488                 MAP_INFO(map, "reducing map size to %ldKiB\n",
 489                         (unsigned long)map->size >> 10);
 490                 err = adm5120_flash_initres(info);
 491                 if (err)
 492                         goto err_out;
 493         }
 494
 495         MAP_INFO(map, "found at 0x%lX, size:%ldKiB, width:%d bits\n",
 496                 (unsigned long)map->phys, (unsigned long)info->mtd->size >> 10,
 497                 map->bankwidth*8);
 498
 499         info->mtd->owner = THIS_MODULE;
 500
 501         err = adm5120_flash_initparts(info);
 502         if (err)
 503                 goto err_out;
 504
 505         if (info->nr_parts == 0) {
 506                 MAP_INFO(map, "no partitions available, registering "
 507                         "whole flash\n");
 508                 add_mtd_device(info->mtd);
 509         }
 510
 511         return 0;
 512
 513 err_out:
 514         adm5120_flash_remove(dev);
 515         return err;
 516 }
 517
 518 #ifdef CONFIG_PM
 519 static int adm5120_flash_suspend(struct platform_device *dev,
 520                 pm_message_t state)
 521 {
 522         struct adm5120_flash_info *info = platform_get_drvdata(dev);
 523         int ret = 0;
 524
 525         if (info)
 526                 ret = info->mtd->suspend(info->mtd);
 527
 528         return ret;
 529 }
 530
 531 static int adm5120_flash_resume(struct platform_device *dev)
 532 {
 533         struct adm5120_flash_info *info = platform_get_drvdata(dev);
 534
 535         if (info)
 536                 info->mtd->resume(info->mtd);
 537
 538         return 0;
 539 }
 540
 541 static void adm5120_flash_shutdown(struct platform_device *dev)
 542 {
 543         struct adm5120_flash_info *info = platform_get_drvdata(dev);
 544
 545         if (info && info->mtd->suspend(info->mtd) == 0)
 546                 info->mtd->resume(info->mtd);
 547 }
 548 #endif
 549
 550 static struct platform_driver adm5120_flash_driver = {
 551         .probe          = adm5120_flash_probe,
 552         .remove         = adm5120_flash_remove,
 553 #ifdef CONFIG_PM
 554         .suspend        = adm5120_flash_suspend,
 555         .resume         = adm5120_flash_resume,
 556         .shutdown       = adm5120_flash_shutdown,
 557 #endif
 558         .driver         = {
 559                 .name   = DRV_NAME,
 560         },
 561 };
 562
 563 static int __init adm5120_flash_init(void)
 564 {
 565         int err;
 566
 567         err = platform_driver_register(&adm5120_flash_driver);
 568
 569         return err;
 570 }
 571
 572 static void __exit adm5120_flash_exit(void)
 573 {
 574         platform_driver_unregister(&adm5120_flash_driver);
 575 }
 576
 577 module_init(adm5120_flash_init);
 578 module_exit(adm5120_flash_exit);
 579
 580 MODULE_LICENSE("GPL");
 581 MODULE_AUTHOR("Gabor Juhos <juhosg at openwrt.org>");
 582 MODULE_DESCRIPTION(DRV_DESC);