Commit | Line | Data |
---|---|---|
989d42e8 | 1 | // SPDX-License-Identifier: GPL-2.0 |
2a41e607 RK |
2 | /* |
3 | * Componentized device handling. | |
2a41e607 RK |
4 | */ |
5 | #include <linux/component.h> | |
6 | #include <linux/device.h> | |
2a41e607 | 7 | #include <linux/list.h> |
2a41e607 | 8 | #include <linux/mutex.h> |
2502960f | 9 | #include <linux/of.h> |
2a41e607 | 10 | #include <linux/slab.h> |
59e73854 | 11 | #include <linux/debugfs.h> |
2a41e607 | 12 | |
4d69c80e DV |
13 | /** |
14 | * DOC: overview | |
15 | * | |
16 | * The component helper allows drivers to collect a pile of sub-devices, | |
17 | * including their bound drivers, into an aggregate driver. Various subsystems | |
18 | * already provide functions to get hold of such components, e.g. | |
19 | * of_clk_get_by_name(). The component helper can be used when such a | |
20 | * subsystem-specific way to find a device is not available: The component | |
21 | * helper fills the niche of aggregate drivers for specific hardware, where | |
22 | * further standardization into a subsystem would not be practical. The common | |
23 | * example is when a logical device (e.g. a DRM display driver) is spread around | |
e4246b05 | 24 | * the SoC on various components (scanout engines, blending blocks, transcoders |
4d69c80e DV |
25 | * for various outputs and so on). |
26 | * | |
27 | * The component helper also doesn't solve runtime dependencies, e.g. for system | |
28 | * suspend and resume operations. See also :ref:`device links<device_link>`. | |
29 | * | |
30 | * Components are registered using component_add() and unregistered with | |
31 | * component_del(), usually from the driver's probe and disconnect functions. | |
32 | * | |
33 | * Aggregate drivers first assemble a component match list of what they need | |
34 | * using component_match_add(). This is then registered as an aggregate driver | |
35 | * using component_master_add_with_match(), and unregistered using | |
36 | * component_master_del(). | |
37 | */ | |
38 | ||
ffc30b74 RK |
39 | struct component; |
40 | ||
ce657b1c RK |
41 | struct component_match_array { |
42 | void *data; | |
43 | int (*compare)(struct device *, void *); | |
3521ee99 | 44 | int (*compare_typed)(struct device *, int, void *); |
ce657b1c RK |
45 | void (*release)(struct device *, void *); |
46 | struct component *component; | |
47 | bool duplicate; | |
48 | }; | |
49 | ||
6955b582 RK |
50 | struct component_match { |
51 | size_t alloc; | |
52 | size_t num; | |
ce657b1c | 53 | struct component_match_array *compare; |
6955b582 RK |
54 | }; |
55 | ||
13e906e5 | 56 | struct aggregate_device { |
2a41e607 | 57 | struct list_head node; |
2a41e607 RK |
58 | bool bound; |
59 | ||
60 | const struct component_master_ops *ops; | |
d52ff34e | 61 | struct device *parent; |
6955b582 | 62 | struct component_match *match; |
2a41e607 RK |
63 | }; |
64 | ||
65 | struct component { | |
66 | struct list_head node; | |
13e906e5 | 67 | struct aggregate_device *adev; |
2a41e607 RK |
68 | bool bound; |
69 | ||
70 | const struct component_ops *ops; | |
3521ee99 | 71 | int subcomponent; |
2a41e607 RK |
72 | struct device *dev; |
73 | }; | |
74 | ||
75 | static DEFINE_MUTEX(component_mutex); | |
76 | static LIST_HEAD(component_list); | |
13e906e5 | 77 | static LIST_HEAD(aggregate_devices); |
2a41e607 | 78 | |
59e73854 MP |
79 | #ifdef CONFIG_DEBUG_FS |
80 | ||
81 | static struct dentry *component_debugfs_dir; | |
82 | ||
83 | static int component_devices_show(struct seq_file *s, void *data) | |
84 | { | |
13e906e5 | 85 | struct aggregate_device *m = s->private; |
59e73854 MP |
86 | struct component_match *match = m->match; |
87 | size_t i; | |
88 | ||
89 | mutex_lock(&component_mutex); | |
13e906e5 | 90 | seq_printf(s, "%-40s %20s\n", "aggregate_device name", "status"); |
59e73854 MP |
91 | seq_puts(s, "-------------------------------------------------------------\n"); |
92 | seq_printf(s, "%-40s %20s\n\n", | |
d52ff34e | 93 | dev_name(m->parent), m->bound ? "bound" : "not bound"); |
59e73854 MP |
94 | |
95 | seq_printf(s, "%-40s %20s\n", "device name", "status"); | |
96 | seq_puts(s, "-------------------------------------------------------------\n"); | |
97 | for (i = 0; i < match->num; i++) { | |
ef9ffc1e | 98 | struct component *component = match->compare[i].component; |
59e73854 | 99 | |
ef9ffc1e LR |
100 | seq_printf(s, "%-40s %20s\n", |
101 | component ? dev_name(component->dev) : "(unknown)", | |
102 | component ? (component->bound ? "bound" : "not bound") : "not registered"); | |
59e73854 MP |
103 | } |
104 | mutex_unlock(&component_mutex); | |
105 | ||
106 | return 0; | |
107 | } | |
108 | ||
c0b8a870 | 109 | DEFINE_SHOW_ATTRIBUTE(component_devices); |
59e73854 MP |
110 | |
111 | static int __init component_debug_init(void) | |
112 | { | |
113 | component_debugfs_dir = debugfs_create_dir("device_component", NULL); | |
114 | ||
115 | return 0; | |
116 | } | |
117 | ||
118 | core_initcall(component_debug_init); | |
119 | ||
13e906e5 | 120 | static void component_debugfs_add(struct aggregate_device *m) |
59e73854 | 121 | { |
d52ff34e | 122 | debugfs_create_file(dev_name(m->parent), 0444, component_debugfs_dir, m, |
c654cea5 | 123 | &component_devices_fops); |
59e73854 MP |
124 | } |
125 | ||
13e906e5 | 126 | static void component_debugfs_del(struct aggregate_device *m) |
59e73854 | 127 | { |
8deb87b1 | 128 | debugfs_lookup_and_remove(dev_name(m->parent), component_debugfs_dir); |
59e73854 MP |
129 | } |
130 | ||
131 | #else | |
132 | ||
13e906e5 | 133 | static void component_debugfs_add(struct aggregate_device *m) |
59e73854 MP |
134 | { } |
135 | ||
13e906e5 | 136 | static void component_debugfs_del(struct aggregate_device *m) |
59e73854 MP |
137 | { } |
138 | ||
139 | #endif | |
140 | ||
13e906e5 | 141 | static struct aggregate_device *__aggregate_find(struct device *parent, |
2a41e607 RK |
142 | const struct component_master_ops *ops) |
143 | { | |
13e906e5 | 144 | struct aggregate_device *m; |
2a41e607 | 145 | |
13e906e5 | 146 | list_for_each_entry(m, &aggregate_devices, node) |
d52ff34e | 147 | if (m->parent == parent && (!ops || m->ops == ops)) |
2a41e607 RK |
148 | return m; |
149 | ||
150 | return NULL; | |
151 | } | |
152 | ||
13e906e5 | 153 | static struct component *find_component(struct aggregate_device *adev, |
3521ee99 | 154 | struct component_match_array *mc) |
2a41e607 RK |
155 | { |
156 | struct component *c; | |
2a41e607 RK |
157 | |
158 | list_for_each_entry(c, &component_list, node) { | |
13e906e5 | 159 | if (c->adev && c->adev != adev) |
2a41e607 RK |
160 | continue; |
161 | ||
3521ee99 DV |
162 | if (mc->compare && mc->compare(c->dev, mc->data)) |
163 | return c; | |
164 | ||
165 | if (mc->compare_typed && | |
166 | mc->compare_typed(c->dev, c->subcomponent, mc->data)) | |
ffc30b74 | 167 | return c; |
2a41e607 RK |
168 | } |
169 | ||
ffc30b74 | 170 | return NULL; |
2a41e607 | 171 | } |
2a41e607 | 172 | |
13e906e5 | 173 | static int find_components(struct aggregate_device *adev) |
6955b582 | 174 | { |
13e906e5 | 175 | struct component_match *match = adev->match; |
6955b582 RK |
176 | size_t i; |
177 | int ret = 0; | |
178 | ||
6955b582 RK |
179 | /* |
180 | * Scan the array of match functions and attach | |
13e906e5 | 181 | * any components which are found to this adev. |
6955b582 RK |
182 | */ |
183 | for (i = 0; i < match->num; i++) { | |
ce657b1c | 184 | struct component_match_array *mc = &match->compare[i]; |
ffc30b74 RK |
185 | struct component *c; |
186 | ||
13e906e5 | 187 | dev_dbg(adev->parent, "Looking for component %zu\n", i); |
ffc30b74 RK |
188 | |
189 | if (match->compare[i].component) | |
190 | continue; | |
191 | ||
13e906e5 | 192 | c = find_component(adev, mc); |
ffc30b74 RK |
193 | if (!c) { |
194 | ret = -ENXIO; | |
6955b582 | 195 | break; |
ffc30b74 RK |
196 | } |
197 | ||
13e906e5 SB |
198 | dev_dbg(adev->parent, "found component %s, duplicate %u\n", |
199 | dev_name(c->dev), !!c->adev); | |
ffc30b74 | 200 | |
13e906e5 SB |
201 | /* Attach this component to the adev */ |
202 | match->compare[i].duplicate = !!c->adev; | |
ffc30b74 | 203 | match->compare[i].component = c; |
13e906e5 | 204 | c->adev = adev; |
6955b582 RK |
205 | } |
206 | return ret; | |
207 | } | |
208 | ||
13e906e5 SB |
209 | /* Detach component from associated aggregate_device */ |
210 | static void remove_component(struct aggregate_device *adev, struct component *c) | |
2a41e607 | 211 | { |
ffc30b74 | 212 | size_t i; |
2a41e607 | 213 | |
13e906e5 SB |
214 | /* Detach the component from this adev. */ |
215 | for (i = 0; i < adev->match->num; i++) | |
216 | if (adev->match->compare[i].component == c) | |
217 | adev->match->compare[i].component = NULL; | |
2a41e607 RK |
218 | } |
219 | ||
220 | /* | |
13e906e5 SB |
221 | * Try to bring up an aggregate device. If component is NULL, we're interested |
222 | * in this aggregate device, otherwise it's a component which must be present | |
223 | * to try and bring up the aggregate device. | |
2a41e607 RK |
224 | * |
225 | * Returns 1 for successful bringup, 0 if not ready, or -ve errno. | |
226 | */ | |
13e906e5 | 227 | static int try_to_bring_up_aggregate_device(struct aggregate_device *adev, |
2a41e607 RK |
228 | struct component *component) |
229 | { | |
c334940e RK |
230 | int ret; |
231 | ||
13e906e5 | 232 | dev_dbg(adev->parent, "trying to bring up adev\n"); |
ffc30b74 | 233 | |
13e906e5 SB |
234 | if (find_components(adev)) { |
235 | dev_dbg(adev->parent, "master has incomplete components\n"); | |
ffc30b74 | 236 | return 0; |
c334940e | 237 | } |
2a41e607 | 238 | |
13e906e5 SB |
239 | if (component && component->adev != adev) { |
240 | dev_dbg(adev->parent, "master is not for this component (%s)\n", | |
ffc30b74 RK |
241 | dev_name(component->dev)); |
242 | return 0; | |
c334940e | 243 | } |
2a41e607 | 244 | |
13e906e5 | 245 | if (!devres_open_group(adev->parent, adev, GFP_KERNEL)) |
ffc30b74 | 246 | return -ENOMEM; |
2a41e607 | 247 | |
c334940e | 248 | /* Found all components */ |
13e906e5 | 249 | ret = adev->ops->bind(adev->parent); |
c334940e | 250 | if (ret < 0) { |
13e906e5 | 251 | devres_release_group(adev->parent, NULL); |
7706b0a7 | 252 | if (ret != -EPROBE_DEFER) |
13e906e5 | 253 | dev_info(adev->parent, "adev bind failed: %d\n", ret); |
ffc30b74 | 254 | return ret; |
c334940e | 255 | } |
9e1ccb4a | 256 | |
13e906e5 SB |
257 | devres_close_group(adev->parent, NULL); |
258 | adev->bound = true; | |
c334940e | 259 | return 1; |
2a41e607 RK |
260 | } |
261 | ||
262 | static int try_to_bring_up_masters(struct component *component) | |
263 | { | |
13e906e5 | 264 | struct aggregate_device *adev; |
2a41e607 RK |
265 | int ret = 0; |
266 | ||
13e906e5 SB |
267 | list_for_each_entry(adev, &aggregate_devices, node) { |
268 | if (!adev->bound) { | |
269 | ret = try_to_bring_up_aggregate_device(adev, component); | |
29f1c7fd RK |
270 | if (ret != 0) |
271 | break; | |
272 | } | |
2a41e607 RK |
273 | } |
274 | ||
275 | return ret; | |
276 | } | |
277 | ||
13e906e5 | 278 | static void take_down_aggregate_device(struct aggregate_device *adev) |
2a41e607 | 279 | { |
13e906e5 SB |
280 | if (adev->bound) { |
281 | adev->ops->unbind(adev->parent); | |
282 | devres_release_group(adev->parent, adev); | |
283 | adev->bound = false; | |
2a41e607 | 284 | } |
2a41e607 RK |
285 | } |
286 | ||
2502960f YW |
287 | /** |
288 | * component_compare_of - A common component compare function for of_node | |
289 | * @dev: component device | |
290 | * @data: @compare_data from component_match_add_release() | |
291 | * | |
292 | * A common compare function when compare_data is device of_node. e.g. | |
293 | * component_match_add_release(masterdev, &match, component_release_of, | |
294 | * component_compare_of, component_dev_of_node) | |
295 | */ | |
296 | int component_compare_of(struct device *dev, void *data) | |
297 | { | |
298 | return device_match_of_node(dev, data); | |
299 | } | |
300 | EXPORT_SYMBOL_GPL(component_compare_of); | |
301 | ||
302 | /** | |
303 | * component_release_of - A common component release function for of_node | |
304 | * @dev: component device | |
305 | * @data: @compare_data from component_match_add_release() | |
306 | * | |
307 | * About the example, Please see component_compare_of(). | |
308 | */ | |
309 | void component_release_of(struct device *dev, void *data) | |
310 | { | |
311 | of_node_put(data); | |
312 | } | |
313 | EXPORT_SYMBOL_GPL(component_release_of); | |
314 | ||
315 | /** | |
316 | * component_compare_dev - A common component compare function for dev | |
317 | * @dev: component device | |
318 | * @data: @compare_data from component_match_add_release() | |
319 | * | |
320 | * A common compare function when compare_data is struce device. e.g. | |
321 | * component_match_add(masterdev, &match, component_compare_dev, component_dev) | |
322 | */ | |
323 | int component_compare_dev(struct device *dev, void *data) | |
324 | { | |
325 | return dev == data; | |
326 | } | |
327 | EXPORT_SYMBOL_GPL(component_compare_dev); | |
328 | ||
329 | /** | |
330 | * component_compare_dev_name - A common component compare function for device name | |
331 | * @dev: component device | |
332 | * @data: @compare_data from component_match_add_release() | |
333 | * | |
334 | * A common compare function when compare_data is device name string. e.g. | |
335 | * component_match_add(masterdev, &match, component_compare_dev_name, | |
336 | * "component_dev_name") | |
337 | */ | |
338 | int component_compare_dev_name(struct device *dev, void *data) | |
339 | { | |
340 | return device_match_name(dev, data); | |
341 | } | |
342 | EXPORT_SYMBOL_GPL(component_compare_dev_name); | |
343 | ||
d52ff34e | 344 | static void devm_component_match_release(struct device *parent, void *res) |
6955b582 | 345 | { |
d52ff34e | 346 | struct component_match *match = res; |
ce657b1c RK |
347 | unsigned int i; |
348 | ||
349 | for (i = 0; i < match->num; i++) { | |
350 | struct component_match_array *mc = &match->compare[i]; | |
351 | ||
352 | if (mc->release) | |
d52ff34e | 353 | mc->release(parent, mc->data); |
ce657b1c | 354 | } |
9a4e7849 RK |
355 | |
356 | kfree(match->compare); | |
6955b582 RK |
357 | } |
358 | ||
82769cc6 | 359 | static int component_match_realloc(struct component_match *match, size_t num) |
6955b582 | 360 | { |
ce657b1c | 361 | struct component_match_array *new; |
6955b582 | 362 | |
ce657b1c RK |
363 | if (match->alloc == num) |
364 | return 0; | |
6955b582 | 365 | |
9a4e7849 | 366 | new = kmalloc_array(num, sizeof(*new), GFP_KERNEL); |
6955b582 | 367 | if (!new) |
ce657b1c | 368 | return -ENOMEM; |
6955b582 | 369 | |
ce657b1c RK |
370 | if (match->compare) { |
371 | memcpy(new, match->compare, sizeof(*new) * | |
372 | min(match->num, num)); | |
9a4e7849 | 373 | kfree(match->compare); |
6955b582 | 374 | } |
ce657b1c RK |
375 | match->compare = new; |
376 | match->alloc = num; | |
6955b582 | 377 | |
ce657b1c | 378 | return 0; |
6955b582 RK |
379 | } |
380 | ||
13e906e5 | 381 | static void __component_match_add(struct device *parent, |
ce657b1c RK |
382 | struct component_match **matchptr, |
383 | void (*release)(struct device *, void *), | |
3521ee99 DV |
384 | int (*compare)(struct device *, void *), |
385 | int (*compare_typed)(struct device *, int, void *), | |
386 | void *compare_data) | |
6955b582 RK |
387 | { |
388 | struct component_match *match = *matchptr; | |
389 | ||
390 | if (IS_ERR(match)) | |
391 | return; | |
392 | ||
ce657b1c RK |
393 | if (!match) { |
394 | match = devres_alloc(devm_component_match_release, | |
395 | sizeof(*match), GFP_KERNEL); | |
396 | if (!match) { | |
397 | *matchptr = ERR_PTR(-ENOMEM); | |
398 | return; | |
399 | } | |
6955b582 | 400 | |
13e906e5 | 401 | devres_add(parent, match); |
6955b582 RK |
402 | |
403 | *matchptr = match; | |
ce657b1c | 404 | } |
6955b582 | 405 | |
ce657b1c | 406 | if (match->num == match->alloc) { |
4877bb91 | 407 | size_t new_size = match->alloc + 16; |
ce657b1c RK |
408 | int ret; |
409 | ||
82769cc6 | 410 | ret = component_match_realloc(match, new_size); |
ce657b1c RK |
411 | if (ret) { |
412 | *matchptr = ERR_PTR(ret); | |
6955b582 | 413 | return; |
ce657b1c | 414 | } |
6955b582 RK |
415 | } |
416 | ||
ce657b1c | 417 | match->compare[match->num].compare = compare; |
3521ee99 | 418 | match->compare[match->num].compare_typed = compare_typed; |
ce657b1c | 419 | match->compare[match->num].release = release; |
6955b582 | 420 | match->compare[match->num].data = compare_data; |
ffc30b74 | 421 | match->compare[match->num].component = NULL; |
6955b582 RK |
422 | match->num++; |
423 | } | |
3521ee99 DV |
424 | |
425 | /** | |
e4246b05 | 426 | * component_match_add_release - add a component match entry with release callback |
13e906e5 | 427 | * @parent: parent device of the aggregate driver |
3521ee99 DV |
428 | * @matchptr: pointer to the list of component matches |
429 | * @release: release function for @compare_data | |
430 | * @compare: compare function to match against all components | |
431 | * @compare_data: opaque pointer passed to the @compare function | |
432 | * | |
13e906e5 | 433 | * Adds a new component match to the list stored in @matchptr, which the |
3521ee99 DV |
434 | * aggregate driver needs to function. The list of component matches pointed to |
435 | * by @matchptr must be initialized to NULL before adding the first match. This | |
436 | * only matches against components added with component_add(). | |
437 | * | |
438 | * The allocated match list in @matchptr is automatically released using devm | |
439 | * actions, where upon @release will be called to free any references held by | |
440 | * @compare_data, e.g. when @compare_data is a &device_node that must be | |
441 | * released with of_node_put(). | |
442 | * | |
443 | * See also component_match_add() and component_match_add_typed(). | |
444 | */ | |
13e906e5 | 445 | void component_match_add_release(struct device *parent, |
3521ee99 DV |
446 | struct component_match **matchptr, |
447 | void (*release)(struct device *, void *), | |
448 | int (*compare)(struct device *, void *), void *compare_data) | |
449 | { | |
13e906e5 | 450 | __component_match_add(parent, matchptr, release, compare, NULL, |
3521ee99 DV |
451 | compare_data); |
452 | } | |
ce657b1c | 453 | EXPORT_SYMBOL(component_match_add_release); |
6955b582 | 454 | |
3521ee99 | 455 | /** |
e4246b05 | 456 | * component_match_add_typed - add a component match entry for a typed component |
13e906e5 | 457 | * @parent: parent device of the aggregate driver |
3521ee99 DV |
458 | * @matchptr: pointer to the list of component matches |
459 | * @compare_typed: compare function to match against all typed components | |
460 | * @compare_data: opaque pointer passed to the @compare function | |
461 | * | |
13e906e5 | 462 | * Adds a new component match to the list stored in @matchptr, which the |
3521ee99 DV |
463 | * aggregate driver needs to function. The list of component matches pointed to |
464 | * by @matchptr must be initialized to NULL before adding the first match. This | |
465 | * only matches against components added with component_add_typed(). | |
466 | * | |
467 | * The allocated match list in @matchptr is automatically released using devm | |
468 | * actions. | |
469 | * | |
470 | * See also component_match_add_release() and component_match_add_typed(). | |
471 | */ | |
13e906e5 | 472 | void component_match_add_typed(struct device *parent, |
3521ee99 DV |
473 | struct component_match **matchptr, |
474 | int (*compare_typed)(struct device *, int, void *), void *compare_data) | |
475 | { | |
13e906e5 | 476 | __component_match_add(parent, matchptr, NULL, NULL, compare_typed, |
3521ee99 DV |
477 | compare_data); |
478 | } | |
479 | EXPORT_SYMBOL(component_match_add_typed); | |
480 | ||
13e906e5 | 481 | static void free_aggregate_device(struct aggregate_device *adev) |
57480484 | 482 | { |
13e906e5 | 483 | struct component_match *match = adev->match; |
57480484 JMT |
484 | int i; |
485 | ||
13e906e5 SB |
486 | component_debugfs_del(adev); |
487 | list_del(&adev->node); | |
57480484 JMT |
488 | |
489 | if (match) { | |
490 | for (i = 0; i < match->num; i++) { | |
491 | struct component *c = match->compare[i].component; | |
492 | if (c) | |
13e906e5 | 493 | c->adev = NULL; |
57480484 JMT |
494 | } |
495 | } | |
496 | ||
13e906e5 | 497 | kfree(adev); |
57480484 JMT |
498 | } |
499 | ||
4d69c80e DV |
500 | /** |
501 | * component_master_add_with_match - register an aggregate driver | |
d52ff34e | 502 | * @parent: parent device of the aggregate driver |
4d69c80e DV |
503 | * @ops: callbacks for the aggregate driver |
504 | * @match: component match list for the aggregate driver | |
505 | * | |
506 | * Registers a new aggregate driver consisting of the components added to @match | |
507 | * by calling one of the component_match_add() functions. Once all components in | |
508 | * @match are available, it will be assembled by calling | |
509 | * &component_master_ops.bind from @ops. Must be unregistered by calling | |
510 | * component_master_del(). | |
511 | */ | |
d52ff34e | 512 | int component_master_add_with_match(struct device *parent, |
6955b582 RK |
513 | const struct component_master_ops *ops, |
514 | struct component_match *match) | |
2a41e607 | 515 | { |
13e906e5 | 516 | struct aggregate_device *adev; |
2a41e607 RK |
517 | int ret; |
518 | ||
fae9e2e0 | 519 | /* Reallocate the match array for its true size */ |
82769cc6 | 520 | ret = component_match_realloc(match, match->num); |
ce657b1c RK |
521 | if (ret) |
522 | return ret; | |
6955b582 | 523 | |
13e906e5 SB |
524 | adev = kzalloc(sizeof(*adev), GFP_KERNEL); |
525 | if (!adev) | |
2a41e607 RK |
526 | return -ENOMEM; |
527 | ||
13e906e5 SB |
528 | adev->parent = parent; |
529 | adev->ops = ops; | |
530 | adev->match = match; | |
2a41e607 | 531 | |
13e906e5 SB |
532 | component_debugfs_add(adev); |
533 | /* Add to the list of available aggregate devices. */ | |
2a41e607 | 534 | mutex_lock(&component_mutex); |
13e906e5 | 535 | list_add(&adev->node, &aggregate_devices); |
2a41e607 | 536 | |
13e906e5 | 537 | ret = try_to_bring_up_aggregate_device(adev, NULL); |
2a41e607 | 538 | |
57480484 | 539 | if (ret < 0) |
13e906e5 | 540 | free_aggregate_device(adev); |
57480484 | 541 | |
2a41e607 RK |
542 | mutex_unlock(&component_mutex); |
543 | ||
544 | return ret < 0 ? ret : 0; | |
545 | } | |
6955b582 RK |
546 | EXPORT_SYMBOL_GPL(component_master_add_with_match); |
547 | ||
4d69c80e DV |
548 | /** |
549 | * component_master_del - unregister an aggregate driver | |
d52ff34e | 550 | * @parent: parent device of the aggregate driver |
4d69c80e DV |
551 | * @ops: callbacks for the aggregate driver |
552 | * | |
553 | * Unregisters an aggregate driver registered with | |
554 | * component_master_add_with_match(). If necessary the aggregate driver is first | |
555 | * disassembled by calling &component_master_ops.unbind from @ops. | |
556 | */ | |
d52ff34e | 557 | void component_master_del(struct device *parent, |
2a41e607 RK |
558 | const struct component_master_ops *ops) |
559 | { | |
13e906e5 | 560 | struct aggregate_device *adev; |
2a41e607 RK |
561 | |
562 | mutex_lock(&component_mutex); | |
13e906e5 SB |
563 | adev = __aggregate_find(parent, ops); |
564 | if (adev) { | |
565 | take_down_aggregate_device(adev); | |
566 | free_aggregate_device(adev); | |
2a41e607 RK |
567 | } |
568 | mutex_unlock(&component_mutex); | |
569 | } | |
570 | EXPORT_SYMBOL_GPL(component_master_del); | |
571 | ||
572 | static void component_unbind(struct component *component, | |
13e906e5 | 573 | struct aggregate_device *adev, void *data) |
2a41e607 RK |
574 | { |
575 | WARN_ON(!component->bound); | |
576 | ||
14422f14 | 577 | if (component->ops && component->ops->unbind) |
13e906e5 | 578 | component->ops->unbind(component->dev, adev->parent, data); |
2a41e607 RK |
579 | component->bound = false; |
580 | ||
581 | /* Release all resources claimed in the binding of this component */ | |
582 | devres_release_group(component->dev, component); | |
583 | } | |
584 | ||
4d69c80e | 585 | /** |
e4246b05 | 586 | * component_unbind_all - unbind all components of an aggregate driver |
d52ff34e | 587 | * @parent: parent device of the aggregate driver |
4d69c80e DV |
588 | * @data: opaque pointer, passed to all components |
589 | * | |
d52ff34e | 590 | * Unbinds all components of the aggregate device by passing @data to their |
4d69c80e DV |
591 | * &component_ops.unbind functions. Should be called from |
592 | * &component_master_ops.unbind. | |
593 | */ | |
d52ff34e | 594 | void component_unbind_all(struct device *parent, void *data) |
2a41e607 | 595 | { |
13e906e5 | 596 | struct aggregate_device *adev; |
2a41e607 | 597 | struct component *c; |
ffc30b74 | 598 | size_t i; |
2a41e607 RK |
599 | |
600 | WARN_ON(!mutex_is_locked(&component_mutex)); | |
601 | ||
13e906e5 SB |
602 | adev = __aggregate_find(parent, NULL); |
603 | if (!adev) | |
2a41e607 RK |
604 | return; |
605 | ||
ffc30b74 | 606 | /* Unbind components in reverse order */ |
13e906e5 SB |
607 | for (i = adev->match->num; i--; ) |
608 | if (!adev->match->compare[i].duplicate) { | |
609 | c = adev->match->compare[i].component; | |
610 | component_unbind(c, adev, data); | |
ffc30b74 | 611 | } |
2a41e607 RK |
612 | } |
613 | EXPORT_SYMBOL_GPL(component_unbind_all); | |
614 | ||
13e906e5 | 615 | static int component_bind(struct component *component, struct aggregate_device *adev, |
2a41e607 RK |
616 | void *data) |
617 | { | |
618 | int ret; | |
619 | ||
620 | /* | |
621 | * Each component initialises inside its own devres group. | |
622 | * This allows us to roll-back a failed component without | |
623 | * affecting anything else. | |
624 | */ | |
13e906e5 | 625 | if (!devres_open_group(adev->parent, NULL, GFP_KERNEL)) |
2a41e607 RK |
626 | return -ENOMEM; |
627 | ||
628 | /* | |
629 | * Also open a group for the device itself: this allows us | |
630 | * to release the resources claimed against the sub-device | |
631 | * at the appropriate moment. | |
632 | */ | |
633 | if (!devres_open_group(component->dev, component, GFP_KERNEL)) { | |
13e906e5 | 634 | devres_release_group(adev->parent, NULL); |
2a41e607 RK |
635 | return -ENOMEM; |
636 | } | |
637 | ||
13e906e5 | 638 | dev_dbg(adev->parent, "binding %s (ops %ps)\n", |
2a41e607 RK |
639 | dev_name(component->dev), component->ops); |
640 | ||
13e906e5 | 641 | ret = component->ops->bind(component->dev, adev->parent, data); |
2a41e607 RK |
642 | if (!ret) { |
643 | component->bound = true; | |
644 | ||
645 | /* | |
646 | * Close the component device's group so that resources | |
647 | * allocated in the binding are encapsulated for removal | |
648 | * at unbind. Remove the group on the DRM device as we | |
649 | * can clean those resources up independently. | |
650 | */ | |
651 | devres_close_group(component->dev, NULL); | |
13e906e5 | 652 | devres_remove_group(adev->parent, NULL); |
2a41e607 | 653 | |
13e906e5 | 654 | dev_info(adev->parent, "bound %s (ops %ps)\n", |
2a41e607 RK |
655 | dev_name(component->dev), component->ops); |
656 | } else { | |
657 | devres_release_group(component->dev, NULL); | |
13e906e5 | 658 | devres_release_group(adev->parent, NULL); |
2a41e607 | 659 | |
7706b0a7 | 660 | if (ret != -EPROBE_DEFER) |
13e906e5 | 661 | dev_err(adev->parent, "failed to bind %s (ops %ps): %d\n", |
7706b0a7 | 662 | dev_name(component->dev), component->ops, ret); |
2a41e607 RK |
663 | } |
664 | ||
665 | return ret; | |
666 | } | |
667 | ||
4d69c80e | 668 | /** |
e4246b05 | 669 | * component_bind_all - bind all components of an aggregate driver |
d52ff34e | 670 | * @parent: parent device of the aggregate driver |
4d69c80e DV |
671 | * @data: opaque pointer, passed to all components |
672 | * | |
e4246b05 | 673 | * Binds all components of the aggregate @dev by passing @data to their |
4d69c80e DV |
674 | * &component_ops.bind functions. Should be called from |
675 | * &component_master_ops.bind. | |
676 | */ | |
d52ff34e | 677 | int component_bind_all(struct device *parent, void *data) |
2a41e607 | 678 | { |
13e906e5 | 679 | struct aggregate_device *adev; |
2a41e607 | 680 | struct component *c; |
ffc30b74 | 681 | size_t i; |
2a41e607 RK |
682 | int ret = 0; |
683 | ||
684 | WARN_ON(!mutex_is_locked(&component_mutex)); | |
685 | ||
13e906e5 SB |
686 | adev = __aggregate_find(parent, NULL); |
687 | if (!adev) | |
2a41e607 RK |
688 | return -EINVAL; |
689 | ||
ffc30b74 | 690 | /* Bind components in match order */ |
13e906e5 SB |
691 | for (i = 0; i < adev->match->num; i++) |
692 | if (!adev->match->compare[i].duplicate) { | |
693 | c = adev->match->compare[i].component; | |
694 | ret = component_bind(c, adev, data); | |
ffc30b74 RK |
695 | if (ret) |
696 | break; | |
697 | } | |
2a41e607 RK |
698 | |
699 | if (ret != 0) { | |
bdae566d | 700 | for (; i > 0; i--) |
13e906e5 SB |
701 | if (!adev->match->compare[i - 1].duplicate) { |
702 | c = adev->match->compare[i - 1].component; | |
703 | component_unbind(c, adev, data); | |
ffc30b74 | 704 | } |
2a41e607 RK |
705 | } |
706 | ||
707 | return ret; | |
708 | } | |
709 | EXPORT_SYMBOL_GPL(component_bind_all); | |
710 | ||
3521ee99 DV |
711 | static int __component_add(struct device *dev, const struct component_ops *ops, |
712 | int subcomponent) | |
2a41e607 RK |
713 | { |
714 | struct component *component; | |
715 | int ret; | |
716 | ||
717 | component = kzalloc(sizeof(*component), GFP_KERNEL); | |
718 | if (!component) | |
719 | return -ENOMEM; | |
720 | ||
721 | component->ops = ops; | |
722 | component->dev = dev; | |
3521ee99 | 723 | component->subcomponent = subcomponent; |
2a41e607 RK |
724 | |
725 | dev_dbg(dev, "adding component (ops %ps)\n", ops); | |
726 | ||
727 | mutex_lock(&component_mutex); | |
728 | list_add_tail(&component->node, &component_list); | |
729 | ||
730 | ret = try_to_bring_up_masters(component); | |
731 | if (ret < 0) { | |
13e906e5 SB |
732 | if (component->adev) |
733 | remove_component(component->adev, component); | |
2a41e607 RK |
734 | list_del(&component->node); |
735 | ||
736 | kfree(component); | |
737 | } | |
738 | mutex_unlock(&component_mutex); | |
739 | ||
740 | return ret < 0 ? ret : 0; | |
741 | } | |
3521ee99 DV |
742 | |
743 | /** | |
744 | * component_add_typed - register a component | |
745 | * @dev: component device | |
746 | * @ops: component callbacks | |
747 | * @subcomponent: nonzero identifier for subcomponents | |
748 | * | |
749 | * Register a new component for @dev. Functions in @ops will be call when the | |
750 | * aggregate driver is ready to bind the overall driver by calling | |
751 | * component_bind_all(). See also &struct component_ops. | |
752 | * | |
753 | * @subcomponent must be nonzero and is used to differentiate between multiple | |
754 | * components registerd on the same device @dev. These components are match | |
755 | * using component_match_add_typed(). | |
756 | * | |
757 | * The component needs to be unregistered at driver unload/disconnect by | |
758 | * calling component_del(). | |
759 | * | |
760 | * See also component_add(). | |
761 | */ | |
762 | int component_add_typed(struct device *dev, const struct component_ops *ops, | |
763 | int subcomponent) | |
764 | { | |
765 | if (WARN_ON(subcomponent == 0)) | |
766 | return -EINVAL; | |
767 | ||
768 | return __component_add(dev, ops, subcomponent); | |
769 | } | |
770 | EXPORT_SYMBOL_GPL(component_add_typed); | |
771 | ||
772 | /** | |
773 | * component_add - register a component | |
774 | * @dev: component device | |
775 | * @ops: component callbacks | |
776 | * | |
777 | * Register a new component for @dev. Functions in @ops will be called when the | |
778 | * aggregate driver is ready to bind the overall driver by calling | |
779 | * component_bind_all(). See also &struct component_ops. | |
780 | * | |
781 | * The component needs to be unregistered at driver unload/disconnect by | |
782 | * calling component_del(). | |
783 | * | |
784 | * See also component_add_typed() for a variant that allows multipled different | |
785 | * components on the same device. | |
786 | */ | |
787 | int component_add(struct device *dev, const struct component_ops *ops) | |
788 | { | |
789 | return __component_add(dev, ops, 0); | |
790 | } | |
2a41e607 RK |
791 | EXPORT_SYMBOL_GPL(component_add); |
792 | ||
4d69c80e DV |
793 | /** |
794 | * component_del - unregister a component | |
795 | * @dev: component device | |
796 | * @ops: component callbacks | |
797 | * | |
798 | * Unregister a component added with component_add(). If the component is bound | |
799 | * into an aggregate driver, this will force the entire aggregate driver, including | |
800 | * all its components, to be unbound. | |
801 | */ | |
2a41e607 RK |
802 | void component_del(struct device *dev, const struct component_ops *ops) |
803 | { | |
804 | struct component *c, *component = NULL; | |
805 | ||
806 | mutex_lock(&component_mutex); | |
807 | list_for_each_entry(c, &component_list, node) | |
808 | if (c->dev == dev && c->ops == ops) { | |
809 | list_del(&c->node); | |
810 | component = c; | |
811 | break; | |
812 | } | |
813 | ||
13e906e5 SB |
814 | if (component && component->adev) { |
815 | take_down_aggregate_device(component->adev); | |
816 | remove_component(component->adev, component); | |
ffc30b74 | 817 | } |
2a41e607 RK |
818 | |
819 | mutex_unlock(&component_mutex); | |
820 | ||
821 | WARN_ON(!component); | |
822 | kfree(component); | |
823 | } | |
824 | EXPORT_SYMBOL_GPL(component_del); |