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 int qdev_hotplug
= 0;
36 /* This is a nasty hack to allow passing a NULL bus to qdev_create. */
37 static BusState
*main_system_bus
;
39 DeviceInfo
*device_info_list
;
41 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
43 static BusState
*qbus_find(const char *path
);
45 /* Register a new device type. */
46 void qdev_register(DeviceInfo
*info
)
48 assert(info
->size
>= sizeof(DeviceState
));
51 info
->next
= device_info_list
;
52 device_info_list
= info
;
55 static DeviceInfo
*qdev_find_info(BusInfo
*bus_info
, const char *name
)
59 /* first check device names */
60 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
61 if (bus_info
&& info
->bus_info
!= bus_info
)
63 if (strcmp(info
->name
, name
) != 0)
68 /* failing that check the aliases */
69 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
70 if (bus_info
&& info
->bus_info
!= bus_info
)
74 if (strcmp(info
->alias
, name
) != 0)
81 static DeviceState
*qdev_create_from_info(BusState
*bus
, DeviceInfo
*info
)
85 assert(bus
->info
== info
->bus_info
);
86 dev
= qemu_mallocz(info
->size
);
88 dev
->parent_bus
= bus
;
89 qdev_prop_set_defaults(dev
, dev
->info
->props
);
90 qdev_prop_set_defaults(dev
, dev
->parent_bus
->info
->props
);
91 qdev_prop_set_globals(dev
);
92 QLIST_INSERT_HEAD(&bus
->children
, dev
, sibling
);
94 assert(bus
->allow_hotplug
);
97 dev
->instance_id_alias
= -1;
98 dev
->state
= DEV_STATE_CREATED
;
102 /* Create a new device. This only initializes the device state structure
103 and allows properties to be set. qdev_init should be called to
104 initialize the actual device emulation. */
105 DeviceState
*qdev_create(BusState
*bus
, const char *name
)
110 bus
= sysbus_get_default();
113 info
= qdev_find_info(bus
->info
, name
);
115 hw_error("Unknown device '%s' for bus '%s'\n", name
, bus
->info
->name
);
118 return qdev_create_from_info(bus
, info
);
121 static void qdev_print_devinfo(DeviceInfo
*info
)
123 error_printf("name \"%s\", bus %s",
124 info
->name
, info
->bus_info
->name
);
126 error_printf(", alias \"%s\"", info
->alias
);
129 error_printf(", desc \"%s\"", info
->desc
);
132 error_printf(", no-user");
137 static int set_property(const char *name
, const char *value
, void *opaque
)
139 DeviceState
*dev
= opaque
;
141 if (strcmp(name
, "driver") == 0)
143 if (strcmp(name
, "bus") == 0)
146 if (qdev_prop_parse(dev
, name
, value
) == -1) {
152 int qdev_device_help(QemuOpts
*opts
)
158 driver
= qemu_opt_get(opts
, "driver");
159 if (driver
&& !strcmp(driver
, "?")) {
160 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
162 continue; /* not available, don't show */
164 qdev_print_devinfo(info
);
169 if (!qemu_opt_get(opts
, "?")) {
173 info
= qdev_find_info(NULL
, driver
);
178 for (prop
= info
->props
; prop
&& prop
->name
; prop
++) {
180 * TODO Properties without a parser are just for dirty hacks.
181 * qdev_prop_ptr is the only such PropertyInfo. It's marked
182 * for removal. This conditional should be removed along with
185 if (!prop
->info
->parse
) {
186 continue; /* no way to set it, don't show */
188 error_printf("%s.%s=%s\n", info
->name
, prop
->name
, prop
->info
->name
);
193 DeviceState
*qdev_device_add(QemuOpts
*opts
)
195 const char *driver
, *path
, *id
;
200 driver
= qemu_opt_get(opts
, "driver");
202 qerror_report(QERR_MISSING_PARAMETER
, "driver");
207 info
= qdev_find_info(NULL
, driver
);
208 if (!info
|| info
->no_user
) {
209 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "driver", "a driver name");
210 error_printf_unless_qmp("Try with argument '?' for a list.\n");
215 path
= qemu_opt_get(opts
, "bus");
217 bus
= qbus_find(path
);
221 if (bus
->info
!= info
->bus_info
) {
222 qerror_report(QERR_BAD_BUS_FOR_DEVICE
,
223 driver
, bus
->info
->name
);
227 bus
= qbus_find_recursive(main_system_bus
, NULL
, info
->bus_info
);
229 qerror_report(QERR_NO_BUS_FOR_DEVICE
,
230 info
->name
, info
->bus_info
->name
);
234 if (qdev_hotplug
&& !bus
->allow_hotplug
) {
235 qerror_report(QERR_BUS_NO_HOTPLUG
, bus
->name
);
239 /* create device, set properties */
240 qdev
= qdev_create_from_info(bus
, info
);
241 id
= qemu_opts_id(opts
);
245 if (qemu_opt_foreach(opts
, set_property
, qdev
, 1) != 0) {
249 if (qdev_init(qdev
) < 0) {
250 qerror_report(QERR_DEVICE_INIT_FAILED
, driver
);
257 /* Initialize a device. Device properties should be set before calling
258 this function. IRQs and MMIO regions should be connected/mapped after
259 calling this function.
260 On failure, destroy the device and return negative value.
261 Return 0 on success. */
262 int qdev_init(DeviceState
*dev
)
266 assert(dev
->state
== DEV_STATE_CREATED
);
267 rc
= dev
->info
->init(dev
, dev
->info
);
272 if (dev
->info
->vmsd
) {
273 vmstate_register_with_alias_id(dev
, -1, dev
->info
->vmsd
, dev
,
274 dev
->instance_id_alias
,
275 dev
->alias_required_for_version
);
277 dev
->state
= DEV_STATE_INITIALIZED
;
281 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
282 int required_for_version
)
284 assert(dev
->state
== DEV_STATE_CREATED
);
285 dev
->instance_id_alias
= alias_id
;
286 dev
->alias_required_for_version
= required_for_version
;
289 int qdev_unplug(DeviceState
*dev
)
291 if (!dev
->parent_bus
->allow_hotplug
) {
292 qerror_report(QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
295 assert(dev
->info
->unplug
!= NULL
);
297 return dev
->info
->unplug(dev
);
300 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
302 if (dev
->info
->reset
) {
303 dev
->info
->reset(dev
);
309 BusState
*sysbus_get_default(void)
311 if (!main_system_bus
) {
312 main_system_bus
= qbus_create(&system_bus_info
, NULL
,
315 return main_system_bus
;
318 static int qbus_reset_one(BusState
*bus
, void *opaque
)
320 if (bus
->info
->reset
) {
321 return bus
->info
->reset(bus
);
326 void qdev_reset_all(DeviceState
*dev
)
328 qdev_walk_children(dev
, qdev_reset_one
, qbus_reset_one
, NULL
);
331 void qbus_reset_all_fn(void *opaque
)
333 BusState
*bus
= opaque
;
334 qbus_walk_children(bus
, qdev_reset_one
, qbus_reset_one
, NULL
);
337 /* can be used as ->unplug() callback for the simple cases */
338 int qdev_simple_unplug_cb(DeviceState
*dev
)
345 /* Like qdev_init(), but terminate program via hw_error() instead of
346 returning an error value. This is okay during machine creation.
347 Don't use for hotplug, because there callers need to recover from
348 failure. Exception: if you know the device's init() callback can't
349 fail, then qdev_init_nofail() can't fail either, and is therefore
350 usable even then. But relying on the device implementation that
351 way is somewhat unclean, and best avoided. */
352 void qdev_init_nofail(DeviceState
*dev
)
354 DeviceInfo
*info
= dev
->info
;
356 if (qdev_init(dev
) < 0) {
357 error_report("Initialization of device %s failed\n", info
->name
);
362 /* Unlink device from bus and free the structure. */
363 void qdev_free(DeviceState
*dev
)
368 if (dev
->state
== DEV_STATE_INITIALIZED
) {
369 while (dev
->num_child_bus
) {
370 bus
= QLIST_FIRST(&dev
->child_bus
);
374 vmstate_unregister(dev
, dev
->info
->vmsd
, dev
);
376 dev
->info
->exit(dev
);
378 qemu_opts_del(dev
->opts
);
380 QLIST_REMOVE(dev
, sibling
);
381 for (prop
= dev
->info
->props
; prop
&& prop
->name
; prop
++) {
382 if (prop
->info
->free
) {
383 prop
->info
->free(dev
, prop
);
389 void qdev_machine_creation_done(void)
392 * ok, initial machine setup is done, starting from now we can
393 * only create hotpluggable devices
398 /* Get a character (serial) device interface. */
399 CharDriverState
*qdev_init_chardev(DeviceState
*dev
)
401 static int next_serial
;
403 /* FIXME: This function needs to go away: use chardev properties! */
404 return serial_hds
[next_serial
++];
407 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
409 return dev
->parent_bus
;
412 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
414 assert(dev
->num_gpio_in
== 0);
415 dev
->num_gpio_in
= n
;
416 dev
->gpio_in
= qemu_allocate_irqs(handler
, dev
, n
);
419 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
421 assert(dev
->num_gpio_out
== 0);
422 dev
->num_gpio_out
= n
;
423 dev
->gpio_out
= pins
;
426 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
428 assert(n
>= 0 && n
< dev
->num_gpio_in
);
429 return dev
->gpio_in
[n
];
432 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
434 assert(n
>= 0 && n
< dev
->num_gpio_out
);
435 dev
->gpio_out
[n
] = pin
;
438 void qdev_set_nic_properties(DeviceState
*dev
, NICInfo
*nd
)
440 qdev_prop_set_macaddr(dev
, "mac", nd
->macaddr
);
442 qdev_prop_set_vlan(dev
, "vlan", nd
->vlan
);
444 qdev_prop_set_netdev(dev
, "netdev", nd
->netdev
);
445 if (nd
->nvectors
!= DEV_NVECTORS_UNSPECIFIED
&&
446 qdev_prop_exists(dev
, "vectors")) {
447 qdev_prop_set_uint32(dev
, "vectors", nd
->nvectors
);
451 static int next_block_unit
[IF_COUNT
];
453 /* Get a block device. This should only be used for single-drive devices
454 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
456 BlockDriverState
*qdev_init_bdrv(DeviceState
*dev
, BlockInterfaceType type
)
458 int unit
= next_block_unit
[type
]++;
461 dinfo
= drive_get(type
, 0, unit
);
462 return dinfo
? dinfo
->bdrv
: NULL
;
465 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
)
469 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
470 if (strcmp(name
, bus
->name
) == 0) {
477 int qbus_walk_children(BusState
*bus
, qdev_walkerfn
*devfn
,
478 qbus_walkerfn
*busfn
, void *opaque
)
484 err
= busfn(bus
, opaque
);
490 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
491 err
= qdev_walk_children(dev
, devfn
, busfn
, opaque
);
500 int qdev_walk_children(DeviceState
*dev
, qdev_walkerfn
*devfn
,
501 qbus_walkerfn
*busfn
, void *opaque
)
507 err
= devfn(dev
, opaque
);
513 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
514 err
= qbus_walk_children(bus
, devfn
, busfn
, opaque
);
523 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
527 BusState
*child
, *ret
;
530 if (name
&& (strcmp(bus
->name
, name
) != 0)) {
533 if (info
&& (bus
->info
!= info
)) {
540 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
541 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
542 ret
= qbus_find_recursive(child
, name
, info
);
551 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
)
553 DeviceState
*dev
, *ret
;
556 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
557 if (dev
->id
&& strcmp(dev
->id
, id
) == 0)
559 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
560 ret
= qdev_find_recursive(child
, id
);
569 static void qbus_list_bus(DeviceState
*dev
)
572 const char *sep
= " ";
574 error_printf("child busses at \"%s\":",
575 dev
->id
? dev
->id
: dev
->info
->name
);
576 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
577 error_printf("%s\"%s\"", sep
, child
->name
);
583 static void qbus_list_dev(BusState
*bus
)
586 const char *sep
= " ";
588 error_printf("devices at \"%s\":", bus
->name
);
589 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
590 error_printf("%s\"%s\"", sep
, dev
->info
->name
);
592 error_printf("/\"%s\"", dev
->id
);
598 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
602 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
603 if (strcmp(child
->name
, elem
) == 0) {
610 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
615 * try to match in order:
616 * (1) instance id, if present
618 * (3) driver alias, if present
620 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
621 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
625 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
626 if (strcmp(dev
->info
->name
, elem
) == 0) {
630 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
631 if (dev
->info
->alias
&& strcmp(dev
->info
->alias
, elem
) == 0) {
638 static BusState
*qbus_find(const char *path
)
645 /* find start element */
646 if (path
[0] == '/') {
647 bus
= main_system_bus
;
650 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
654 bus
= qbus_find_recursive(main_system_bus
, elem
, NULL
);
656 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
663 assert(path
[pos
] == '/' || !path
[pos
]);
664 while (path
[pos
] == '/') {
667 if (path
[pos
] == '\0') {
672 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
677 dev
= qbus_find_dev(bus
, elem
);
679 qerror_report(QERR_DEVICE_NOT_FOUND
, elem
);
680 if (!monitor_cur_is_qmp()) {
686 assert(path
[pos
] == '/' || !path
[pos
]);
687 while (path
[pos
] == '/') {
690 if (path
[pos
] == '\0') {
691 /* last specified element is a device. If it has exactly
692 * one child bus accept it nevertheless */
693 switch (dev
->num_child_bus
) {
695 qerror_report(QERR_DEVICE_NO_BUS
, elem
);
698 return QLIST_FIRST(&dev
->child_bus
);
700 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES
, elem
);
701 if (!monitor_cur_is_qmp()) {
709 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
714 bus
= qbus_find_bus(dev
, elem
);
716 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
717 if (!monitor_cur_is_qmp()) {
725 void qbus_create_inplace(BusState
*bus
, BusInfo
*info
,
726 DeviceState
*parent
, const char *name
)
732 bus
->parent
= parent
;
735 /* use supplied name */
736 bus
->name
= qemu_strdup(name
);
737 } else if (parent
&& parent
->id
) {
738 /* parent device has id -> use it for bus name */
739 len
= strlen(parent
->id
) + 16;
740 buf
= qemu_malloc(len
);
741 snprintf(buf
, len
, "%s.%d", parent
->id
, parent
->num_child_bus
);
744 /* no id -> use lowercase bus type for bus name */
745 len
= strlen(info
->name
) + 16;
746 buf
= qemu_malloc(len
);
747 len
= snprintf(buf
, len
, "%s.%d", info
->name
,
748 parent
? parent
->num_child_bus
: 0);
749 for (i
= 0; i
< len
; i
++)
750 buf
[i
] = qemu_tolower(buf
[i
]);
754 QLIST_INIT(&bus
->children
);
756 QLIST_INSERT_HEAD(&parent
->child_bus
, bus
, sibling
);
757 parent
->num_child_bus
++;
758 } else if (bus
!= main_system_bus
) {
759 /* TODO: once all bus devices are qdevified,
760 only reset handler for main_system_bus should be registered here. */
761 qemu_register_reset(qbus_reset_all_fn
, bus
);
765 BusState
*qbus_create(BusInfo
*info
, DeviceState
*parent
, const char *name
)
769 bus
= qemu_mallocz(info
->size
);
770 bus
->qdev_allocated
= 1;
771 qbus_create_inplace(bus
, info
, parent
, name
);
775 void qbus_free(BusState
*bus
)
779 while ((dev
= QLIST_FIRST(&bus
->children
)) != NULL
) {
783 QLIST_REMOVE(bus
, sibling
);
784 bus
->parent
->num_child_bus
--;
786 assert(bus
!= main_system_bus
); /* main_system_bus is never freed */
787 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
789 qemu_free((void*)bus
->name
);
790 if (bus
->qdev_allocated
) {
795 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
796 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
798 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
799 const char *prefix
, int indent
)
805 while (props
->name
) {
807 * TODO Properties without a print method are just for dirty
808 * hacks. qdev_prop_ptr is the only such PropertyInfo. It's
809 * marked for removal. The test props->info->print should be
810 * removed along with it.
812 if (props
->info
->print
) {
813 props
->info
->print(dev
, props
, buf
, sizeof(buf
));
814 qdev_printf("%s-prop: %s = %s\n", prefix
, props
->name
, buf
);
820 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
823 qdev_printf("dev: %s, id \"%s\"\n", dev
->info
->name
,
824 dev
->id
? dev
->id
: "");
826 if (dev
->num_gpio_in
) {
827 qdev_printf("gpio-in %d\n", dev
->num_gpio_in
);
829 if (dev
->num_gpio_out
) {
830 qdev_printf("gpio-out %d\n", dev
->num_gpio_out
);
832 qdev_print_props(mon
, dev
, dev
->info
->props
, "dev", indent
);
833 qdev_print_props(mon
, dev
, dev
->parent_bus
->info
->props
, "bus", indent
);
834 if (dev
->parent_bus
->info
->print_dev
)
835 dev
->parent_bus
->info
->print_dev(mon
, dev
, indent
);
836 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
837 qbus_print(mon
, child
, indent
);
841 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
843 struct DeviceState
*dev
;
845 qdev_printf("bus: %s\n", bus
->name
);
847 qdev_printf("type %s\n", bus
->info
->name
);
848 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
849 qdev_print(mon
, dev
, indent
);
854 void do_info_qtree(Monitor
*mon
)
857 qbus_print(mon
, main_system_bus
, 0);
860 void do_info_qdm(Monitor
*mon
)
864 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
865 qdev_print_devinfo(info
);
869 int do_device_add(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
873 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
);
877 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
881 if (!qdev_device_add(opts
)) {
888 int do_device_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
890 const char *id
= qdict_get_str(qdict
, "id");
893 dev
= qdev_find_recursive(main_system_bus
, id
);
895 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
898 return qdev_unplug(dev
);
901 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
905 if (dev
&& dev
->parent_bus
) {
907 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
908 if (dev
->parent_bus
->info
->get_fw_dev_path
) {
909 d
= dev
->parent_bus
->info
->get_fw_dev_path(dev
);
910 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
913 l
+= snprintf(p
+ l
, size
- l
, "%s", dev
->info
->name
);
916 l
+= snprintf(p
+ l
, size
- l
, "/");
921 char* qdev_get_fw_dev_path(DeviceState
*dev
)
926 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);