drivers/mtd/maps/physmap.c

   1 /*
   2  * Normal mappings of chips in physical memory
   3  *
   4  * Copyright (C) 2003 MontaVista Software Inc.
   5  * Author: Jun Sun, jsun@mvista.com or jsun@junsun.net
   6  *
   7  * 031022 - [jsun] add run-time configure and partition setup
   8  */
   9
  10 #include <linux/module.h>
  11 #include <linux/types.h>
  12 #include <linux/kernel.h>
  13 #include <linux/init.h>
  14 #include <linux/slab.h>
  15 #include <linux/device.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/mtd/mtd.h>
  18 #include <linux/mtd/map.h>
  19 #include <linux/mtd/partitions.h>
  20 #include <linux/mtd/physmap.h>
  21 #include <linux/mtd/concat.h>
  22 #include <linux/io.h>
  23
  24 #define MAX_RESOURCES           4
  25
  26 struct physmap_flash_info {
  27         struct mtd_info         *mtd[MAX_RESOURCES];
  28         struct mtd_info         *cmtd;
  29         struct map_info         map[MAX_RESOURCES];
  30 #ifdef CONFIG_MTD_PARTITIONS
  31         int                     nr_parts;
  32 #endif
  33 };
  34
  35 static int physmap_flash_remove(struct platform_device *dev)
  36 {
  37         struct physmap_flash_info *info;
  38         struct physmap_flash_data *physmap_data;
  39         int i;
  40
  41         info = platform_get_drvdata(dev);
  42         if (info == NULL)
  43                 return 0;
  44         platform_set_drvdata(dev, NULL);
  45
  46         physmap_data = dev->dev.platform_data;
  47
  48 #ifdef CONFIG_MTD_CONCAT
  49         if (info->cmtd != info->mtd[0]) {
  50                 del_mtd_device(info->cmtd);
  51                 mtd_concat_destroy(info->cmtd);
  52         }
  53 #endif
  54
  55         for (i = 0; i < MAX_RESOURCES; i++) {
  56                 if (info->mtd[i] != NULL) {
  57 #ifdef CONFIG_MTD_PARTITIONS
  58                         if (info->nr_parts || physmap_data->nr_parts)
  59                                 del_mtd_partitions(info->mtd[i]);
  60                         else
  61                                 del_mtd_device(info->mtd[i]);
  62 #else
  63                         del_mtd_device(info->mtd[i]);
  64 #endif
  65                         map_destroy(info->mtd[i]);
  66                 }
  67         }
  68         return 0;
  69 }
  70
  71 static const char *rom_probe_types[] = { "cfi_probe", "jedec_probe", "map_rom", NULL };
  72 #ifdef CONFIG_MTD_PARTITIONS
  73 static const char *part_probe_types[] = { "cmdlinepart", "RedBoot", NULL };
  74 #endif
  75
  76 static int physmap_flash_probe(struct platform_device *dev)
  77 {
  78         struct physmap_flash_data *physmap_data;
  79         struct physmap_flash_info *info;
  80         const char **probe_type;
  81         int err = 0;
  82         int i;
  83         int devices_found = 0;
  84 #ifdef CONFIG_MTD_PARTITIONS
  85         struct mtd_partition *parts;
  86 #endif
  87
  88         physmap_data = dev->dev.platform_data;
  89         if (physmap_data == NULL)
  90                 return -ENODEV;
  91
  92         info = devm_kzalloc(&dev->dev, sizeof(struct physmap_flash_info),
  93                             GFP_KERNEL);
  94         if (info == NULL) {
  95                 err = -ENOMEM;
  96                 goto err_out;
  97         }
  98
  99         platform_set_drvdata(dev, info);
 100
 101         for (i = 0; i < dev->num_resources; i++) {
 102                 printk(KERN_NOTICE "physmap platform flash device: %.8llx at %.8llx\n",
 103                        (unsigned long long)(dev->resource[i].end - dev->resource[i].start + 1),
 104                        (unsigned long long)dev->resource[i].start);
 105
 106                 if (!devm_request_mem_region(&dev->dev,
 107                         dev->resource[i].start,
 108                         dev->resource[i].end - dev->resource[i].start + 1,
 109                         dev_name(&dev->dev))) {
 110                         dev_err(&dev->dev, "Could not reserve memory region\n");
 111                         err = -ENOMEM;
 112                         goto err_out;
 113                 }
 114
 115                 info->map[i].name = dev_name(&dev->dev);
 116                 info->map[i].phys = dev->resource[i].start;
 117                 info->map[i].size = dev->resource[i].end - dev->resource[i].start + 1;
 118                 info->map[i].bankwidth = physmap_data->width;
 119                 info->map[i].set_vpp = physmap_data->set_vpp;
 120
 121                 info->map[i].virt = devm_ioremap(&dev->dev, info->map[i].phys,
 122                                                  info->map[i].size);
 123                 if (info->map[i].virt == NULL) {
 124                         dev_err(&dev->dev, "Failed to ioremap flash region\n");
 125                         err = EIO;
 126                         goto err_out;
 127                 }
 128
 129                 simple_map_init(&info->map[i]);
 130
 131                 probe_type = rom_probe_types;
 132                 for (; info->mtd[i] == NULL && *probe_type != NULL; probe_type++)
 133                         info->mtd[i] = do_map_probe(*probe_type, &info->map[i]);
 134                 if (info->mtd[i] == NULL) {
 135                         dev_err(&dev->dev, "map_probe failed\n");
 136                         err = -ENXIO;
 137                         goto err_out;
 138                 } else {
 139                         devices_found++;
 140                 }
 141                 info->mtd[i]->owner = THIS_MODULE;
 142         }
 143
 144         if (devices_found == 1) {
 145                 info->cmtd = info->mtd[0];
 146         } else if (devices_found > 1) {
 147                 /*
 148                  * We detected multiple devices. Concatenate them together.
 149                  */
 150 #ifdef CONFIG_MTD_CONCAT
 151                 info->cmtd = mtd_concat_create(info->mtd, devices_found, dev_name(&dev->dev));
 152                 if (info->cmtd == NULL)
 153                         err = -ENXIO;
 154 #else
 155                 printk(KERN_ERR "physmap-flash: multiple devices "
 156                        "found but MTD concat support disabled.\n");
 157                 err = -ENXIO;
 158 #endif
 159         }
 160         if (err)
 161                 goto err_out;
 162
 163 #ifdef CONFIG_MTD_PARTITIONS
 164         err = parse_mtd_partitions(info->cmtd, part_probe_types, &parts, 0);
 165         if (err > 0) {
 166                 add_mtd_partitions(info->cmtd, parts, err);
 167                 kfree(parts);
 168                 return 0;
 169         }
 170
 171         if (physmap_data->nr_parts) {
 172                 printk(KERN_NOTICE "Using physmap partition information\n");
 173                 add_mtd_partitions(info->cmtd, physmap_data->parts,
 174                                    physmap_data->nr_parts);
 175                 return 0;
 176         }
 177 #endif
 178
 179         add_mtd_device(info->cmtd);
 180         return 0;
 181
 182 err_out:
 183         physmap_flash_remove(dev);
 184         return err;
 185 }
 186
 187 #ifdef CONFIG_PM
 188 static int physmap_flash_suspend(struct platform_device *dev, pm_message_t state)
 189 {
 190         struct physmap_flash_info *info = platform_get_drvdata(dev);
 191         int ret = 0;
 192         int i;
 193
 194         for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
 195                 if (info->mtd[i]->suspend) {
 196                         ret = info->mtd[i]->suspend(info->mtd[i]);
 197                         if (ret)
 198                                 goto fail;
 199                 }
 200
 201         return 0;
 202 fail:
 203         for (--i; i >= 0; --i)
 204                 if (info->mtd[i]->suspend) {
 205                         BUG_ON(!info->mtd[i]->resume);
 206                         info->mtd[i]->resume(info->mtd[i]);
 207                 }
 208
 209         return ret;
 210 }
 211
 212 static int physmap_flash_resume(struct platform_device *dev)
 213 {
 214         struct physmap_flash_info *info = platform_get_drvdata(dev);
 215         int i;
 216
 217         for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
 218                 if (info->mtd[i]->resume)
 219                         info->mtd[i]->resume(info->mtd[i]);
 220
 221         return 0;
 222 }
 223
 224 static void physmap_flash_shutdown(struct platform_device *dev)
 225 {
 226         struct physmap_flash_info *info = platform_get_drvdata(dev);
 227         int i;
 228
 229         for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
 230                 if (info->mtd[i]->suspend && info->mtd[i]->resume)
 231                         if (info->mtd[i]->suspend(info->mtd[i]) == 0)
 232                                 info->mtd[i]->resume(info->mtd[i]);
 233 }
 234 #else
 235 #define physmap_flash_suspend NULL
 236 #define physmap_flash_resume NULL
 237 #define physmap_flash_shutdown NULL
 238 #endif
 239
 240 static struct platform_driver physmap_flash_driver = {
 241         .probe          = physmap_flash_probe,
 242         .remove         = physmap_flash_remove,
 243         .suspend        = physmap_flash_suspend,
 244         .resume         = physmap_flash_resume,
 245         .shutdown       = physmap_flash_shutdown,
 246         .driver         = {
 247                 .name   = "physmap-flash",
 248                 .owner  = THIS_MODULE,
 249         },
 250 };
 251
 252
 253 #ifdef CONFIG_MTD_PHYSMAP_COMPAT
 254 static struct physmap_flash_data physmap_flash_data = {
 255         .width          = CONFIG_MTD_PHYSMAP_BANKWIDTH,
 256 };
 257
 258 static struct resource physmap_flash_resource = {
 259         .start          = CONFIG_MTD_PHYSMAP_START,
 260         .end            = CONFIG_MTD_PHYSMAP_START + CONFIG_MTD_PHYSMAP_LEN - 1,
 261         .flags          = IORESOURCE_MEM,
 262 };
 263
 264 static struct platform_device physmap_flash = {
 265         .name           = "physmap-flash",
 266         .id             = 0,
 267         .dev            = {
 268                 .platform_data  = &physmap_flash_data,
 269         },
 270         .num_resources  = 1,
 271         .resource       = &physmap_flash_resource,
 272 };
 273
 274 void physmap_configure(unsigned long addr, unsigned long size,
 275                 int bankwidth, void (*set_vpp)(struct map_info *, int))
 276 {
 277         physmap_flash_resource.start = addr;
 278         physmap_flash_resource.end = addr + size - 1;
 279         physmap_flash_data.width = bankwidth;
 280         physmap_flash_data.set_vpp = set_vpp;
 281 }
 282
 283 #ifdef CONFIG_MTD_PARTITIONS
 284 void physmap_set_partitions(struct mtd_partition *parts, int num_parts)
 285 {
 286         physmap_flash_data.nr_parts = num_parts;
 287         physmap_flash_data.parts = parts;
 288 }
 289 #endif
 290 #endif
 291
 292 static int __init physmap_init(void)
 293 {
 294         int err;
 295
 296         err = platform_driver_register(&physmap_flash_driver);
 297 #ifdef CONFIG_MTD_PHYSMAP_COMPAT
 298         if (err == 0)
 299                 platform_device_register(&physmap_flash);
 300 #endif
 301
 302         return err;
 303 }
 304
 305 static void __exit physmap_exit(void)
 306 {
 307 #ifdef CONFIG_MTD_PHYSMAP_COMPAT
 308         platform_device_unregister(&physmap_flash);
 309 #endif
 310         platform_driver_unregister(&physmap_flash_driver);
 311 }
 312
 313 module_init(physmap_init);
 314 module_exit(physmap_exit);
 315
 316 MODULE_LICENSE("GPL");
 317 MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
 318 MODULE_DESCRIPTION("Generic configurable MTD map driver");
 319
 320 /* legacy platform drivers can't hotplug or coldplg */
 321 #ifndef CONFIG_MTD_PHYSMAP_COMPAT
 322 /* work with hotplug and coldplug */
 323 MODULE_ALIAS("platform:physmap-flash");
 324 #endif