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
= g_malloc0(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 QTAILQ_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 (!driver
|| !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
);
210 for (prop
= info
->bus_info
->props
; prop
&& prop
->name
; prop
++) {
211 if (!prop
->info
->parse
) {
212 continue; /* no way to set it, don't show */
214 error_printf("%s.%s=%s\n", info
->name
, prop
->name
, prop
->info
->name
);
219 DeviceState
*qdev_device_add(QemuOpts
*opts
)
221 const char *driver
, *path
, *id
;
226 driver
= qemu_opt_get(opts
, "driver");
228 qerror_report(QERR_MISSING_PARAMETER
, "driver");
233 info
= qdev_find_info(NULL
, driver
);
234 if (!info
|| info
->no_user
) {
235 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "driver", "a driver name");
236 error_printf_unless_qmp("Try with argument '?' for a list.\n");
241 path
= qemu_opt_get(opts
, "bus");
243 bus
= qbus_find(path
);
247 if (bus
->info
!= info
->bus_info
) {
248 qerror_report(QERR_BAD_BUS_FOR_DEVICE
,
249 driver
, bus
->info
->name
);
253 bus
= qbus_find_recursive(main_system_bus
, NULL
, info
->bus_info
);
255 qerror_report(QERR_NO_BUS_FOR_DEVICE
,
256 info
->name
, info
->bus_info
->name
);
260 if (qdev_hotplug
&& !bus
->allow_hotplug
) {
261 qerror_report(QERR_BUS_NO_HOTPLUG
, bus
->name
);
265 /* create device, set properties */
266 qdev
= qdev_create_from_info(bus
, info
);
267 id
= qemu_opts_id(opts
);
271 if (qemu_opt_foreach(opts
, set_property
, qdev
, 1) != 0) {
275 if (qdev_init(qdev
) < 0) {
276 qerror_report(QERR_DEVICE_INIT_FAILED
, driver
);
283 /* Initialize a device. Device properties should be set before calling
284 this function. IRQs and MMIO regions should be connected/mapped after
285 calling this function.
286 On failure, destroy the device and return negative value.
287 Return 0 on success. */
288 int qdev_init(DeviceState
*dev
)
292 assert(dev
->state
== DEV_STATE_CREATED
);
293 rc
= dev
->info
->init(dev
, dev
->info
);
298 if (dev
->info
->vmsd
) {
299 vmstate_register_with_alias_id(dev
, -1, dev
->info
->vmsd
, dev
,
300 dev
->instance_id_alias
,
301 dev
->alias_required_for_version
);
303 dev
->state
= DEV_STATE_INITIALIZED
;
304 if (dev
->hotplugged
&& dev
->info
->reset
) {
305 dev
->info
->reset(dev
);
310 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
311 int required_for_version
)
313 assert(dev
->state
== DEV_STATE_CREATED
);
314 dev
->instance_id_alias
= alias_id
;
315 dev
->alias_required_for_version
= required_for_version
;
318 int qdev_unplug(DeviceState
*dev
)
320 if (!dev
->parent_bus
->allow_hotplug
) {
321 qerror_report(QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
324 assert(dev
->info
->unplug
!= NULL
);
326 qdev_hot_removed
= true;
328 return dev
->info
->unplug(dev
);
331 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
333 if (dev
->info
->reset
) {
334 dev
->info
->reset(dev
);
340 BusState
*sysbus_get_default(void)
342 if (!main_system_bus
) {
343 main_system_bus_create();
345 return main_system_bus
;
348 static int qbus_reset_one(BusState
*bus
, void *opaque
)
350 if (bus
->info
->reset
) {
351 return bus
->info
->reset(bus
);
356 void qdev_reset_all(DeviceState
*dev
)
358 qdev_walk_children(dev
, qdev_reset_one
, qbus_reset_one
, NULL
);
361 void qbus_reset_all_fn(void *opaque
)
363 BusState
*bus
= opaque
;
364 qbus_walk_children(bus
, qdev_reset_one
, qbus_reset_one
, NULL
);
367 /* can be used as ->unplug() callback for the simple cases */
368 int qdev_simple_unplug_cb(DeviceState
*dev
)
376 /* Like qdev_init(), but terminate program via error_report() instead of
377 returning an error value. This is okay during machine creation.
378 Don't use for hotplug, because there callers need to recover from
379 failure. Exception: if you know the device's init() callback can't
380 fail, then qdev_init_nofail() can't fail either, and is therefore
381 usable even then. But relying on the device implementation that
382 way is somewhat unclean, and best avoided. */
383 void qdev_init_nofail(DeviceState
*dev
)
385 DeviceInfo
*info
= dev
->info
;
387 if (qdev_init(dev
) < 0) {
388 error_report("Initialization of device %s failed", info
->name
);
393 /* Unlink device from bus and free the structure. */
394 void qdev_free(DeviceState
*dev
)
399 if (dev
->state
== DEV_STATE_INITIALIZED
) {
400 while (dev
->num_child_bus
) {
401 bus
= QLIST_FIRST(&dev
->child_bus
);
405 vmstate_unregister(dev
, dev
->info
->vmsd
, dev
);
407 dev
->info
->exit(dev
);
409 qemu_opts_del(dev
->opts
);
411 QTAILQ_REMOVE(&dev
->parent_bus
->children
, dev
, sibling
);
412 for (prop
= dev
->info
->props
; prop
&& prop
->name
; prop
++) {
413 if (prop
->info
->free
) {
414 prop
->info
->free(dev
, prop
);
420 void qdev_machine_creation_done(void)
423 * ok, initial machine setup is done, starting from now we can
424 * only create hotpluggable devices
429 bool qdev_machine_modified(void)
431 return qdev_hot_added
|| qdev_hot_removed
;
434 /* Get a character (serial) device interface. */
435 CharDriverState
*qdev_init_chardev(DeviceState
*dev
)
437 static int next_serial
;
439 /* FIXME: This function needs to go away: use chardev properties! */
440 return serial_hds
[next_serial
++];
443 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
445 return dev
->parent_bus
;
448 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
450 assert(dev
->num_gpio_in
== 0);
451 dev
->num_gpio_in
= n
;
452 dev
->gpio_in
= qemu_allocate_irqs(handler
, dev
, n
);
455 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
457 assert(dev
->num_gpio_out
== 0);
458 dev
->num_gpio_out
= n
;
459 dev
->gpio_out
= pins
;
462 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
464 assert(n
>= 0 && n
< dev
->num_gpio_in
);
465 return dev
->gpio_in
[n
];
468 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
470 assert(n
>= 0 && n
< dev
->num_gpio_out
);
471 dev
->gpio_out
[n
] = pin
;
474 void qdev_set_nic_properties(DeviceState
*dev
, NICInfo
*nd
)
476 qdev_prop_set_macaddr(dev
, "mac", nd
->macaddr
.a
);
478 qdev_prop_set_vlan(dev
, "vlan", nd
->vlan
);
480 qdev_prop_set_netdev(dev
, "netdev", nd
->netdev
);
481 if (nd
->nvectors
!= DEV_NVECTORS_UNSPECIFIED
&&
482 qdev_prop_exists(dev
, "vectors")) {
483 qdev_prop_set_uint32(dev
, "vectors", nd
->nvectors
);
485 nd
->instantiated
= 1;
488 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
)
492 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
493 if (strcmp(name
, bus
->name
) == 0) {
500 int qbus_walk_children(BusState
*bus
, qdev_walkerfn
*devfn
,
501 qbus_walkerfn
*busfn
, void *opaque
)
507 err
= busfn(bus
, opaque
);
513 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
514 err
= qdev_walk_children(dev
, devfn
, busfn
, opaque
);
523 int qdev_walk_children(DeviceState
*dev
, qdev_walkerfn
*devfn
,
524 qbus_walkerfn
*busfn
, void *opaque
)
530 err
= devfn(dev
, opaque
);
536 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
537 err
= qbus_walk_children(bus
, devfn
, busfn
, opaque
);
546 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
550 BusState
*child
, *ret
;
553 if (name
&& (strcmp(bus
->name
, name
) != 0)) {
556 if (info
&& (bus
->info
!= info
)) {
563 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
564 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
565 ret
= qbus_find_recursive(child
, name
, info
);
574 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
)
576 DeviceState
*dev
, *ret
;
579 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
580 if (dev
->id
&& strcmp(dev
->id
, id
) == 0)
582 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
583 ret
= qdev_find_recursive(child
, id
);
592 static void qbus_list_bus(DeviceState
*dev
)
595 const char *sep
= " ";
597 error_printf("child busses at \"%s\":",
598 dev
->id
? dev
->id
: dev
->info
->name
);
599 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
600 error_printf("%s\"%s\"", sep
, child
->name
);
606 static void qbus_list_dev(BusState
*bus
)
609 const char *sep
= " ";
611 error_printf("devices at \"%s\":", bus
->name
);
612 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
613 error_printf("%s\"%s\"", sep
, dev
->info
->name
);
615 error_printf("/\"%s\"", dev
->id
);
621 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
625 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
626 if (strcmp(child
->name
, elem
) == 0) {
633 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
638 * try to match in order:
639 * (1) instance id, if present
641 * (3) driver alias, if present
643 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
644 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
648 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
649 if (strcmp(dev
->info
->name
, elem
) == 0) {
653 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
654 if (dev
->info
->alias
&& strcmp(dev
->info
->alias
, elem
) == 0) {
661 static BusState
*qbus_find(const char *path
)
668 /* find start element */
669 if (path
[0] == '/') {
670 bus
= main_system_bus
;
673 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
677 bus
= qbus_find_recursive(main_system_bus
, elem
, NULL
);
679 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
686 assert(path
[pos
] == '/' || !path
[pos
]);
687 while (path
[pos
] == '/') {
690 if (path
[pos
] == '\0') {
695 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
700 dev
= qbus_find_dev(bus
, elem
);
702 qerror_report(QERR_DEVICE_NOT_FOUND
, elem
);
703 if (!monitor_cur_is_qmp()) {
709 assert(path
[pos
] == '/' || !path
[pos
]);
710 while (path
[pos
] == '/') {
713 if (path
[pos
] == '\0') {
714 /* last specified element is a device. If it has exactly
715 * one child bus accept it nevertheless */
716 switch (dev
->num_child_bus
) {
718 qerror_report(QERR_DEVICE_NO_BUS
, elem
);
721 return QLIST_FIRST(&dev
->child_bus
);
723 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES
, elem
);
724 if (!monitor_cur_is_qmp()) {
732 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
737 bus
= qbus_find_bus(dev
, elem
);
739 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
740 if (!monitor_cur_is_qmp()) {
748 void qbus_create_inplace(BusState
*bus
, BusInfo
*info
,
749 DeviceState
*parent
, const char *name
)
755 bus
->parent
= parent
;
758 /* use supplied name */
759 bus
->name
= g_strdup(name
);
760 } else if (parent
&& parent
->id
) {
761 /* parent device has id -> use it for bus name */
762 len
= strlen(parent
->id
) + 16;
764 snprintf(buf
, len
, "%s.%d", parent
->id
, parent
->num_child_bus
);
767 /* no id -> use lowercase bus type for bus name */
768 len
= strlen(info
->name
) + 16;
770 len
= snprintf(buf
, len
, "%s.%d", info
->name
,
771 parent
? parent
->num_child_bus
: 0);
772 for (i
= 0; i
< len
; i
++)
773 buf
[i
] = qemu_tolower(buf
[i
]);
777 QTAILQ_INIT(&bus
->children
);
779 QLIST_INSERT_HEAD(&parent
->child_bus
, bus
, sibling
);
780 parent
->num_child_bus
++;
781 } else if (bus
!= main_system_bus
) {
782 /* TODO: once all bus devices are qdevified,
783 only reset handler for main_system_bus should be registered here. */
784 qemu_register_reset(qbus_reset_all_fn
, bus
);
788 BusState
*qbus_create(BusInfo
*info
, DeviceState
*parent
, const char *name
)
792 bus
= g_malloc0(info
->size
);
793 bus
->qdev_allocated
= 1;
794 qbus_create_inplace(bus
, info
, parent
, name
);
798 static void main_system_bus_create(void)
800 /* assign main_system_bus before qbus_create_inplace()
801 * in order to make "if (bus != main_system_bus)" work */
802 main_system_bus
= g_malloc0(system_bus_info
.size
);
803 main_system_bus
->qdev_allocated
= 1;
804 qbus_create_inplace(main_system_bus
, &system_bus_info
, NULL
,
808 void qbus_free(BusState
*bus
)
812 while ((dev
= QTAILQ_FIRST(&bus
->children
)) != NULL
) {
816 QLIST_REMOVE(bus
, sibling
);
817 bus
->parent
->num_child_bus
--;
819 assert(bus
!= main_system_bus
); /* main_system_bus is never freed */
820 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
822 g_free((void*)bus
->name
);
823 if (bus
->qdev_allocated
) {
828 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
829 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
831 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
832 const char *prefix
, int indent
)
838 while (props
->name
) {
840 * TODO Properties without a print method are just for dirty
841 * hacks. qdev_prop_ptr is the only such PropertyInfo. It's
842 * marked for removal. The test props->info->print should be
843 * removed along with it.
845 if (props
->info
->print
) {
846 props
->info
->print(dev
, props
, buf
, sizeof(buf
));
847 qdev_printf("%s-prop: %s = %s\n", prefix
, props
->name
, buf
);
853 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
856 qdev_printf("dev: %s, id \"%s\"\n", dev
->info
->name
,
857 dev
->id
? dev
->id
: "");
859 if (dev
->num_gpio_in
) {
860 qdev_printf("gpio-in %d\n", dev
->num_gpio_in
);
862 if (dev
->num_gpio_out
) {
863 qdev_printf("gpio-out %d\n", dev
->num_gpio_out
);
865 qdev_print_props(mon
, dev
, dev
->info
->props
, "dev", indent
);
866 qdev_print_props(mon
, dev
, dev
->parent_bus
->info
->props
, "bus", indent
);
867 if (dev
->parent_bus
->info
->print_dev
)
868 dev
->parent_bus
->info
->print_dev(mon
, dev
, indent
);
869 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
870 qbus_print(mon
, child
, indent
);
874 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
876 struct DeviceState
*dev
;
878 qdev_printf("bus: %s\n", bus
->name
);
880 qdev_printf("type %s\n", bus
->info
->name
);
881 QTAILQ_FOREACH(dev
, &bus
->children
, sibling
) {
882 qdev_print(mon
, dev
, indent
);
887 void do_info_qtree(Monitor
*mon
)
890 qbus_print(mon
, main_system_bus
, 0);
893 void do_info_qdm(Monitor
*mon
)
897 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
898 qdev_print_devinfo(info
);
902 int do_device_add(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
906 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
);
910 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
914 if (!qdev_device_add(opts
)) {
921 int do_device_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
923 const char *id
= qdict_get_str(qdict
, "id");
926 dev
= qdev_find_recursive(main_system_bus
, id
);
928 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
931 return qdev_unplug(dev
);
934 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
938 if (dev
&& dev
->parent_bus
) {
940 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
941 if (dev
->parent_bus
->info
->get_fw_dev_path
) {
942 d
= dev
->parent_bus
->info
->get_fw_dev_path(dev
);
943 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
946 l
+= snprintf(p
+ l
, size
- l
, "%s", dev
->info
->name
);
949 l
+= snprintf(p
+ l
, size
- l
, "/");
954 char* qdev_get_fw_dev_path(DeviceState
*dev
)
959 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);