[deliverable/linux.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 r;

	pdev = platform_device_alloc(cell->name, id + cell->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) {
			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(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 DB	127	int ret = -ENOMEM;
	128	int r;
	129
3bed6e41	130	pdev = platform_device_alloc(cell->name, id + cell->id);
aa613de6 DB	131	if (!pdev)
	132	goto fail_alloc;
	133
a87903f3 IM	134	res = kzalloc(sizeof(res) cell->num_resources, GFP_KERNEL);
	135	if (!res)
	136	goto fail_device;
	137
424f525a	138	pdev->dev.parent = parent;
b9fbb62e	139	pdev->dev.type = &mfd_dev_type;
b018e136 BS	140	pdev->dev.dma_mask = parent->dma_mask;
b018e136 BS	141	pdev->dev.dma_parms = parent->dma_parms;
4f08df1b	142	pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
aa613de6	143
d137be00	144	ret = regulator_bulk_register_supply_alias(
7fcd4274 CK	145	&pdev->dev, cell->parent_supplies,
	146	parent, cell->parent_supplies,
	147	cell->num_parent_supplies);
	148	if (ret < 0)
	149	goto fail_res;
	150
c94bb233 LJ	151	if (parent->of_node && cell->of_compatible) {
	152	for_each_child_of_node(parent->of_node, np) {
	153	if (of_device_is_compatible(np, cell->of_compatible)) {
	154	pdev->dev.of_node = np;
c94bb233 LJ	155	break;
	156	}
	157	}
	158	}
	159
6ab34301 MW	160	mfd_acpi_add_device(cell, pdev);
6ab34301 MW	161
eb895607 SO	162	if (cell->pdata_size) {
	163	ret = platform_device_add_data(pdev,
	164	cell->platform_data, cell->pdata_size);
	165	if (ret)
7fcd4274	166	goto fail_alias;
eb895607 SO	167	}
eb895607 SO	168
03e361b2	169	ret = mfd_platform_add_cell(pdev, cell, usage_count);
fe891a00	170	if (ret)
7fcd4274	171	goto fail_alias;
aa613de6	172
aa613de6 DB	173	for (r = 0; r < cell->num_resources; r++) {
	174	res[r].name = cell->resources[r].name;
	175	res[r].flags = cell->resources[r].flags;
	176
	177	/* Find out base to use */
f03cfcbc	178	if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
aa613de6 DB	179	res[r].parent = mem_base;
	180	res[r].start = mem_base->start +
	181	cell->resources[r].start;
	182	res[r].end = mem_base->start +
	183	cell->resources[r].end;
	184	} else if (cell->resources[r].flags & IORESOURCE_IRQ) {
c94bb233 LJ	185	if (domain) {
	186	/* Unable to create mappings for IRQ ranges. */
	187	WARN_ON(cell->resources[r].start !=
	188	cell->resources[r].end);
	189	res[r].start = res[r].end = irq_create_mapping(
	190	domain, cell->resources[r].start);
	191	} else {
	192	res[r].start = irq_base +
	193	cell->resources[r].start;
	194	res[r].end = irq_base +
	195	cell->resources[r].end;
	196	}
aa613de6 DB	197	} else {
	198	res[r].parent = cell->resources[r].parent;
	199	res[r].start = cell->resources[r].start;
	200	res[r].end = cell->resources[r].end;
	201	}
91fedede	202
5f2545fa	203	if (!cell->ignore_resource_conflicts) {
855cc454	204	ret = acpi_check_resource_conflict(&res[r]);
5f2545fa	205	if (ret)
7fcd4274	206	goto fail_alias;
5f2545fa	207	}
aa613de6 DB	208	}
aa613de6 DB	209
8af5fe3b AL	210	ret = platform_device_add_resources(pdev, res, cell->num_resources);
8af5fe3b AL	211	if (ret)
7fcd4274	212	goto fail_alias;
aa613de6 DB	213
	214	ret = platform_device_add(pdev);
	215	if (ret)
7fcd4274	216	goto fail_alias;
a87903f3	217
4c90aa94 MB	218	if (cell->pm_runtime_no_callbacks)
	219	pm_runtime_no_callbacks(&pdev->dev);
	220
a87903f3	221	kfree(res);
aa613de6 DB	222
	223	return 0;
	224
7fcd4274	225	fail_alias:
d137be00 CK	226	regulator_bulk_unregister_supply_alias(&pdev->dev,
	227	cell->parent_supplies,
	228	cell->num_parent_supplies);
a87903f3 IM	229	fail_res:
a87903f3 IM	230	kfree(res);
aa613de6 DB	231	fail_device:
	232	platform_device_put(pdev);
	233	fail_alloc:
	234	return ret;
	235	}
	236
424f525a	237	int mfd_add_devices(struct device *parent, int id,
03e361b2	238	const struct mfd_cell *cells, int n_devs,
7f71ac93	239	struct resource *mem_base,
0848c94f	240	int irq_base, struct irq_domain *domain)
aa613de6 DB	241	{
aa613de6 DB	242	int i;
0b208e41	243	int ret;
1e29af62 AS	244	atomic_t *cnts;
	245
	246	/* initialize reference counting for all cells */
d1b5c5e2	247	cnts = kcalloc(n_devs, sizeof(*cnts), GFP_KERNEL);
1e29af62 AS	248	if (!cnts)
1e29af62 AS	249	return -ENOMEM;
aa613de6 DB	250
aa613de6 DB	251	for (i = 0; i < n_devs; i++) {
1e29af62	252	atomic_set(&cnts[i], 0);
03e361b2	253	ret = mfd_add_device(parent, id, cells + i, cnts + i, mem_base,
0848c94f	254	irq_base, domain);
aa613de6	255	if (ret)
0b208e41	256	goto fail;
aa613de6 DB	257	}
aa613de6 DB	258
0b208e41	259	return 0;
aa613de6	260
0b208e41 GU	261	fail:
	262	if (i)
	263	mfd_remove_devices(parent);
	264	else
	265	kfree(cnts);
aa613de6 DB	266	return ret;
	267	}
	268	EXPORT_SYMBOL(mfd_add_devices);
	269
1e29af62	270	static int mfd_remove_devices_fn(struct device dev, void c)
aa613de6	271	{
b9fbb62e CK	272	struct platform_device *pdev;
b9fbb62e CK	273	const struct mfd_cell *cell;
1e29af62 AS	274	atomic_t **usage_count = c;
1e29af62 AS	275
b9fbb62e CK	276	if (dev->type != &mfd_dev_type)
	277	return 0;
	278
	279	pdev = to_platform_device(dev);
	280	cell = mfd_get_cell(pdev);
	281
d137be00 CK	282	regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
	283	cell->num_parent_supplies);
	284
1e29af62 AS	285	/* find the base address of usage_count pointers (for freeing) */
	286	if (!usage_count \|\| (cell->usage_count < usage_count))
	287	*usage_count = cell->usage_count;
	288
	289	platform_device_unregister(pdev);
aa613de6 DB	290	return 0;
	291	}
	292
424f525a	293	void mfd_remove_devices(struct device *parent)
aa613de6	294	{
1e29af62 AS	295	atomic_t *cnts = NULL;
	296
	297	device_for_each_child(parent, &cnts, mfd_remove_devices_fn);
	298	kfree(cnts);
aa613de6 DB	299	}
	300	EXPORT_SYMBOL(mfd_remove_devices);
	301
fa1df691	302	int mfd_clone_cell(const char cell, const char *clones, size_t n_clones)
a9bbba99 AS	303	{
	304	struct mfd_cell cell_entry;
	305	struct device *dev;
	306	struct platform_device *pdev;
fa1df691	307	int i;
a9bbba99 AS	308
	309	/* fetch the parent cell's device (should already be registered!) */
	310	dev = bus_find_device_by_name(&platform_bus_type, NULL, cell);
	311	if (!dev) {
	312	printk(KERN_ERR "failed to find device for cell %s\n", cell);
	313	return -ENODEV;
	314	}
	315	pdev = to_platform_device(dev);
	316	memcpy(&cell_entry, mfd_get_cell(pdev), sizeof(cell_entry));
	317
	318	WARN_ON(!cell_entry.enable);
	319
fa1df691 AS	320	for (i = 0; i < n_clones; i++) {
	321	cell_entry.name = clones[i];
	322	/* don't give up if a single call fails; just report error */
03e361b2 GU	323	if (mfd_add_device(pdev->dev.parent, -1, &cell_entry,
03e361b2 GU	324	cell_entry.usage_count, NULL, 0, NULL))
fa1df691 AS	325	dev_err(dev, "failed to create platform device '%s'\n",
	326	clones[i]);
	327	}
a9bbba99	328
fa1df691	329	return 0;
a9bbba99	330	}
fa1df691	331	EXPORT_SYMBOL(mfd_clone_cell);
a9bbba99	332
aa613de6 DB	333	MODULE_LICENSE("GPL");
aa613de6 DB	334	MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");