drivers/mtd/maps/bcm963xx-flash.c

   1 /*
   2  * Copyright © 2006-2008  Florian Fainelli <florian@openwrt.org>
   3  *                        Mike Albon <malbon@openwrt.org>
   4  * Copyright © 2009-2010  Daniel Dickinson <openwrt@cshore.neomailbox.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  */
  20
  21 #include <linux/init.h>
  22 #include <linux/kernel.h>
  23 #include <linux/slab.h>
  24 #include <linux/module.h>
  25 #include <linux/mtd/map.h>
  26 #include <linux/mtd/mtd.h>
  27 #include <linux/mtd/partitions.h>
  28 #include <linux/vmalloc.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/io.h>
  31
  32 #include <asm/mach-bcm63xx/bcm963xx_tag.h>
  33
  34 #define BCM63XX_BUSWIDTH        2               /* Buswidth */
  35 #define BCM63XX_EXTENDED_SIZE   0xBFC00000      /* Extended flash address */
  36
  37 #define PFX KBUILD_MODNAME ": "
  38
  39 static struct mtd_partition *parsed_parts;
  40
  41 static struct mtd_info *bcm963xx_mtd_info;
  42
  43 static struct map_info bcm963xx_map = {
  44         .name           = "bcm963xx",
  45         .bankwidth      = BCM63XX_BUSWIDTH,
  46 };
  47
  48 static int parse_cfe_partitions(struct mtd_info *master,
  49                                                 struct mtd_partition **pparts)
  50 {
  51         /* CFE, NVRAM and global Linux are always present */
  52         int nrparts = 3, curpart = 0;
  53         struct bcm_tag *buf;
  54         struct mtd_partition *parts;
  55         int ret;
  56         size_t retlen;
  57         unsigned int rootfsaddr, kerneladdr, spareaddr;
  58         unsigned int rootfslen, kernellen, sparelen, totallen;
  59         int namelen = 0;
  60         int i;
  61         char *boardid;
  62         char *tagversion;
  63
  64         /* Allocate memory for buffer */
  65         buf = vmalloc(sizeof(struct bcm_tag));
  66         if (!buf)
  67                 return -ENOMEM;
  68
  69         /* Get the tag */
  70         ret = master->read(master, master->erasesize, sizeof(struct bcm_tag),
  71                                                         &retlen, (void *)buf);
  72         if (retlen != sizeof(struct bcm_tag)) {
  73                 vfree(buf);
  74                 return -EIO;
  75         }
  76
  77         sscanf(buf->kernel_address, "%u", &kerneladdr);
  78         sscanf(buf->kernel_length, "%u", &kernellen);
  79         sscanf(buf->total_length, "%u", &totallen);
  80         tagversion = &(buf->tag_version[0]);
  81         boardid = &(buf->board_id[0]);
  82
  83         printk(KERN_INFO PFX "CFE boot tag found with version %s "
  84                                 "and board type %s\n", tagversion, boardid);
  85
  86         kerneladdr = kerneladdr - BCM63XX_EXTENDED_SIZE;
  87         rootfsaddr = kerneladdr + kernellen;
  88         spareaddr = roundup(totallen, master->erasesize) + master->erasesize;
  89         sparelen = master->size - spareaddr - master->erasesize;
  90         rootfslen = spareaddr - rootfsaddr;
  91
  92         /* Determine number of partitions */
  93         namelen = 8;
  94         if (rootfslen > 0) {
  95                 nrparts++;
  96                 namelen += 6;
  97         };
  98         if (kernellen > 0) {
  99                 nrparts++;
 100                 namelen += 6;
 101         };
 102
 103         /* Ask kernel for more memory */
 104         parts = kzalloc(sizeof(*parts) * nrparts + 10 * nrparts, GFP_KERNEL);
 105         if (!parts) {
 106                 vfree(buf);
 107                 return -ENOMEM;
 108         };
 109
 110         /* Start building partition list */
 111         parts[curpart].name = "CFE";
 112         parts[curpart].offset = 0;
 113         parts[curpart].size = master->erasesize;
 114         curpart++;
 115
 116         if (kernellen > 0) {
 117                 parts[curpart].name = "kernel";
 118                 parts[curpart].offset = kerneladdr;
 119                 parts[curpart].size = kernellen;
 120                 curpart++;
 121         };
 122
 123         if (rootfslen > 0) {
 124                 parts[curpart].name = "rootfs";
 125                 parts[curpart].offset = rootfsaddr;
 126                 parts[curpart].size = rootfslen;
 127                 if (sparelen > 0)
 128                         parts[curpart].size += sparelen;
 129                 curpart++;
 130         };
 131
 132         parts[curpart].name = "nvram";
 133         parts[curpart].offset = master->size - master->erasesize;
 134         parts[curpart].size = master->erasesize;
 135
 136         /* Global partition "linux" to make easy firmware upgrade */
 137         curpart++;
 138         parts[curpart].name = "linux";
 139         parts[curpart].offset = parts[0].size;
 140         parts[curpart].size = master->size - parts[0].size - parts[3].size;
 141
 142         for (i = 0; i < nrparts; i++)
 143                 printk(KERN_INFO PFX "Partition %d is %s offset %lx and "
 144                                         "length %lx\n", i, parts[i].name,
 145                                         (long unsigned int)(parts[i].offset),
 146                                         (long unsigned int)(parts[i].size));
 147
 148         printk(KERN_INFO PFX "Spare partition is %x offset and length %x\n",
 149                                                         spareaddr, sparelen);
 150         *pparts = parts;
 151         vfree(buf);
 152
 153         return nrparts;
 154 };
 155
 156 static int bcm963xx_detect_cfe(struct mtd_info *master)
 157 {
 158         int idoffset = 0x4e0;
 159         static char idstring[8] = "CFE1CFE1";
 160         char buf[9];
 161         int ret;
 162         size_t retlen;
 163
 164         ret = master->read(master, idoffset, 8, &retlen, (void *)buf);
 165         buf[retlen] = 0;
 166         printk(KERN_INFO PFX "Read Signature value of %s\n", buf);
 167
 168         return strncmp(idstring, buf, 8);
 169 }
 170
 171 static int bcm963xx_probe(struct platform_device *pdev)
 172 {
 173         int err = 0;
 174         int parsed_nr_parts = 0;
 175         char *part_type;
 176         struct resource *r;
 177
 178         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 179         if (!r) {
 180                 dev_err(&pdev->dev, "no resource supplied\n");
 181                 return -ENODEV;
 182         }
 183
 184         bcm963xx_map.phys = r->start;
 185         bcm963xx_map.size = resource_size(r);
 186         bcm963xx_map.virt = ioremap(r->start, resource_size(r));
 187         if (!bcm963xx_map.virt) {
 188                 dev_err(&pdev->dev, "failed to ioremap\n");
 189                 return -EIO;
 190         }
 191
 192         dev_info(&pdev->dev, "0x%08lx at 0x%08x\n",
 193                                         bcm963xx_map.size, bcm963xx_map.phys);
 194
 195         simple_map_init(&bcm963xx_map);
 196
 197         bcm963xx_mtd_info = do_map_probe("cfi_probe", &bcm963xx_map);
 198         if (!bcm963xx_mtd_info) {
 199                 dev_err(&pdev->dev, "failed to probe using CFI\n");
 200                 bcm963xx_mtd_info = do_map_probe("jedec_probe", &bcm963xx_map);
 201                 if (bcm963xx_mtd_info)
 202                         goto probe_ok;
 203                 dev_err(&pdev->dev, "failed to probe using JEDEC\n");
 204                 err = -EIO;
 205                 goto err_probe;
 206         }
 207
 208 probe_ok:
 209         bcm963xx_mtd_info->owner = THIS_MODULE;
 210
 211         /* This is mutually exclusive */
 212         if (bcm963xx_detect_cfe(bcm963xx_mtd_info) == 0) {
 213                 dev_info(&pdev->dev, "CFE bootloader detected\n");
 214                 if (parsed_nr_parts == 0) {
 215                         int ret = parse_cfe_partitions(bcm963xx_mtd_info,
 216                                                         &parsed_parts);
 217                         if (ret > 0) {
 218                                 part_type = "CFE";
 219                                 parsed_nr_parts = ret;
 220                         }
 221                 }
 222         } else {
 223                 dev_info(&pdev->dev, "unsupported bootloader\n");
 224                 err = -ENODEV;
 225                 goto err_probe;
 226         }
 227
 228         return mtd_device_register(bcm963xx_mtd_info, parsed_parts,
 229                                    parsed_nr_parts);
 230
 231 err_probe:
 232         iounmap(bcm963xx_map.virt);
 233         return err;
 234 }
 235
 236 static int bcm963xx_remove(struct platform_device *pdev)
 237 {
 238         if (bcm963xx_mtd_info) {
 239                 mtd_device_unregister(bcm963xx_mtd_info);
 240                 map_destroy(bcm963xx_mtd_info);
 241         }
 242
 243         if (bcm963xx_map.virt) {
 244                 iounmap(bcm963xx_map.virt);
 245                 bcm963xx_map.virt = 0;
 246         }
 247
 248         return 0;
 249 }
 250
 251 static struct platform_driver bcm63xx_mtd_dev = {
 252         .probe  = bcm963xx_probe,
 253         .remove = bcm963xx_remove,
 254         .driver = {
 255                 .name   = "bcm963xx-flash",
 256                 .owner  = THIS_MODULE,
 257         },
 258 };
 259
 260 static int __init bcm963xx_mtd_init(void)
 261 {
 262         return platform_driver_register(&bcm63xx_mtd_dev);
 263 }
 264
 265 static void __exit bcm963xx_mtd_exit(void)
 266 {
 267         platform_driver_unregister(&bcm63xx_mtd_dev);
 268 }
 269
 270 module_init(bcm963xx_mtd_init);
 271 module_exit(bcm963xx_mtd_exit);
 272
 273 MODULE_LICENSE("GPL");
 274 MODULE_DESCRIPTION("Broadcom BCM63xx MTD driver for CFE and RedBoot");
 275 MODULE_AUTHOR("Daniel Dickinson <openwrt@cshore.neomailbox.net>");
 276 MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
 277 MODULE_AUTHOR("Mike Albon <malbon@openwrt.org>");