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)
63static void mfd_acpi_add_device(const struct mfd_cell *cell,
64 struct platform_device *pdev)
65{
66 const struct mfd_cell_acpi_match *match = cell->acpi_match;
67 struct acpi_device *parent, *child;
68 struct acpi_device *adev = NULL;
69
70 parent = ACPI_COMPANION(pdev->dev.parent);
71 if (!parent)
72 return;
73
74 /*
75 * MFD child device gets its ACPI handle either from the ACPI device
76 * directly under the parent that matches the either _HID or _CID, or
77 * _ADR or it will use the parent handle if is no ID is given.
78 *
79 * Note that use of _ADR is a grey area in the ACPI specification,
80 * though at least Intel Galileo Gen 2 is using it to distinguish
81 * the children devices.
82 */
83 if (match) {
84 if (match->pnpid) {
85 struct acpi_device_id ids[2] = {};
86
87 strlcpy(ids[0].id, match->pnpid, sizeof(ids[0].id));
88 list_for_each_entry(child, &parent->children, node) {
89 if (!acpi_match_device_ids(child, ids)) {
90 adev = child;
91 break;
92 }
93 }
94 } else {
95 adev = acpi_find_child_device(parent, match->adr, false);
96 }
97 }
98
99 ACPI_COMPANION_SET(&pdev->dev, adev ?: parent);
100}
101#else
102static inline void mfd_acpi_add_device(const struct mfd_cell *cell,
103 struct platform_device *pdev)
104{
105}
106#endif
107
108static int mfd_match_of_node_to_dev(struct platform_device *pdev,
109 struct device_node *np,
110 const struct mfd_cell *cell)
111{
112#if IS_ENABLED(CONFIG_OF)
113 struct mfd_of_node_entry *of_entry;
114 const __be32 *reg;
115 u64 of_node_addr;
116
117 /* Skip if OF node has previously been allocated to a device */
118 list_for_each_entry(of_entry, &mfd_of_node_list, list)
119 if (of_entry->np == np)
120 return -EAGAIN;
121
122 if (!cell->use_of_reg)
123 /* No of_reg defined - allocate first free compatible match */
124 goto allocate_of_node;
125
126 /* We only care about each node's first defined address */
127 reg = of_get_address(np, 0, NULL, NULL);
128 if (!reg)
129 /* OF node does not contatin a 'reg' property to match to */
130 return -EAGAIN;
131
132 of_node_addr = of_read_number(reg, of_n_addr_cells(np));
133
134 if (cell->of_reg != of_node_addr)
135 /* No match */
136 return -EAGAIN;
137
138allocate_of_node:
139 of_entry = kzalloc(sizeof(*of_entry), GFP_KERNEL);
140 if (!of_entry)
141 return -ENOMEM;
142
143 of_entry->dev = &pdev->dev;
144 of_entry->np = np;
145 list_add_tail(&of_entry->list, &mfd_of_node_list);
146
147 pdev->dev.of_node = np;
148 pdev->dev.fwnode = &np->fwnode;
149#endif
150 return 0;
151}
152
153static int mfd_add_device(struct device *parent, int id,
154 const struct mfd_cell *cell,
155 struct resource *mem_base,
156 int irq_base, struct irq_domain *domain)
157{
158 struct resource *res;
159 struct platform_device *pdev;
160 struct device_node *np = NULL;
161 struct mfd_of_node_entry *of_entry, *tmp;
162 int ret = -ENOMEM;
163 int platform_id;
164 int r;
165
166 if (id == PLATFORM_DEVID_AUTO)
167 platform_id = id;
168 else
169 platform_id = id + cell->id;
170
171 pdev = platform_device_alloc(cell->name, platform_id);
172 if (!pdev)
173 goto fail_alloc;
174
175 pdev->mfd_cell = kmemdup(cell, sizeof(*cell), GFP_KERNEL);
176 if (!pdev->mfd_cell)
177 goto fail_device;
178
179 res = kcalloc(cell->num_resources, sizeof(*res), GFP_KERNEL);
180 if (!res)
181 goto fail_device;
182
183 pdev->dev.parent = parent;
184 pdev->dev.type = &mfd_dev_type;
185 pdev->dev.dma_mask = parent->dma_mask;
186 pdev->dev.dma_parms = parent->dma_parms;
187 pdev->dev.coherent_dma_mask = parent->coherent_dma_mask;
188
189 ret = regulator_bulk_register_supply_alias(
190 &pdev->dev, cell->parent_supplies,
191 parent, cell->parent_supplies,
192 cell->num_parent_supplies);
193 if (ret < 0)
194 goto fail_res;
195
196 if (IS_ENABLED(CONFIG_OF) && parent->of_node && cell->of_compatible) {
197 for_each_child_of_node(parent->of_node, np) {
198 if (of_device_is_compatible(np, cell->of_compatible)) {
199 /* Ignore 'disabled' devices error free */
200 if (!of_device_is_available(np)) {
201 ret = 0;
202 goto fail_alias;
203 }
204
205 ret = mfd_match_of_node_to_dev(pdev, np, cell);
206 if (ret == -EAGAIN)
207 continue;
208 if (ret)
209 goto fail_alias;
210
211 break;
212 }
213 }
214
215 if (!pdev->dev.of_node)
216 pr_warn("%s: Failed to locate of_node [id: %d]\n",
217 cell->name, platform_id);
218 }
219
220 mfd_acpi_add_device(cell, pdev);
221
222 if (cell->pdata_size) {
223 ret = platform_device_add_data(pdev,
224 cell->platform_data, cell->pdata_size);
225 if (ret)
226 goto fail_of_entry;
227 }
228
229 if (cell->swnode) {
230 ret = device_add_software_node(&pdev->dev, cell->swnode);
231 if (ret)
232 goto fail_of_entry;
233 }
234
235 for (r = 0; r < cell->num_resources; r++) {
236 res[r].name = cell->resources[r].name;
237 res[r].flags = cell->resources[r].flags;
238
239 /* Find out base to use */
240 if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) {
241 res[r].parent = mem_base;
242 res[r].start = mem_base->start +
243 cell->resources[r].start;
244 res[r].end = mem_base->start +
245 cell->resources[r].end;
246 } else if (cell->resources[r].flags & IORESOURCE_IRQ) {
247 if (domain) {
248 /* Unable to create mappings for IRQ ranges. */
249 WARN_ON(cell->resources[r].start !=
250 cell->resources[r].end);
251 res[r].start = res[r].end = irq_create_mapping(
252 domain, cell->resources[r].start);
253 } else {
254 res[r].start = irq_base +
255 cell->resources[r].start;
256 res[r].end = irq_base +
257 cell->resources[r].end;
258 }
259 } else {
260 res[r].parent = cell->resources[r].parent;
261 res[r].start = cell->resources[r].start;
262 res[r].end = cell->resources[r].end;
263 }
264
265 if (!cell->ignore_resource_conflicts) {
266 if (has_acpi_companion(&pdev->dev)) {
267 ret = acpi_check_resource_conflict(&res[r]);
268 if (ret)
269 goto fail_res_conflict;
270 }
271 }
272 }
273
274 ret = platform_device_add_resources(pdev, res, cell->num_resources);
275 if (ret)
276 goto fail_res_conflict;
277
278 ret = platform_device_add(pdev);
279 if (ret)
280 goto fail_res_conflict;
281
282 if (cell->pm_runtime_no_callbacks)
283 pm_runtime_no_callbacks(&pdev->dev);
284
285 kfree(res);
286
287 return 0;
288
289fail_res_conflict:
290 if (cell->swnode)
291 device_remove_software_node(&pdev->dev);
292fail_of_entry:
293 list_for_each_entry_safe(of_entry, tmp, &mfd_of_node_list, list)
294 if (of_entry->dev == &pdev->dev) {
295 list_del(&of_entry->list);
296 kfree(of_entry);
297 }
298fail_alias:
299 regulator_bulk_unregister_supply_alias(&pdev->dev,
300 cell->parent_supplies,
301 cell->num_parent_supplies);
302fail_res:
303 kfree(res);
304fail_device:
305 platform_device_put(pdev);
306fail_alloc:
307 return ret;
308}
309
310/**
311 * mfd_add_devices - register child devices
312 *
313 * @parent: Pointer to parent device.
314 * @id: Can be PLATFORM_DEVID_AUTO to let the Platform API take care
315 * of device numbering, or will be added to a device's cell_id.
316 * @cells: Array of (struct mfd_cell)s describing child devices.
317 * @n_devs: Number of child devices to register.
318 * @mem_base: Parent register range resource for child devices.
319 * @irq_base: Base of the range of virtual interrupt numbers allocated for
320 * this MFD device. Unused if @domain is specified.
321 * @domain: Interrupt domain to create mappings for hardware interrupts.
322 */
323int mfd_add_devices(struct device *parent, int id,
324 const struct mfd_cell *cells, int n_devs,
325 struct resource *mem_base,
326 int irq_base, struct irq_domain *domain)
327{
328 int i;
329 int ret;
330
331 for (i = 0; i < n_devs; i++) {
332 ret = mfd_add_device(parent, id, cells + i, mem_base,
333 irq_base, domain);
334 if (ret)
335 goto fail;
336 }
337
338 return 0;
339
340fail:
341 if (i)
342 mfd_remove_devices(parent);
343
344 return ret;
345}
346EXPORT_SYMBOL(mfd_add_devices);
347
348static int mfd_remove_devices_fn(struct device *dev, void *data)
349{
350 struct platform_device *pdev;
351 const struct mfd_cell *cell;
352 int *level = data;
353
354 if (dev->type != &mfd_dev_type)
355 return 0;
356
357 pdev = to_platform_device(dev);
358 cell = mfd_get_cell(pdev);
359
360 if (level && cell->level > *level)
361 return 0;
362
363 if (cell->swnode)
364 device_remove_software_node(&pdev->dev);
365
366 regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies,
367 cell->num_parent_supplies);
368
369 platform_device_unregister(pdev);
370 return 0;
371}
372
373void mfd_remove_devices_late(struct device *parent)
374{
375 int level = MFD_DEP_LEVEL_HIGH;
376
377 device_for_each_child_reverse(parent, &level, mfd_remove_devices_fn);
378}
379EXPORT_SYMBOL(mfd_remove_devices_late);
380
381void mfd_remove_devices(struct device *parent)
382{
383 int level = MFD_DEP_LEVEL_NORMAL;
384
385 device_for_each_child_reverse(parent, &level, mfd_remove_devices_fn);
386}
387EXPORT_SYMBOL(mfd_remove_devices);
388
389static void devm_mfd_dev_release(struct device *dev, void *res)
390{
391 mfd_remove_devices(dev);
392}
393
394/**
395 * devm_mfd_add_devices - Resource managed version of mfd_add_devices()
396 *
397 * Returns 0 on success or an appropriate negative error number on failure.
398 * All child-devices of the MFD will automatically be removed when it gets
399 * unbinded.
400 *
401 * @dev: Pointer to parent device.
402 * @id: Can be PLATFORM_DEVID_AUTO to let the Platform API take care
403 * of device numbering, or will be added to a device's cell_id.
404 * @cells: Array of (struct mfd_cell)s describing child devices.
405 * @n_devs: Number of child devices to register.
406 * @mem_base: Parent register range resource for child devices.
407 * @irq_base: Base of the range of virtual interrupt numbers allocated for
408 * this MFD device. Unused if @domain is specified.
409 * @domain: Interrupt domain to create mappings for hardware interrupts.
410 */
411int devm_mfd_add_devices(struct device *dev, int id,
412 const struct mfd_cell *cells, int n_devs,
413 struct resource *mem_base,
414 int irq_base, struct irq_domain *domain)
415{
416 struct device **ptr;
417 int ret;
418
419 ptr = devres_alloc(devm_mfd_dev_release, sizeof(*ptr), GFP_KERNEL);
420 if (!ptr)
421 return -ENOMEM;
422
423 ret = mfd_add_devices(dev, id, cells, n_devs, mem_base,
424 irq_base, domain);
425 if (ret < 0) {
426 devres_free(ptr);
427 return ret;
428 }
429
430 *ptr = dev;
431 devres_add(dev, ptr);
432
433 return ret;
434}
435EXPORT_SYMBOL(devm_mfd_add_devices);
436
437MODULE_LICENSE("GPL");
438MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov");