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