blob: 8e148f1478fd2aa8d9c0d58655051c8fbfa528c2 [file] [log] [blame]
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +02001/*
2 * drivers/mtd/ndfc.c
3 *
4 * Overview:
Sean MacLennana808ad32008-12-10 13:16:34 +00005 * Platform independent driver for NDFC (NanD Flash Controller)
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +02006 * integrated into EP440 cores
7 *
Sean MacLennana808ad32008-12-10 13:16:34 +00008 * Ported to an OF platform driver by Sean MacLennan
9 *
10 * The NDFC supports multiple chips, but this driver only supports a
11 * single chip since I do not have access to any boards with
12 * multiple chips.
13 *
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020014 * Author: Thomas Gleixner
15 *
16 * Copyright 2006 IBM
Sean MacLennana808ad32008-12-10 13:16:34 +000017 * Copyright 2008 PIKA Technologies
18 * Sean MacLennan <smaclennan@pikatech.com>
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020019 *
20 * This program is free software; you can redistribute it and/or modify it
21 * under the terms of the GNU General Public License as published by the
22 * Free Software Foundation; either version 2 of the License, or (at your
23 * option) any later version.
24 *
25 */
26#include <linux/module.h>
27#include <linux/mtd/nand.h>
28#include <linux/mtd/nand_ecc.h>
29#include <linux/mtd/partitions.h>
30#include <linux/mtd/ndfc.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090031#include <linux/slab.h>
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020032#include <linux/mtd/mtd.h>
Sean MacLennana808ad32008-12-10 13:16:34 +000033#include <linux/of_platform.h>
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020034#include <asm/io.h>
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020035
Felix Radensky410fe2f2011-04-26 12:36:46 +030036#define NDFC_MAX_CS 4
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020037
38struct ndfc_controller {
Grant Likely2dc11582010-08-06 09:25:50 -060039 struct platform_device *ofdev;
Sean MacLennana808ad32008-12-10 13:16:34 +000040 void __iomem *ndfcbase;
41 struct mtd_info mtd;
42 struct nand_chip chip;
43 int chip_select;
44 struct nand_hw_control ndfc_control;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020045};
46
Felix Radensky410fe2f2011-04-26 12:36:46 +030047static struct ndfc_controller ndfc_ctrl[NDFC_MAX_CS];
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020048
49static void ndfc_select_chip(struct mtd_info *mtd, int chip)
50{
51 uint32_t ccr;
Felix Radensky410fe2f2011-04-26 12:36:46 +030052 struct nand_chip *nchip = mtd->priv;
53 struct ndfc_controller *ndfc = nchip->priv;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020054
Sean MacLennana808ad32008-12-10 13:16:34 +000055 ccr = in_be32(ndfc->ndfcbase + NDFC_CCR);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020056 if (chip >= 0) {
57 ccr &= ~NDFC_CCR_BS_MASK;
Sean MacLennana808ad32008-12-10 13:16:34 +000058 ccr |= NDFC_CCR_BS(chip + ndfc->chip_select);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020059 } else
60 ccr |= NDFC_CCR_RESET_CE;
Sean MacLennana808ad32008-12-10 13:16:34 +000061 out_be32(ndfc->ndfcbase + NDFC_CCR, ccr);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020062}
63
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +020064static void ndfc_hwcontrol(struct mtd_info *mtd, int cmd, unsigned int ctrl)
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020065{
Felix Radensky410fe2f2011-04-26 12:36:46 +030066 struct nand_chip *chip = mtd->priv;
67 struct ndfc_controller *ndfc = chip->priv;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020068
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +020069 if (cmd == NAND_CMD_NONE)
70 return;
71
72 if (ctrl & NAND_CLE)
Thomas Gleixner1794c132006-06-22 13:06:43 +020073 writel(cmd & 0xFF, ndfc->ndfcbase + NDFC_CMD);
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +020074 else
Thomas Gleixner1794c132006-06-22 13:06:43 +020075 writel(cmd & 0xFF, ndfc->ndfcbase + NDFC_ALE);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020076}
77
78static int ndfc_ready(struct mtd_info *mtd)
79{
Felix Radensky410fe2f2011-04-26 12:36:46 +030080 struct nand_chip *chip = mtd->priv;
81 struct ndfc_controller *ndfc = chip->priv;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020082
Sean MacLennana808ad32008-12-10 13:16:34 +000083 return in_be32(ndfc->ndfcbase + NDFC_STAT) & NDFC_STAT_IS_READY;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020084}
85
86static void ndfc_enable_hwecc(struct mtd_info *mtd, int mode)
87{
88 uint32_t ccr;
Felix Radensky410fe2f2011-04-26 12:36:46 +030089 struct nand_chip *chip = mtd->priv;
90 struct ndfc_controller *ndfc = chip->priv;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020091
Sean MacLennana808ad32008-12-10 13:16:34 +000092 ccr = in_be32(ndfc->ndfcbase + NDFC_CCR);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020093 ccr |= NDFC_CCR_RESET_ECC;
Sean MacLennana808ad32008-12-10 13:16:34 +000094 out_be32(ndfc->ndfcbase + NDFC_CCR, ccr);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +020095 wmb();
96}
97
98static int ndfc_calculate_ecc(struct mtd_info *mtd,
99 const u_char *dat, u_char *ecc_code)
100{
Felix Radensky410fe2f2011-04-26 12:36:46 +0300101 struct nand_chip *chip = mtd->priv;
102 struct ndfc_controller *ndfc = chip->priv;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200103 uint32_t ecc;
104 uint8_t *p = (uint8_t *)&ecc;
105
106 wmb();
Sean MacLennana808ad32008-12-10 13:16:34 +0000107 ecc = in_be32(ndfc->ndfcbase + NDFC_ECC);
108 /* The NDFC uses Smart Media (SMC) bytes order */
Feng Kan76c23c32009-08-25 11:27:20 -0700109 ecc_code[0] = p[1];
110 ecc_code[1] = p[2];
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200111 ecc_code[2] = p[3];
112
113 return 0;
114}
115
116/*
117 * Speedups for buffer read/write/verify
118 *
119 * NDFC allows 32bit read/write of data. So we can speed up the buffer
120 * functions. No further checking, as nand_base will always read/write
121 * page aligned.
122 */
123static void ndfc_read_buf(struct mtd_info *mtd, uint8_t *buf, int len)
124{
Felix Radensky410fe2f2011-04-26 12:36:46 +0300125 struct nand_chip *chip = mtd->priv;
126 struct ndfc_controller *ndfc = chip->priv;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200127 uint32_t *p = (uint32_t *) buf;
128
129 for(;len > 0; len -= 4)
Sean MacLennana808ad32008-12-10 13:16:34 +0000130 *p++ = in_be32(ndfc->ndfcbase + NDFC_DATA);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200131}
132
133static void ndfc_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len)
134{
Felix Radensky410fe2f2011-04-26 12:36:46 +0300135 struct nand_chip *chip = mtd->priv;
136 struct ndfc_controller *ndfc = chip->priv;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200137 uint32_t *p = (uint32_t *) buf;
138
139 for(;len > 0; len -= 4)
Sean MacLennana808ad32008-12-10 13:16:34 +0000140 out_be32(ndfc->ndfcbase + NDFC_DATA, *p++);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200141}
142
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200143/*
144 * Initialize chip structure
145 */
Sean MacLennana808ad32008-12-10 13:16:34 +0000146static int ndfc_chip_init(struct ndfc_controller *ndfc,
147 struct device_node *node)
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200148{
Sean MacLennana808ad32008-12-10 13:16:34 +0000149 struct device_node *flash_np;
150 struct nand_chip *chip = &ndfc->chip;
Dmitry Eremin-Solenikov9d7948c2011-05-30 01:02:25 +0400151 struct mtd_part_parser_data ppdata;
Sean MacLennana808ad32008-12-10 13:16:34 +0000152 int ret;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200153
154 chip->IO_ADDR_R = ndfc->ndfcbase + NDFC_DATA;
155 chip->IO_ADDR_W = ndfc->ndfcbase + NDFC_DATA;
Thomas Gleixner7abd3ef2006-05-23 23:25:53 +0200156 chip->cmd_ctrl = ndfc_hwcontrol;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200157 chip->dev_ready = ndfc_ready;
158 chip->select_chip = ndfc_select_chip;
159 chip->chip_delay = 50;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200160 chip->controller = &ndfc->ndfc_control;
161 chip->read_buf = ndfc_read_buf;
162 chip->write_buf = ndfc_write_buf;
Thomas Gleixner6dfc6d22006-05-23 12:00:46 +0200163 chip->ecc.correct = nand_correct_data;
164 chip->ecc.hwctl = ndfc_enable_hwecc;
165 chip->ecc.calculate = ndfc_calculate_ecc;
166 chip->ecc.mode = NAND_ECC_HW;
167 chip->ecc.size = 256;
168 chip->ecc.bytes = 3;
Mike Dunn6a918ba2012-03-11 14:21:11 -0700169 chip->ecc.strength = 1;
Felix Radensky410fe2f2011-04-26 12:36:46 +0300170 chip->priv = ndfc;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200171
Sean MacLennana808ad32008-12-10 13:16:34 +0000172 ndfc->mtd.priv = chip;
173 ndfc->mtd.owner = THIS_MODULE;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200174
Sean MacLennana808ad32008-12-10 13:16:34 +0000175 flash_np = of_get_next_child(node, NULL);
176 if (!flash_np)
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200177 return -ENODEV;
Sean MacLennana808ad32008-12-10 13:16:34 +0000178
Tony Breeds629be5f2011-11-22 15:39:11 +1100179 ppdata.of_node = flash_np;
Sean MacLennana808ad32008-12-10 13:16:34 +0000180 ndfc->mtd.name = kasprintf(GFP_KERNEL, "%s.%s",
Kay Sieversc36f1e32009-03-24 16:38:21 -0700181 dev_name(&ndfc->ofdev->dev), flash_np->name);
Sean MacLennana808ad32008-12-10 13:16:34 +0000182 if (!ndfc->mtd.name) {
183 ret = -ENOMEM;
184 goto err;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200185 }
186
Sean MacLennana808ad32008-12-10 13:16:34 +0000187 ret = nand_scan(&ndfc->mtd, 1);
188 if (ret)
189 goto err;
190
Dmitry Eremin-Solenikova9106492011-06-02 18:00:51 +0400191 ret = mtd_device_parse_register(&ndfc->mtd, NULL, &ppdata, NULL, 0);
Sean MacLennana808ad32008-12-10 13:16:34 +0000192
193err:
194 of_node_put(flash_np);
195 if (ret)
196 kfree(ndfc->mtd.name);
197 return ret;
198}
199
Bill Pemberton06f25512012-11-19 13:23:07 -0500200static int ndfc_probe(struct platform_device *ofdev)
Sean MacLennana808ad32008-12-10 13:16:34 +0000201{
Felix Radensky410fe2f2011-04-26 12:36:46 +0300202 struct ndfc_controller *ndfc;
Ian Munsie766f2712010-10-01 17:06:08 +1000203 const __be32 *reg;
Sean MacLennana808ad32008-12-10 13:16:34 +0000204 u32 ccr;
Felix Radensky410fe2f2011-04-26 12:36:46 +0300205 int err, len, cs;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200206
Sean MacLennana808ad32008-12-10 13:16:34 +0000207 /* Read the reg property to get the chip select */
Grant Likely61c7a082010-04-13 16:12:29 -0700208 reg = of_get_property(ofdev->dev.of_node, "reg", &len);
Sean MacLennana808ad32008-12-10 13:16:34 +0000209 if (reg == NULL || len != 12) {
210 dev_err(&ofdev->dev, "unable read reg property (%d)\n", len);
211 return -ENOENT;
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200212 }
Felix Radensky410fe2f2011-04-26 12:36:46 +0300213
214 cs = be32_to_cpu(reg[0]);
215 if (cs >= NDFC_MAX_CS) {
216 dev_err(&ofdev->dev, "invalid CS number (%d)\n", cs);
217 return -EINVAL;
218 }
219
220 ndfc = &ndfc_ctrl[cs];
221 ndfc->chip_select = cs;
222
223 spin_lock_init(&ndfc->ndfc_control.lock);
224 init_waitqueue_head(&ndfc->ndfc_control.wq);
225 ndfc->ofdev = ofdev;
226 dev_set_drvdata(&ofdev->dev, ndfc);
Sean MacLennana808ad32008-12-10 13:16:34 +0000227
Grant Likely61c7a082010-04-13 16:12:29 -0700228 ndfc->ndfcbase = of_iomap(ofdev->dev.of_node, 0);
Sean MacLennana808ad32008-12-10 13:16:34 +0000229 if (!ndfc->ndfcbase) {
230 dev_err(&ofdev->dev, "failed to get memory\n");
231 return -EIO;
232 }
233
234 ccr = NDFC_CCR_BS(ndfc->chip_select);
235
236 /* It is ok if ccr does not exist - just default to 0 */
Grant Likely61c7a082010-04-13 16:12:29 -0700237 reg = of_get_property(ofdev->dev.of_node, "ccr", NULL);
Sean MacLennana808ad32008-12-10 13:16:34 +0000238 if (reg)
Ian Munsie766f2712010-10-01 17:06:08 +1000239 ccr |= be32_to_cpup(reg);
Sean MacLennana808ad32008-12-10 13:16:34 +0000240
241 out_be32(ndfc->ndfcbase + NDFC_CCR, ccr);
242
243 /* Set the bank settings if given */
Grant Likely61c7a082010-04-13 16:12:29 -0700244 reg = of_get_property(ofdev->dev.of_node, "bank-settings", NULL);
Sean MacLennana808ad32008-12-10 13:16:34 +0000245 if (reg) {
246 int offset = NDFC_BCFG0 + (ndfc->chip_select << 2);
Ian Munsie766f2712010-10-01 17:06:08 +1000247 out_be32(ndfc->ndfcbase + offset, be32_to_cpup(reg));
Sean MacLennana808ad32008-12-10 13:16:34 +0000248 }
249
Grant Likely61c7a082010-04-13 16:12:29 -0700250 err = ndfc_chip_init(ndfc, ofdev->dev.of_node);
Sean MacLennana808ad32008-12-10 13:16:34 +0000251 if (err) {
252 iounmap(ndfc->ndfcbase);
253 return err;
254 }
255
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200256 return 0;
257}
258
Bill Pemberton810b7e02012-11-19 13:26:04 -0500259static int ndfc_remove(struct platform_device *ofdev)
Sean MacLennana808ad32008-12-10 13:16:34 +0000260{
261 struct ndfc_controller *ndfc = dev_get_drvdata(&ofdev->dev);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200262
Sean MacLennana808ad32008-12-10 13:16:34 +0000263 nand_release(&ndfc->mtd);
Axel Lin96166052011-06-07 22:55:21 +0800264 kfree(ndfc->mtd.name);
Sean MacLennana808ad32008-12-10 13:16:34 +0000265
266 return 0;
267}
268
269static const struct of_device_id ndfc_match[] = {
270 { .compatible = "ibm,ndfc", },
271 {}
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200272};
Sean MacLennana808ad32008-12-10 13:16:34 +0000273MODULE_DEVICE_TABLE(of, ndfc_match);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200274
Grant Likely1c48a5c2011-02-17 02:43:24 -0700275static struct platform_driver ndfc_driver = {
Sean MacLennana808ad32008-12-10 13:16:34 +0000276 .driver = {
Grant Likely40182942010-04-13 16:13:02 -0700277 .name = "ndfc",
278 .owner = THIS_MODULE,
279 .of_match_table = ndfc_match,
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200280 },
Sean MacLennana808ad32008-12-10 13:16:34 +0000281 .probe = ndfc_probe,
Bill Pemberton5153b882012-11-19 13:21:24 -0500282 .remove = ndfc_remove,
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200283};
284
Axel Linf99640d2011-11-27 20:45:03 +0800285module_platform_driver(ndfc_driver);
Thomas Gleixnerce4c61f2006-05-23 11:43:28 +0200286
287MODULE_LICENSE("GPL");
288MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>");
Sean MacLennana808ad32008-12-10 13:16:34 +0000289MODULE_DESCRIPTION("OF Platform driver for NDFC");