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 DG |
24 | #include <linux/of.h> |
25 | #include <linux/of_platform.h> | |
a2c2fe4b | 26 | |
143070e7 SR |
27 | struct of_flash_list { |
28 | struct mtd_info *mtd; | |
29 | struct map_info map; | |
30 | struct resource *res; | |
31 | }; | |
32 | ||
c4d5e375 | 33 | struct of_flash { |
143070e7 | 34 | struct mtd_info *cmtd; |
a2c2fe4b | 35 | #ifdef CONFIG_MTD_PARTITIONS |
a2c2fe4b VW |
36 | struct mtd_partition *parts; |
37 | #endif | |
143070e7 SR |
38 | int list_size; /* number of elements in of_flash_list */ |
39 | struct of_flash_list list[0]; | |
a2c2fe4b VW |
40 | }; |
41 | ||
a2c2fe4b | 42 | #ifdef CONFIG_MTD_PARTITIONS |
c4d5e375 | 43 | #define OF_FLASH_PARTS(info) ((info)->parts) |
a2c2fe4b | 44 | |
2099172d | 45 | static int parse_obsolete_partitions(struct of_device *dev, |
c4d5e375 | 46 | struct of_flash *info, |
2099172d | 47 | struct device_node *dp) |
a2c2fe4b | 48 | { |
2099172d DG |
49 | int i, plen, nr_parts; |
50 | const struct { | |
51 | u32 offset, len; | |
52 | } *part; | |
53 | const char *names; | |
a2c2fe4b | 54 | |
2099172d DG |
55 | part = of_get_property(dp, "partitions", &plen); |
56 | if (!part) | |
c4d5e375 | 57 | return 0; /* No partitions found */ |
a2c2fe4b | 58 | |
2099172d DG |
59 | dev_warn(&dev->dev, "Device tree uses obsolete partition map binding\n"); |
60 | ||
61 | nr_parts = plen / sizeof(part[0]); | |
62 | ||
c4d5e375 DG |
63 | info->parts = kzalloc(nr_parts * sizeof(*info->parts), GFP_KERNEL); |
64 | if (!info->parts) | |
2099172d | 65 | return -ENOMEM; |
a2c2fe4b | 66 | |
2099172d | 67 | names = of_get_property(dp, "partition-names", &plen); |
a2c2fe4b | 68 | |
2099172d DG |
69 | for (i = 0; i < nr_parts; i++) { |
70 | info->parts[i].offset = part->offset; | |
71 | info->parts[i].size = part->len & ~1; | |
72 | if (part->len & 1) /* bit 0 set signifies read only partition */ | |
73 | info->parts[i].mask_flags = MTD_WRITEABLE; | |
a2c2fe4b | 74 | |
2099172d DG |
75 | if (names && (plen > 0)) { |
76 | int len = strlen(names) + 1; | |
a2c2fe4b | 77 | |
2099172d | 78 | info->parts[i].name = (char *)names; |
a2c2fe4b | 79 | plen -= len; |
2099172d DG |
80 | names += len; |
81 | } else { | |
82 | info->parts[i].name = "unnamed"; | |
83 | } | |
84 | ||
85 | part++; | |
a2c2fe4b | 86 | } |
2099172d DG |
87 | |
88 | return nr_parts; | |
a2c2fe4b | 89 | } |
2099172d | 90 | #else /* MTD_PARTITIONS */ |
c4d5e375 DG |
91 | #define OF_FLASH_PARTS(info) (0) |
92 | #define parse_partitions(info, dev) (0) | |
2099172d | 93 | #endif /* MTD_PARTITIONS */ |
a2c2fe4b | 94 | |
c4d5e375 | 95 | static int of_flash_remove(struct of_device *dev) |
a2c2fe4b | 96 | { |
c4d5e375 | 97 | struct of_flash *info; |
143070e7 | 98 | int i; |
a2c2fe4b VW |
99 | |
100 | info = dev_get_drvdata(&dev->dev); | |
c4d5e375 | 101 | if (!info) |
a2c2fe4b VW |
102 | return 0; |
103 | dev_set_drvdata(&dev->dev, NULL); | |
104 | ||
143070e7 SR |
105 | #ifdef CONFIG_MTD_CONCAT |
106 | if (info->cmtd != info->list[0].mtd) { | |
107 | del_mtd_device(info->cmtd); | |
108 | mtd_concat_destroy(info->cmtd); | |
109 | } | |
110 | #endif | |
111 | ||
112 | if (info->cmtd) { | |
c4d5e375 | 113 | if (OF_FLASH_PARTS(info)) { |
143070e7 | 114 | del_mtd_partitions(info->cmtd); |
c4d5e375 | 115 | kfree(OF_FLASH_PARTS(info)); |
a2c2fe4b | 116 | } else { |
143070e7 | 117 | del_mtd_device(info->cmtd); |
a2c2fe4b | 118 | } |
a2c2fe4b VW |
119 | } |
120 | ||
143070e7 SR |
121 | for (i = 0; i < info->list_size; i++) { |
122 | if (info->list[i].mtd) | |
123 | map_destroy(info->list[i].mtd); | |
a2c2fe4b | 124 | |
143070e7 SR |
125 | if (info->list[i].map.virt) |
126 | iounmap(info->list[i].map.virt); | |
127 | ||
128 | if (info->list[i].res) { | |
129 | release_resource(info->list[i].res); | |
130 | kfree(info->list[i].res); | |
131 | } | |
a2c2fe4b VW |
132 | } |
133 | ||
143070e7 SR |
134 | kfree(info); |
135 | ||
a2c2fe4b VW |
136 | return 0; |
137 | } | |
138 | ||
2099172d DG |
139 | /* Helper function to handle probing of the obsolete "direct-mapped" |
140 | * compatible binding, which has an extra "probe-type" property | |
141 | * describing the type of flash probe necessary. */ | |
142 | static struct mtd_info * __devinit obsolete_probe(struct of_device *dev, | |
143 | struct map_info *map) | |
a2c2fe4b VW |
144 | { |
145 | struct device_node *dp = dev->node; | |
a2c2fe4b | 146 | const char *of_probe; |
2099172d DG |
147 | struct mtd_info *mtd; |
148 | static const char *rom_probe_types[] | |
149 | = { "cfi_probe", "jedec_probe", "map_rom"}; | |
150 | int i; | |
151 | ||
152 | dev_warn(&dev->dev, "Device tree uses obsolete \"direct-mapped\" " | |
153 | "flash binding\n"); | |
154 | ||
155 | of_probe = of_get_property(dp, "probe-type", NULL); | |
156 | if (!of_probe) { | |
157 | for (i = 0; i < ARRAY_SIZE(rom_probe_types); i++) { | |
158 | mtd = do_map_probe(rom_probe_types[i], map); | |
159 | if (mtd) | |
160 | return mtd; | |
161 | } | |
162 | return NULL; | |
163 | } else if (strcmp(of_probe, "CFI") == 0) { | |
164 | return do_map_probe("cfi_probe", map); | |
165 | } else if (strcmp(of_probe, "JEDEC") == 0) { | |
166 | return do_map_probe("jedec_probe", map); | |
167 | } else { | |
168 | if (strcmp(of_probe, "ROM") != 0) | |
c4d5e375 DG |
169 | dev_warn(&dev->dev, "obsolete_probe: don't know probe " |
170 | "type '%s', mapping as rom\n", of_probe); | |
2099172d DG |
171 | return do_map_probe("mtd_rom", map); |
172 | } | |
173 | } | |
174 | ||
c4d5e375 DG |
175 | static int __devinit of_flash_probe(struct of_device *dev, |
176 | const struct of_device_id *match) | |
a2c2fe4b | 177 | { |
9a310d21 SW |
178 | #ifdef CONFIG_MTD_PARTITIONS |
179 | static const char *part_probe_types[] | |
180 | = { "cmdlinepart", "RedBoot", NULL }; | |
181 | #endif | |
a2c2fe4b VW |
182 | struct device_node *dp = dev->node; |
183 | struct resource res; | |
c4d5e375 DG |
184 | struct of_flash *info; |
185 | const char *probe_type = match->data; | |
a2c2fe4b VW |
186 | const u32 *width; |
187 | int err; | |
143070e7 SR |
188 | int i; |
189 | int count; | |
190 | const u32 *p; | |
191 | int reg_tuple_size; | |
192 | struct mtd_info **mtd_list = NULL; | |
193 | ||
194 | reg_tuple_size = (of_n_addr_cells(dp) + of_n_size_cells(dp)) * sizeof(u32); | |
195 | ||
196 | /* | |
197 | * Get number of "reg" tuples. Scan for MTD devices on area's | |
198 | * described by each "reg" region. This makes it possible (including | |
199 | * the concat support) to support the Intel P30 48F4400 chips which | |
200 | * consists internally of 2 non-identical NOR chips on one die. | |
201 | */ | |
202 | p = of_get_property(dp, "reg", &count); | |
203 | if (count % reg_tuple_size != 0) { | |
204 | dev_err(&dev->dev, "Malformed reg property on %s\n", | |
205 | dev->node->full_name); | |
206 | err = -EINVAL; | |
a2c2fe4b VW |
207 | goto err_out; |
208 | } | |
143070e7 | 209 | count /= reg_tuple_size; |
a2c2fe4b | 210 | |
c4d5e375 | 211 | err = -ENOMEM; |
143070e7 SR |
212 | info = kzalloc(sizeof(struct of_flash) + |
213 | sizeof(struct of_flash_list) * count, GFP_KERNEL); | |
214 | if (!info) | |
215 | goto err_out; | |
216 | ||
217 | mtd_list = kzalloc(sizeof(struct mtd_info) * count, GFP_KERNEL); | |
c4d5e375 | 218 | if (!info) |
a2c2fe4b | 219 | goto err_out; |
a2c2fe4b VW |
220 | |
221 | dev_set_drvdata(&dev->dev, info); | |
222 | ||
143070e7 SR |
223 | for (i = 0; i < count; i++) { |
224 | err = -ENXIO; | |
225 | if (of_address_to_resource(dp, i, &res)) { | |
226 | dev_err(&dev->dev, "Can't get IO address from device" | |
227 | " tree\n"); | |
228 | goto err_out; | |
229 | } | |
a2c2fe4b | 230 | |
143070e7 SR |
231 | dev_dbg(&dev->dev, "of_flash device: %.8llx-%.8llx\n", |
232 | (unsigned long long)res.start, | |
233 | (unsigned long long)res.end); | |
234 | ||
235 | err = -EBUSY; | |
236 | info->list[i].res = request_mem_region(res.start, res.end - | |
237 | res.start + 1, | |
238 | dev_name(&dev->dev)); | |
239 | if (!info->list[i].res) | |
240 | goto err_out; | |
241 | ||
242 | err = -ENXIO; | |
243 | width = of_get_property(dp, "bank-width", NULL); | |
244 | if (!width) { | |
245 | dev_err(&dev->dev, "Can't get bank width from device" | |
246 | " tree\n"); | |
247 | goto err_out; | |
248 | } | |
a2c2fe4b | 249 | |
143070e7 SR |
250 | info->list[i].map.name = dev_name(&dev->dev); |
251 | info->list[i].map.phys = res.start; | |
252 | info->list[i].map.size = res.end - res.start + 1; | |
253 | info->list[i].map.bankwidth = *width; | |
254 | ||
255 | err = -ENOMEM; | |
256 | info->list[i].map.virt = ioremap(info->list[i].map.phys, | |
257 | info->list[i].map.size); | |
258 | if (!info->list[i].map.virt) { | |
259 | dev_err(&dev->dev, "Failed to ioremap() flash" | |
260 | " region\n"); | |
261 | goto err_out; | |
262 | } | |
a2c2fe4b | 263 | |
143070e7 | 264 | simple_map_init(&info->list[i].map); |
a2c2fe4b | 265 | |
143070e7 SR |
266 | if (probe_type) { |
267 | info->list[i].mtd = do_map_probe(probe_type, | |
268 | &info->list[i].map); | |
269 | } else { | |
270 | info->list[i].mtd = obsolete_probe(dev, | |
271 | &info->list[i].map); | |
272 | } | |
273 | mtd_list[i] = info->list[i].mtd; | |
a2c2fe4b | 274 | |
143070e7 SR |
275 | err = -ENXIO; |
276 | if (!info->list[i].mtd) { | |
277 | dev_err(&dev->dev, "do_map_probe() failed\n"); | |
278 | goto err_out; | |
279 | } else { | |
280 | info->list_size++; | |
281 | } | |
282 | info->list[i].mtd->owner = THIS_MODULE; | |
283 | info->list[i].mtd->dev.parent = &dev->dev; | |
284 | } | |
2099172d | 285 | |
143070e7 SR |
286 | err = 0; |
287 | if (info->list_size == 1) { | |
288 | info->cmtd = info->list[0].mtd; | |
289 | } else if (info->list_size > 1) { | |
290 | /* | |
291 | * We detected multiple devices. Concatenate them together. | |
292 | */ | |
293 | #ifdef CONFIG_MTD_CONCAT | |
294 | info->cmtd = mtd_concat_create(mtd_list, info->list_size, | |
295 | dev_name(&dev->dev)); | |
296 | if (info->cmtd == NULL) | |
297 | err = -ENXIO; | |
298 | #else | |
299 | printk(KERN_ERR "physmap_of: multiple devices " | |
300 | "found but MTD concat support disabled.\n"); | |
301 | err = -ENXIO; | |
302 | #endif | |
a2c2fe4b | 303 | } |
143070e7 SR |
304 | if (err) |
305 | goto err_out; | |
a2c2fe4b | 306 | |
9a310d21 SW |
307 | #ifdef CONFIG_MTD_PARTITIONS |
308 | /* First look for RedBoot table or partitions on the command | |
309 | * line, these take precedence over device tree information */ | |
143070e7 SR |
310 | err = parse_mtd_partitions(info->cmtd, part_probe_types, |
311 | &info->parts, 0); | |
c4d5e375 | 312 | if (err < 0) |
9a310d21 SW |
313 | return err; |
314 | ||
315 | #ifdef CONFIG_MTD_OF_PARTS | |
316 | if (err == 0) { | |
69fd3a8d | 317 | err = of_mtd_parse_partitions(&dev->dev, dp, &info->parts); |
9a310d21 SW |
318 | if (err < 0) |
319 | return err; | |
320 | } | |
321 | #endif | |
322 | ||
323 | if (err == 0) { | |
324 | err = parse_obsolete_partitions(dev, info, dp); | |
325 | if (err < 0) | |
326 | return err; | |
327 | } | |
a2c2fe4b | 328 | |
c4d5e375 | 329 | if (err > 0) |
143070e7 | 330 | add_mtd_partitions(info->cmtd, info->parts, err); |
c4d5e375 | 331 | else |
9a310d21 | 332 | #endif |
143070e7 SR |
333 | add_mtd_device(info->cmtd); |
334 | ||
335 | kfree(mtd_list); | |
a2c2fe4b | 336 | |
a2c2fe4b VW |
337 | return 0; |
338 | ||
339 | err_out: | |
143070e7 | 340 | kfree(mtd_list); |
c4d5e375 | 341 | of_flash_remove(dev); |
143070e7 | 342 | |
a2c2fe4b | 343 | return err; |
a2c2fe4b VW |
344 | } |
345 | ||
c4d5e375 | 346 | static struct of_device_id of_flash_match[] = { |
2099172d DG |
347 | { |
348 | .compatible = "cfi-flash", | |
349 | .data = (void *)"cfi_probe", | |
350 | }, | |
351 | { | |
352 | /* FIXME: JEDEC chips can't be safely and reliably | |
353 | * probed, although the mtd code gets it right in | |
354 | * practice most of the time. We should use the | |
355 | * vendor and device ids specified by the binding to | |
356 | * bypass the heuristic probe code, but the mtd layer | |
357 | * provides, at present, no interface for doing so | |
358 | * :(. */ | |
359 | .compatible = "jedec-flash", | |
360 | .data = (void *)"jedec_probe", | |
361 | }, | |
a2c2fe4b VW |
362 | { |
363 | .type = "rom", | |
364 | .compatible = "direct-mapped" | |
365 | }, | |
366 | { }, | |
367 | }; | |
c4d5e375 | 368 | MODULE_DEVICE_TABLE(of, of_flash_match); |
a2c2fe4b | 369 | |
c4d5e375 DG |
370 | static struct of_platform_driver of_flash_driver = { |
371 | .name = "of-flash", | |
372 | .match_table = of_flash_match, | |
373 | .probe = of_flash_probe, | |
374 | .remove = of_flash_remove, | |
a2c2fe4b VW |
375 | }; |
376 | ||
c4d5e375 | 377 | static int __init of_flash_init(void) |
a2c2fe4b | 378 | { |
c4d5e375 | 379 | return of_register_platform_driver(&of_flash_driver); |
a2c2fe4b VW |
380 | } |
381 | ||
c4d5e375 | 382 | static void __exit of_flash_exit(void) |
a2c2fe4b | 383 | { |
c4d5e375 | 384 | of_unregister_platform_driver(&of_flash_driver); |
a2c2fe4b VW |
385 | } |
386 | ||
c4d5e375 DG |
387 | module_init(of_flash_init); |
388 | module_exit(of_flash_exit); | |
a2c2fe4b VW |
389 | |
390 | MODULE_LICENSE("GPL"); | |
391 | MODULE_AUTHOR("Vitaly Wool <vwool@ru.mvista.com>"); | |
c4d5e375 | 392 | MODULE_DESCRIPTION("Device tree based MTD map driver"); |