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 "hw/fw-path-provider.h"
30 #include "sysemu/sysemu.h"
31 #include "qapi/error.h"
32 #include "qapi/qmp/qerror.h"
33 #include "qapi/visitor.h"
34 #include "qapi/qmp/qjson.h"
35 #include "qemu/error-report.h"
36 #include "hw/hotplug.h"
37 #include "hw/boards.h"
38 #include "qapi-event.h"
41 static bool qdev_hot_added
= false;
42 static bool qdev_hot_removed
= false;
44 const VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
)
46 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
50 const char *qdev_fw_name(DeviceState
*dev
)
52 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
58 return object_get_typename(OBJECT(dev
));
61 static void qdev_property_add_legacy(DeviceState
*dev
, Property
*prop
,
64 static void bus_remove_child(BusState
*bus
, DeviceState
*child
)
68 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
69 if (kid
->child
== child
) {
72 snprintf(name
, sizeof(name
), "child[%d]", kid
->index
);
73 QTAILQ_REMOVE(&bus
->children
, kid
, sibling
);
75 /* This gives back ownership of kid->child back to us. */
76 object_property_del(OBJECT(bus
), name
, NULL
);
77 object_unref(OBJECT(kid
->child
));
84 static void bus_add_child(BusState
*bus
, DeviceState
*child
)
87 BusChild
*kid
= g_malloc0(sizeof(*kid
));
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
,
100 NULL
, /* read-only property */
101 0, /* return ownership on prop deletion */
105 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
)
107 dev
->parent_bus
= bus
;
108 object_ref(OBJECT(bus
));
109 bus_add_child(bus
, dev
);
112 static void qbus_set_hotplug_handler_internal(BusState
*bus
, Object
*handler
,
116 object_property_set_link(OBJECT(bus
), OBJECT(handler
),
117 QDEV_HOTPLUG_HANDLER_PROPERTY
, errp
);
120 void qbus_set_hotplug_handler(BusState
*bus
, DeviceState
*handler
, Error
**errp
)
122 qbus_set_hotplug_handler_internal(bus
, OBJECT(handler
), errp
);
125 void qbus_set_bus_hotplug_handler(BusState
*bus
, Error
**errp
)
127 qbus_set_hotplug_handler_internal(bus
, OBJECT(bus
), errp
);
130 /* Create a new device. This only initializes the device state
131 structure and allows properties to be set. The device still needs
132 to be realized. See qdev-core.h. */
133 DeviceState
*qdev_create(BusState
*bus
, const char *name
)
137 dev
= qdev_try_create(bus
, name
);
140 error_report("Unknown device '%s' for bus '%s'", name
,
141 object_get_typename(OBJECT(bus
)));
143 error_report("Unknown device '%s' for default sysbus", name
);
151 DeviceState
*qdev_try_create(BusState
*bus
, const char *type
)
155 if (object_class_by_name(type
) == NULL
) {
158 dev
= DEVICE(object_new(type
));
164 bus
= sysbus_get_default();
167 qdev_set_parent_bus(dev
, bus
);
168 object_unref(OBJECT(dev
));
172 static QTAILQ_HEAD(device_listeners
, DeviceListener
) device_listeners
173 = QTAILQ_HEAD_INITIALIZER(device_listeners
);
175 enum ListenerDirection
{ Forward
, Reverse
};
177 #define DEVICE_LISTENER_CALL(_callback, _direction, _args...) \
179 DeviceListener *_listener; \
181 switch (_direction) { \
183 QTAILQ_FOREACH(_listener, &device_listeners, link) { \
184 if (_listener->_callback) { \
185 _listener->_callback(_listener, ##_args); \
190 QTAILQ_FOREACH_REVERSE(_listener, &device_listeners, \
191 device_listeners, link) { \
192 if (_listener->_callback) { \
193 _listener->_callback(_listener, ##_args); \
202 static int device_listener_add(DeviceState
*dev
, void *opaque
)
204 DEVICE_LISTENER_CALL(realize
, Forward
, dev
);
209 void device_listener_register(DeviceListener
*listener
)
211 QTAILQ_INSERT_TAIL(&device_listeners
, listener
, link
);
213 qbus_walk_children(sysbus_get_default(), NULL
, NULL
, device_listener_add
,
217 void device_listener_unregister(DeviceListener
*listener
)
219 QTAILQ_REMOVE(&device_listeners
, listener
, link
);
222 static void device_realize(DeviceState
*dev
, Error
**errp
)
224 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
227 int rc
= dc
->init(dev
);
229 error_setg(errp
, "Device initialization failed.");
235 static void device_unrealize(DeviceState
*dev
, Error
**errp
)
237 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
240 int rc
= dc
->exit(dev
);
242 error_setg(errp
, "Device exit failed.");
248 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
249 int required_for_version
)
251 assert(!dev
->realized
);
252 dev
->instance_id_alias
= alias_id
;
253 dev
->alias_required_for_version
= required_for_version
;
256 HotplugHandler
*qdev_get_hotplug_handler(DeviceState
*dev
)
258 HotplugHandler
*hotplug_ctrl
= NULL
;
260 if (dev
->parent_bus
&& dev
->parent_bus
->hotplug_handler
) {
261 hotplug_ctrl
= dev
->parent_bus
->hotplug_handler
;
262 } else if (object_dynamic_cast(qdev_get_machine(), TYPE_MACHINE
)) {
263 MachineState
*machine
= MACHINE(qdev_get_machine());
264 MachineClass
*mc
= MACHINE_GET_CLASS(machine
);
266 if (mc
->get_hotplug_handler
) {
267 hotplug_ctrl
= mc
->get_hotplug_handler(machine
, dev
);
273 void qdev_unplug(DeviceState
*dev
, Error
**errp
)
275 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
276 HotplugHandler
*hotplug_ctrl
;
277 HotplugHandlerClass
*hdc
;
279 if (dev
->parent_bus
&& !qbus_is_hotpluggable(dev
->parent_bus
)) {
280 error_setg(errp
, QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
284 if (!dc
->hotpluggable
) {
285 error_setg(errp
, QERR_DEVICE_NO_HOTPLUG
,
286 object_get_typename(OBJECT(dev
)));
290 qdev_hot_removed
= true;
292 hotplug_ctrl
= qdev_get_hotplug_handler(dev
);
293 /* hotpluggable device MUST have HotplugHandler, if it doesn't
294 * then something is very wrong with it */
295 g_assert(hotplug_ctrl
);
297 /* If device supports async unplug just request it to be done,
298 * otherwise just remove it synchronously */
299 hdc
= HOTPLUG_HANDLER_GET_CLASS(hotplug_ctrl
);
300 if (hdc
->unplug_request
) {
301 hotplug_handler_unplug_request(hotplug_ctrl
, dev
, errp
);
303 hotplug_handler_unplug(hotplug_ctrl
, dev
, errp
);
307 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
314 static int qbus_reset_one(BusState
*bus
, void *opaque
)
316 BusClass
*bc
= BUS_GET_CLASS(bus
);
323 void qdev_reset_all(DeviceState
*dev
)
325 qdev_walk_children(dev
, NULL
, NULL
, qdev_reset_one
, qbus_reset_one
, NULL
);
328 void qbus_reset_all(BusState
*bus
)
330 qbus_walk_children(bus
, NULL
, NULL
, qdev_reset_one
, qbus_reset_one
, NULL
);
333 void qbus_reset_all_fn(void *opaque
)
335 BusState
*bus
= opaque
;
339 /* can be used as ->unplug() callback for the simple cases */
340 void qdev_simple_device_unplug_cb(HotplugHandler
*hotplug_dev
,
341 DeviceState
*dev
, Error
**errp
)
344 object_unparent(OBJECT(dev
));
349 * Device properties should be set before calling this function. IRQs
350 * and MMIO regions should be connected/mapped after calling this
352 * On failure, report an error with error_report() and terminate the
353 * program. This is okay during machine creation. Don't use for
354 * hotplug, because there callers need to recover from failure.
355 * Exception: if you know the device's init() callback can't fail,
356 * then qdev_init_nofail() can't fail either, and is therefore usable
357 * even then. But relying on the device implementation that way is
358 * somewhat unclean, and best avoided.
360 void qdev_init_nofail(DeviceState
*dev
)
364 assert(!dev
->realized
);
366 object_property_set_bool(OBJECT(dev
), true, "realized", &err
);
368 error_report("Initialization of device %s failed: %s",
369 object_get_typename(OBJECT(dev
)),
370 error_get_pretty(err
));
375 void qdev_machine_creation_done(void)
378 * ok, initial machine setup is done, starting from now we can
379 * only create hotpluggable devices
384 bool qdev_machine_modified(void)
386 return qdev_hot_added
|| qdev_hot_removed
;
389 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
391 return dev
->parent_bus
;
394 static NamedGPIOList
*qdev_get_named_gpio_list(DeviceState
*dev
,
399 QLIST_FOREACH(ngl
, &dev
->gpios
, node
) {
400 /* NULL is a valid and matchable name, otherwise do a normal
403 if ((!ngl
->name
&& !name
) ||
404 (name
&& ngl
->name
&& strcmp(name
, ngl
->name
) == 0)) {
409 ngl
= g_malloc0(sizeof(*ngl
));
410 ngl
->name
= g_strdup(name
);
411 QLIST_INSERT_HEAD(&dev
->gpios
, ngl
, node
);
415 void qdev_init_gpio_in_named(DeviceState
*dev
, qemu_irq_handler handler
,
416 const char *name
, int n
)
419 NamedGPIOList
*gpio_list
= qdev_get_named_gpio_list(dev
, name
);
420 char *propname
= g_strdup_printf("%s[*]", name
? name
: "unnamed-gpio-in");
422 assert(gpio_list
->num_out
== 0 || !name
);
423 gpio_list
->in
= qemu_extend_irqs(gpio_list
->in
, gpio_list
->num_in
, handler
,
426 for (i
= gpio_list
->num_in
; i
< gpio_list
->num_in
+ n
; i
++) {
427 object_property_add_child(OBJECT(dev
), propname
,
428 OBJECT(gpio_list
->in
[i
]), &error_abort
);
432 gpio_list
->num_in
+= n
;
435 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
437 qdev_init_gpio_in_named(dev
, handler
, NULL
, n
);
440 void qdev_init_gpio_out_named(DeviceState
*dev
, qemu_irq
*pins
,
441 const char *name
, int n
)
444 NamedGPIOList
*gpio_list
= qdev_get_named_gpio_list(dev
, name
);
445 char *propname
= g_strdup_printf("%s[*]", name
? name
: "unnamed-gpio-out");
447 assert(gpio_list
->num_in
== 0 || !name
);
448 gpio_list
->num_out
+= n
;
450 for (i
= 0; i
< n
; ++i
) {
451 memset(&pins
[i
], 0, sizeof(*pins
));
452 object_property_add_link(OBJECT(dev
), propname
, TYPE_IRQ
,
454 object_property_allow_set_link
,
455 OBJ_PROP_LINK_UNREF_ON_RELEASE
,
461 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
463 qdev_init_gpio_out_named(dev
, pins
, NULL
, n
);
466 qemu_irq
qdev_get_gpio_in_named(DeviceState
*dev
, const char *name
, int n
)
468 NamedGPIOList
*gpio_list
= qdev_get_named_gpio_list(dev
, name
);
470 assert(n
>= 0 && n
< gpio_list
->num_in
);
471 return gpio_list
->in
[n
];
474 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
476 return qdev_get_gpio_in_named(dev
, NULL
, n
);
479 void qdev_connect_gpio_out_named(DeviceState
*dev
, const char *name
, int n
,
482 char *propname
= g_strdup_printf("%s[%d]",
483 name
? name
: "unnamed-gpio-out", n
);
485 /* We need a name for object_property_set_link to work. If the
486 * object has a parent, object_property_add_child will come back
487 * with an error without doing anything. If it has none, it will
488 * never fail. So we can just call it with a NULL Error pointer.
490 object_property_add_child(container_get(qdev_get_machine(),
492 "non-qdev-gpio[*]", OBJECT(pin
), NULL
);
494 object_property_set_link(OBJECT(dev
), OBJECT(pin
), propname
, &error_abort
);
498 qemu_irq
qdev_get_gpio_out_connector(DeviceState
*dev
, const char *name
, int n
)
500 char *propname
= g_strdup_printf("%s[%d]",
501 name
? name
: "unnamed-gpio-out", n
);
503 qemu_irq ret
= (qemu_irq
)object_property_get_link(OBJECT(dev
), propname
,
509 /* disconnect a GPIO ouput, returning the disconnected input (if any) */
511 static qemu_irq
qdev_disconnect_gpio_out_named(DeviceState
*dev
,
512 const char *name
, int n
)
514 char *propname
= g_strdup_printf("%s[%d]",
515 name
? name
: "unnamed-gpio-out", n
);
517 qemu_irq ret
= (qemu_irq
)object_property_get_link(OBJECT(dev
), propname
,
520 object_property_set_link(OBJECT(dev
), NULL
, propname
, NULL
);
526 qemu_irq
qdev_intercept_gpio_out(DeviceState
*dev
, qemu_irq icpt
,
527 const char *name
, int n
)
529 qemu_irq disconnected
= qdev_disconnect_gpio_out_named(dev
, name
, n
);
530 qdev_connect_gpio_out_named(dev
, name
, n
, icpt
);
534 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
536 qdev_connect_gpio_out_named(dev
, NULL
, n
, pin
);
539 void qdev_pass_gpios(DeviceState
*dev
, DeviceState
*container
,
543 NamedGPIOList
*ngl
= qdev_get_named_gpio_list(dev
, name
);
545 for (i
= 0; i
< ngl
->num_in
; i
++) {
546 const char *nm
= ngl
->name
? ngl
->name
: "unnamed-gpio-in";
547 char *propname
= g_strdup_printf("%s[%d]", nm
, i
);
549 object_property_add_alias(OBJECT(container
), propname
,
550 OBJECT(dev
), propname
,
554 for (i
= 0; i
< ngl
->num_out
; i
++) {
555 const char *nm
= ngl
->name
? ngl
->name
: "unnamed-gpio-out";
556 char *propname
= g_strdup_printf("%s[%d]", nm
, i
);
558 object_property_add_alias(OBJECT(container
), propname
,
559 OBJECT(dev
), propname
,
563 QLIST_REMOVE(ngl
, node
);
564 QLIST_INSERT_HEAD(&container
->gpios
, ngl
, node
);
567 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
)
571 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
572 if (strcmp(name
, bus
->name
) == 0) {
579 int qbus_walk_children(BusState
*bus
,
580 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
581 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
588 err
= pre_busfn(bus
, opaque
);
594 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
595 err
= qdev_walk_children(kid
->child
,
596 pre_devfn
, pre_busfn
,
597 post_devfn
, post_busfn
, opaque
);
604 err
= post_busfn(bus
, opaque
);
613 int qdev_walk_children(DeviceState
*dev
,
614 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
615 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
622 err
= pre_devfn(dev
, opaque
);
628 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
629 err
= qbus_walk_children(bus
, pre_devfn
, pre_busfn
,
630 post_devfn
, post_busfn
, opaque
);
637 err
= post_devfn(dev
, opaque
);
646 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
)
652 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
653 DeviceState
*dev
= kid
->child
;
655 if (dev
->id
&& strcmp(dev
->id
, id
) == 0) {
659 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
660 ret
= qdev_find_recursive(child
, id
);
669 static void qbus_realize(BusState
*bus
, DeviceState
*parent
, const char *name
)
671 const char *typename
= object_get_typename(OBJECT(bus
));
676 bus
->parent
= parent
;
679 bus
->name
= g_strdup(name
);
680 } else if (bus
->parent
&& bus
->parent
->id
) {
681 /* parent device has id -> use it plus parent-bus-id for bus name */
682 bus_id
= bus
->parent
->num_child_bus
;
684 len
= strlen(bus
->parent
->id
) + 16;
686 snprintf(buf
, len
, "%s.%d", bus
->parent
->id
, bus_id
);
689 /* no id -> use lowercase bus type plus global bus-id for bus name */
690 bc
= BUS_GET_CLASS(bus
);
691 bus_id
= bc
->automatic_ids
++;
693 len
= strlen(typename
) + 16;
695 len
= snprintf(buf
, len
, "%s.%d", typename
, bus_id
);
696 for (i
= 0; i
< len
; i
++) {
697 buf
[i
] = qemu_tolower(buf
[i
]);
703 QLIST_INSERT_HEAD(&bus
->parent
->child_bus
, bus
, sibling
);
704 bus
->parent
->num_child_bus
++;
705 object_property_add_child(OBJECT(bus
->parent
), bus
->name
, OBJECT(bus
), NULL
);
706 object_unref(OBJECT(bus
));
707 } else if (bus
!= sysbus_get_default()) {
708 /* TODO: once all bus devices are qdevified,
709 only reset handler for main_system_bus should be registered here. */
710 qemu_register_reset(qbus_reset_all_fn
, bus
);
714 static void bus_unparent(Object
*obj
)
716 BusState
*bus
= BUS(obj
);
719 while ((kid
= QTAILQ_FIRST(&bus
->children
)) != NULL
) {
720 DeviceState
*dev
= kid
->child
;
721 object_unparent(OBJECT(dev
));
724 QLIST_REMOVE(bus
, sibling
);
725 bus
->parent
->num_child_bus
--;
728 assert(bus
!= sysbus_get_default()); /* main_system_bus is never freed */
729 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
733 static bool bus_get_realized(Object
*obj
, Error
**errp
)
735 BusState
*bus
= BUS(obj
);
737 return bus
->realized
;
740 static void bus_set_realized(Object
*obj
, bool value
, Error
**errp
)
742 BusState
*bus
= BUS(obj
);
743 BusClass
*bc
= BUS_GET_CLASS(bus
);
745 Error
*local_err
= NULL
;
747 if (value
&& !bus
->realized
) {
749 bc
->realize(bus
, &local_err
);
752 /* TODO: recursive realization */
753 } else if (!value
&& bus
->realized
) {
754 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
755 DeviceState
*dev
= kid
->child
;
756 object_property_set_bool(OBJECT(dev
), false, "realized",
758 if (local_err
!= NULL
) {
762 if (bc
->unrealize
&& local_err
== NULL
) {
763 bc
->unrealize(bus
, &local_err
);
767 if (local_err
!= NULL
) {
768 error_propagate(errp
, local_err
);
772 bus
->realized
= value
;
775 void qbus_create_inplace(void *bus
, size_t size
, const char *typename
,
776 DeviceState
*parent
, const char *name
)
778 object_initialize(bus
, size
, typename
);
779 qbus_realize(bus
, parent
, name
);
782 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
)
786 bus
= BUS(object_new(typename
));
787 qbus_realize(bus
, parent
, name
);
792 static char *bus_get_fw_dev_path(BusState
*bus
, DeviceState
*dev
)
794 BusClass
*bc
= BUS_GET_CLASS(bus
);
796 if (bc
->get_fw_dev_path
) {
797 return bc
->get_fw_dev_path(dev
);
803 static char *qdev_get_fw_dev_path_from_handler(BusState
*bus
, DeviceState
*dev
)
805 Object
*obj
= OBJECT(dev
);
808 while (!d
&& obj
->parent
) {
810 d
= fw_path_provider_try_get_dev_path(obj
, bus
, dev
);
815 char *qdev_get_own_fw_dev_path_from_handler(BusState
*bus
, DeviceState
*dev
)
817 Object
*obj
= OBJECT(dev
);
819 return fw_path_provider_try_get_dev_path(obj
, bus
, dev
);
822 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
826 if (dev
&& dev
->parent_bus
) {
828 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
829 d
= qdev_get_fw_dev_path_from_handler(dev
->parent_bus
, dev
);
831 d
= bus_get_fw_dev_path(dev
->parent_bus
, dev
);
834 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
840 l
+= snprintf(p
+ l
, size
- l
, "/");
845 char* qdev_get_fw_dev_path(DeviceState
*dev
)
850 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);
854 return g_strdup(path
);
857 char *qdev_get_dev_path(DeviceState
*dev
)
861 if (!dev
|| !dev
->parent_bus
) {
865 bc
= BUS_GET_CLASS(dev
->parent_bus
);
866 if (bc
->get_dev_path
) {
867 return bc
->get_dev_path(dev
);
874 * Legacy property handling
877 static void qdev_get_legacy_property(Object
*obj
, Visitor
*v
, void *opaque
,
878 const char *name
, Error
**errp
)
880 DeviceState
*dev
= DEVICE(obj
);
881 Property
*prop
= opaque
;
886 prop
->info
->print(dev
, prop
, buffer
, sizeof(buffer
));
887 visit_type_str(v
, &ptr
, name
, errp
);
891 * @qdev_add_legacy_property - adds a legacy property
893 * Do not use this is new code! Properties added through this interface will
894 * be given names and types in the "legacy" namespace.
896 * Legacy properties are string versions of other OOM properties. The format
897 * of the string depends on the property type.
899 static void qdev_property_add_legacy(DeviceState
*dev
, Property
*prop
,
904 /* Register pointer properties as legacy properties */
905 if (!prop
->info
->print
&& prop
->info
->get
) {
909 name
= g_strdup_printf("legacy-%s", prop
->name
);
910 object_property_add(OBJECT(dev
), name
, "str",
911 prop
->info
->print
? qdev_get_legacy_property
: prop
->info
->get
,
920 * @qdev_property_add_static - add a @Property to a device.
922 * Static properties access data in a struct. The actual type of the
923 * property and the field depends on the property type.
925 void qdev_property_add_static(DeviceState
*dev
, Property
*prop
,
928 Error
*local_err
= NULL
;
929 Object
*obj
= OBJECT(dev
);
932 * TODO qdev_prop_ptr does not have getters or setters. It must
933 * go now that it can be replaced with links. The test should be
934 * removed along with it: all static properties are read/write.
936 if (!prop
->info
->get
&& !prop
->info
->set
) {
940 object_property_add(obj
, prop
->name
, prop
->info
->name
,
941 prop
->info
->get
, prop
->info
->set
,
946 error_propagate(errp
, local_err
);
950 object_property_set_description(obj
, prop
->name
,
951 prop
->info
->description
,
954 if (prop
->qtype
== QTYPE_NONE
) {
958 if (prop
->qtype
== QTYPE_QBOOL
) {
959 object_property_set_bool(obj
, prop
->defval
, prop
->name
, &error_abort
);
960 } else if (prop
->info
->enum_table
) {
961 object_property_set_str(obj
, prop
->info
->enum_table
[prop
->defval
],
962 prop
->name
, &error_abort
);
963 } else if (prop
->qtype
== QTYPE_QINT
) {
964 object_property_set_int(obj
, prop
->defval
, prop
->name
, &error_abort
);
968 /* @qdev_alias_all_properties - Add alias properties to the source object for
969 * all qdev properties on the target DeviceState.
971 void qdev_alias_all_properties(DeviceState
*target
, Object
*source
)
976 class = object_get_class(OBJECT(target
));
978 DeviceClass
*dc
= DEVICE_CLASS(class);
980 for (prop
= dc
->props
; prop
&& prop
->name
; prop
++) {
981 object_property_add_alias(source
, prop
->name
,
982 OBJECT(target
), prop
->name
,
985 class = object_class_get_parent(class);
986 } while (class != object_class_by_name(TYPE_DEVICE
));
989 static int qdev_add_hotpluggable_device(Object
*obj
, void *opaque
)
991 GSList
**list
= opaque
;
992 DeviceState
*dev
= (DeviceState
*)object_dynamic_cast(OBJECT(obj
),
999 if (dev
->realized
&& object_property_get_bool(obj
, "hotpluggable", NULL
)) {
1000 *list
= g_slist_append(*list
, dev
);
1006 GSList
*qdev_build_hotpluggable_device_list(Object
*peripheral
)
1008 GSList
*list
= NULL
;
1010 object_child_foreach(peripheral
, qdev_add_hotpluggable_device
, &list
);
1015 static bool device_get_realized(Object
*obj
, Error
**errp
)
1017 DeviceState
*dev
= DEVICE(obj
);
1018 return dev
->realized
;
1021 static void device_set_realized(Object
*obj
, bool value
, Error
**errp
)
1023 DeviceState
*dev
= DEVICE(obj
);
1024 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
1025 HotplugHandler
*hotplug_ctrl
;
1027 Error
*local_err
= NULL
;
1029 if (dev
->hotplugged
&& !dc
->hotpluggable
) {
1030 error_setg(errp
, QERR_DEVICE_NO_HOTPLUG
, object_get_typename(obj
));
1034 if (value
&& !dev
->realized
) {
1036 static int unattached_count
;
1037 gchar
*name
= g_strdup_printf("device[%d]", unattached_count
++);
1039 object_property_add_child(container_get(qdev_get_machine(),
1041 name
, obj
, &error_abort
);
1046 dc
->realize(dev
, &local_err
);
1049 if (local_err
!= NULL
) {
1053 DEVICE_LISTENER_CALL(realize
, Forward
, dev
);
1055 hotplug_ctrl
= qdev_get_hotplug_handler(dev
);
1057 hotplug_handler_plug(hotplug_ctrl
, dev
, &local_err
);
1060 if (local_err
!= NULL
) {
1061 goto post_realize_fail
;
1064 if (qdev_get_vmsd(dev
)) {
1065 vmstate_register_with_alias_id(dev
, -1, qdev_get_vmsd(dev
), dev
,
1066 dev
->instance_id_alias
,
1067 dev
->alias_required_for_version
);
1070 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
1071 object_property_set_bool(OBJECT(bus
), true, "realized",
1073 if (local_err
!= NULL
) {
1074 goto child_realize_fail
;
1077 if (dev
->hotplugged
) {
1080 dev
->pending_deleted_event
= false;
1081 } else if (!value
&& dev
->realized
) {
1082 Error
**local_errp
= NULL
;
1083 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
1084 local_errp
= local_err
? NULL
: &local_err
;
1085 object_property_set_bool(OBJECT(bus
), false, "realized",
1088 if (qdev_get_vmsd(dev
)) {
1089 vmstate_unregister(dev
, qdev_get_vmsd(dev
), dev
);
1091 if (dc
->unrealize
) {
1092 local_errp
= local_err
? NULL
: &local_err
;
1093 dc
->unrealize(dev
, local_errp
);
1095 dev
->pending_deleted_event
= true;
1096 DEVICE_LISTENER_CALL(unrealize
, Reverse
, dev
);
1099 if (local_err
!= NULL
) {
1103 dev
->realized
= value
;
1107 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
1108 object_property_set_bool(OBJECT(bus
), false, "realized",
1112 if (qdev_get_vmsd(dev
)) {
1113 vmstate_unregister(dev
, qdev_get_vmsd(dev
), dev
);
1117 if (dc
->unrealize
) {
1118 dc
->unrealize(dev
, NULL
);
1122 error_propagate(errp
, local_err
);
1126 static bool device_get_hotpluggable(Object
*obj
, Error
**errp
)
1128 DeviceClass
*dc
= DEVICE_GET_CLASS(obj
);
1129 DeviceState
*dev
= DEVICE(obj
);
1131 return dc
->hotpluggable
&& (dev
->parent_bus
== NULL
||
1132 qbus_is_hotpluggable(dev
->parent_bus
));
1135 static bool device_get_hotplugged(Object
*obj
, Error
**err
)
1137 DeviceState
*dev
= DEVICE(obj
);
1139 return dev
->hotplugged
;
1142 static void device_set_hotplugged(Object
*obj
, bool value
, Error
**err
)
1144 DeviceState
*dev
= DEVICE(obj
);
1146 dev
->hotplugged
= value
;
1149 static void device_initfn(Object
*obj
)
1151 DeviceState
*dev
= DEVICE(obj
);
1156 dev
->hotplugged
= 1;
1157 qdev_hot_added
= true;
1160 dev
->instance_id_alias
= -1;
1161 dev
->realized
= false;
1163 object_property_add_bool(obj
, "realized",
1164 device_get_realized
, device_set_realized
, NULL
);
1165 object_property_add_bool(obj
, "hotpluggable",
1166 device_get_hotpluggable
, NULL
, NULL
);
1167 object_property_add_bool(obj
, "hotplugged",
1168 device_get_hotplugged
, device_set_hotplugged
,
1171 class = object_get_class(OBJECT(dev
));
1173 for (prop
= DEVICE_CLASS(class)->props
; prop
&& prop
->name
; prop
++) {
1174 qdev_property_add_legacy(dev
, prop
, &error_abort
);
1175 qdev_property_add_static(dev
, prop
, &error_abort
);
1177 class = object_class_get_parent(class);
1178 } while (class != object_class_by_name(TYPE_DEVICE
));
1180 object_property_add_link(OBJECT(dev
), "parent_bus", TYPE_BUS
,
1181 (Object
**)&dev
->parent_bus
, NULL
, 0,
1183 QLIST_INIT(&dev
->gpios
);
1186 static void device_post_init(Object
*obj
)
1188 qdev_prop_set_globals(DEVICE(obj
));
1191 /* Unlink device from bus and free the structure. */
1192 static void device_finalize(Object
*obj
)
1194 NamedGPIOList
*ngl
, *next
;
1196 DeviceState
*dev
= DEVICE(obj
);
1197 qemu_opts_del(dev
->opts
);
1199 QLIST_FOREACH_SAFE(ngl
, &dev
->gpios
, node
, next
) {
1200 QLIST_REMOVE(ngl
, node
);
1201 qemu_free_irqs(ngl
->in
, ngl
->num_in
);
1204 /* ngl->out irqs are owned by the other end and should not be freed
1210 static void device_class_base_init(ObjectClass
*class, void *data
)
1212 DeviceClass
*klass
= DEVICE_CLASS(class);
1214 /* We explicitly look up properties in the superclasses,
1215 * so do not propagate them to the subclasses.
1217 klass
->props
= NULL
;
1220 static void device_unparent(Object
*obj
)
1222 DeviceState
*dev
= DEVICE(obj
);
1225 if (dev
->realized
) {
1226 object_property_set_bool(obj
, false, "realized", NULL
);
1228 while (dev
->num_child_bus
) {
1229 bus
= QLIST_FIRST(&dev
->child_bus
);
1230 object_unparent(OBJECT(bus
));
1232 if (dev
->parent_bus
) {
1233 bus_remove_child(dev
->parent_bus
, dev
);
1234 object_unref(OBJECT(dev
->parent_bus
));
1235 dev
->parent_bus
= NULL
;
1238 /* Only send event if the device had been completely realized */
1239 if (dev
->pending_deleted_event
) {
1240 gchar
*path
= object_get_canonical_path(OBJECT(dev
));
1242 qapi_event_send_device_deleted(!!dev
->id
, dev
->id
, path
, &error_abort
);
1247 static void device_class_init(ObjectClass
*class, void *data
)
1249 DeviceClass
*dc
= DEVICE_CLASS(class);
1251 class->unparent
= device_unparent
;
1252 dc
->realize
= device_realize
;
1253 dc
->unrealize
= device_unrealize
;
1255 /* by default all devices were considered as hotpluggable,
1256 * so with intent to check it in generic qdev_unplug() /
1257 * device_set_realized() functions make every device
1258 * hotpluggable. Devices that shouldn't be hotpluggable,
1259 * should override it in their class_init()
1261 dc
->hotpluggable
= true;
1264 void device_reset(DeviceState
*dev
)
1266 DeviceClass
*klass
= DEVICE_GET_CLASS(dev
);
1273 Object
*qdev_get_machine(void)
1278 dev
= container_get(object_get_root(), "/machine");
1284 static const TypeInfo device_type_info
= {
1285 .name
= TYPE_DEVICE
,
1286 .parent
= TYPE_OBJECT
,
1287 .instance_size
= sizeof(DeviceState
),
1288 .instance_init
= device_initfn
,
1289 .instance_post_init
= device_post_init
,
1290 .instance_finalize
= device_finalize
,
1291 .class_base_init
= device_class_base_init
,
1292 .class_init
= device_class_init
,
1294 .class_size
= sizeof(DeviceClass
),
1297 static void qbus_initfn(Object
*obj
)
1299 BusState
*bus
= BUS(obj
);
1301 QTAILQ_INIT(&bus
->children
);
1302 object_property_add_link(obj
, QDEV_HOTPLUG_HANDLER_PROPERTY
,
1303 TYPE_HOTPLUG_HANDLER
,
1304 (Object
**)&bus
->hotplug_handler
,
1305 object_property_allow_set_link
,
1306 OBJ_PROP_LINK_UNREF_ON_RELEASE
,
1308 object_property_add_bool(obj
, "realized",
1309 bus_get_realized
, bus_set_realized
, NULL
);
1312 static char *default_bus_get_fw_dev_path(DeviceState
*dev
)
1314 return g_strdup(object_get_typename(OBJECT(dev
)));
1317 static void bus_class_init(ObjectClass
*class, void *data
)
1319 BusClass
*bc
= BUS_CLASS(class);
1321 class->unparent
= bus_unparent
;
1322 bc
->get_fw_dev_path
= default_bus_get_fw_dev_path
;
1325 static void qbus_finalize(Object
*obj
)
1327 BusState
*bus
= BUS(obj
);
1329 g_free((char *)bus
->name
);
1332 static const TypeInfo bus_info
= {
1334 .parent
= TYPE_OBJECT
,
1335 .instance_size
= sizeof(BusState
),
1337 .class_size
= sizeof(BusClass
),
1338 .instance_init
= qbus_initfn
,
1339 .instance_finalize
= qbus_finalize
,
1340 .class_init
= bus_class_init
,
1343 static void qdev_register_types(void)
1345 type_register_static(&bus_info
);
1346 type_register_static(&device_type_info
);
1349 type_init(qdev_register_types
)