Commit | Line | Data |
---|---|---|
5c249c5a AV |
1 | /* |
2 | * Freescale UPM NAND driver. | |
3 | * | |
4 | * Copyright © 2007-2008 MontaVista Software, Inc. | |
5 | * | |
6 | * Author: Anton Vorontsov <avorontsov@ru.mvista.com> | |
7 | * | |
8 | * This program is free software; you can redistribute it and/or modify | |
9 | * it under the terms of the GNU General Public License as published by | |
10 | * the Free Software Foundation; either version 2 of the License, or | |
11 | * (at your option) any later version. | |
12 | */ | |
13 | ||
14 | #include <linux/kernel.h> | |
15 | #include <linux/module.h> | |
13f53697 | 16 | #include <linux/delay.h> |
5c249c5a AV |
17 | #include <linux/mtd/nand.h> |
18 | #include <linux/mtd/nand_ecc.h> | |
19 | #include <linux/mtd/partitions.h> | |
20 | #include <linux/mtd/mtd.h> | |
5af50730 | 21 | #include <linux/of_address.h> |
5c249c5a AV |
22 | #include <linux/of_platform.h> |
23 | #include <linux/of_gpio.h> | |
24 | #include <linux/io.h> | |
5a0e3ad6 | 25 | #include <linux/slab.h> |
5c249c5a AV |
26 | #include <asm/fsl_lbc.h> |
27 | ||
ade92a63 WG |
28 | #define FSL_UPM_WAIT_RUN_PATTERN 0x1 |
29 | #define FSL_UPM_WAIT_WRITE_BYTE 0x2 | |
30 | #define FSL_UPM_WAIT_WRITE_BUFFER 0x4 | |
31 | ||
5c249c5a AV |
32 | struct fsl_upm_nand { |
33 | struct device *dev; | |
34 | struct mtd_info mtd; | |
35 | struct nand_chip chip; | |
36 | int last_ctrl; | |
5c249c5a | 37 | struct mtd_partition *parts; |
5c249c5a AV |
38 | struct fsl_upm upm; |
39 | uint8_t upm_addr_offset; | |
40 | uint8_t upm_cmd_offset; | |
41 | void __iomem *io_base; | |
b6e0e8c0 WG |
42 | int rnb_gpio[NAND_MAX_CHIPS]; |
43 | uint32_t mchip_offsets[NAND_MAX_CHIPS]; | |
44 | uint32_t mchip_count; | |
45 | uint32_t mchip_number; | |
13f53697 | 46 | int chip_delay; |
ade92a63 | 47 | uint32_t wait_flags; |
5c249c5a AV |
48 | }; |
49 | ||
b92b5c41 FW |
50 | static inline struct fsl_upm_nand *to_fsl_upm_nand(struct mtd_info *mtdinfo) |
51 | { | |
52 | return container_of(mtdinfo, struct fsl_upm_nand, mtd); | |
53 | } | |
5c249c5a AV |
54 | |
55 | static int fun_chip_ready(struct mtd_info *mtd) | |
56 | { | |
57 | struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd); | |
58 | ||
b6e0e8c0 | 59 | if (gpio_get_value(fun->rnb_gpio[fun->mchip_number])) |
5c249c5a AV |
60 | return 1; |
61 | ||
62 | dev_vdbg(fun->dev, "busy\n"); | |
63 | return 0; | |
64 | } | |
65 | ||
66 | static void fun_wait_rnb(struct fsl_upm_nand *fun) | |
67 | { | |
b6e0e8c0 WG |
68 | if (fun->rnb_gpio[fun->mchip_number] >= 0) { |
69 | int cnt = 1000000; | |
5c249c5a | 70 | |
5c249c5a AV |
71 | while (--cnt && !fun_chip_ready(&fun->mtd)) |
72 | cpu_relax(); | |
13f53697 WG |
73 | if (!cnt) |
74 | dev_err(fun->dev, "tired waiting for RNB\n"); | |
75 | } else { | |
76 | ndelay(100); | |
5c249c5a | 77 | } |
5c249c5a AV |
78 | } |
79 | ||
80 | static void fun_cmd_ctrl(struct mtd_info *mtd, int cmd, unsigned int ctrl) | |
81 | { | |
b6e0e8c0 | 82 | struct nand_chip *chip = mtd->priv; |
5c249c5a | 83 | struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd); |
b6e0e8c0 | 84 | u32 mar; |
5c249c5a AV |
85 | |
86 | if (!(ctrl & fun->last_ctrl)) { | |
87 | fsl_upm_end_pattern(&fun->upm); | |
88 | ||
89 | if (cmd == NAND_CMD_NONE) | |
90 | return; | |
91 | ||
92 | fun->last_ctrl = ctrl & (NAND_ALE | NAND_CLE); | |
93 | } | |
94 | ||
95 | if (ctrl & NAND_CTRL_CHANGE) { | |
96 | if (ctrl & NAND_ALE) | |
97 | fsl_upm_start_pattern(&fun->upm, fun->upm_addr_offset); | |
98 | else if (ctrl & NAND_CLE) | |
99 | fsl_upm_start_pattern(&fun->upm, fun->upm_cmd_offset); | |
100 | } | |
101 | ||
b6e0e8c0 WG |
102 | mar = (cmd << (32 - fun->upm.width)) | |
103 | fun->mchip_offsets[fun->mchip_number]; | |
104 | fsl_upm_run_pattern(&fun->upm, chip->IO_ADDR_R, mar); | |
5c249c5a | 105 | |
ade92a63 WG |
106 | if (fun->wait_flags & FSL_UPM_WAIT_RUN_PATTERN) |
107 | fun_wait_rnb(fun); | |
5c249c5a AV |
108 | } |
109 | ||
b6e0e8c0 WG |
110 | static void fun_select_chip(struct mtd_info *mtd, int mchip_nr) |
111 | { | |
112 | struct nand_chip *chip = mtd->priv; | |
113 | struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd); | |
114 | ||
115 | if (mchip_nr == -1) { | |
116 | chip->cmd_ctrl(mtd, NAND_CMD_NONE, 0 | NAND_CTRL_CHANGE); | |
35016dd7 | 117 | } else if (mchip_nr >= 0 && mchip_nr < NAND_MAX_CHIPS) { |
b6e0e8c0 WG |
118 | fun->mchip_number = mchip_nr; |
119 | chip->IO_ADDR_R = fun->io_base + fun->mchip_offsets[mchip_nr]; | |
120 | chip->IO_ADDR_W = chip->IO_ADDR_R; | |
121 | } else { | |
122 | BUG(); | |
123 | } | |
124 | } | |
125 | ||
5c249c5a AV |
126 | static uint8_t fun_read_byte(struct mtd_info *mtd) |
127 | { | |
128 | struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd); | |
129 | ||
130 | return in_8(fun->chip.IO_ADDR_R); | |
131 | } | |
132 | ||
133 | static void fun_read_buf(struct mtd_info *mtd, uint8_t *buf, int len) | |
134 | { | |
135 | struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd); | |
136 | int i; | |
137 | ||
138 | for (i = 0; i < len; i++) | |
139 | buf[i] = in_8(fun->chip.IO_ADDR_R); | |
140 | } | |
141 | ||
142 | static void fun_write_buf(struct mtd_info *mtd, const uint8_t *buf, int len) | |
143 | { | |
144 | struct fsl_upm_nand *fun = to_fsl_upm_nand(mtd); | |
145 | int i; | |
146 | ||
147 | for (i = 0; i < len; i++) { | |
148 | out_8(fun->chip.IO_ADDR_W, buf[i]); | |
ade92a63 WG |
149 | if (fun->wait_flags & FSL_UPM_WAIT_WRITE_BYTE) |
150 | fun_wait_rnb(fun); | |
5c249c5a | 151 | } |
ade92a63 WG |
152 | if (fun->wait_flags & FSL_UPM_WAIT_WRITE_BUFFER) |
153 | fun_wait_rnb(fun); | |
5c249c5a AV |
154 | } |
155 | ||
06f25510 | 156 | static int fun_chip_init(struct fsl_upm_nand *fun, |
d8929942 GKH |
157 | const struct device_node *upm_np, |
158 | const struct resource *io_res) | |
5c249c5a AV |
159 | { |
160 | int ret; | |
95ebffd7 | 161 | struct device_node *flash_np; |
5c249c5a AV |
162 | |
163 | fun->chip.IO_ADDR_R = fun->io_base; | |
164 | fun->chip.IO_ADDR_W = fun->io_base; | |
165 | fun->chip.cmd_ctrl = fun_cmd_ctrl; | |
13f53697 | 166 | fun->chip.chip_delay = fun->chip_delay; |
5c249c5a AV |
167 | fun->chip.read_byte = fun_read_byte; |
168 | fun->chip.read_buf = fun_read_buf; | |
169 | fun->chip.write_buf = fun_write_buf; | |
170 | fun->chip.ecc.mode = NAND_ECC_SOFT; | |
b6e0e8c0 WG |
171 | if (fun->mchip_count > 1) |
172 | fun->chip.select_chip = fun_select_chip; | |
5c249c5a | 173 | |
b6e0e8c0 | 174 | if (fun->rnb_gpio[0] >= 0) |
5c249c5a AV |
175 | fun->chip.dev_ready = fun_chip_ready; |
176 | ||
177 | fun->mtd.priv = &fun->chip; | |
50c65c8f | 178 | fun->mtd.dev.parent = fun->dev; |
5c249c5a | 179 | |
95ebffd7 AV |
180 | flash_np = of_get_next_child(upm_np, NULL); |
181 | if (!flash_np) | |
182 | return -ENODEV; | |
183 | ||
a61ae81a | 184 | nand_set_flash_node(&fun->chip, flash_np); |
0eecf4b2 | 185 | fun->mtd.name = kasprintf(GFP_KERNEL, "0x%llx.%s", (u64)io_res->start, |
95ebffd7 AV |
186 | flash_np->name); |
187 | if (!fun->mtd.name) { | |
188 | ret = -ENOMEM; | |
189 | goto err; | |
190 | } | |
191 | ||
b6e0e8c0 | 192 | ret = nand_scan(&fun->mtd, fun->mchip_count); |
5c249c5a | 193 | if (ret) |
95ebffd7 | 194 | goto err; |
5c249c5a | 195 | |
a61ae81a | 196 | ret = mtd_device_register(&fun->mtd, NULL, 0); |
95ebffd7 AV |
197 | err: |
198 | of_node_put(flash_np); | |
a751d315 AL |
199 | if (ret) |
200 | kfree(fun->mtd.name); | |
95ebffd7 | 201 | return ret; |
5c249c5a AV |
202 | } |
203 | ||
06f25510 | 204 | static int fun_probe(struct platform_device *ofdev) |
5c249c5a AV |
205 | { |
206 | struct fsl_upm_nand *fun; | |
207 | struct resource io_res; | |
766f271a | 208 | const __be32 *prop; |
b6e0e8c0 | 209 | int rnb_gpio; |
5c249c5a AV |
210 | int ret; |
211 | int size; | |
b6e0e8c0 | 212 | int i; |
5c249c5a AV |
213 | |
214 | fun = kzalloc(sizeof(*fun), GFP_KERNEL); | |
215 | if (!fun) | |
216 | return -ENOMEM; | |
217 | ||
c8a4d0fd | 218 | ret = of_address_to_resource(ofdev->dev.of_node, 0, &io_res); |
5c249c5a AV |
219 | if (ret) { |
220 | dev_err(&ofdev->dev, "can't get IO base\n"); | |
221 | goto err1; | |
222 | } | |
223 | ||
224 | ret = fsl_upm_find(io_res.start, &fun->upm); | |
225 | if (ret) { | |
226 | dev_err(&ofdev->dev, "can't find UPM\n"); | |
227 | goto err1; | |
228 | } | |
229 | ||
c8a4d0fd AG |
230 | prop = of_get_property(ofdev->dev.of_node, "fsl,upm-addr-offset", |
231 | &size); | |
5c249c5a AV |
232 | if (!prop || size != sizeof(uint32_t)) { |
233 | dev_err(&ofdev->dev, "can't get UPM address offset\n"); | |
234 | ret = -EINVAL; | |
b6e0e8c0 | 235 | goto err1; |
5c249c5a AV |
236 | } |
237 | fun->upm_addr_offset = *prop; | |
238 | ||
c8a4d0fd | 239 | prop = of_get_property(ofdev->dev.of_node, "fsl,upm-cmd-offset", &size); |
5c249c5a AV |
240 | if (!prop || size != sizeof(uint32_t)) { |
241 | dev_err(&ofdev->dev, "can't get UPM command offset\n"); | |
242 | ret = -EINVAL; | |
b6e0e8c0 | 243 | goto err1; |
5c249c5a AV |
244 | } |
245 | fun->upm_cmd_offset = *prop; | |
246 | ||
c8a4d0fd | 247 | prop = of_get_property(ofdev->dev.of_node, |
b6e0e8c0 WG |
248 | "fsl,upm-addr-line-cs-offsets", &size); |
249 | if (prop && (size / sizeof(uint32_t)) > 0) { | |
250 | fun->mchip_count = size / sizeof(uint32_t); | |
251 | if (fun->mchip_count >= NAND_MAX_CHIPS) { | |
252 | dev_err(&ofdev->dev, "too much multiple chips\n"); | |
253 | goto err1; | |
254 | } | |
255 | for (i = 0; i < fun->mchip_count; i++) | |
766f271a | 256 | fun->mchip_offsets[i] = be32_to_cpu(prop[i]); |
b6e0e8c0 WG |
257 | } else { |
258 | fun->mchip_count = 1; | |
259 | } | |
260 | ||
261 | for (i = 0; i < fun->mchip_count; i++) { | |
262 | fun->rnb_gpio[i] = -1; | |
c8a4d0fd | 263 | rnb_gpio = of_get_gpio(ofdev->dev.of_node, i); |
b6e0e8c0 WG |
264 | if (rnb_gpio >= 0) { |
265 | ret = gpio_request(rnb_gpio, dev_name(&ofdev->dev)); | |
266 | if (ret) { | |
267 | dev_err(&ofdev->dev, | |
268 | "can't request RNB gpio #%d\n", i); | |
269 | goto err2; | |
270 | } | |
271 | gpio_direction_input(rnb_gpio); | |
272 | fun->rnb_gpio[i] = rnb_gpio; | |
273 | } else if (rnb_gpio == -EINVAL) { | |
274 | dev_err(&ofdev->dev, "RNB gpio #%d is invalid\n", i); | |
5c249c5a AV |
275 | goto err2; |
276 | } | |
5c249c5a AV |
277 | } |
278 | ||
c8a4d0fd | 279 | prop = of_get_property(ofdev->dev.of_node, "chip-delay", NULL); |
13f53697 | 280 | if (prop) |
766f271a | 281 | fun->chip_delay = be32_to_cpup(prop); |
13f53697 WG |
282 | else |
283 | fun->chip_delay = 50; | |
284 | ||
c8a4d0fd | 285 | prop = of_get_property(ofdev->dev.of_node, "fsl,upm-wait-flags", &size); |
ade92a63 | 286 | if (prop && size == sizeof(uint32_t)) |
766f271a | 287 | fun->wait_flags = be32_to_cpup(prop); |
ade92a63 WG |
288 | else |
289 | fun->wait_flags = FSL_UPM_WAIT_RUN_PATTERN | | |
290 | FSL_UPM_WAIT_WRITE_BYTE; | |
291 | ||
5c249c5a | 292 | fun->io_base = devm_ioremap_nocache(&ofdev->dev, io_res.start, |
58e6a84d | 293 | resource_size(&io_res)); |
5c249c5a AV |
294 | if (!fun->io_base) { |
295 | ret = -ENOMEM; | |
296 | goto err2; | |
297 | } | |
298 | ||
299 | fun->dev = &ofdev->dev; | |
300 | fun->last_ctrl = NAND_CLE; | |
5c249c5a | 301 | |
c8a4d0fd | 302 | ret = fun_chip_init(fun, ofdev->dev.of_node, &io_res); |
5c249c5a AV |
303 | if (ret) |
304 | goto err2; | |
305 | ||
306 | dev_set_drvdata(&ofdev->dev, fun); | |
307 | ||
308 | return 0; | |
309 | err2: | |
b6e0e8c0 WG |
310 | for (i = 0; i < fun->mchip_count; i++) { |
311 | if (fun->rnb_gpio[i] < 0) | |
312 | break; | |
313 | gpio_free(fun->rnb_gpio[i]); | |
314 | } | |
5c249c5a AV |
315 | err1: |
316 | kfree(fun); | |
317 | ||
318 | return ret; | |
319 | } | |
320 | ||
810b7e06 | 321 | static int fun_remove(struct platform_device *ofdev) |
5c249c5a AV |
322 | { |
323 | struct fsl_upm_nand *fun = dev_get_drvdata(&ofdev->dev); | |
b6e0e8c0 | 324 | int i; |
5c249c5a AV |
325 | |
326 | nand_release(&fun->mtd); | |
95ebffd7 | 327 | kfree(fun->mtd.name); |
5c249c5a | 328 | |
b6e0e8c0 WG |
329 | for (i = 0; i < fun->mchip_count; i++) { |
330 | if (fun->rnb_gpio[i] < 0) | |
331 | break; | |
332 | gpio_free(fun->rnb_gpio[i]); | |
333 | } | |
5c249c5a AV |
334 | |
335 | kfree(fun); | |
336 | ||
337 | return 0; | |
338 | } | |
339 | ||
b2d4fbab | 340 | static const struct of_device_id of_fun_match[] = { |
5c249c5a AV |
341 | { .compatible = "fsl,upm-nand" }, |
342 | {}, | |
343 | }; | |
344 | MODULE_DEVICE_TABLE(of, of_fun_match); | |
345 | ||
1c48a5c9 | 346 | static struct platform_driver of_fun_driver = { |
4018294b GL |
347 | .driver = { |
348 | .name = "fsl,upm-nand", | |
4018294b GL |
349 | .of_match_table = of_fun_match, |
350 | }, | |
5c249c5a | 351 | .probe = fun_probe, |
5153b88c | 352 | .remove = fun_remove, |
5c249c5a AV |
353 | }; |
354 | ||
f99640de | 355 | module_platform_driver(of_fun_driver); |
5c249c5a AV |
356 | |
357 | MODULE_LICENSE("GPL"); | |
358 | MODULE_AUTHOR("Anton Vorontsov <avorontsov@ru.mvista.com>"); | |
359 | MODULE_DESCRIPTION("Driver for NAND chips working through Freescale " | |
360 | "LocalBus User-Programmable Machine"); |