drivers/mtd/nand/bf5xx_nand.c

   1 /* linux/drivers/mtd/nand/bf5xx_nand.c
   2  *
   3  * Copyright 2006-2008 Analog Devices Inc.
   4  *      http://blackfin.uclinux.org/
   5  *      Bryan Wu <bryan.wu@analog.com>
   6  *
   7  * Blackfin BF5xx on-chip NAND flash controller driver
   8  *
   9  * Derived from drivers/mtd/nand/s3c2410.c
  10  * Copyright (c) 2007 Ben Dooks <ben@simtec.co.uk>
  11  *
  12  * Derived from drivers/mtd/nand/cafe.c
  13  * Copyright © 2006 Red Hat, Inc.
  14  * Copyright © 2006 David Woodhouse <dwmw2@infradead.org>
  15  *
  16  * Changelog:
  17  *      12-Jun-2007  Bryan Wu:  Initial version
  18  *      18-Jul-2007  Bryan Wu:
  19  *              - ECC_HW and ECC_SW supported
  20  *              - DMA supported in ECC_HW
  21  *              - YAFFS tested as rootfs in both ECC_HW and ECC_SW
  22  *
  23  * This program is free software; you can redistribute it and/or modify
  24  * it under the terms of the GNU General Public License as published by
  25  * the Free Software Foundation; either version 2 of the License, or
  26  * (at your option) any later version.
  27  *
  28  * This program is distributed in the hope that it will be useful,
  29  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  30  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  31  * GNU General Public License for more details.
  32  *
  33  * You should have received a copy of the GNU General Public License
  34  * along with this program; if not, write to the Free Software
  35  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  36 */
  37
  38 #include <linux/module.h>
  39 #include <linux/types.h>
  40 #include <linux/kernel.h>
  41 #include <linux/string.h>
  42 #include <linux/ioport.h>
  43 #include <linux/platform_device.h>
  44 #include <linux/delay.h>
  45 #include <linux/dma-mapping.h>
  46 #include <linux/err.h>
  47 #include <linux/slab.h>
  48 #include <linux/io.h>
  49 #include <linux/bitops.h>
  50
  51 #include <linux/mtd/mtd.h>
  52 #include <linux/mtd/rawnand.h>
  53 #include <linux/mtd/nand_ecc.h>
  54 #include <linux/mtd/partitions.h>
  55
  56 #include <asm/blackfin.h>
  57 #include <asm/dma.h>
  58 #include <asm/cacheflush.h>
  59 #include <asm/nand.h>
  60 #include <asm/portmux.h>
  61
  62 #define DRV_NAME        "bf5xx-nand"
  63 #define DRV_VERSION     "1.2"
  64 #define DRV_AUTHOR      "Bryan Wu <bryan.wu@analog.com>"
  65 #define DRV_DESC        "BF5xx on-chip NAND FLash Controller Driver"
  66
  67 /* NFC_STAT Masks */
  68 #define NBUSY       0x01  /* Not Busy */
  69 #define WB_FULL     0x02  /* Write Buffer Full */
  70 #define PG_WR_STAT  0x04  /* Page Write Pending */
  71 #define PG_RD_STAT  0x08  /* Page Read Pending */
  72 #define WB_EMPTY    0x10  /* Write Buffer Empty */
  73
  74 /* NFC_IRQSTAT Masks */
  75 #define NBUSYIRQ    0x01  /* Not Busy IRQ */
  76 #define WB_OVF      0x02  /* Write Buffer Overflow */
  77 #define WB_EDGE     0x04  /* Write Buffer Edge Detect */
  78 #define RD_RDY      0x08  /* Read Data Ready */
  79 #define WR_DONE     0x10  /* Page Write Done */
  80
  81 /* NFC_RST Masks */
  82 #define ECC_RST     0x01  /* ECC (and NFC counters) Reset */
  83
  84 /* NFC_PGCTL Masks */
  85 #define PG_RD_START 0x01  /* Page Read Start */
  86 #define PG_WR_START 0x02  /* Page Write Start */
  87
  88 #ifdef CONFIG_MTD_NAND_BF5XX_HWECC
  89 static int hardware_ecc = 1;
  90 #else
  91 static int hardware_ecc;
  92 #endif
  93
  94 static const unsigned short bfin_nfc_pin_req[] =
  95         {P_NAND_CE,
  96          P_NAND_RB,
  97          P_NAND_D0,
  98          P_NAND_D1,
  99          P_NAND_D2,
 100          P_NAND_D3,
 101          P_NAND_D4,
 102          P_NAND_D5,
 103          P_NAND_D6,
 104          P_NAND_D7,
 105          P_NAND_WE,
 106          P_NAND_RE,
 107          P_NAND_CLE,
 108          P_NAND_ALE,
 109          0};
 110
 111 #ifdef CONFIG_MTD_NAND_BF5XX_BOOTROM_ECC
 112 static int bootrom_ooblayout_ecc(struct mtd_info *mtd, int section,
 113                                  struct mtd_oob_region *oobregion)
 114 {
 115         if (section > 7)
 116                 return -ERANGE;
 117
 118         oobregion->offset = section * 8;
 119         oobregion->length = 3;
 120
 121         return 0;
 122 }
 123
 124 static int bootrom_ooblayout_free(struct mtd_info *mtd, int section,
 125                                   struct mtd_oob_region *oobregion)
 126 {
 127         if (section > 7)
 128                 return -ERANGE;
 129
 130         oobregion->offset = (section * 8) + 3;
 131         oobregion->length = 5;
 132
 133         return 0;
 134 }
 135
 136 static const struct mtd_ooblayout_ops bootrom_ooblayout_ops = {
 137         .ecc = bootrom_ooblayout_ecc,
 138         .free = bootrom_ooblayout_free,
 139 };
 140 #endif
 141
 142 /*
 143  * Data structures for bf5xx nand flash controller driver
 144  */
 145
 146 /* bf5xx nand info */
 147 struct bf5xx_nand_info {
 148         /* mtd info */
 149         struct nand_hw_control          controller;
 150         struct nand_chip                chip;
 151
 152         /* platform info */
 153         struct bf5xx_nand_platform      *platform;
 154
 155         /* device info */
 156         struct device                   *device;
 157
 158         /* DMA stuff */
 159         struct completion               dma_completion;
 160 };
 161
 162 /*
 163  * Conversion functions
 164  */
 165 static struct bf5xx_nand_info *mtd_to_nand_info(struct mtd_info *mtd)
 166 {
 167         return container_of(mtd_to_nand(mtd), struct bf5xx_nand_info,
 168                             chip);
 169 }
 170
 171 static struct bf5xx_nand_info *to_nand_info(struct platform_device *pdev)
 172 {
 173         return platform_get_drvdata(pdev);
 174 }
 175
 176 static struct bf5xx_nand_platform *to_nand_plat(struct platform_device *pdev)
 177 {
 178         return dev_get_platdata(&pdev->dev);
 179 }
 180
 181 /*
 182  * struct nand_chip interface function pointers
 183  */
 184
 185 /*
 186  * bf5xx_nand_hwcontrol
 187  *
 188  * Issue command and address cycles to the chip
 189  */
 190 static void bf5xx_nand_hwcontrol(struct mtd_info *mtd, int cmd,
 191                                    unsigned int ctrl)
 192 {
 193         if (cmd == NAND_CMD_NONE)
 194                 return;
 195
 196         while (bfin_read_NFC_STAT() & WB_FULL)
 197                 cpu_relax();
 198
 199         if (ctrl & NAND_CLE)
 200                 bfin_write_NFC_CMD(cmd);
 201         else if (ctrl & NAND_ALE)
 202                 bfin_write_NFC_ADDR(cmd);
 203         SSYNC();
 204 }
 205
 206 /*
 207  * bf5xx_nand_devready()
 208  *
 209  * returns 0 if the nand is busy, 1 if it is ready
 210  */
 211 static int bf5xx_nand_devready(struct mtd_info *mtd)
 212 {
 213         unsigned short val = bfin_read_NFC_STAT();
 214
 215         if ((val & NBUSY) == NBUSY)
 216                 return 1;
 217         else
 218                 return 0;
 219 }
 220
 221 /*
 222  * ECC functions
 223  * These allow the bf5xx to use the controller's ECC
 224  * generator block to ECC the data as it passes through
 225  */
 226
 227 /*
 228  * ECC error correction function
 229  */
 230 static int bf5xx_nand_correct_data_256(struct mtd_info *mtd, u_char *dat,
 231                                         u_char *read_ecc, u_char *calc_ecc)
 232 {
 233         struct bf5xx_nand_info *info = mtd_to_nand_info(mtd);
 234         u32 syndrome[5];
 235         u32 calced, stored;
 236         int i;
 237         unsigned short failing_bit, failing_byte;
 238         u_char data;
 239
 240         calced = calc_ecc[0] | (calc_ecc[1] << 8) | (calc_ecc[2] << 16);
 241         stored = read_ecc[0] | (read_ecc[1] << 8) | (read_ecc[2] << 16);
 242
 243         syndrome[0] = (calced ^ stored);
 244
 245         /*
 246          * syndrome 0: all zero
 247          * No error in data
 248          * No action
 249          */
 250         if (!syndrome[0] || !calced || !stored)
 251                 return 0;
 252
 253         /*
 254          * sysdrome 0: only one bit is one
 255          * ECC data was incorrect
 256          * No action
 257          */
 258         if (hweight32(syndrome[0]) == 1) {
 259                 dev_err(info->device, "ECC data was incorrect!\n");
 260                 return -EBADMSG;
 261         }
 262
 263         syndrome[1] = (calced & 0x7FF) ^ (stored & 0x7FF);
 264         syndrome[2] = (calced & 0x7FF) ^ ((calced >> 11) & 0x7FF);
 265         syndrome[3] = (stored & 0x7FF) ^ ((stored >> 11) & 0x7FF);
 266         syndrome[4] = syndrome[2] ^ syndrome[3];
 267
 268         for (i = 0; i < 5; i++)
 269                 dev_info(info->device, "syndrome[%d] 0x%08x\n", i, syndrome[i]);
 270
 271         dev_info(info->device,
 272                 "calced[0x%08x], stored[0x%08x]\n",
 273                 calced, stored);
 274
 275         /*
 276          * sysdrome 0: exactly 11 bits are one, each parity
 277          * and parity' pair is 1 & 0 or 0 & 1.
 278          * 1-bit correctable error
 279          * Correct the error
 280          */
 281         if (hweight32(syndrome[0]) == 11 && syndrome[4] == 0x7FF) {
 282                 dev_info(info->device,
 283                         "1-bit correctable error, correct it.\n");
 284                 dev_info(info->device,
 285                         "syndrome[1] 0x%08x\n", syndrome[1]);
 286
 287                 failing_bit = syndrome[1] & 0x7;
 288                 failing_byte = syndrome[1] >> 0x3;
 289                 data = *(dat + failing_byte);
 290                 data = data ^ (0x1 << failing_bit);
 291                 *(dat + failing_byte) = data;
 292
 293                 return 1;
 294         }
 295
 296         /*
 297          * sysdrome 0: random data
 298          * More than 1-bit error, non-correctable error
 299          * Discard data, mark bad block
 300          */
 301         dev_err(info->device,
 302                 "More than 1-bit error, non-correctable error.\n");
 303         dev_err(info->device,
 304                 "Please discard data, mark bad block\n");
 305
 306         return -EBADMSG;
 307 }
 308
 309 static int bf5xx_nand_correct_data(struct mtd_info *mtd, u_char *dat,
 310                                         u_char *read_ecc, u_char *calc_ecc)
 311 {
 312         struct nand_chip *chip = mtd_to_nand(mtd);
 313         int ret, bitflips = 0;
 314
 315         ret = bf5xx_nand_correct_data_256(mtd, dat, read_ecc, calc_ecc);
 316         if (ret < 0)
 317                 return ret;
 318
 319         bitflips = ret;
 320
 321         /* If ecc size is 512, correct second 256 bytes */
 322         if (chip->ecc.size == 512) {
 323                 dat += 256;
 324                 read_ecc += 3;
 325                 calc_ecc += 3;
 326                 ret = bf5xx_nand_correct_data_256(mtd, dat, read_ecc, calc_ecc);
 327                 if (ret < 0)
 328                         return ret;
 329
 330                 bitflips += ret;
 331         }
 332
 333         return bitflips;
 334 }
 335
 336 static void bf5xx_nand_enable_hwecc(struct mtd_info *mtd, int mode)
 337 {
 338         return;
 339 }
 340
 341 static int bf5xx_nand_calculate_ecc(struct mtd_info *mtd,
 342                 const u_char *dat, u_char *ecc_code)
 343 {
 344         struct bf5xx_nand_info *info = mtd_to_nand_info(mtd);
 345         struct nand_chip *chip = mtd_to_nand(mtd);
 346         u16 ecc0, ecc1;
 347         u32 code[2];
 348         u8 *p;
 349
 350         /* first 3 bytes ECC code for 256 page size */
 351         ecc0 = bfin_read_NFC_ECC0();
 352         ecc1 = bfin_read_NFC_ECC1();
 353
 354         code[0] = (ecc0 & 0x7ff) | ((ecc1 & 0x7ff) << 11);
 355
 356         dev_dbg(info->device, "returning ecc 0x%08x\n", code[0]);
 357
 358         p = (u8 *) code;
 359         memcpy(ecc_code, p, 3);
 360
 361         /* second 3 bytes ECC code for 512 ecc size */
 362         if (chip->ecc.size == 512) {
 363                 ecc0 = bfin_read_NFC_ECC2();
 364                 ecc1 = bfin_read_NFC_ECC3();
 365                 code[1] = (ecc0 & 0x7ff) | ((ecc1 & 0x7ff) << 11);
 366
 367                 /* second 3 bytes in ecc_code for second 256
 368                  * bytes of 512 page size
 369                  */
 370                 p = (u8 *) (code + 1);
 371                 memcpy((ecc_code + 3), p, 3);
 372                 dev_dbg(info->device, "returning ecc 0x%08x\n", code[1]);
 373         }
 374
 375         return 0;
 376 }
 377
 378 /*
 379  * PIO mode for buffer writing and reading
 380  */
 381 static void bf5xx_nand_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
 382 {
 383         int i;
 384         unsigned short val;
 385
 386         /*
 387          * Data reads are requested by first writing to NFC_DATA_RD
 388          * and then reading back from NFC_READ.
 389          */
 390         for (i = 0; i < len; i++) {
 391                 while (bfin_read_NFC_STAT() & WB_FULL)
 392                         cpu_relax();
 393
 394                 /* Contents do not matter */
 395                 bfin_write_NFC_DATA_RD(0x0000);
 396                 SSYNC();
 397
 398                 while ((bfin_read_NFC_IRQSTAT() & RD_RDY) != RD_RDY)
 399                         cpu_relax();
 400
 401                 buf[i] = bfin_read_NFC_READ();
 402
 403                 val = bfin_read_NFC_IRQSTAT();
 404                 val |= RD_RDY;
 405                 bfin_write_NFC_IRQSTAT(val);
 406                 SSYNC();
 407         }
 408 }
 409
 410 static uint8_t bf5xx_nand_read_byte(struct mtd_info *mtd)
 411 {
 412         uint8_t val;
 413
 414         bf5xx_nand_read_buf(mtd, &val, 1);
 415
 416         return val;
 417 }
 418
 419 static void bf5xx_nand_write_buf(struct mtd_info *mtd,
 420                                 const uint8_t *buf, int len)
 421 {
 422         int i;
 423
 424         for (i = 0; i < len; i++) {
 425                 while (bfin_read_NFC_STAT() & WB_FULL)
 426                         cpu_relax();
 427
 428                 bfin_write_NFC_DATA_WR(buf[i]);
 429                 SSYNC();
 430         }
 431 }
 432
 433 static void bf5xx_nand_read_buf16(struct mtd_info *mtd, uint8_t *buf, int len)
 434 {
 435         int i;
 436         u16 *p = (u16 *) buf;
 437         len >>= 1;
 438
 439         /*
 440          * Data reads are requested by first writing to NFC_DATA_RD
 441          * and then reading back from NFC_READ.
 442          */
 443         bfin_write_NFC_DATA_RD(0x5555);
 444
 445         SSYNC();
 446
 447         for (i = 0; i < len; i++)
 448                 p[i] = bfin_read_NFC_READ();
 449 }
 450
 451 static void bf5xx_nand_write_buf16(struct mtd_info *mtd,
 452                                 const uint8_t *buf, int len)
 453 {
 454         int i;
 455         u16 *p = (u16 *) buf;
 456         len >>= 1;
 457
 458         for (i = 0; i < len; i++)
 459                 bfin_write_NFC_DATA_WR(p[i]);
 460
 461         SSYNC();
 462 }
 463
 464 /*
 465  * DMA functions for buffer writing and reading
 466  */
 467 static irqreturn_t bf5xx_nand_dma_irq(int irq, void *dev_id)
 468 {
 469         struct bf5xx_nand_info *info = dev_id;
 470
 471         clear_dma_irqstat(CH_NFC);
 472         disable_dma(CH_NFC);
 473         complete(&info->dma_completion);
 474
 475         return IRQ_HANDLED;
 476 }
 477
 478 static void bf5xx_nand_dma_rw(struct mtd_info *mtd,
 479                                 uint8_t *buf, int is_read)
 480 {
 481         struct bf5xx_nand_info *info = mtd_to_nand_info(mtd);
 482         struct nand_chip *chip = mtd_to_nand(mtd);
 483         unsigned short val;
 484
 485         dev_dbg(info->device, " mtd->%p, buf->%p, is_read %d\n",
 486                         mtd, buf, is_read);
 487
 488         /*
 489          * Before starting a dma transfer, be sure to invalidate/flush
 490          * the cache over the address range of your DMA buffer to
 491          * prevent cache coherency problems. Otherwise very subtle bugs
 492          * can be introduced to your driver.
 493          */
 494         if (is_read)
 495                 invalidate_dcache_range((unsigned int)buf,
 496                                 (unsigned int)(buf + chip->ecc.size));
 497         else
 498                 flush_dcache_range((unsigned int)buf,
 499                                 (unsigned int)(buf + chip->ecc.size));
 500
 501         /*
 502          * This register must be written before each page is
 503          * transferred to generate the correct ECC register
 504          * values.
 505          */
 506         bfin_write_NFC_RST(ECC_RST);
 507         SSYNC();
 508         while (bfin_read_NFC_RST() & ECC_RST)
 509                 cpu_relax();
 510
 511         disable_dma(CH_NFC);
 512         clear_dma_irqstat(CH_NFC);
 513
 514         /* setup DMA register with Blackfin DMA API */
 515         set_dma_config(CH_NFC, 0x0);
 516         set_dma_start_addr(CH_NFC, (unsigned long) buf);
 517
 518         /* The DMAs have different size on BF52x and BF54x */
 519 #ifdef CONFIG_BF52x
 520         set_dma_x_count(CH_NFC, (chip->ecc.size >> 1));
 521         set_dma_x_modify(CH_NFC, 2);
 522         val = DI_EN | WDSIZE_16;
 523 #endif
 524
 525 #ifdef CONFIG_BF54x
 526         set_dma_x_count(CH_NFC, (chip->ecc.size >> 2));
 527         set_dma_x_modify(CH_NFC, 4);
 528         val = DI_EN | WDSIZE_32;
 529 #endif
 530         /* setup write or read operation */
 531         if (is_read)
 532                 val |= WNR;
 533         set_dma_config(CH_NFC, val);
 534         enable_dma(CH_NFC);
 535
 536         /* Start PAGE read/write operation */
 537         if (is_read)
 538                 bfin_write_NFC_PGCTL(PG_RD_START);
 539         else
 540                 bfin_write_NFC_PGCTL(PG_WR_START);
 541         wait_for_completion(&info->dma_completion);
 542 }
 543
 544 static void bf5xx_nand_dma_read_buf(struct mtd_info *mtd,
 545                                         uint8_t *buf, int len)
 546 {
 547         struct bf5xx_nand_info *info = mtd_to_nand_info(mtd);
 548         struct nand_chip *chip = mtd_to_nand(mtd);
 549
 550         dev_dbg(info->device, "mtd->%p, buf->%p, int %d\n", mtd, buf, len);
 551
 552         if (len == chip->ecc.size)
 553                 bf5xx_nand_dma_rw(mtd, buf, 1);
 554         else
 555                 bf5xx_nand_read_buf(mtd, buf, len);
 556 }
 557
 558 static void bf5xx_nand_dma_write_buf(struct mtd_info *mtd,
 559                                 const uint8_t *buf, int len)
 560 {
 561         struct bf5xx_nand_info *info = mtd_to_nand_info(mtd);
 562         struct nand_chip *chip = mtd_to_nand(mtd);
 563
 564         dev_dbg(info->device, "mtd->%p, buf->%p, len %d\n", mtd, buf, len);
 565
 566         if (len == chip->ecc.size)
 567                 bf5xx_nand_dma_rw(mtd, (uint8_t *)buf, 0);
 568         else
 569                 bf5xx_nand_write_buf(mtd, buf, len);
 570 }
 571
 572 static int bf5xx_nand_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
 573                 uint8_t *buf, int oob_required, int page)
 574 {
 575         nand_read_page_op(chip, page, 0, NULL, 0);
 576
 577         bf5xx_nand_read_buf(mtd, buf, mtd->writesize);
 578         bf5xx_nand_read_buf(mtd, chip->oob_poi, mtd->oobsize);
 579
 580         return 0;
 581 }
 582
 583 static int bf5xx_nand_write_page_raw(struct mtd_info *mtd,
 584                 struct nand_chip *chip, const uint8_t *buf, int oob_required,
 585                 int page)
 586 {
 587         nand_prog_page_begin_op(chip, page, 0, buf, mtd->writesize);
 588         bf5xx_nand_write_buf(mtd, chip->oob_poi, mtd->oobsize);
 589
 590         return nand_prog_page_end_op(chip);
 591 }
 592
 593 /*
 594  * System initialization functions
 595  */
 596 static int bf5xx_nand_dma_init(struct bf5xx_nand_info *info)
 597 {
 598         int ret;
 599
 600         /* Do not use dma */
 601         if (!hardware_ecc)
 602                 return 0;
 603
 604         init_completion(&info->dma_completion);
 605
 606         /* Request NFC DMA channel */
 607         ret = request_dma(CH_NFC, "BF5XX NFC driver");
 608         if (ret < 0) {
 609                 dev_err(info->device, " unable to get DMA channel\n");
 610                 return ret;
 611         }
 612
 613 #ifdef CONFIG_BF54x
 614         /* Setup DMAC1 channel mux for NFC which shared with SDH */
 615         bfin_write_DMAC1_PERIMUX(bfin_read_DMAC1_PERIMUX() & ~1);
 616         SSYNC();
 617 #endif
 618
 619         set_dma_callback(CH_NFC, bf5xx_nand_dma_irq, info);
 620
 621         /* Turn off the DMA channel first */
 622         disable_dma(CH_NFC);
 623         return 0;
 624 }
 625
 626 static void bf5xx_nand_dma_remove(struct bf5xx_nand_info *info)
 627 {
 628         /* Free NFC DMA channel */
 629         if (hardware_ecc)
 630                 free_dma(CH_NFC);
 631 }
 632
 633 /*
 634  * BF5XX NFC hardware initialization
 635  *  - pin mux setup
 636  *  - clear interrupt status
 637  */
 638 static int bf5xx_nand_hw_init(struct bf5xx_nand_info *info)
 639 {
 640         int err = 0;
 641         unsigned short val;
 642         struct bf5xx_nand_platform *plat = info->platform;
 643
 644         /* setup NFC_CTL register */
 645         dev_info(info->device,
 646                 "data_width=%d, wr_dly=%d, rd_dly=%d\n",
 647                 (plat->data_width ? 16 : 8),
 648                 plat->wr_dly, plat->rd_dly);
 649
 650         val = (1 << NFC_PG_SIZE_OFFSET) |
 651                 (plat->data_width << NFC_NWIDTH_OFFSET) |
 652                 (plat->rd_dly << NFC_RDDLY_OFFSET) |
 653                 (plat->wr_dly << NFC_WRDLY_OFFSET);
 654         dev_dbg(info->device, "NFC_CTL is 0x%04x\n", val);
 655
 656         bfin_write_NFC_CTL(val);
 657         SSYNC();
 658
 659         /* clear interrupt status */
 660         bfin_write_NFC_IRQMASK(0x0);
 661         SSYNC();
 662         val = bfin_read_NFC_IRQSTAT();
 663         bfin_write_NFC_IRQSTAT(val);
 664         SSYNC();
 665
 666         /* DMA initialization  */
 667         if (bf5xx_nand_dma_init(info))
 668                 err = -ENXIO;
 669
 670         return err;
 671 }
 672
 673 /*
 674  * Device management interface
 675  */
 676 static int bf5xx_nand_add_partition(struct bf5xx_nand_info *info)
 677 {
 678         struct mtd_info *mtd = nand_to_mtd(&info->chip);
 679         struct mtd_partition *parts = info->platform->partitions;
 680         int nr = info->platform->nr_partitions;
 681
 682         return mtd_device_register(mtd, parts, nr);
 683 }
 684
 685 static int bf5xx_nand_remove(struct platform_device *pdev)
 686 {
 687         struct bf5xx_nand_info *info = to_nand_info(pdev);
 688
 689         /* first thing we need to do is release all our mtds
 690          * and their partitions, then go through freeing the
 691          * resources used
 692          */
 693         nand_release(nand_to_mtd(&info->chip));
 694
 695         peripheral_free_list(bfin_nfc_pin_req);
 696         bf5xx_nand_dma_remove(info);
 697
 698         return 0;
 699 }
 700
 701 static int bf5xx_nand_scan(struct mtd_info *mtd)
 702 {
 703         struct nand_chip *chip = mtd_to_nand(mtd);
 704         int ret;
 705
 706         ret = nand_scan_ident(mtd, 1, NULL);
 707         if (ret)
 708                 return ret;
 709
 710         if (hardware_ecc) {
 711                 /*
 712                  * for nand with page size > 512B, think it as several sections with 512B
 713                  */
 714                 if (likely(mtd->writesize >= 512)) {
 715                         chip->ecc.size = 512;
 716                         chip->ecc.bytes = 6;
 717                         chip->ecc.strength = 2;
 718                 } else {
 719                         chip->ecc.size = 256;
 720                         chip->ecc.bytes = 3;
 721                         chip->ecc.strength = 1;
 722                         bfin_write_NFC_CTL(bfin_read_NFC_CTL() & ~(1 << NFC_PG_SIZE_OFFSET));
 723                         SSYNC();
 724                 }
 725         }
 726
 727         return  nand_scan_tail(mtd);
 728 }
 729
 730 /*
 731  * bf5xx_nand_probe
 732  *
 733  * called by device layer when it finds a device matching
 734  * one our driver can handled. This code checks to see if
 735  * it can allocate all necessary resources then calls the
 736  * nand layer to look for devices
 737  */
 738 static int bf5xx_nand_probe(struct platform_device *pdev)
 739 {
 740         struct bf5xx_nand_platform *plat = to_nand_plat(pdev);
 741         struct bf5xx_nand_info *info = NULL;
 742         struct nand_chip *chip = NULL;
 743         struct mtd_info *mtd = NULL;
 744         int err = 0;
 745
 746         dev_dbg(&pdev->dev, "(%p)\n", pdev);
 747
 748         if (!plat) {
 749                 dev_err(&pdev->dev, "no platform specific information\n");
 750                 return -EINVAL;
 751         }
 752
 753         if (peripheral_request_list(bfin_nfc_pin_req, DRV_NAME)) {
 754                 dev_err(&pdev->dev, "requesting Peripherals failed\n");
 755                 return -EFAULT;
 756         }
 757
 758         info = devm_kzalloc(&pdev->dev, sizeof(*info), GFP_KERNEL);
 759         if (info == NULL) {
 760                 err = -ENOMEM;
 761                 goto out_err;
 762         }
 763
 764         platform_set_drvdata(pdev, info);
 765
 766         nand_hw_control_init(&info->controller);
 767
 768         info->device     = &pdev->dev;
 769         info->platform   = plat;
 770
 771         /* initialise chip data struct */
 772         chip = &info->chip;
 773         mtd = nand_to_mtd(&info->chip);
 774
 775         if (plat->data_width)
 776                 chip->options |= NAND_BUSWIDTH_16;
 777
 778         chip->options |= NAND_CACHEPRG | NAND_SKIP_BBTSCAN;
 779
 780         chip->read_buf = (plat->data_width) ?
 781                 bf5xx_nand_read_buf16 : bf5xx_nand_read_buf;
 782         chip->write_buf = (plat->data_width) ?
 783                 bf5xx_nand_write_buf16 : bf5xx_nand_write_buf;
 784
 785         chip->read_byte    = bf5xx_nand_read_byte;
 786
 787         chip->cmd_ctrl     = bf5xx_nand_hwcontrol;
 788         chip->dev_ready    = bf5xx_nand_devready;
 789
 790         nand_set_controller_data(chip, mtd);
 791         chip->controller   = &info->controller;
 792
 793         chip->IO_ADDR_R    = (void __iomem *) NFC_READ;
 794         chip->IO_ADDR_W    = (void __iomem *) NFC_DATA_WR;
 795
 796         chip->chip_delay   = 0;
 797
 798         /* initialise mtd info data struct */
 799         mtd->dev.parent = &pdev->dev;
 800
 801         /* initialise the hardware */
 802         err = bf5xx_nand_hw_init(info);
 803         if (err)
 804                 goto out_err;
 805
 806         /* setup hardware ECC data struct */
 807         if (hardware_ecc) {
 808 #ifdef CONFIG_MTD_NAND_BF5XX_BOOTROM_ECC
 809                 mtd_set_ooblayout(mtd, &bootrom_ooblayout_ops);
 810 #endif
 811                 chip->read_buf      = bf5xx_nand_dma_read_buf;
 812                 chip->write_buf     = bf5xx_nand_dma_write_buf;
 813                 chip->ecc.calculate = bf5xx_nand_calculate_ecc;
 814                 chip->ecc.correct   = bf5xx_nand_correct_data;
 815                 chip->ecc.mode      = NAND_ECC_HW;
 816                 chip->ecc.hwctl     = bf5xx_nand_enable_hwecc;
 817                 chip->ecc.read_page_raw = bf5xx_nand_read_page_raw;
 818                 chip->ecc.write_page_raw = bf5xx_nand_write_page_raw;
 819         } else {
 820                 chip->ecc.mode      = NAND_ECC_SOFT;
 821                 chip->ecc.algo  = NAND_ECC_HAMMING;
 822         }
 823
 824         /* scan hardware nand chip and setup mtd info data struct */
 825         if (bf5xx_nand_scan(mtd)) {
 826                 err = -ENXIO;
 827                 goto out_err_nand_scan;
 828         }
 829
 830 #ifdef CONFIG_MTD_NAND_BF5XX_BOOTROM_ECC
 831         chip->badblockpos = 63;
 832 #endif
 833
 834         /* add NAND partition */
 835         bf5xx_nand_add_partition(info);
 836
 837         dev_dbg(&pdev->dev, "initialised ok\n");
 838         return 0;
 839
 840 out_err_nand_scan:
 841         bf5xx_nand_dma_remove(info);
 842 out_err:
 843         peripheral_free_list(bfin_nfc_pin_req);
 844
 845         return err;
 846 }
 847
 848 /* driver device registration */
 849 static struct platform_driver bf5xx_nand_driver = {
 850         .probe          = bf5xx_nand_probe,
 851         .remove         = bf5xx_nand_remove,
 852         .driver         = {
 853                 .name   = DRV_NAME,
 854         },
 855 };
 856
 857 module_platform_driver(bf5xx_nand_driver);
 858
 859 MODULE_LICENSE("GPL");
 860 MODULE_AUTHOR(DRV_AUTHOR);
 861 MODULE_DESCRIPTION(DRV_DESC);
 862 MODULE_ALIAS("platform:" DRV_NAME);