2 * Dynamic device configuration and creation.
4 * Copyright (c) 2009 CodeSourcery
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
20 /* The theory here is that it should be possible to create a machine without
21 knowledge of specific devices. Historically board init routines have
22 passed a bunch of arguments to each device, requiring the board know
23 exactly which device it is dealing with. This file provides an abstract
24 API for device configuration and initialization. Devices will generally
25 inherit from a particular bus (e.g. PCI or I2C) rather than
32 #include "qapi/qapi-visit-core.h"
35 static bool qdev_hot_added = false;
36 static bool qdev_hot_removed = false;
38 const VMStateDescription *qdev_get_vmsd(DeviceState *dev)
40 DeviceClass *dc = DEVICE_GET_CLASS(dev);
44 const char *qdev_fw_name(DeviceState *dev)
46 DeviceClass *dc = DEVICE_GET_CLASS(dev);
52 return object_get_typename(OBJECT(dev));
55 static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
58 static void bus_remove_child(BusState *bus, DeviceState *child)
62 QTAILQ_FOREACH(kid, &bus->children, sibling) {
63 if (kid->child == child) {
66 snprintf(name, sizeof(name), "child[%d]", kid->index);
67 QTAILQ_REMOVE(&bus->children, kid, sibling);
68 object_property_del(OBJECT(bus), name, NULL);
75 static void bus_add_child(BusState *bus, DeviceState *child)
78 BusChild *kid = g_malloc0(sizeof(*kid));
81 assert(bus->allow_hotplug);
84 kid->index = bus->max_index++;
87 QTAILQ_INSERT_HEAD(&bus->children, kid, sibling);
89 snprintf(name, sizeof(name), "child[%d]", kid->index);
90 object_property_add_link(OBJECT(bus), name,
91 object_get_typename(OBJECT(child)),
92 (Object **)&kid->child,
96 void qdev_set_parent_bus(DeviceState *dev, BusState *bus)
98 dev->parent_bus = bus;
99 bus_add_child(bus, dev);
102 /* Create a new device. This only initializes the device state structure
103 and allows properties to be set. qdev_init should be called to
104 initialize the actual device emulation. */
105 DeviceState *qdev_create(BusState *bus, const char *name)
109 dev = qdev_try_create(bus, name);
112 hw_error("Unknown device '%s' for bus '%s'\n", name,
113 object_get_typename(OBJECT(bus)));
115 hw_error("Unknown device '%s' for default sysbus\n", name);
122 DeviceState *qdev_try_create(BusState *bus, const char *type)
126 if (object_class_by_name(type) == NULL) {
129 dev = DEVICE(object_new(type));
135 bus = sysbus_get_default();
138 qdev_set_parent_bus(dev, bus);
143 /* Initialize a device. Device properties should be set before calling
144 this function. IRQs and MMIO regions should be connected/mapped after
145 calling this function.
146 On failure, destroy the device and return negative value.
147 Return 0 on success. */
148 int qdev_init(DeviceState *dev)
150 DeviceClass *dc = DEVICE_GET_CLASS(dev);
153 assert(dev->state == DEV_STATE_CREATED);
161 if (!OBJECT(dev)->parent) {
162 static int unattached_count = 0;
163 gchar *name = g_strdup_printf("device[%d]", unattached_count++);
165 object_property_add_child(container_get(qdev_get_machine(),
167 name, OBJECT(dev), NULL);
171 if (qdev_get_vmsd(dev)) {
172 vmstate_register_with_alias_id(dev, -1, qdev_get_vmsd(dev), dev,
173 dev->instance_id_alias,
174 dev->alias_required_for_version);
176 dev->state = DEV_STATE_INITIALIZED;
177 if (dev->hotplugged) {
183 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
184 int required_for_version)
186 assert(dev->state == DEV_STATE_CREATED);
187 dev->instance_id_alias = alias_id;
188 dev->alias_required_for_version = required_for_version;
191 void qdev_unplug(DeviceState *dev, Error **errp)
193 DeviceClass *dc = DEVICE_GET_CLASS(dev);
195 if (!dev->parent_bus->allow_hotplug) {
196 error_set(errp, QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
199 assert(dc->unplug != NULL);
201 qdev_hot_removed = true;
203 if (dc->unplug(dev) < 0) {
204 error_set(errp, QERR_UNDEFINED_ERROR);
209 static int qdev_reset_one(DeviceState *dev, void *opaque)
216 static int qbus_reset_one(BusState *bus, void *opaque)
218 BusClass *bc = BUS_GET_CLASS(bus);
220 return bc->reset(bus);
225 void qdev_reset_all(DeviceState *dev)
227 qdev_walk_children(dev, qdev_reset_one, qbus_reset_one, NULL);
230 void qbus_reset_all_fn(void *opaque)
232 BusState *bus = opaque;
233 qbus_walk_children(bus, qdev_reset_one, qbus_reset_one, NULL);
236 /* can be used as ->unplug() callback for the simple cases */
237 int qdev_simple_unplug_cb(DeviceState *dev)
245 /* Like qdev_init(), but terminate program via error_report() instead of
246 returning an error value. This is okay during machine creation.
247 Don't use for hotplug, because there callers need to recover from
248 failure. Exception: if you know the device's init() callback can't
249 fail, then qdev_init_nofail() can't fail either, and is therefore
250 usable even then. But relying on the device implementation that
251 way is somewhat unclean, and best avoided. */
252 void qdev_init_nofail(DeviceState *dev)
254 const char *typename = object_get_typename(OBJECT(dev));
256 if (qdev_init(dev) < 0) {
257 error_report("Initialization of device %s failed", typename);
262 /* Unlink device from bus and free the structure. */
263 void qdev_free(DeviceState *dev)
265 object_delete(OBJECT(dev));
268 void qdev_machine_creation_done(void)
271 * ok, initial machine setup is done, starting from now we can
272 * only create hotpluggable devices
277 bool qdev_machine_modified(void)
279 return qdev_hot_added || qdev_hot_removed;
282 BusState *qdev_get_parent_bus(DeviceState *dev)
284 return dev->parent_bus;
287 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
289 dev->gpio_in = qemu_extend_irqs(dev->gpio_in, dev->num_gpio_in, handler,
291 dev->num_gpio_in += n;
294 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
296 assert(dev->num_gpio_out == 0);
297 dev->num_gpio_out = n;
298 dev->gpio_out = pins;
301 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
303 assert(n >= 0 && n < dev->num_gpio_in);
304 return dev->gpio_in[n];
307 void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
309 assert(n >= 0 && n < dev->num_gpio_out);
310 dev->gpio_out[n] = pin;
313 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd)
315 qdev_prop_set_macaddr(dev, "mac", nd->macaddr.a);
317 qdev_prop_set_netdev(dev, "netdev", nd->netdev);
318 if (nd->nvectors != DEV_NVECTORS_UNSPECIFIED &&
319 object_property_find(OBJECT(dev), "vectors", NULL)) {
320 qdev_prop_set_uint32(dev, "vectors", nd->nvectors);
322 nd->instantiated = 1;
325 BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
329 QLIST_FOREACH(bus, &dev->child_bus, sibling) {
330 if (strcmp(name, bus->name) == 0) {
337 int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
338 qbus_walkerfn *busfn, void *opaque)
344 err = busfn(bus, opaque);
350 QTAILQ_FOREACH(kid, &bus->children, sibling) {
351 err = qdev_walk_children(kid->child, devfn, busfn, opaque);
360 int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
361 qbus_walkerfn *busfn, void *opaque)
367 err = devfn(dev, opaque);
373 QLIST_FOREACH(bus, &dev->child_bus, sibling) {
374 err = qbus_walk_children(bus, devfn, busfn, opaque);
383 DeviceState *qdev_find_recursive(BusState *bus, const char *id)
389 QTAILQ_FOREACH(kid, &bus->children, sibling) {
390 DeviceState *dev = kid->child;
392 if (dev->id && strcmp(dev->id, id) == 0) {
396 QLIST_FOREACH(child, &dev->child_bus, sibling) {
397 ret = qdev_find_recursive(child, id);
406 static void qbus_realize(BusState *bus)
408 const char *typename = object_get_typename(OBJECT(bus));
413 /* use supplied name */
414 } else if (bus->parent && bus->parent->id) {
415 /* parent device has id -> use it for bus name */
416 len = strlen(bus->parent->id) + 16;
418 snprintf(buf, len, "%s.%d", bus->parent->id, bus->parent->num_child_bus);
421 /* no id -> use lowercase bus type for bus name */
422 len = strlen(typename) + 16;
424 len = snprintf(buf, len, "%s.%d", typename,
425 bus->parent ? bus->parent->num_child_bus : 0);
426 for (i = 0; i < len; i++)
427 buf[i] = qemu_tolower(buf[i]);
432 QLIST_INSERT_HEAD(&bus->parent->child_bus, bus, sibling);
433 bus->parent->num_child_bus++;
434 object_property_add_child(OBJECT(bus->parent), bus->name, OBJECT(bus), NULL);
435 } else if (bus != sysbus_get_default()) {
436 /* TODO: once all bus devices are qdevified,
437 only reset handler for main_system_bus should be registered here. */
438 qemu_register_reset(qbus_reset_all_fn, bus);
442 void qbus_create_inplace(BusState *bus, const char *typename,
443 DeviceState *parent, const char *name)
445 object_initialize(bus, typename);
447 bus->parent = parent;
448 bus->name = name ? g_strdup(name) : NULL;
452 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name)
456 bus = BUS(object_new(typename));
458 bus->parent = parent;
459 bus->name = name ? g_strdup(name) : NULL;
465 void qbus_free(BusState *bus)
467 object_delete(OBJECT(bus));
470 static char *bus_get_fw_dev_path(BusState *bus, DeviceState *dev)
472 BusClass *bc = BUS_GET_CLASS(bus);
474 if (bc->get_fw_dev_path) {
475 return bc->get_fw_dev_path(dev);
481 static int qdev_get_fw_dev_path_helper(DeviceState *dev, char *p, int size)
485 if (dev && dev->parent_bus) {
487 l = qdev_get_fw_dev_path_helper(dev->parent_bus->parent, p, size);
488 d = bus_get_fw_dev_path(dev->parent_bus, dev);
490 l += snprintf(p + l, size - l, "%s", d);
493 l += snprintf(p + l, size - l, "%s", object_get_typename(OBJECT(dev)));
496 l += snprintf(p + l , size - l, "/");
501 char* qdev_get_fw_dev_path(DeviceState *dev)
506 l = qdev_get_fw_dev_path_helper(dev, path, 128);
510 return g_strdup(path);
513 char *qdev_get_dev_path(DeviceState *dev)
517 if (!dev || !dev->parent_bus) {
521 bc = BUS_GET_CLASS(dev->parent_bus);
522 if (bc->get_dev_path) {
523 return bc->get_dev_path(dev);
530 * Legacy property handling
533 static void qdev_get_legacy_property(Object *obj, Visitor *v, void *opaque,
534 const char *name, Error **errp)
536 DeviceState *dev = DEVICE(obj);
537 Property *prop = opaque;
542 prop->info->print(dev, prop, buffer, sizeof(buffer));
543 visit_type_str(v, &ptr, name, errp);
546 static void qdev_set_legacy_property(Object *obj, Visitor *v, void *opaque,
547 const char *name, Error **errp)
549 DeviceState *dev = DEVICE(obj);
550 Property *prop = opaque;
551 Error *local_err = NULL;
555 if (dev->state != DEV_STATE_CREATED) {
556 error_set(errp, QERR_PERMISSION_DENIED);
560 visit_type_str(v, &ptr, name, &local_err);
562 error_propagate(errp, local_err);
566 ret = prop->info->parse(dev, prop, ptr);
567 error_set_from_qdev_prop_error(errp, ret, dev, prop, ptr);
572 * @qdev_add_legacy_property - adds a legacy property
574 * Do not use this is new code! Properties added through this interface will
575 * be given names and types in the "legacy" namespace.
577 * Legacy properties are string versions of other OOM properties. The format
578 * of the string depends on the property type.
580 void qdev_property_add_legacy(DeviceState *dev, Property *prop,
585 /* Register pointer properties as legacy properties */
586 if (!prop->info->print && !prop->info->parse &&
587 (prop->info->set || prop->info->get)) {
591 name = g_strdup_printf("legacy-%s", prop->name);
592 type = g_strdup_printf("legacy<%s>",
593 prop->info->legacy_name ?: prop->info->name);
595 object_property_add(OBJECT(dev), name, type,
596 prop->info->print ? qdev_get_legacy_property : prop->info->get,
597 prop->info->parse ? qdev_set_legacy_property : prop->info->set,
606 * @qdev_property_add_static - add a @Property to a device.
608 * Static properties access data in a struct. The actual type of the
609 * property and the field depends on the property type.
611 void qdev_property_add_static(DeviceState *dev, Property *prop,
614 Error *local_err = NULL;
615 Object *obj = OBJECT(dev);
618 * TODO qdev_prop_ptr does not have getters or setters. It must
619 * go now that it can be replaced with links. The test should be
620 * removed along with it: all static properties are read/write.
622 if (!prop->info->get && !prop->info->set) {
626 object_property_add(obj, prop->name, prop->info->name,
627 prop->info->get, prop->info->set,
632 error_propagate(errp, local_err);
635 if (prop->qtype == QTYPE_NONE) {
639 if (prop->qtype == QTYPE_QBOOL) {
640 object_property_set_bool(obj, prop->defval, prop->name, &local_err);
641 } else if (prop->info->enum_table) {
642 object_property_set_str(obj, prop->info->enum_table[prop->defval],
643 prop->name, &local_err);
644 } else if (prop->qtype == QTYPE_QINT) {
645 object_property_set_int(obj, prop->defval, prop->name, &local_err);
647 assert_no_error(local_err);
650 static void device_initfn(Object *obj)
652 DeviceState *dev = DEVICE(obj);
658 qdev_hot_added = true;
661 dev->instance_id_alias = -1;
662 dev->state = DEV_STATE_CREATED;
664 class = object_get_class(OBJECT(dev));
666 for (prop = DEVICE_CLASS(class)->props; prop && prop->name; prop++) {
667 qdev_property_add_legacy(dev, prop, NULL);
668 qdev_property_add_static(dev, prop, NULL);
670 class = object_class_get_parent(class);
671 } while (class != object_class_by_name(TYPE_DEVICE));
672 qdev_prop_set_globals(dev);
674 object_property_add_link(OBJECT(dev), "parent_bus", TYPE_BUS,
675 (Object **)&dev->parent_bus, NULL);
678 /* Unlink device from bus and free the structure. */
679 static void device_finalize(Object *obj)
681 DeviceState *dev = DEVICE(obj);
683 DeviceClass *dc = DEVICE_GET_CLASS(dev);
685 if (dev->state == DEV_STATE_INITIALIZED) {
686 while (dev->num_child_bus) {
687 bus = QLIST_FIRST(&dev->child_bus);
690 if (qdev_get_vmsd(dev)) {
691 vmstate_unregister(dev, qdev_get_vmsd(dev), dev);
697 qemu_opts_del(dev->opts);
702 static void device_class_base_init(ObjectClass *class, void *data)
704 DeviceClass *klass = DEVICE_CLASS(class);
706 /* We explicitly look up properties in the superclasses,
707 * so do not propagate them to the subclasses.
712 static void qdev_remove_from_bus(Object *obj)
714 DeviceState *dev = DEVICE(obj);
716 bus_remove_child(dev->parent_bus, dev);
719 static void device_class_init(ObjectClass *class, void *data)
721 class->unparent = qdev_remove_from_bus;
724 void device_reset(DeviceState *dev)
726 DeviceClass *klass = DEVICE_GET_CLASS(dev);
733 Object *qdev_get_machine(void)
738 dev = container_get(object_get_root(), "/machine");
744 static TypeInfo device_type_info = {
746 .parent = TYPE_OBJECT,
747 .instance_size = sizeof(DeviceState),
748 .instance_init = device_initfn,
749 .instance_finalize = device_finalize,
750 .class_base_init = device_class_base_init,
751 .class_init = device_class_init,
753 .class_size = sizeof(DeviceClass),
756 static void qbus_initfn(Object *obj)
758 BusState *bus = BUS(obj);
760 QTAILQ_INIT(&bus->children);
763 static void qbus_finalize(Object *obj)
765 BusState *bus = BUS(obj);
768 while ((kid = QTAILQ_FIRST(&bus->children)) != NULL) {
769 DeviceState *dev = kid->child;
773 QLIST_REMOVE(bus, sibling);
774 bus->parent->num_child_bus--;
776 assert(bus != sysbus_get_default()); /* main_system_bus is never freed */
777 qemu_unregister_reset(qbus_reset_all_fn, bus);
779 g_free((char *)bus->name);
782 static const TypeInfo bus_info = {
784 .parent = TYPE_OBJECT,
785 .instance_size = sizeof(BusState),
787 .class_size = sizeof(BusClass),
788 .instance_init = qbus_initfn,
789 .instance_finalize = qbus_finalize,
792 static void qdev_register_types(void)
794 type_register_static(&bus_info);
795 type_register_static(&device_type_info);
798 type_init(qdev_register_types)