Commit | Line | Data |
---|---|---|
ce4c61f1 | 1 | /* |
ce4c61f1 | 2 | * Overview: |
a808ad3b | 3 | * Platform independent driver for NDFC (NanD Flash Controller) |
ce4c61f1 TG |
4 | * integrated into EP440 cores |
5 | * | |
a808ad3b SM |
6 | * Ported to an OF platform driver by Sean MacLennan |
7 | * | |
8 | * The NDFC supports multiple chips, but this driver only supports a | |
9 | * single chip since I do not have access to any boards with | |
10 | * multiple chips. | |
11 | * | |
ce4c61f1 TG |
12 | * Author: Thomas Gleixner |
13 | * | |
14 | * Copyright 2006 IBM | |
a808ad3b SM |
15 | * Copyright 2008 PIKA Technologies |
16 | * Sean MacLennan <smaclennan@pikatech.com> | |
ce4c61f1 TG |
17 | * |
18 | * This program is free software; you can redistribute it and/or modify it | |
19 | * under the terms of the GNU General Public License as published by the | |
20 | * Free Software Foundation; either version 2 of the License, or (at your | |
21 | * option) any later version. | |
22 | * | |
23 | */ | |
24 | #include <linux/module.h> | |
25 | #include <linux/mtd/nand.h> | |
26 | #include <linux/mtd/nand_ecc.h> | |
27 | #include <linux/mtd/partitions.h> | |
28 | #include <linux/mtd/ndfc.h> | |
5a0e3ad6 | 29 | #include <linux/slab.h> |
ce4c61f1 | 30 | #include <linux/mtd/mtd.h> |
5af50730 | 31 | #include <linux/of_address.h> |
a808ad3b | 32 | #include <linux/of_platform.h> |
ce4c61f1 | 33 | #include <asm/io.h> |
ce4c61f1 | 34 | |
410fe2f0 | 35 | #define NDFC_MAX_CS 4 |
ce4c61f1 TG |
36 | |
37 | struct ndfc_controller { | |
2dc11581 | 38 | struct platform_device *ofdev; |
a808ad3b | 39 | void __iomem *ndfcbase; |
a808ad3b SM |
40 | struct nand_chip chip; |
41 | int chip_select; | |
42 | struct nand_hw_control ndfc_control; | |
ce4c61f1 TG |
43 | }; |
44 | ||
410fe2f0 | 45 | static struct ndfc_controller ndfc_ctrl[NDFC_MAX_CS]; |
ce4c61f1 TG |
46 | |
47 | static void ndfc_select_chip(struct mtd_info *mtd, int chip) | |
48 | { | |
49 | uint32_t ccr; | |
4bd4ebcc | 50 | struct nand_chip *nchip = mtd_to_nand(mtd); |
d699ed25 | 51 | struct ndfc_controller *ndfc = nand_get_controller_data(nchip); |
ce4c61f1 | 52 | |
a808ad3b | 53 | ccr = in_be32(ndfc->ndfcbase + NDFC_CCR); |
ce4c61f1 TG |
54 | if (chip >= 0) { |
55 | ccr &= ~NDFC_CCR_BS_MASK; | |
a808ad3b | 56 | ccr |= NDFC_CCR_BS(chip + ndfc->chip_select); |
ce4c61f1 TG |
57 | } else |
58 | ccr |= NDFC_CCR_RESET_CE; | |
a808ad3b | 59 | out_be32(ndfc->ndfcbase + NDFC_CCR, ccr); |
ce4c61f1 TG |
60 | } |
61 | ||
7abd3ef9 | 62 | static void ndfc_hwcontrol(struct mtd_info *mtd, int cmd, unsigned int ctrl) |
ce4c61f1 | 63 | { |
4bd4ebcc | 64 | struct nand_chip *chip = mtd_to_nand(mtd); |
d699ed25 | 65 | struct ndfc_controller *ndfc = nand_get_controller_data(chip); |
ce4c61f1 | 66 | |
7abd3ef9 TG |
67 | if (cmd == NAND_CMD_NONE) |
68 | return; | |
69 | ||
70 | if (ctrl & NAND_CLE) | |
1794c130 | 71 | writel(cmd & 0xFF, ndfc->ndfcbase + NDFC_CMD); |
7abd3ef9 | 72 | else |
1794c130 | 73 | writel(cmd & 0xFF, ndfc->ndfcbase + NDFC_ALE); |
ce4c61f1 TG |
74 | } |
75 | ||
76 | static int ndfc_ready(struct mtd_info *mtd) | |
77 | { | |
4bd4ebcc | 78 | struct nand_chip *chip = mtd_to_nand(mtd); |
d699ed25 | 79 | struct ndfc_controller *ndfc = nand_get_controller_data(chip); |
ce4c61f1 | 80 | |
a808ad3b | 81 | return in_be32(ndfc->ndfcbase + NDFC_STAT) & NDFC_STAT_IS_READY; |
ce4c61f1 TG |
82 | } |
83 | ||
84 | static void ndfc_enable_hwecc(struct mtd_info *mtd, int mode) | |
85 | { | |
86 | uint32_t ccr; | |
4bd4ebcc | 87 | struct nand_chip *chip = mtd_to_nand(mtd); |
d699ed25 | 88 | struct ndfc_controller *ndfc = nand_get_controller_data(chip); |
ce4c61f1 | 89 | |
a808ad3b | 90 | ccr = in_be32(ndfc->ndfcbase + NDFC_CCR); |
ce4c61f1 | 91 | ccr |= NDFC_CCR_RESET_ECC; |
a808ad3b | 92 | out_be32(ndfc->ndfcbase + NDFC_CCR, ccr); |
ce4c61f1 TG |
93 | wmb(); |
94 | } | |
95 | ||
96 | static int ndfc_calculate_ecc(struct mtd_info *mtd, | |
97 | const u_char *dat, u_char *ecc_code) | |
98 | { | |
4bd4ebcc | 99 | struct nand_chip *chip = mtd_to_nand(mtd); |
d699ed25 | 100 | struct ndfc_controller *ndfc = nand_get_controller_data(chip); |
ce4c61f1 TG |
101 | uint32_t ecc; |
102 | uint8_t *p = (uint8_t *)&ecc; | |
103 | ||
104 | wmb(); | |
a808ad3b SM |
105 | ecc = in_be32(ndfc->ndfcbase + NDFC_ECC); |
106 | /* The NDFC uses Smart Media (SMC) bytes order */ | |
76c23c32 FK |
107 | ecc_code[0] = p[1]; |
108 | ecc_code[1] = p[2]; | |
ce4c61f1 TG |
109 | ecc_code[2] = p[3]; |
110 | ||
111 | return 0; | |
112 | } | |
113 | ||
114 | /* | |
115 | * Speedups for buffer read/write/verify | |
116 | * | |
117 | * NDFC allows 32bit read/write of data. So we can speed up the buffer | |
118 | * functions. No further checking, as nand_base will always read/write | |
119 | * page aligned. | |
120 | */ | |
121 | static void ndfc_read_buf(struct mtd_info *mtd, uint8_t *buf, int len) | |
122 | { | |
4bd4ebcc | 123 | struct nand_chip *chip = mtd_to_nand(mtd); |
d699ed25 | 124 | struct ndfc_controller *ndfc = nand_get_controller_data(chip); |
ce4c61f1 TG |
125 | uint32_t *p = (uint32_t *) buf; |
126 | ||
127 | for(;len > 0; len -= 4) | |
a808ad3b | 128 | *p++ = in_be32(ndfc->ndfcbase + NDFC_DATA); |
ce4c61f1 TG |
129 | } |
130 | ||
131 | static void ndfc_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len) | |
132 | { | |
4bd4ebcc | 133 | struct nand_chip *chip = mtd_to_nand(mtd); |
d699ed25 | 134 | struct ndfc_controller *ndfc = nand_get_controller_data(chip); |
ce4c61f1 TG |
135 | uint32_t *p = (uint32_t *) buf; |
136 | ||
137 | for(;len > 0; len -= 4) | |
a808ad3b | 138 | out_be32(ndfc->ndfcbase + NDFC_DATA, *p++); |
ce4c61f1 TG |
139 | } |
140 | ||
ce4c61f1 TG |
141 | /* |
142 | * Initialize chip structure | |
143 | */ | |
a808ad3b SM |
144 | static int ndfc_chip_init(struct ndfc_controller *ndfc, |
145 | struct device_node *node) | |
ce4c61f1 | 146 | { |
a808ad3b SM |
147 | struct device_node *flash_np; |
148 | struct nand_chip *chip = &ndfc->chip; | |
ca921b53 | 149 | struct mtd_info *mtd = nand_to_mtd(chip); |
a808ad3b | 150 | int ret; |
ce4c61f1 TG |
151 | |
152 | chip->IO_ADDR_R = ndfc->ndfcbase + NDFC_DATA; | |
153 | chip->IO_ADDR_W = ndfc->ndfcbase + NDFC_DATA; | |
7abd3ef9 | 154 | chip->cmd_ctrl = ndfc_hwcontrol; |
ce4c61f1 TG |
155 | chip->dev_ready = ndfc_ready; |
156 | chip->select_chip = ndfc_select_chip; | |
157 | chip->chip_delay = 50; | |
ce4c61f1 TG |
158 | chip->controller = &ndfc->ndfc_control; |
159 | chip->read_buf = ndfc_read_buf; | |
160 | chip->write_buf = ndfc_write_buf; | |
6dfc6d25 TG |
161 | chip->ecc.correct = nand_correct_data; |
162 | chip->ecc.hwctl = ndfc_enable_hwecc; | |
163 | chip->ecc.calculate = ndfc_calculate_ecc; | |
164 | chip->ecc.mode = NAND_ECC_HW; | |
165 | chip->ecc.size = 256; | |
166 | chip->ecc.bytes = 3; | |
6a918bad | 167 | chip->ecc.strength = 1; |
d699ed25 | 168 | nand_set_controller_data(chip, ndfc); |
ce4c61f1 | 169 | |
ca921b53 | 170 | mtd->dev.parent = &ndfc->ofdev->dev; |
ce4c61f1 | 171 | |
a808ad3b SM |
172 | flash_np = of_get_next_child(node, NULL); |
173 | if (!flash_np) | |
ce4c61f1 | 174 | return -ENODEV; |
a61ae81a | 175 | nand_set_flash_node(chip, flash_np); |
a808ad3b | 176 | |
ca921b53 BB |
177 | mtd->name = kasprintf(GFP_KERNEL, "%s.%s", dev_name(&ndfc->ofdev->dev), |
178 | flash_np->name); | |
179 | if (!mtd->name) { | |
a808ad3b SM |
180 | ret = -ENOMEM; |
181 | goto err; | |
ce4c61f1 TG |
182 | } |
183 | ||
ca921b53 | 184 | ret = nand_scan(mtd, 1); |
a808ad3b SM |
185 | if (ret) |
186 | goto err; | |
ce4c61f1 | 187 | |
ca921b53 | 188 | ret = mtd_device_register(mtd, NULL, 0); |
ce4c61f1 | 189 | |
a808ad3b SM |
190 | err: |
191 | of_node_put(flash_np); | |
192 | if (ret) | |
ca921b53 | 193 | kfree(mtd->name); |
a808ad3b | 194 | return ret; |
ce4c61f1 TG |
195 | } |
196 | ||
06f25510 | 197 | static int ndfc_probe(struct platform_device *ofdev) |
ce4c61f1 | 198 | { |
410fe2f0 | 199 | struct ndfc_controller *ndfc; |
766f271a | 200 | const __be32 *reg; |
a808ad3b | 201 | u32 ccr; |
5828c608 DC |
202 | u32 cs; |
203 | int err, len; | |
a808ad3b SM |
204 | |
205 | /* Read the reg property to get the chip select */ | |
61c7a080 | 206 | reg = of_get_property(ofdev->dev.of_node, "reg", &len); |
a808ad3b SM |
207 | if (reg == NULL || len != 12) { |
208 | dev_err(&ofdev->dev, "unable read reg property (%d)\n", len); | |
209 | return -ENOENT; | |
210 | } | |
410fe2f0 FR |
211 | |
212 | cs = be32_to_cpu(reg[0]); | |
213 | if (cs >= NDFC_MAX_CS) { | |
214 | dev_err(&ofdev->dev, "invalid CS number (%d)\n", cs); | |
215 | return -EINVAL; | |
216 | } | |
217 | ||
218 | ndfc = &ndfc_ctrl[cs]; | |
219 | ndfc->chip_select = cs; | |
220 | ||
221 | spin_lock_init(&ndfc->ndfc_control.lock); | |
222 | init_waitqueue_head(&ndfc->ndfc_control.wq); | |
223 | ndfc->ofdev = ofdev; | |
224 | dev_set_drvdata(&ofdev->dev, ndfc); | |
a808ad3b | 225 | |
61c7a080 | 226 | ndfc->ndfcbase = of_iomap(ofdev->dev.of_node, 0); |
ce4c61f1 | 227 | if (!ndfc->ndfcbase) { |
a808ad3b | 228 | dev_err(&ofdev->dev, "failed to get memory\n"); |
ce4c61f1 TG |
229 | return -EIO; |
230 | } | |
231 | ||
a808ad3b | 232 | ccr = NDFC_CCR_BS(ndfc->chip_select); |
ce4c61f1 | 233 | |
a808ad3b | 234 | /* It is ok if ccr does not exist - just default to 0 */ |
61c7a080 | 235 | reg = of_get_property(ofdev->dev.of_node, "ccr", NULL); |
a808ad3b | 236 | if (reg) |
766f271a | 237 | ccr |= be32_to_cpup(reg); |
ce4c61f1 | 238 | |
a808ad3b | 239 | out_be32(ndfc->ndfcbase + NDFC_CCR, ccr); |
ce4c61f1 | 240 | |
a808ad3b | 241 | /* Set the bank settings if given */ |
61c7a080 | 242 | reg = of_get_property(ofdev->dev.of_node, "bank-settings", NULL); |
a808ad3b SM |
243 | if (reg) { |
244 | int offset = NDFC_BCFG0 + (ndfc->chip_select << 2); | |
766f271a | 245 | out_be32(ndfc->ndfcbase + offset, be32_to_cpup(reg)); |
a808ad3b SM |
246 | } |
247 | ||
61c7a080 | 248 | err = ndfc_chip_init(ndfc, ofdev->dev.of_node); |
a808ad3b SM |
249 | if (err) { |
250 | iounmap(ndfc->ndfcbase); | |
251 | return err; | |
252 | } | |
ce4c61f1 TG |
253 | |
254 | return 0; | |
255 | } | |
256 | ||
810b7e06 | 257 | static int ndfc_remove(struct platform_device *ofdev) |
ce4c61f1 | 258 | { |
a808ad3b | 259 | struct ndfc_controller *ndfc = dev_get_drvdata(&ofdev->dev); |
ca921b53 | 260 | struct mtd_info *mtd = nand_to_mtd(&ndfc->chip); |
ce4c61f1 | 261 | |
ca921b53 BB |
262 | nand_release(mtd); |
263 | kfree(mtd->name); | |
ce4c61f1 | 264 | |
ce4c61f1 TG |
265 | return 0; |
266 | } | |
267 | ||
a808ad3b SM |
268 | static const struct of_device_id ndfc_match[] = { |
269 | { .compatible = "ibm,ndfc", }, | |
270 | {} | |
ce4c61f1 | 271 | }; |
a808ad3b | 272 | MODULE_DEVICE_TABLE(of, ndfc_match); |
ce4c61f1 | 273 | |
1c48a5c9 | 274 | static struct platform_driver ndfc_driver = { |
a808ad3b | 275 | .driver = { |
4018294b | 276 | .name = "ndfc", |
4018294b | 277 | .of_match_table = ndfc_match, |
ce4c61f1 | 278 | }, |
a808ad3b | 279 | .probe = ndfc_probe, |
5153b88c | 280 | .remove = ndfc_remove, |
ce4c61f1 TG |
281 | }; |
282 | ||
f99640de | 283 | module_platform_driver(ndfc_driver); |
ce4c61f1 TG |
284 | |
285 | MODULE_LICENSE("GPL"); | |
286 | MODULE_AUTHOR("Thomas Gleixner <tglx@linutronix.de>"); | |
a808ad3b | 287 | MODULE_DESCRIPTION("OF Platform driver for NDFC"); |