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
34 static bool qdev_hot_added
= false;
35 static bool qdev_hot_removed
= false;
37 /* Register a new device type. */
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 bool qdev_exists(const char *name
)
57 return !!object_class_by_name(name
);
60 static void qdev_property_add_legacy(DeviceState
*dev
, Property
*prop
,
63 static void bus_remove_child(BusState
*bus
, DeviceState
*child
)
67 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
68 if (kid
->child
== child
) {
71 snprintf(name
, sizeof(name
), "child[%d]", kid
->index
);
72 QTAILQ_REMOVE(&bus
->children
, kid
, sibling
);
73 object_property_del(OBJECT(bus
), name
, NULL
);
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
++;
92 QTAILQ_INSERT_HEAD(&bus
->children
, kid
, sibling
);
94 snprintf(name
, sizeof(name
), "child[%d]", kid
->index
);
95 object_property_add_link(OBJECT(bus
), name
,
96 object_get_typename(OBJECT(child
)),
97 (Object
**)&kid
->child
,
101 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
)
103 dev
->parent_bus
= bus
;
104 bus_add_child(bus
, dev
);
107 /* Create a new device. This only initializes the device state structure
108 and allows properties to be set. qdev_init should be called to
109 initialize the actual device emulation. */
110 DeviceState
*qdev_create(BusState
*bus
, const char *name
)
114 dev
= qdev_try_create(bus
, name
);
117 hw_error("Unknown device '%s' for bus '%s'\n", name
,
118 object_get_typename(OBJECT(bus
)));
120 hw_error("Unknown device '%s' for default sysbus\n", name
);
127 DeviceState
*qdev_try_create(BusState
*bus
, const char *type
)
131 if (object_class_by_name(type
) == NULL
) {
134 dev
= DEVICE(object_new(type
));
140 bus
= sysbus_get_default();
143 qdev_set_parent_bus(dev
, bus
);
148 /* Initialize a device. Device properties should be set before calling
149 this function. IRQs and MMIO regions should be connected/mapped after
150 calling this function.
151 On failure, destroy the device and return negative value.
152 Return 0 on success. */
153 int qdev_init(DeviceState
*dev
)
155 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
158 assert(dev
->state
== DEV_STATE_CREATED
);
162 object_unparent(OBJECT(dev
));
167 if (!OBJECT(dev
)->parent
) {
168 static int unattached_count
= 0;
169 gchar
*name
= g_strdup_printf("device[%d]", unattached_count
++);
171 object_property_add_child(container_get(qdev_get_machine(),
173 name
, OBJECT(dev
), NULL
);
177 if (qdev_get_vmsd(dev
)) {
178 vmstate_register_with_alias_id(dev
, -1, qdev_get_vmsd(dev
), dev
,
179 dev
->instance_id_alias
,
180 dev
->alias_required_for_version
);
182 dev
->state
= DEV_STATE_INITIALIZED
;
183 if (dev
->hotplugged
) {
189 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
190 int required_for_version
)
192 assert(dev
->state
== DEV_STATE_CREATED
);
193 dev
->instance_id_alias
= alias_id
;
194 dev
->alias_required_for_version
= required_for_version
;
197 void qdev_unplug(DeviceState
*dev
, Error
**errp
)
199 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
201 if (!dev
->parent_bus
->allow_hotplug
) {
202 error_set(errp
, QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
205 assert(dc
->unplug
!= NULL
);
207 qdev_hot_removed
= true;
209 if (dc
->unplug(dev
) < 0) {
210 error_set(errp
, QERR_UNDEFINED_ERROR
);
215 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
222 static int qbus_reset_one(BusState
*bus
, void *opaque
)
224 BusClass
*bc
= BUS_GET_CLASS(bus
);
226 return bc
->reset(bus
);
231 void qdev_reset_all(DeviceState
*dev
)
233 qdev_walk_children(dev
, qdev_reset_one
, qbus_reset_one
, NULL
);
236 void qbus_reset_all_fn(void *opaque
)
238 BusState
*bus
= opaque
;
239 qbus_walk_children(bus
, qdev_reset_one
, qbus_reset_one
, NULL
);
242 /* can be used as ->unplug() callback for the simple cases */
243 int qdev_simple_unplug_cb(DeviceState
*dev
)
246 object_unparent(OBJECT(dev
));
252 /* Like qdev_init(), but terminate program via error_report() instead of
253 returning an error value. This is okay during machine creation.
254 Don't use for hotplug, because there callers need to recover from
255 failure. Exception: if you know the device's init() callback can't
256 fail, then qdev_init_nofail() can't fail either, and is therefore
257 usable even then. But relying on the device implementation that
258 way is somewhat unclean, and best avoided. */
259 void qdev_init_nofail(DeviceState
*dev
)
261 const char *typename
= object_get_typename(OBJECT(dev
));
263 if (qdev_init(dev
) < 0) {
264 error_report("Initialization of device %s failed", typename
);
269 /* Unlink device from bus and free the structure. */
270 void qdev_free(DeviceState
*dev
)
272 object_delete(OBJECT(dev
));
275 void qdev_machine_creation_done(void)
278 * ok, initial machine setup is done, starting from now we can
279 * only create hotpluggable devices
284 bool qdev_machine_modified(void)
286 return qdev_hot_added
|| qdev_hot_removed
;
289 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
291 return dev
->parent_bus
;
294 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
296 assert(dev
->num_gpio_in
== 0);
297 dev
->num_gpio_in
= n
;
298 dev
->gpio_in
= qemu_allocate_irqs(handler
, dev
, n
);
301 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
303 assert(dev
->num_gpio_out
== 0);
304 dev
->num_gpio_out
= n
;
305 dev
->gpio_out
= pins
;
308 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
310 assert(n
>= 0 && n
< dev
->num_gpio_in
);
311 return dev
->gpio_in
[n
];
314 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
316 assert(n
>= 0 && n
< dev
->num_gpio_out
);
317 dev
->gpio_out
[n
] = pin
;
320 void qdev_set_nic_properties(DeviceState
*dev
, NICInfo
*nd
)
322 qdev_prop_set_macaddr(dev
, "mac", nd
->macaddr
.a
);
324 qdev_prop_set_netdev(dev
, "netdev", nd
->netdev
);
325 if (nd
->nvectors
!= DEV_NVECTORS_UNSPECIFIED
&&
326 object_property_find(OBJECT(dev
), "vectors", NULL
)) {
327 qdev_prop_set_uint32(dev
, "vectors", nd
->nvectors
);
329 nd
->instantiated
= 1;
332 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
)
336 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
337 if (strcmp(name
, bus
->name
) == 0) {
344 int qbus_walk_children(BusState
*bus
, qdev_walkerfn
*devfn
,
345 qbus_walkerfn
*busfn
, void *opaque
)
351 err
= busfn(bus
, opaque
);
357 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
358 err
= qdev_walk_children(kid
->child
, devfn
, busfn
, opaque
);
367 int qdev_walk_children(DeviceState
*dev
, qdev_walkerfn
*devfn
,
368 qbus_walkerfn
*busfn
, void *opaque
)
374 err
= devfn(dev
, opaque
);
380 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
381 err
= qbus_walk_children(bus
, devfn
, busfn
, opaque
);
390 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
)
396 QTAILQ_FOREACH(kid
, &bus
->children
, sibling
) {
397 DeviceState
*dev
= kid
->child
;
399 if (dev
->id
&& strcmp(dev
->id
, id
) == 0) {
403 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
404 ret
= qdev_find_recursive(child
, id
);
413 static void qbus_realize(BusState
*bus
)
415 const char *typename
= object_get_typename(OBJECT(bus
));
420 /* use supplied name */
421 } else if (bus
->parent
&& bus
->parent
->id
) {
422 /* parent device has id -> use it for bus name */
423 len
= strlen(bus
->parent
->id
) + 16;
425 snprintf(buf
, len
, "%s.%d", bus
->parent
->id
, bus
->parent
->num_child_bus
);
428 /* no id -> use lowercase bus type for bus name */
429 len
= strlen(typename
) + 16;
431 len
= snprintf(buf
, len
, "%s.%d", typename
,
432 bus
->parent
? bus
->parent
->num_child_bus
: 0);
433 for (i
= 0; i
< len
; i
++)
434 buf
[i
] = qemu_tolower(buf
[i
]);
439 QLIST_INSERT_HEAD(&bus
->parent
->child_bus
, bus
, sibling
);
440 bus
->parent
->num_child_bus
++;
441 object_property_add_child(OBJECT(bus
->parent
), bus
->name
, OBJECT(bus
), NULL
);
442 } else if (bus
!= sysbus_get_default()) {
443 /* TODO: once all bus devices are qdevified,
444 only reset handler for main_system_bus should be registered here. */
445 qemu_register_reset(qbus_reset_all_fn
, bus
);
449 void qbus_create_inplace(BusState
*bus
, const char *typename
,
450 DeviceState
*parent
, const char *name
)
452 object_initialize(bus
, typename
);
454 bus
->parent
= parent
;
455 bus
->name
= name
? g_strdup(name
) : NULL
;
459 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
)
463 bus
= BUS(object_new(typename
));
464 bus
->qom_allocated
= true;
466 bus
->parent
= parent
;
467 bus
->name
= name
? g_strdup(name
) : NULL
;
473 void qbus_free(BusState
*bus
)
475 if (bus
->qom_allocated
) {
476 object_delete(OBJECT(bus
));
478 object_finalize(OBJECT(bus
));
479 if (bus
->glib_allocated
) {
485 static char *bus_get_fw_dev_path(BusState
*bus
, DeviceState
*dev
)
487 BusClass
*bc
= BUS_GET_CLASS(bus
);
489 if (bc
->get_fw_dev_path
) {
490 return bc
->get_fw_dev_path(dev
);
496 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
500 if (dev
&& dev
->parent_bus
) {
502 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
503 d
= bus_get_fw_dev_path(dev
->parent_bus
, dev
);
505 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
508 l
+= snprintf(p
+ l
, size
- l
, "%s", object_get_typename(OBJECT(dev
)));
511 l
+= snprintf(p
+ l
, size
- l
, "/");
516 char* qdev_get_fw_dev_path(DeviceState
*dev
)
521 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);
528 char *qdev_get_dev_path(DeviceState
*dev
)
532 if (!dev
|| !dev
->parent_bus
) {
536 bc
= BUS_GET_CLASS(dev
->parent_bus
);
537 if (bc
->get_dev_path
) {
538 return bc
->get_dev_path(dev
);
545 * Legacy property handling
548 static void qdev_get_legacy_property(Object
*obj
, Visitor
*v
, void *opaque
,
549 const char *name
, Error
**errp
)
551 DeviceState
*dev
= DEVICE(obj
);
552 Property
*prop
= opaque
;
557 prop
->info
->print(dev
, prop
, buffer
, sizeof(buffer
));
558 visit_type_str(v
, &ptr
, name
, errp
);
561 static void qdev_set_legacy_property(Object
*obj
, Visitor
*v
, void *opaque
,
562 const char *name
, Error
**errp
)
564 DeviceState
*dev
= DEVICE(obj
);
565 Property
*prop
= opaque
;
566 Error
*local_err
= NULL
;
570 if (dev
->state
!= DEV_STATE_CREATED
) {
571 error_set(errp
, QERR_PERMISSION_DENIED
);
575 visit_type_str(v
, &ptr
, name
, &local_err
);
577 error_propagate(errp
, local_err
);
581 ret
= prop
->info
->parse(dev
, prop
, ptr
);
582 error_set_from_qdev_prop_error(errp
, ret
, dev
, prop
, ptr
);
587 * @qdev_add_legacy_property - adds a legacy property
589 * Do not use this is new code! Properties added through this interface will
590 * be given names and types in the "legacy" namespace.
592 * Legacy properties are string versions of other OOM properties. The format
593 * of the string depends on the property type.
595 void qdev_property_add_legacy(DeviceState
*dev
, Property
*prop
,
600 /* Register pointer properties as legacy properties */
601 if (!prop
->info
->print
&& !prop
->info
->parse
&&
602 (prop
->info
->set
|| prop
->info
->get
)) {
606 name
= g_strdup_printf("legacy-%s", prop
->name
);
607 type
= g_strdup_printf("legacy<%s>",
608 prop
->info
->legacy_name
?: prop
->info
->name
);
610 object_property_add(OBJECT(dev
), name
, type
,
611 prop
->info
->print
? qdev_get_legacy_property
: prop
->info
->get
,
612 prop
->info
->parse
? qdev_set_legacy_property
: prop
->info
->set
,
621 * @qdev_property_add_static - add a @Property to a device.
623 * Static properties access data in a struct. The actual type of the
624 * property and the field depends on the property type.
626 void qdev_property_add_static(DeviceState
*dev
, Property
*prop
,
629 Error
*local_err
= NULL
;
630 Object
*obj
= OBJECT(dev
);
633 * TODO qdev_prop_ptr does not have getters or setters. It must
634 * go now that it can be replaced with links. The test should be
635 * removed along with it: all static properties are read/write.
637 if (!prop
->info
->get
&& !prop
->info
->set
) {
641 object_property_add(obj
, prop
->name
, prop
->info
->name
,
642 prop
->info
->get
, prop
->info
->set
,
647 error_propagate(errp
, local_err
);
650 if (prop
->qtype
== QTYPE_NONE
) {
654 if (prop
->qtype
== QTYPE_QBOOL
) {
655 object_property_set_bool(obj
, prop
->defval
, prop
->name
, &local_err
);
656 } else if (prop
->info
->enum_table
) {
657 object_property_set_str(obj
, prop
->info
->enum_table
[prop
->defval
],
658 prop
->name
, &local_err
);
659 } else if (prop
->qtype
== QTYPE_QINT
) {
660 object_property_set_int(obj
, prop
->defval
, prop
->name
, &local_err
);
662 assert_no_error(local_err
);
665 static void device_initfn(Object
*obj
)
667 DeviceState
*dev
= DEVICE(obj
);
673 qdev_hot_added
= true;
676 dev
->instance_id_alias
= -1;
677 dev
->state
= DEV_STATE_CREATED
;
679 class = object_get_class(OBJECT(dev
));
681 for (prop
= DEVICE_CLASS(class)->props
; prop
&& prop
->name
; prop
++) {
682 qdev_property_add_legacy(dev
, prop
, NULL
);
683 qdev_property_add_static(dev
, prop
, NULL
);
685 class = object_class_get_parent(class);
686 } while (class != object_class_by_name(TYPE_DEVICE
));
687 qdev_prop_set_globals(dev
);
689 object_property_add_link(OBJECT(dev
), "parent_bus", TYPE_BUS
,
690 (Object
**)&dev
->parent_bus
, NULL
);
693 /* Unlink device from bus and free the structure. */
694 static void device_finalize(Object
*obj
)
696 DeviceState
*dev
= DEVICE(obj
);
698 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
700 if (dev
->state
== DEV_STATE_INITIALIZED
) {
701 while (dev
->num_child_bus
) {
702 bus
= QLIST_FIRST(&dev
->child_bus
);
705 if (qdev_get_vmsd(dev
)) {
706 vmstate_unregister(dev
, qdev_get_vmsd(dev
), dev
);
712 qemu_opts_del(dev
->opts
);
715 if (dev
->parent_bus
) {
716 bus_remove_child(dev
->parent_bus
, dev
);
720 static void device_class_base_init(ObjectClass
*class, void *data
)
722 DeviceClass
*klass
= DEVICE_CLASS(class);
724 /* We explicitly look up properties in the superclasses,
725 * so do not propagate them to the subclasses.
730 void device_reset(DeviceState
*dev
)
732 DeviceClass
*klass
= DEVICE_GET_CLASS(dev
);
739 Object
*qdev_get_machine(void)
744 dev
= container_get(object_get_root(), "/machine");
750 static TypeInfo device_type_info
= {
752 .parent
= TYPE_OBJECT
,
753 .instance_size
= sizeof(DeviceState
),
754 .instance_init
= device_initfn
,
755 .instance_finalize
= device_finalize
,
756 .class_base_init
= device_class_base_init
,
758 .class_size
= sizeof(DeviceClass
),
761 static void qbus_initfn(Object
*obj
)
763 BusState
*bus
= BUS(obj
);
765 QTAILQ_INIT(&bus
->children
);
768 static void qbus_finalize(Object
*obj
)
770 BusState
*bus
= BUS(obj
);
773 while ((kid
= QTAILQ_FIRST(&bus
->children
)) != NULL
) {
774 DeviceState
*dev
= kid
->child
;
778 QLIST_REMOVE(bus
, sibling
);
779 bus
->parent
->num_child_bus
--;
781 assert(bus
!= sysbus_get_default()); /* main_system_bus is never freed */
782 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
784 g_free((char *)bus
->name
);
787 static const TypeInfo bus_info
= {
789 .parent
= TYPE_OBJECT
,
790 .instance_size
= sizeof(BusState
),
792 .class_size
= sizeof(BusClass
),
793 .instance_init
= qbus_initfn
,
794 .instance_finalize
= qbus_finalize
,
797 static void qdev_register_types(void)
799 type_register_static(&bus_info
);
800 type_register_static(&device_type_info
);
803 type_init(qdev_register_types
)