[mirror_ubuntu-jammy-kernel.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[];
};

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);
		fallthrough;
	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;
1da177e4 LT	36	int num_subdev;
f1ffdbfa	37	struct sa_subdev_info subdev[];
1da177e4 LT	38	};
1da177e4 LT	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);
025a06c1	84	fallthrough;
1da177e4 LT	85	case SA1100_CS0_PHYS:
	86	subdev->map.bankwidth = (MSC0 & MSC_RBW) ? 2 : 4;
	87	break;
	88
	89	case SA1100_CS1_PHYS:
	90	subdev->map.bankwidth = ((MSC0 >> 16) & MSC_RBW) ? 2 : 4;
	91	break;
	92	}
	93
	94	if (!request_mem_region(phys, size, subdev->name)) {
	95	ret = -EBUSY;
	96	goto out;
	97	}
	98
57725f0a	99	if (subdev->plat->set_vpp)
1da177e4 LT	100	subdev->map.set_vpp = sa1100_set_vpp;
	101
	102	subdev->map.phys = phys;
	103	subdev->map.size = size;
	104	subdev->map.virt = ioremap(phys, size);
	105	if (!subdev->map.virt) {
	106	ret = -ENOMEM;
	107	goto err;
	108	}
	109
	110	simple_map_init(&subdev->map);
	111
	112	/*
	113	* Now let's probe for the actual flash. Do it here since
	114	* specific machine settings might have been set above.
	115	*/
57725f0a	116	subdev->mtd = do_map_probe(subdev->plat->map_name, &subdev->map);
1da177e4 LT	117	if (subdev->mtd == NULL) {
	118	ret = -ENXIO;
	119	goto err;
	120	}
1da177e4	121
794d579a RK	122	printk(KERN_INFO "SA1100 flash: CFI device at 0x%08lx, %uMiB, %d-bit\n",
794d579a RK	123	phys, (unsigned)(subdev->mtd->size >> 20),
1da177e4 LT	124	subdev->map.bankwidth * 8);
	125
	126	return 0;
	127
	128	err:
	129	sa1100_destroy_subdev(subdev);
	130	out:
	131	return ret;
	132	}
	133
0d2ef7d7	134	static void sa1100_destroy(struct sa_info info, struct flash_platform_data plat)
1da177e4 LT	135	{
	136	int i;
	137
	138	if (info->mtd) {
2fe2e24e	139	mtd_device_unregister(info->mtd);
1da177e4 LT	140	if (info->mtd != info->subdev[0].mtd)
1da177e4 LT	141	mtd_concat_destroy(info->mtd);
1da177e4 LT	142	}
1da177e4 LT	143
1da177e4 LT	144	for (i = info->num_subdev - 1; i >= 0; i--)
	145	sa1100_destroy_subdev(&info->subdev[i]);
	146	kfree(info);
0d2ef7d7 RK	147
	148	if (plat->exit)
	149	plat->exit();
1da177e4 LT	150	}
1da177e4 LT	151
7bf350b7 AB	152	static struct sa_info sa1100_setup_mtd(struct platform_device pdev,
7bf350b7 AB	153	struct flash_platform_data *plat)
1da177e4 LT	154	{
	155	struct sa_info *info;
	156	int nr, size, i, ret = 0;
	157
	158	/*
	159	* Count number of devices.
	160	*/
	161	for (nr = 0; ; nr++)
	162	if (!platform_get_resource(pdev, IORESOURCE_MEM, nr))
	163	break;
	164
	165	if (nr == 0) {
	166	ret = -ENODEV;
	167	goto out;
	168	}
	169
	170	size = sizeof(struct sa_info) + sizeof(struct sa_subdev_info) * nr;
	171
	172	/*
	173	* Allocate the map_info structs in one go.
	174	*/
95b93a0c	175	info = kzalloc(size, GFP_KERNEL);
1da177e4 LT	176	if (!info) {
	177	ret = -ENOMEM;
	178	goto out;
	179	}
	180
0d2ef7d7 RK	181	if (plat->init) {
	182	ret = plat->init();
	183	if (ret)
	184	goto err;
	185	}
	186
1da177e4 LT	187	/*
	188	* Claim and then map the memory regions.
	189	*/
	190	for (i = 0; i < nr; i++) {
	191	struct sa_subdev_info *subdev = &info->subdev[i];
	192	struct resource *res;
	193
	194	res = platform_get_resource(pdev, IORESOURCE_MEM, i);
	195	if (!res)
	196	break;
	197
	198	subdev->map.name = subdev->name;
14e66f76	199	sprintf(subdev->name, "%s-%d", plat->name, i);
57725f0a	200	subdev->plat = plat;
1da177e4 LT	201
	202	ret = sa1100_probe_subdev(subdev, res);
	203	if (ret)
	204	break;
	205	}
	206
	207	info->num_subdev = i;
	208
	209	/*
	210	* ENXIO is special. It means we didn't find a chip when we probed.
	211	*/
	212	if (ret != 0 && !(ret == -ENXIO && info->num_subdev > 0))
	213	goto err;
	214
	215	/*
	216	* If we found one device, don't bother with concat support. If
	217	* we found multiple devices, use concat if we have it available,
	218	* otherwise fail. Either way, it'll be called "sa1100".
	219	*/
	220	if (info->num_subdev == 1) {
14e66f76	221	strcpy(info->subdev[0].name, plat->name);
1da177e4 LT	222	info->mtd = info->subdev[0].mtd;
	223	ret = 0;
	224	} else if (info->num_subdev > 1) {
ba26cd7d BB	225	struct mtd_info **cdev;
	226
	227	cdev = kmalloc_array(nr, sizeof(*cdev), GFP_KERNEL);
	228	if (!cdev) {
	229	ret = -ENOMEM;
	230	goto err;
	231	}
	232
1da177e4 LT	233	/*
	234	* We detected multiple devices. Concatenate them together.
	235	*/
	236	for (i = 0; i < info->num_subdev; i++)
	237	cdev[i] = info->subdev[i].mtd;
	238
	239	info->mtd = mtd_concat_create(cdev, info->num_subdev,
14e66f76	240	plat->name);
ba26cd7d	241	kfree(cdev);
dc01a28d	242	if (info->mtd == NULL) {
1da177e4	243	ret = -ENXIO;
dc01a28d DC	244	goto err;
dc01a28d DC	245	}
1da177e4	246	}
72169755	247	info->mtd->dev.parent = &pdev->dev;
1da177e4 LT	248
	249	if (ret == 0)
	250	return info;
	251
	252	err:
0d2ef7d7	253	sa1100_destroy(info, plat);
1da177e4 LT	254	out:
	255	return ERR_PTR(ret);
	256	}
	257
0984c891	258	static const char * const part_probes[] = { "cmdlinepart", "RedBoot", NULL };
1da177e4	259
06f25510	260	static int sa1100_mtd_probe(struct platform_device *pdev)
1da177e4	261	{
d20d5a57	262	struct flash_platform_data *plat = dev_get_platdata(&pdev->dev);
1da177e4	263	struct sa_info *info;
769dc431	264	int err;
1da177e4	265
57725f0a	266	if (!plat)
1da177e4 LT	267	return -ENODEV;
1da177e4 LT	268
57725f0a	269	info = sa1100_setup_mtd(pdev, plat);
1da177e4 LT	270	if (IS_ERR(info)) {
	271	err = PTR_ERR(info);
	272	goto out;
	273	}
	274
	275	/*
	276	* Partition selection stuff.
	277	*/
42d7fbe2 AB	278	mtd_device_parse_register(info->mtd, part_probes, NULL, plat->parts,
42d7fbe2 AB	279	plat->nr_parts);
822e5e72	280
3ae5eaec	281	platform_set_drvdata(pdev, info);
1da177e4 LT	282	err = 0;
	283
	284	out:
	285	return err;
	286	}
	287
271afb4c	288	static int sa1100_mtd_remove(struct platform_device *pdev)
1da177e4	289	{
3ae5eaec	290	struct sa_info *info = platform_get_drvdata(pdev);
d20d5a57	291	struct flash_platform_data *plat = dev_get_platdata(&pdev->dev);
0d2ef7d7	292
0d2ef7d7 RK	293	sa1100_destroy(info, plat);
0d2ef7d7 RK	294
1da177e4 LT	295	return 0;
	296	}
	297
3ae5eaec	298	static struct platform_driver sa1100_mtd_driver = {
1da177e4	299	.probe = sa1100_mtd_probe,
271afb4c	300	.remove = sa1100_mtd_remove,
3ae5eaec	301	.driver = {
bcc8f3e0	302	.name = "sa1100-mtd",
3ae5eaec	303	},
1da177e4 LT	304	};
1da177e4 LT	305
f99640de	306	module_platform_driver(sa1100_mtd_driver);
1da177e4 LT	307
	308	MODULE_AUTHOR("Nicolas Pitre");
	309	MODULE_DESCRIPTION("SA1100 CFI map driver");
	310	MODULE_LICENSE("GPL");
bcc8f3e0	311	MODULE_ALIAS("platform:sa1100-mtd");