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
33 static int qdev_hotplug
= 0;
34 static bool qdev_hot_added
= false;
35 static bool qdev_hot_removed
= false;
37 /* This is a nasty hack to allow passing a NULL bus to qdev_create. */
38 static BusState
*main_system_bus
;
39 static void main_system_bus_create(void);
41 DeviceInfo
*device_info_list
;
43 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
45 static BusState
*qbus_find(const char *path
);
47 /* Register a new device type. */
48 void qdev_register(DeviceInfo
*info
)
50 assert(info
->size
>= sizeof(DeviceState
));
53 info
->next
= device_info_list
;
54 device_info_list
= info
;
57 static DeviceInfo
*qdev_find_info(BusInfo
*bus_info
, const char *name
)
61 /* first check device names */
62 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
63 if (bus_info
&& info
->bus_info
!= bus_info
)
65 if (strcmp(info
->name
, name
) != 0)
70 /* failing that check the aliases */
71 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
72 if (bus_info
&& info
->bus_info
!= bus_info
)
76 if (strcmp(info
->alias
, name
) != 0)
83 static DeviceState
*qdev_create_from_info(BusState
*bus
, DeviceInfo
*info
)
87 assert(bus
->info
== info
->bus_info
);
88 dev
= qemu_mallocz(info
->size
);
90 dev
->parent_bus
= bus
;
91 qdev_prop_set_defaults(dev
, dev
->info
->props
);
92 qdev_prop_set_defaults(dev
, dev
->parent_bus
->info
->props
);
93 qdev_prop_set_globals(dev
);
94 QLIST_INSERT_HEAD(&bus
->children
, dev
, sibling
);
96 assert(bus
->allow_hotplug
);
98 qdev_hot_added
= true;
100 dev
->instance_id_alias
= -1;
101 dev
->state
= DEV_STATE_CREATED
;
105 /* Create a new device. This only initializes the device state structure
106 and allows properties to be set. qdev_init should be called to
107 initialize the actual device emulation. */
108 DeviceState
*qdev_create(BusState
*bus
, const char *name
)
112 dev
= qdev_try_create(bus
, name
);
115 hw_error("Unknown device '%s' for bus '%s'\n", name
,
118 hw_error("Unknown device '%s' for default sysbus\n", name
);
125 DeviceState
*qdev_try_create(BusState
*bus
, const char *name
)
130 bus
= sysbus_get_default();
133 info
= qdev_find_info(bus
->info
, name
);
138 return qdev_create_from_info(bus
, info
);
141 static void qdev_print_devinfo(DeviceInfo
*info
)
143 error_printf("name \"%s\", bus %s",
144 info
->name
, info
->bus_info
->name
);
146 error_printf(", alias \"%s\"", info
->alias
);
149 error_printf(", desc \"%s\"", info
->desc
);
152 error_printf(", no-user");
157 static int set_property(const char *name
, const char *value
, void *opaque
)
159 DeviceState
*dev
= opaque
;
161 if (strcmp(name
, "driver") == 0)
163 if (strcmp(name
, "bus") == 0)
166 if (qdev_prop_parse(dev
, name
, value
) == -1) {
172 int qdev_device_help(QemuOpts
*opts
)
178 driver
= qemu_opt_get(opts
, "driver");
179 if (driver
&& !strcmp(driver
, "?")) {
180 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
182 continue; /* not available, don't show */
184 qdev_print_devinfo(info
);
189 if (!qemu_opt_get(opts
, "?")) {
193 info
= qdev_find_info(NULL
, driver
);
198 for (prop
= info
->props
; prop
&& prop
->name
; prop
++) {
200 * TODO Properties without a parser are just for dirty hacks.
201 * qdev_prop_ptr is the only such PropertyInfo. It's marked
202 * for removal. This conditional should be removed along with
205 if (!prop
->info
->parse
) {
206 continue; /* no way to set it, don't show */
208 error_printf("%s.%s=%s\n", info
->name
, prop
->name
, prop
->info
->name
);
213 DeviceState
*qdev_device_add(QemuOpts
*opts
)
215 const char *driver
, *path
, *id
;
220 driver
= qemu_opt_get(opts
, "driver");
222 qerror_report(QERR_MISSING_PARAMETER
, "driver");
227 info
= qdev_find_info(NULL
, driver
);
228 if (!info
|| info
->no_user
) {
229 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "driver", "a driver name");
230 error_printf_unless_qmp("Try with argument '?' for a list.\n");
235 path
= qemu_opt_get(opts
, "bus");
237 bus
= qbus_find(path
);
241 if (bus
->info
!= info
->bus_info
) {
242 qerror_report(QERR_BAD_BUS_FOR_DEVICE
,
243 driver
, bus
->info
->name
);
247 bus
= qbus_find_recursive(main_system_bus
, NULL
, info
->bus_info
);
249 qerror_report(QERR_NO_BUS_FOR_DEVICE
,
250 info
->name
, info
->bus_info
->name
);
254 if (qdev_hotplug
&& !bus
->allow_hotplug
) {
255 qerror_report(QERR_BUS_NO_HOTPLUG
, bus
->name
);
259 /* create device, set properties */
260 qdev
= qdev_create_from_info(bus
, info
);
261 id
= qemu_opts_id(opts
);
265 if (qemu_opt_foreach(opts
, set_property
, qdev
, 1) != 0) {
269 if (qdev_init(qdev
) < 0) {
270 qerror_report(QERR_DEVICE_INIT_FAILED
, driver
);
277 /* Initialize a device. Device properties should be set before calling
278 this function. IRQs and MMIO regions should be connected/mapped after
279 calling this function.
280 On failure, destroy the device and return negative value.
281 Return 0 on success. */
282 int qdev_init(DeviceState
*dev
)
286 assert(dev
->state
== DEV_STATE_CREATED
);
287 rc
= dev
->info
->init(dev
, dev
->info
);
292 if (dev
->info
->vmsd
) {
293 vmstate_register_with_alias_id(dev
, -1, dev
->info
->vmsd
, dev
,
294 dev
->instance_id_alias
,
295 dev
->alias_required_for_version
);
297 dev
->state
= DEV_STATE_INITIALIZED
;
298 if (dev
->hotplugged
&& dev
->info
->reset
) {
299 dev
->info
->reset(dev
);
304 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
305 int required_for_version
)
307 assert(dev
->state
== DEV_STATE_CREATED
);
308 dev
->instance_id_alias
= alias_id
;
309 dev
->alias_required_for_version
= required_for_version
;
312 int qdev_unplug(DeviceState
*dev
)
314 if (!dev
->parent_bus
->allow_hotplug
) {
315 qerror_report(QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
318 assert(dev
->info
->unplug
!= NULL
);
320 qdev_hot_removed
= true;
322 return dev
->info
->unplug(dev
);
325 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
327 if (dev
->info
->reset
) {
328 dev
->info
->reset(dev
);
334 BusState
*sysbus_get_default(void)
336 if (!main_system_bus
) {
337 main_system_bus_create();
339 return main_system_bus
;
342 static int qbus_reset_one(BusState
*bus
, void *opaque
)
344 if (bus
->info
->reset
) {
345 return bus
->info
->reset(bus
);
350 void qdev_reset_all(DeviceState
*dev
)
352 qdev_walk_children(dev
, qdev_reset_one
, qbus_reset_one
, NULL
);
355 void qbus_reset_all_fn(void *opaque
)
357 BusState
*bus
= opaque
;
358 qbus_walk_children(bus
, qdev_reset_one
, qbus_reset_one
, NULL
);
361 /* can be used as ->unplug() callback for the simple cases */
362 int qdev_simple_unplug_cb(DeviceState
*dev
)
370 /* Like qdev_init(), but terminate program via error_report() instead of
371 returning an error value. This is okay during machine creation.
372 Don't use for hotplug, because there callers need to recover from
373 failure. Exception: if you know the device's init() callback can't
374 fail, then qdev_init_nofail() can't fail either, and is therefore
375 usable even then. But relying on the device implementation that
376 way is somewhat unclean, and best avoided. */
377 void qdev_init_nofail(DeviceState
*dev
)
379 DeviceInfo
*info
= dev
->info
;
381 if (qdev_init(dev
) < 0) {
382 error_report("Initialization of device %s failed", info
->name
);
387 /* Unlink device from bus and free the structure. */
388 void qdev_free(DeviceState
*dev
)
393 if (dev
->state
== DEV_STATE_INITIALIZED
) {
394 while (dev
->num_child_bus
) {
395 bus
= QLIST_FIRST(&dev
->child_bus
);
399 vmstate_unregister(dev
, dev
->info
->vmsd
, dev
);
401 dev
->info
->exit(dev
);
403 qemu_opts_del(dev
->opts
);
405 QLIST_REMOVE(dev
, sibling
);
406 for (prop
= dev
->info
->props
; prop
&& prop
->name
; prop
++) {
407 if (prop
->info
->free
) {
408 prop
->info
->free(dev
, prop
);
414 void qdev_machine_creation_done(void)
417 * ok, initial machine setup is done, starting from now we can
418 * only create hotpluggable devices
423 bool qdev_machine_modified(void)
425 return qdev_hot_added
|| qdev_hot_removed
;
428 /* Get a character (serial) device interface. */
429 CharDriverState
*qdev_init_chardev(DeviceState
*dev
)
431 static int next_serial
;
433 /* FIXME: This function needs to go away: use chardev properties! */
434 return serial_hds
[next_serial
++];
437 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
439 return dev
->parent_bus
;
442 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
444 assert(dev
->num_gpio_in
== 0);
445 dev
->num_gpio_in
= n
;
446 dev
->gpio_in
= qemu_allocate_irqs(handler
, dev
, n
);
449 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
451 assert(dev
->num_gpio_out
== 0);
452 dev
->num_gpio_out
= n
;
453 dev
->gpio_out
= pins
;
456 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
458 assert(n
>= 0 && n
< dev
->num_gpio_in
);
459 return dev
->gpio_in
[n
];
462 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
464 assert(n
>= 0 && n
< dev
->num_gpio_out
);
465 dev
->gpio_out
[n
] = pin
;
468 void qdev_set_nic_properties(DeviceState
*dev
, NICInfo
*nd
)
470 qdev_prop_set_macaddr(dev
, "mac", nd
->macaddr
.a
);
472 qdev_prop_set_vlan(dev
, "vlan", nd
->vlan
);
474 qdev_prop_set_netdev(dev
, "netdev", nd
->netdev
);
475 if (nd
->nvectors
!= DEV_NVECTORS_UNSPECIFIED
&&
476 qdev_prop_exists(dev
, "vectors")) {
477 qdev_prop_set_uint32(dev
, "vectors", nd
->nvectors
);
479 nd
->instantiated
= 1;
482 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
)
486 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
487 if (strcmp(name
, bus
->name
) == 0) {
494 int qbus_walk_children(BusState
*bus
, qdev_walkerfn
*devfn
,
495 qbus_walkerfn
*busfn
, void *opaque
)
501 err
= busfn(bus
, opaque
);
507 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
508 err
= qdev_walk_children(dev
, devfn
, busfn
, opaque
);
517 int qdev_walk_children(DeviceState
*dev
, qdev_walkerfn
*devfn
,
518 qbus_walkerfn
*busfn
, void *opaque
)
524 err
= devfn(dev
, opaque
);
530 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
531 err
= qbus_walk_children(bus
, devfn
, busfn
, opaque
);
540 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
544 BusState
*child
, *ret
;
547 if (name
&& (strcmp(bus
->name
, name
) != 0)) {
550 if (info
&& (bus
->info
!= info
)) {
557 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
558 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
559 ret
= qbus_find_recursive(child
, name
, info
);
568 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
)
570 DeviceState
*dev
, *ret
;
573 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
574 if (dev
->id
&& strcmp(dev
->id
, id
) == 0)
576 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
577 ret
= qdev_find_recursive(child
, id
);
586 static void qbus_list_bus(DeviceState
*dev
)
589 const char *sep
= " ";
591 error_printf("child busses at \"%s\":",
592 dev
->id
? dev
->id
: dev
->info
->name
);
593 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
594 error_printf("%s\"%s\"", sep
, child
->name
);
600 static void qbus_list_dev(BusState
*bus
)
603 const char *sep
= " ";
605 error_printf("devices at \"%s\":", bus
->name
);
606 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
607 error_printf("%s\"%s\"", sep
, dev
->info
->name
);
609 error_printf("/\"%s\"", dev
->id
);
615 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
619 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
620 if (strcmp(child
->name
, elem
) == 0) {
627 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
632 * try to match in order:
633 * (1) instance id, if present
635 * (3) driver alias, if present
637 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
638 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
642 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
643 if (strcmp(dev
->info
->name
, elem
) == 0) {
647 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
648 if (dev
->info
->alias
&& strcmp(dev
->info
->alias
, elem
) == 0) {
655 static BusState
*qbus_find(const char *path
)
662 /* find start element */
663 if (path
[0] == '/') {
664 bus
= main_system_bus
;
667 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
671 bus
= qbus_find_recursive(main_system_bus
, elem
, NULL
);
673 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
680 assert(path
[pos
] == '/' || !path
[pos
]);
681 while (path
[pos
] == '/') {
684 if (path
[pos
] == '\0') {
689 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
694 dev
= qbus_find_dev(bus
, elem
);
696 qerror_report(QERR_DEVICE_NOT_FOUND
, elem
);
697 if (!monitor_cur_is_qmp()) {
703 assert(path
[pos
] == '/' || !path
[pos
]);
704 while (path
[pos
] == '/') {
707 if (path
[pos
] == '\0') {
708 /* last specified element is a device. If it has exactly
709 * one child bus accept it nevertheless */
710 switch (dev
->num_child_bus
) {
712 qerror_report(QERR_DEVICE_NO_BUS
, elem
);
715 return QLIST_FIRST(&dev
->child_bus
);
717 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES
, elem
);
718 if (!monitor_cur_is_qmp()) {
726 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
731 bus
= qbus_find_bus(dev
, elem
);
733 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
734 if (!monitor_cur_is_qmp()) {
742 void qbus_create_inplace(BusState
*bus
, BusInfo
*info
,
743 DeviceState
*parent
, const char *name
)
749 bus
->parent
= parent
;
752 /* use supplied name */
753 bus
->name
= qemu_strdup(name
);
754 } else if (parent
&& parent
->id
) {
755 /* parent device has id -> use it for bus name */
756 len
= strlen(parent
->id
) + 16;
757 buf
= qemu_malloc(len
);
758 snprintf(buf
, len
, "%s.%d", parent
->id
, parent
->num_child_bus
);
761 /* no id -> use lowercase bus type for bus name */
762 len
= strlen(info
->name
) + 16;
763 buf
= qemu_malloc(len
);
764 len
= snprintf(buf
, len
, "%s.%d", info
->name
,
765 parent
? parent
->num_child_bus
: 0);
766 for (i
= 0; i
< len
; i
++)
767 buf
[i
] = qemu_tolower(buf
[i
]);
771 QLIST_INIT(&bus
->children
);
773 QLIST_INSERT_HEAD(&parent
->child_bus
, bus
, sibling
);
774 parent
->num_child_bus
++;
775 } else if (bus
!= main_system_bus
) {
776 /* TODO: once all bus devices are qdevified,
777 only reset handler for main_system_bus should be registered here. */
778 qemu_register_reset(qbus_reset_all_fn
, bus
);
782 BusState
*qbus_create(BusInfo
*info
, DeviceState
*parent
, const char *name
)
786 bus
= qemu_mallocz(info
->size
);
787 bus
->qdev_allocated
= 1;
788 qbus_create_inplace(bus
, info
, parent
, name
);
792 static void main_system_bus_create(void)
794 /* assign main_system_bus before qbus_create_inplace()
795 * in order to make "if (bus != main_system_bus)" work */
796 main_system_bus
= qemu_mallocz(system_bus_info
.size
);
797 main_system_bus
->qdev_allocated
= 1;
798 qbus_create_inplace(main_system_bus
, &system_bus_info
, NULL
,
802 void qbus_free(BusState
*bus
)
806 while ((dev
= QLIST_FIRST(&bus
->children
)) != NULL
) {
810 QLIST_REMOVE(bus
, sibling
);
811 bus
->parent
->num_child_bus
--;
813 assert(bus
!= main_system_bus
); /* main_system_bus is never freed */
814 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
816 qemu_free((void*)bus
->name
);
817 if (bus
->qdev_allocated
) {
822 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
823 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
825 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
826 const char *prefix
, int indent
)
832 while (props
->name
) {
834 * TODO Properties without a print method are just for dirty
835 * hacks. qdev_prop_ptr is the only such PropertyInfo. It's
836 * marked for removal. The test props->info->print should be
837 * removed along with it.
839 if (props
->info
->print
) {
840 props
->info
->print(dev
, props
, buf
, sizeof(buf
));
841 qdev_printf("%s-prop: %s = %s\n", prefix
, props
->name
, buf
);
847 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
850 qdev_printf("dev: %s, id \"%s\"\n", dev
->info
->name
,
851 dev
->id
? dev
->id
: "");
853 if (dev
->num_gpio_in
) {
854 qdev_printf("gpio-in %d\n", dev
->num_gpio_in
);
856 if (dev
->num_gpio_out
) {
857 qdev_printf("gpio-out %d\n", dev
->num_gpio_out
);
859 qdev_print_props(mon
, dev
, dev
->info
->props
, "dev", indent
);
860 qdev_print_props(mon
, dev
, dev
->parent_bus
->info
->props
, "bus", indent
);
861 if (dev
->parent_bus
->info
->print_dev
)
862 dev
->parent_bus
->info
->print_dev(mon
, dev
, indent
);
863 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
864 qbus_print(mon
, child
, indent
);
868 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
870 struct DeviceState
*dev
;
872 qdev_printf("bus: %s\n", bus
->name
);
874 qdev_printf("type %s\n", bus
->info
->name
);
875 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
876 qdev_print(mon
, dev
, indent
);
881 void do_info_qtree(Monitor
*mon
)
884 qbus_print(mon
, main_system_bus
, 0);
887 void do_info_qdm(Monitor
*mon
)
891 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
892 qdev_print_devinfo(info
);
896 int do_device_add(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
900 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
);
904 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
908 if (!qdev_device_add(opts
)) {
915 int do_device_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
917 const char *id
= qdict_get_str(qdict
, "id");
920 dev
= qdev_find_recursive(main_system_bus
, id
);
922 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
925 return qdev_unplug(dev
);
928 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
932 if (dev
&& dev
->parent_bus
) {
934 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
935 if (dev
->parent_bus
->info
->get_fw_dev_path
) {
936 d
= dev
->parent_bus
->info
->get_fw_dev_path(dev
);
937 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
940 l
+= snprintf(p
+ l
, size
- l
, "%s", dev
->info
->name
);
943 l
+= snprintf(p
+ l
, size
- l
, "/");
948 char* qdev_get_fw_dev_path(DeviceState
*dev
)
953 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);