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