blob: 3ac486a597f3c31e8e362f1f9954098cdf081086 [file] [log] [blame]
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +01001/*
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>
Samuel Ortiz91feded2010-02-19 11:07:59 +010016#include <linux/acpi.h>
Andy Shevchenko4d215ca2015-11-30 17:11:40 +020017#include <linux/property.h>
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010018#include <linux/mfd/core.h>
Mark Brown4c90aa92010-11-26 17:19:34 +000019#include <linux/pm_runtime.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090020#include <linux/slab.h>
Paul Gortmaker4e36dd32011-07-03 15:13:27 -040021#include <linux/module.h>
Lee Jonesc94bb232012-06-29 19:01:03 +020022#include <linux/irqdomain.h>
23#include <linux/of.h>
Charles Keepax7fcd4272013-10-15 20:14:21 +010024#include <linux/regulator/consumer.h>
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +010025
Charles Keepaxb9fbb622012-11-09 16:15:28 +000026static struct device_type mfd_dev_type = {
27 .name = "mfd_device",
28};
29
Andres Salomonf77289a2011-03-03 09:51:58 -080030int mfd_cell_enable(struct platform_device *pdev)
Andres Salomon1e29af62011-02-17 19:07:34 -080031{
32 const struct mfd_cell *cell = mfd_get_cell(pdev);
33 int err = 0;
34
35 /* only call enable hook if the cell wasn't previously enabled */
36 if (atomic_inc_return(cell->usage_count) == 1)
37 err = cell->enable(pdev);
38
39 /* if the enable hook failed, decrement counter to allow retries */
40 if (err)
41 atomic_dec(cell->usage_count);
42
43 return err;
44}
Andres Salomonf77289a2011-03-03 09:51:58 -080045EXPORT_SYMBOL(mfd_cell_enable);
Andres Salomon1e29af62011-02-17 19:07:34 -080046
Andres Salomonf77289a2011-03-03 09:51:58 -080047int mfd_cell_disable(struct platform_device *pdev)
Andres Salomon1e29af62011-02-17 19:07:34 -080048{
49 const struct mfd_cell *cell = mfd_get_cell(pdev);
50 int err = 0;
51
52 /* only disable if no other clients are using it */
53 if (atomic_dec_return(cell->usage_count) == 0)
54 err = cell->disable(pdev);
55
56 /* if the disable hook failed, increment to allow retries */
57 if (err)
58 atomic_inc(cell->usage_count);
59
60 /* sanity check; did someone call disable too many times? */
61 WARN_ON(atomic_read(cell->usage_count) < 0);
62
63 return err;
64}
Andres Salomonf77289a2011-03-03 09:51:58 -080065EXPORT_SYMBOL(mfd_cell_disable);
Andres Salomon1e29af62011-02-17 19:07:34 -080066
Samuel Ortize710d7d2011-04-08 00:43:01 +020067static int mfd_platform_add_cell(struct platform_device *pdev,
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +010068 const struct mfd_cell *cell,
69 atomic_t *usage_count)
Samuel Ortize710d7d2011-04-08 00:43:01 +020070{
71 if (!cell)
72 return 0;
73
74 pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
75 if (!pdev->mfd_cell)
76 return -ENOMEM;
77
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +010078 pdev->mfd_cell->usage_count = usage_count;
Samuel Ortize710d7d2011-04-08 00:43:01 +020079 return 0;
80}
81
Mika Westerberg6ab34302014-09-16 14:52:36 +030082#if IS_ENABLED(CONFIG_ACPI)
83static void mfd_acpi_add_device(const struct mfd_cell *cell,
84 struct platform_device *pdev)
85{
Andy Shevchenko98a3be42015-10-23 12:16:41 +030086 const struct mfd_cell_acpi_match *match = cell->acpi_match;
87 struct acpi_device *parent, *child;
Mika Westerberg6ab34302014-09-16 14:52:36 +030088 struct acpi_device *adev;
89
Andy Shevchenko98a3be42015-10-23 12:16:41 +030090 parent = ACPI_COMPANION(pdev->dev.parent);
91 if (!parent)
Mika Westerberg6ab34302014-09-16 14:52:36 +030092 return;
93
94 /*
Andy Shevchenko98a3be42015-10-23 12:16:41 +030095 * MFD child device gets its ACPI handle either from the ACPI device
96 * directly under the parent that matches the either _HID or _CID, or
97 * _ADR or it will use the parent handle if is no ID is given.
98 *
99 * Note that use of _ADR is a grey area in the ACPI specification,
100 * though Intel Galileo Gen2 is using it to distinguish the children
101 * devices.
Mika Westerberg6ab34302014-09-16 14:52:36 +0300102 */
Andy Shevchenko98a3be42015-10-23 12:16:41 +0300103 adev = parent;
104 if (match) {
105 if (match->pnpid) {
106 struct acpi_device_id ids[2] = {};
Mika Westerberg6ab34302014-09-16 14:52:36 +0300107
Andy Shevchenko98a3be42015-10-23 12:16:41 +0300108 strlcpy(ids[0].id, match->pnpid, sizeof(ids[0].id));
109 list_for_each_entry(child, &parent->children, node) {
Irina Tirdeaee414de2016-03-13 03:02:58 +0200110 if (!acpi_match_device_ids(child, ids)) {
Andy Shevchenko98a3be42015-10-23 12:16:41 +0300111 adev = child;
112 break;
113 }
Mika Westerberg6ab34302014-09-16 14:52:36 +0300114 }
Andy Shevchenko98a3be42015-10-23 12:16:41 +0300115 } else {
116 unsigned long long adr;
117 acpi_status status;
118
119 list_for_each_entry(child, &parent->children, node) {
120 status = acpi_evaluate_integer(child->handle,
121 "_ADR", NULL,
122 &adr);
123 if (ACPI_SUCCESS(status) && match->adr == adr) {
124 adev = child;
125 break;
126 }
127 }
128 }
Mika Westerberg6ab34302014-09-16 14:52:36 +0300129 }
130
131 ACPI_COMPANION_SET(&pdev->dev, adev);
132}
133#else
134static inline void mfd_acpi_add_device(const struct mfd_cell *cell,
135 struct platform_device *pdev)
136{
137}
138#endif
139
Dmitry Baryshkov424f5252008-07-29 01:30:26 +0200140static int mfd_add_device(struct device *parent, int id,
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +0100141 const struct mfd_cell *cell, atomic_t *usage_count,
Ben Dooks7f71ac92008-07-28 18:29:09 +0200142 struct resource *mem_base,
Mark Brown0848c942012-09-11 15:16:36 +0800143 int irq_base, struct irq_domain *domain)
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100144{
Ian Moltona87903f2008-07-25 22:59:29 +0100145 struct resource *res;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100146 struct platform_device *pdev;
Lee Jonesc94bb232012-06-29 19:01:03 +0200147 struct device_node *np = NULL;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100148 int ret = -ENOMEM;
Johan Hovold6e3f62f2014-09-26 12:55:33 +0200149 int platform_id;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100150 int r;
151
Johan Hovolda77c50b2015-03-25 12:07:05 +0100152 if (id == PLATFORM_DEVID_AUTO)
Johan Hovold6e3f62f2014-09-26 12:55:33 +0200153 platform_id = id;
154 else
155 platform_id = id + cell->id;
156
157 pdev = platform_device_alloc(cell->name, platform_id);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100158 if (!pdev)
159 goto fail_alloc;
160
Ian Moltona87903f2008-07-25 22:59:29 +0100161 res = kzalloc(sizeof(*res) * cell->num_resources, GFP_KERNEL);
162 if (!res)
163 goto fail_device;
164
Dmitry Baryshkov424f5252008-07-29 01:30:26 +0200165 pdev->dev.parent = parent;
Charles Keepaxb9fbb622012-11-09 16:15:28 +0000166 pdev->dev.type = &mfd_dev_type;
Benedikt Sprangerb018e132013-08-13 11:08:38 +0200167 pdev->dev.dma_mask = parent->dma_mask;
168 pdev->dev.dma_parms = parent->dma_parms;
Boris BREZILLON4f08df12014-09-22 21:37:55 +0200169 pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100170
Charles Keepaxd137be02014-04-24 18:27:25 +0100171 ret = regulator_bulk_register_supply_alias(
Charles Keepax7fcd4272013-10-15 20:14:21 +0100172 &pdev->dev, cell->parent_supplies,
173 parent, cell->parent_supplies,
174 cell->num_parent_supplies);
175 if (ret < 0)
176 goto fail_res;
177
Lee Jonesc94bb232012-06-29 19:01:03 +0200178 if (parent->of_node && cell->of_compatible) {
179 for_each_child_of_node(parent->of_node, np) {
180 if (of_device_is_compatible(np, cell->of_compatible)) {
181 pdev->dev.of_node = np;
Lee Jonesc94bb232012-06-29 19:01:03 +0200182 break;
183 }
184 }
185 }
186
Mika Westerberg6ab34302014-09-16 14:52:36 +0300187 mfd_acpi_add_device(cell, pdev);
188
Samuel Ortizeb895602011-04-06 16:52:52 +0200189 if (cell->pdata_size) {
190 ret = platform_device_add_data(pdev,
191 cell->platform_data, cell->pdata_size);
192 if (ret)
Charles Keepax7fcd4272013-10-15 20:14:21 +0100193 goto fail_alias;
Samuel Ortizeb895602011-04-06 16:52:52 +0200194 }
195
Heikki Krogerusf4d05262016-03-29 14:52:23 +0300196 if (cell->properties) {
197 ret = platform_device_add_properties(pdev, cell->properties);
Andy Shevchenko4d215ca2015-11-30 17:11:40 +0200198 if (ret)
199 goto fail_alias;
200 }
201
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +0100202 ret = mfd_platform_add_cell(pdev, cell, usage_count);
Andres Salomonfe891a02011-02-17 19:07:09 -0800203 if (ret)
Charles Keepax7fcd4272013-10-15 20:14:21 +0100204 goto fail_alias;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100205
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100206 for (r = 0; r < cell->num_resources; r++) {
207 res[r].name = cell->resources[r].name;
208 res[r].flags = cell->resources[r].flags;
209
210 /* Find out base to use */
Samuel Ortizf03cfcb2010-03-26 01:09:04 +0100211 if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100212 res[r].parent = mem_base;
213 res[r].start = mem_base->start +
214 cell->resources[r].start;
215 res[r].end = mem_base->start +
216 cell->resources[r].end;
217 } else if (cell->resources[r].flags & IORESOURCE_IRQ) {
Lee Jonesc94bb232012-06-29 19:01:03 +0200218 if (domain) {
219 /* Unable to create mappings for IRQ ranges. */
220 WARN_ON(cell->resources[r].start !=
221 cell->resources[r].end);
222 res[r].start = res[r].end = irq_create_mapping(
223 domain, cell->resources[r].start);
224 } else {
225 res[r].start = irq_base +
226 cell->resources[r].start;
227 res[r].end = irq_base +
228 cell->resources[r].end;
229 }
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100230 } else {
231 res[r].parent = cell->resources[r].parent;
232 res[r].start = cell->resources[r].start;
233 res[r].end = cell->resources[r].end;
234 }
Samuel Ortiz91feded2010-02-19 11:07:59 +0100235
Daniel Drake5f2545f2010-09-30 21:55:36 +0100236 if (!cell->ignore_resource_conflicts) {
Lorenzo Pieralisiec40c602015-05-01 10:41:10 +0100237 if (has_acpi_companion(&pdev->dev)) {
238 ret = acpi_check_resource_conflict(&res[r]);
239 if (ret)
240 goto fail_alias;
241 }
Daniel Drake5f2545f2010-09-30 21:55:36 +0100242 }
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100243 }
244
Axel Lin8af5fe32010-05-31 17:30:55 +0800245 ret = platform_device_add_resources(pdev, res, cell->num_resources);
246 if (ret)
Charles Keepax7fcd4272013-10-15 20:14:21 +0100247 goto fail_alias;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100248
249 ret = platform_device_add(pdev);
250 if (ret)
Charles Keepax7fcd4272013-10-15 20:14:21 +0100251 goto fail_alias;
Ian Moltona87903f2008-07-25 22:59:29 +0100252
Mark Brown4c90aa92010-11-26 17:19:34 +0000253 if (cell->pm_runtime_no_callbacks)
254 pm_runtime_no_callbacks(&pdev->dev);
255
Ian Moltona87903f2008-07-25 22:59:29 +0100256 kfree(res);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100257
258 return 0;
259
Charles Keepax7fcd4272013-10-15 20:14:21 +0100260fail_alias:
Charles Keepaxd137be02014-04-24 18:27:25 +0100261 regulator_bulk_unregister_supply_alias(&pdev->dev,
262 cell->parent_supplies,
263 cell->num_parent_supplies);
Ian Moltona87903f2008-07-25 22:59:29 +0100264fail_res:
265 kfree(res);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100266fail_device:
267 platform_device_put(pdev);
268fail_alloc:
269 return ret;
270}
271
Dmitry Baryshkov424f5252008-07-29 01:30:26 +0200272int mfd_add_devices(struct device *parent, int id,
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +0100273 const struct mfd_cell *cells, int n_devs,
Ben Dooks7f71ac92008-07-28 18:29:09 +0200274 struct resource *mem_base,
Mark Brown0848c942012-09-11 15:16:36 +0800275 int irq_base, struct irq_domain *domain)
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100276{
277 int i;
Geert Uytterhoeven0b208e42013-10-29 15:47:22 +0100278 int ret;
Andres Salomon1e29af62011-02-17 19:07:34 -0800279 atomic_t *cnts;
280
281 /* initialize reference counting for all cells */
Axel Lind1b5c5e2012-02-12 17:43:22 +0800282 cnts = kcalloc(n_devs, sizeof(*cnts), GFP_KERNEL);
Andres Salomon1e29af62011-02-17 19:07:34 -0800283 if (!cnts)
284 return -ENOMEM;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100285
286 for (i = 0; i < n_devs; i++) {
Andres Salomon1e29af62011-02-17 19:07:34 -0800287 atomic_set(&cnts[i], 0);
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +0100288 ret = mfd_add_device(parent, id, cells + i, cnts + i, mem_base,
Mark Brown0848c942012-09-11 15:16:36 +0800289 irq_base, domain);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100290 if (ret)
Geert Uytterhoeven0b208e42013-10-29 15:47:22 +0100291 goto fail;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100292 }
293
Geert Uytterhoeven0b208e42013-10-29 15:47:22 +0100294 return 0;
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100295
Geert Uytterhoeven0b208e42013-10-29 15:47:22 +0100296fail:
297 if (i)
298 mfd_remove_devices(parent);
299 else
300 kfree(cnts);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100301 return ret;
302}
303EXPORT_SYMBOL(mfd_add_devices);
304
Andres Salomon1e29af62011-02-17 19:07:34 -0800305static int mfd_remove_devices_fn(struct device *dev, void *c)
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100306{
Charles Keepaxb9fbb622012-11-09 16:15:28 +0000307 struct platform_device *pdev;
308 const struct mfd_cell *cell;
Andres Salomon1e29af62011-02-17 19:07:34 -0800309 atomic_t **usage_count = c;
310
Charles Keepaxb9fbb622012-11-09 16:15:28 +0000311 if (dev->type != &mfd_dev_type)
312 return 0;
313
314 pdev = to_platform_device(dev);
315 cell = mfd_get_cell(pdev);
316
Charles Keepaxd137be02014-04-24 18:27:25 +0100317 regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
318 cell->num_parent_supplies);
319
Andres Salomon1e29af62011-02-17 19:07:34 -0800320 /* find the base address of usage_count pointers (for freeing) */
321 if (!*usage_count || (cell->usage_count < *usage_count))
322 *usage_count = cell->usage_count;
323
324 platform_device_unregister(pdev);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100325 return 0;
326}
327
Dmitry Baryshkov424f5252008-07-29 01:30:26 +0200328void mfd_remove_devices(struct device *parent)
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100329{
Andres Salomon1e29af62011-02-17 19:07:34 -0800330 atomic_t *cnts = NULL;
331
Andy Shevchenkob9a8a272015-07-27 18:04:01 +0300332 device_for_each_child_reverse(parent, &cnts, mfd_remove_devices_fn);
Andres Salomon1e29af62011-02-17 19:07:34 -0800333 kfree(cnts);
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100334}
335EXPORT_SYMBOL(mfd_remove_devices);
336
Laxman Dewangana8f447be2016-04-08 00:12:55 +0530337static void devm_mfd_dev_release(struct device *dev, void *res)
338{
339 mfd_remove_devices(dev);
340}
341
342/**
343 * devm_mfd_add_devices - Resource managed version of mfd_add_devices()
344 *
345 * Returns 0 on success or an appropriate negative error number on failure.
346 * All child-devices of the MFD will automatically be removed when it gets
347 * unbinded.
348 */
349int devm_mfd_add_devices(struct device *dev, int id,
350 const struct mfd_cell *cells, int n_devs,
351 struct resource *mem_base,
352 int irq_base, struct irq_domain *domain)
353{
354 struct device **ptr;
355 int ret;
356
357 ptr = devres_alloc(devm_mfd_dev_release, sizeof(*ptr), GFP_KERNEL);
358 if (!ptr)
359 return -ENOMEM;
360
361 ret = mfd_add_devices(dev, id, cells, n_devs, mem_base,
362 irq_base, domain);
363 if (ret < 0) {
364 devres_free(ptr);
365 return ret;
366 }
367
368 *ptr = dev;
369 devres_add(dev, ptr);
370
371 return ret;
372}
373EXPORT_SYMBOL(devm_mfd_add_devices);
374
Andres Salomonfa1df692011-03-21 19:19:35 -0700375int mfd_clone_cell(const char *cell, const char **clones, size_t n_clones)
Andres Salomona9bbba92011-02-17 19:07:35 -0800376{
377 struct mfd_cell cell_entry;
378 struct device *dev;
379 struct platform_device *pdev;
Andres Salomonfa1df692011-03-21 19:19:35 -0700380 int i;
Andres Salomona9bbba92011-02-17 19:07:35 -0800381
382 /* fetch the parent cell's device (should already be registered!) */
383 dev = bus_find_device_by_name(&platform_bus_type, NULL, cell);
384 if (!dev) {
385 printk(KERN_ERR "failed to find device for cell %s\n", cell);
386 return -ENODEV;
387 }
388 pdev = to_platform_device(dev);
389 memcpy(&cell_entry, mfd_get_cell(pdev), sizeof(cell_entry));
390
391 WARN_ON(!cell_entry.enable);
392
Andres Salomonfa1df692011-03-21 19:19:35 -0700393 for (i = 0; i < n_clones; i++) {
394 cell_entry.name = clones[i];
395 /* don't give up if a single call fails; just report error */
Geert Uytterhoeven03e361b2013-10-29 10:03:04 +0100396 if (mfd_add_device(pdev->dev.parent, -1, &cell_entry,
397 cell_entry.usage_count, NULL, 0, NULL))
Andres Salomonfa1df692011-03-21 19:19:35 -0700398 dev_err(dev, "failed to create platform device '%s'\n",
399 clones[i]);
400 }
401
402 return 0;
Andres Salomona9bbba92011-02-17 19:07:35 -0800403}
Andres Salomonfa1df692011-03-21 19:19:35 -0700404EXPORT_SYMBOL(mfd_clone_cell);
Andres Salomona9bbba92011-02-17 19:07:35 -0800405
Dmitry Baryshkovaa613de2008-06-27 10:37:19 +0100406MODULE_LICENSE("GPL");
407MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");