mtd: nand: Allow caller to pass alternative ID table to nand_scan_ident()
[deliverable/linux.git] / drivers / mtd / nand / mxc_nand.c
index 67ddc35ca7bc1066d9f009d1d6781c5a2707d1b1..474a09e53131b98fa91a92c627a33620911c22ab 100644 (file)
 
 #include <asm/mach/flash.h>
 #include <mach/mxc_nand.h>
+#include <mach/hardware.h>
 
 #define DRIVER_NAME "mxc_nand"
 
+#define nfc_is_v21()           (cpu_is_mx25() || cpu_is_mx35())
+#define nfc_is_v1()            (cpu_is_mx31() || cpu_is_mx27())
+
 /* Addresses for NFC registers */
 #define NFC_BUF_SIZE           0xE00
 #define NFC_BUF_ADDR           0xE04
 #define NFC_RSLTMAIN_AREA      0xE0E
 #define NFC_RSLTSPARE_AREA     0xE10
 #define NFC_WRPROT             0xE12
-#define NFC_UNLOCKSTART_BLKADDR        0xE14
-#define NFC_UNLOCKEND_BLKADDR  0xE16
+#define NFC_V1_UNLOCKSTART_BLKADDR     0xe14
+#define NFC_V1_UNLOCKEND_BLKADDR       0xe16
+#define NFC_V21_UNLOCKSTART_BLKADDR    0xe20
+#define NFC_V21_UNLOCKEND_BLKADDR      0xe22
 #define NFC_NF_WRPRST          0xE18
 #define NFC_CONFIG1            0xE1A
 #define NFC_CONFIG2            0xE1C
 
-/* Addresses for NFC RAM BUFFER Main area 0 */
-#define MAIN_AREA0             0x000
-#define MAIN_AREA1             0x200
-#define MAIN_AREA2             0x400
-#define MAIN_AREA3             0x600
-
-/* Addresses for NFC SPARE BUFFER Spare area 0 */
-#define SPARE_AREA0            0x800
-#define SPARE_AREA1            0x810
-#define SPARE_AREA2            0x820
-#define SPARE_AREA3            0x830
-
 /* Set INT to 0, FCMD to 1, rest to 0 in NFC_CONFIG2 Register
  * for Command operation */
 #define NFC_CMD            0x1
@@ -106,9 +100,13 @@ struct mxc_nand_host {
        struct mtd_partition    *parts;
        struct device           *dev;
 
+       void                    *spare0;
+       void                    *main_area0;
+       void                    *main_area1;
+
+       void __iomem            *base;
        void __iomem            *regs;
        int                     status_request;
-       int                     pagesize_2k;
        struct clk              *clk;
        int                     clk_act;
        int                     irq;
@@ -120,30 +118,48 @@ struct mxc_nand_host {
        int                     spare_len;
 };
 
-/* Define delays in microsec for NAND device operations */
-#define TROP_US_DELAY   2000
-/* Macros to get byte and bit positions of ECC */
-#define COLPOS(x)  ((x) >> 3)
-#define BITPOS(x) ((x) & 0xf)
-
-/* Define single bit Error positions in Main & Spare area */
-#define MAIN_SINGLEBIT_ERROR 0x4
-#define SPARE_SINGLEBIT_ERROR 0x1
-
 /* OOB placement block for use with hardware ecc generation */
-static struct nand_ecclayout nand_hw_eccoob_smallpage = {
+static struct nand_ecclayout nandv1_hw_eccoob_smallpage = {
        .eccbytes = 5,
        .eccpos = {6, 7, 8, 9, 10},
        .oobfree = {{0, 5}, {12, 4}, }
 };
 
-static struct nand_ecclayout nand_hw_eccoob_largepage = {
+static struct nand_ecclayout nandv1_hw_eccoob_largepage = {
        .eccbytes = 20,
        .eccpos = {6, 7, 8, 9, 10, 22, 23, 24, 25, 26,
                   38, 39, 40, 41, 42, 54, 55, 56, 57, 58},
        .oobfree = {{2, 4}, {11, 10}, {27, 10}, {43, 10}, {59, 5}, }
 };
 
+/* OOB description for 512 byte pages with 16 byte OOB */
+static struct nand_ecclayout nandv2_hw_eccoob_smallpage = {
+       .eccbytes = 1 * 9,
+       .eccpos = {
+                7,  8,  9, 10, 11, 12, 13, 14, 15
+       },
+       .oobfree = {
+               {.offset = 0, .length = 5}
+       }
+};
+
+/* OOB description for 2048 byte pages with 64 byte OOB */
+static struct nand_ecclayout nandv2_hw_eccoob_largepage = {
+       .eccbytes = 4 * 9,
+       .eccpos = {
+                7,  8,  9, 10, 11, 12, 13, 14, 15,
+               23, 24, 25, 26, 27, 28, 29, 30, 31,
+               39, 40, 41, 42, 43, 44, 45, 46, 47,
+               55, 56, 57, 58, 59, 60, 61, 62, 63
+       },
+       .oobfree = {
+               {.offset = 2, .length = 4},
+               {.offset = 16, .length = 7},
+               {.offset = 32, .length = 7},
+               {.offset = 48, .length = 7}
+       }
+};
+
 #ifdef CONFIG_MTD_PARTITIONS
 static const char *part_probes[] = { "RedBoot", "cmdlinepart", NULL };
 #endif
@@ -166,10 +182,10 @@ static irqreturn_t mxc_nfc_irq(int irq, void *dev_id)
 /* This function polls the NANDFC to wait for the basic operation to
  * complete by checking the INT bit of config2 register.
  */
-static void wait_op_done(struct mxc_nand_host *host, int max_retries,
-                               int useirq)
+static void wait_op_done(struct mxc_nand_host *host, int useirq)
 {
        uint32_t tmp;
+       int max_retries = 2000;
 
        if (useirq) {
                if ((readw(host->regs + NFC_CONFIG2) & NFC_INT) == 0) {
@@ -211,7 +227,7 @@ static void send_cmd(struct mxc_nand_host *host, uint16_t cmd, int useirq)
        writew(NFC_CMD, host->regs + NFC_CONFIG2);
 
        /* Wait for operation to complete */
-       wait_op_done(host, TROP_US_DELAY, useirq);
+       wait_op_done(host, useirq);
 }
 
 /* This function sends an address (or partial address) to the
@@ -225,42 +241,47 @@ static void send_addr(struct mxc_nand_host *host, uint16_t addr, int islast)
        writew(NFC_ADDR, host->regs + NFC_CONFIG2);
 
        /* Wait for operation to complete */
-       wait_op_done(host, TROP_US_DELAY, islast);
+       wait_op_done(host, islast);
 }
 
-static void send_page(struct mxc_nand_host *host, uint8_t buf_id,
-               unsigned int ops)
+static void send_page(struct mtd_info *mtd, unsigned int ops)
 {
-       /* NANDFC buffer 0 is used for page read/write */
-       writew(buf_id, host->regs + NFC_BUF_ADDR);
+       struct nand_chip *nand_chip = mtd->priv;
+       struct mxc_nand_host *host = nand_chip->priv;
+       int bufs, i;
 
-       writew(ops, host->regs + NFC_CONFIG2);
+       if (nfc_is_v1() && mtd->writesize > 512)
+               bufs = 4;
+       else
+               bufs = 1;
 
-       /* Wait for operation to complete */
-       wait_op_done(host, TROP_US_DELAY, true);
+       for (i = 0; i < bufs; i++) {
+
+               /* NANDFC buffer 0 is used for page read/write */
+               writew(i, host->regs + NFC_BUF_ADDR);
+
+               writew(ops, host->regs + NFC_CONFIG2);
+
+               /* Wait for operation to complete */
+               wait_op_done(host, true);
+       }
 }
 
 /* Request the NANDFC to perform a read of the NAND device ID. */
 static void send_read_id(struct mxc_nand_host *host)
 {
        struct nand_chip *this = &host->nand;
-       uint16_t tmp;
 
        /* NANDFC buffer 0 is used for device ID output */
        writew(0x0, host->regs + NFC_BUF_ADDR);
 
-       /* Read ID into main buffer */
-       tmp = readw(host->regs + NFC_CONFIG1);
-       tmp &= ~NFC_SP_EN;
-       writew(tmp, host->regs + NFC_CONFIG1);
-
        writew(NFC_ID, host->regs + NFC_CONFIG2);
 
        /* Wait for operation to complete */
-       wait_op_done(host, TROP_US_DELAY, true);
+       wait_op_done(host, true);
 
        if (this->options & NAND_BUSWIDTH_16) {
-               void __iomem *main_buf = host->regs + MAIN_AREA0;
+               void __iomem *main_buf = host->main_area0;
                /* compress the ID info */
                writeb(readb(main_buf + 2), main_buf + 1);
                writeb(readb(main_buf + 4), main_buf + 2);
@@ -268,16 +289,16 @@ static void send_read_id(struct mxc_nand_host *host)
                writeb(readb(main_buf + 8), main_buf + 4);
                writeb(readb(main_buf + 10), main_buf + 5);
        }
-       memcpy(host->data_buf, host->regs + MAIN_AREA0, 16);
+       memcpy(host->data_buf, host->main_area0, 16);
 }
 
 /* This function requests the NANDFC to perform a read of the
  * NAND device status and returns the current status. */
 static uint16_t get_dev_status(struct mxc_nand_host *host)
 {
-       void __iomem *main_buf = host->regs + MAIN_AREA1;
+       void __iomem *main_buf = host->main_area1;
        uint32_t store;
-       uint16_t ret, tmp;
+       uint16_t ret;
        /* Issue status request to NAND device */
 
        /* store the main area1 first word, later do recovery */
@@ -286,15 +307,10 @@ static uint16_t get_dev_status(struct mxc_nand_host *host)
         * corruption of read/write buffer on status requests. */
        writew(1, host->regs + NFC_BUF_ADDR);
 
-       /* Read status into main buffer */
-       tmp = readw(host->regs + NFC_CONFIG1);
-       tmp &= ~NFC_SP_EN;
-       writew(tmp, host->regs + NFC_CONFIG1);
-
        writew(NFC_STATUS, host->regs + NFC_CONFIG2);
 
        /* Wait for operation to complete */
-       wait_op_done(host, TROP_US_DELAY, true);
+       wait_op_done(host, true);
 
        /* Status is placed in first word of main buffer */
        /* get status, then recovery area 1 data */
@@ -460,7 +476,7 @@ static void copy_spare(struct mtd_info *mtd, bool bfrom)
        u16 i, j;
        u16 n = mtd->writesize >> 9;
        u8 *d = host->data_buf + mtd->writesize;
-       u8 *s = host->regs + SPARE_AREA0;
+       u8 *s = host->spare0;
        u16 t = host->spare_len;
 
        j = (mtd->oobsize / n >> 1) << 1;
@@ -495,7 +511,7 @@ static void mxc_do_addr_cycle(struct mtd_info *mtd, int column, int page_addr)
                 * the full page.
                 */
                send_addr(host, 0, page_addr == -1);
-               if (host->pagesize_2k)
+               if (mtd->writesize > 512)
                        /* another col addr cycle for 2k page */
                        send_addr(host, 0, false);
        }
@@ -505,7 +521,7 @@ static void mxc_do_addr_cycle(struct mtd_info *mtd, int column, int page_addr)
                /* paddr_0 - p_addr_7 */
                send_addr(host, (page_addr & 0xff), false);
 
-               if (host->pagesize_2k) {
+               if (mtd->writesize > 512) {
                        if (mtd->size >= 0x10000000) {
                                /* paddr_8 - paddr_15 */
                                send_addr(host, (page_addr >> 8) & 0xff, false);
@@ -559,24 +575,18 @@ static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
                else
                        host->buf_start = column + mtd->writesize;
 
-               if (host->pagesize_2k)
+               if (mtd->writesize > 512)
                        command = NAND_CMD_READ0; /* only READ0 is valid */
 
                send_cmd(host, command, false);
                mxc_do_addr_cycle(mtd, column, page_addr);
 
-               if (host->pagesize_2k) {
-                       /* send read confirm command */
+               if (mtd->writesize > 512)
                        send_cmd(host, NAND_CMD_READSTART, true);
-                       /* read for each AREA */
-                       send_page(host, 0, NFC_OUTPUT);
-                       send_page(host, 1, NFC_OUTPUT);
-                       send_page(host, 2, NFC_OUTPUT);
-                       send_page(host, 3, NFC_OUTPUT);
-               } else
-                       send_page(host, 0, NFC_OUTPUT);
-
-               memcpy(host->data_buf, host->regs + MAIN_AREA0, mtd->writesize);
+
+               send_page(mtd, NFC_OUTPUT);
+
+               memcpy(host->data_buf, host->main_area0, mtd->writesize);
                copy_spare(mtd, true);
                break;
 
@@ -589,7 +599,7 @@ static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
                         * pointer to spare area, we must write the whole page
                         * including OOB together.
                         */
-                       if (host->pagesize_2k)
+                       if (mtd->writesize > 512)
                                /* call ourself to read a page */
                                mxc_nand_command(mtd, NAND_CMD_READ0, 0,
                                                page_addr);
@@ -597,13 +607,13 @@ static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
                        host->buf_start = column;
 
                        /* Set program pointer to spare region */
-                       if (!host->pagesize_2k)
+                       if (mtd->writesize == 512)
                                send_cmd(host, NAND_CMD_READOOB, false);
                } else {
                        host->buf_start = column;
 
                        /* Set program pointer to page start */
-                       if (!host->pagesize_2k)
+                       if (mtd->writesize == 512)
                                send_cmd(host, NAND_CMD_READ0, false);
                }
 
@@ -612,17 +622,9 @@ static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
                break;
 
        case NAND_CMD_PAGEPROG:
-               memcpy(host->regs + MAIN_AREA0, host->data_buf, mtd->writesize);
+               memcpy(host->main_area0, host->data_buf, mtd->writesize);
                copy_spare(mtd, false);
-               send_page(host, 0, NFC_INPUT);
-
-               if (host->pagesize_2k) {
-                       /* data in 4 areas datas */
-                       send_page(host, 1, NFC_INPUT);
-                       send_page(host, 2, NFC_INPUT);
-                       send_page(host, 3, NFC_INPUT);
-               }
-
+               send_page(mtd, NFC_INPUT);
                send_cmd(host, command, true);
                mxc_do_addr_cycle(mtd, column, page_addr);
                break;
@@ -631,10 +633,12 @@ static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
                send_cmd(host, command, true);
                mxc_do_addr_cycle(mtd, column, page_addr);
                send_read_id(host);
+               host->buf_start = column;
                break;
 
        case NAND_CMD_ERASE1:
        case NAND_CMD_ERASE2:
+       case NAND_CMD_RESET:
                send_cmd(host, command, false);
                mxc_do_addr_cycle(mtd, column, page_addr);
 
@@ -642,6 +646,33 @@ static void mxc_nand_command(struct mtd_info *mtd, unsigned command,
        }
 }
 
+/*
+ * The generic flash bbt decriptors overlap with our ecc
+ * hardware, so define some i.MX specific ones.
+ */
+static uint8_t bbt_pattern[] = { 'B', 'b', 't', '0' };
+static uint8_t mirror_pattern[] = { '1', 't', 'b', 'B' };
+
+static struct nand_bbt_descr bbt_main_descr = {
+       .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
+           | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
+       .offs = 0,
+       .len = 4,
+       .veroffs = 4,
+       .maxblocks = 4,
+       .pattern = bbt_pattern,
+};
+
+static struct nand_bbt_descr bbt_mirror_descr = {
+       .options = NAND_BBT_LASTBLOCK | NAND_BBT_CREATE | NAND_BBT_WRITE
+           | NAND_BBT_2BIT | NAND_BBT_VERSION | NAND_BBT_PERCHIP,
+       .offs = 0,
+       .len = 4,
+       .veroffs = 4,
+       .maxblocks = 4,
+       .pattern = mirror_pattern,
+};
+
 static int __init mxcnd_probe(struct platform_device *pdev)
 {
        struct nand_chip *this;
@@ -651,6 +682,7 @@ static int __init mxcnd_probe(struct platform_device *pdev)
        struct resource *res;
        uint16_t tmp;
        int err = 0, nr_parts = 0;
+       struct nand_ecclayout *oob_smallpage, *oob_largepage;
 
        /* Allocate memory for MTD device structure and private data */
        host = kzalloc(sizeof(struct mxc_nand_host) + NAND_MAX_PAGESIZE +
@@ -659,7 +691,6 @@ static int __init mxcnd_probe(struct platform_device *pdev)
                return -ENOMEM;
 
        host->data_buf = (uint8_t *)(host + 1);
-       host->spare_len = 16;
 
        host->dev = &pdev->dev;
        /* structures must be linked */
@@ -668,7 +699,7 @@ static int __init mxcnd_probe(struct platform_device *pdev)
        mtd->priv = this;
        mtd->owner = THIS_MODULE;
        mtd->dev.parent = &pdev->dev;
-       mtd->name = "mxc_nand";
+       mtd->name = DRIVER_NAME;
 
        /* 50 us command delay time */
        this->chip_delay = 5;
@@ -698,21 +729,41 @@ static int __init mxcnd_probe(struct platform_device *pdev)
                goto eres;
        }
 
-       host->regs = ioremap(res->start, resource_size(res));
-       if (!host->regs) {
+       host->base = ioremap(res->start, resource_size(res));
+       if (!host->base) {
                err = -ENOMEM;
                goto eres;
        }
 
+       host->main_area0 = host->base;
+       host->main_area1 = host->base + 0x200;
+
+       if (nfc_is_v21()) {
+               host->regs = host->base + 0x1000;
+               host->spare0 = host->base + 0x1000;
+               host->spare_len = 64;
+               oob_smallpage = &nandv2_hw_eccoob_smallpage;
+               oob_largepage = &nandv2_hw_eccoob_largepage;
+       } else if (nfc_is_v1()) {
+               host->regs = host->base;
+               host->spare0 = host->base + 0x800;
+               host->spare_len = 16;
+               oob_smallpage = &nandv1_hw_eccoob_smallpage;
+               oob_largepage = &nandv1_hw_eccoob_largepage;
+       } else
+               BUG();
+
+       /* disable interrupt and spare enable */
        tmp = readw(host->regs + NFC_CONFIG1);
        tmp |= NFC_INT_MSK;
+       tmp &= ~NFC_SP_EN;
        writew(tmp, host->regs + NFC_CONFIG1);
 
        init_waitqueue_head(&host->irq_waitq);
 
        host->irq = platform_get_irq(pdev, 0);
 
-       err = request_irq(host->irq, mxc_nfc_irq, 0, "mxc_nd", host);
+       err = request_irq(host->irq, mxc_nfc_irq, 0, DRIVER_NAME, host);
        if (err)
                goto eirq;
 
@@ -724,15 +775,22 @@ static int __init mxcnd_probe(struct platform_device *pdev)
        writew(0x2, host->regs + NFC_CONFIG);
 
        /* Blocks to be unlocked */
-       writew(0x0, host->regs + NFC_UNLOCKSTART_BLKADDR);
-       writew(0x4000, host->regs + NFC_UNLOCKEND_BLKADDR);
+       if (nfc_is_v21()) {
+               writew(0x0, host->regs + NFC_V21_UNLOCKSTART_BLKADDR);
+               writew(0xffff, host->regs + NFC_V21_UNLOCKEND_BLKADDR);
+               this->ecc.bytes = 9;
+       } else if (nfc_is_v1()) {
+               writew(0x0, host->regs + NFC_V1_UNLOCKSTART_BLKADDR);
+               writew(0x4000, host->regs + NFC_V1_UNLOCKEND_BLKADDR);
+               this->ecc.bytes = 3;
+       } else
+               BUG();
 
        /* Unlock Block Command for given address range */
        writew(0x4, host->regs + NFC_WRPROT);
 
        this->ecc.size = 512;
-       this->ecc.bytes = 3;
-       this->ecc.layout = &nand_hw_eccoob_smallpage;
+       this->ecc.layout = oob_smallpage;
 
        if (pdata->hw_ecc) {
                this->ecc.calculate = mxc_nand_calculate_ecc;
@@ -753,16 +811,21 @@ static int __init mxcnd_probe(struct platform_device *pdev)
        if (pdata->width == 2)
                this->options |= NAND_BUSWIDTH_16;
 
+       if (pdata->flash_bbt) {
+               this->bbt_td = &bbt_main_descr;
+               this->bbt_md = &bbt_mirror_descr;
+               /* update flash based bbt */
+               this->options |= NAND_USE_FLASH_BBT;
+       }
+
        /* first scan to find the device and get the page size */
-       if (nand_scan_ident(mtd, 1)) {
+       if (nand_scan_ident(mtd, 1, NULL)) {
                err = -ENXIO;
                goto escan;
        }
 
-       if (mtd->writesize == 2048) {
-               host->pagesize_2k = 1;
-               this->ecc.layout = &nand_hw_eccoob_largepage;
-       }
+       if (mtd->writesize == 2048)
+               this->ecc.layout = oob_largepage;
 
        /* second phase scan */
        if (nand_scan_tail(mtd)) {
@@ -790,7 +853,7 @@ static int __init mxcnd_probe(struct platform_device *pdev)
 escan:
        free_irq(host->irq, host);
 eirq:
-       iounmap(host->regs);
+       iounmap(host->base);
 eres:
        clk_put(host->clk);
 eclk:
@@ -799,7 +862,7 @@ eclk:
        return err;
 }
 
-static int __exit mxcnd_remove(struct platform_device *pdev)
+static int __devexit mxcnd_remove(struct platform_device *pdev)
 {
        struct mxc_nand_host *host = platform_get_drvdata(pdev);
 
@@ -809,7 +872,7 @@ static int __exit mxcnd_remove(struct platform_device *pdev)
 
        nand_release(&host->mtd);
        free_irq(host->irq, host);
-       iounmap(host->regs);
+       iounmap(host->base);
        kfree(host);
 
        return 0;
@@ -824,11 +887,14 @@ static int mxcnd_suspend(struct platform_device *pdev, pm_message_t state)
        int ret = 0;
 
        DEBUG(MTD_DEBUG_LEVEL0, "MXC_ND : NAND suspend\n");
-       if (mtd) {
-               ret = mtd->suspend(mtd);
-               /* Disable the NFC clock */
-               clk_disable(host->clk);
-       }
+
+       ret = mtd->suspend(mtd);
+
+       /*
+        * nand_suspend locks the device for exclusive access, so
+        * the clock must already be off.
+        */
+       BUG_ON(!ret && host->clk_act);
 
        return ret;
 }
@@ -842,11 +908,7 @@ static int mxcnd_resume(struct platform_device *pdev)
 
        DEBUG(MTD_DEBUG_LEVEL0, "MXC_ND : NAND resume\n");
 
-       if (mtd) {
-               /* Enable the NFC clock */
-               clk_enable(host->clk);
-               mtd->resume(mtd);
-       }
+       mtd->resume(mtd);
 
        return ret;
 }
@@ -860,7 +922,7 @@ static struct platform_driver mxcnd_driver = {
        .driver = {
                   .name = DRIVER_NAME,
                   },
-       .remove = __exit_p(mxcnd_remove),
+       .remove = __devexit_p(mxcnd_remove),
        .suspend = mxcnd_suspend,
        .resume = mxcnd_resume,
 };
This page took 0.061521 seconds and 5 git commands to generate.