[linux-2.6-block.git] / drivers / mtd / maps / sa1100-flash.c

// SPDX-License-Identifier: GPL-2.0-only
/*
 * Flash memory access on SA11x0 based devices
 *
 * (C) 2000 Nicolas Pitre <nico@fluxnic.net>
 */
#include <linux/module.h>
#include <linux/types.h>
#include <linux/ioport.h>
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/errno.h>
#include <linux/slab.h>
#include <linux/platform_device.h>
#include <linux/err.h>
#include <linux/io.h>

#include <linux/mtd/mtd.h>
#include <linux/mtd/map.h>
#include <linux/mtd/partitions.h>
#include <linux/mtd/concat.h>

#include <mach/hardware.h>
#include <linux/sizes.h>
#include <asm/mach/flash.h>

struct sa_subdev_info {
	char name[16];
	struct map_info map;
	struct mtd_info *mtd;
	struct flash_platform_data *plat;
};

struct sa_info {
	struct mtd_info		*mtd;
	int			num_subdev;
	struct sa_subdev_info	subdev[0];
};

static DEFINE_SPINLOCK(sa1100_vpp_lock);
static int sa1100_vpp_refcnt;
static void sa1100_set_vpp(struct map_info *map, int on)
{
	struct sa_subdev_info *subdev = container_of(map, struct sa_subdev_info, map);
	unsigned long flags;

	spin_lock_irqsave(&sa1100_vpp_lock, flags);
	if (on) {
		if (++sa1100_vpp_refcnt == 1)   /* first nested 'on' */
			subdev->plat->set_vpp(1);
	} else {
		if (--sa1100_vpp_refcnt == 0)   /* last nested 'off' */
			subdev->plat->set_vpp(0);
	}
	spin_unlock_irqrestore(&sa1100_vpp_lock, flags);
}

static void sa1100_destroy_subdev(struct sa_subdev_info *subdev)
{
	if (subdev->mtd)
		map_destroy(subdev->mtd);
	if (subdev->map.virt)
		iounmap(subdev->map.virt);
	release_mem_region(subdev->map.phys, subdev->map.size);
}

static int sa1100_probe_subdev(struct sa_subdev_info *subdev, struct resource *res)
{
	unsigned long phys;
	unsigned int size;
	int ret;

	phys = res->start;
	size = res->end - phys + 1;

	/*
	 * Retrieve the bankwidth from the MSC registers.
	 * We currently only implement CS0 and CS1 here.
	 */
	switch (phys) {
	default:
		printk(KERN_WARNING "SA1100 flash: unknown base address "
		       "0x%08lx, assuming CS0\n", phys);
		/* Fall through */

	case SA1100_CS0_PHYS:
		subdev->map.bankwidth = (MSC0 & MSC_RBW) ? 2 : 4;
		break;

	case SA1100_CS1_PHYS:
		subdev->map.bankwidth = ((MSC0 >> 16) & MSC_RBW) ? 2 : 4;
		break;
	}

	if (!request_mem_region(phys, size, subdev->name)) {
		ret = -EBUSY;
		goto out;
	}

	if (subdev->plat->set_vpp)
		subdev->map.set_vpp = sa1100_set_vpp;

	subdev->map.phys = phys;
	subdev->map.size = size;
	subdev->map.virt = ioremap(phys, size);
	if (!subdev->map.virt) {
		ret = -ENOMEM;
		goto err;
	}

	simple_map_init(&subdev->map);

	/*
	 * Now let's probe for the actual flash.  Do it here since
	 * specific machine settings might have been set above.
	 */
	subdev->mtd = do_map_probe(subdev->plat->map_name, &subdev->map);
	if (subdev->mtd == NULL) {
		ret = -ENXIO;
		goto err;
	}

	printk(KERN_INFO "SA1100 flash: CFI device at 0x%08lx, %uMiB, %d-bit\n",
		phys, (unsigned)(subdev->mtd->size >> 20),
		subdev->map.bankwidth * 8);

	return 0;

 err:
	sa1100_destroy_subdev(subdev);
 out:
	return ret;
}

static void sa1100_destroy(struct sa_info *info, struct flash_platform_data *plat)
{
	int i;

	if (info->mtd) {
		mtd_device_unregister(info->mtd);
		if (info->mtd != info->subdev[0].mtd)
			mtd_concat_destroy(info->mtd);
	}

	for (i = info->num_subdev - 1; i >= 0; i--)
		sa1100_destroy_subdev(&info->subdev[i]);
	kfree(info);

	if (plat->exit)
		plat->exit();
}

static struct sa_info *sa1100_setup_mtd(struct platform_device *pdev,
					struct flash_platform_data *plat)
{
	struct sa_info *info;
	int nr, size, i, ret = 0;

	/*
	 * Count number of devices.
	 */
	for (nr = 0; ; nr++)
		if (!platform_get_resource(pdev, IORESOURCE_MEM, nr))
			break;

	if (nr == 0) {
		ret = -ENODEV;
		goto out;
	}

	size = sizeof(struct sa_info) + sizeof(struct sa_subdev_info) * nr;

	/*
	 * Allocate the map_info structs in one go.
	 */
	info = kzalloc(size, GFP_KERNEL);
	if (!info) {
		ret = -ENOMEM;
		goto out;
	}

	if (plat->init) {
		ret = plat->init();
		if (ret)
			goto err;
	}

	/*
	 * Claim and then map the memory regions.
	 */
	for (i = 0; i < nr; i++) {
		struct sa_subdev_info *subdev = &info->subdev[i];
		struct resource *res;

		res = platform_get_resource(pdev, IORESOURCE_MEM, i);
		if (!res)
			break;

		subdev->map.name = subdev->name;
		sprintf(subdev->name, "%s-%d", plat->name, i);
		subdev->plat = plat;

		ret = sa1100_probe_subdev(subdev, res);
		if (ret)
			break;
	}

	info->num_subdev = i;

	/*
	 * ENXIO is special.  It means we didn't find a chip when we probed.
	 */
	if (ret != 0 && !(ret == -ENXIO && info->num_subdev > 0))
		goto err;

	/*
	 * If we found one device, don't bother with concat support.  If
	 * we found multiple devices, use concat if we have it available,
	 * otherwise fail.  Either way, it'll be called "sa1100".
	 */
	if (info->num_subdev == 1) {
		strcpy(info->subdev[0].name, plat->name);
		info->mtd = info->subdev[0].mtd;
		ret = 0;
	} else if (info->num_subdev > 1) {
		struct mtd_info **cdev;

		cdev = kmalloc_array(nr, sizeof(*cdev), GFP_KERNEL);
		if (!cdev) {
			ret = -ENOMEM;
			goto err;
		}

		/*
		 * We detected multiple devices.  Concatenate them together.
		 */
		for (i = 0; i < info->num_subdev; i++)
			cdev[i] = info->subdev[i].mtd;

		info->mtd = mtd_concat_create(cdev, info->num_subdev,
					      plat->name);
		kfree(cdev);
		if (info->mtd == NULL) {
			ret = -ENXIO;
			goto err;
		}
	}
	info->mtd->dev.parent = &pdev->dev;

	if (ret == 0)
		return info;

 err:
	sa1100_destroy(info, plat);
 out:
	return ERR_PTR(ret);
}

static const char * const part_probes[] = { "cmdlinepart", "RedBoot", NULL };

static int sa1100_mtd_probe(struct platform_device *pdev)
{
	struct flash_platform_data *plat = dev_get_platdata(&pdev->dev);
	struct sa_info *info;
	int err;

	if (!plat)
		return -ENODEV;

	info = sa1100_setup_mtd(pdev, plat);
	if (IS_ERR(info)) {
		err = PTR_ERR(info);
		goto out;
	}

	/*
	 * Partition selection stuff.
	 */
	mtd_device_parse_register(info->mtd, part_probes, NULL, plat->parts,
				  plat->nr_parts);

	platform_set_drvdata(pdev, info);
	err = 0;

 out:
	return err;
}

static int sa1100_mtd_remove(struct platform_device *pdev)
{
	struct sa_info *info = platform_get_drvdata(pdev);
	struct flash_platform_data *plat = dev_get_platdata(&pdev->dev);

	sa1100_destroy(info, plat);

	return 0;
}

static struct platform_driver sa1100_mtd_driver = {
	.probe		= sa1100_mtd_probe,
	.remove		= sa1100_mtd_remove,
	.driver		= {
		.name	= "sa1100-mtd",
	},
};

module_platform_driver(sa1100_mtd_driver);

MODULE_AUTHOR("Nicolas Pitre");
MODULE_DESCRIPTION("SA1100 CFI map driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:sa1100-mtd");
Commit	Line	Data
09c434b8	1	// SPDX-License-Identifier: GPL-2.0-only
1da177e4 LT	2	/*
1da177e4 LT	3	* Flash memory access on SA11x0 based devices
69f34c98	4	*
2f82af08	5	* (C) 2000 Nicolas Pitre <nico@fluxnic.net>
1da177e4	6	*/
1da177e4 LT	7	#include <linux/module.h>
	8	#include <linux/types.h>
	9	#include <linux/ioport.h>
	10	#include <linux/kernel.h>
	11	#include <linux/init.h>
	12	#include <linux/errno.h>
	13	#include <linux/slab.h>
d052d1be	14	#include <linux/platform_device.h>
1da177e4	15	#include <linux/err.h>
99730225	16	#include <linux/io.h>
1da177e4 LT	17
	18	#include <linux/mtd/mtd.h>
	19	#include <linux/mtd/map.h>
	20	#include <linux/mtd/partitions.h>
	21	#include <linux/mtd/concat.h>
	22
a09e64fb	23	#include <mach/hardware.h>
87dfb311	24	#include <linux/sizes.h>
1da177e4 LT	25	#include <asm/mach/flash.h>
1da177e4 LT	26
1da177e4 LT	27	struct sa_subdev_info {
	28	char name[16];
	29	struct map_info map;
	30	struct mtd_info *mtd;
57725f0a	31	struct flash_platform_data *plat;
1da177e4 LT	32	};
	33
	34	struct sa_info {
1da177e4 LT	35	struct mtd_info *mtd;
	36	int num_subdev;
	37	struct sa_subdev_info subdev[0];
	38	};
	39
ee478af8 PP	40	static DEFINE_SPINLOCK(sa1100_vpp_lock);
ee478af8 PP	41	static int sa1100_vpp_refcnt;
1da177e4 LT	42	static void sa1100_set_vpp(struct map_info *map, int on)
	43	{
	44	struct sa_subdev_info *subdev = container_of(map, struct sa_subdev_info, map);
ee478af8 PP	45	unsigned long flags;
	46
	47	spin_lock_irqsave(&sa1100_vpp_lock, flags);
	48	if (on) {
	49	if (++sa1100_vpp_refcnt == 1) /* first nested 'on' */
	50	subdev->plat->set_vpp(1);
	51	} else {
	52	if (--sa1100_vpp_refcnt == 0) /* last nested 'off' */
	53	subdev->plat->set_vpp(0);
	54	}
	55	spin_unlock_irqrestore(&sa1100_vpp_lock, flags);
1da177e4 LT	56	}
	57
	58	static void sa1100_destroy_subdev(struct sa_subdev_info *subdev)
	59	{
	60	if (subdev->mtd)
	61	map_destroy(subdev->mtd);
	62	if (subdev->map.virt)
	63	iounmap(subdev->map.virt);
	64	release_mem_region(subdev->map.phys, subdev->map.size);
	65	}
	66
	67	static int sa1100_probe_subdev(struct sa_subdev_info subdev, struct resource res)
	68	{
	69	unsigned long phys;
	70	unsigned int size;
	71	int ret;
	72
	73	phys = res->start;
	74	size = res->end - phys + 1;
	75
	76	/*
	77	* Retrieve the bankwidth from the MSC registers.
	78	* We currently only implement CS0 and CS1 here.
	79	*/
	80	switch (phys) {
	81	default:
	82	printk(KERN_WARNING "SA1100 flash: unknown base address "
	83	"0x%08lx, assuming CS0\n", phys);
3f0289cb	84	/* Fall through */
1da177e4 LT	85
	86	case SA1100_CS0_PHYS:
	87	subdev->map.bankwidth = (MSC0 & MSC_RBW) ? 2 : 4;
	88	break;
	89
	90	case SA1100_CS1_PHYS:
	91	subdev->map.bankwidth = ((MSC0 >> 16) & MSC_RBW) ? 2 : 4;
	92	break;
	93	}
	94
	95	if (!request_mem_region(phys, size, subdev->name)) {
	96	ret = -EBUSY;
	97	goto out;
	98	}
	99
57725f0a	100	if (subdev->plat->set_vpp)
1da177e4 LT	101	subdev->map.set_vpp = sa1100_set_vpp;
	102
	103	subdev->map.phys = phys;
	104	subdev->map.size = size;
	105	subdev->map.virt = ioremap(phys, size);
	106	if (!subdev->map.virt) {
	107	ret = -ENOMEM;
	108	goto err;
	109	}
	110
	111	simple_map_init(&subdev->map);
	112
	113	/*
	114	* Now let's probe for the actual flash. Do it here since
	115	* specific machine settings might have been set above.
	116	*/
57725f0a	117	subdev->mtd = do_map_probe(subdev->plat->map_name, &subdev->map);
1da177e4 LT	118	if (subdev->mtd == NULL) {
	119	ret = -ENXIO;
	120	goto err;
	121	}
1da177e4	122
794d579a RK	123	printk(KERN_INFO "SA1100 flash: CFI device at 0x%08lx, %uMiB, %d-bit\n",
794d579a RK	124	phys, (unsigned)(subdev->mtd->size >> 20),
1da177e4 LT	125	subdev->map.bankwidth * 8);
	126
	127	return 0;
	128
	129	err:
	130	sa1100_destroy_subdev(subdev);
	131	out:
	132	return ret;
	133	}
	134
0d2ef7d7	135	static void sa1100_destroy(struct sa_info info, struct flash_platform_data plat)
1da177e4 LT	136	{
	137	int i;
	138
	139	if (info->mtd) {
2fe2e24e	140	mtd_device_unregister(info->mtd);
1da177e4 LT	141	if (info->mtd != info->subdev[0].mtd)
1da177e4 LT	142	mtd_concat_destroy(info->mtd);
1da177e4 LT	143	}
1da177e4 LT	144
1da177e4 LT	145	for (i = info->num_subdev - 1; i >= 0; i--)
	146	sa1100_destroy_subdev(&info->subdev[i]);
	147	kfree(info);
0d2ef7d7 RK	148
	149	if (plat->exit)
	150	plat->exit();
1da177e4 LT	151	}
1da177e4 LT	152
7bf350b7 AB	153	static struct sa_info sa1100_setup_mtd(struct platform_device pdev,
7bf350b7 AB	154	struct flash_platform_data *plat)
1da177e4 LT	155	{
	156	struct sa_info *info;
	157	int nr, size, i, ret = 0;
	158
	159	/*
	160	* Count number of devices.
	161	*/
	162	for (nr = 0; ; nr++)
	163	if (!platform_get_resource(pdev, IORESOURCE_MEM, nr))
	164	break;
	165
	166	if (nr == 0) {
	167	ret = -ENODEV;
	168	goto out;
	169	}
	170
	171	size = sizeof(struct sa_info) + sizeof(struct sa_subdev_info) * nr;
	172
	173	/*
	174	* Allocate the map_info structs in one go.
	175	*/
95b93a0c	176	info = kzalloc(size, GFP_KERNEL);
1da177e4 LT	177	if (!info) {
	178	ret = -ENOMEM;
	179	goto out;
	180	}
	181
0d2ef7d7 RK	182	if (plat->init) {
	183	ret = plat->init();
	184	if (ret)
	185	goto err;
	186	}
	187
1da177e4 LT	188	/*
	189	* Claim and then map the memory regions.
	190	*/
	191	for (i = 0; i < nr; i++) {
	192	struct sa_subdev_info *subdev = &info->subdev[i];
	193	struct resource *res;
	194
	195	res = platform_get_resource(pdev, IORESOURCE_MEM, i);
	196	if (!res)
	197	break;
	198
	199	subdev->map.name = subdev->name;
14e66f76	200	sprintf(subdev->name, "%s-%d", plat->name, i);
57725f0a	201	subdev->plat = plat;
1da177e4 LT	202
	203	ret = sa1100_probe_subdev(subdev, res);
	204	if (ret)
	205	break;
	206	}
	207
	208	info->num_subdev = i;
	209
	210	/*
	211	* ENXIO is special. It means we didn't find a chip when we probed.
	212	*/
	213	if (ret != 0 && !(ret == -ENXIO && info->num_subdev > 0))
	214	goto err;
	215
	216	/*
	217	* If we found one device, don't bother with concat support. If
	218	* we found multiple devices, use concat if we have it available,
	219	* otherwise fail. Either way, it'll be called "sa1100".
	220	*/
	221	if (info->num_subdev == 1) {
14e66f76	222	strcpy(info->subdev[0].name, plat->name);
1da177e4 LT	223	info->mtd = info->subdev[0].mtd;
	224	ret = 0;
	225	} else if (info->num_subdev > 1) {
ba26cd7d BB	226	struct mtd_info **cdev;
	227
	228	cdev = kmalloc_array(nr, sizeof(*cdev), GFP_KERNEL);
	229	if (!cdev) {
	230	ret = -ENOMEM;
	231	goto err;
	232	}
	233
1da177e4 LT	234	/*
	235	* We detected multiple devices. Concatenate them together.
	236	*/
	237	for (i = 0; i < info->num_subdev; i++)
	238	cdev[i] = info->subdev[i].mtd;
	239
	240	info->mtd = mtd_concat_create(cdev, info->num_subdev,
14e66f76	241	plat->name);
ba26cd7d	242	kfree(cdev);
dc01a28d	243	if (info->mtd == NULL) {
1da177e4	244	ret = -ENXIO;
dc01a28d DC	245	goto err;
dc01a28d DC	246	}
1da177e4	247	}
72169755	248	info->mtd->dev.parent = &pdev->dev;
1da177e4 LT	249
	250	if (ret == 0)
	251	return info;
	252
	253	err:
0d2ef7d7	254	sa1100_destroy(info, plat);
1da177e4 LT	255	out:
	256	return ERR_PTR(ret);
	257	}
	258
0984c891	259	static const char * const part_probes[] = { "cmdlinepart", "RedBoot", NULL };
1da177e4	260
06f25510	261	static int sa1100_mtd_probe(struct platform_device *pdev)
1da177e4	262	{
d20d5a57	263	struct flash_platform_data *plat = dev_get_platdata(&pdev->dev);
1da177e4	264	struct sa_info *info;
769dc431	265	int err;
1da177e4	266
57725f0a	267	if (!plat)
1da177e4 LT	268	return -ENODEV;
1da177e4 LT	269
57725f0a	270	info = sa1100_setup_mtd(pdev, plat);
1da177e4 LT	271	if (IS_ERR(info)) {
	272	err = PTR_ERR(info);
	273	goto out;
	274	}
	275
	276	/*
	277	* Partition selection stuff.
	278	*/
42d7fbe2 AB	279	mtd_device_parse_register(info->mtd, part_probes, NULL, plat->parts,
42d7fbe2 AB	280	plat->nr_parts);
822e5e72	281
3ae5eaec	282	platform_set_drvdata(pdev, info);
1da177e4 LT	283	err = 0;
	284
	285	out:
	286	return err;
	287	}
	288
271afb4c	289	static int sa1100_mtd_remove(struct platform_device *pdev)
1da177e4	290	{
3ae5eaec	291	struct sa_info *info = platform_get_drvdata(pdev);
d20d5a57	292	struct flash_platform_data *plat = dev_get_platdata(&pdev->dev);
0d2ef7d7	293
0d2ef7d7 RK	294	sa1100_destroy(info, plat);
0d2ef7d7 RK	295
1da177e4 LT	296	return 0;
	297	}
	298
3ae5eaec	299	static struct platform_driver sa1100_mtd_driver = {
1da177e4	300	.probe = sa1100_mtd_probe,
271afb4c	301	.remove = sa1100_mtd_remove,
3ae5eaec	302	.driver = {
bcc8f3e0	303	.name = "sa1100-mtd",
3ae5eaec	304	},
1da177e4 LT	305	};
1da177e4 LT	306
f99640de	307	module_platform_driver(sa1100_mtd_driver);
1da177e4 LT	308
	309	MODULE_AUTHOR("Nicolas Pitre");
	310	MODULE_DESCRIPTION("SA1100 CFI map driver");
	311	MODULE_LICENSE("GPL");
bcc8f3e0	312	MODULE_ALIAS("platform:sa1100-mtd");