drivers/mtd/nand/tango_nand.c

   1 /*
   2  * Copyright (C) 2016 Sigma Designs
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * version 2 as published by the Free Software Foundation.
   7  */
   8
   9 #include <linux/io.h>
  10 #include <linux/of.h>
  11 #include <linux/clk.h>
  12 #include <linux/iopoll.h>
  13 #include <linux/module.h>
  14 #include <linux/mtd/rawnand.h>
  15 #include <linux/dmaengine.h>
  16 #include <linux/dma-mapping.h>
  17 #include <linux/platform_device.h>
  18
  19 /* Offsets relative to chip->base */
  20 #define PBUS_CMD        0
  21 #define PBUS_ADDR       4
  22 #define PBUS_DATA       8
  23
  24 /* Offsets relative to reg_base */
  25 #define NFC_STATUS      0x00
  26 #define NFC_FLASH_CMD   0x04
  27 #define NFC_DEVICE_CFG  0x08
  28 #define NFC_TIMING1     0x0c
  29 #define NFC_TIMING2     0x10
  30 #define NFC_XFER_CFG    0x14
  31 #define NFC_PKT_0_CFG   0x18
  32 #define NFC_PKT_N_CFG   0x1c
  33 #define NFC_BB_CFG      0x20
  34 #define NFC_ADDR_PAGE   0x24
  35 #define NFC_ADDR_OFFSET 0x28
  36 #define NFC_XFER_STATUS 0x2c
  37
  38 /* NFC_STATUS values */
  39 #define CMD_READY       BIT(31)
  40
  41 /* NFC_FLASH_CMD values */
  42 #define NFC_READ        1
  43 #define NFC_WRITE       2
  44
  45 /* NFC_XFER_STATUS values */
  46 #define PAGE_IS_EMPTY   BIT(16)
  47
  48 /* Offsets relative to mem_base */
  49 #define METADATA        0x000
  50 #define ERROR_REPORT    0x1c0
  51
  52 /*
  53  * Error reports are split in two bytes:
  54  * byte 0 for the first packet in the page (PKT_0)
  55  * byte 1 for other packets in the page (PKT_N, for N > 0)
  56  * ERR_COUNT_PKT_N is the max error count over all but the first packet.
  57  */
  58 #define ERR_COUNT_PKT_0(v)      (((v) >> 0) & 0x3f)
  59 #define ERR_COUNT_PKT_N(v)      (((v) >> 8) & 0x3f)
  60 #define DECODE_FAIL_PKT_0(v)    (((v) & BIT(7)) == 0)
  61 #define DECODE_FAIL_PKT_N(v)    (((v) & BIT(15)) == 0)
  62
  63 /* Offsets relative to pbus_base */
  64 #define PBUS_CS_CTRL    0x83c
  65 #define PBUS_PAD_MODE   0x8f0
  66
  67 /* PBUS_CS_CTRL values */
  68 #define PBUS_IORDY      BIT(31)
  69
  70 /*
  71  * PBUS_PAD_MODE values
  72  * In raw mode, the driver communicates directly with the NAND chips.
  73  * In NFC mode, the NAND Flash controller manages the communication.
  74  * We use NFC mode for read and write; raw mode for everything else.
  75  */
  76 #define MODE_RAW        0
  77 #define MODE_NFC        BIT(31)
  78
  79 #define METADATA_SIZE   4
  80 #define BBM_SIZE        6
  81 #define FIELD_ORDER     15
  82
  83 #define MAX_CS          4
  84
  85 struct tango_nfc {
  86         struct nand_hw_control hw;
  87         void __iomem *reg_base;
  88         void __iomem *mem_base;
  89         void __iomem *pbus_base;
  90         struct tango_chip *chips[MAX_CS];
  91         struct dma_chan *chan;
  92         int freq_kHz;
  93 };
  94
  95 #define to_tango_nfc(ptr) container_of(ptr, struct tango_nfc, hw)
  96
  97 struct tango_chip {
  98         struct nand_chip nand_chip;
  99         void __iomem *base;
 100         u32 timing1;
 101         u32 timing2;
 102         u32 xfer_cfg;
 103         u32 pkt_0_cfg;
 104         u32 pkt_n_cfg;
 105         u32 bb_cfg;
 106 };
 107
 108 #define to_tango_chip(ptr) container_of(ptr, struct tango_chip, nand_chip)
 109
 110 #define XFER_CFG(cs, page_count, steps, metadata_size)  \
 111         ((cs) << 24 | (page_count) << 16 | (steps) << 8 | (metadata_size))
 112
 113 #define PKT_CFG(size, strength) ((size) << 16 | (strength))
 114
 115 #define BB_CFG(bb_offset, bb_size) ((bb_offset) << 16 | (bb_size))
 116
 117 #define TIMING(t0, t1, t2, t3) ((t0) << 24 | (t1) << 16 | (t2) << 8 | (t3))
 118
 119 static void tango_cmd_ctrl(struct mtd_info *mtd, int dat, unsigned int ctrl)
 120 {
 121         struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
 122
 123         if (ctrl & NAND_CLE)
 124                 writeb_relaxed(dat, tchip->base + PBUS_CMD);
 125
 126         if (ctrl & NAND_ALE)
 127                 writeb_relaxed(dat, tchip->base + PBUS_ADDR);
 128 }
 129
 130 static int tango_dev_ready(struct mtd_info *mtd)
 131 {
 132         struct nand_chip *chip = mtd_to_nand(mtd);
 133         struct tango_nfc *nfc = to_tango_nfc(chip->controller);
 134
 135         return readl_relaxed(nfc->pbus_base + PBUS_CS_CTRL) & PBUS_IORDY;
 136 }
 137
 138 static u8 tango_read_byte(struct mtd_info *mtd)
 139 {
 140         struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
 141
 142         return readb_relaxed(tchip->base + PBUS_DATA);
 143 }
 144
 145 static void tango_read_buf(struct mtd_info *mtd, u8 *buf, int len)
 146 {
 147         struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
 148
 149         ioread8_rep(tchip->base + PBUS_DATA, buf, len);
 150 }
 151
 152 static void tango_write_buf(struct mtd_info *mtd, const u8 *buf, int len)
 153 {
 154         struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
 155
 156         iowrite8_rep(tchip->base + PBUS_DATA, buf, len);
 157 }
 158
 159 static void tango_select_chip(struct mtd_info *mtd, int idx)
 160 {
 161         struct nand_chip *chip = mtd_to_nand(mtd);
 162         struct tango_nfc *nfc = to_tango_nfc(chip->controller);
 163         struct tango_chip *tchip = to_tango_chip(chip);
 164
 165         if (idx < 0)
 166                 return; /* No "chip unselect" function */
 167
 168         writel_relaxed(tchip->timing1, nfc->reg_base + NFC_TIMING1);
 169         writel_relaxed(tchip->timing2, nfc->reg_base + NFC_TIMING2);
 170         writel_relaxed(tchip->xfer_cfg, nfc->reg_base + NFC_XFER_CFG);
 171         writel_relaxed(tchip->pkt_0_cfg, nfc->reg_base + NFC_PKT_0_CFG);
 172         writel_relaxed(tchip->pkt_n_cfg, nfc->reg_base + NFC_PKT_N_CFG);
 173         writel_relaxed(tchip->bb_cfg, nfc->reg_base + NFC_BB_CFG);
 174 }
 175
 176 /*
 177  * The controller does not check for bitflips in erased pages,
 178  * therefore software must check instead.
 179  */
 180 static int check_erased_page(struct nand_chip *chip, u8 *buf)
 181 {
 182         struct mtd_info *mtd = nand_to_mtd(chip);
 183         u8 *meta = chip->oob_poi + BBM_SIZE;
 184         u8 *ecc = chip->oob_poi + BBM_SIZE + METADATA_SIZE;
 185         const int ecc_size = chip->ecc.bytes;
 186         const int pkt_size = chip->ecc.size;
 187         int i, res, meta_len, bitflips = 0;
 188
 189         for (i = 0; i < chip->ecc.steps; ++i) {
 190                 meta_len = i ? 0 : METADATA_SIZE;
 191                 res = nand_check_erased_ecc_chunk(buf, pkt_size, ecc, ecc_size,
 192                                                   meta, meta_len,
 193                                                   chip->ecc.strength);
 194                 if (res < 0)
 195                         mtd->ecc_stats.failed++;
 196                 else
 197                         mtd->ecc_stats.corrected += res;
 198
 199                 bitflips = max(res, bitflips);
 200                 buf += pkt_size;
 201                 ecc += ecc_size;
 202         }
 203
 204         return bitflips;
 205 }
 206
 207 static int decode_error_report(struct nand_chip *chip)
 208 {
 209         u32 status, res;
 210         struct mtd_info *mtd = nand_to_mtd(chip);
 211         struct tango_nfc *nfc = to_tango_nfc(chip->controller);
 212
 213         status = readl_relaxed(nfc->reg_base + NFC_XFER_STATUS);
 214         if (status & PAGE_IS_EMPTY)
 215                 return 0;
 216
 217         res = readl_relaxed(nfc->mem_base + ERROR_REPORT);
 218
 219         if (DECODE_FAIL_PKT_0(res) || DECODE_FAIL_PKT_N(res))
 220                 return -EBADMSG;
 221
 222         /* ERR_COUNT_PKT_N is max, not sum, but that's all we have */
 223         mtd->ecc_stats.corrected +=
 224                 ERR_COUNT_PKT_0(res) + ERR_COUNT_PKT_N(res);
 225
 226         return max(ERR_COUNT_PKT_0(res), ERR_COUNT_PKT_N(res));
 227 }
 228
 229 static void tango_dma_callback(void *arg)
 230 {
 231         complete(arg);
 232 }
 233
 234 static int do_dma(struct tango_nfc *nfc, enum dma_data_direction dir, int cmd,
 235                   const void *buf, int len, int page)
 236 {
 237         void __iomem *addr = nfc->reg_base + NFC_STATUS;
 238         struct dma_chan *chan = nfc->chan;
 239         struct dma_async_tx_descriptor *desc;
 240         enum dma_transfer_direction tdir;
 241         struct scatterlist sg;
 242         struct completion tx_done;
 243         int err = -EIO;
 244         u32 res, val;
 245
 246         sg_init_one(&sg, buf, len);
 247         if (dma_map_sg(chan->device->dev, &sg, 1, dir) != 1)
 248                 return -EIO;
 249
 250         tdir = dir == DMA_TO_DEVICE ? DMA_MEM_TO_DEV : DMA_DEV_TO_MEM;
 251         desc = dmaengine_prep_slave_sg(chan, &sg, 1, tdir, DMA_PREP_INTERRUPT);
 252         if (!desc)
 253                 goto dma_unmap;
 254
 255         desc->callback = tango_dma_callback;
 256         desc->callback_param = &tx_done;
 257         init_completion(&tx_done);
 258
 259         writel_relaxed(MODE_NFC, nfc->pbus_base + PBUS_PAD_MODE);
 260
 261         writel_relaxed(page, nfc->reg_base + NFC_ADDR_PAGE);
 262         writel_relaxed(0, nfc->reg_base + NFC_ADDR_OFFSET);
 263         writel_relaxed(cmd, nfc->reg_base + NFC_FLASH_CMD);
 264
 265         dmaengine_submit(desc);
 266         dma_async_issue_pending(chan);
 267
 268         res = wait_for_completion_timeout(&tx_done, HZ);
 269         if (res > 0)
 270                 err = readl_poll_timeout(addr, val, val & CMD_READY, 0, 1000);
 271
 272         writel_relaxed(MODE_RAW, nfc->pbus_base + PBUS_PAD_MODE);
 273
 274 dma_unmap:
 275         dma_unmap_sg(chan->device->dev, &sg, 1, dir);
 276
 277         return err;
 278 }
 279
 280 static int tango_read_page(struct mtd_info *mtd, struct nand_chip *chip,
 281                            u8 *buf, int oob_required, int page)
 282 {
 283         struct tango_nfc *nfc = to_tango_nfc(chip->controller);
 284         int err, res, len = mtd->writesize;
 285
 286         if (oob_required)
 287                 chip->ecc.read_oob(mtd, chip, page);
 288
 289         err = do_dma(nfc, DMA_FROM_DEVICE, NFC_READ, buf, len, page);
 290         if (err)
 291                 return err;
 292
 293         res = decode_error_report(chip);
 294         if (res < 0) {
 295                 chip->ecc.read_oob_raw(mtd, chip, page);
 296                 res = check_erased_page(chip, buf);
 297         }
 298
 299         return res;
 300 }
 301
 302 static int tango_write_page(struct mtd_info *mtd, struct nand_chip *chip,
 303                             const u8 *buf, int oob_required, int page)
 304 {
 305         struct tango_nfc *nfc = to_tango_nfc(chip->controller);
 306         int err, status, len = mtd->writesize;
 307
 308         /* Calling tango_write_oob() would send PAGEPROG twice */
 309         if (oob_required)
 310                 return -ENOTSUPP;
 311
 312         writel_relaxed(0xffffffff, nfc->mem_base + METADATA);
 313         err = do_dma(nfc, DMA_TO_DEVICE, NFC_WRITE, buf, len, page);
 314         if (err)
 315                 return err;
 316
 317         status = chip->waitfunc(mtd, chip);
 318         if (status & NAND_STATUS_FAIL)
 319                 return -EIO;
 320
 321         return 0;
 322 }
 323
 324 static void aux_read(struct nand_chip *chip, u8 **buf, int len, int *pos)
 325 {
 326         struct mtd_info *mtd = nand_to_mtd(chip);
 327
 328         *pos += len;
 329
 330         if (!*buf) {
 331                 /* skip over "len" bytes */
 332                 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, *pos, -1);
 333         } else {
 334                 tango_read_buf(mtd, *buf, len);
 335                 *buf += len;
 336         }
 337 }
 338
 339 static void aux_write(struct nand_chip *chip, const u8 **buf, int len, int *pos)
 340 {
 341         struct mtd_info *mtd = nand_to_mtd(chip);
 342
 343         *pos += len;
 344
 345         if (!*buf) {
 346                 /* skip over "len" bytes */
 347                 chip->cmdfunc(mtd, NAND_CMD_RNDIN, *pos, -1);
 348         } else {
 349                 tango_write_buf(mtd, *buf, len);
 350                 *buf += len;
 351         }
 352 }
 353
 354 /*
 355  * Physical page layout (not drawn to scale)
 356  *
 357  * NB: Bad Block Marker area splits PKT_N in two (N1, N2).
 358  *
 359  * +---+-----------------+-------+-----+-----------+-----+----+-------+
 360  * | M |      PKT_0      | ECC_0 | ... |     N1    | BBM | N2 | ECC_N |
 361  * +---+-----------------+-------+-----+-----------+-----+----+-------+
 362  *
 363  * Logical page layout:
 364  *
 365  *       +-----+---+-------+-----+-------+
 366  * oob = | BBM | M | ECC_0 | ... | ECC_N |
 367  *       +-----+---+-------+-----+-------+
 368  *
 369  *       +-----------------+-----+-----------------+
 370  * buf = |      PKT_0      | ... |      PKT_N      |
 371  *       +-----------------+-----+-----------------+
 372  */
 373 static void raw_read(struct nand_chip *chip, u8 *buf, u8 *oob)
 374 {
 375         struct mtd_info *mtd = nand_to_mtd(chip);
 376         u8 *oob_orig = oob;
 377         const int page_size = mtd->writesize;
 378         const int ecc_size = chip->ecc.bytes;
 379         const int pkt_size = chip->ecc.size;
 380         int pos = 0; /* position within physical page */
 381         int rem = page_size; /* bytes remaining until BBM area */
 382
 383         if (oob)
 384                 oob += BBM_SIZE;
 385
 386         aux_read(chip, &oob, METADATA_SIZE, &pos);
 387
 388         while (rem > pkt_size) {
 389                 aux_read(chip, &buf, pkt_size, &pos);
 390                 aux_read(chip, &oob, ecc_size, &pos);
 391                 rem = page_size - pos;
 392         }
 393
 394         aux_read(chip, &buf, rem, &pos);
 395         aux_read(chip, &oob_orig, BBM_SIZE, &pos);
 396         aux_read(chip, &buf, pkt_size - rem, &pos);
 397         aux_read(chip, &oob, ecc_size, &pos);
 398 }
 399
 400 static void raw_write(struct nand_chip *chip, const u8 *buf, const u8 *oob)
 401 {
 402         struct mtd_info *mtd = nand_to_mtd(chip);
 403         const u8 *oob_orig = oob;
 404         const int page_size = mtd->writesize;
 405         const int ecc_size = chip->ecc.bytes;
 406         const int pkt_size = chip->ecc.size;
 407         int pos = 0; /* position within physical page */
 408         int rem = page_size; /* bytes remaining until BBM area */
 409
 410         if (oob)
 411                 oob += BBM_SIZE;
 412
 413         aux_write(chip, &oob, METADATA_SIZE, &pos);
 414
 415         while (rem > pkt_size) {
 416                 aux_write(chip, &buf, pkt_size, &pos);
 417                 aux_write(chip, &oob, ecc_size, &pos);
 418                 rem = page_size - pos;
 419         }
 420
 421         aux_write(chip, &buf, rem, &pos);
 422         aux_write(chip, &oob_orig, BBM_SIZE, &pos);
 423         aux_write(chip, &buf, pkt_size - rem, &pos);
 424         aux_write(chip, &oob, ecc_size, &pos);
 425 }
 426
 427 static int tango_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
 428                                u8 *buf, int oob_required, int page)
 429 {
 430         chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
 431         raw_read(chip, buf, chip->oob_poi);
 432         return 0;
 433 }
 434
 435 static int tango_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
 436                                 const u8 *buf, int oob_required, int page)
 437 {
 438         int status;
 439
 440         chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0, page);
 441         raw_write(chip, buf, chip->oob_poi);
 442         chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
 443
 444         status = chip->waitfunc(mtd, chip);
 445         if (status & NAND_STATUS_FAIL)
 446                 return -EIO;
 447
 448         return 0;
 449 }
 450
 451 static int tango_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
 452                           int page)
 453 {
 454         chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
 455         raw_read(chip, NULL, chip->oob_poi);
 456         return 0;
 457 }
 458
 459 static int tango_write_oob(struct mtd_info *mtd, struct nand_chip *chip,
 460                            int page)
 461 {
 462         chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0, page);
 463         raw_write(chip, NULL, chip->oob_poi);
 464         chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
 465         chip->waitfunc(mtd, chip);
 466         return 0;
 467 }
 468
 469 static int oob_ecc(struct mtd_info *mtd, int idx, struct mtd_oob_region *res)
 470 {
 471         struct nand_chip *chip = mtd_to_nand(mtd);
 472         struct nand_ecc_ctrl *ecc = &chip->ecc;
 473
 474         if (idx >= ecc->steps)
 475                 return -ERANGE;
 476
 477         res->offset = BBM_SIZE + METADATA_SIZE + ecc->bytes * idx;
 478         res->length = ecc->bytes;
 479
 480         return 0;
 481 }
 482
 483 static int oob_free(struct mtd_info *mtd, int idx, struct mtd_oob_region *res)
 484 {
 485         return -ERANGE; /* no free space in spare area */
 486 }
 487
 488 static const struct mtd_ooblayout_ops tango_nand_ooblayout_ops = {
 489         .ecc    = oob_ecc,
 490         .free   = oob_free,
 491 };
 492
 493 static u32 to_ticks(int kHz, int ps)
 494 {
 495         return DIV_ROUND_UP_ULL((u64)kHz * ps, NSEC_PER_SEC);
 496 }
 497
 498 static int tango_set_timings(struct mtd_info *mtd, int csline,
 499                              const struct nand_data_interface *conf)
 500 {
 501         const struct nand_sdr_timings *sdr = nand_get_sdr_timings(conf);
 502         struct nand_chip *chip = mtd_to_nand(mtd);
 503         struct tango_nfc *nfc = to_tango_nfc(chip->controller);
 504         struct tango_chip *tchip = to_tango_chip(chip);
 505         u32 Trdy, Textw, Twc, Twpw, Tacc, Thold, Trpw, Textr;
 506         int kHz = nfc->freq_kHz;
 507
 508         if (IS_ERR(sdr))
 509                 return PTR_ERR(sdr);
 510
 511         if (csline == NAND_DATA_IFACE_CHECK_ONLY)
 512                 return 0;
 513
 514         Trdy = to_ticks(kHz, sdr->tCEA_max - sdr->tREA_max);
 515         Textw = to_ticks(kHz, sdr->tWB_max);
 516         Twc = to_ticks(kHz, sdr->tWC_min);
 517         Twpw = to_ticks(kHz, sdr->tWC_min - sdr->tWP_min);
 518
 519         Tacc = to_ticks(kHz, sdr->tREA_max);
 520         Thold = to_ticks(kHz, sdr->tREH_min);
 521         Trpw = to_ticks(kHz, sdr->tRC_min - sdr->tREH_min);
 522         Textr = to_ticks(kHz, sdr->tRHZ_max);
 523
 524         tchip->timing1 = TIMING(Trdy, Textw, Twc, Twpw);
 525         tchip->timing2 = TIMING(Tacc, Thold, Trpw, Textr);
 526
 527         return 0;
 528 }
 529
 530 static int chip_init(struct device *dev, struct device_node *np)
 531 {
 532         u32 cs;
 533         int err, res;
 534         struct mtd_info *mtd;
 535         struct nand_chip *chip;
 536         struct tango_chip *tchip;
 537         struct nand_ecc_ctrl *ecc;
 538         struct tango_nfc *nfc = dev_get_drvdata(dev);
 539
 540         tchip = devm_kzalloc(dev, sizeof(*tchip), GFP_KERNEL);
 541         if (!tchip)
 542                 return -ENOMEM;
 543
 544         res = of_property_count_u32_elems(np, "reg");
 545         if (res < 0)
 546                 return res;
 547
 548         if (res != 1)
 549                 return -ENOTSUPP; /* Multi-CS chips are not supported */
 550
 551         err = of_property_read_u32_index(np, "reg", 0, &cs);
 552         if (err)
 553                 return err;
 554
 555         if (cs >= MAX_CS)
 556                 return -EINVAL;
 557
 558         chip = &tchip->nand_chip;
 559         ecc = &chip->ecc;
 560         mtd = nand_to_mtd(chip);
 561
 562         chip->read_byte = tango_read_byte;
 563         chip->write_buf = tango_write_buf;
 564         chip->read_buf = tango_read_buf;
 565         chip->select_chip = tango_select_chip;
 566         chip->cmd_ctrl = tango_cmd_ctrl;
 567         chip->dev_ready = tango_dev_ready;
 568         chip->setup_data_interface = tango_set_timings;
 569         chip->options = NAND_USE_BOUNCE_BUFFER |
 570                         NAND_NO_SUBPAGE_WRITE |
 571                         NAND_WAIT_TCCS;
 572         chip->controller = &nfc->hw;
 573         tchip->base = nfc->pbus_base + (cs * 256);
 574
 575         nand_set_flash_node(chip, np);
 576         mtd_set_ooblayout(mtd, &tango_nand_ooblayout_ops);
 577         mtd->dev.parent = dev;
 578
 579         err = nand_scan_ident(mtd, 1, NULL);
 580         if (err)
 581                 return err;
 582
 583         ecc->mode = NAND_ECC_HW;
 584         ecc->algo = NAND_ECC_BCH;
 585         ecc->bytes = DIV_ROUND_UP(ecc->strength * FIELD_ORDER, BITS_PER_BYTE);
 586
 587         ecc->read_page_raw = tango_read_page_raw;
 588         ecc->write_page_raw = tango_write_page_raw;
 589         ecc->read_page = tango_read_page;
 590         ecc->write_page = tango_write_page;
 591         ecc->read_oob = tango_read_oob;
 592         ecc->write_oob = tango_write_oob;
 593         ecc->options = NAND_ECC_CUSTOM_PAGE_ACCESS;
 594
 595         err = nand_scan_tail(mtd);
 596         if (err)
 597                 return err;
 598
 599         tchip->xfer_cfg = XFER_CFG(cs, 1, ecc->steps, METADATA_SIZE);
 600         tchip->pkt_0_cfg = PKT_CFG(ecc->size + METADATA_SIZE, ecc->strength);
 601         tchip->pkt_n_cfg = PKT_CFG(ecc->size, ecc->strength);
 602         tchip->bb_cfg = BB_CFG(mtd->writesize, BBM_SIZE);
 603
 604         err = mtd_device_register(mtd, NULL, 0);
 605         if (err)
 606                 return err;
 607
 608         nfc->chips[cs] = tchip;
 609
 610         return 0;
 611 }
 612
 613 static int tango_nand_remove(struct platform_device *pdev)
 614 {
 615         int cs;
 616         struct tango_nfc *nfc = platform_get_drvdata(pdev);
 617
 618         dma_release_channel(nfc->chan);
 619
 620         for (cs = 0; cs < MAX_CS; ++cs) {
 621                 if (nfc->chips[cs])
 622                         nand_release(nand_to_mtd(&nfc->chips[cs]->nand_chip));
 623         }
 624
 625         return 0;
 626 }
 627
 628 static int tango_nand_probe(struct platform_device *pdev)
 629 {
 630         int err;
 631         struct clk *clk;
 632         struct resource *res;
 633         struct tango_nfc *nfc;
 634         struct device_node *np;
 635
 636         nfc = devm_kzalloc(&pdev->dev, sizeof(*nfc), GFP_KERNEL);
 637         if (!nfc)
 638                 return -ENOMEM;
 639
 640         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 641         nfc->reg_base = devm_ioremap_resource(&pdev->dev, res);
 642         if (IS_ERR(nfc->reg_base))
 643                 return PTR_ERR(nfc->reg_base);
 644
 645         res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
 646         nfc->mem_base = devm_ioremap_resource(&pdev->dev, res);
 647         if (IS_ERR(nfc->mem_base))
 648                 return PTR_ERR(nfc->mem_base);
 649
 650         res = platform_get_resource(pdev, IORESOURCE_MEM, 2);
 651         nfc->pbus_base = devm_ioremap_resource(&pdev->dev, res);
 652         if (IS_ERR(nfc->pbus_base))
 653                 return PTR_ERR(nfc->pbus_base);
 654
 655         writel_relaxed(MODE_RAW, nfc->pbus_base + PBUS_PAD_MODE);
 656
 657         clk = clk_get(&pdev->dev, NULL);
 658         if (IS_ERR(clk))
 659                 return PTR_ERR(clk);
 660
 661         nfc->chan = dma_request_chan(&pdev->dev, "rxtx");
 662         if (IS_ERR(nfc->chan))
 663                 return PTR_ERR(nfc->chan);
 664
 665         platform_set_drvdata(pdev, nfc);
 666         nand_hw_control_init(&nfc->hw);
 667         nfc->freq_kHz = clk_get_rate(clk) / 1000;
 668
 669         for_each_child_of_node(pdev->dev.of_node, np) {
 670                 err = chip_init(&pdev->dev, np);
 671                 if (err) {
 672                         tango_nand_remove(pdev);
 673                         return err;
 674                 }
 675         }
 676
 677         return 0;
 678 }
 679
 680 static const struct of_device_id tango_nand_ids[] = {
 681         { .compatible = "sigma,smp8758-nand" },
 682         { /* sentinel */ }
 683 };
 684 MODULE_DEVICE_TABLE(of, tango_nand_ids);
 685
 686 static struct platform_driver tango_nand_driver = {
 687         .probe  = tango_nand_probe,
 688         .remove = tango_nand_remove,
 689         .driver = {
 690                 .name           = "tango-nand",
 691                 .of_match_table = tango_nand_ids,
 692         },
 693 };
 694
 695 module_platform_driver(tango_nand_driver);
 696
 697 MODULE_LICENSE("GPL");
 698 MODULE_AUTHOR("Sigma Designs");
 699 MODULE_DESCRIPTION("Tango4 NAND Flash controller driver");