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/qmp/qerror.h"
32 #include "qapi/visitor.h"
33 #include "qapi/qmp/qjson.h"
34 #include "monitor/monitor.h"
37 static bool qdev_hot_added
= false;
38 static bool qdev_hot_removed
= false;
40 const VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
)
42 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
46 const char *qdev_fw_name(DeviceState
*dev
)
48 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
54 return object_get_typename(OBJECT(dev
));
57 static void qdev_property_add_legacy(DeviceState
*dev
, Property
*prop
,
60 static void bus_remove_child(BusState
*bus
, DeviceState
*child
)
64 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
65 if (kid
->child
== child
) {
68 snprintf(name
, sizeof(name
), "child[%d]", kid
->index
);
69 QTAILQ_REMOVE(&bus
->children
, kid
, sibling
);
71 /* This gives back ownership of kid->child back to us. */
72 object_property_del(OBJECT(bus
), name
, NULL
);
73 object_unref(OBJECT(kid
->child
));
80 static void bus_add_child(BusState
*bus
, DeviceState
*child
)
83 BusChild
*kid
= g_malloc0(sizeof(*kid
));
86 assert(bus
->allow_hotplug
);
89 kid
->index
= bus
->max_index
++;
91 object_ref(OBJECT(kid
->child
));
93 QTAILQ_INSERT_HEAD(&bus
->children
, kid
, sibling
);
95 /* This transfers ownership of kid->child to the property. */
96 snprintf(name
, sizeof(name
), "child[%d]", kid
->index
);
97 object_property_add_link(OBJECT(bus
), name
,
98 object_get_typename(OBJECT(child
)),
99 (Object
**)&kid
->child
,
103 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
)
105 dev
->parent_bus
= bus
;
106 object_ref(OBJECT(bus
));
107 bus_add_child(bus
, dev
);
110 /* Create a new device. This only initializes the device state structure
111 and allows properties to be set. qdev_init should be called to
112 initialize the actual device emulation. */
113 DeviceState
*qdev_create(BusState
*bus
, const char *name
)
117 dev
= qdev_try_create(bus
, name
);
120 error_report("Unknown device '%s' for bus '%s'", name
,
121 object_get_typename(OBJECT(bus
)));
123 error_report("Unknown device '%s' for default sysbus", name
);
131 DeviceState
*qdev_try_create(BusState
*bus
, const char *type
)
135 if (object_class_by_name(type
) == NULL
) {
138 dev
= DEVICE(object_new(type
));
144 bus
= sysbus_get_default();
147 qdev_set_parent_bus(dev
, bus
);
148 object_unref(OBJECT(dev
));
152 /* Initialize a device. Device properties should be set before calling
153 this function. IRQs and MMIO regions should be connected/mapped after
154 calling this function.
155 On failure, destroy the device and return negative value.
156 Return 0 on success. */
157 int qdev_init(DeviceState
*dev
)
159 Error
*local_err
= NULL
;
161 assert(!dev
->realized
);
163 object_property_set_bool(OBJECT(dev
), true, "realized", &local_err
);
164 if (local_err
!= NULL
) {
165 qerror_report_err(local_err
);
166 error_free(local_err
);
167 object_unparent(OBJECT(dev
));
173 static void device_realize(DeviceState
*dev
, Error
**err
)
175 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
178 int rc
= dc
->init(dev
);
180 error_setg(err
, "Device initialization failed.");
186 static void device_unrealize(DeviceState
*dev
, Error
**errp
)
188 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
191 int rc
= dc
->exit(dev
);
193 error_setg(errp
, "Device exit failed.");
199 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
200 int required_for_version
)
202 assert(!dev
->realized
);
203 dev
->instance_id_alias
= alias_id
;
204 dev
->alias_required_for_version
= required_for_version
;
207 void qdev_unplug(DeviceState
*dev
, Error
**errp
)
209 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
211 if (dev
->parent_bus
&& !dev
->parent_bus
->allow_hotplug
) {
212 error_set(errp
, QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
215 assert(dc
->unplug
!= NULL
);
217 qdev_hot_removed
= true;
219 if (dc
->unplug(dev
) < 0) {
220 error_set(errp
, QERR_UNDEFINED_ERROR
);
225 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
232 static int qbus_reset_one(BusState
*bus
, void *opaque
)
234 BusClass
*bc
= BUS_GET_CLASS(bus
);
236 return bc
->reset(bus
);
241 void qdev_reset_all(DeviceState
*dev
)
243 qdev_walk_children(dev
, qdev_reset_one
, qbus_reset_one
, NULL
);
246 void qbus_reset_all(BusState
*bus
)
248 qbus_walk_children(bus
, qdev_reset_one
, qbus_reset_one
, NULL
);
251 void qbus_reset_all_fn(void *opaque
)
253 BusState
*bus
= opaque
;
257 /* can be used as ->unplug() callback for the simple cases */
258 int qdev_simple_unplug_cb(DeviceState
*dev
)
261 object_unparent(OBJECT(dev
));
266 /* Like qdev_init(), but terminate program via error_report() instead of
267 returning an error value. This is okay during machine creation.
268 Don't use for hotplug, because there callers need to recover from
269 failure. Exception: if you know the device's init() callback can't
270 fail, then qdev_init_nofail() can't fail either, and is therefore
271 usable even then. But relying on the device implementation that
272 way is somewhat unclean, and best avoided. */
273 void qdev_init_nofail(DeviceState
*dev
)
275 const char *typename
= object_get_typename(OBJECT(dev
));
277 if (qdev_init(dev
) < 0) {
278 error_report("Initialization of device %s failed", typename
);
283 void qdev_machine_creation_done(void)
286 * ok, initial machine setup is done, starting from now we can
287 * only create hotpluggable devices
292 bool qdev_machine_modified(void)
294 return qdev_hot_added
|| qdev_hot_removed
;
297 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
299 return dev
->parent_bus
;
302 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
304 dev
->gpio_in
= qemu_extend_irqs(dev
->gpio_in
, dev
->num_gpio_in
, handler
,
306 dev
->num_gpio_in
+= n
;
309 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
311 assert(dev
->num_gpio_out
== 0);
312 dev
->num_gpio_out
= n
;
313 dev
->gpio_out
= pins
;
316 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
318 assert(n
>= 0 && n
< dev
->num_gpio_in
);
319 return dev
->gpio_in
[n
];
322 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
324 assert(n
>= 0 && n
< dev
->num_gpio_out
);
325 dev
->gpio_out
[n
] = pin
;
328 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
)
332 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
333 if (strcmp(name
, bus
->name
) == 0) {
340 int qbus_walk_children(BusState
*bus
, qdev_walkerfn
*devfn
,
341 qbus_walkerfn
*busfn
, void *opaque
)
347 err
= busfn(bus
, opaque
);
353 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
354 err
= qdev_walk_children(kid
->child
, devfn
, busfn
, opaque
);
363 int qdev_walk_children(DeviceState
*dev
, qdev_walkerfn
*devfn
,
364 qbus_walkerfn
*busfn
, void *opaque
)
370 err
= devfn(dev
, opaque
);
376 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
377 err
= qbus_walk_children(bus
, devfn
, busfn
, opaque
);
386 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
)
392 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
393 DeviceState
*dev
= kid
->child
;
395 if (dev
->id
&& strcmp(dev
->id
, id
) == 0) {
399 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
400 ret
= qdev_find_recursive(child
, id
);
409 static void qbus_realize(BusState
*bus
, DeviceState
*parent
, const char *name
)
411 const char *typename
= object_get_typename(OBJECT(bus
));
415 bus
->parent
= parent
;
418 bus
->name
= g_strdup(name
);
419 } else if (bus
->parent
&& bus
->parent
->id
) {
420 /* parent device has id -> use it for bus name */
421 len
= strlen(bus
->parent
->id
) + 16;
423 snprintf(buf
, len
, "%s.%d", bus
->parent
->id
, bus
->parent
->num_child_bus
);
426 /* no id -> use lowercase bus type for bus name */
427 len
= strlen(typename
) + 16;
429 len
= snprintf(buf
, len
, "%s.%d", typename
,
430 bus
->parent
? bus
->parent
->num_child_bus
: 0);
431 for (i
= 0; i
< len
; i
++)
432 buf
[i
] = qemu_tolower(buf
[i
]);
437 QLIST_INSERT_HEAD(&bus
->parent
->child_bus
, bus
, sibling
);
438 bus
->parent
->num_child_bus
++;
439 object_property_add_child(OBJECT(bus
->parent
), bus
->name
, OBJECT(bus
), NULL
);
440 object_unref(OBJECT(bus
));
441 } else if (bus
!= sysbus_get_default()) {
442 /* TODO: once all bus devices are qdevified,
443 only reset handler for main_system_bus should be registered here. */
444 qemu_register_reset(qbus_reset_all_fn
, bus
);
448 static void bus_unparent(Object
*obj
)
450 BusState
*bus
= BUS(obj
);
453 while ((kid
= QTAILQ_FIRST(&bus
->children
)) != NULL
) {
454 DeviceState
*dev
= kid
->child
;
455 object_unparent(OBJECT(dev
));
458 QLIST_REMOVE(bus
, sibling
);
459 bus
->parent
->num_child_bus
--;
462 assert(bus
!= sysbus_get_default()); /* main_system_bus is never freed */
463 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
467 void qbus_create_inplace(void *bus
, size_t size
, const char *typename
,
468 DeviceState
*parent
, const char *name
)
470 object_initialize(bus
, size
, typename
);
471 qbus_realize(bus
, parent
, name
);
474 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
)
478 bus
= BUS(object_new(typename
));
479 qbus_realize(bus
, parent
, name
);
484 void qbus_free(BusState
*bus
)
486 object_unparent(OBJECT(bus
));
489 static char *bus_get_fw_dev_path(BusState
*bus
, DeviceState
*dev
)
491 BusClass
*bc
= BUS_GET_CLASS(bus
);
493 if (bc
->get_fw_dev_path
) {
494 return bc
->get_fw_dev_path(dev
);
500 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
504 if (dev
&& dev
->parent_bus
) {
506 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
507 d
= bus_get_fw_dev_path(dev
->parent_bus
, dev
);
509 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
515 l
+= snprintf(p
+ l
, size
- l
, "/");
520 char* qdev_get_fw_dev_path(DeviceState
*dev
)
525 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);
529 return g_strdup(path
);
532 char *qdev_get_dev_path(DeviceState
*dev
)
536 if (!dev
|| !dev
->parent_bus
) {
540 bc
= BUS_GET_CLASS(dev
->parent_bus
);
541 if (bc
->get_dev_path
) {
542 return bc
->get_dev_path(dev
);
549 * Legacy property handling
552 static void qdev_get_legacy_property(Object
*obj
, Visitor
*v
, void *opaque
,
553 const char *name
, Error
**errp
)
555 DeviceState
*dev
= DEVICE(obj
);
556 Property
*prop
= opaque
;
561 prop
->info
->print(dev
, prop
, buffer
, sizeof(buffer
));
562 visit_type_str(v
, &ptr
, name
, errp
);
565 static void qdev_set_legacy_property(Object
*obj
, Visitor
*v
, void *opaque
,
566 const char *name
, Error
**errp
)
568 DeviceState
*dev
= DEVICE(obj
);
569 Property
*prop
= opaque
;
570 Error
*local_err
= NULL
;
575 qdev_prop_set_after_realize(dev
, name
, errp
);
579 visit_type_str(v
, &ptr
, name
, &local_err
);
581 error_propagate(errp
, local_err
);
585 ret
= prop
->info
->parse(dev
, prop
, ptr
);
586 error_set_from_qdev_prop_error(errp
, ret
, dev
, prop
, ptr
);
591 * @qdev_add_legacy_property - adds a legacy property
593 * Do not use this is new code! Properties added through this interface will
594 * be given names and types in the "legacy" namespace.
596 * Legacy properties are string versions of other OOM properties. The format
597 * of the string depends on the property type.
599 void qdev_property_add_legacy(DeviceState
*dev
, Property
*prop
,
604 /* Register pointer properties as legacy properties */
605 if (!prop
->info
->print
&& !prop
->info
->parse
&&
606 (prop
->info
->set
|| prop
->info
->get
)) {
610 name
= g_strdup_printf("legacy-%s", prop
->name
);
611 type
= g_strdup_printf("legacy<%s>",
612 prop
->info
->legacy_name
?: prop
->info
->name
);
614 object_property_add(OBJECT(dev
), name
, type
,
615 prop
->info
->print
? qdev_get_legacy_property
: prop
->info
->get
,
616 prop
->info
->parse
? qdev_set_legacy_property
: prop
->info
->set
,
625 * @qdev_property_add_static - add a @Property to a device.
627 * Static properties access data in a struct. The actual type of the
628 * property and the field depends on the property type.
630 void qdev_property_add_static(DeviceState
*dev
, Property
*prop
,
633 Error
*local_err
= NULL
;
634 Object
*obj
= OBJECT(dev
);
637 * TODO qdev_prop_ptr does not have getters or setters. It must
638 * go now that it can be replaced with links. The test should be
639 * removed along with it: all static properties are read/write.
641 if (!prop
->info
->get
&& !prop
->info
->set
) {
645 object_property_add(obj
, prop
->name
, prop
->info
->name
,
646 prop
->info
->get
, prop
->info
->set
,
651 error_propagate(errp
, local_err
);
654 if (prop
->qtype
== QTYPE_NONE
) {
658 if (prop
->qtype
== QTYPE_QBOOL
) {
659 object_property_set_bool(obj
, prop
->defval
, prop
->name
, &local_err
);
660 } else if (prop
->info
->enum_table
) {
661 object_property_set_str(obj
, prop
->info
->enum_table
[prop
->defval
],
662 prop
->name
, &local_err
);
663 } else if (prop
->qtype
== QTYPE_QINT
) {
664 object_property_set_int(obj
, prop
->defval
, prop
->name
, &local_err
);
666 assert_no_error(local_err
);
669 static bool device_get_realized(Object
*obj
, Error
**err
)
671 DeviceState
*dev
= DEVICE(obj
);
672 return dev
->realized
;
675 static void device_set_realized(Object
*obj
, bool value
, Error
**err
)
677 DeviceState
*dev
= DEVICE(obj
);
678 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
679 Error
*local_err
= NULL
;
681 if (value
&& !dev
->realized
) {
682 if (!obj
->parent
&& local_err
== NULL
) {
683 static int unattached_count
;
684 gchar
*name
= g_strdup_printf("device[%d]", unattached_count
++);
686 object_property_add_child(container_get(qdev_get_machine(),
688 name
, obj
, &local_err
);
693 dc
->realize(dev
, &local_err
);
696 if (qdev_get_vmsd(dev
) && local_err
== NULL
) {
697 vmstate_register_with_alias_id(dev
, -1, qdev_get_vmsd(dev
), dev
,
698 dev
->instance_id_alias
,
699 dev
->alias_required_for_version
);
701 if (dev
->hotplugged
&& local_err
== NULL
) {
704 } else if (!value
&& dev
->realized
) {
705 if (qdev_get_vmsd(dev
)) {
706 vmstate_unregister(dev
, qdev_get_vmsd(dev
), dev
);
709 dc
->unrealize(dev
, &local_err
);
713 if (local_err
!= NULL
) {
714 error_propagate(err
, local_err
);
718 dev
->realized
= value
;
721 static void device_initfn(Object
*obj
)
723 DeviceState
*dev
= DEVICE(obj
);
730 qdev_hot_added
= true;
733 dev
->instance_id_alias
= -1;
734 dev
->realized
= false;
736 object_property_add_bool(obj
, "realized",
737 device_get_realized
, device_set_realized
, NULL
);
739 class = object_get_class(OBJECT(dev
));
741 for (prop
= DEVICE_CLASS(class)->props
; prop
&& prop
->name
; prop
++) {
742 qdev_property_add_legacy(dev
, prop
, &err
);
743 assert_no_error(err
);
744 qdev_property_add_static(dev
, prop
, &err
);
745 assert_no_error(err
);
747 class = object_class_get_parent(class);
748 } while (class != object_class_by_name(TYPE_DEVICE
));
750 qerror_report_err(err
);
755 object_property_add_link(OBJECT(dev
), "parent_bus", TYPE_BUS
,
756 (Object
**)&dev
->parent_bus
, &err
);
757 assert_no_error(err
);
760 static void device_post_init(Object
*obj
)
762 DeviceState
*dev
= DEVICE(obj
);
765 qdev_prop_set_globals(dev
, &err
);
766 assert_no_error(err
);
769 /* Unlink device from bus and free the structure. */
770 static void device_finalize(Object
*obj
)
772 DeviceState
*dev
= DEVICE(obj
);
774 qemu_opts_del(dev
->opts
);
778 static void device_class_base_init(ObjectClass
*class, void *data
)
780 DeviceClass
*klass
= DEVICE_CLASS(class);
782 /* We explicitly look up properties in the superclasses,
783 * so do not propagate them to the subclasses.
788 static void device_unparent(Object
*obj
)
790 DeviceState
*dev
= DEVICE(obj
);
793 bool have_realized
= dev
->realized
;
795 while (dev
->num_child_bus
) {
796 bus
= QLIST_FIRST(&dev
->child_bus
);
800 object_property_set_bool(obj
, false, "realized", NULL
);
802 if (dev
->parent_bus
) {
803 bus_remove_child(dev
->parent_bus
, dev
);
804 object_unref(OBJECT(dev
->parent_bus
));
805 dev
->parent_bus
= NULL
;
808 /* Only send event if the device had been completely realized */
810 gchar
*path
= object_get_canonical_path(OBJECT(dev
));
813 event_data
= qobject_from_jsonf("{ 'device': %s, 'path': %s }",
816 event_data
= qobject_from_jsonf("{ 'path': %s }", path
);
818 monitor_protocol_event(QEVENT_DEVICE_DELETED
, event_data
);
819 qobject_decref(event_data
);
824 static void device_class_init(ObjectClass
*class, void *data
)
826 DeviceClass
*dc
= DEVICE_CLASS(class);
828 class->unparent
= device_unparent
;
829 dc
->realize
= device_realize
;
830 dc
->unrealize
= device_unrealize
;
833 void device_reset(DeviceState
*dev
)
835 DeviceClass
*klass
= DEVICE_GET_CLASS(dev
);
842 Object
*qdev_get_machine(void)
847 dev
= container_get(object_get_root(), "/machine");
853 static const TypeInfo device_type_info
= {
855 .parent
= TYPE_OBJECT
,
856 .instance_size
= sizeof(DeviceState
),
857 .instance_init
= device_initfn
,
858 .instance_post_init
= device_post_init
,
859 .instance_finalize
= device_finalize
,
860 .class_base_init
= device_class_base_init
,
861 .class_init
= device_class_init
,
863 .class_size
= sizeof(DeviceClass
),
866 static void qbus_initfn(Object
*obj
)
868 BusState
*bus
= BUS(obj
);
870 QTAILQ_INIT(&bus
->children
);
873 static char *default_bus_get_fw_dev_path(DeviceState
*dev
)
875 return g_strdup(object_get_typename(OBJECT(dev
)));
878 static void bus_class_init(ObjectClass
*class, void *data
)
880 BusClass
*bc
= BUS_CLASS(class);
882 class->unparent
= bus_unparent
;
883 bc
->get_fw_dev_path
= default_bus_get_fw_dev_path
;
886 static void qbus_finalize(Object
*obj
)
888 BusState
*bus
= BUS(obj
);
890 g_free((char *)bus
->name
);
893 static const TypeInfo bus_info
= {
895 .parent
= TYPE_OBJECT
,
896 .instance_size
= sizeof(BusState
),
898 .class_size
= sizeof(BusClass
),
899 .instance_init
= qbus_initfn
,
900 .instance_finalize
= qbus_finalize
,
901 .class_init
= bus_class_init
,
904 static void qdev_register_types(void)
906 type_register_static(&bus_info
);
907 type_register_static(&device_type_info
);
910 type_init(qdev_register_types
)