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
29 #include "sysemu/sysemu.h"
30 #include "qapi/error.h"
31 #include "qapi/visitor.h"
34 static bool qdev_hot_added = false;
35 static bool qdev_hot_removed = false;
37 const VMStateDescription *qdev_get_vmsd(DeviceState *dev)
39 DeviceClass *dc = DEVICE_GET_CLASS(dev);
43 const char *qdev_fw_name(DeviceState *dev)
45 DeviceClass *dc = DEVICE_GET_CLASS(dev);
51 return object_get_typename(OBJECT(dev));
54 static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
57 static void bus_remove_child(BusState *bus, DeviceState *child)
61 QTAILQ_FOREACH(kid, &bus->children, sibling) {
62 if (kid->child == child) {
65 snprintf(name, sizeof(name), "child[%d]", kid->index);
66 QTAILQ_REMOVE(&bus->children, kid, sibling);
67 object_property_del(OBJECT(bus), name, NULL);
74 static void bus_add_child(BusState *bus, DeviceState *child)
77 BusChild *kid = g_malloc0(sizeof(*kid));
80 assert(bus->allow_hotplug);
83 kid->index = bus->max_index++;
86 QTAILQ_INSERT_HEAD(&bus->children, kid, sibling);
88 snprintf(name, sizeof(name), "child[%d]", kid->index);
89 object_property_add_link(OBJECT(bus), name,
90 object_get_typename(OBJECT(child)),
91 (Object **)&kid->child,
95 void qdev_set_parent_bus(DeviceState *dev, BusState *bus)
97 dev->parent_bus = bus;
98 bus_add_child(bus, dev);
101 /* Create a new device. This only initializes the device state structure
102 and allows properties to be set. qdev_init should be called to
103 initialize the actual device emulation. */
104 DeviceState *qdev_create(BusState *bus, const char *name)
108 dev = qdev_try_create(bus, name);
111 error_report("Unknown device '%s' for bus '%s'\n", name,
112 object_get_typename(OBJECT(bus)));
115 error_report("Unknown device '%s' for default sysbus\n", name);
123 DeviceState *qdev_try_create(BusState *bus, const char *type)
127 if (object_class_by_name(type) == NULL) {
130 dev = DEVICE(object_new(type));
136 bus = sysbus_get_default();
139 qdev_set_parent_bus(dev, bus);
144 /* Initialize a device. Device properties should be set before calling
145 this function. IRQs and MMIO regions should be connected/mapped after
146 calling this function.
147 On failure, destroy the device and return negative value.
148 Return 0 on success. */
149 int qdev_init(DeviceState *dev)
151 Error *local_err = NULL;
153 assert(!dev->realized);
155 object_property_set_bool(OBJECT(dev), true, "realized", &local_err);
156 if (local_err != NULL) {
157 error_free(local_err);
164 static void device_realize(DeviceState *dev, Error **err)
166 DeviceClass *dc = DEVICE_GET_CLASS(dev);
169 int rc = dc->init(dev);
171 error_setg(err, "Device initialization failed.");
177 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
178 int required_for_version)
180 assert(!dev->realized);
181 dev->instance_id_alias = alias_id;
182 dev->alias_required_for_version = required_for_version;
185 void qdev_unplug(DeviceState *dev, Error **errp)
187 DeviceClass *dc = DEVICE_GET_CLASS(dev);
189 if (!dev->parent_bus->allow_hotplug) {
190 error_set(errp, QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
193 assert(dc->unplug != NULL);
195 qdev_hot_removed = true;
197 if (dc->unplug(dev) < 0) {
198 error_set(errp, QERR_UNDEFINED_ERROR);
203 static int qdev_reset_one(DeviceState *dev, void *opaque)
210 static int qbus_reset_one(BusState *bus, void *opaque)
212 BusClass *bc = BUS_GET_CLASS(bus);
214 return bc->reset(bus);
219 void qdev_reset_all(DeviceState *dev)
221 qdev_walk_children(dev, qdev_reset_one, qbus_reset_one, NULL);
224 void qbus_reset_all(BusState *bus)
226 qbus_walk_children(bus, qdev_reset_one, qbus_reset_one, NULL);
229 void qbus_reset_all_fn(void *opaque)
231 BusState *bus = opaque;
235 /* can be used as ->unplug() callback for the simple cases */
236 int qdev_simple_unplug_cb(DeviceState *dev)
244 /* Like qdev_init(), but terminate program via error_report() instead of
245 returning an error value. This is okay during machine creation.
246 Don't use for hotplug, because there callers need to recover from
247 failure. Exception: if you know the device's init() callback can't
248 fail, then qdev_init_nofail() can't fail either, and is therefore
249 usable even then. But relying on the device implementation that
250 way is somewhat unclean, and best avoided. */
251 void qdev_init_nofail(DeviceState *dev)
253 const char *typename = object_get_typename(OBJECT(dev));
255 if (qdev_init(dev) < 0) {
256 error_report("Initialization of device %s failed", typename);
261 /* Unlink device from bus and free the structure. */
262 void qdev_free(DeviceState *dev)
264 object_delete(OBJECT(dev));
267 void qdev_machine_creation_done(void)
270 * ok, initial machine setup is done, starting from now we can
271 * only create hotpluggable devices
276 bool qdev_machine_modified(void)
278 return qdev_hot_added || qdev_hot_removed;
281 BusState *qdev_get_parent_bus(DeviceState *dev)
283 return dev->parent_bus;
286 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
288 dev->gpio_in = qemu_extend_irqs(dev->gpio_in, dev->num_gpio_in, handler,
290 dev->num_gpio_in += n;
293 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
295 assert(dev->num_gpio_out == 0);
296 dev->num_gpio_out = n;
297 dev->gpio_out = pins;
300 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
302 assert(n >= 0 && n < dev->num_gpio_in);
303 return dev->gpio_in[n];
306 void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
308 assert(n >= 0 && n < dev->num_gpio_out);
309 dev->gpio_out[n] = pin;
312 BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
316 QLIST_FOREACH(bus, &dev->child_bus, sibling) {
317 if (strcmp(name, bus->name) == 0) {
324 int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
325 qbus_walkerfn *busfn, void *opaque)
331 err = busfn(bus, opaque);
337 QTAILQ_FOREACH(kid, &bus->children, sibling) {
338 err = qdev_walk_children(kid->child, devfn, busfn, opaque);
347 int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
348 qbus_walkerfn *busfn, void *opaque)
354 err = devfn(dev, opaque);
360 QLIST_FOREACH(bus, &dev->child_bus, sibling) {
361 err = qbus_walk_children(bus, devfn, busfn, opaque);
370 DeviceState *qdev_find_recursive(BusState *bus, const char *id)
376 QTAILQ_FOREACH(kid, &bus->children, sibling) {
377 DeviceState *dev = kid->child;
379 if (dev->id && strcmp(dev->id, id) == 0) {
383 QLIST_FOREACH(child, &dev->child_bus, sibling) {
384 ret = qdev_find_recursive(child, id);
393 static void qbus_realize(BusState *bus, DeviceState *parent, const char *name)
395 const char *typename = object_get_typename(OBJECT(bus));
399 bus->parent = parent;
402 bus->name = g_strdup(name);
403 } else if (bus->parent && bus->parent->id) {
404 /* parent device has id -> use it for bus name */
405 len = strlen(bus->parent->id) + 16;
407 snprintf(buf, len, "%s.%d", bus->parent->id, bus->parent->num_child_bus);
410 /* no id -> use lowercase bus type for bus name */
411 len = strlen(typename) + 16;
413 len = snprintf(buf, len, "%s.%d", typename,
414 bus->parent ? bus->parent->num_child_bus : 0);
415 for (i = 0; i < len; i++)
416 buf[i] = qemu_tolower(buf[i]);
421 QLIST_INSERT_HEAD(&bus->parent->child_bus, bus, sibling);
422 bus->parent->num_child_bus++;
423 object_property_add_child(OBJECT(bus->parent), bus->name, OBJECT(bus), NULL);
424 } else if (bus != sysbus_get_default()) {
425 /* TODO: once all bus devices are qdevified,
426 only reset handler for main_system_bus should be registered here. */
427 qemu_register_reset(qbus_reset_all_fn, bus);
431 void qbus_create_inplace(BusState *bus, const char *typename,
432 DeviceState *parent, const char *name)
434 object_initialize(bus, typename);
435 qbus_realize(bus, parent, name);
438 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name)
442 bus = BUS(object_new(typename));
443 qbus_realize(bus, parent, name);
448 void qbus_free(BusState *bus)
450 object_delete(OBJECT(bus));
453 static char *bus_get_fw_dev_path(BusState *bus, DeviceState *dev)
455 BusClass *bc = BUS_GET_CLASS(bus);
457 if (bc->get_fw_dev_path) {
458 return bc->get_fw_dev_path(dev);
464 static int qdev_get_fw_dev_path_helper(DeviceState *dev, char *p, int size)
468 if (dev && dev->parent_bus) {
470 l = qdev_get_fw_dev_path_helper(dev->parent_bus->parent, p, size);
471 d = bus_get_fw_dev_path(dev->parent_bus, dev);
473 l += snprintf(p + l, size - l, "%s", d);
476 l += snprintf(p + l, size - l, "%s", object_get_typename(OBJECT(dev)));
479 l += snprintf(p + l , size - l, "/");
484 char* qdev_get_fw_dev_path(DeviceState *dev)
489 l = qdev_get_fw_dev_path_helper(dev, path, 128);
493 return g_strdup(path);
496 char *qdev_get_dev_path(DeviceState *dev)
500 if (!dev || !dev->parent_bus) {
504 bc = BUS_GET_CLASS(dev->parent_bus);
505 if (bc->get_dev_path) {
506 return bc->get_dev_path(dev);
513 * Legacy property handling
516 static void qdev_get_legacy_property(Object *obj, Visitor *v, void *opaque,
517 const char *name, Error **errp)
519 DeviceState *dev = DEVICE(obj);
520 Property *prop = opaque;
525 prop->info->print(dev, prop, buffer, sizeof(buffer));
526 visit_type_str(v, &ptr, name, errp);
529 static void qdev_set_legacy_property(Object *obj, Visitor *v, void *opaque,
530 const char *name, Error **errp)
532 DeviceState *dev = DEVICE(obj);
533 Property *prop = opaque;
534 Error *local_err = NULL;
539 error_set(errp, QERR_PERMISSION_DENIED);
543 visit_type_str(v, &ptr, name, &local_err);
545 error_propagate(errp, local_err);
549 ret = prop->info->parse(dev, prop, ptr);
550 error_set_from_qdev_prop_error(errp, ret, dev, prop, ptr);
555 * @qdev_add_legacy_property - adds a legacy property
557 * Do not use this is new code! Properties added through this interface will
558 * be given names and types in the "legacy" namespace.
560 * Legacy properties are string versions of other OOM properties. The format
561 * of the string depends on the property type.
563 void qdev_property_add_legacy(DeviceState *dev, Property *prop,
568 /* Register pointer properties as legacy properties */
569 if (!prop->info->print && !prop->info->parse &&
570 (prop->info->set || prop->info->get)) {
574 name = g_strdup_printf("legacy-%s", prop->name);
575 type = g_strdup_printf("legacy<%s>",
576 prop->info->legacy_name ?: prop->info->name);
578 object_property_add(OBJECT(dev), name, type,
579 prop->info->print ? qdev_get_legacy_property : prop->info->get,
580 prop->info->parse ? qdev_set_legacy_property : prop->info->set,
589 * @qdev_property_add_static - add a @Property to a device.
591 * Static properties access data in a struct. The actual type of the
592 * property and the field depends on the property type.
594 void qdev_property_add_static(DeviceState *dev, Property *prop,
597 Error *local_err = NULL;
598 Object *obj = OBJECT(dev);
601 * TODO qdev_prop_ptr does not have getters or setters. It must
602 * go now that it can be replaced with links. The test should be
603 * removed along with it: all static properties are read/write.
605 if (!prop->info->get && !prop->info->set) {
609 object_property_add(obj, prop->name, prop->info->name,
610 prop->info->get, prop->info->set,
615 error_propagate(errp, local_err);
618 if (prop->qtype == QTYPE_NONE) {
622 if (prop->qtype == QTYPE_QBOOL) {
623 object_property_set_bool(obj, prop->defval, prop->name, &local_err);
624 } else if (prop->info->enum_table) {
625 object_property_set_str(obj, prop->info->enum_table[prop->defval],
626 prop->name, &local_err);
627 } else if (prop->qtype == QTYPE_QINT) {
628 object_property_set_int(obj, prop->defval, prop->name, &local_err);
630 assert_no_error(local_err);
633 static bool device_get_realized(Object *obj, Error **err)
635 DeviceState *dev = DEVICE(obj);
636 return dev->realized;
639 static void device_set_realized(Object *obj, bool value, Error **err)
641 DeviceState *dev = DEVICE(obj);
642 DeviceClass *dc = DEVICE_GET_CLASS(dev);
643 Error *local_err = NULL;
645 if (value && !dev->realized) {
647 dc->realize(dev, &local_err);
650 if (!obj->parent && local_err == NULL) {
651 static int unattached_count;
652 gchar *name = g_strdup_printf("device[%d]", unattached_count++);
654 object_property_add_child(container_get(qdev_get_machine(),
656 name, obj, &local_err);
660 if (qdev_get_vmsd(dev) && local_err == NULL) {
661 vmstate_register_with_alias_id(dev, -1, qdev_get_vmsd(dev), dev,
662 dev->instance_id_alias,
663 dev->alias_required_for_version);
665 if (dev->hotplugged && local_err == NULL) {
668 } else if (!value && dev->realized) {
670 dc->unrealize(dev, &local_err);
674 if (local_err != NULL) {
675 error_propagate(err, local_err);
679 dev->realized = value;
682 static void device_initfn(Object *obj)
684 DeviceState *dev = DEVICE(obj);
690 qdev_hot_added = true;
693 dev->instance_id_alias = -1;
694 dev->realized = false;
696 object_property_add_bool(obj, "realized",
697 device_get_realized, device_set_realized, NULL);
699 class = object_get_class(OBJECT(dev));
701 for (prop = DEVICE_CLASS(class)->props; prop && prop->name; prop++) {
702 qdev_property_add_legacy(dev, prop, NULL);
703 qdev_property_add_static(dev, prop, NULL);
705 class = object_class_get_parent(class);
706 } while (class != object_class_by_name(TYPE_DEVICE));
707 qdev_prop_set_globals(dev);
709 object_property_add_link(OBJECT(dev), "parent_bus", TYPE_BUS,
710 (Object **)&dev->parent_bus, NULL);
713 /* Unlink device from bus and free the structure. */
714 static void device_finalize(Object *obj)
716 DeviceState *dev = DEVICE(obj);
718 DeviceClass *dc = DEVICE_GET_CLASS(dev);
721 while (dev->num_child_bus) {
722 bus = QLIST_FIRST(&dev->child_bus);
725 if (qdev_get_vmsd(dev)) {
726 vmstate_unregister(dev, qdev_get_vmsd(dev), dev);
732 qemu_opts_del(dev->opts);
737 static void device_class_base_init(ObjectClass *class, void *data)
739 DeviceClass *klass = DEVICE_CLASS(class);
741 /* We explicitly look up properties in the superclasses,
742 * so do not propagate them to the subclasses.
747 static void device_unparent(Object *obj)
749 DeviceState *dev = DEVICE(obj);
751 if (dev->parent_bus != NULL) {
752 bus_remove_child(dev->parent_bus, dev);
756 static void device_class_init(ObjectClass *class, void *data)
758 DeviceClass *dc = DEVICE_CLASS(class);
760 class->unparent = device_unparent;
761 dc->realize = device_realize;
764 void device_reset(DeviceState *dev)
766 DeviceClass *klass = DEVICE_GET_CLASS(dev);
773 Object *qdev_get_machine(void)
778 dev = container_get(object_get_root(), "/machine");
784 static const TypeInfo device_type_info = {
786 .parent = TYPE_OBJECT,
787 .instance_size = sizeof(DeviceState),
788 .instance_init = device_initfn,
789 .instance_finalize = device_finalize,
790 .class_base_init = device_class_base_init,
791 .class_init = device_class_init,
793 .class_size = sizeof(DeviceClass),
796 static void qbus_initfn(Object *obj)
798 BusState *bus = BUS(obj);
800 QTAILQ_INIT(&bus->children);
803 static void qbus_finalize(Object *obj)
805 BusState *bus = BUS(obj);
808 while ((kid = QTAILQ_FIRST(&bus->children)) != NULL) {
809 DeviceState *dev = kid->child;
813 QLIST_REMOVE(bus, sibling);
814 bus->parent->num_child_bus--;
816 assert(bus != sysbus_get_default()); /* main_system_bus is never freed */
817 qemu_unregister_reset(qbus_reset_all_fn, bus);
819 g_free((char *)bus->name);
822 static const TypeInfo bus_info = {
824 .parent = TYPE_OBJECT,
825 .instance_size = sizeof(BusState),
827 .class_size = sizeof(BusClass),
828 .instance_init = qbus_initfn,
829 .instance_finalize = qbus_finalize,
832 static void qdev_register_types(void)
834 type_register_static(&bus_info);
835 type_register_static(&device_type_info);
838 type_init(qdev_register_types)