4 #include <linux/iopoll.h>
5 #include <linux/module.h>
6 #include <linux/mtd/nand.h>
7 #include <linux/dmaengine.h>
8 #include <linux/dma-mapping.h>
9 #include <linux/platform_device.h>
11 /* Offsets relative to chip->base */
16 /* Offsets relative to reg_base */
17 #define NFC_STATUS 0x00
18 #define NFC_FLASH_CMD 0x04
19 #define NFC_DEVICE_CFG 0x08
20 #define NFC_TIMING1 0x0c
21 #define NFC_TIMING2 0x10
22 #define NFC_XFER_CFG 0x14
23 #define NFC_PKT_0_CFG 0x18
24 #define NFC_PKT_N_CFG 0x1c
25 #define NFC_BB_CFG 0x20
26 #define NFC_ADDR_PAGE 0x24
27 #define NFC_ADDR_OFFSET 0x28
28 #define NFC_XFER_STATUS 0x2c
30 /* NFC_STATUS values */
31 #define CMD_READY BIT(31)
33 /* NFC_FLASH_CMD values */
37 /* NFC_XFER_STATUS values */
38 #define PAGE_IS_EMPTY BIT(16)
40 /* Offsets relative to mem_base */
41 #define METADATA 0x000
42 #define ERROR_REPORT 0x1c0
45 * Error reports are split in two bytes:
46 * byte 0 for the first packet in the page (PKT_0)
47 * byte 1 for other packets in the page (PKT_N, for N > 0)
48 * ERR_COUNT_PKT_N is the max error count over all but the first packet.
50 #define DECODE_OK_PKT_0(v) ((v) & BIT(7))
51 #define DECODE_OK_PKT_N(v) ((v) & BIT(15))
52 #define ERR_COUNT_PKT_0(v) (((v) >> 0) & 0x3f)
53 #define ERR_COUNT_PKT_N(v) (((v) >> 8) & 0x3f)
55 /* Offsets relative to pbus_base */
56 #define PBUS_CS_CTRL 0x83c
57 #define PBUS_PAD_MODE 0x8f0
59 /* PBUS_CS_CTRL values */
60 #define PBUS_IORDY BIT(31)
63 * PBUS_PAD_MODE values
64 * In raw mode, the driver communicates directly with the NAND chips.
65 * In NFC mode, the NAND Flash controller manages the communication.
66 * We use NFC mode for read and write; raw mode for everything else.
69 #define MODE_NFC BIT(31)
71 #define METADATA_SIZE 4
73 #define FIELD_ORDER 15
78 struct nand_hw_control hw;
79 void __iomem *reg_base;
80 void __iomem *mem_base;
81 void __iomem *pbus_base;
82 struct tango_chip *chips[MAX_CS];
83 struct dma_chan *chan;
87 #define to_tango_nfc(ptr) container_of(ptr, struct tango_nfc, hw)
90 struct nand_chip nand_chip;
100 #define to_tango_chip(ptr) container_of(ptr, struct tango_chip, nand_chip)
102 #define XFER_CFG(cs, page_count, steps, metadata_size) \
103 ((cs) << 24 | (page_count) << 16 | (steps) << 8 | (metadata_size))
105 #define PKT_CFG(size, strength) ((size) << 16 | (strength))
107 #define BB_CFG(bb_offset, bb_size) ((bb_offset) << 16 | (bb_size))
109 #define TIMING(t0, t1, t2, t3) ((t0) << 24 | (t1) << 16 | (t2) << 8 | (t3))
111 static void tango_cmd_ctrl(struct mtd_info *mtd, int dat, unsigned int ctrl)
113 struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
116 writeb_relaxed(dat, tchip->base + PBUS_CMD);
119 writeb_relaxed(dat, tchip->base + PBUS_ADDR);
122 static int tango_dev_ready(struct mtd_info *mtd)
124 struct nand_chip *chip = mtd_to_nand(mtd);
125 struct tango_nfc *nfc = to_tango_nfc(chip->controller);
127 return readl_relaxed(nfc->pbus_base + PBUS_CS_CTRL) & PBUS_IORDY;
130 static u8 tango_read_byte(struct mtd_info *mtd)
132 struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
134 return readb_relaxed(tchip->base + PBUS_DATA);
137 static void tango_read_buf(struct mtd_info *mtd, u8 *buf, int len)
139 struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
141 ioread8_rep(tchip->base + PBUS_DATA, buf, len);
144 static void tango_write_buf(struct mtd_info *mtd, const u8 *buf, int len)
146 struct tango_chip *tchip = to_tango_chip(mtd_to_nand(mtd));
148 iowrite8_rep(tchip->base + PBUS_DATA, buf, len);
151 static void tango_select_chip(struct mtd_info *mtd, int idx)
153 struct nand_chip *chip = mtd_to_nand(mtd);
154 struct tango_nfc *nfc = to_tango_nfc(chip->controller);
155 struct tango_chip *tchip = to_tango_chip(chip);
158 return; /* No "chip unselect" function */
160 writel_relaxed(tchip->timing1, nfc->reg_base + NFC_TIMING1);
161 writel_relaxed(tchip->timing2, nfc->reg_base + NFC_TIMING2);
162 writel_relaxed(tchip->xfer_cfg, nfc->reg_base + NFC_XFER_CFG);
163 writel_relaxed(tchip->pkt_0_cfg, nfc->reg_base + NFC_PKT_0_CFG);
164 writel_relaxed(tchip->pkt_n_cfg, nfc->reg_base + NFC_PKT_N_CFG);
165 writel_relaxed(tchip->bb_cfg, nfc->reg_base + NFC_BB_CFG);
169 * The controller does not check for bitflips in erased pages,
170 * therefore software must check instead.
172 static int check_erased_page(struct nand_chip *chip, u8 *buf)
174 struct mtd_info *mtd = nand_to_mtd(chip);
175 u8 *meta = chip->oob_poi + BBM_SIZE;
176 u8 *ecc = chip->oob_poi + BBM_SIZE + METADATA_SIZE;
177 const int ecc_size = chip->ecc.bytes;
178 const int pkt_size = chip->ecc.size;
179 int i, res, meta_len, bitflips = 0;
181 for (i = 0; i < chip->ecc.steps; ++i) {
182 meta_len = i ? 0 : METADATA_SIZE;
183 res = nand_check_erased_ecc_chunk(buf, pkt_size, ecc, ecc_size,
187 mtd->ecc_stats.failed++;
189 bitflips = max(res, bitflips);
197 static int decode_error_report(struct tango_nfc *nfc)
201 status = readl_relaxed(nfc->reg_base + NFC_XFER_STATUS);
202 if (status & PAGE_IS_EMPTY)
205 res = readl_relaxed(nfc->mem_base + ERROR_REPORT);
207 if (DECODE_OK_PKT_0(res) && DECODE_OK_PKT_N(res))
208 return max(ERR_COUNT_PKT_0(res), ERR_COUNT_PKT_N(res));
213 static void tango_dma_callback(void *arg)
218 static int do_dma(struct tango_nfc *nfc, int dir, int cmd, const void *buf,
221 void __iomem *addr = nfc->reg_base + NFC_STATUS;
222 struct dma_chan *chan = nfc->chan;
223 struct dma_async_tx_descriptor *desc;
224 struct scatterlist sg;
225 struct completion tx_done;
229 sg_init_one(&sg, buf, len);
230 if (dma_map_sg(chan->device->dev, &sg, 1, dir) != 1)
233 desc = dmaengine_prep_slave_sg(chan, &sg, 1, dir, DMA_PREP_INTERRUPT);
237 desc->callback = tango_dma_callback;
238 desc->callback_param = &tx_done;
239 init_completion(&tx_done);
241 writel_relaxed(MODE_NFC, nfc->pbus_base + PBUS_PAD_MODE);
243 writel_relaxed(page, nfc->reg_base + NFC_ADDR_PAGE);
244 writel_relaxed(0, nfc->reg_base + NFC_ADDR_OFFSET);
245 writel_relaxed(cmd, nfc->reg_base + NFC_FLASH_CMD);
247 dmaengine_submit(desc);
248 dma_async_issue_pending(chan);
250 res = wait_for_completion_timeout(&tx_done, HZ);
252 err = readl_poll_timeout(addr, val, val & CMD_READY, 0, 1000);
254 writel_relaxed(MODE_RAW, nfc->pbus_base + PBUS_PAD_MODE);
257 dma_unmap_sg(chan->device->dev, &sg, 1, dir);
262 static int tango_read_page(struct mtd_info *mtd, struct nand_chip *chip,
263 u8 *buf, int oob_required, int page)
265 struct tango_nfc *nfc = to_tango_nfc(chip->controller);
266 int err, res, len = mtd->writesize;
269 chip->ecc.read_oob(mtd, chip, page);
271 err = do_dma(nfc, DMA_FROM_DEVICE, NFC_READ, buf, len, page);
275 res = decode_error_report(nfc);
277 chip->ecc.read_oob_raw(mtd, chip, page);
278 res = check_erased_page(chip, buf);
284 static int tango_write_page(struct mtd_info *mtd, struct nand_chip *chip,
285 const u8 *buf, int oob_required, int page)
287 struct tango_nfc *nfc = to_tango_nfc(chip->controller);
288 int err, len = mtd->writesize;
290 /* Calling tango_write_oob() would send PAGEPROG twice */
294 writel_relaxed(0xffffffff, nfc->mem_base + METADATA);
295 err = do_dma(nfc, DMA_TO_DEVICE, NFC_WRITE, buf, len, page);
302 static void aux_read(struct nand_chip *chip, u8 **buf, int len, int *pos)
304 struct mtd_info *mtd = nand_to_mtd(chip);
309 /* skip over "len" bytes */
310 chip->cmdfunc(mtd, NAND_CMD_RNDOUT, *pos, -1);
312 tango_read_buf(mtd, *buf, len);
317 static void aux_write(struct nand_chip *chip, const u8 **buf, int len, int *pos)
319 struct mtd_info *mtd = nand_to_mtd(chip);
324 /* skip over "len" bytes */
325 chip->cmdfunc(mtd, NAND_CMD_SEQIN, *pos, -1);
327 tango_write_buf(mtd, *buf, len);
333 * Physical page layout (not drawn to scale)
335 * NB: Bad Block Marker area splits PKT_N in two (N1, N2).
337 * +---+-----------------+-------+-----+-----------+-----+----+-------+
338 * | M | PKT_0 | ECC_0 | ... | N1 | BBM | N2 | ECC_N |
339 * +---+-----------------+-------+-----+-----------+-----+----+-------+
341 * Logical page layout:
343 * +-----+---+-------+-----+-------+
344 * oob = | BBM | M | ECC_0 | ... | ECC_N |
345 * +-----+---+-------+-----+-------+
347 * +-----------------+-----+-----------------+
348 * buf = | PKT_0 | ... | PKT_N |
349 * +-----------------+-----+-----------------+
351 static void raw_read(struct nand_chip *chip, u8 *buf, u8 *oob)
353 struct mtd_info *mtd = nand_to_mtd(chip);
355 const int page_size = mtd->writesize;
356 const int ecc_size = chip->ecc.bytes;
357 const int pkt_size = chip->ecc.size;
358 int pos = 0; /* position within physical page */
359 int rem = page_size; /* bytes remaining until BBM area */
364 aux_read(chip, &oob, METADATA_SIZE, &pos);
366 while (rem > pkt_size) {
367 aux_read(chip, &buf, pkt_size, &pos);
368 aux_read(chip, &oob, ecc_size, &pos);
369 rem = page_size - pos;
372 aux_read(chip, &buf, rem, &pos);
373 aux_read(chip, &oob_orig, BBM_SIZE, &pos);
374 aux_read(chip, &buf, pkt_size - rem, &pos);
375 aux_read(chip, &oob, ecc_size, &pos);
378 static void raw_write(struct nand_chip *chip, const u8 *buf, const u8 *oob)
380 struct mtd_info *mtd = nand_to_mtd(chip);
381 const u8 *oob_orig = oob;
382 const int page_size = mtd->writesize;
383 const int ecc_size = chip->ecc.bytes;
384 const int pkt_size = chip->ecc.size;
385 int pos = 0; /* position within physical page */
386 int rem = page_size; /* bytes remaining until BBM area */
391 aux_write(chip, &oob, METADATA_SIZE, &pos);
393 while (rem > pkt_size) {
394 aux_write(chip, &buf, pkt_size, &pos);
395 aux_write(chip, &oob, ecc_size, &pos);
396 rem = page_size - pos;
399 aux_write(chip, &buf, rem, &pos);
400 aux_write(chip, &oob_orig, BBM_SIZE, &pos);
401 aux_write(chip, &buf, pkt_size - rem, &pos);
402 aux_write(chip, &oob, ecc_size, &pos);
405 static int tango_read_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
406 u8 *buf, int oob_required, int page)
408 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
409 raw_read(chip, buf, chip->oob_poi);
413 static int tango_write_page_raw(struct mtd_info *mtd, struct nand_chip *chip,
414 const u8 *buf, int oob_required, int page)
416 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0, page);
417 raw_write(chip, buf, chip->oob_poi);
418 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
422 static int tango_read_oob(struct mtd_info *mtd, struct nand_chip *chip,
425 chip->cmdfunc(mtd, NAND_CMD_READ0, 0, page);
426 raw_read(chip, NULL, chip->oob_poi);
430 static int tango_write_oob(struct mtd_info *mtd, struct nand_chip *chip,
433 chip->cmdfunc(mtd, NAND_CMD_SEQIN, 0, page);
434 raw_write(chip, NULL, chip->oob_poi);
435 chip->cmdfunc(mtd, NAND_CMD_PAGEPROG, -1, -1);
436 chip->waitfunc(mtd, chip);
440 static int oob_ecc(struct mtd_info *mtd, int idx, struct mtd_oob_region *res)
442 struct nand_chip *chip = mtd_to_nand(mtd);
443 struct nand_ecc_ctrl *ecc = &chip->ecc;
445 if (idx >= ecc->steps)
448 res->offset = BBM_SIZE + METADATA_SIZE + ecc->bytes * idx;
449 res->length = ecc->bytes;
454 static int oob_free(struct mtd_info *mtd, int idx, struct mtd_oob_region *res)
456 return -ERANGE; /* no free space in spare area */
459 static const struct mtd_ooblayout_ops tango_nand_ooblayout_ops = {
464 static u32 to_ticks(int kHz, int ps)
466 return DIV_ROUND_UP_ULL((u64)kHz * ps, NSEC_PER_SEC);
469 static int tango_set_timings(struct mtd_info *mtd,
470 const struct nand_data_interface *conf,
473 const struct nand_sdr_timings *sdr = nand_get_sdr_timings(conf);
474 struct nand_chip *chip = mtd_to_nand(mtd);
475 struct tango_nfc *nfc = to_tango_nfc(chip->controller);
476 struct tango_chip *tchip = to_tango_chip(chip);
477 u32 Trdy, Textw, Twc, Twpw, Tacc, Thold, Trpw, Textr;
478 int kHz = nfc->freq_kHz;
486 Trdy = to_ticks(kHz, sdr->tCEA_max - sdr->tREA_max);
487 Textw = to_ticks(kHz, sdr->tWB_max);
488 Twc = to_ticks(kHz, sdr->tWC_min);
489 Twpw = to_ticks(kHz, sdr->tWC_min - sdr->tWP_min);
491 Tacc = to_ticks(kHz, sdr->tREA_max);
492 Thold = to_ticks(kHz, sdr->tREH_min);
493 Trpw = to_ticks(kHz, sdr->tRC_min - sdr->tREH_min);
494 Textr = to_ticks(kHz, sdr->tRHZ_max);
496 tchip->timing1 = TIMING(Trdy, Textw, Twc, Twpw);
497 tchip->timing2 = TIMING(Tacc, Thold, Trpw, Textr);
502 static int chip_init(struct device *dev, struct device_node *np)
506 struct mtd_info *mtd;
507 struct nand_chip *chip;
508 struct tango_chip *tchip;
509 struct nand_ecc_ctrl *ecc;
510 struct tango_nfc *nfc = dev_get_drvdata(dev);
512 tchip = devm_kzalloc(dev, sizeof(*tchip), GFP_KERNEL);
516 res = of_property_count_u32_elems(np, "reg");
521 return -ENOTSUPP; /* Multi-CS chips are not supported */
523 err = of_property_read_u32_index(np, "reg", 0, &cs);
530 chip = &tchip->nand_chip;
532 mtd = nand_to_mtd(chip);
534 chip->read_byte = tango_read_byte;
535 chip->write_buf = tango_write_buf;
536 chip->read_buf = tango_read_buf;
537 chip->select_chip = tango_select_chip;
538 chip->cmd_ctrl = tango_cmd_ctrl;
539 chip->dev_ready = tango_dev_ready;
540 chip->setup_data_interface = tango_set_timings;
541 chip->options = NAND_USE_BOUNCE_BUFFER |
542 NAND_NO_SUBPAGE_WRITE |
544 chip->controller = &nfc->hw;
545 tchip->base = nfc->pbus_base + (cs * 256);
547 nand_set_flash_node(chip, np);
548 mtd_set_ooblayout(mtd, &tango_nand_ooblayout_ops);
549 mtd->dev.parent = dev;
551 err = nand_scan_ident(mtd, 1, NULL);
555 ecc->mode = NAND_ECC_HW;
556 ecc->algo = NAND_ECC_BCH;
557 ecc->bytes = DIV_ROUND_UP(ecc->strength * FIELD_ORDER, BITS_PER_BYTE);
559 ecc->read_page_raw = tango_read_page_raw;
560 ecc->write_page_raw = tango_write_page_raw;
561 ecc->read_page = tango_read_page;
562 ecc->write_page = tango_write_page;
563 ecc->read_oob = tango_read_oob;
564 ecc->write_oob = tango_write_oob;
565 ecc->options = NAND_ECC_CUSTOM_PAGE_ACCESS;
567 err = nand_scan_tail(mtd);
571 tchip->xfer_cfg = XFER_CFG(cs, 1, ecc->steps, METADATA_SIZE);
572 tchip->pkt_0_cfg = PKT_CFG(ecc->size + METADATA_SIZE, ecc->strength);
573 tchip->pkt_n_cfg = PKT_CFG(ecc->size, ecc->strength);
574 tchip->bb_cfg = BB_CFG(mtd->writesize, BBM_SIZE);
576 err = mtd_device_register(mtd, NULL, 0);
580 nfc->chips[cs] = tchip;
585 static int tango_nand_remove(struct platform_device *pdev)
588 struct tango_nfc *nfc = platform_get_drvdata(pdev);
590 dma_release_channel(nfc->chan);
592 for (cs = 0; cs < MAX_CS; ++cs) {
594 nand_release(nand_to_mtd(&nfc->chips[cs]->nand_chip));
600 static int tango_nand_probe(struct platform_device *pdev)
604 struct resource *res;
605 struct tango_nfc *nfc;
606 struct device_node *np;
608 nfc = devm_kzalloc(&pdev->dev, sizeof(*nfc), GFP_KERNEL);
612 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
613 nfc->reg_base = devm_ioremap_resource(&pdev->dev, res);
614 if (IS_ERR(nfc->reg_base))
615 return PTR_ERR(nfc->reg_base);
617 res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
618 nfc->mem_base = devm_ioremap_resource(&pdev->dev, res);
619 if (IS_ERR(nfc->mem_base))
620 return PTR_ERR(nfc->mem_base);
622 res = platform_get_resource(pdev, IORESOURCE_MEM, 2);
623 nfc->pbus_base = devm_ioremap_resource(&pdev->dev, res);
624 if (IS_ERR(nfc->pbus_base))
625 return PTR_ERR(nfc->pbus_base);
627 clk = clk_get(&pdev->dev, NULL);
631 nfc->chan = dma_request_chan(&pdev->dev, "nfc_sbox");
632 if (IS_ERR(nfc->chan))
633 return PTR_ERR(nfc->chan);
635 platform_set_drvdata(pdev, nfc);
636 nand_hw_control_init(&nfc->hw);
637 nfc->freq_kHz = clk_get_rate(clk) / 1000;
639 for_each_child_of_node(pdev->dev.of_node, np) {
640 err = chip_init(&pdev->dev, np);
642 tango_nand_remove(pdev);
650 static const struct of_device_id tango_nand_ids[] = {
651 { .compatible = "sigma,smp8758-nand" },
655 static struct platform_driver tango_nand_driver = {
656 .probe = tango_nand_probe,
657 .remove = tango_nand_remove,
659 .name = "tango-nand",
660 .of_match_table = tango_nand_ids,
664 module_platform_driver(tango_nand_driver);
666 MODULE_LICENSE("GPL");
667 MODULE_AUTHOR("Sigma Designs");
668 MODULE_DESCRIPTION("Tango4 NAND Flash controller driver");