target/linux/adm5120-2.6/files/drivers/mtd/maps/adm5120_mtd.c

   1 /*
   2  *  Copyright (C) 2006 Felix Fietkau <nbd@openwrt.org>
   3  *  Copyright (C) 2005 Waldemar Brodkorb <wbx@openwrt.org>
   4  *  Copyright (C) 2004 Florian Schirmer (jolt@tuxbox.org)
   5  *
   6  *  original functions for finding root filesystem from Mike Baker
   7  *
   8  *  This program is free software; you can redistribute  it and/or modify it
   9  *  under  the terms of  the GNU General  Public License as published by the
  10  *  Free Software Foundation;  either version 2 of the  License, or (at your
  11  *  option) any later version.
  12  *
  13  *  THIS  SOFTWARE  IS PROVIDED   ``AS  IS'' AND   ANY  EXPRESS OR IMPLIED
  14  *  WARRANTIES,   INCLUDING, BUT NOT  LIMITED  TO, THE IMPLIED WARRANTIES OF
  15  *  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN
  16  *  NO  EVENT  SHALL   THE AUTHOR  BE    LIABLE FOR ANY   DIRECT, INDIRECT,
  17  *  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18  *  NOT LIMITED   TO, PROCUREMENT OF  SUBSTITUTE GOODS  OR SERVICES; LOSS OF
  19  *  USE, DATA,  OR PROFITS; OR  BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
  20  *  ANY THEORY OF LIABILITY, WHETHER IN  CONTRACT, STRICT LIABILITY, OR TORT
  21  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22  *  THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23  *
  24  *  You should have received a copy of the  GNU General Public License along
  25  *  with this program; if not, write  to the Free Software Foundation, Inc.,
  26  *  675 Mass Ave, Cambridge, MA 02139, USA.
  27  *
  28  *  Copyright 2001-2003, Broadcom Corporation
  29  *  All Rights Reserved.
  30  *
  31  *  THIS SOFTWARE IS OFFERED "AS IS", AND BROADCOM GRANTS NO WARRANTIES OF ANY
  32  *  KIND, EXPRESS OR IMPLIED, BY STATUTE, COMMUNICATION OR OTHERWISE. BROADCOM
  33  *  SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS
  34  *  FOR A SPECIFIC PURPOSE OR NONINFRINGEMENT CONCERNING THIS SOFTWARE.
  35  *
  36  *  Flash mapping for ADM5120 boards
  37  */
  38
  39 #include <linux/init.h>
  40 #include <linux/module.h>
  41 #include <linux/types.h>
  42 #include <linux/kernel.h>
  43 #include <linux/wait.h>
  44 #include <linux/mtd/mtd.h>
  45 #include <linux/mtd/map.h>
  46 #ifdef CONFIG_MTD_PARTITIONS
  47 #include <linux/mtd/partitions.h>
  48 #endif
  49 #include <linux/squashfs_fs.h>
  50 #include <linux/jffs2.h>
  51 #include <linux/crc32.h>
  52 #include <asm/io.h>
  53 #include <asm/mach-adm5120/myloader.h>
  54 #include <asm/mach-adm5120/adm5120_info.h>
  55
  56 extern int parse_myloader_partitions(struct mtd_info *master,
  57                         struct mtd_partition **pparts,
  58                         unsigned long origin);
  59
  60 /* Macros for switching flash bank
  61    ADM5120 only support 2MB flash address space
  62    so GPIO5 is used as A20
  63  */
  64 #define GPIO_IO        ((volatile unsigned long *)0xb20000b8)
  65 #define FLASH_A20_GPIO  5
  66 #define FLASH_BOUNDARY  0x200000
  67
  68
  69 #define TRX_MAGIC       0x30524448      /* "HDR0" */
  70 #define TRX_VERSION     1
  71 #define TRX_MAX_LEN     0x3A0000
  72 #define TRX_NO_HEADER   1               /* Do not write TRX header */
  73 #define TRX_GZ_FILES    0x2     /* Contains up to TRX_MAX_OFFSET individual gzip files */
  74 #define TRX_MAX_OFFSET  3
  75
  76 struct trx_header {
  77         u32 magic;              /* "HDR0" */
  78         u32 len;                /* Length of file including header */
  79         u32 crc32;              /* 32-bit CRC from flag_version to end of file */
  80         u32 flag_version;       /* 0:15 flags, 16:31 version */
  81         u32 offsets[TRX_MAX_OFFSET];    /* Offsets of partitions from start of header */
  82 };
  83
  84 #define ROUNDUP(x, y) ((((x)+((y)-1))/(y))*(y))
  85 #define NVRAM_SPACE 0x8000
  86 #define WINDOW_ADDR 0x1fc00000
  87 #define WINDOW_SIZE 0x400000
  88 #define BUSWIDTH 2
  89
  90 static struct mtd_info *adm5120_mtd;
  91
  92 static struct map_info adm5120_map = {
  93         name: "adm5120 physically mapped flash",
  94         size: WINDOW_SIZE,
  95         bankwidth: BUSWIDTH,
  96         phys: WINDOW_ADDR,
  97 };
  98
  99 #ifdef CONFIG_MTD_PARTITIONS
 100
 101 static struct mtd_partition adm5120_cfe_parts[] = {
 102         { name: "cfe",  offset: 0, size: 0, mask_flags: MTD_WRITEABLE, },
 103         { name: "linux", offset: 0, size: 0, },
 104         { name: "rootfs", offset: 0, size: 0, },
 105         { name: "nvram", offset: 0, size: 0, },
 106         { name: "OpenWrt", offset: 0, size: 0, },
 107         { name: NULL, },
 108 };
 109
 110
 111 static void flash_switch_bank(unsigned long addr)
 112 {
 113         unsigned long val;
 114
 115         /* Set GPIO as output */
 116         val = *GPIO_IO | (1 << (FLASH_A20_GPIO+16));
 117         if ( addr & FLASH_BOUNDARY ) {
 118                 val |= 1 << (FLASH_A20_GPIO + 24);
 119         } else {
 120                 val &= ~(1 << (FLASH_A20_GPIO + 24));
 121         }
 122         *GPIO_IO = val;
 123 }
 124
 125 static map_word adm5120_map_read(struct map_info *map, unsigned long ofs)
 126 {
 127     flash_switch_bank(ofs);
 128         return inline_map_read(map, ofs);
 129 }
 130
 131 static void adm5120_map_write(struct map_info *map, const map_word datum, unsigned long ofs)
 132 {
 133     flash_switch_bank(ofs);
 134         inline_map_write(map, datum, ofs);
 135 }
 136
 137 static void adm5120_map_copy_from(struct map_info *map, void *to, unsigned long from, ssize_t len)
 138 {
 139         ssize_t tmp;
 140
 141         if (from < FLASH_BOUNDARY) {
 142                 tmp = (len < (FLASH_BOUNDARY - from)) ? len : (FLASH_BOUNDARY - from);
 143                 flash_switch_bank(0);
 144                 inline_map_copy_from(map, to, from, tmp);
 145                 to = (void *)((char *)to + tmp);
 146                 from += tmp;
 147                 len -= tmp;
 148         }
 149         if (len > 0) {
 150                 flash_switch_bank(FLASH_BOUNDARY);
 151                 inline_map_copy_from(map, to, from, len);
 152         }
 153
 154 }
 155
 156 static int __init
 157 find_cfe_size(struct mtd_info *mtd, size_t size)
 158 {
 159         struct trx_header *trx;
 160         unsigned char buf[512];
 161         int off;
 162         size_t len;
 163         int blocksize;
 164
 165         trx = (struct trx_header *) buf;
 166
 167         blocksize = mtd->erasesize;
 168         if (blocksize < 0x10000)
 169                 blocksize = 0x10000;
 170
 171         for (off = (128*1024); off < size; off += blocksize) {
 172                 memset(buf, 0xe5, sizeof(buf));
 173
 174                 /*
 175                  * Read into buffer
 176                  */
 177                 if (mtd->read(mtd, off, sizeof(buf), &len, buf) ||
 178                     len != sizeof(buf))
 179                         continue;
 180
 181                 /* found a TRX header */
 182                 if (le32_to_cpu(trx->magic) == TRX_MAGIC) {
 183                         goto found;
 184                 }
 185         }
 186
 187         printk(KERN_NOTICE
 188                "%s: Couldn't find bootloader size\n",
 189                mtd->name);
 190         return -1;
 191
 192  found:
 193         printk(KERN_NOTICE "bootloader size: %d\n", off);
 194         return off;
 195
 196 }
 197
 198 /*
 199  * Copied from mtdblock.c
 200  *
 201  * Cache stuff...
 202  *
 203  * Since typical flash erasable sectors are much larger than what Linux's
 204  * buffer cache can handle, we must implement read-modify-write on flash
 205  * sectors for each block write requests.  To avoid over-erasing flash sectors
 206  * and to speed things up, we locally cache a whole flash sector while it is
 207  * being written to until a different sector is required.
 208  */
 209
 210 static void erase_callback(struct erase_info *done)
 211 {
 212         wait_queue_head_t *wait_q = (wait_queue_head_t *)done->priv;
 213         wake_up(wait_q);
 214 }
 215
 216 static int erase_write (struct mtd_info *mtd, unsigned long pos,
 217                         int len, const char *buf)
 218 {
 219         struct erase_info erase;
 220         DECLARE_WAITQUEUE(wait, current);
 221         wait_queue_head_t wait_q;
 222         size_t retlen;
 223         int ret;
 224
 225         /*
 226          * First, let's erase the flash block.
 227          */
 228
 229         init_waitqueue_head(&wait_q);
 230         erase.mtd = mtd;
 231         erase.callback = erase_callback;
 232         erase.addr = pos;
 233         erase.len = len;
 234         erase.priv = (u_long)&wait_q;
 235
 236         set_current_state(TASK_INTERRUPTIBLE);
 237         add_wait_queue(&wait_q, &wait);
 238
 239         ret = mtd->erase(mtd, &erase);
 240         if (ret) {
 241                 set_current_state(TASK_RUNNING);
 242                 remove_wait_queue(&wait_q, &wait);
 243                 printk (KERN_WARNING "erase of region [0x%lx, 0x%x] "
 244                                      "on \"%s\" failed\n",
 245                         pos, len, mtd->name);
 246                 return ret;
 247         }
 248
 249         schedule();  /* Wait for erase to finish. */
 250         remove_wait_queue(&wait_q, &wait);
 251
 252         /*
 253          * Next, writhe data to flash.
 254          */
 255
 256         ret = mtd->write (mtd, pos, len, &retlen, buf);
 257         if (ret)
 258                 return ret;
 259         if (retlen != len)
 260                 return -EIO;
 261         return 0;
 262 }
 263
 264
 265
 266
 267 static int __init
 268 find_root(struct mtd_info *mtd, size_t size, struct mtd_partition *part)
 269 {
 270         struct trx_header trx, *trx2;
 271         unsigned char buf[512], *block;
 272         int off, blocksize;
 273         u32 i, crc = ~0;
 274         size_t len;
 275         struct squashfs_super_block *sb = (struct squashfs_super_block *) buf;
 276
 277         blocksize = mtd->erasesize;
 278         if (blocksize < 0x10000)
 279                 blocksize = 0x10000;
 280
 281         for (off = (128*1024); off < size; off += blocksize) {
 282                 memset(&trx, 0xe5, sizeof(trx));
 283
 284                 /*
 285                  * Read into buffer
 286                  */
 287                 if (mtd->read(mtd, off, sizeof(trx), &len, (char *) &trx) ||
 288                     len != sizeof(trx))
 289                         continue;
 290
 291                 /* found a TRX header */
 292                 if (le32_to_cpu(trx.magic) == TRX_MAGIC) {
 293                         part->offset = le32_to_cpu(trx.offsets[2]) ? :
 294                                 le32_to_cpu(trx.offsets[1]);
 295                         part->size = le32_to_cpu(trx.len);
 296
 297                         part->size -= part->offset;
 298                         part->offset += off;
 299
 300                         goto found;
 301                 }
 302         }
 303
 304         printk(KERN_NOTICE
 305                "%s: Couldn't find root filesystem\n",
 306                mtd->name);
 307         return -1;
 308
 309  found:
 310         if (part->size == 0)
 311                 return 0;
 312
 313         if (mtd->read(mtd, part->offset, sizeof(buf), &len, buf) || len != sizeof(buf))
 314                 return 0;
 315
 316         if (*((__u32 *) buf) == SQUASHFS_MAGIC) {
 317                 printk(KERN_INFO "%s: Filesystem type: squashfs, size=0x%x\n", mtd->name, (u32) sb->bytes_used);
 318
 319                 /* Update the squashfs partition size based on the superblock info */
 320                 part->size = sb->bytes_used;
 321                 len = part->offset + part->size;
 322                 len +=  (mtd->erasesize - 1);
 323                 len &= ~(mtd->erasesize - 1);
 324                 part->size = len - part->offset;
 325         } else if (*((__u16 *) buf) == JFFS2_MAGIC_BITMASK) {
 326                 printk(KERN_INFO "%s: Filesystem type: jffs2\n", mtd->name);
 327
 328                 /* Move the squashfs outside of the trx */
 329                 part->size = 0;
 330         } else {
 331                 printk(KERN_INFO "%s: Filesystem type: unknown\n", mtd->name);
 332                 return 0;
 333         }
 334
 335         if (trx.len != part->offset + part->size - off) {
 336                 /* Update the trx offsets and length */
 337                 trx.len = part->offset + part->size - off;
 338
 339                 /* Update the trx crc32 */
 340                 for (i = (u32) &(((struct trx_header *)NULL)->flag_version); i <= trx.len; i += sizeof(buf)) {
 341                         if (mtd->read(mtd, off + i, sizeof(buf), &len, buf) || len != sizeof(buf))
 342                                 return 0;
 343                         crc = crc32_le(crc, buf, min(sizeof(buf), trx.len - i));
 344                 }
 345                 trx.crc32 = crc;
 346
 347                 /* read first eraseblock from the trx */
 348                 block = kmalloc(mtd->erasesize, GFP_KERNEL);
 349                 trx2 = (struct trx_header *) block;
 350                 if (mtd->read(mtd, off, mtd->erasesize, &len, block) || len != mtd->erasesize) {
 351                         printk("Error accessing the first trx eraseblock\n");
 352                         return 0;
 353                 }
 354
 355                 printk("Updating TRX offsets and length:\n");
 356                 printk("old trx = [0x%08x, 0x%08x, 0x%08x], len=0x%08x crc32=0x%08x\n", trx2->offsets[0], trx2->offsets[1], trx2->offsets[2], trx2->len, trx2->crc32);
 357                 printk("new trx = [0x%08x, 0x%08x, 0x%08x], len=0x%08x crc32=0x%08x\n",   trx.offsets[0],   trx.offsets[1],   trx.offsets[2],   trx.len, trx.crc32);
 358
 359                 /* Write updated trx header to the flash */
 360                 memcpy(block, &trx, sizeof(trx));
 361                 if (mtd->unlock)
 362                         mtd->unlock(mtd, off, mtd->erasesize);
 363                 erase_write(mtd, off, mtd->erasesize, block);
 364                 if (mtd->sync)
 365                         mtd->sync(mtd);
 366                 kfree(block);
 367                 printk("Done\n");
 368         }
 369
 370         return part->size;
 371 }
 372
 373 struct mtd_partition * __init
 374 init_mtd_partitions(struct mtd_info *mtd, size_t size)
 375 {
 376         int cfe_size;
 377
 378         if ((cfe_size = find_cfe_size(mtd,size)) < 0)
 379                 return NULL;
 380
 381         /* boot loader */
 382         adm5120_cfe_parts[0].offset = 0;
 383         adm5120_cfe_parts[0].size   = cfe_size;
 384
 385         /* nvram */
 386         if (cfe_size != 384 * 1024) {
 387                 adm5120_cfe_parts[3].offset = size - ROUNDUP(NVRAM_SPACE, mtd->erasesize);
 388                 adm5120_cfe_parts[3].size   = ROUNDUP(NVRAM_SPACE, mtd->erasesize);
 389         } else {
 390                 /* nvram (old 128kb config partition on netgear wgt634u) */
 391                 adm5120_cfe_parts[3].offset = adm5120_cfe_parts[0].size;
 392                 adm5120_cfe_parts[3].size   = ROUNDUP(NVRAM_SPACE, mtd->erasesize);
 393         }
 394
 395         /* linux (kernel and rootfs) */
 396         if (cfe_size != 384 * 1024) {
 397                 adm5120_cfe_parts[1].offset = adm5120_cfe_parts[0].size;
 398                 adm5120_cfe_parts[1].size   = adm5120_cfe_parts[3].offset -
 399                         adm5120_cfe_parts[1].offset;
 400         } else {
 401                 /* do not count the elf loader, which is on one block */
 402                 adm5120_cfe_parts[1].offset = adm5120_cfe_parts[0].size +
 403                         adm5120_cfe_parts[3].size + mtd->erasesize;
 404                 adm5120_cfe_parts[1].size   = size -
 405                         adm5120_cfe_parts[0].size -
 406                         (2*adm5120_cfe_parts[3].size) -
 407                         mtd->erasesize;
 408         }
 409
 410         /* find and size rootfs */
 411         if (find_root(mtd,size,&adm5120_cfe_parts[2])==0) {
 412                 /* entirely jffs2 */
 413                 adm5120_cfe_parts[4].name = NULL;
 414                 adm5120_cfe_parts[2].size = size - adm5120_cfe_parts[2].offset -
 415                                 adm5120_cfe_parts[3].size;
 416         } else {
 417                 /* legacy setup */
 418                 /* calculate leftover flash, and assign it to the jffs2 partition */
 419                 if (cfe_size != 384 * 1024) {
 420                         adm5120_cfe_parts[4].offset = adm5120_cfe_parts[2].offset +
 421                                 adm5120_cfe_parts[2].size;
 422                         if ((adm5120_cfe_parts[4].offset % mtd->erasesize) > 0) {
 423                                 adm5120_cfe_parts[4].offset += mtd->erasesize -
 424                                         (adm5120_cfe_parts[4].offset % mtd->erasesize);
 425                         }
 426                         adm5120_cfe_parts[4].size = adm5120_cfe_parts[3].offset -
 427                                 adm5120_cfe_parts[4].offset;
 428                 } else {
 429                         adm5120_cfe_parts[4].offset = adm5120_cfe_parts[2].offset +
 430                                 adm5120_cfe_parts[2].size;
 431                         if ((adm5120_cfe_parts[4].offset % mtd->erasesize) > 0) {
 432                                 adm5120_cfe_parts[4].offset += mtd->erasesize -
 433                                         (adm5120_cfe_parts[4].offset % mtd->erasesize);
 434                         }
 435                         adm5120_cfe_parts[4].size = size - adm5120_cfe_parts[3].size -
 436                                 adm5120_cfe_parts[4].offset;
 437                 }
 438         }
 439
 440         return adm5120_cfe_parts;
 441 }
 442 #endif
 443
 444 int __init init_adm5120_map(void)
 445 {
 446         size_t size;
 447         int ret = 0;
 448 #if defined (CONFIG_MTD_PARTITIONS) || (CONFIG_MTD_MYLOADER_PARTS)
 449         struct mtd_partition *parts;
 450         int i, parsed_nr_parts = 0;
 451 #endif
 452         printk("adm5120 : flash init : 0x%08x 0x%08x\n", WINDOW_ADDR, WINDOW_SIZE);
 453         adm5120_map.virt = ioremap_nocache(WINDOW_ADDR, WINDOW_SIZE);
 454
 455         if (!adm5120_map.virt) {
 456                 printk("Failed to ioremap\n");
 457                 return -EIO;
 458         }
 459         simple_map_init(&adm5120_map);
 460         adm5120_map.read = adm5120_map_read;
 461         adm5120_map.write = adm5120_map_write;
 462         adm5120_map.copy_from = adm5120_map_copy_from;
 463
 464         if (!(adm5120_mtd = do_map_probe("cfi_probe", &adm5120_map))) {
 465                 printk("Failed to do_map_probe\n");
 466                 iounmap((void *)adm5120_map.virt);
 467                 return -ENXIO;
 468         }
 469
 470         adm5120_mtd->owner = THIS_MODULE;
 471
 472         size = adm5120_mtd->size;
 473
 474         printk(KERN_NOTICE "Flash device: 0x%x at 0x%x\n", size, WINDOW_ADDR);
 475
 476 #ifdef CONFIG_MTD_PARTITIONS
 477
 478         if (adm5120_boot_loader == BOOT_LOADER_CFE)
 479         {
 480                 printk(KERN_NOTICE "adm5120 : using CFE flash mapping\n");
 481                 parts = init_mtd_partitions(adm5120_mtd, size);
 482
 483                 for (i = 0; parts[i].name; i++);
 484                         ret = add_mtd_partitions(adm5120_mtd, parts, i);
 485
 486                 if (ret) {
 487                         printk(KERN_ERR "Flash: add_mtd_partitions failed\n");
 488                         goto fail;
 489                 }
 490         }
 491 #endif
 492 #ifdef CONFIG_MTD_MYLOADER_PARTS
 493         if (adm5120_boot_loader == BOOT_LOADER_MYLOADER)
 494         {
 495                 printk(KERN_NOTICE "adm5120 : using MyLoader flash mapping\n");
 496                 char *part_type;
 497
 498                 if (parsed_nr_parts == 0) {
 499                         ret = parse_myloader_partitions(adm5120_mtd, &parts, 0);
 500
 501                         if (ret  > 0) {
 502                                 part_type ="MyLoader";
 503                                 parsed_nr_parts = ret;
 504                         }
 505                 }
 506                 ret = add_mtd_partitions(adm5120_mtd, parts, parsed_nr_parts);
 507
 508                 if (ret) {
 509                         printk(KERN_ERR "Flash: add_mtd_partitions failed\n");
 510                         goto fail;
 511                 }
 512         }
 513 #endif
 514         return 0;
 515
 516  fail:
 517         if (adm5120_mtd)
 518                 map_destroy(adm5120_mtd);
 519         if (adm5120_map.virt)
 520                 iounmap((void *)adm5120_map.virt);
 521         adm5120_map.virt = 0;
 522         return ret;
 523 }
 524
 525 void __exit cleanup_adm5120_map(void)
 526 {
 527 #ifdef CONFIG_MTD_PARTITIONS
 528         del_mtd_partitions(adm5120_mtd);
 529 #endif
 530         map_destroy(adm5120_mtd);
 531         iounmap((void *)adm5120_map.virt);
 532 }
 533
 534 module_init(init_adm5120_map);
 535 module_exit(cleanup_adm5120_map);