drivers/mtd/nand/au1550nd.c

   1 /*
   2  *  drivers/mtd/nand/au1550nd.c
   3  *
   4  *  Copyright (C) 2004 Embedded Edge, LLC
   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 version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  */
  11
  12 #include <linux/slab.h>
  13 #include <linux/gpio.h>
  14 #include <linux/module.h>
  15 #include <linux/interrupt.h>
  16 #include <linux/mtd/mtd.h>
  17 #include <linux/mtd/nand.h>
  18 #include <linux/mtd/partitions.h>
  19 #include <linux/platform_device.h>
  20 #include <asm/io.h>
  21 #include <asm/mach-au1x00/au1000.h>
  22 #include <asm/mach-au1x00/au1550nd.h>
  23
  24
  25 struct au1550nd_ctx {
  26         struct mtd_info info;
  27         struct nand_chip chip;
  28
  29         int cs;
  30         void __iomem *base;
  31         void (*write_byte)(struct mtd_info *, u_char);
  32 };
  33
  34 /**
  35  * au_read_byte -  read one byte from the chip
  36  * @mtd:        MTD device structure
  37  *
  38  * read function for 8bit buswidth
  39  */
  40 static u_char au_read_byte(struct mtd_info *mtd)
  41 {
  42         struct nand_chip *this = mtd->priv;
  43         u_char ret = readb(this->IO_ADDR_R);
  44         au_sync();
  45         return ret;
  46 }
  47
  48 /**
  49  * au_write_byte -  write one byte to the chip
  50  * @mtd:        MTD device structure
  51  * @byte:       pointer to data byte to write
  52  *
  53  * write function for 8it buswidth
  54  */
  55 static void au_write_byte(struct mtd_info *mtd, u_char byte)
  56 {
  57         struct nand_chip *this = mtd->priv;
  58         writeb(byte, this->IO_ADDR_W);
  59         au_sync();
  60 }
  61
  62 /**
  63  * au_read_byte16 -  read one byte endianness aware from the chip
  64  * @mtd:        MTD device structure
  65  *
  66  * read function for 16bit buswidth with endianness conversion
  67  */
  68 static u_char au_read_byte16(struct mtd_info *mtd)
  69 {
  70         struct nand_chip *this = mtd->priv;
  71         u_char ret = (u_char) cpu_to_le16(readw(this->IO_ADDR_R));
  72         au_sync();
  73         return ret;
  74 }
  75
  76 /**
  77  * au_write_byte16 -  write one byte endianness aware to the chip
  78  * @mtd:        MTD device structure
  79  * @byte:       pointer to data byte to write
  80  *
  81  * write function for 16bit buswidth with endianness conversion
  82  */
  83 static void au_write_byte16(struct mtd_info *mtd, u_char byte)
  84 {
  85         struct nand_chip *this = mtd->priv;
  86         writew(le16_to_cpu((u16) byte), this->IO_ADDR_W);
  87         au_sync();
  88 }
  89
  90 /**
  91  * au_read_word -  read one word from the chip
  92  * @mtd:        MTD device structure
  93  *
  94  * read function for 16bit buswidth without endianness conversion
  95  */
  96 static u16 au_read_word(struct mtd_info *mtd)
  97 {
  98         struct nand_chip *this = mtd->priv;
  99         u16 ret = readw(this->IO_ADDR_R);
 100         au_sync();
 101         return ret;
 102 }
 103
 104 /**
 105  * au_write_buf -  write buffer to chip
 106  * @mtd:        MTD device structure
 107  * @buf:        data buffer
 108  * @len:        number of bytes to write
 109  *
 110  * write function for 8bit buswidth
 111  */
 112 static void au_write_buf(struct mtd_info *mtd, const u_char *buf, int len)
 113 {
 114         int i;
 115         struct nand_chip *this = mtd->priv;
 116
 117         for (i = 0; i < len; i++) {
 118                 writeb(buf[i], this->IO_ADDR_W);
 119                 au_sync();
 120         }
 121 }
 122
 123 /**
 124  * au_read_buf -  read chip data into buffer
 125  * @mtd:        MTD device structure
 126  * @buf:        buffer to store date
 127  * @len:        number of bytes to read
 128  *
 129  * read function for 8bit buswidth
 130  */
 131 static void au_read_buf(struct mtd_info *mtd, u_char *buf, int len)
 132 {
 133         int i;
 134         struct nand_chip *this = mtd->priv;
 135
 136         for (i = 0; i < len; i++) {
 137                 buf[i] = readb(this->IO_ADDR_R);
 138                 au_sync();
 139         }
 140 }
 141
 142 /**
 143  * au_write_buf16 -  write buffer to chip
 144  * @mtd:        MTD device structure
 145  * @buf:        data buffer
 146  * @len:        number of bytes to write
 147  *
 148  * write function for 16bit buswidth
 149  */
 150 static void au_write_buf16(struct mtd_info *mtd, const u_char *buf, int len)
 151 {
 152         int i;
 153         struct nand_chip *this = mtd->priv;
 154         u16 *p = (u16 *) buf;
 155         len >>= 1;
 156
 157         for (i = 0; i < len; i++) {
 158                 writew(p[i], this->IO_ADDR_W);
 159                 au_sync();
 160         }
 161
 162 }
 163
 164 /**
 165  * au_read_buf16 -  read chip data into buffer
 166  * @mtd:        MTD device structure
 167  * @buf:        buffer to store date
 168  * @len:        number of bytes to read
 169  *
 170  * read function for 16bit buswidth
 171  */
 172 static void au_read_buf16(struct mtd_info *mtd, u_char *buf, int len)
 173 {
 174         int i;
 175         struct nand_chip *this = mtd->priv;
 176         u16 *p = (u16 *) buf;
 177         len >>= 1;
 178
 179         for (i = 0; i < len; i++) {
 180                 p[i] = readw(this->IO_ADDR_R);
 181                 au_sync();
 182         }
 183 }
 184
 185 /* Select the chip by setting nCE to low */
 186 #define NAND_CTL_SETNCE         1
 187 /* Deselect the chip by setting nCE to high */
 188 #define NAND_CTL_CLRNCE         2
 189 /* Select the command latch by setting CLE to high */
 190 #define NAND_CTL_SETCLE         3
 191 /* Deselect the command latch by setting CLE to low */
 192 #define NAND_CTL_CLRCLE         4
 193 /* Select the address latch by setting ALE to high */
 194 #define NAND_CTL_SETALE         5
 195 /* Deselect the address latch by setting ALE to low */
 196 #define NAND_CTL_CLRALE         6
 197
 198 static void au1550_hwcontrol(struct mtd_info *mtd, int cmd)
 199 {
 200         struct au1550nd_ctx *ctx = container_of(mtd, struct au1550nd_ctx, info);
 201         struct nand_chip *this = mtd->priv;
 202
 203         switch (cmd) {
 204
 205         case NAND_CTL_SETCLE:
 206                 this->IO_ADDR_W = ctx->base + MEM_STNAND_CMD;
 207                 break;
 208
 209         case NAND_CTL_CLRCLE:
 210                 this->IO_ADDR_W = ctx->base + MEM_STNAND_DATA;
 211                 break;
 212
 213         case NAND_CTL_SETALE:
 214                 this->IO_ADDR_W = ctx->base + MEM_STNAND_ADDR;
 215                 break;
 216
 217         case NAND_CTL_CLRALE:
 218                 this->IO_ADDR_W = ctx->base + MEM_STNAND_DATA;
 219                 /* FIXME: Nobody knows why this is necessary,
 220                  * but it works only that way */
 221                 udelay(1);
 222                 break;
 223
 224         case NAND_CTL_SETNCE:
 225                 /* assert (force assert) chip enable */
 226                 au_writel((1 << (4 + ctx->cs)), MEM_STNDCTL);
 227                 break;
 228
 229         case NAND_CTL_CLRNCE:
 230                 /* deassert chip enable */
 231                 au_writel(0, MEM_STNDCTL);
 232                 break;
 233         }
 234
 235         this->IO_ADDR_R = this->IO_ADDR_W;
 236
 237         /* Drain the writebuffer */
 238         au_sync();
 239 }
 240
 241 int au1550_device_ready(struct mtd_info *mtd)
 242 {
 243         int ret = (au_readl(MEM_STSTAT) & 0x1) ? 1 : 0;
 244         au_sync();
 245         return ret;
 246 }
 247
 248 /**
 249  * au1550_select_chip - control -CE line
 250  *      Forbid driving -CE manually permitting the NAND controller to do this.
 251  *      Keeping -CE asserted during the whole sector reads interferes with the
 252  *      NOR flash and PCMCIA drivers as it causes contention on the static bus.
 253  *      We only have to hold -CE low for the NAND read commands since the flash
 254  *      chip needs it to be asserted during chip not ready time but the NAND
 255  *      controller keeps it released.
 256  *
 257  * @mtd:        MTD device structure
 258  * @chip:       chipnumber to select, -1 for deselect
 259  */
 260 static void au1550_select_chip(struct mtd_info *mtd, int chip)
 261 {
 262 }
 263
 264 /**
 265  * au1550_command - Send command to NAND device
 266  * @mtd:        MTD device structure
 267  * @command:    the command to be sent
 268  * @column:     the column address for this command, -1 if none
 269  * @page_addr:  the page address for this command, -1 if none
 270  */
 271 static void au1550_command(struct mtd_info *mtd, unsigned command, int column, int page_addr)
 272 {
 273         struct au1550nd_ctx *ctx = container_of(mtd, struct au1550nd_ctx, info);
 274         struct nand_chip *this = mtd->priv;
 275         int ce_override = 0, i;
 276         unsigned long flags = 0;
 277
 278         /* Begin command latch cycle */
 279         au1550_hwcontrol(mtd, NAND_CTL_SETCLE);
 280         /*
 281          * Write out the command to the device.
 282          */
 283         if (command == NAND_CMD_SEQIN) {
 284                 int readcmd;
 285
 286                 if (column >= mtd->writesize) {
 287                         /* OOB area */
 288                         column -= mtd->writesize;
 289                         readcmd = NAND_CMD_READOOB;
 290                 } else if (column < 256) {
 291                         /* First 256 bytes --> READ0 */
 292                         readcmd = NAND_CMD_READ0;
 293                 } else {
 294                         column -= 256;
 295                         readcmd = NAND_CMD_READ1;
 296                 }
 297                 ctx->write_byte(mtd, readcmd);
 298         }
 299         ctx->write_byte(mtd, command);
 300
 301         /* Set ALE and clear CLE to start address cycle */
 302         au1550_hwcontrol(mtd, NAND_CTL_CLRCLE);
 303
 304         if (column != -1 || page_addr != -1) {
 305                 au1550_hwcontrol(mtd, NAND_CTL_SETALE);
 306
 307                 /* Serially input address */
 308                 if (column != -1) {
 309                         /* Adjust columns for 16 bit buswidth */
 310                         if (this->options & NAND_BUSWIDTH_16)
 311                                 column >>= 1;
 312                         ctx->write_byte(mtd, column);
 313                 }
 314                 if (page_addr != -1) {
 315                         ctx->write_byte(mtd, (u8)(page_addr & 0xff));
 316
 317                         if (command == NAND_CMD_READ0 ||
 318                             command == NAND_CMD_READ1 ||
 319                             command == NAND_CMD_READOOB) {
 320                                 /*
 321                                  * NAND controller will release -CE after
 322                                  * the last address byte is written, so we'll
 323                                  * have to forcibly assert it. No interrupts
 324                                  * are allowed while we do this as we don't
 325                                  * want the NOR flash or PCMCIA drivers to
 326                                  * steal our precious bytes of data...
 327                                  */
 328                                 ce_override = 1;
 329                                 local_irq_save(flags);
 330                                 au1550_hwcontrol(mtd, NAND_CTL_SETNCE);
 331                         }
 332
 333                         ctx->write_byte(mtd, (u8)(page_addr >> 8));
 334
 335                         /* One more address cycle for devices > 32MiB */
 336                         if (this->chipsize > (32 << 20))
 337                                 ctx->write_byte(mtd,
 338                                                 ((page_addr >> 16) & 0x0f));
 339                 }
 340                 /* Latch in address */
 341                 au1550_hwcontrol(mtd, NAND_CTL_CLRALE);
 342         }
 343
 344         /*
 345          * Program and erase have their own busy handlers.
 346          * Status and sequential in need no delay.
 347          */
 348         switch (command) {
 349
 350         case NAND_CMD_PAGEPROG:
 351         case NAND_CMD_ERASE1:
 352         case NAND_CMD_ERASE2:
 353         case NAND_CMD_SEQIN:
 354         case NAND_CMD_STATUS:
 355                 return;
 356
 357         case NAND_CMD_RESET:
 358                 break;
 359
 360         case NAND_CMD_READ0:
 361         case NAND_CMD_READ1:
 362         case NAND_CMD_READOOB:
 363                 /* Check if we're really driving -CE low (just in case) */
 364                 if (unlikely(!ce_override))
 365                         break;
 366
 367                 /* Apply a short delay always to ensure that we do wait tWB. */
 368                 ndelay(100);
 369                 /* Wait for a chip to become ready... */
 370                 for (i = this->chip_delay; !this->dev_ready(mtd) && i > 0; --i)
 371                         udelay(1);
 372
 373                 /* Release -CE and re-enable interrupts. */
 374                 au1550_hwcontrol(mtd, NAND_CTL_CLRNCE);
 375                 local_irq_restore(flags);
 376                 return;
 377         }
 378         /* Apply this short delay always to ensure that we do wait tWB. */
 379         ndelay(100);
 380
 381         while(!this->dev_ready(mtd));
 382 }
 383
 384 static int find_nand_cs(unsigned long nand_base)
 385 {
 386         void __iomem *base =
 387                         (void __iomem *)KSEG1ADDR(AU1000_STATIC_MEM_PHYS_ADDR);
 388         unsigned long addr, staddr, start, mask, end;
 389         int i;
 390
 391         for (i = 0; i < 4; i++) {
 392                 addr = 0x1000 + (i * 0x10);                     /* CSx */
 393                 staddr = __raw_readl(base + addr + 0x08);       /* STADDRx */
 394                 /* figure out the decoded range of this CS */
 395                 start = (staddr << 4) & 0xfffc0000;
 396                 mask = (staddr << 18) & 0xfffc0000;
 397                 end = (start | (start - 1)) & ~(start ^ mask);
 398                 if ((nand_base >= start) && (nand_base < end))
 399                         return i;
 400         }
 401
 402         return -ENODEV;
 403 }
 404
 405 static int au1550nd_probe(struct platform_device *pdev)
 406 {
 407         struct au1550nd_platdata *pd;
 408         struct au1550nd_ctx *ctx;
 409         struct nand_chip *this;
 410         struct resource *r;
 411         int ret, cs;
 412
 413         pd = dev_get_platdata(&pdev->dev);
 414         if (!pd) {
 415                 dev_err(&pdev->dev, "missing platform data\n");
 416                 return -ENODEV;
 417         }
 418
 419         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
 420         if (!ctx)
 421                 return -ENOMEM;
 422
 423         r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 424         if (!r) {
 425                 dev_err(&pdev->dev, "no NAND memory resource\n");
 426                 ret = -ENODEV;
 427                 goto out1;
 428         }
 429         if (request_mem_region(r->start, resource_size(r), "au1550-nand")) {
 430                 dev_err(&pdev->dev, "cannot claim NAND memory area\n");
 431                 ret = -ENOMEM;
 432                 goto out1;
 433         }
 434
 435         ctx->base = ioremap_nocache(r->start, 0x1000);
 436         if (!ctx->base) {
 437                 dev_err(&pdev->dev, "cannot remap NAND memory area\n");
 438                 ret = -ENODEV;
 439                 goto out2;
 440         }
 441
 442         this = &ctx->chip;
 443         ctx->info.priv = this;
 444         ctx->info.owner = THIS_MODULE;
 445
 446         /* figure out which CS# r->start belongs to */
 447         cs = find_nand_cs(r->start);
 448         if (cs < 0) {
 449                 dev_err(&pdev->dev, "cannot detect NAND chipselect\n");
 450                 ret = -ENODEV;
 451                 goto out3;
 452         }
 453         ctx->cs = cs;
 454
 455         this->dev_ready = au1550_device_ready;
 456         this->select_chip = au1550_select_chip;
 457         this->cmdfunc = au1550_command;
 458
 459         /* 30 us command delay time */
 460         this->chip_delay = 30;
 461         this->ecc.mode = NAND_ECC_SOFT;
 462
 463         if (pd->devwidth)
 464                 this->options |= NAND_BUSWIDTH_16;
 465
 466         this->read_byte = (pd->devwidth) ? au_read_byte16 : au_read_byte;
 467         ctx->write_byte = (pd->devwidth) ? au_write_byte16 : au_write_byte;
 468         this->read_word = au_read_word;
 469         this->write_buf = (pd->devwidth) ? au_write_buf16 : au_write_buf;
 470         this->read_buf = (pd->devwidth) ? au_read_buf16 : au_read_buf;
 471
 472         ret = nand_scan(&ctx->info, 1);
 473         if (ret) {
 474                 dev_err(&pdev->dev, "NAND scan failed with %d\n", ret);
 475                 goto out3;
 476         }
 477
 478         mtd_device_register(&ctx->info, pd->parts, pd->num_parts);
 479
 480         platform_set_drvdata(pdev, ctx);
 481
 482         return 0;
 483
 484 out3:
 485         iounmap(ctx->base);
 486 out2:
 487         release_mem_region(r->start, resource_size(r));
 488 out1:
 489         kfree(ctx);
 490         return ret;
 491 }
 492
 493 static int au1550nd_remove(struct platform_device *pdev)
 494 {
 495         struct au1550nd_ctx *ctx = platform_get_drvdata(pdev);
 496         struct resource *r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 497
 498         nand_release(&ctx->info);
 499         iounmap(ctx->base);
 500         release_mem_region(r->start, 0x1000);
 501         kfree(ctx);
 502         return 0;
 503 }
 504
 505 static struct platform_driver au1550nd_driver = {
 506         .driver = {
 507                 .name   = "au1550-nand",
 508                 .owner  = THIS_MODULE,
 509         },
 510         .probe          = au1550nd_probe,
 511         .remove         = au1550nd_remove,
 512 };
 513
 514 module_platform_driver(au1550nd_driver);
 515
 516 MODULE_LICENSE("GPL");
 517 MODULE_AUTHOR("Embedded Edge, LLC");
 518 MODULE_DESCRIPTION("Board-specific glue layer for NAND flash on Pb1550 board");