target/linux/brcm63xx/files/drivers/mtd/maps/bcm963xx-flash.c

   1 /*
   2  * Copyright (C) 2006-2008  Florian Fainelli <florian@openwrt.org>
   3  *                          Mike Albon <malbon@openwrt.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  */
  19
  20 #include <linux/init.h>
  21 #include <linux/kernel.h>
  22 #include <linux/mtd/map.h>
  23 #include <linux/mtd/mtd.h>
  24 #include <linux/mtd/partitions.h>
  25 #include <linux/vmalloc.h>
  26 #include <linux/platform_device.h>
  27
  28 #include <bcm_tag.h>
  29 #include <asm/io.h>
  30
  31 #define BUSWIDTH 2                     /* Buswidth */
  32 #define EXTENDED_SIZE 0xBFC00000       /* Extended flash address */
  33
  34 #define PFX KBUILD_MODNAME ": "
  35
  36 extern int parse_redboot_partitions(struct mtd_info *master, struct mtd_partition **pparts, unsigned long fis_origin);
  37 static struct mtd_partition *parsed_parts;
  38
  39 static struct mtd_info *bcm963xx_mtd_info;
  40
  41 static struct map_info bcm963xx_map = {
  42        .name            = "bcm963xx",
  43        .bankwidth       = BUSWIDTH,
  44 };
  45
  46 static struct tagiddesc_t tagidtab[NUM_TAGID] = TAGID_DEFINITIONS;
  47
  48 static uint32_t tagcrc32tab[256] = {
  49         0x00000000, 0x77073096, 0xEE0E612C, 0x990951BA, 0x076DC419, 0x706AF48F, 0xE963A535, 0x9E6495A3,
  50         0x0EDB8832, 0x79DCB8A4, 0xE0D5E91E, 0x97D2D988, 0x09B64C2B, 0x7EB17CBD, 0xE7B82D07, 0x90BF1D91,
  51         0x1DB71064, 0x6AB020F2, 0xF3B97148, 0x84BE41DE, 0x1ADAD47D, 0x6DDDE4EB, 0xF4D4B551, 0x83D385C7,
  52         0x136C9856, 0x646BA8C0, 0xFD62F97A, 0x8A65C9EC, 0x14015C4F, 0x63066CD9, 0xFA0F3D63, 0x8D080DF5,
  53         0x3B6E20C8, 0x4C69105E, 0xD56041E4, 0xA2677172, 0x3C03E4D1, 0x4B04D447, 0xD20D85FD, 0xA50AB56B,
  54         0x35B5A8FA, 0x42B2986C, 0xDBBBC9D6, 0xACBCF940, 0x32D86CE3, 0x45DF5C75, 0xDCD60DCF, 0xABD13D59,
  55         0x26D930AC, 0x51DE003A, 0xC8D75180, 0xBFD06116, 0x21B4F4B5, 0x56B3C423, 0xCFBA9599, 0xB8BDA50F,
  56         0x2802B89E, 0x5F058808, 0xC60CD9B2, 0xB10BE924, 0x2F6F7C87, 0x58684C11, 0xC1611DAB, 0xB6662D3D,
  57         0x76DC4190, 0x01DB7106, 0x98D220BC, 0xEFD5102A, 0x71B18589, 0x06B6B51F, 0x9FBFE4A5, 0xE8B8D433,
  58         0x7807C9A2, 0x0F00F934, 0x9609A88E, 0xE10E9818, 0x7F6A0DBB, 0x086D3D2D, 0x91646C97, 0xE6635C01,
  59         0x6B6B51F4, 0x1C6C6162, 0x856530D8, 0xF262004E, 0x6C0695ED, 0x1B01A57B, 0x8208F4C1, 0xF50FC457,
  60         0x65B0D9C6, 0x12B7E950, 0x8BBEB8EA, 0xFCB9887C, 0x62DD1DDF, 0x15DA2D49, 0x8CD37CF3, 0xFBD44C65,
  61         0x4DB26158, 0x3AB551CE, 0xA3BC0074, 0xD4BB30E2, 0x4ADFA541, 0x3DD895D7, 0xA4D1C46D, 0xD3D6F4FB,
  62         0x4369E96A, 0x346ED9FC, 0xAD678846, 0xDA60B8D0, 0x44042D73, 0x33031DE5, 0xAA0A4C5F, 0xDD0D7CC9,
  63         0x5005713C, 0x270241AA, 0xBE0B1010, 0xC90C2086, 0x5768B525, 0x206F85B3, 0xB966D409, 0xCE61E49F,
  64         0x5EDEF90E, 0x29D9C998, 0xB0D09822, 0xC7D7A8B4, 0x59B33D17, 0x2EB40D81, 0xB7BD5C3B, 0xC0BA6CAD,
  65         0xEDB88320, 0x9ABFB3B6, 0x03B6E20C, 0x74B1D29A, 0xEAD54739, 0x9DD277AF, 0x04DB2615, 0x73DC1683,
  66         0xE3630B12, 0x94643B84, 0x0D6D6A3E, 0x7A6A5AA8, 0xE40ECF0B, 0x9309FF9D, 0x0A00AE27, 0x7D079EB1,
  67         0xF00F9344, 0x8708A3D2, 0x1E01F268, 0x6906C2FE, 0xF762575D, 0x806567CB, 0x196C3671, 0x6E6B06E7,
  68         0xFED41B76, 0x89D32BE0, 0x10DA7A5A, 0x67DD4ACC, 0xF9B9DF6F, 0x8EBEEFF9, 0x17B7BE43, 0x60B08ED5,
  69         0xD6D6A3E8, 0xA1D1937E, 0x38D8C2C4, 0x4FDFF252, 0xD1BB67F1, 0xA6BC5767, 0x3FB506DD, 0x48B2364B,
  70         0xD80D2BDA, 0xAF0A1B4C, 0x36034AF6, 0x41047A60, 0xDF60EFC3, 0xA867DF55, 0x316E8EEF, 0x4669BE79,
  71         0xCB61B38C, 0xBC66831A, 0x256FD2A0, 0x5268E236, 0xCC0C7795, 0xBB0B4703, 0x220216B9, 0x5505262F,
  72         0xC5BA3BBE, 0xB2BD0B28, 0x2BB45A92, 0x5CB36A04, 0xC2D7FFA7, 0xB5D0CF31, 0x2CD99E8B, 0x5BDEAE1D,
  73         0x9B64C2B0, 0xEC63F226, 0x756AA39C, 0x026D930A, 0x9C0906A9, 0xEB0E363F, 0x72076785, 0x05005713,
  74         0x95BF4A82, 0xE2B87A14, 0x7BB12BAE, 0x0CB61B38, 0x92D28E9B, 0xE5D5BE0D, 0x7CDCEFB7, 0x0BDBDF21,
  75         0x86D3D2D4, 0xF1D4E242, 0x68DDB3F8, 0x1FDA836E, 0x81BE16CD, 0xF6B9265B, 0x6FB077E1, 0x18B74777,
  76         0x88085AE6, 0xFF0F6A70, 0x66063BCA, 0x11010B5C, 0x8F659EFF, 0xF862AE69, 0x616BFFD3, 0x166CCF45,
  77         0xA00AE278, 0xD70DD2EE, 0x4E048354, 0x3903B3C2, 0xA7672661, 0xD06016F7, 0x4969474D, 0x3E6E77DB,
  78         0xAED16A4A, 0xD9D65ADC, 0x40DF0B66, 0x37D83BF0, 0xA9BCAE53, 0xDEBB9EC5, 0x47B2CF7F, 0x30B5FFE9,
  79         0xBDBDF21C, 0xCABAC28A, 0x53B39330, 0x24B4A3A6, 0xBAD03605, 0xCDD70693, 0x54DE5729, 0x23D967BF,
  80         0xB3667A2E, 0xC4614AB8, 0x5D681B02, 0x2A6F2B94, 0xB40BBE37, 0xC30C8EA1, 0x5A05DF1B, 0x2D02EF8D
  81 };
  82
  83 static uint32_t tagcrc32(uint32_t crc, uint8_t *data, size_t len)
  84 {
  85         while (len--)
  86                 crc = (crc >> 8) ^ tagcrc32tab[(crc ^ *data++) & 0xFF];
  87
  88         return crc;
  89 }
  90
  91 static int parse_cfe_partitions( struct mtd_info *master, struct mtd_partition **pparts)
  92 {
  93         int nrparts = 3, curpart = 0; /* CFE,NVRAM and global LINUX are always present. */
  94         union bcm_tag *buf;
  95         struct mtd_partition *parts;
  96         int ret;
  97         size_t retlen;
  98         unsigned int rootfsaddr, kerneladdr, spareaddr;
  99         unsigned int rootfslen, kernellen, sparelen, totallen;
 100         unsigned char *tagid;
 101         int namelen = 0;
 102         int i;
 103         uint32_t tagidcrc;
 104         uint32_t calctagidcrc;
 105         bool tagid_match = false;
 106         char *boardid;
 107         char *tagversion;
 108         char *matchtagid;
 109
 110         /* Allocate memory for buffer */
 111         buf = vmalloc(sizeof(union bcm_tag));
 112         if (!buf)
 113                 return -ENOMEM;
 114
 115         /* Get the tag */
 116         ret = master->read(master,master->erasesize,sizeof(union bcm_tag), &retlen, (void *)buf);
 117         if (retlen != sizeof(union bcm_tag)){
 118                 vfree(buf);
 119                 return -EIO;
 120         }
 121
 122         /* tagId isn't in the same location, so we check each tagid against the
 123          * tagid CRC.  If the CRC is valid we have found the right tag and so
 124          * use that tag
 125          */
 126
 127         for (i = 0; i < NUM_TAGID; i++) {
 128           switch(i) {
 129           case 0:
 130             matchtagid = "bccfe";
 131             tagid = &(buf->bccfe.tagId[0]);
 132             sscanf(buf->bccfe.rootAddress,"%u", &rootfsaddr);
 133             sscanf(buf->bccfe.rootLength, "%u", &rootfslen);
 134             sscanf(buf->bccfe.kernelAddress, "%u", &kerneladdr);
 135             sscanf(buf->bccfe.kernelLength, "%u", &kernellen);
 136             sscanf(buf->bccfe.totalLength, "%u", &totallen);
 137             tagidcrc = buf->bccfe.tagIdCRC;
 138             tagversion = &(buf->bccfe.tagVersion[0]);
 139             boardid = &(buf->bccfe.boardid[0]);
 140             break;
 141           case 1:
 142             matchtagid = "bc300";
 143             tagid = &(buf->bc300.tagId[0]);
 144             sscanf(buf->bc300.rootAddress,"%u", &rootfsaddr);
 145             sscanf(buf->bc300.rootLength, "%u", &rootfslen);
 146             sscanf(buf->bc300.kernelAddress, "%u", &kerneladdr);
 147             sscanf(buf->bc300.kernelLength, "%u", &kernellen);
 148             sscanf(buf->bc300.totalLength, "%u", &totallen);
 149             tagidcrc = buf->bc300.tagIdCRC;
 150             tagversion = &(buf->bc300.tagVersion[0]);
 151             boardid = &(buf->bc300.boardid[0]);
 152             break;
 153           case 2:
 154             matchtagid = "ag306";
 155             tagid = &(buf->ag306.tagId[0]);
 156             sscanf(buf->ag306.rootAddress,"%u", &rootfsaddr);
 157             sscanf(buf->ag306.rootLength, "%u", &rootfslen);
 158             sscanf(buf->ag306.kernelAddress, "%u", &kerneladdr);
 159             sscanf(buf->ag306.kernelLength, "%u", &kernellen);
 160             sscanf(buf->ag306.totalLength, "%u", &totallen);
 161             tagidcrc = buf->ag306.tagIdCRC;
 162             tagversion = &(buf->ag306.tagVersion[0]);
 163             boardid = &(buf->ag306.boardid[0]);
 164             break;
 165           case 3:
 166             matchtagid = "bc308";
 167             tagid = &(buf->bc308.tagId[0]);
 168             sscanf(buf->bc308.rootAddress,"%u", &rootfsaddr);
 169             sscanf(buf->bc308.rootLength, "%u", &rootfslen);
 170             sscanf(buf->bc308.kernelAddress, "%u", &kerneladdr);
 171             sscanf(buf->bc308.kernelLength, "%u", &kernellen);
 172             sscanf(buf->bc308.totalLength, "%u", &totallen);
 173             tagidcrc = buf->bc308.tagIdCRC;
 174             tagversion = &(buf->bc308.tagVersion[0]);
 175             boardid = &(buf->bc308.boardid[0]);
 176             break;
 177           case 4:
 178             matchtagid = "bc310";
 179             tagid = &(buf->bc310.tagId[0]);
 180             sscanf(buf->bc310.rootAddress,"%u", &rootfsaddr);
 181             sscanf(buf->bc310.rootLength, "%u", &rootfslen);
 182             sscanf(buf->bc310.kernelAddress, "%u", &kerneladdr);
 183             sscanf(buf->bc310.kernelLength, "%u", &kernellen);
 184             sscanf(buf->bc310.totalLength, "%u", &totallen);
 185             tagidcrc = buf->bc310.tagIdCRC;
 186             tagversion = &(buf->bc310.tagVersion[0]);
 187             boardid = &(buf->bc310.boardid[0]);
 188             break;
 189           }
 190           if (strncmp(tagid, matchtagid, TAGID_LEN) != 0) {
 191             continue;
 192           }
 193
 194           calctagidcrc = tagcrc32(IMAGETAG_CRC_START, tagid, TAGID_LEN);
 195           if (tagidcrc = calctagidcrc) {
 196             tagid_match = true;
 197             break;
 198           }
 199         }
 200
 201         if (!tagid_match) {
 202           printk(KERN_ERR PFX "Failed to find a valid tag id\n");
 203           return -EIO;
 204         }
 205
 206         printk(KERN_INFO PFX "CFE boot tag found with version %s, board type %s, and tagid %s.\n",tagversion,boardid,tagid);
 207
 208         rootfsaddr = rootfsaddr - EXTENDED_SIZE;
 209         kerneladdr = kerneladdr - EXTENDED_SIZE;
 210         spareaddr = roundup(totallen,master->erasesize) + master->erasesize;
 211         sparelen = master->size - spareaddr - master->erasesize;
 212
 213         /* Determine number of partitions */
 214         namelen = 8;
 215         if (rootfslen > 0){
 216                 nrparts++;
 217                 namelen =+ 6;
 218         };
 219         if (kernellen > 0) {
 220                 nrparts++;
 221                 namelen =+ 6;
 222         };
 223
 224         /* Ask kernel for more memory */
 225         parts = kzalloc(sizeof(*parts) * nrparts + 10 * nrparts, GFP_KERNEL);
 226         if (!parts) {
 227                 vfree(buf);
 228                 return -ENOMEM;
 229         };
 230
 231         /* Start building partition list */
 232         parts[curpart].name = "CFE";
 233         parts[curpart].offset = 0;
 234         parts[curpart].size = master->erasesize;
 235         curpart++;
 236
 237         if (kernellen > 0) {
 238                 parts[curpart].name = "kernel";
 239                 parts[curpart].offset = kerneladdr;
 240                 parts[curpart].size = kernellen;
 241                 curpart++;
 242         };
 243
 244         if (rootfslen > 0) {
 245                 parts[curpart].name = "rootfs";
 246                 parts[curpart].offset = rootfsaddr;
 247                 parts[curpart].size = rootfslen;
 248                 if (sparelen > 0)
 249                         parts[curpart].size += sparelen;
 250                 curpart++;
 251         };
 252
 253         parts[curpart].name = "nvram";
 254         parts[curpart].offset = master->size - master->erasesize;
 255         parts[curpart].size = master->erasesize;
 256
 257         /* Global partition "linux" to make easy firmware upgrade */
 258         curpart++;
 259         parts[curpart].name = "linux";
 260         parts[curpart].offset = parts[0].size;
 261         parts[curpart].size = master->size - parts[0].size - parts[3].size;
 262
 263         for (i = 0; i < nrparts; i++)
 264                 printk(KERN_INFO PFX "Partition %d is %s offset %x and length %x\n", i, parts[i].name, parts[i].offset, parts[i].size);
 265
 266         *pparts = parts;
 267         vfree(buf);
 268
 269         return nrparts;
 270 };
 271
 272 static int bcm963xx_detect_cfe(struct mtd_info *master)
 273 {
 274         int idoffset = 0x4e0;
 275         static char idstring[8] = "CFE1CFE1";
 276         char buf[9];
 277         int ret;
 278         size_t retlen;
 279
 280         ret = master->read(master, idoffset, 8, &retlen, (void *)buf);
 281         buf[retlen] = 0;
 282         printk(KERN_INFO PFX "Read Signature value of %s\n", buf);
 283
 284         return strncmp(idstring, buf, 8);
 285 }
 286
 287 static int bcm963xx_probe(struct platform_device *pdev)
 288 {
 289         int err = 0;
 290         int parsed_nr_parts = 0;
 291         char *part_type;
 292         struct resource *r;
 293
 294         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 295         bcm963xx_map.phys = r->start;
 296         bcm963xx_map.size = (r->end - r->start) + 1;
 297         bcm963xx_map.virt = ioremap(r->start, r->end - r->start + 1);
 298
 299         if (!bcm963xx_map.virt) {
 300                 printk(KERN_ERR PFX "Failed to ioremap\n");
 301                 return -EIO;
 302         }
 303         printk(KERN_INFO PFX "0x%08lx at 0x%08x\n", bcm963xx_map.size, bcm963xx_map.phys);
 304
 305         simple_map_init(&bcm963xx_map);
 306
 307         bcm963xx_mtd_info = do_map_probe("cfi_probe", &bcm963xx_map);
 308         if (!bcm963xx_mtd_info) {
 309                 printk(KERN_ERR PFX "Failed to probe using CFI\n");
 310                 err = -EIO;
 311                 goto err_probe;
 312         }
 313
 314         bcm963xx_mtd_info->owner = THIS_MODULE;
 315
 316         /* This is mutually exclusive */
 317         if (bcm963xx_detect_cfe(bcm963xx_mtd_info) == 0) {
 318                 printk(KERN_INFO PFX "CFE bootloader detected\n");
 319                 if (parsed_nr_parts == 0) {
 320                         int ret = parse_cfe_partitions(bcm963xx_mtd_info, &parsed_parts);
 321                         if (ret > 0) {
 322                                 part_type = "CFE";
 323                                 parsed_nr_parts = ret;
 324                         }
 325                 }
 326         } else {
 327                 printk(KERN_INFO PFX "assuming RedBoot bootloader\n");
 328                 if (bcm963xx_mtd_info->size > 0x00400000) {
 329                         printk(KERN_INFO PFX "Support for extended flash memory size : 0x%08X ; ONLY 64MBIT SUPPORT\n", bcm963xx_mtd_info->size);
 330                         bcm963xx_map.virt = (u32)(EXTENDED_SIZE);
 331                 }
 332
 333 #ifdef CONFIG_MTD_REDBOOT_PARTS
 334                 if (parsed_nr_parts == 0) {
 335                         int ret = parse_redboot_partitions(bcm963xx_mtd_info, &parsed_parts, 0);
 336                         if (ret > 0) {
 337                                 part_type = "RedBoot";
 338                                 parsed_nr_parts = ret;
 339                         }
 340                 }
 341 #endif
 342         }
 343
 344         return add_mtd_partitions(bcm963xx_mtd_info, parsed_parts, parsed_nr_parts);
 345
 346 err_probe:
 347         iounmap(bcm963xx_map.virt);
 348         return err;
 349 }
 350
 351 static int bcm963xx_remove(struct platform_device *pdev)
 352 {
 353         if (bcm963xx_mtd_info) {
 354                 del_mtd_partitions(bcm963xx_mtd_info);
 355                 map_destroy(bcm963xx_mtd_info);
 356         }
 357
 358         if (bcm963xx_map.virt) {
 359                 iounmap(bcm963xx_map.virt);
 360                 bcm963xx_map.virt = 0;
 361         }
 362
 363         return 0;
 364 }
 365
 366 static struct platform_driver bcm63xx_mtd_dev = {
 367         .probe  = bcm963xx_probe,
 368         .remove = bcm963xx_remove,
 369         .driver = {
 370                 .name   = "bcm963xx-flash",
 371                 .owner  = THIS_MODULE,
 372         },
 373 };
 374
 375 static int __init bcm963xx_mtd_init(void)
 376 {
 377         return platform_driver_register(&bcm63xx_mtd_dev);
 378 }
 379
 380 static void __exit bcm963xx_mtd_exit(void)
 381 {
 382         platform_driver_unregister(&bcm63xx_mtd_dev);
 383 }
 384
 385 module_init(bcm963xx_mtd_init);
 386 module_exit(bcm963xx_mtd_exit);
 387
 388 MODULE_LICENSE("GPL");
 389 MODULE_DESCRIPTION("Broadcom BCM63xx MTD partition parser/mapping for CFE and RedBoot");
 390 MODULE_AUTHOR("Florian Fainelli <florian@openwrt.org>");
 391 MODULE_AUTHOR("Mike Albon <malbon@openwrt.org>");