Loading...
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>
16#include <linux/acpi.h>
17#include <linux/mfd/core.h>
18#include <linux/pm_runtime.h>
19#include <linux/slab.h>
20
21int mfd_cell_enable(struct platform_device *pdev)
22{
23 const struct mfd_cell *cell = mfd_get_cell(pdev);
24 int err = 0;
25
26 /* only call enable hook if the cell wasn't previously enabled */
27 if (atomic_inc_return(cell->usage_count) == 1)
28 err = cell->enable(pdev);
29
30 /* if the enable hook failed, decrement counter to allow retries */
31 if (err)
32 atomic_dec(cell->usage_count);
33
34 return err;
35}
36EXPORT_SYMBOL(mfd_cell_enable);
37
38int mfd_cell_disable(struct platform_device *pdev)
39{
40 const struct mfd_cell *cell = mfd_get_cell(pdev);
41 int err = 0;
42
43 /* only disable if no other clients are using it */
44 if (atomic_dec_return(cell->usage_count) == 0)
45 err = cell->disable(pdev);
46
47 /* if the disable hook failed, increment to allow retries */
48 if (err)
49 atomic_inc(cell->usage_count);
50
51 /* sanity check; did someone call disable too many times? */
52 WARN_ON(atomic_read(cell->usage_count) < 0);
53
54 return err;
55}
56EXPORT_SYMBOL(mfd_cell_disable);
57
58static int mfd_platform_add_cell(struct platform_device *pdev,
59 const struct mfd_cell *cell)
60{
61 if (!cell)
62 return 0;
63
64 pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
65 if (!pdev->mfd_cell)
66 return -ENOMEM;
67
68 return 0;
69}
70
71static int mfd_add_device(struct device *parent, int id,
72 const struct mfd_cell *cell,
73 struct resource *mem_base,
74 int irq_base)
75{
76 struct resource *res;
77 struct platform_device *pdev;
78 int ret = -ENOMEM;
79 int r;
80
81 pdev = platform_device_alloc(cell->name, id + cell->id);
82 if (!pdev)
83 goto fail_alloc;
84
85 res = kzalloc(sizeof(*res) * cell->num_resources, GFP_KERNEL);
86 if (!res)
87 goto fail_device;
88
89 pdev->dev.parent = parent;
90
91 if (cell->pdata_size) {
92 ret = platform_device_add_data(pdev,
93 cell->platform_data, cell->pdata_size);
94 if (ret)
95 goto fail_res;
96 }
97
98 ret = mfd_platform_add_cell(pdev, cell);
99 if (ret)
100 goto fail_res;
101
102 for (r = 0; r < cell->num_resources; r++) {
103 res[r].name = cell->resources[r].name;
104 res[r].flags = cell->resources[r].flags;
105
106 /* Find out base to use */
107 if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
108 res[r].parent = mem_base;
109 res[r].start = mem_base->start +
110 cell->resources[r].start;
111 res[r].end = mem_base->start +
112 cell->resources[r].end;
113 } else if (cell->resources[r].flags & IORESOURCE_IRQ) {
114 res[r].start = irq_base +
115 cell->resources[r].start;
116 res[r].end = irq_base +
117 cell->resources[r].end;
118 } else {
119 res[r].parent = cell->resources[r].parent;
120 res[r].start = cell->resources[r].start;
121 res[r].end = cell->resources[r].end;
122 }
123
124 if (!cell->ignore_resource_conflicts) {
125 ret = acpi_check_resource_conflict(res);
126 if (ret)
127 goto fail_res;
128 }
129 }
130
131 ret = platform_device_add_resources(pdev, res, cell->num_resources);
132 if (ret)
133 goto fail_res;
134
135 ret = platform_device_add(pdev);
136 if (ret)
137 goto fail_res;
138
139 if (cell->pm_runtime_no_callbacks)
140 pm_runtime_no_callbacks(&pdev->dev);
141
142 kfree(res);
143
144 return 0;
145
146fail_res:
147 kfree(res);
148fail_device:
149 platform_device_put(pdev);
150fail_alloc:
151 return ret;
152}
153
154int mfd_add_devices(struct device *parent, int id,
155 struct mfd_cell *cells, int n_devs,
156 struct resource *mem_base,
157 int irq_base)
158{
159 int i;
160 int ret = 0;
161 atomic_t *cnts;
162
163 /* initialize reference counting for all cells */
164 cnts = kcalloc(sizeof(*cnts), n_devs, GFP_KERNEL);
165 if (!cnts)
166 return -ENOMEM;
167
168 for (i = 0; i < n_devs; i++) {
169 atomic_set(&cnts[i], 0);
170 cells[i].usage_count = &cnts[i];
171 ret = mfd_add_device(parent, id, cells + i, mem_base, irq_base);
172 if (ret)
173 break;
174 }
175
176 if (ret)
177 mfd_remove_devices(parent);
178
179 return ret;
180}
181EXPORT_SYMBOL(mfd_add_devices);
182
183static int mfd_remove_devices_fn(struct device *dev, void *c)
184{
185 struct platform_device *pdev = to_platform_device(dev);
186 const struct mfd_cell *cell = mfd_get_cell(pdev);
187 atomic_t **usage_count = c;
188
189 /* find the base address of usage_count pointers (for freeing) */
190 if (!*usage_count || (cell->usage_count < *usage_count))
191 *usage_count = cell->usage_count;
192
193 platform_device_unregister(pdev);
194 return 0;
195}
196
197void mfd_remove_devices(struct device *parent)
198{
199 atomic_t *cnts = NULL;
200
201 device_for_each_child(parent, &cnts, mfd_remove_devices_fn);
202 kfree(cnts);
203}
204EXPORT_SYMBOL(mfd_remove_devices);
205
206int mfd_clone_cell(const char *cell, const char **clones, size_t n_clones)
207{
208 struct mfd_cell cell_entry;
209 struct device *dev;
210 struct platform_device *pdev;
211 int i;
212
213 /* fetch the parent cell's device (should already be registered!) */
214 dev = bus_find_device_by_name(&platform_bus_type, NULL, cell);
215 if (!dev) {
216 printk(KERN_ERR "failed to find device for cell %s\n", cell);
217 return -ENODEV;
218 }
219 pdev = to_platform_device(dev);
220 memcpy(&cell_entry, mfd_get_cell(pdev), sizeof(cell_entry));
221
222 WARN_ON(!cell_entry.enable);
223
224 for (i = 0; i < n_clones; i++) {
225 cell_entry.name = clones[i];
226 /* don't give up if a single call fails; just report error */
227 if (mfd_add_device(pdev->dev.parent, -1, &cell_entry, NULL, 0))
228 dev_err(dev, "failed to create platform device '%s'\n",
229 clones[i]);
230 }
231
232 return 0;
233}
234EXPORT_SYMBOL(mfd_clone_cell);
235
236MODULE_LICENSE("GPL");
237MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * drivers/mfd/mfd-core.c
4 *
5 * core MFD support
6 * Copyright (c) 2006 Ian Molton
7 * Copyright (c) 2007,2008 Dmitry Baryshkov
8 */
9
10#include <linux/kernel.h>
11#include <linux/platform_device.h>
12#include <linux/acpi.h>
13#include <linux/list.h>
14#include <linux/property.h>
15#include <linux/mfd/core.h>
16#include <linux/pm_runtime.h>
17#include <linux/slab.h>
18#include <linux/module.h>
19#include <linux/irqdomain.h>
20#include <linux/of.h>
21#include <linux/of_address.h>
22#include <linux/regulator/consumer.h>
23
24static LIST_HEAD(mfd_of_node_list);
25
26struct mfd_of_node_entry {
27 struct list_head list;
28 struct device *dev;
29 struct device_node *np;
30};
31
32static struct device_type mfd_dev_type = {
33 .name = "mfd_device",
34};
35
36int mfd_cell_enable(struct platform_device *pdev)
37{
38 const struct mfd_cell *cell = mfd_get_cell(pdev);
39
40 if (!cell->enable) {
41 dev_dbg(&pdev->dev, "No .enable() call-back registered\n");
42 return 0;
43 }
44
45 return cell->enable(pdev);
46}
47EXPORT_SYMBOL(mfd_cell_enable);
48
49int mfd_cell_disable(struct platform_device *pdev)
50{
51 const struct mfd_cell *cell = mfd_get_cell(pdev);
52
53 if (!cell->disable) {
54 dev_dbg(&pdev->dev, "No .disable() call-back registered\n");
55 return 0;
56 }
57
58 return cell->disable(pdev);
59}
60EXPORT_SYMBOL(mfd_cell_disable);
61
62#if IS_ENABLED(CONFIG_ACPI)
63struct match_ids_walk_data {
64 struct acpi_device_id *ids;
65 struct acpi_device *adev;
66};
67
68static int match_device_ids(struct acpi_device *adev, void *data)
69{
70 struct match_ids_walk_data *wd = data;
71
72 if (!acpi_match_device_ids(adev, wd->ids)) {
73 wd->adev = adev;
74 return 1;
75 }
76
77 return 0;
78}
79
80static void mfd_acpi_add_device(const struct mfd_cell *cell,
81 struct platform_device *pdev)
82{
83 const struct mfd_cell_acpi_match *match = cell->acpi_match;
84 struct acpi_device *adev = NULL;
85 struct acpi_device *parent;
86
87 parent = ACPI_COMPANION(pdev->dev.parent);
88 if (!parent)
89 return;
90
91 /*
92 * MFD child device gets its ACPI handle either from the ACPI device
93 * directly under the parent that matches the either _HID or _CID, or
94 * _ADR or it will use the parent handle if is no ID is given.
95 *
96 * Note that use of _ADR is a grey area in the ACPI specification,
97 * though at least Intel Galileo Gen 2 is using it to distinguish
98 * the children devices.
99 */
100 if (match) {
101 if (match->pnpid) {
102 struct acpi_device_id ids[2] = {};
103 struct match_ids_walk_data wd = {
104 .adev = NULL,
105 .ids = ids,
106 };
107
108 strscpy(ids[0].id, match->pnpid, sizeof(ids[0].id));
109 acpi_dev_for_each_child(parent, match_device_ids, &wd);
110 adev = wd.adev;
111 } else {
112 adev = acpi_find_child_device(parent, match->adr, false);
113 }
114 }
115
116 ACPI_COMPANION_SET(&pdev->dev, adev ?: parent);
117}
118#else
119static inline void mfd_acpi_add_device(const struct mfd_cell *cell,
120 struct platform_device *pdev)
121{
122}
123#endif
124
125static int mfd_match_of_node_to_dev(struct platform_device *pdev,
126 struct device_node *np,
127 const struct mfd_cell *cell)
128{
129#if IS_ENABLED(CONFIG_OF)
130 struct mfd_of_node_entry *of_entry;
131 const __be32 *reg;
132 u64 of_node_addr;
133
134 /* Skip if OF node has previously been allocated to a device */
135 list_for_each_entry(of_entry, &mfd_of_node_list, list)
136 if (of_entry->np == np)
137 return -EAGAIN;
138
139 if (!cell->use_of_reg)
140 /* No of_reg defined - allocate first free compatible match */
141 goto allocate_of_node;
142
143 /* We only care about each node's first defined address */
144 reg = of_get_address(np, 0, NULL, NULL);
145 if (!reg)
146 /* OF node does not contatin a 'reg' property to match to */
147 return -EAGAIN;
148
149 of_node_addr = of_read_number(reg, of_n_addr_cells(np));
150
151 if (cell->of_reg != of_node_addr)
152 /* No match */
153 return -EAGAIN;
154
155allocate_of_node:
156 of_entry = kzalloc(sizeof(*of_entry), GFP_KERNEL);
157 if (!of_entry)
158 return -ENOMEM;
159
160 of_entry->dev = &pdev->dev;
161 of_entry->np = np;
162 list_add_tail(&of_entry->list, &mfd_of_node_list);
163
164 pdev->dev.of_node = np;
165 pdev->dev.fwnode = &np->fwnode;
166#endif
167 return 0;
168}
169
170static int mfd_add_device(struct device *parent, int id,
171 const struct mfd_cell *cell,
172 struct resource *mem_base,
173 int irq_base, struct irq_domain *domain)
174{
175 struct resource *res;
176 struct platform_device *pdev;
177 struct device_node *np = NULL;
178 struct mfd_of_node_entry *of_entry, *tmp;
179 int ret = -ENOMEM;
180 int platform_id;
181 int r;
182
183 if (id == PLATFORM_DEVID_AUTO)
184 platform_id = id;
185 else
186 platform_id = id + cell->id;
187
188 pdev = platform_device_alloc(cell->name, platform_id);
189 if (!pdev)
190 goto fail_alloc;
191
192 pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
193 if (!pdev->mfd_cell)
194 goto fail_device;
195
196 res = kcalloc(cell->num_resources, sizeof(*res), GFP_KERNEL);
197 if (!res)
198 goto fail_device;
199
200 pdev->dev.parent = parent;
201 pdev->dev.type = &mfd_dev_type;
202 pdev->dev.dma_mask = parent->dma_mask;
203 pdev->dev.dma_parms = parent->dma_parms;
204 pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
205
206 ret = regulator_bulk_register_supply_alias(
207 &pdev->dev, cell->parent_supplies,
208 parent, cell->parent_supplies,
209 cell->num_parent_supplies);
210 if (ret < 0)
211 goto fail_res;
212
213 if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
214 for_each_child_of_node(parent->of_node, np) {
215 if (of_device_is_compatible(np, cell->of_compatible)) {
216 /* Ignore 'disabled' devices error free */
217 if (!of_device_is_available(np)) {
218 of_node_put(np);
219 ret = 0;
220 goto fail_alias;
221 }
222
223 ret = mfd_match_of_node_to_dev(pdev, np, cell);
224 if (ret == -EAGAIN)
225 continue;
226 of_node_put(np);
227 if (ret)
228 goto fail_alias;
229
230 break;
231 }
232 }
233
234 if (!pdev->dev.of_node)
235 pr_warn("%s: Failed to locate of_node [id: %d]\n",
236 cell->name, platform_id);
237 }
238
239 mfd_acpi_add_device(cell, pdev);
240
241 if (cell->pdata_size) {
242 ret = platform_device_add_data(pdev,
243 cell->platform_data, cell->pdata_size);
244 if (ret)
245 goto fail_of_entry;
246 }
247
248 if (cell->swnode) {
249 ret = device_add_software_node(&pdev->dev, cell->swnode);
250 if (ret)
251 goto fail_of_entry;
252 }
253
254 for (r = 0; r < cell->num_resources; r++) {
255 res[r].name = cell->resources[r].name;
256 res[r].flags = cell->resources[r].flags;
257
258 /* Find out base to use */
259 if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
260 res[r].parent = mem_base;
261 res[r].start = mem_base->start +
262 cell->resources[r].start;
263 res[r].end = mem_base->start +
264 cell->resources[r].end;
265 } else if (cell->resources[r].flags & IORESOURCE_IRQ) {
266 if (domain) {
267 /* Unable to create mappings for IRQ ranges. */
268 WARN_ON(cell->resources[r].start !=
269 cell->resources[r].end);
270 res[r].start = res[r].end = irq_create_mapping(
271 domain, cell->resources[r].start);
272 } else {
273 res[r].start = irq_base +
274 cell->resources[r].start;
275 res[r].end = irq_base +
276 cell->resources[r].end;
277 }
278 } else {
279 res[r].parent = cell->resources[r].parent;
280 res[r].start = cell->resources[r].start;
281 res[r].end = cell->resources[r].end;
282 }
283
284 if (!cell->ignore_resource_conflicts) {
285 if (has_acpi_companion(&pdev->dev)) {
286 ret = acpi_check_resource_conflict(&res[r]);
287 if (ret)
288 goto fail_res_conflict;
289 }
290 }
291 }
292
293 ret = platform_device_add_resources(pdev, res, cell->num_resources);
294 if (ret)
295 goto fail_res_conflict;
296
297 ret = platform_device_add(pdev);
298 if (ret)
299 goto fail_res_conflict;
300
301 if (cell->pm_runtime_no_callbacks)
302 pm_runtime_no_callbacks(&pdev->dev);
303
304 kfree(res);
305
306 return 0;
307
308fail_res_conflict:
309 if (cell->swnode)
310 device_remove_software_node(&pdev->dev);
311fail_of_entry:
312 list_for_each_entry_safe(of_entry, tmp, &mfd_of_node_list, list)
313 if (of_entry->dev == &pdev->dev) {
314 list_del(&of_entry->list);
315 kfree(of_entry);
316 }
317fail_alias:
318 regulator_bulk_unregister_supply_alias(&pdev->dev,
319 cell->parent_supplies,
320 cell->num_parent_supplies);
321fail_res:
322 kfree(res);
323fail_device:
324 platform_device_put(pdev);
325fail_alloc:
326 return ret;
327}
328
329/**
330 * mfd_add_devices - register child devices
331 *
332 * @parent: Pointer to parent device.
333 * @id: Can be PLATFORM_DEVID_AUTO to let the Platform API take care
334 * of device numbering, or will be added to a device's cell_id.
335 * @cells: Array of (struct mfd_cell)s describing child devices.
336 * @n_devs: Number of child devices to register.
337 * @mem_base: Parent register range resource for child devices.
338 * @irq_base: Base of the range of virtual interrupt numbers allocated for
339 * this MFD device. Unused if @domain is specified.
340 * @domain: Interrupt domain to create mappings for hardware interrupts.
341 */
342int mfd_add_devices(struct device *parent, int id,
343 const struct mfd_cell *cells, int n_devs,
344 struct resource *mem_base,
345 int irq_base, struct irq_domain *domain)
346{
347 int i;
348 int ret;
349
350 for (i = 0; i < n_devs; i++) {
351 ret = mfd_add_device(parent, id, cells + i, mem_base,
352 irq_base, domain);
353 if (ret)
354 goto fail;
355 }
356
357 return 0;
358
359fail:
360 if (i)
361 mfd_remove_devices(parent);
362
363 return ret;
364}
365EXPORT_SYMBOL(mfd_add_devices);
366
367static int mfd_remove_devices_fn(struct device *dev, void *data)
368{
369 struct platform_device *pdev;
370 const struct mfd_cell *cell;
371 struct mfd_of_node_entry *of_entry, *tmp;
372 int *level = data;
373
374 if (dev->type != &mfd_dev_type)
375 return 0;
376
377 pdev = to_platform_device(dev);
378 cell = mfd_get_cell(pdev);
379
380 if (level && cell->level > *level)
381 return 0;
382
383 if (cell->swnode)
384 device_remove_software_node(&pdev->dev);
385
386 list_for_each_entry_safe(of_entry, tmp, &mfd_of_node_list, list)
387 if (of_entry->dev == &pdev->dev) {
388 list_del(&of_entry->list);
389 kfree(of_entry);
390 }
391
392 regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
393 cell->num_parent_supplies);
394
395 platform_device_unregister(pdev);
396 return 0;
397}
398
399void mfd_remove_devices_late(struct device *parent)
400{
401 int level = MFD_DEP_LEVEL_HIGH;
402
403 device_for_each_child_reverse(parent, &level, mfd_remove_devices_fn);
404}
405EXPORT_SYMBOL(mfd_remove_devices_late);
406
407void mfd_remove_devices(struct device *parent)
408{
409 int level = MFD_DEP_LEVEL_NORMAL;
410
411 device_for_each_child_reverse(parent, &level, mfd_remove_devices_fn);
412}
413EXPORT_SYMBOL(mfd_remove_devices);
414
415static void devm_mfd_dev_release(struct device *dev, void *res)
416{
417 mfd_remove_devices(dev);
418}
419
420/**
421 * devm_mfd_add_devices - Resource managed version of mfd_add_devices()
422 *
423 * Returns 0 on success or an appropriate negative error number on failure.
424 * All child-devices of the MFD will automatically be removed when it gets
425 * unbinded.
426 *
427 * @dev: Pointer to parent device.
428 * @id: Can be PLATFORM_DEVID_AUTO to let the Platform API take care
429 * of device numbering, or will be added to a device's cell_id.
430 * @cells: Array of (struct mfd_cell)s describing child devices.
431 * @n_devs: Number of child devices to register.
432 * @mem_base: Parent register range resource for child devices.
433 * @irq_base: Base of the range of virtual interrupt numbers allocated for
434 * this MFD device. Unused if @domain is specified.
435 * @domain: Interrupt domain to create mappings for hardware interrupts.
436 */
437int devm_mfd_add_devices(struct device *dev, int id,
438 const struct mfd_cell *cells, int n_devs,
439 struct resource *mem_base,
440 int irq_base, struct irq_domain *domain)
441{
442 struct device **ptr;
443 int ret;
444
445 ptr = devres_alloc(devm_mfd_dev_release, sizeof(*ptr), GFP_KERNEL);
446 if (!ptr)
447 return -ENOMEM;
448
449 ret = mfd_add_devices(dev, id, cells, n_devs, mem_base,
450 irq_base, domain);
451 if (ret < 0) {
452 devres_free(ptr);
453 return ret;
454 }
455
456 *ptr = dev;
457 devres_add(dev, ptr);
458
459 return ret;
460}
461EXPORT_SYMBOL(devm_mfd_add_devices);
462
463MODULE_LICENSE("GPL");
464MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");