1/*
  2 * Normal mappings of chips in physical memory
  3 *
  4 * Copyright (C) 2003 MontaVista Software Inc.
  5 * Author: Jun Sun, jsun@mvista.com or jsun@junsun.net
  6 *
  7 * 031022 - [jsun] add run-time configure and partition setup
  8 */
  9
 10#include <linux/module.h>
 11#include <linux/types.h>
 12#include <linux/kernel.h>
 13#include <linux/init.h>
 14#include <linux/slab.h>
 15#include <linux/device.h>
 16#include <linux/platform_device.h>
 17#include <linux/mtd/mtd.h>
 18#include <linux/mtd/map.h>
 19#include <linux/mtd/partitions.h>
 20#include <linux/mtd/physmap.h>
 21#include <linux/mtd/concat.h>
 22#include <linux/io.h>
 23
 24#define MAX_RESOURCES		4
 25
 26struct physmap_flash_info {
 27	struct mtd_info		*mtd[MAX_RESOURCES];
 28	struct mtd_info		*cmtd;
 29	struct map_info		map[MAX_RESOURCES];
 30	int			nr_parts;
 31	struct mtd_partition	*parts;
 32};
 33
 34static int physmap_flash_remove(struct platform_device *dev)
 35{
 36	struct physmap_flash_info *info;
 37	struct physmap_flash_data *physmap_data;
 38	int i;
 39
 40	info = platform_get_drvdata(dev);
 41	if (info == NULL)
 42		return 0;
 43	platform_set_drvdata(dev, NULL);
 44
 45	physmap_data = dev->dev.platform_data;
 46
 47	if (info->cmtd) {
 48		mtd_device_unregister(info->cmtd);
 49		if (info->nr_parts)
 50			kfree(info->parts);
 51		if (info->cmtd != info->mtd[0])
 52			mtd_concat_destroy(info->cmtd);
 53	}
 54
 55	for (i = 0; i < MAX_RESOURCES; i++) {
 56		if (info->mtd[i] != NULL)
 57			map_destroy(info->mtd[i]);
 58	}
 59
 60	if (physmap_data->exit)
 61		physmap_data->exit(dev);
 62
 63	return 0;
 64}
 65
 66static void physmap_set_vpp(struct map_info *map, int state)
 67{
 68	struct platform_device *pdev;
 69	struct physmap_flash_data *physmap_data;
 70
 71	pdev = (struct platform_device *)map->map_priv_1;
 72	physmap_data = pdev->dev.platform_data;
 73
 74	if (physmap_data->set_vpp)
 75		physmap_data->set_vpp(pdev, state);
 76}
 77
 78static const char *rom_probe_types[] = {
 79					"cfi_probe",
 80					"jedec_probe",
 81					"qinfo_probe",
 82					"map_rom",
 83					NULL };
 84static const char *part_probe_types[] = { "cmdlinepart", "RedBoot", "afs",
 85					  NULL };
 86
 87static int physmap_flash_probe(struct platform_device *dev)
 88{
 89	struct physmap_flash_data *physmap_data;
 90	struct physmap_flash_info *info;
 91	const char **probe_type;
 92	int err = 0;
 93	int i;
 94	int devices_found = 0;
 95
 96	physmap_data = dev->dev.platform_data;
 97	if (physmap_data == NULL)
 98		return -ENODEV;
 99
100	info = devm_kzalloc(&dev->dev, sizeof(struct physmap_flash_info),
101			    GFP_KERNEL);
102	if (info == NULL) {
103		err = -ENOMEM;
104		goto err_out;
105	}
106
107	if (physmap_data->init) {
108		err = physmap_data->init(dev);
109		if (err)
110			goto err_out;
111	}
112
113	platform_set_drvdata(dev, info);
114
115	for (i = 0; i < dev->num_resources; i++) {
116		printk(KERN_NOTICE "physmap platform flash device: %.8llx at %.8llx\n",
117		       (unsigned long long)resource_size(&dev->resource[i]),
118		       (unsigned long long)dev->resource[i].start);
119
120		if (!devm_request_mem_region(&dev->dev,
121			dev->resource[i].start,
122			resource_size(&dev->resource[i]),
123			dev_name(&dev->dev))) {
124			dev_err(&dev->dev, "Could not reserve memory region\n");
125			err = -ENOMEM;
126			goto err_out;
127		}
128
129		info->map[i].name = dev_name(&dev->dev);
130		info->map[i].phys = dev->resource[i].start;
131		info->map[i].size = resource_size(&dev->resource[i]);
132		info->map[i].bankwidth = physmap_data->width;
133		info->map[i].set_vpp = physmap_set_vpp;
134		info->map[i].pfow_base = physmap_data->pfow_base;
135		info->map[i].map_priv_1 = (unsigned long)dev;
136
137		info->map[i].virt = devm_ioremap(&dev->dev, info->map[i].phys,
138						 info->map[i].size);
139		if (info->map[i].virt == NULL) {
140			dev_err(&dev->dev, "Failed to ioremap flash region\n");
141			err = -EIO;
142			goto err_out;
143		}
144
145		simple_map_init(&info->map[i]);
146
147		probe_type = rom_probe_types;
148		if (physmap_data->probe_type == NULL) {
149			for (; info->mtd[i] == NULL && *probe_type != NULL; probe_type++)
150				info->mtd[i] = do_map_probe(*probe_type, &info->map[i]);
151		} else
152			info->mtd[i] = do_map_probe(physmap_data->probe_type, &info->map[i]);
153
154		if (info->mtd[i] == NULL) {
155			dev_err(&dev->dev, "map_probe failed\n");
156			err = -ENXIO;
157			goto err_out;
158		} else {
159			devices_found++;
160		}
161		info->mtd[i]->owner = THIS_MODULE;
162		info->mtd[i]->dev.parent = &dev->dev;
163	}
164
165	if (devices_found == 1) {
166		info->cmtd = info->mtd[0];
167	} else if (devices_found > 1) {
168		/*
169		 * We detected multiple devices. Concatenate them together.
170		 */
171		info->cmtd = mtd_concat_create(info->mtd, devices_found, dev_name(&dev->dev));
172		if (info->cmtd == NULL)
173			err = -ENXIO;
174	}
175	if (err)
176		goto err_out;
177
178	err = parse_mtd_partitions(info->cmtd, part_probe_types,
179				   &info->parts, 0);
180	if (err > 0) {
181		mtd_device_register(info->cmtd, info->parts, err);
182		info->nr_parts = err;
183		return 0;
184	}
185
186	if (physmap_data->nr_parts) {
187		printk(KERN_NOTICE "Using physmap partition information\n");
188		mtd_device_register(info->cmtd, physmap_data->parts,
189				    physmap_data->nr_parts);
190		return 0;
191	}
192
193	mtd_device_register(info->cmtd, NULL, 0);
194
195	return 0;
196
197err_out:
198	physmap_flash_remove(dev);
199	return err;
200}
201
202#ifdef CONFIG_PM
203static void physmap_flash_shutdown(struct platform_device *dev)
204{
205	struct physmap_flash_info *info = platform_get_drvdata(dev);
206	int i;
207
208	for (i = 0; i < MAX_RESOURCES && info->mtd[i]; i++)
209		if (info->mtd[i]->suspend && info->mtd[i]->resume)
210			if (info->mtd[i]->suspend(info->mtd[i]) == 0)
211				info->mtd[i]->resume(info->mtd[i]);
212}
213#else
214#define physmap_flash_shutdown NULL
215#endif
216
217static struct platform_driver physmap_flash_driver = {
218	.probe		= physmap_flash_probe,
219	.remove		= physmap_flash_remove,
220	.shutdown	= physmap_flash_shutdown,
221	.driver		= {
222		.name	= "physmap-flash",
223		.owner	= THIS_MODULE,
224	},
225};
226
227
228#ifdef CONFIG_MTD_PHYSMAP_COMPAT
229static struct physmap_flash_data physmap_flash_data = {
230	.width		= CONFIG_MTD_PHYSMAP_BANKWIDTH,
231};
232
233static struct resource physmap_flash_resource = {
234	.start		= CONFIG_MTD_PHYSMAP_START,
235	.end		= CONFIG_MTD_PHYSMAP_START + CONFIG_MTD_PHYSMAP_LEN - 1,
236	.flags		= IORESOURCE_MEM,
237};
238
239static struct platform_device physmap_flash = {
240	.name		= "physmap-flash",
241	.id		= 0,
242	.dev		= {
243		.platform_data	= &physmap_flash_data,
244	},
245	.num_resources	= 1,
246	.resource	= &physmap_flash_resource,
247};
248
249void physmap_configure(unsigned long addr, unsigned long size,
250		int bankwidth, void (*set_vpp)(struct map_info *, int))
251{
252	physmap_flash_resource.start = addr;
253	physmap_flash_resource.end = addr + size - 1;
254	physmap_flash_data.width = bankwidth;
255	physmap_flash_data.set_vpp = set_vpp;
256}
257
258void physmap_set_partitions(struct mtd_partition *parts, int num_parts)
259{
260	physmap_flash_data.nr_parts = num_parts;
261	physmap_flash_data.parts = parts;
262}
263#endif
264
265static int __init physmap_init(void)
266{
267	int err;
268
269	err = platform_driver_register(&physmap_flash_driver);
270#ifdef CONFIG_MTD_PHYSMAP_COMPAT
271	if (err == 0) {
272		err = platform_device_register(&physmap_flash);
273		if (err)
274			platform_driver_unregister(&physmap_flash_driver);
275	}
276#endif
277
278	return err;
279}
280
281static void __exit physmap_exit(void)
282{
283#ifdef CONFIG_MTD_PHYSMAP_COMPAT
284	platform_device_unregister(&physmap_flash);
285#endif
286	platform_driver_unregister(&physmap_flash_driver);
287}
288
289module_init(physmap_init);
290module_exit(physmap_exit);
291
292MODULE_LICENSE("GPL");
293MODULE_AUTHOR("David Woodhouse <dwmw2@infradead.org>");
294MODULE_DESCRIPTION("Generic configurable MTD map driver");
295
296/* legacy platform drivers can't hotplug or coldplg */
297#ifndef CONFIG_MTD_PHYSMAP_COMPAT
298/* work with hotplug and coldplug */
299MODULE_ALIAS("platform:physmap-flash");
300#endif