2 * Componentized device handling.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
8 * This is work in progress. We gather up the component devices into a list,
9 * and bind them when instructed. At the moment, we're specific to the DRM
10 * subsystem, and only handles one master device, but this doesn't have to be
13 #include <linux/component.h>
14 #include <linux/device.h>
15 #include <linux/kref.h>
16 #include <linux/list.h>
17 #include <linux/module.h>
18 #include <linux/mutex.h>
19 #include <linux/slab.h>
23 struct component_match_array {
25 int (*compare)(struct device *, void *);
26 void (*release)(struct device *, void *);
27 struct component *component;
31 struct component_match {
34 struct component_match_array *compare;
38 struct list_head node;
41 const struct component_master_ops *ops;
43 struct component_match *match;
47 struct list_head node;
48 struct master *master;
51 const struct component_ops *ops;
55 static DEFINE_MUTEX(component_mutex);
56 static LIST_HEAD(component_list);
57 static LIST_HEAD(masters);
59 static struct master *__master_find(struct device *dev,
60 const struct component_master_ops *ops)
64 list_for_each_entry(m, &masters, node)
65 if (m->dev == dev && (!ops || m->ops == ops))
71 static struct component *find_component(struct master *master,
72 int (*compare)(struct device *, void *), void *compare_data)
76 list_for_each_entry(c, &component_list, node) {
77 if (c->master && c->master != master)
80 if (compare(c->dev, compare_data))
87 static int find_components(struct master *master)
89 struct component_match *match = master->match;
94 * Scan the array of match functions and attach
95 * any components which are found to this master.
97 for (i = 0; i < match->num; i++) {
98 struct component_match_array *mc = &match->compare[i];
101 dev_dbg(master->dev, "Looking for component %zu\n", i);
103 if (match->compare[i].component)
106 c = find_component(master, mc->compare, mc->data);
112 dev_dbg(master->dev, "found component %s, duplicate %u\n", dev_name(c->dev), !!c->master);
114 /* Attach this component to the master */
115 match->compare[i].duplicate = !!c->master;
116 match->compare[i].component = c;
122 /* Detach component from associated master */
123 static void remove_component(struct master *master, struct component *c)
127 /* Detach the component from this master. */
128 for (i = 0; i < master->match->num; i++)
129 if (master->match->compare[i].component == c)
130 master->match->compare[i].component = NULL;
134 * Try to bring up a master. If component is NULL, we're interested in
135 * this master, otherwise it's a component which must be present to try
136 * and bring up the master.
138 * Returns 1 for successful bringup, 0 if not ready, or -ve errno.
140 static int try_to_bring_up_master(struct master *master,
141 struct component *component)
145 dev_dbg(master->dev, "trying to bring up master\n");
147 if (find_components(master)) {
148 dev_dbg(master->dev, "master has incomplete components\n");
152 if (component && component->master != master) {
153 dev_dbg(master->dev, "master is not for this component (%s)\n",
154 dev_name(component->dev));
158 if (!devres_open_group(master->dev, NULL, GFP_KERNEL))
161 /* Found all components */
162 ret = master->ops->bind(master->dev);
164 devres_release_group(master->dev, NULL);
165 dev_info(master->dev, "master bind failed: %d\n", ret);
169 master->bound = true;
173 static int try_to_bring_up_masters(struct component *component)
178 list_for_each_entry(m, &masters, node) {
180 ret = try_to_bring_up_master(m, component);
189 static void take_down_master(struct master *master)
192 master->ops->unbind(master->dev);
193 devres_release_group(master->dev, NULL);
194 master->bound = false;
198 static void component_match_release(struct device *master,
199 struct component_match *match)
203 for (i = 0; i < match->num; i++) {
204 struct component_match_array *mc = &match->compare[i];
207 mc->release(master, mc->data);
211 static void devm_component_match_release(struct device *dev, void *res)
213 component_match_release(dev, res);
216 static int component_match_realloc(struct device *dev,
217 struct component_match *match, size_t num)
219 struct component_match_array *new;
221 if (match->alloc == num)
224 new = devm_kmalloc_array(dev, num, sizeof(*new), GFP_KERNEL);
228 if (match->compare) {
229 memcpy(new, match->compare, sizeof(*new) *
230 min(match->num, num));
231 devm_kfree(dev, match->compare);
233 match->compare = new;
240 * Add a component to be matched, with a release function.
242 * The match array is first created or extended if necessary.
244 void component_match_add_release(struct device *master,
245 struct component_match **matchptr,
246 void (*release)(struct device *, void *),
247 int (*compare)(struct device *, void *), void *compare_data)
249 struct component_match *match = *matchptr;
255 match = devres_alloc(devm_component_match_release,
256 sizeof(*match), GFP_KERNEL);
258 *matchptr = ERR_PTR(-ENOMEM);
262 devres_add(master, match);
267 if (match->num == match->alloc) {
268 size_t new_size = match ? match->alloc + 16 : 15;
271 ret = component_match_realloc(master, match, new_size);
273 *matchptr = ERR_PTR(ret);
278 match->compare[match->num].compare = compare;
279 match->compare[match->num].release = release;
280 match->compare[match->num].data = compare_data;
281 match->compare[match->num].component = NULL;
284 EXPORT_SYMBOL(component_match_add_release);
286 int component_master_add_with_match(struct device *dev,
287 const struct component_master_ops *ops,
288 struct component_match *match)
290 struct master *master;
293 /* Reallocate the match array for its true size */
294 ret = component_match_realloc(dev, match, match->num);
298 master = kzalloc(sizeof(*master), GFP_KERNEL);
304 master->match = match;
306 /* Add to the list of available masters. */
307 mutex_lock(&component_mutex);
308 list_add(&master->node, &masters);
310 ret = try_to_bring_up_master(master, NULL);
313 /* Delete off the list if we weren't successful */
314 list_del(&master->node);
317 mutex_unlock(&component_mutex);
319 return ret < 0 ? ret : 0;
321 EXPORT_SYMBOL_GPL(component_master_add_with_match);
323 void component_master_del(struct device *dev,
324 const struct component_master_ops *ops)
326 struct master *master;
329 mutex_lock(&component_mutex);
330 master = __master_find(dev, ops);
332 struct component_match *match = master->match;
334 take_down_master(master);
336 list_del(&master->node);
339 for (i = 0; i < match->num; i++) {
340 struct component *c = match->compare[i].component;
347 mutex_unlock(&component_mutex);
349 EXPORT_SYMBOL_GPL(component_master_del);
351 static void component_unbind(struct component *component,
352 struct master *master, void *data)
354 WARN_ON(!component->bound);
356 component->ops->unbind(component->dev, master->dev, data);
357 component->bound = false;
359 /* Release all resources claimed in the binding of this component */
360 devres_release_group(component->dev, component);
363 void component_unbind_all(struct device *master_dev, void *data)
365 struct master *master;
369 WARN_ON(!mutex_is_locked(&component_mutex));
371 master = __master_find(master_dev, NULL);
375 /* Unbind components in reverse order */
376 for (i = master->match->num; i--; )
377 if (!master->match->compare[i].duplicate) {
378 c = master->match->compare[i].component;
379 component_unbind(c, master, data);
382 EXPORT_SYMBOL_GPL(component_unbind_all);
384 static int component_bind(struct component *component, struct master *master,
390 * Each component initialises inside its own devres group.
391 * This allows us to roll-back a failed component without
392 * affecting anything else.
394 if (!devres_open_group(master->dev, NULL, GFP_KERNEL))
398 * Also open a group for the device itself: this allows us
399 * to release the resources claimed against the sub-device
400 * at the appropriate moment.
402 if (!devres_open_group(component->dev, component, GFP_KERNEL)) {
403 devres_release_group(master->dev, NULL);
407 dev_dbg(master->dev, "binding %s (ops %ps)\n",
408 dev_name(component->dev), component->ops);
410 ret = component->ops->bind(component->dev, master->dev, data);
412 component->bound = true;
415 * Close the component device's group so that resources
416 * allocated in the binding are encapsulated for removal
417 * at unbind. Remove the group on the DRM device as we
418 * can clean those resources up independently.
420 devres_close_group(component->dev, NULL);
421 devres_remove_group(master->dev, NULL);
423 dev_info(master->dev, "bound %s (ops %ps)\n",
424 dev_name(component->dev), component->ops);
426 devres_release_group(component->dev, NULL);
427 devres_release_group(master->dev, NULL);
429 dev_err(master->dev, "failed to bind %s (ops %ps): %d\n",
430 dev_name(component->dev), component->ops, ret);
436 int component_bind_all(struct device *master_dev, void *data)
438 struct master *master;
443 WARN_ON(!mutex_is_locked(&component_mutex));
445 master = __master_find(master_dev, NULL);
449 /* Bind components in match order */
450 for (i = 0; i < master->match->num; i++)
451 if (!master->match->compare[i].duplicate) {
452 c = master->match->compare[i].component;
453 ret = component_bind(c, master, data);
460 if (!master->match->compare[i].duplicate) {
461 c = master->match->compare[i].component;
462 component_unbind(c, master, data);
468 EXPORT_SYMBOL_GPL(component_bind_all);
470 int component_add(struct device *dev, const struct component_ops *ops)
472 struct component *component;
475 component = kzalloc(sizeof(*component), GFP_KERNEL);
479 component->ops = ops;
480 component->dev = dev;
482 dev_dbg(dev, "adding component (ops %ps)\n", ops);
484 mutex_lock(&component_mutex);
485 list_add_tail(&component->node, &component_list);
487 ret = try_to_bring_up_masters(component);
489 list_del(&component->node);
493 mutex_unlock(&component_mutex);
495 return ret < 0 ? ret : 0;
497 EXPORT_SYMBOL_GPL(component_add);
499 void component_del(struct device *dev, const struct component_ops *ops)
501 struct component *c, *component = NULL;
503 mutex_lock(&component_mutex);
504 list_for_each_entry(c, &component_list, node)
505 if (c->dev == dev && c->ops == ops) {
511 if (component && component->master) {
512 take_down_master(component->master);
513 remove_component(component->master, component);
516 mutex_unlock(&component_mutex);
521 EXPORT_SYMBOL_GPL(component_del);
523 MODULE_LICENSE("GPL v2");