Commit | Line | Data |
---|---|---|
a2c2fe4b | 1 | /* |
c4d5e375 | 2 | * Flash mappings described by the OF (or flattened) device tree |
a2c2fe4b VW |
3 | * |
4 | * Copyright (C) 2006 MontaVista Software Inc. | |
5 | * Author: Vitaly Wool <vwool@ru.mvista.com> | |
6 | * | |
2099172d DG |
7 | * Revised to handle newer style flash binding by: |
8 | * Copyright (C) 2007 David Gibson, IBM Corporation. | |
9 | * | |
a2c2fe4b VW |
10 | * This program is free software; you can redistribute it and/or modify it |
11 | * under the terms of the GNU General Public License as published by the | |
12 | * Free Software Foundation; either version 2 of the License, or (at your | |
13 | * option) any later version. | |
14 | */ | |
15 | ||
16 | #include <linux/module.h> | |
17 | #include <linux/types.h> | |
a2c2fe4b | 18 | #include <linux/init.h> |
a2c2fe4b VW |
19 | #include <linux/device.h> |
20 | #include <linux/mtd/mtd.h> | |
21 | #include <linux/mtd/map.h> | |
22 | #include <linux/mtd/partitions.h> | |
143070e7 | 23 | #include <linux/mtd/concat.h> |
c4d5e375 | 24 | #include <linux/of.h> |
7a50d06e | 25 | #include <linux/of_address.h> |
c4d5e375 | 26 | #include <linux/of_platform.h> |
5a0e3ad6 | 27 | #include <linux/slab.h> |
a2c2fe4b | 28 | |
143070e7 SR |
29 | struct of_flash_list { |
30 | struct mtd_info *mtd; | |
31 | struct map_info map; | |
32 | struct resource *res; | |
33 | }; | |
34 | ||
c4d5e375 | 35 | struct of_flash { |
143070e7 | 36 | struct mtd_info *cmtd; |
143070e7 SR |
37 | int list_size; /* number of elements in of_flash_list */ |
38 | struct of_flash_list list[0]; | |
a2c2fe4b VW |
39 | }; |
40 | ||
2dc11581 | 41 | static int of_flash_remove(struct platform_device *dev) |
a2c2fe4b | 42 | { |
c4d5e375 | 43 | struct of_flash *info; |
143070e7 | 44 | int i; |
a2c2fe4b VW |
45 | |
46 | info = dev_get_drvdata(&dev->dev); | |
c4d5e375 | 47 | if (!info) |
a2c2fe4b VW |
48 | return 0; |
49 | dev_set_drvdata(&dev->dev, NULL); | |
50 | ||
143070e7 | 51 | if (info->cmtd != info->list[0].mtd) { |
984e6d8e | 52 | mtd_device_unregister(info->cmtd); |
143070e7 SR |
53 | mtd_concat_destroy(info->cmtd); |
54 | } | |
143070e7 | 55 | |
f44dcbd0 | 56 | if (info->cmtd) |
984e6d8e | 57 | mtd_device_unregister(info->cmtd); |
a2c2fe4b | 58 | |
143070e7 SR |
59 | for (i = 0; i < info->list_size; i++) { |
60 | if (info->list[i].mtd) | |
61 | map_destroy(info->list[i].mtd); | |
a2c2fe4b | 62 | |
143070e7 SR |
63 | if (info->list[i].map.virt) |
64 | iounmap(info->list[i].map.virt); | |
65 | ||
66 | if (info->list[i].res) { | |
67 | release_resource(info->list[i].res); | |
68 | kfree(info->list[i].res); | |
69 | } | |
a2c2fe4b | 70 | } |
a2c2fe4b VW |
71 | return 0; |
72 | } | |
73 | ||
cce2a026 AB |
74 | static const char * const rom_probe_types[] = { |
75 | "cfi_probe", "jedec_probe", "map_rom" }; | |
76 | ||
2099172d DG |
77 | /* Helper function to handle probing of the obsolete "direct-mapped" |
78 | * compatible binding, which has an extra "probe-type" property | |
79 | * describing the type of flash probe necessary. */ | |
06f25510 | 80 | static struct mtd_info *obsolete_probe(struct platform_device *dev, |
d8929942 | 81 | struct map_info *map) |
a2c2fe4b | 82 | { |
61c7a080 | 83 | struct device_node *dp = dev->dev.of_node; |
a2c2fe4b | 84 | const char *of_probe; |
2099172d | 85 | struct mtd_info *mtd; |
2099172d DG |
86 | int i; |
87 | ||
88 | dev_warn(&dev->dev, "Device tree uses obsolete \"direct-mapped\" " | |
89 | "flash binding\n"); | |
90 | ||
91 | of_probe = of_get_property(dp, "probe-type", NULL); | |
92 | if (!of_probe) { | |
93 | for (i = 0; i < ARRAY_SIZE(rom_probe_types); i++) { | |
94 | mtd = do_map_probe(rom_probe_types[i], map); | |
95 | if (mtd) | |
96 | return mtd; | |
97 | } | |
98 | return NULL; | |
99 | } else if (strcmp(of_probe, "CFI") == 0) { | |
100 | return do_map_probe("cfi_probe", map); | |
101 | } else if (strcmp(of_probe, "JEDEC") == 0) { | |
102 | return do_map_probe("jedec_probe", map); | |
103 | } else { | |
104 | if (strcmp(of_probe, "ROM") != 0) | |
c4d5e375 DG |
105 | dev_warn(&dev->dev, "obsolete_probe: don't know probe " |
106 | "type '%s', mapping as rom\n", of_probe); | |
2099172d DG |
107 | return do_map_probe("mtd_rom", map); |
108 | } | |
109 | } | |
110 | ||
9d5da3a9 JG |
111 | /* When partitions are set we look for a linux,part-probe property which |
112 | specifies the list of partition probers to use. If none is given then the | |
113 | default is use. These take precedence over other device tree | |
114 | information. */ | |
cce2a026 AB |
115 | static const char * const part_probe_types_def[] = { |
116 | "cmdlinepart", "RedBoot", "ofpart", "ofoldpart", NULL }; | |
117 | ||
118 | static const char * const *of_get_probes(struct device_node *dp) | |
9d5da3a9 JG |
119 | { |
120 | const char *cp; | |
121 | int cplen; | |
122 | unsigned int l; | |
123 | unsigned int count; | |
124 | const char **res; | |
125 | ||
126 | cp = of_get_property(dp, "linux,part-probe", &cplen); | |
127 | if (cp == NULL) | |
128 | return part_probe_types_def; | |
129 | ||
130 | count = 0; | |
131 | for (l = 0; l != cplen; l++) | |
132 | if (cp[l] == 0) | |
133 | count++; | |
134 | ||
135 | res = kzalloc((count + 1)*sizeof(*res), GFP_KERNEL); | |
136 | count = 0; | |
137 | while (cplen > 0) { | |
138 | res[count] = cp; | |
139 | l = strlen(cp) + 1; | |
140 | cp += l; | |
141 | cplen -= l; | |
142 | count++; | |
143 | } | |
144 | return res; | |
145 | } | |
146 | ||
cce2a026 | 147 | static void of_free_probes(const char * const *probes) |
9d5da3a9 JG |
148 | { |
149 | if (probes != part_probe_types_def) | |
150 | kfree(probes); | |
151 | } | |
9d5da3a9 | 152 | |
b1608d69 | 153 | static struct of_device_id of_flash_match[]; |
06f25510 | 154 | static int of_flash_probe(struct platform_device *dev) |
a2c2fe4b | 155 | { |
cce2a026 | 156 | const char * const *part_probe_types; |
b1608d69 | 157 | const struct of_device_id *match; |
61c7a080 | 158 | struct device_node *dp = dev->dev.of_node; |
a2c2fe4b | 159 | struct resource res; |
c4d5e375 | 160 | struct of_flash *info; |
1c48a5c9 | 161 | const char *probe_type; |
766f271a | 162 | const __be32 *width; |
a2c2fe4b | 163 | int err; |
143070e7 SR |
164 | int i; |
165 | int count; | |
766f271a | 166 | const __be32 *p; |
143070e7 SR |
167 | int reg_tuple_size; |
168 | struct mtd_info **mtd_list = NULL; | |
2763c508 | 169 | resource_size_t res_size; |
5f4ba9f9 | 170 | struct mtd_part_parser_data ppdata; |
d0788ce4 | 171 | bool map_indirect; |
7dfe4be3 | 172 | const char *mtd_name = NULL; |
143070e7 | 173 | |
b1608d69 GL |
174 | match = of_match_device(of_flash_match, &dev->dev); |
175 | if (!match) | |
1c48a5c9 | 176 | return -EINVAL; |
b1608d69 | 177 | probe_type = match->data; |
1c48a5c9 | 178 | |
143070e7 SR |
179 | reg_tuple_size = (of_n_addr_cells(dp) + of_n_size_cells(dp)) * sizeof(u32); |
180 | ||
d68cbdd4 JCPV |
181 | of_property_read_string(dp, "linux,mtd-name", &mtd_name); |
182 | ||
143070e7 SR |
183 | /* |
184 | * Get number of "reg" tuples. Scan for MTD devices on area's | |
185 | * described by each "reg" region. This makes it possible (including | |
186 | * the concat support) to support the Intel P30 48F4400 chips which | |
187 | * consists internally of 2 non-identical NOR chips on one die. | |
188 | */ | |
189 | p = of_get_property(dp, "reg", &count); | |
190 | if (count % reg_tuple_size != 0) { | |
191 | dev_err(&dev->dev, "Malformed reg property on %s\n", | |
61c7a080 | 192 | dev->dev.of_node->full_name); |
143070e7 | 193 | err = -EINVAL; |
ad4fbc79 | 194 | goto err_flash_remove; |
a2c2fe4b | 195 | } |
143070e7 | 196 | count /= reg_tuple_size; |
a2c2fe4b | 197 | |
d0788ce4 SR |
198 | map_indirect = of_property_read_bool(dp, "no-unaligned-direct-access"); |
199 | ||
c4d5e375 | 200 | err = -ENOMEM; |
eb82038f EG |
201 | info = devm_kzalloc(&dev->dev, |
202 | sizeof(struct of_flash) + | |
203 | sizeof(struct of_flash_list) * count, GFP_KERNEL); | |
143070e7 | 204 | if (!info) |
ad4fbc79 | 205 | goto err_flash_remove; |
a2c2fe4b VW |
206 | |
207 | dev_set_drvdata(&dev->dev, info); | |
208 | ||
e026255f | 209 | mtd_list = kzalloc(sizeof(*mtd_list) * count, GFP_KERNEL); |
ad4fbc79 | 210 | if (!mtd_list) |
211 | goto err_flash_remove; | |
212 | ||
143070e7 SR |
213 | for (i = 0; i < count; i++) { |
214 | err = -ENXIO; | |
215 | if (of_address_to_resource(dp, i, &res)) { | |
940fe282 SR |
216 | /* |
217 | * Continue with next register tuple if this | |
218 | * one is not mappable | |
219 | */ | |
220 | continue; | |
143070e7 | 221 | } |
a2c2fe4b | 222 | |
f9a5279c | 223 | dev_dbg(&dev->dev, "of_flash device: %pR\n", &res); |
143070e7 SR |
224 | |
225 | err = -EBUSY; | |
2763c508 WS |
226 | res_size = resource_size(&res); |
227 | info->list[i].res = request_mem_region(res.start, res_size, | |
143070e7 SR |
228 | dev_name(&dev->dev)); |
229 | if (!info->list[i].res) | |
230 | goto err_out; | |
231 | ||
232 | err = -ENXIO; | |
233 | width = of_get_property(dp, "bank-width", NULL); | |
234 | if (!width) { | |
235 | dev_err(&dev->dev, "Can't get bank width from device" | |
236 | " tree\n"); | |
237 | goto err_out; | |
238 | } | |
a2c2fe4b | 239 | |
d68cbdd4 | 240 | info->list[i].map.name = mtd_name ?: dev_name(&dev->dev); |
143070e7 | 241 | info->list[i].map.phys = res.start; |
2763c508 | 242 | info->list[i].map.size = res_size; |
766f271a | 243 | info->list[i].map.bankwidth = be32_to_cpup(width); |
1648eaaa | 244 | info->list[i].map.device_node = dp; |
143070e7 SR |
245 | |
246 | err = -ENOMEM; | |
247 | info->list[i].map.virt = ioremap(info->list[i].map.phys, | |
248 | info->list[i].map.size); | |
249 | if (!info->list[i].map.virt) { | |
250 | dev_err(&dev->dev, "Failed to ioremap() flash" | |
251 | " region\n"); | |
252 | goto err_out; | |
253 | } | |
a2c2fe4b | 254 | |
143070e7 | 255 | simple_map_init(&info->list[i].map); |
a2c2fe4b | 256 | |
d0788ce4 SR |
257 | /* |
258 | * On some platforms (e.g. MPC5200) a direct 1:1 mapping | |
259 | * may cause problems with JFFS2 usage, as the local bus (LPB) | |
260 | * doesn't support unaligned accesses as implemented in the | |
261 | * JFFS2 code via memcpy(). By setting NO_XIP, the | |
262 | * flash will not be exposed directly to the MTD users | |
263 | * (e.g. JFFS2) any more. | |
264 | */ | |
265 | if (map_indirect) | |
266 | info->list[i].map.phys = NO_XIP; | |
267 | ||
143070e7 SR |
268 | if (probe_type) { |
269 | info->list[i].mtd = do_map_probe(probe_type, | |
270 | &info->list[i].map); | |
271 | } else { | |
272 | info->list[i].mtd = obsolete_probe(dev, | |
273 | &info->list[i].map); | |
274 | } | |
275 | mtd_list[i] = info->list[i].mtd; | |
a2c2fe4b | 276 | |
143070e7 SR |
277 | err = -ENXIO; |
278 | if (!info->list[i].mtd) { | |
279 | dev_err(&dev->dev, "do_map_probe() failed\n"); | |
280 | goto err_out; | |
281 | } else { | |
282 | info->list_size++; | |
283 | } | |
284 | info->list[i].mtd->owner = THIS_MODULE; | |
285 | info->list[i].mtd->dev.parent = &dev->dev; | |
286 | } | |
2099172d | 287 | |
143070e7 | 288 | err = 0; |
e58a66d8 | 289 | info->cmtd = NULL; |
143070e7 SR |
290 | if (info->list_size == 1) { |
291 | info->cmtd = info->list[0].mtd; | |
292 | } else if (info->list_size > 1) { | |
293 | /* | |
294 | * We detected multiple devices. Concatenate them together. | |
295 | */ | |
143070e7 SR |
296 | info->cmtd = mtd_concat_create(mtd_list, info->list_size, |
297 | dev_name(&dev->dev)); | |
a2c2fe4b | 298 | } |
e58a66d8 AP |
299 | if (info->cmtd == NULL) |
300 | err = -ENXIO; | |
301 | ||
143070e7 SR |
302 | if (err) |
303 | goto err_out; | |
a2c2fe4b | 304 | |
5f4ba9f9 | 305 | ppdata.of_node = dp; |
9d5da3a9 | 306 | part_probe_types = of_get_probes(dp); |
f44dcbd0 DES |
307 | mtd_device_parse_register(info->cmtd, part_probe_types, &ppdata, |
308 | NULL, 0); | |
9d5da3a9 | 309 | of_free_probes(part_probe_types); |
9a310d21 | 310 | |
143070e7 | 311 | kfree(mtd_list); |
a2c2fe4b | 312 | |
a2c2fe4b VW |
313 | return 0; |
314 | ||
315 | err_out: | |
143070e7 | 316 | kfree(mtd_list); |
ad4fbc79 | 317 | err_flash_remove: |
c4d5e375 | 318 | of_flash_remove(dev); |
143070e7 | 319 | |
a2c2fe4b | 320 | return err; |
a2c2fe4b VW |
321 | } |
322 | ||
c4d5e375 | 323 | static struct of_device_id of_flash_match[] = { |
2099172d DG |
324 | { |
325 | .compatible = "cfi-flash", | |
326 | .data = (void *)"cfi_probe", | |
327 | }, | |
328 | { | |
329 | /* FIXME: JEDEC chips can't be safely and reliably | |
330 | * probed, although the mtd code gets it right in | |
331 | * practice most of the time. We should use the | |
332 | * vendor and device ids specified by the binding to | |
333 | * bypass the heuristic probe code, but the mtd layer | |
334 | * provides, at present, no interface for doing so | |
335 | * :(. */ | |
336 | .compatible = "jedec-flash", | |
337 | .data = (void *)"jedec_probe", | |
338 | }, | |
fc28c39f WS |
339 | { |
340 | .compatible = "mtd-ram", | |
341 | .data = (void *)"map_ram", | |
342 | }, | |
a2c2fe4b VW |
343 | { |
344 | .type = "rom", | |
345 | .compatible = "direct-mapped" | |
346 | }, | |
347 | { }, | |
348 | }; | |
c4d5e375 | 349 | MODULE_DEVICE_TABLE(of, of_flash_match); |
a2c2fe4b | 350 | |
1c48a5c9 | 351 | static struct platform_driver of_flash_driver = { |
4018294b GL |
352 | .driver = { |
353 | .name = "of-flash", | |
354 | .owner = THIS_MODULE, | |
355 | .of_match_table = of_flash_match, | |
356 | }, | |
c4d5e375 DG |
357 | .probe = of_flash_probe, |
358 | .remove = of_flash_remove, | |
a2c2fe4b VW |
359 | }; |
360 | ||
f99640de | 361 | module_platform_driver(of_flash_driver); |
a2c2fe4b VW |
362 | |
363 | MODULE_LICENSE("GPL"); | |
364 | MODULE_AUTHOR("Vitaly Wool <vwool@ru.mvista.com>"); | |
c4d5e375 | 365 | MODULE_DESCRIPTION("Device tree based MTD map driver"); |