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
);
166 if (!OBJECT(dev
)->parent
) {
167 static int unattached_count
= 0;
168 gchar
*name
= g_strdup_printf("device[%d]", unattached_count
++);
170 object_property_add_child(container_get(qdev_get_machine(),
172 name
, OBJECT(dev
), NULL
);
176 if (qdev_get_vmsd(dev
)) {
177 vmstate_register_with_alias_id(dev
, -1, qdev_get_vmsd(dev
), dev
,
178 dev
->instance_id_alias
,
179 dev
->alias_required_for_version
);
181 dev
->state
= DEV_STATE_INITIALIZED
;
182 if (dev
->hotplugged
) {
188 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
189 int required_for_version
)
191 assert(dev
->state
== DEV_STATE_CREATED
);
192 dev
->instance_id_alias
= alias_id
;
193 dev
->alias_required_for_version
= required_for_version
;
196 void qdev_unplug(DeviceState
*dev
, Error
**errp
)
198 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
200 if (!dev
->parent_bus
->allow_hotplug
) {
201 error_set(errp
, QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
204 assert(dc
->unplug
!= NULL
);
206 qdev_hot_removed
= true;
208 if (dc
->unplug(dev
) < 0) {
209 error_set(errp
, QERR_UNDEFINED_ERROR
);
214 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
221 static int qbus_reset_one(BusState
*bus
, void *opaque
)
223 BusClass
*bc
= BUS_GET_CLASS(bus
);
225 return bc
->reset(bus
);
230 void qdev_reset_all(DeviceState
*dev
)
232 qdev_walk_children(dev
, qdev_reset_one
, qbus_reset_one
, NULL
);
235 void qbus_reset_all_fn(void *opaque
)
237 BusState
*bus
= opaque
;
238 qbus_walk_children(bus
, qdev_reset_one
, qbus_reset_one
, NULL
);
241 /* can be used as ->unplug() callback for the simple cases */
242 int qdev_simple_unplug_cb(DeviceState
*dev
)
245 object_unparent(OBJECT(dev
));
251 /* Like qdev_init(), but terminate program via error_report() instead of
252 returning an error value. This is okay during machine creation.
253 Don't use for hotplug, because there callers need to recover from
254 failure. Exception: if you know the device's init() callback can't
255 fail, then qdev_init_nofail() can't fail either, and is therefore
256 usable even then. But relying on the device implementation that
257 way is somewhat unclean, and best avoided. */
258 void qdev_init_nofail(DeviceState
*dev
)
260 if (qdev_init(dev
) < 0) {
261 error_report("Initialization of device %s failed",
262 object_get_typename(OBJECT(dev
)));
267 /* Unlink device from bus and free the structure. */
268 void qdev_free(DeviceState
*dev
)
270 object_delete(OBJECT(dev
));
273 void qdev_machine_creation_done(void)
276 * ok, initial machine setup is done, starting from now we can
277 * only create hotpluggable devices
282 bool qdev_machine_modified(void)
284 return qdev_hot_added
|| qdev_hot_removed
;
287 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
289 return dev
->parent_bus
;
292 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
294 assert(dev
->num_gpio_in
== 0);
295 dev
->num_gpio_in
= n
;
296 dev
->gpio_in
= qemu_allocate_irqs(handler
, dev
, n
);
299 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
301 assert(dev
->num_gpio_out
== 0);
302 dev
->num_gpio_out
= n
;
303 dev
->gpio_out
= pins
;
306 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
308 assert(n
>= 0 && n
< dev
->num_gpio_in
);
309 return dev
->gpio_in
[n
];
312 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
314 assert(n
>= 0 && n
< dev
->num_gpio_out
);
315 dev
->gpio_out
[n
] = pin
;
318 void qdev_set_nic_properties(DeviceState
*dev
, NICInfo
*nd
)
320 qdev_prop_set_macaddr(dev
, "mac", nd
->macaddr
.a
);
322 qdev_prop_set_vlan(dev
, "vlan", nd
->vlan
);
324 qdev_prop_set_netdev(dev
, "netdev", nd
->netdev
);
325 if (nd
->nvectors
!= DEV_NVECTORS_UNSPECIFIED
&&
326 qdev_prop_exists(dev
, "vectors")) {
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 /* FIXME move this logic into instance_init */
414 static void do_qbus_create_inplace(BusState
*bus
, const char *typename
,
415 DeviceState
*parent
, const char *name
)
420 bus
->parent
= parent
;
423 /* use supplied name */
424 bus
->name
= g_strdup(name
);
425 } else if (parent
&& parent
->id
) {
426 /* parent device has id -> use it for bus name */
427 len
= strlen(parent
->id
) + 16;
429 snprintf(buf
, len
, "%s.%d", parent
->id
, parent
->num_child_bus
);
432 /* no id -> use lowercase bus type for bus name */
433 len
= strlen(typename
) + 16;
435 len
= snprintf(buf
, len
, "%s.%d", typename
,
436 parent
? parent
->num_child_bus
: 0);
437 for (i
= 0; i
< len
; i
++)
438 buf
[i
] = qemu_tolower(buf
[i
]);
442 QTAILQ_INIT(&bus
->children
);
444 QLIST_INSERT_HEAD(&parent
->child_bus
, bus
, sibling
);
445 parent
->num_child_bus
++;
446 object_property_add_child(OBJECT(parent
), bus
->name
, OBJECT(bus
), NULL
);
447 } else if (bus
!= sysbus_get_default()) {
448 /* TODO: once all bus devices are qdevified,
449 only reset handler for main_system_bus should be registered here. */
450 qemu_register_reset(qbus_reset_all_fn
, bus
);
454 void qbus_create_inplace(BusState
*bus
, const char *typename
,
455 DeviceState
*parent
, const char *name
)
457 object_initialize(bus
, typename
);
458 do_qbus_create_inplace(bus
, typename
, parent
, name
);
461 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
)
465 bus
= BUS(object_new(typename
));
466 bus
->qom_allocated
= true;
467 do_qbus_create_inplace(bus
, typename
, parent
, name
);
471 void qbus_free(BusState
*bus
)
475 while ((kid
= QTAILQ_FIRST(&bus
->children
)) != NULL
) {
476 DeviceState
*dev
= kid
->child
;
480 QLIST_REMOVE(bus
, sibling
);
481 bus
->parent
->num_child_bus
--;
483 assert(bus
!= sysbus_get_default()); /* main_system_bus is never freed */
484 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
486 g_free((void*)bus
->name
);
487 if (bus
->qom_allocated
) {
488 object_delete(OBJECT(bus
));
490 object_finalize(OBJECT(bus
));
491 if (bus
->glib_allocated
) {
497 static char *bus_get_fw_dev_path(BusState
*bus
, DeviceState
*dev
)
499 BusClass
*bc
= BUS_GET_CLASS(bus
);
501 if (bc
->get_fw_dev_path
) {
502 return bc
->get_fw_dev_path(dev
);
508 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
512 if (dev
&& dev
->parent_bus
) {
514 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
515 d
= bus_get_fw_dev_path(dev
->parent_bus
, dev
);
517 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
520 l
+= snprintf(p
+ l
, size
- l
, "%s", object_get_typename(OBJECT(dev
)));
523 l
+= snprintf(p
+ l
, size
- l
, "/");
528 char* qdev_get_fw_dev_path(DeviceState
*dev
)
533 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);
540 char *qdev_get_dev_path(DeviceState
*dev
)
544 if (!dev
|| !dev
->parent_bus
) {
548 bc
= BUS_GET_CLASS(dev
->parent_bus
);
549 if (bc
->get_dev_path
) {
550 return bc
->get_dev_path(dev
);
557 * Legacy property handling
560 static void qdev_get_legacy_property(Object
*obj
, Visitor
*v
, void *opaque
,
561 const char *name
, Error
**errp
)
563 DeviceState
*dev
= DEVICE(obj
);
564 Property
*prop
= opaque
;
569 prop
->info
->print(dev
, prop
, buffer
, sizeof(buffer
));
570 visit_type_str(v
, &ptr
, name
, errp
);
573 static void qdev_set_legacy_property(Object
*obj
, Visitor
*v
, void *opaque
,
574 const char *name
, Error
**errp
)
576 DeviceState
*dev
= DEVICE(obj
);
577 Property
*prop
= opaque
;
578 Error
*local_err
= NULL
;
582 if (dev
->state
!= DEV_STATE_CREATED
) {
583 error_set(errp
, QERR_PERMISSION_DENIED
);
587 visit_type_str(v
, &ptr
, name
, &local_err
);
589 error_propagate(errp
, local_err
);
593 ret
= prop
->info
->parse(dev
, prop
, ptr
);
594 error_set_from_qdev_prop_error(errp
, ret
, dev
, prop
, ptr
);
599 * @qdev_add_legacy_property - adds a legacy property
601 * Do not use this is new code! Properties added through this interface will
602 * be given names and types in the "legacy" namespace.
604 * Legacy properties are string versions of other OOM properties. The format
605 * of the string depends on the property type.
607 void qdev_property_add_legacy(DeviceState
*dev
, Property
*prop
,
612 /* Register pointer properties as legacy properties */
613 if (!prop
->info
->print
&& !prop
->info
->parse
&&
614 (prop
->info
->set
|| prop
->info
->get
)) {
618 name
= g_strdup_printf("legacy-%s", prop
->name
);
619 type
= g_strdup_printf("legacy<%s>",
620 prop
->info
->legacy_name
?: prop
->info
->name
);
622 object_property_add(OBJECT(dev
), name
, type
,
623 prop
->info
->print
? qdev_get_legacy_property
: prop
->info
->get
,
624 prop
->info
->parse
? qdev_set_legacy_property
: prop
->info
->set
,
633 * @qdev_property_add_static - add a @Property to a device.
635 * Static properties access data in a struct. The actual type of the
636 * property and the field depends on the property type.
638 void qdev_property_add_static(DeviceState
*dev
, Property
*prop
,
641 Error
*local_err
= NULL
;
642 Object
*obj
= OBJECT(dev
);
645 * TODO qdev_prop_ptr does not have getters or setters. It must
646 * go now that it can be replaced with links. The test should be
647 * removed along with it: all static properties are read/write.
649 if (!prop
->info
->get
&& !prop
->info
->set
) {
653 object_property_add(obj
, prop
->name
, prop
->info
->name
,
654 prop
->info
->get
, prop
->info
->set
,
659 error_propagate(errp
, local_err
);
662 if (prop
->qtype
== QTYPE_NONE
) {
666 if (prop
->qtype
== QTYPE_QBOOL
) {
667 object_property_set_bool(obj
, prop
->defval
, prop
->name
, &local_err
);
668 } else if (prop
->info
->enum_table
) {
669 object_property_set_str(obj
, prop
->info
->enum_table
[prop
->defval
],
670 prop
->name
, &local_err
);
671 } else if (prop
->qtype
== QTYPE_QINT
) {
672 object_property_set_int(obj
, prop
->defval
, prop
->name
, &local_err
);
674 assert_no_error(local_err
);
677 static void device_initfn(Object
*obj
)
679 DeviceState
*dev
= DEVICE(obj
);
685 qdev_hot_added
= true;
688 dev
->instance_id_alias
= -1;
689 dev
->state
= DEV_STATE_CREATED
;
691 class = object_get_class(OBJECT(dev
));
693 for (prop
= DEVICE_CLASS(class)->props
; prop
&& prop
->name
; prop
++) {
694 qdev_property_add_legacy(dev
, prop
, NULL
);
695 qdev_property_add_static(dev
, prop
, NULL
);
697 class = object_class_get_parent(class);
698 } while (class != object_class_by_name(TYPE_DEVICE
));
699 qdev_prop_set_globals(dev
);
701 object_property_add_link(OBJECT(dev
), "parent_bus", TYPE_BUS
,
702 (Object
**)&dev
->parent_bus
, NULL
);
705 /* Unlink device from bus and free the structure. */
706 static void device_finalize(Object
*obj
)
708 DeviceState
*dev
= DEVICE(obj
);
710 DeviceClass
*dc
= DEVICE_GET_CLASS(dev
);
712 if (dev
->state
== DEV_STATE_INITIALIZED
) {
713 while (dev
->num_child_bus
) {
714 bus
= QLIST_FIRST(&dev
->child_bus
);
717 if (qdev_get_vmsd(dev
)) {
718 vmstate_unregister(dev
, qdev_get_vmsd(dev
), dev
);
724 qemu_opts_del(dev
->opts
);
727 if (dev
->parent_bus
) {
728 bus_remove_child(dev
->parent_bus
, dev
);
732 static void device_class_base_init(ObjectClass
*class, void *data
)
734 DeviceClass
*klass
= DEVICE_CLASS(class);
736 /* We explicitly look up properties in the superclasses,
737 * so do not propagate them to the subclasses.
742 void device_reset(DeviceState
*dev
)
744 DeviceClass
*klass
= DEVICE_GET_CLASS(dev
);
751 Object
*qdev_get_machine(void)
756 dev
= container_get(object_get_root(), "/machine");
762 static TypeInfo device_type_info
= {
764 .parent
= TYPE_OBJECT
,
765 .instance_size
= sizeof(DeviceState
),
766 .instance_init
= device_initfn
,
767 .instance_finalize
= device_finalize
,
768 .class_base_init
= device_class_base_init
,
770 .class_size
= sizeof(DeviceClass
),
773 static const TypeInfo bus_info
= {
775 .parent
= TYPE_OBJECT
,
776 .instance_size
= sizeof(BusState
),
778 .class_size
= sizeof(BusClass
),
781 static void qdev_register_types(void)
783 type_register_static(&bus_info
);
784 type_register_static(&device_type_info
);
787 type_init(qdev_register_types
)