[linux-2.6-block.git] / drivers / mfd / mfd-core.c

/*
 * drivers/mfd/mfd-core.c
 *
 * core MFD support
 * Copyright (c) 2006 Ian Molton
 * Copyright (c) 2007,2008 Dmitry Baryshkov
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 */

#include <linux/kernel.h>
#include <linux/platform_device.h>
#include <linux/acpi.h>
#include <linux/mfd/core.h>
#include <linux/pm_runtime.h>
#include <linux/slab.h>
#include <linux/module.h>
#include <linux/irqdomain.h>
#include <linux/of.h>
#include <linux/regulator/consumer.h>

static struct device_type mfd_dev_type = {
	.name	= "mfd_device",
};

int mfd_cell_enable(struct platform_device *pdev)
{
	const struct mfd_cell *cell = mfd_get_cell(pdev);
	int err = 0;

	/* only call enable hook if the cell wasn't previously enabled */
	if (atomic_inc_return(cell->usage_count) == 1)
		err = cell->enable(pdev);

	/* if the enable hook failed, decrement counter to allow retries */
	if (err)
		atomic_dec(cell->usage_count);

	return err;
}
EXPORT_SYMBOL(mfd_cell_enable);

int mfd_cell_disable(struct platform_device *pdev)
{
	const struct mfd_cell *cell = mfd_get_cell(pdev);
	int err = 0;

	/* only disable if no other clients are using it */
	if (atomic_dec_return(cell->usage_count) == 0)
		err = cell->disable(pdev);

	/* if the disable hook failed, increment to allow retries */
	if (err)
		atomic_inc(cell->usage_count);

	/* sanity check; did someone call disable too many times? */
	WARN_ON(atomic_read(cell->usage_count) < 0);

	return err;
}
EXPORT_SYMBOL(mfd_cell_disable);

static int mfd_platform_add_cell(struct platform_device *pdev,
				 const struct mfd_cell *cell,
				 atomic_t *usage_count)
{
	if (!cell)
		return 0;

	pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
	if (!pdev->mfd_cell)
		return -ENOMEM;

	pdev->mfd_cell->usage_count = usage_count;
	return 0;
}

#if IS_ENABLED(CONFIG_ACPI)
static void mfd_acpi_add_device(const struct mfd_cell *cell,
				struct platform_device *pdev)
{
	struct acpi_device *parent_adev;
	struct acpi_device *adev;

	parent_adev = ACPI_COMPANION(pdev->dev.parent);
	if (!parent_adev)
		return;

	/*
	 * MFD child device gets its ACPI handle either from the ACPI
	 * device directly under the parent that matches the acpi_pnpid or
	 * it will use the parent handle if is no acpi_pnpid is given.
	 */
	adev = parent_adev;
	if (cell->acpi_pnpid) {
		struct acpi_device_id ids[2] = {};
		struct acpi_device *child_adev;

		strlcpy(ids[0].id, cell->acpi_pnpid, sizeof(ids[0].id));
		list_for_each_entry(child_adev, &parent_adev->children, node)
			if (acpi_match_device_ids(child_adev, ids)) {
				adev = child_adev;
				break;
			}
	}

	ACPI_COMPANION_SET(&pdev->dev, adev);
}
#else
static inline void mfd_acpi_add_device(const struct mfd_cell *cell,
				       struct platform_device *pdev)
{
}
#endif

static int mfd_add_device(struct device *parent, int id,
			  const struct mfd_cell *cell, atomic_t *usage_count,
			  struct resource *mem_base,
			  int irq_base, struct irq_domain *domain)
{
	struct resource *res;
	struct platform_device *pdev;
	struct device_node *np = NULL;
	int ret = -ENOMEM;
	int platform_id;
	int r;

	if (id == PLATFORM_DEVID_AUTO)
		platform_id = id;
	else
		platform_id = id + cell->id;

	pdev = platform_device_alloc(cell->name, platform_id);
	if (!pdev)
		goto fail_alloc;

	res = kzalloc(sizeof(*res) * cell->num_resources, GFP_KERNEL);
	if (!res)
		goto fail_device;

	pdev->dev.parent = parent;
	pdev->dev.type = &mfd_dev_type;
	pdev->dev.dma_mask = parent->dma_mask;
	pdev->dev.dma_parms = parent->dma_parms;
	pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;

	ret = regulator_bulk_register_supply_alias(
			&pdev->dev, cell->parent_supplies,
			parent, cell->parent_supplies,
			cell->num_parent_supplies);
	if (ret < 0)
		goto fail_res;

	if (parent->of_node && cell->of_compatible) {
		for_each_child_of_node(parent->of_node, np) {
			if (of_device_is_compatible(np, cell->of_compatible)) {
				pdev->dev.of_node = np;
				break;
			}
		}
	}

	mfd_acpi_add_device(cell, pdev);

	if (cell->pdata_size) {
		ret = platform_device_add_data(pdev,
					cell->platform_data, cell->pdata_size);
		if (ret)
			goto fail_alias;
	}

	ret = mfd_platform_add_cell(pdev, cell, usage_count);
	if (ret)
		goto fail_alias;

	for (r = 0; r < cell->num_resources; r++) {
		res[r].name = cell->resources[r].name;
		res[r].flags = cell->resources[r].flags;

		/* Find out base to use */
		if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
			res[r].parent = mem_base;
			res[r].start = mem_base->start +
				cell->resources[r].start;
			res[r].end = mem_base->start +
				cell->resources[r].end;
		} else if (cell->resources[r].flags & IORESOURCE_IRQ) {
			if (domain) {
				/* Unable to create mappings for IRQ ranges. */
				WARN_ON(cell->resources[r].start !=
					cell->resources[r].end);
				res[r].start = res[r].end = irq_create_mapping(
					domain, cell->resources[r].start);
			} else {
				res[r].start = irq_base +
					cell->resources[r].start;
				res[r].end   = irq_base +
					cell->resources[r].end;
			}
		} else {
			res[r].parent = cell->resources[r].parent;
			res[r].start = cell->resources[r].start;
			res[r].end   = cell->resources[r].end;
		}

		if (!cell->ignore_resource_conflicts) {
			if (has_acpi_companion(&pdev->dev)) {
				ret = acpi_check_resource_conflict(&res[r]);
				if (ret)
					goto fail_alias;
			}
		}
	}

	ret = platform_device_add_resources(pdev, res, cell->num_resources);
	if (ret)
		goto fail_alias;

	ret = platform_device_add(pdev);
	if (ret)
		goto fail_alias;

	if (cell->pm_runtime_no_callbacks)
		pm_runtime_no_callbacks(&pdev->dev);

	kfree(res);

	return 0;

fail_alias:
	regulator_bulk_unregister_supply_alias(&pdev->dev,
					       cell->parent_supplies,
					       cell->num_parent_supplies);
fail_res:
	kfree(res);
fail_device:
	platform_device_put(pdev);
fail_alloc:
	return ret;
}

int mfd_add_devices(struct device *parent, int id,
		    const struct mfd_cell *cells, int n_devs,
		    struct resource *mem_base,
		    int irq_base, struct irq_domain *domain)
{
	int i;
	int ret;
	atomic_t *cnts;

	/* initialize reference counting for all cells */
	cnts = kcalloc(n_devs, sizeof(*cnts), GFP_KERNEL);
	if (!cnts)
		return -ENOMEM;

	for (i = 0; i < n_devs; i++) {
		atomic_set(&cnts[i], 0);
		ret = mfd_add_device(parent, id, cells + i, cnts + i, mem_base,
				     irq_base, domain);
		if (ret)
			goto fail;
	}

	return 0;

fail:
	if (i)
		mfd_remove_devices(parent);
	else
		kfree(cnts);
	return ret;
}
EXPORT_SYMBOL(mfd_add_devices);

static int mfd_remove_devices_fn(struct device *dev, void *c)
{
	struct platform_device *pdev;
	const struct mfd_cell *cell;
	atomic_t **usage_count = c;

	if (dev->type != &mfd_dev_type)
		return 0;

	pdev = to_platform_device(dev);
	cell = mfd_get_cell(pdev);

	regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
					       cell->num_parent_supplies);

	/* find the base address of usage_count pointers (for freeing) */
	if (!*usage_count || (cell->usage_count < *usage_count))
		*usage_count = cell->usage_count;

	platform_device_unregister(pdev);
	return 0;
}

void mfd_remove_devices(struct device *parent)
{
	atomic_t *cnts = NULL;

	device_for_each_child_reverse(parent, &cnts, mfd_remove_devices_fn);
	kfree(cnts);
}
EXPORT_SYMBOL(mfd_remove_devices);

int mfd_clone_cell(const char *cell, const char **clones, size_t n_clones)
{
	struct mfd_cell cell_entry;
	struct device *dev;
	struct platform_device *pdev;
	int i;

	/* fetch the parent cell's device (should already be registered!) */
	dev = bus_find_device_by_name(&platform_bus_type, NULL, cell);
	if (!dev) {
		printk(KERN_ERR "failed to find device for cell %s\n", cell);
		return -ENODEV;
	}
	pdev = to_platform_device(dev);
	memcpy(&cell_entry, mfd_get_cell(pdev), sizeof(cell_entry));

	WARN_ON(!cell_entry.enable);

	for (i = 0; i < n_clones; i++) {
		cell_entry.name = clones[i];
		/* don't give up if a single call fails; just report error */
		if (mfd_add_device(pdev->dev.parent, -1, &cell_entry,
				   cell_entry.usage_count, NULL, 0, NULL))
			dev_err(dev, "failed to create platform device '%s'\n",
					clones[i]);
	}

	return 0;
}
EXPORT_SYMBOL(mfd_clone_cell);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");
Commit	Line	Data
aa613de6 DB	1	/*
	2	* drivers/mfd/mfd-core.c
	3	*
	4	* core MFD support
	5	* Copyright (c) 2006 Ian Molton
	6	* Copyright (c) 2007,2008 Dmitry Baryshkov
	7	*
	8	* This program is free software; you can redistribute it and/or modify
	9	* it under the terms of the GNU General Public License version 2 as
	10	* published by the Free Software Foundation.
	11	*
	12	*/
	13
	14	#include <linux/kernel.h>
	15	#include <linux/platform_device.h>
91fedede	16	#include <linux/acpi.h>
aa613de6	17	#include <linux/mfd/core.h>
4c90aa94	18	#include <linux/pm_runtime.h>
5a0e3ad6	19	#include <linux/slab.h>
4e36dd33	20	#include <linux/module.h>
c94bb233 LJ	21	#include <linux/irqdomain.h>
c94bb233 LJ	22	#include <linux/of.h>
7fcd4274	23	#include <linux/regulator/consumer.h>
aa613de6	24
b9fbb62e CK	25	static struct device_type mfd_dev_type = {
	26	.name = "mfd_device",
	27	};
	28
f77289ac	29	int mfd_cell_enable(struct platform_device *pdev)
1e29af62 AS	30	{
	31	const struct mfd_cell *cell = mfd_get_cell(pdev);
	32	int err = 0;
	33
	34	/* only call enable hook if the cell wasn't previously enabled */
	35	if (atomic_inc_return(cell->usage_count) == 1)
	36	err = cell->enable(pdev);
	37
	38	/* if the enable hook failed, decrement counter to allow retries */
	39	if (err)
	40	atomic_dec(cell->usage_count);
	41
	42	return err;
	43	}
f77289ac	44	EXPORT_SYMBOL(mfd_cell_enable);
1e29af62	45
f77289ac	46	int mfd_cell_disable(struct platform_device *pdev)
1e29af62 AS	47	{
	48	const struct mfd_cell *cell = mfd_get_cell(pdev);
	49	int err = 0;
	50
	51	/* only disable if no other clients are using it */
	52	if (atomic_dec_return(cell->usage_count) == 0)
	53	err = cell->disable(pdev);
	54
	55	/* if the disable hook failed, increment to allow retries */
	56	if (err)
	57	atomic_inc(cell->usage_count);
	58
	59	/* sanity check; did someone call disable too many times? */
	60	WARN_ON(atomic_read(cell->usage_count) < 0);
	61
	62	return err;
	63	}
f77289ac	64	EXPORT_SYMBOL(mfd_cell_disable);
1e29af62	65
e710d7d5	66	static int mfd_platform_add_cell(struct platform_device *pdev,
03e361b2 GU	67	const struct mfd_cell *cell,
03e361b2 GU	68	atomic_t *usage_count)
e710d7d5 SO	69	{
	70	if (!cell)
	71	return 0;
	72
	73	pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
	74	if (!pdev->mfd_cell)
	75	return -ENOMEM;
	76
03e361b2	77	pdev->mfd_cell->usage_count = usage_count;
e710d7d5 SO	78	return 0;
	79	}
	80
6ab34301 MW	81	#if IS_ENABLED(CONFIG_ACPI)
	82	static void mfd_acpi_add_device(const struct mfd_cell *cell,
	83	struct platform_device *pdev)
	84	{
	85	struct acpi_device *parent_adev;
	86	struct acpi_device *adev;
	87
	88	parent_adev = ACPI_COMPANION(pdev->dev.parent);
	89	if (!parent_adev)
	90	return;
	91
	92	/*
	93	* MFD child device gets its ACPI handle either from the ACPI
	94	* device directly under the parent that matches the acpi_pnpid or
	95	* it will use the parent handle if is no acpi_pnpid is given.
	96	*/
	97	adev = parent_adev;
	98	if (cell->acpi_pnpid) {
	99	struct acpi_device_id ids[2] = {};
	100	struct acpi_device *child_adev;
	101
	102	strlcpy(ids[0].id, cell->acpi_pnpid, sizeof(ids[0].id));
	103	list_for_each_entry(child_adev, &parent_adev->children, node)
	104	if (acpi_match_device_ids(child_adev, ids)) {
	105	adev = child_adev;
	106	break;
	107	}
	108	}
	109
	110	ACPI_COMPANION_SET(&pdev->dev, adev);
	111	}
	112	#else
	113	static inline void mfd_acpi_add_device(const struct mfd_cell *cell,
	114	struct platform_device *pdev)
	115	{
	116	}
	117	#endif
	118
424f525a	119	static int mfd_add_device(struct device *parent, int id,
03e361b2	120	const struct mfd_cell cell, atomic_t usage_count,
7f71ac93	121	struct resource *mem_base,
0848c94f	122	int irq_base, struct irq_domain *domain)
aa613de6	123	{
a87903f3	124	struct resource *res;
aa613de6	125	struct platform_device *pdev;
c94bb233	126	struct device_node *np = NULL;
aa613de6	127	int ret = -ENOMEM;
6e3f62f0	128	int platform_id;
aa613de6 DB	129	int r;
aa613de6 DB	130
a77c50b4	131	if (id == PLATFORM_DEVID_AUTO)
6e3f62f0 JH	132	platform_id = id;
	133	else
	134	platform_id = id + cell->id;
	135
	136	pdev = platform_device_alloc(cell->name, platform_id);
aa613de6 DB	137	if (!pdev)
	138	goto fail_alloc;
	139
a87903f3 IM	140	res = kzalloc(sizeof(res) cell->num_resources, GFP_KERNEL);
	141	if (!res)
	142	goto fail_device;
	143
424f525a	144	pdev->dev.parent = parent;
b9fbb62e	145	pdev->dev.type = &mfd_dev_type;
b018e136 BS	146	pdev->dev.dma_mask = parent->dma_mask;
b018e136 BS	147	pdev->dev.dma_parms = parent->dma_parms;
4f08df1b	148	pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
aa613de6	149
d137be00	150	ret = regulator_bulk_register_supply_alias(
7fcd4274 CK	151	&pdev->dev, cell->parent_supplies,
	152	parent, cell->parent_supplies,
	153	cell->num_parent_supplies);
	154	if (ret < 0)
	155	goto fail_res;
	156
c94bb233 LJ	157	if (parent->of_node && cell->of_compatible) {
	158	for_each_child_of_node(parent->of_node, np) {
	159	if (of_device_is_compatible(np, cell->of_compatible)) {
	160	pdev->dev.of_node = np;
c94bb233 LJ	161	break;
	162	}
	163	}
	164	}
	165
6ab34301 MW	166	mfd_acpi_add_device(cell, pdev);
6ab34301 MW	167
eb895607 SO	168	if (cell->pdata_size) {
	169	ret = platform_device_add_data(pdev,
	170	cell->platform_data, cell->pdata_size);
	171	if (ret)
7fcd4274	172	goto fail_alias;
eb895607 SO	173	}
eb895607 SO	174
03e361b2	175	ret = mfd_platform_add_cell(pdev, cell, usage_count);
fe891a00	176	if (ret)
7fcd4274	177	goto fail_alias;
aa613de6	178
aa613de6 DB	179	for (r = 0; r < cell->num_resources; r++) {
	180	res[r].name = cell->resources[r].name;
	181	res[r].flags = cell->resources[r].flags;
	182
	183	/* Find out base to use */
f03cfcbc	184	if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
aa613de6 DB	185	res[r].parent = mem_base;
	186	res[r].start = mem_base->start +
	187	cell->resources[r].start;
	188	res[r].end = mem_base->start +
	189	cell->resources[r].end;
	190	} else if (cell->resources[r].flags & IORESOURCE_IRQ) {
c94bb233 LJ	191	if (domain) {
	192	/* Unable to create mappings for IRQ ranges. */
	193	WARN_ON(cell->resources[r].start !=
	194	cell->resources[r].end);
	195	res[r].start = res[r].end = irq_create_mapping(
	196	domain, cell->resources[r].start);
	197	} else {
	198	res[r].start = irq_base +
	199	cell->resources[r].start;
	200	res[r].end = irq_base +
	201	cell->resources[r].end;
	202	}
aa613de6 DB	203	} else {
	204	res[r].parent = cell->resources[r].parent;
	205	res[r].start = cell->resources[r].start;
	206	res[r].end = cell->resources[r].end;
	207	}
91fedede	208
5f2545fa	209	if (!cell->ignore_resource_conflicts) {
ec40c606 LP	210	if (has_acpi_companion(&pdev->dev)) {
	211	ret = acpi_check_resource_conflict(&res[r]);
	212	if (ret)
	213	goto fail_alias;
	214	}
5f2545fa	215	}
aa613de6 DB	216	}
aa613de6 DB	217
8af5fe3b AL	218	ret = platform_device_add_resources(pdev, res, cell->num_resources);
8af5fe3b AL	219	if (ret)
7fcd4274	220	goto fail_alias;
aa613de6 DB	221
	222	ret = platform_device_add(pdev);
	223	if (ret)
7fcd4274	224	goto fail_alias;
a87903f3	225
4c90aa94 MB	226	if (cell->pm_runtime_no_callbacks)
	227	pm_runtime_no_callbacks(&pdev->dev);
	228
a87903f3	229	kfree(res);
aa613de6 DB	230
	231	return 0;
	232
7fcd4274	233	fail_alias:
d137be00 CK	234	regulator_bulk_unregister_supply_alias(&pdev->dev,
	235	cell->parent_supplies,
	236	cell->num_parent_supplies);
a87903f3 IM	237	fail_res:
a87903f3 IM	238	kfree(res);
aa613de6 DB	239	fail_device:
	240	platform_device_put(pdev);
	241	fail_alloc:
	242	return ret;
	243	}
	244
424f525a	245	int mfd_add_devices(struct device *parent, int id,
03e361b2	246	const struct mfd_cell *cells, int n_devs,
7f71ac93	247	struct resource *mem_base,
0848c94f	248	int irq_base, struct irq_domain *domain)
aa613de6 DB	249	{
aa613de6 DB	250	int i;
0b208e41	251	int ret;
1e29af62 AS	252	atomic_t *cnts;
	253
	254	/* initialize reference counting for all cells */
d1b5c5e2	255	cnts = kcalloc(n_devs, sizeof(*cnts), GFP_KERNEL);
1e29af62 AS	256	if (!cnts)
1e29af62 AS	257	return -ENOMEM;
aa613de6 DB	258
aa613de6 DB	259	for (i = 0; i < n_devs; i++) {
1e29af62	260	atomic_set(&cnts[i], 0);
03e361b2	261	ret = mfd_add_device(parent, id, cells + i, cnts + i, mem_base,
0848c94f	262	irq_base, domain);
aa613de6	263	if (ret)
0b208e41	264	goto fail;
aa613de6 DB	265	}
aa613de6 DB	266
0b208e41	267	return 0;
aa613de6	268
0b208e41 GU	269	fail:
	270	if (i)
	271	mfd_remove_devices(parent);
	272	else
	273	kfree(cnts);
aa613de6 DB	274	return ret;
	275	}
	276	EXPORT_SYMBOL(mfd_add_devices);
	277
1e29af62	278	static int mfd_remove_devices_fn(struct device dev, void c)
aa613de6	279	{
b9fbb62e CK	280	struct platform_device *pdev;
b9fbb62e CK	281	const struct mfd_cell *cell;
1e29af62 AS	282	atomic_t **usage_count = c;
1e29af62 AS	283
b9fbb62e CK	284	if (dev->type != &mfd_dev_type)
	285	return 0;
	286
	287	pdev = to_platform_device(dev);
	288	cell = mfd_get_cell(pdev);
	289
d137be00 CK	290	regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
	291	cell->num_parent_supplies);
	292
1e29af62 AS	293	/* find the base address of usage_count pointers (for freeing) */
	294	if (!usage_count \|\| (cell->usage_count < usage_count))
	295	*usage_count = cell->usage_count;
	296
	297	platform_device_unregister(pdev);
aa613de6 DB	298	return 0;
	299	}
	300
424f525a	301	void mfd_remove_devices(struct device *parent)
aa613de6	302	{
1e29af62 AS	303	atomic_t *cnts = NULL;
1e29af62 AS	304
b9a8a271	305	device_for_each_child_reverse(parent, &cnts, mfd_remove_devices_fn);
1e29af62	306	kfree(cnts);
aa613de6 DB	307	}
	308	EXPORT_SYMBOL(mfd_remove_devices);
	309
fa1df691	310	int mfd_clone_cell(const char cell, const char *clones, size_t n_clones)
a9bbba99 AS	311	{
	312	struct mfd_cell cell_entry;
	313	struct device *dev;
	314	struct platform_device *pdev;
fa1df691	315	int i;
a9bbba99 AS	316
	317	/* fetch the parent cell's device (should already be registered!) */
	318	dev = bus_find_device_by_name(&platform_bus_type, NULL, cell);
	319	if (!dev) {
	320	printk(KERN_ERR "failed to find device for cell %s\n", cell);
	321	return -ENODEV;
	322	}
	323	pdev = to_platform_device(dev);
	324	memcpy(&cell_entry, mfd_get_cell(pdev), sizeof(cell_entry));
	325
	326	WARN_ON(!cell_entry.enable);
	327
fa1df691 AS	328	for (i = 0; i < n_clones; i++) {
	329	cell_entry.name = clones[i];
	330	/* don't give up if a single call fails; just report error */
03e361b2 GU	331	if (mfd_add_device(pdev->dev.parent, -1, &cell_entry,
03e361b2 GU	332	cell_entry.usage_count, NULL, 0, NULL))
fa1df691 AS	333	dev_err(dev, "failed to create platform device '%s'\n",
	334	clones[i]);
	335	}
a9bbba99	336
fa1df691	337	return 0;
a9bbba99	338	}
fa1df691	339	EXPORT_SYMBOL(mfd_clone_cell);
a9bbba99	340
aa613de6 DB	341	MODULE_LICENSE("GPL");
aa613de6 DB	342	MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");