drivers/mtd/nand/tx4925ndfmc.c

   1 /*
   2  *  drivers/mtd/tx4925ndfmc.c
   3  *
   4  *  Overview:
   5  *   This is a device driver for the NAND flash device found on the
   6  *   Toshiba RBTX4925 reference board, which is a SmartMediaCard. It supports
   7  *   16MiB, 32MiB and 64MiB cards.
   8  *
   9  * Author: MontaVista Software, Inc.  source@mvista.com
  10  *
  11  * Derived from drivers/mtd/autcpu12.c
  12  *       Copyright (c) 2001 Thomas Gleixner (gleixner@autronix.de)
  13  *
  14  * $Id: tx4925ndfmc.c,v 1.3 2004/07/20 02:44:26 dwmw2 Exp $
  15  *
  16  * Copyright (C) 2001 Toshiba Corporation
  17  *
  18  * 2003 (c) MontaVista Software, Inc. This file is licensed under
  19  * the terms of the GNU General Public License version 2. This program
  20  * is licensed "as is" without any warranty of any kind, whether express
  21  * or implied.
  22  *
  23  */
  24
  25 #include <linux/slab.h>
  26 #include <linux/init.h>
  27 #include <linux/module.h>
  28 #include <linux/mtd/mtd.h>
  29 #include <linux/mtd/nand.h>
  30 #include <linux/mtd/partitions.h>
  31 #include <linux/delay.h>
  32 #include <asm/io.h>
  33 #include <asm/tx4925/tx4925_nand.h>
  34
  35 extern struct nand_oobinfo jffs2_oobinfo;
  36
  37 /*
  38  * MTD structure for RBTX4925 board
  39  */
  40 static struct mtd_info *tx4925ndfmc_mtd = NULL;
  41
  42 /*
  43  * Define partitions for flash devices
  44  */
  45
  46 static struct mtd_partition partition_info16k[] = {
  47         { .name = "RBTX4925 flash partition 1",
  48           .offset =  0,
  49           .size =    8 * 0x00100000 },
  50         { .name = "RBTX4925 flash partition 2",
  51           .offset =  8 * 0x00100000,
  52           .size =    8 * 0x00100000 },
  53 };
  54
  55 static struct mtd_partition partition_info32k[] = {
  56         { .name = "RBTX4925 flash partition 1",
  57           .offset =  0,
  58           .size =    8 * 0x00100000 },
  59         { .name = "RBTX4925 flash partition 2",
  60           .offset = 8 * 0x00100000,
  61           .size =  24 * 0x00100000 },
  62 };
  63
  64 static struct mtd_partition partition_info64k[] = {
  65         { .name = "User FS",
  66           .offset =  0,
  67           .size =   16 * 0x00100000 },
  68         { .name = "RBTX4925 flash partition 2",
  69           .offset = 16 * 0x00100000,
  70           .size =   48 * 0x00100000},
  71 };
  72
  73 static struct mtd_partition partition_info128k[] = {
  74         { .name = "Skip bad section",
  75           .offset =  0,
  76           .size =   16 * 0x00100000 },
  77         { .name = "User FS",
  78           .offset = 16 * 0x00100000,
  79           .size =   112 * 0x00100000 },
  80 };
  81 #define NUM_PARTITIONS16K  2
  82 #define NUM_PARTITIONS32K  2
  83 #define NUM_PARTITIONS64K  2
  84 #define NUM_PARTITIONS128K 2
  85
  86 /*
  87  *      hardware specific access to control-lines
  88 */
  89 static void tx4925ndfmc_hwcontrol(struct mtd_info *mtd, int cmd)
  90 {
  91
  92         switch(cmd){
  93
  94                 case NAND_CTL_SETCLE:
  95                         tx4925_ndfmcptr->mcr |= TX4925_NDFMCR_CLE;
  96                         break;
  97                 case NAND_CTL_CLRCLE:
  98                         tx4925_ndfmcptr->mcr &= ~TX4925_NDFMCR_CLE;
  99                         break;
 100                 case NAND_CTL_SETALE:
 101                         tx4925_ndfmcptr->mcr |= TX4925_NDFMCR_ALE;
 102                         break;
 103                 case NAND_CTL_CLRALE:
 104                         tx4925_ndfmcptr->mcr &= ~TX4925_NDFMCR_ALE;
 105                         break;
 106                 case NAND_CTL_SETNCE:
 107                         tx4925_ndfmcptr->mcr |= TX4925_NDFMCR_CE;
 108                         break;
 109                 case NAND_CTL_CLRNCE:
 110                         tx4925_ndfmcptr->mcr &= ~TX4925_NDFMCR_CE;
 111                         break;
 112                 case NAND_CTL_SETWP:
 113                         tx4925_ndfmcptr->mcr |= TX4925_NDFMCR_WE;
 114                         break;
 115                 case NAND_CTL_CLRWP:
 116                         tx4925_ndfmcptr->mcr &= ~TX4925_NDFMCR_WE;
 117                         break;
 118         }
 119 }
 120
 121 /*
 122 *       read device ready pin
 123 */
 124 static int tx4925ndfmc_device_ready(struct mtd_info *mtd)
 125 {
 126         int ready;
 127         ready = (tx4925_ndfmcptr->sr & TX4925_NDSFR_BUSY) ? 0 : 1;
 128         return ready;
 129 }
 130 void tx4925ndfmc_enable_hwecc(struct mtd_info *mtd, int mode)
 131 {
 132         /* reset first */
 133         tx4925_ndfmcptr->mcr |= TX4925_NDFMCR_ECC_CNTL_MASK;
 134         tx4925_ndfmcptr->mcr &= ~TX4925_NDFMCR_ECC_CNTL_MASK;
 135         tx4925_ndfmcptr->mcr |= TX4925_NDFMCR_ECC_CNTL_ENAB;
 136 }
 137 static void tx4925ndfmc_disable_ecc(void)
 138 {
 139         tx4925_ndfmcptr->mcr &= ~TX4925_NDFMCR_ECC_CNTL_MASK;
 140 }
 141 static void tx4925ndfmc_enable_read_ecc(void)
 142 {
 143         tx4925_ndfmcptr->mcr &= ~TX4925_NDFMCR_ECC_CNTL_MASK;
 144         tx4925_ndfmcptr->mcr |= TX4925_NDFMCR_ECC_CNTL_READ;
 145 }
 146 void tx4925ndfmc_readecc(struct mtd_info *mtd, const u_char *dat, u_char *ecc_code){
 147         int i;
 148         u_char *ecc = ecc_code;
 149         tx4925ndfmc_enable_read_ecc();
 150         for (i = 0;i < 6;i++,ecc++)
 151                 *ecc = tx4925_read_nfmc(&(tx4925_ndfmcptr->dtr));
 152         tx4925ndfmc_disable_ecc();
 153 }
 154 void tx4925ndfmc_device_setup(void)
 155 {
 156
 157         *(unsigned char *)0xbb005000 &= ~0x08;
 158
 159         /* reset NDFMC */
 160         tx4925_ndfmcptr->rstr |= TX4925_NDFRSTR_RST;
 161         while (tx4925_ndfmcptr->rstr & TX4925_NDFRSTR_RST);
 162
 163         /* setup BusSeparete, Hold Time, Strobe Pulse Width */
 164         tx4925_ndfmcptr->mcr = TX4925_BSPRT ? TX4925_NDFMCR_BSPRT : 0;
 165         tx4925_ndfmcptr->spr = TX4925_HOLD << 4 | TX4925_SPW;
 166 }
 167 static u_char tx4925ndfmc_nand_read_byte(struct mtd_info *mtd)
 168 {
 169         struct nand_chip *this = mtd->priv;
 170         return tx4925_read_nfmc(this->IO_ADDR_R);
 171 }
 172
 173 static void tx4925ndfmc_nand_write_byte(struct mtd_info *mtd, u_char byte)
 174 {
 175         struct nand_chip *this = mtd->priv;
 176         tx4925_write_nfmc(byte, this->IO_ADDR_W);
 177 }
 178
 179 static void tx4925ndfmc_nand_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
 180 {
 181         int i;
 182         struct nand_chip *this = mtd->priv;
 183
 184         for (i=0; i<len; i++)
 185                 tx4925_write_nfmc(buf[i], this->IO_ADDR_W);
 186 }
 187
 188 static void tx4925ndfmc_nand_read_buf(struct mtd_info *mtd, u_char *buf, int len)
 189 {
 190         int i;
 191         struct nand_chip *this = mtd->priv;
 192
 193         for (i=0; i<len; i++)
 194                 buf[i] = tx4925_read_nfmc(this->IO_ADDR_R);
 195 }
 196
 197 static int tx4925ndfmc_nand_verify_buf(struct mtd_info *mtd, const u_char *buf, int len)
 198 {
 199         int i;
 200         struct nand_chip *this = mtd->priv;
 201
 202         for (i=0; i<len; i++)
 203                 if (buf[i] != tx4925_read_nfmc(this->IO_ADDR_R))
 204                         return -EFAULT;
 205
 206         return 0;
 207 }
 208
 209 /*
 210  * Send command to NAND device
 211  */
 212 static void tx4925ndfmc_nand_command (struct mtd_info *mtd, unsigned command, int column, int page_addr)
 213 {
 214         register struct nand_chip *this = mtd->priv;
 215
 216         /* Begin command latch cycle */
 217         this->hwcontrol(mtd, NAND_CTL_SETCLE);
 218         /*
 219          * Write out the command to the device.
 220          */
 221         if (command == NAND_CMD_SEQIN) {
 222                 int readcmd;
 223
 224                 if (column >= mtd->oobblock) {
 225                         /* OOB area */
 226                         column -= mtd->oobblock;
 227                         readcmd = NAND_CMD_READOOB;
 228                 } else if (column < 256) {
 229                         /* First 256 bytes --> READ0 */
 230                         readcmd = NAND_CMD_READ0;
 231                 } else {
 232                         column -= 256;
 233                         readcmd = NAND_CMD_READ1;
 234                 }
 235                 this->write_byte(mtd, readcmd);
 236         }
 237         this->write_byte(mtd, command);
 238
 239         /* Set ALE and clear CLE to start address cycle */
 240         this->hwcontrol(mtd, NAND_CTL_CLRCLE);
 241
 242         if (column != -1 || page_addr != -1) {
 243                 this->hwcontrol(mtd, NAND_CTL_SETALE);
 244
 245                 /* Serially input address */
 246                 if (column != -1)
 247                         this->write_byte(mtd, column);
 248                 if (page_addr != -1) {
 249                         this->write_byte(mtd, (unsigned char) (page_addr & 0xff));
 250                         this->write_byte(mtd, (unsigned char) ((page_addr >> 8) & 0xff));
 251                         /* One more address cycle for higher density devices */
 252                         if (mtd->size & 0x0c000000)
 253                                 this->write_byte(mtd, (unsigned char) ((page_addr >> 16) & 0x0f));
 254                 }
 255                 /* Latch in address */
 256                 this->hwcontrol(mtd, NAND_CTL_CLRALE);
 257         }
 258
 259         /*
 260          * program and erase have their own busy handlers
 261          * status and sequential in needs no delay
 262         */
 263         switch (command) {
 264
 265         case NAND_CMD_PAGEPROG:
 266                 /* Turn off WE */
 267                 this->hwcontrol (mtd, NAND_CTL_CLRWP);
 268                 return;
 269
 270         case NAND_CMD_SEQIN:
 271                 /* Turn on WE */
 272                 this->hwcontrol (mtd, NAND_CTL_SETWP);
 273                 return;
 274
 275         case NAND_CMD_ERASE1:
 276         case NAND_CMD_ERASE2:
 277         case NAND_CMD_STATUS:
 278                 return;
 279
 280         case NAND_CMD_RESET:
 281                 if (this->dev_ready)
 282                         break;
 283                 this->hwcontrol(mtd, NAND_CTL_SETCLE);
 284                 this->write_byte(mtd, NAND_CMD_STATUS);
 285                 this->hwcontrol(mtd, NAND_CTL_CLRCLE);
 286                 while ( !(this->read_byte(mtd) & 0x40));
 287                 return;
 288
 289         /* This applies to read commands */
 290         default:
 291                 /*
 292                  * If we don't have access to the busy pin, we apply the given
 293                  * command delay
 294                 */
 295                 if (!this->dev_ready) {
 296                         udelay (this->chip_delay);
 297                         return;
 298                 }
 299         }
 300
 301         /* wait until command is processed */
 302         while (!this->dev_ready(mtd));
 303 }
 304
 305 #ifdef CONFIG_MTD_CMDLINE_PARTS
 306 extern int parse_cmdline_partitions(struct mtd_info *master, struct mtd_partitio
 307 n **pparts, char *);
 308 #endif
 309
 310 /*
 311  * Main initialization routine
 312  */
 313 extern int nand_correct_data(struct mtd_info *mtd, u_char *dat, u_char *read_ecc, u_char *calc_ecc);
 314 int __init tx4925ndfmc_init (void)
 315 {
 316         struct nand_chip *this;
 317         int err = 0;
 318
 319         /* Allocate memory for MTD device structure and private data */
 320         tx4925ndfmc_mtd = kmalloc (sizeof(struct mtd_info) + sizeof (struct nand_chip),
 321                                 GFP_KERNEL);
 322         if (!tx4925ndfmc_mtd) {
 323                 printk ("Unable to allocate RBTX4925 NAND MTD device structure.\n");
 324                 err = -ENOMEM;
 325                 goto out;
 326         }
 327
 328         tx4925ndfmc_device_setup();
 329
 330         /* io is indirect via a register so don't need to ioremap address */
 331
 332         /* Get pointer to private data */
 333         this = (struct nand_chip *) (&tx4925ndfmc_mtd[1]);
 334
 335         /* Initialize structures */
 336         memset((char *) tx4925ndfmc_mtd, 0, sizeof(struct mtd_info));
 337         memset((char *) this, 0, sizeof(struct nand_chip));
 338
 339         /* Link the private data with the MTD structure */
 340         tx4925ndfmc_mtd->priv = this;
 341
 342         /* Set address of NAND IO lines */
 343         this->IO_ADDR_R = (unsigned long)&(tx4925_ndfmcptr->dtr);
 344         this->IO_ADDR_W = (unsigned long)&(tx4925_ndfmcptr->dtr);
 345         this->hwcontrol = tx4925ndfmc_hwcontrol;
 346         this->enable_hwecc = tx4925ndfmc_enable_hwecc;
 347         this->calculate_ecc = tx4925ndfmc_readecc;
 348         this->correct_data = nand_correct_data;
 349         this->eccmode = NAND_ECC_HW6_512;
 350         this->dev_ready = tx4925ndfmc_device_ready;
 351         /* 20 us command delay time */
 352         this->chip_delay = 20;
 353         this->read_byte = tx4925ndfmc_nand_read_byte;
 354         this->write_byte = tx4925ndfmc_nand_write_byte;
 355         this->cmdfunc = tx4925ndfmc_nand_command;
 356         this->write_buf = tx4925ndfmc_nand_write_buf;
 357         this->read_buf = tx4925ndfmc_nand_read_buf;
 358         this->verify_buf = tx4925ndfmc_nand_verify_buf;
 359
 360         /* Scan to find existance of the device */
 361         if (nand_scan (tx4925ndfmc_mtd, 1)) {
 362                 err = -ENXIO;
 363                 goto out_ior;
 364         }
 365
 366         /* Allocate memory for internal data buffer */
 367         this->data_buf = kmalloc (sizeof(u_char) * (tx4925ndfmc_mtd->oobblock + tx4925ndfmc_mtd->oobsize), GFP_KERNEL);
 368         if (!this->data_buf) {
 369                 printk ("Unable to allocate NAND data buffer for RBTX4925.\n");
 370                 err = -ENOMEM;
 371                 goto out_ior;
 372         }
 373
 374         /* Register the partitions */
 375 #ifdef CONFIG_MTD_CMDLINE_PARTS
 376         {
 377                 int mtd_parts_nb = 0;
 378                 struct mtd_partition *mtd_parts = 0;
 379                 mtd_parts_nb = parse_cmdline_partitions(tx4925ndfmc_mtd, &mtd_parts, "tx4925ndfmc");
 380                 if (mtd_parts_nb > 0)
 381                         add_mtd_partitions(tx4925ndfmc_mtd, mtd_parts, mtd_parts_nb);
 382                 else
 383                         add_mtd_device(tx4925ndfmc_mtd);
 384         }
 385 #else /* ifdef CONFIG_MTD_CMDLINE_PARTS */
 386         switch(tx4925ndfmc_mtd->size){
 387                 case 0x01000000: add_mtd_partitions(tx4925ndfmc_mtd, partition_info16k, NUM_PARTITIONS16K); break;
 388                 case 0x02000000: add_mtd_partitions(tx4925ndfmc_mtd, partition_info32k, NUM_PARTITIONS32K); break;
 389                 case 0x04000000: add_mtd_partitions(tx4925ndfmc_mtd, partition_info64k, NUM_PARTITIONS64K); break;
 390                 case 0x08000000: add_mtd_partitions(tx4925ndfmc_mtd, partition_info128k, NUM_PARTITIONS128K); break;
 391                 default: {
 392                         printk ("Unsupported SmartMedia device\n");
 393                         err = -ENXIO;
 394                         goto out_buf;
 395                 }
 396         }
 397 #endif /* ifdef CONFIG_MTD_CMDLINE_PARTS */
 398         goto out;
 399
 400 out_buf:
 401         kfree (this->data_buf);
 402 out_ior:
 403 out:
 404         return err;
 405 }
 406
 407 module_init(tx4925ndfmc_init);
 408
 409 /*
 410  * Clean up routine
 411  */
 412 #ifdef MODULE
 413 static void __exit tx4925ndfmc_cleanup (void)
 414 {
 415         struct nand_chip *this = (struct nand_chip *) &tx4925ndfmc_mtd[1];
 416
 417         /* Unregister partitions */
 418         del_mtd_partitions(tx4925ndfmc_mtd);
 419
 420         /* Unregister the device */
 421         del_mtd_device (tx4925ndfmc_mtd);
 422
 423         /* Free internal data buffers */
 424         kfree (this->data_buf);
 425
 426         /* Free the MTD device structure */
 427         kfree (tx4925ndfmc_mtd);
 428 }
 429 module_exit(tx4925ndfmc_cleanup);
 430 #endif
 431
 432 MODULE_LICENSE("GPL");
 433 MODULE_AUTHOR("Alice Hennessy <ahennessy@mvista.com>");
 434 MODULE_DESCRIPTION("Glue layer for SmartMediaCard on Toshiba RBTX4925");