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, map->size, map->name);
 224         if (info->res == NULL) {
 225                 MAP_ERR(map, "could not reserve memory region\n");
 226                 err = -ENOMEM;
 227                 goto out;
 228         }
 229
 230         map->virt = ioremap_nocache(map->phys, map->size);
 231         if (map->virt == NULL) {
 232                 MAP_ERR(map, "failed to ioremap flash region\n");
 233                 err = -ENOMEM;
 234                 goto out;
 235         }
 236
 237 out:
 238         return err;
 239 }
 240
 241 static int adm5120_flash_initinfo(struct adm5120_flash_info *info,
 242                 struct platform_device *dev)
 243 {
 244         struct map_info *map = &info->amap.map;
 245         struct adm5120_flash_platform_data *pdata = dev->dev.platform_data;
 246         struct flash_desc *fdesc;
 247         u32 t;
 248
 249         map->name = dev->dev.bus_id;
 250
 251         if (dev->id > 1) {
 252                 MAP_ERR(map, "invalid flash id\n");
 253                 goto err_out;
 254         }
 255
 256         fdesc = &flash_descs[dev->id];
 257
 258         /* get memory window size */
 259         t = SW_READ_REG(MEMCTRL) >> fdesc->srs_shift;
 260         t &= MEMCTRL_SRS_MASK;
 261         info->amap.window_size = flash_sizes[t];
 262         if (info->amap.window_size == 0) {
 263                 MAP_ERR(map, "invalid flash size detected\n");
 264                 goto err_out;
 265         }
 266
 267         /* get flash bus width */
 268         switch (dev->id) {
 269         case 0:
 270                 t = MPMC_READ_REG(SC1) & SC_MW_MASK;
 271                 break;
 272         case 1:
 273                 t = MPMC_READ_REG(SC0) & SC_MW_MASK;
 274                 break;
 275         }
 276         map->bankwidth = flash_bankwidths[t];
 277         if (map->bankwidth == 0) {
 278                 MAP_ERR(map, "invalid bus width detected\n");
 279                 goto err_out;
 280         }
 281
 282         map->phys = fdesc->phys;
 283         map->size = BANK_SIZE_MAX;
 284
 285         simple_map_init(map);
 286         map->read = adm5120_flash_read;
 287         map->write = adm5120_flash_write;
 288         map->copy_from = adm5120_flash_copy_from;
 289
 290         if (pdata) {
 291                 map->set_vpp = pdata->set_vpp;
 292                 info->amap.switch_bank = pdata->switch_bank;
 293         }
 294
 295         info->dev = dev;
 296
 297         MAP_INFO(map, "probing at 0x%lX, size:%ldKiB, width:%d bits\n",
 298                 (unsigned long)map->phys,
 299                 (unsigned long)info->amap.window_size >> 10,
 300                 map->bankwidth*8);
 301
 302         return 0;
 303
 304 err_out:
 305         return -ENODEV;
 306 }
 307
 308 static void adm5120_flash_initbanks(struct adm5120_flash_info *info)
 309 {
 310         struct map_info *map = &info->amap.map;
 311
 312         if (info->mtd->size <= BANK_SIZE)
 313                 /* no bank switching needed */
 314                 return;
 315
 316         if (info->amap.switch_bank) {
 317                 info->amap.window_size = info->mtd->size;
 318                 return;
 319         }
 320
 321         MAP_ERR(map, "reduce visibility from %ldKiB to %ldKiB\n",
 322                 (unsigned long)map->size >> 10,
 323                 (unsigned long)info->mtd->size >> 10);
 324
 325         info->mtd->size = info->amap.window_size;
 326 }
 327
 328 #ifdef CONFIG_MTD_PARTITIONS
 329 static int adm5120_flash_initparts(struct adm5120_flash_info *info)
 330 {
 331         struct adm5120_flash_platform_data *pdata;
 332         struct map_info *map = &info->amap.map;
 333         int num_parsers;
 334         const char *parser[2];
 335         int err = 0;
 336         int nr_parts;
 337         int i;
 338
 339         info->nr_parts = 0;
 340
 341         pdata = info->dev->dev.platform_data;
 342         if (pdata == NULL)
 343                 goto out;
 344
 345         if (pdata->nr_parts) {
 346                 MAP_INFO(map, "adding static partitions\n");
 347                 err = add_mtd_partitions(info->mtd, pdata->parts,
 348                         pdata->nr_parts);
 349                 if (err == 0) {
 350                         info->nr_parts += pdata->nr_parts;
 351                         goto out;
 352                 }
 353         }
 354
 355         num_parsers = ARRAY_SIZE(parse_types);
 356         if (num_parsers > MAX_PARSED_PARTS)
 357                 num_parsers = MAX_PARSED_PARTS;
 358
 359         parser[1] = NULL;
 360         for (i = 0; i < num_parsers; i++) {
 361                 parser[0] = parse_types[i];
 362
 363                 MAP_INFO(map, "parsing \"%s\" partitions\n",
 364                         parser[0]);
 365                 nr_parts = parse_mtd_partitions(info->mtd, parser,
 366                         &info->parts[i], 0);
 367
 368                 if (nr_parts <= 0)
 369                         continue;
 370
 371                 MAP_INFO(map, "adding \"%s\" partitions\n",
 372                         parser[0]);
 373
 374                 err = add_mtd_partitions(info->mtd, info->parts[i], nr_parts);
 375                 if (err)
 376                         break;
 377
 378                 info->nr_parts += nr_parts;
 379         }
 380 out:
 381         return err;
 382 }
 383 #else
 384 static int adm5120_flash_initparts(struct adm5120_flash_info *info)
 385 {
 386         return 0;
 387 }
 388 #endif /* CONFIG_MTD_PARTITIONS */
 389
 390 #ifdef CONFIG_MTD_PARTITIONS
 391 static void adm5120_flash_remove_mtd(struct adm5120_flash_info *info)
 392 {
 393         int i;
 394
 395         if (info->nr_parts) {
 396                 del_mtd_partitions(info->mtd);
 397                 for (i = 0; i < MAX_PARSED_PARTS; i++)
 398                         if (info->parts[i] != NULL)
 399                                 kfree(info->parts[i]);
 400         } else {
 401                 del_mtd_device(info->mtd);
 402         }
 403 }
 404 #else
 405 static void adm5120_flash_remove_mtd(struct adm5120_flash_info *info)
 406 {
 407         del_mtd_device(info->mtd);
 408 }
 409 #endif
 410
 411 static int adm5120_flash_remove(struct platform_device *dev)
 412 {
 413         struct adm5120_flash_info *info;
 414
 415         info = platform_get_drvdata(dev);
 416         if (info == NULL)
 417                 return 0;
 418
 419         platform_set_drvdata(dev, NULL);
 420
 421         if (info->mtd != NULL) {
 422                 adm5120_flash_remove_mtd(info);
 423                 map_destroy(info->mtd);
 424         }
 425
 426         if (info->amap.map.virt != NULL)
 427                 iounmap(info->amap.map.virt);
 428
 429         if (info->res != NULL) {
 430                 release_resource(info->res);
 431                 kfree(info->res);
 432         }
 433
 434         return 0;
 435 }
 436
 437 static int adm5120_flash_probe(struct platform_device *dev)
 438 {
 439         struct adm5120_flash_info *info;
 440         struct map_info *map;
 441         const char **probe_type;
 442         int err;
 443
 444         info = kzalloc(sizeof(*info), GFP_KERNEL);
 445         if (info == NULL) {
 446                 err = -ENOMEM;
 447                 goto err_out;
 448         }
 449
 450         platform_set_drvdata(dev, info);
 451
 452         err = adm5120_flash_initinfo(info, dev);
 453         if (err)
 454                 goto err_out;
 455
 456         err = adm5120_flash_initres(info);
 457         if (err)
 458                 goto err_out;
 459
 460         map = &info->amap.map;
 461         for (probe_type = probe_types; info->mtd == NULL && *probe_type != NULL;
 462                 probe_type++)
 463                 info->mtd = do_map_probe(*probe_type, map);
 464
 465         if (info->mtd == NULL) {
 466                 MAP_ERR(map, "map_probe failed\n");
 467                 err = -ENXIO;
 468                 goto err_out;
 469         }
 470
 471         adm5120_flash_initbanks(info);
 472
 473         if (info->mtd->size < info->amap.window_size) {
 474                 /* readjust resources */
 475                 iounmap(map->virt);
 476                 release_resource(info->res);
 477                 kfree(info->res);
 478
 479                 info->amap.window_size = info->mtd->size;
 480                 map->size = info->mtd->size;
 481                 MAP_INFO(map, "reducing map size to %ldKiB\n",
 482                         (unsigned long)map->size >> 10);
 483                 err = adm5120_flash_initres(info);
 484                 if (err)
 485                         goto err_out;
 486         }
 487
 488         MAP_INFO(map, "found at 0x%lX, size:%ldKiB, width:%d bits\n",
 489                 (unsigned long)map->phys, (unsigned long)info->mtd->size >> 10,
 490                 map->bankwidth*8);
 491
 492         info->mtd->owner = THIS_MODULE;
 493
 494         err = adm5120_flash_initparts(info);
 495         if (err)
 496                 goto err_out;
 497
 498         if (info->nr_parts == 0) {
 499                 MAP_INFO(map, "no partitions available, registering "
 500                         "whole flash\n");
 501                 add_mtd_device(info->mtd);
 502         }
 503
 504         return 0;
 505
 506 err_out:
 507         adm5120_flash_remove(dev);
 508         return err;
 509 }
 510
 511 #ifdef CONFIG_PM
 512 static int adm5120_flash_suspend(struct platform_device *dev,
 513                 pm_message_t state)
 514 {
 515         struct adm5120_flash_info *info = platform_get_drvdata(dev);
 516         int ret = 0;
 517
 518         if (info)
 519                 ret = info->mtd->suspend(info->mtd);
 520
 521         return ret;
 522 }
 523
 524 static int adm5120_flash_resume(struct platform_device *dev)
 525 {
 526         struct adm5120_flash_info *info = platform_get_drvdata(dev);
 527
 528         if (info)
 529                 info->mtd->resume(info->mtd);
 530
 531         return 0;
 532 }
 533
 534 static void adm5120_flash_shutdown(struct platform_device *dev)
 535 {
 536         struct adm5120_flash_info *info = platform_get_drvdata(dev);
 537
 538         if (info && info->mtd->suspend(info->mtd) == 0)
 539                 info->mtd->resume(info->mtd);
 540 }
 541 #endif
 542
 543 static struct platform_driver adm5120_flash_driver = {
 544         .probe          = adm5120_flash_probe,
 545         .remove         = adm5120_flash_remove,
 546 #ifdef CONFIG_PM
 547         .suspend        = adm5120_flash_suspend,
 548         .resume         = adm5120_flash_resume,
 549         .shutdown       = adm5120_flash_shutdown,
 550 #endif
 551         .driver         = {
 552                 .name   = DRV_NAME,
 553         },
 554 };
 555
 556 static int __init adm5120_flash_init(void)
 557 {
 558         int err;
 559
 560         err = platform_driver_register(&adm5120_flash_driver);
 561
 562         return err;
 563 }
 564
 565 static void __exit adm5120_flash_exit(void)
 566 {
 567         platform_driver_unregister(&adm5120_flash_driver);
 568 }
 569
 570 module_init(adm5120_flash_init);
 571 module_exit(adm5120_flash_exit);
 572
 573 MODULE_LICENSE("GPL");
 574 MODULE_AUTHOR("Gabor Juhos <juhosg at openwrt.org>");
 575 MODULE_DESCRIPTION(DRV_DESC);