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> |
4d215cab | 17 | #include <linux/property.h> |
aa613de6 | 18 | #include <linux/mfd/core.h> |
4c90aa94 | 19 | #include <linux/pm_runtime.h> |
5a0e3ad6 | 20 | #include <linux/slab.h> |
4e36dd33 | 21 | #include <linux/module.h> |
c94bb233 LJ |
22 | #include <linux/irqdomain.h> |
23 | #include <linux/of.h> | |
7fcd4274 | 24 | #include <linux/regulator/consumer.h> |
aa613de6 | 25 | |
b9fbb62e CK |
26 | static struct device_type mfd_dev_type = { |
27 | .name = "mfd_device", | |
28 | }; | |
29 | ||
f77289ac | 30 | int mfd_cell_enable(struct platform_device *pdev) |
1e29af62 AS |
31 | { |
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 | } | |
f77289ac | 45 | EXPORT_SYMBOL(mfd_cell_enable); |
1e29af62 | 46 | |
f77289ac | 47 | int mfd_cell_disable(struct platform_device *pdev) |
1e29af62 AS |
48 | { |
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 | } | |
f77289ac | 65 | EXPORT_SYMBOL(mfd_cell_disable); |
1e29af62 | 66 | |
e710d7d5 | 67 | static int mfd_platform_add_cell(struct platform_device *pdev, |
03e361b2 GU |
68 | const struct mfd_cell *cell, |
69 | atomic_t *usage_count) | |
e710d7d5 SO |
70 | { |
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 | ||
03e361b2 | 78 | pdev->mfd_cell->usage_count = usage_count; |
e710d7d5 SO |
79 | return 0; |
80 | } | |
81 | ||
6ab34301 MW |
82 | #if IS_ENABLED(CONFIG_ACPI) |
83 | static void mfd_acpi_add_device(const struct mfd_cell *cell, | |
84 | struct platform_device *pdev) | |
85 | { | |
98a3be44 AS |
86 | const struct mfd_cell_acpi_match *match = cell->acpi_match; |
87 | struct acpi_device *parent, *child; | |
6ab34301 MW |
88 | struct acpi_device *adev; |
89 | ||
98a3be44 AS |
90 | parent = ACPI_COMPANION(pdev->dev.parent); |
91 | if (!parent) | |
6ab34301 MW |
92 | return; |
93 | ||
94 | /* | |
98a3be44 AS |
95 | * 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. | |
6ab34301 | 102 | */ |
98a3be44 AS |
103 | adev = parent; |
104 | if (match) { | |
105 | if (match->pnpid) { | |
106 | struct acpi_device_id ids[2] = {}; | |
107 | ||
108 | strlcpy(ids[0].id, match->pnpid, sizeof(ids[0].id)); | |
109 | list_for_each_entry(child, &parent->children, node) { | |
ee414de5 | 110 | if (!acpi_match_device_ids(child, ids)) { |
98a3be44 AS |
111 | adev = child; |
112 | break; | |
113 | } | |
6ab34301 | 114 | } |
98a3be44 AS |
115 | } 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 | } | |
6ab34301 MW |
129 | } |
130 | ||
131 | ACPI_COMPANION_SET(&pdev->dev, adev); | |
132 | } | |
133 | #else | |
134 | static inline void mfd_acpi_add_device(const struct mfd_cell *cell, | |
135 | struct platform_device *pdev) | |
136 | { | |
137 | } | |
138 | #endif | |
139 | ||
424f525a | 140 | static int mfd_add_device(struct device *parent, int id, |
03e361b2 | 141 | const struct mfd_cell *cell, atomic_t *usage_count, |
7f71ac93 | 142 | struct resource *mem_base, |
0848c94f | 143 | int irq_base, struct irq_domain *domain) |
aa613de6 | 144 | { |
a87903f3 | 145 | struct resource *res; |
aa613de6 | 146 | struct platform_device *pdev; |
c94bb233 | 147 | struct device_node *np = NULL; |
aa613de6 | 148 | int ret = -ENOMEM; |
6e3f62f0 | 149 | int platform_id; |
aa613de6 DB |
150 | int r; |
151 | ||
a77c50b4 | 152 | if (id == PLATFORM_DEVID_AUTO) |
6e3f62f0 JH |
153 | platform_id = id; |
154 | else | |
155 | platform_id = id + cell->id; | |
156 | ||
157 | pdev = platform_device_alloc(cell->name, platform_id); | |
aa613de6 DB |
158 | if (!pdev) |
159 | goto fail_alloc; | |
160 | ||
6396bb22 | 161 | res = kcalloc(cell->num_resources, sizeof(*res), GFP_KERNEL); |
a87903f3 IM |
162 | if (!res) |
163 | goto fail_device; | |
164 | ||
424f525a | 165 | pdev->dev.parent = parent; |
b9fbb62e | 166 | pdev->dev.type = &mfd_dev_type; |
b018e136 BS |
167 | pdev->dev.dma_mask = parent->dma_mask; |
168 | pdev->dev.dma_parms = parent->dma_parms; | |
4f08df1b | 169 | pdev->dev.coherent_dma_mask = parent->coherent_dma_mask; |
aa613de6 | 170 | |
d137be00 | 171 | ret = regulator_bulk_register_supply_alias( |
7fcd4274 CK |
172 | &pdev->dev, cell->parent_supplies, |
173 | parent, cell->parent_supplies, | |
174 | cell->num_parent_supplies); | |
175 | if (ret < 0) | |
176 | goto fail_res; | |
177 | ||
c94bb233 LJ |
178 | 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; | |
c94bb233 LJ |
182 | break; |
183 | } | |
184 | } | |
185 | } | |
186 | ||
6ab34301 MW |
187 | mfd_acpi_add_device(cell, pdev); |
188 | ||
eb895607 SO |
189 | if (cell->pdata_size) { |
190 | ret = platform_device_add_data(pdev, | |
191 | cell->platform_data, cell->pdata_size); | |
192 | if (ret) | |
7fcd4274 | 193 | goto fail_alias; |
eb895607 SO |
194 | } |
195 | ||
f4d05266 HK |
196 | if (cell->properties) { |
197 | ret = platform_device_add_properties(pdev, cell->properties); | |
4d215cab AS |
198 | if (ret) |
199 | goto fail_alias; | |
200 | } | |
201 | ||
03e361b2 | 202 | ret = mfd_platform_add_cell(pdev, cell, usage_count); |
fe891a00 | 203 | if (ret) |
7fcd4274 | 204 | goto fail_alias; |
aa613de6 | 205 | |
aa613de6 DB |
206 | 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 */ | |
f03cfcbc | 211 | if ((cell->resources[r].flags & IORESOURCE_MEM) && mem_base) { |
aa613de6 DB |
212 | 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) { | |
c94bb233 LJ |
218 | 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 | } | |
aa613de6 DB |
230 | } 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 | } | |
91fedede | 235 | |
5f2545fa | 236 | if (!cell->ignore_resource_conflicts) { |
ec40c606 LP |
237 | if (has_acpi_companion(&pdev->dev)) { |
238 | ret = acpi_check_resource_conflict(&res[r]); | |
239 | if (ret) | |
240 | goto fail_alias; | |
241 | } | |
5f2545fa | 242 | } |
aa613de6 DB |
243 | } |
244 | ||
8af5fe3b AL |
245 | ret = platform_device_add_resources(pdev, res, cell->num_resources); |
246 | if (ret) | |
7fcd4274 | 247 | goto fail_alias; |
aa613de6 DB |
248 | |
249 | ret = platform_device_add(pdev); | |
250 | if (ret) | |
7fcd4274 | 251 | goto fail_alias; |
a87903f3 | 252 | |
4c90aa94 MB |
253 | if (cell->pm_runtime_no_callbacks) |
254 | pm_runtime_no_callbacks(&pdev->dev); | |
255 | ||
a87903f3 | 256 | kfree(res); |
aa613de6 DB |
257 | |
258 | return 0; | |
259 | ||
7fcd4274 | 260 | fail_alias: |
d137be00 CK |
261 | regulator_bulk_unregister_supply_alias(&pdev->dev, |
262 | cell->parent_supplies, | |
263 | cell->num_parent_supplies); | |
a87903f3 IM |
264 | fail_res: |
265 | kfree(res); | |
aa613de6 DB |
266 | fail_device: |
267 | platform_device_put(pdev); | |
268 | fail_alloc: | |
269 | return ret; | |
270 | } | |
271 | ||
1946f996 BG |
272 | /** |
273 | * mfd_add_devices - register child devices | |
274 | * | |
275 | * @parent: Pointer to parent device. | |
276 | * @id: Can be PLATFORM_DEVID_AUTO to let the Platform API take care | |
277 | * of device numbering, or will be added to a device's cell_id. | |
278 | * @cells: Array of (struct mfd_cell)s describing child devices. | |
279 | * @n_devs: Number of child devices to register. | |
280 | * @mem_base: Parent register range resource for child devices. | |
281 | * @irq_base: Base of the range of virtual interrupt numbers allocated for | |
282 | * this MFD device. Unused if @domain is specified. | |
283 | * @domain: Interrupt domain to create mappings for hardware interrupts. | |
284 | */ | |
424f525a | 285 | int mfd_add_devices(struct device *parent, int id, |
03e361b2 | 286 | const struct mfd_cell *cells, int n_devs, |
7f71ac93 | 287 | struct resource *mem_base, |
0848c94f | 288 | int irq_base, struct irq_domain *domain) |
aa613de6 DB |
289 | { |
290 | int i; | |
0b208e41 | 291 | int ret; |
1e29af62 AS |
292 | atomic_t *cnts; |
293 | ||
294 | /* initialize reference counting for all cells */ | |
d1b5c5e2 | 295 | cnts = kcalloc(n_devs, sizeof(*cnts), GFP_KERNEL); |
1e29af62 AS |
296 | if (!cnts) |
297 | return -ENOMEM; | |
aa613de6 DB |
298 | |
299 | for (i = 0; i < n_devs; i++) { | |
1e29af62 | 300 | atomic_set(&cnts[i], 0); |
03e361b2 | 301 | ret = mfd_add_device(parent, id, cells + i, cnts + i, mem_base, |
0848c94f | 302 | irq_base, domain); |
aa613de6 | 303 | if (ret) |
0b208e41 | 304 | goto fail; |
aa613de6 DB |
305 | } |
306 | ||
0b208e41 | 307 | return 0; |
aa613de6 | 308 | |
0b208e41 GU |
309 | fail: |
310 | if (i) | |
311 | mfd_remove_devices(parent); | |
312 | else | |
313 | kfree(cnts); | |
aa613de6 DB |
314 | return ret; |
315 | } | |
316 | EXPORT_SYMBOL(mfd_add_devices); | |
317 | ||
1e29af62 | 318 | static int mfd_remove_devices_fn(struct device *dev, void *c) |
aa613de6 | 319 | { |
b9fbb62e CK |
320 | struct platform_device *pdev; |
321 | const struct mfd_cell *cell; | |
1e29af62 AS |
322 | atomic_t **usage_count = c; |
323 | ||
b9fbb62e CK |
324 | if (dev->type != &mfd_dev_type) |
325 | return 0; | |
326 | ||
327 | pdev = to_platform_device(dev); | |
328 | cell = mfd_get_cell(pdev); | |
329 | ||
d137be00 CK |
330 | regulator_bulk_unregister_supply_alias(dev, cell->parent_supplies, |
331 | cell->num_parent_supplies); | |
332 | ||
1e29af62 AS |
333 | /* find the base address of usage_count pointers (for freeing) */ |
334 | if (!*usage_count || (cell->usage_count < *usage_count)) | |
335 | *usage_count = cell->usage_count; | |
336 | ||
337 | platform_device_unregister(pdev); | |
aa613de6 DB |
338 | return 0; |
339 | } | |
340 | ||
424f525a | 341 | void mfd_remove_devices(struct device *parent) |
aa613de6 | 342 | { |
1e29af62 AS |
343 | atomic_t *cnts = NULL; |
344 | ||
b9a8a271 | 345 | device_for_each_child_reverse(parent, &cnts, mfd_remove_devices_fn); |
1e29af62 | 346 | kfree(cnts); |
aa613de6 DB |
347 | } |
348 | EXPORT_SYMBOL(mfd_remove_devices); | |
349 | ||
a8f447be LD |
350 | static void devm_mfd_dev_release(struct device *dev, void *res) |
351 | { | |
352 | mfd_remove_devices(dev); | |
353 | } | |
354 | ||
355 | /** | |
356 | * devm_mfd_add_devices - Resource managed version of mfd_add_devices() | |
357 | * | |
358 | * Returns 0 on success or an appropriate negative error number on failure. | |
359 | * All child-devices of the MFD will automatically be removed when it gets | |
360 | * unbinded. | |
361 | */ | |
362 | int devm_mfd_add_devices(struct device *dev, int id, | |
363 | const struct mfd_cell *cells, int n_devs, | |
364 | struct resource *mem_base, | |
365 | int irq_base, struct irq_domain *domain) | |
366 | { | |
367 | struct device **ptr; | |
368 | int ret; | |
369 | ||
370 | ptr = devres_alloc(devm_mfd_dev_release, sizeof(*ptr), GFP_KERNEL); | |
371 | if (!ptr) | |
372 | return -ENOMEM; | |
373 | ||
374 | ret = mfd_add_devices(dev, id, cells, n_devs, mem_base, | |
375 | irq_base, domain); | |
376 | if (ret < 0) { | |
377 | devres_free(ptr); | |
378 | return ret; | |
379 | } | |
380 | ||
381 | *ptr = dev; | |
382 | devres_add(dev, ptr); | |
383 | ||
384 | return ret; | |
385 | } | |
386 | EXPORT_SYMBOL(devm_mfd_add_devices); | |
387 | ||
fa1df691 | 388 | int mfd_clone_cell(const char *cell, const char **clones, size_t n_clones) |
a9bbba99 AS |
389 | { |
390 | struct mfd_cell cell_entry; | |
391 | struct device *dev; | |
392 | struct platform_device *pdev; | |
fa1df691 | 393 | int i; |
a9bbba99 AS |
394 | |
395 | /* fetch the parent cell's device (should already be registered!) */ | |
396 | dev = bus_find_device_by_name(&platform_bus_type, NULL, cell); | |
397 | if (!dev) { | |
398 | printk(KERN_ERR "failed to find device for cell %s\n", cell); | |
399 | return -ENODEV; | |
400 | } | |
401 | pdev = to_platform_device(dev); | |
402 | memcpy(&cell_entry, mfd_get_cell(pdev), sizeof(cell_entry)); | |
403 | ||
404 | WARN_ON(!cell_entry.enable); | |
405 | ||
fa1df691 AS |
406 | for (i = 0; i < n_clones; i++) { |
407 | cell_entry.name = clones[i]; | |
408 | /* don't give up if a single call fails; just report error */ | |
03e361b2 GU |
409 | if (mfd_add_device(pdev->dev.parent, -1, &cell_entry, |
410 | cell_entry.usage_count, NULL, 0, NULL)) | |
fa1df691 AS |
411 | dev_err(dev, "failed to create platform device '%s'\n", |
412 | clones[i]); | |
413 | } | |
a9bbba99 | 414 | |
722f1910 JH |
415 | put_device(dev); |
416 | ||
fa1df691 | 417 | return 0; |
a9bbba99 | 418 | } |
fa1df691 | 419 | EXPORT_SYMBOL(mfd_clone_cell); |
a9bbba99 | 420 | |
aa613de6 DB |
421 | MODULE_LICENSE("GPL"); |
422 | MODULE_AUTHOR("Ian Molton, Dmitry Baryshkov"); |