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
;
40 DeviceInfo
*device_info_list
;
42 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
44 static BusState
*qbus_find(const char *path
);
46 /* Register a new device type. */
47 void qdev_register(DeviceInfo
*info
)
49 assert(info
->size
>= sizeof(DeviceState
));
52 info
->next
= device_info_list
;
53 device_info_list
= info
;
56 static DeviceInfo
*qdev_find_info(BusInfo
*bus_info
, const char *name
)
60 /* first check device names */
61 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
62 if (bus_info
&& info
->bus_info
!= bus_info
)
64 if (strcmp(info
->name
, name
) != 0)
69 /* failing that check the aliases */
70 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
71 if (bus_info
&& info
->bus_info
!= bus_info
)
75 if (strcmp(info
->alias
, name
) != 0)
82 static DeviceState
*qdev_create_from_info(BusState
*bus
, DeviceInfo
*info
)
86 assert(bus
->info
== info
->bus_info
);
87 dev
= qemu_mallocz(info
->size
);
89 dev
->parent_bus
= bus
;
90 qdev_prop_set_defaults(dev
, dev
->info
->props
);
91 qdev_prop_set_defaults(dev
, dev
->parent_bus
->info
->props
);
92 qdev_prop_set_globals(dev
);
93 QLIST_INSERT_HEAD(&bus
->children
, dev
, sibling
);
95 assert(bus
->allow_hotplug
);
97 qdev_hot_added
= true;
99 dev
->instance_id_alias
= -1;
100 dev
->state
= DEV_STATE_CREATED
;
104 /* Create a new device. This only initializes the device state structure
105 and allows properties to be set. qdev_init should be called to
106 initialize the actual device emulation. */
107 DeviceState
*qdev_create(BusState
*bus
, const char *name
)
111 dev
= qdev_try_create(bus
, name
);
113 hw_error("Unknown device '%s' for bus '%s'\n", name
, bus
->info
->name
);
119 DeviceState
*qdev_try_create(BusState
*bus
, const char *name
)
124 bus
= sysbus_get_default();
127 info
= qdev_find_info(bus
->info
, name
);
132 return qdev_create_from_info(bus
, info
);
135 static void qdev_print_devinfo(DeviceInfo
*info
)
137 error_printf("name \"%s\", bus %s",
138 info
->name
, info
->bus_info
->name
);
140 error_printf(", alias \"%s\"", info
->alias
);
143 error_printf(", desc \"%s\"", info
->desc
);
146 error_printf(", no-user");
151 static int set_property(const char *name
, const char *value
, void *opaque
)
153 DeviceState
*dev
= opaque
;
155 if (strcmp(name
, "driver") == 0)
157 if (strcmp(name
, "bus") == 0)
160 if (qdev_prop_parse(dev
, name
, value
) == -1) {
166 int qdev_device_help(QemuOpts
*opts
)
172 driver
= qemu_opt_get(opts
, "driver");
173 if (driver
&& !strcmp(driver
, "?")) {
174 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
176 continue; /* not available, don't show */
178 qdev_print_devinfo(info
);
183 if (!qemu_opt_get(opts
, "?")) {
187 info
= qdev_find_info(NULL
, driver
);
192 for (prop
= info
->props
; prop
&& prop
->name
; prop
++) {
194 * TODO Properties without a parser are just for dirty hacks.
195 * qdev_prop_ptr is the only such PropertyInfo. It's marked
196 * for removal. This conditional should be removed along with
199 if (!prop
->info
->parse
) {
200 continue; /* no way to set it, don't show */
202 error_printf("%s.%s=%s\n", info
->name
, prop
->name
, prop
->info
->name
);
207 DeviceState
*qdev_device_add(QemuOpts
*opts
)
209 const char *driver
, *path
, *id
;
214 driver
= qemu_opt_get(opts
, "driver");
216 qerror_report(QERR_MISSING_PARAMETER
, "driver");
221 info
= qdev_find_info(NULL
, driver
);
222 if (!info
|| info
->no_user
) {
223 qerror_report(QERR_INVALID_PARAMETER_VALUE
, "driver", "a driver name");
224 error_printf_unless_qmp("Try with argument '?' for a list.\n");
229 path
= qemu_opt_get(opts
, "bus");
231 bus
= qbus_find(path
);
235 if (bus
->info
!= info
->bus_info
) {
236 qerror_report(QERR_BAD_BUS_FOR_DEVICE
,
237 driver
, bus
->info
->name
);
241 bus
= qbus_find_recursive(main_system_bus
, NULL
, info
->bus_info
);
243 qerror_report(QERR_NO_BUS_FOR_DEVICE
,
244 info
->name
, info
->bus_info
->name
);
248 if (qdev_hotplug
&& !bus
->allow_hotplug
) {
249 qerror_report(QERR_BUS_NO_HOTPLUG
, bus
->name
);
253 /* create device, set properties */
254 qdev
= qdev_create_from_info(bus
, info
);
255 id
= qemu_opts_id(opts
);
259 if (qemu_opt_foreach(opts
, set_property
, qdev
, 1) != 0) {
263 if (qdev_init(qdev
) < 0) {
264 qerror_report(QERR_DEVICE_INIT_FAILED
, driver
);
271 /* Initialize a device. Device properties should be set before calling
272 this function. IRQs and MMIO regions should be connected/mapped after
273 calling this function.
274 On failure, destroy the device and return negative value.
275 Return 0 on success. */
276 int qdev_init(DeviceState
*dev
)
280 assert(dev
->state
== DEV_STATE_CREATED
);
281 rc
= dev
->info
->init(dev
, dev
->info
);
286 if (dev
->info
->vmsd
) {
287 vmstate_register_with_alias_id(dev
, -1, dev
->info
->vmsd
, dev
,
288 dev
->instance_id_alias
,
289 dev
->alias_required_for_version
);
291 dev
->state
= DEV_STATE_INITIALIZED
;
295 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
296 int required_for_version
)
298 assert(dev
->state
== DEV_STATE_CREATED
);
299 dev
->instance_id_alias
= alias_id
;
300 dev
->alias_required_for_version
= required_for_version
;
303 int qdev_unplug(DeviceState
*dev
)
305 if (!dev
->parent_bus
->allow_hotplug
) {
306 qerror_report(QERR_BUS_NO_HOTPLUG
, dev
->parent_bus
->name
);
309 assert(dev
->info
->unplug
!= NULL
);
311 qdev_hot_removed
= true;
313 return dev
->info
->unplug(dev
);
316 static int qdev_reset_one(DeviceState
*dev
, void *opaque
)
318 if (dev
->info
->reset
) {
319 dev
->info
->reset(dev
);
325 BusState
*sysbus_get_default(void)
327 if (!main_system_bus
) {
328 main_system_bus
= qbus_create(&system_bus_info
, NULL
,
331 return main_system_bus
;
334 static int qbus_reset_one(BusState
*bus
, void *opaque
)
336 if (bus
->info
->reset
) {
337 return bus
->info
->reset(bus
);
342 void qdev_reset_all(DeviceState
*dev
)
344 qdev_walk_children(dev
, qdev_reset_one
, qbus_reset_one
, NULL
);
347 void qbus_reset_all_fn(void *opaque
)
349 BusState
*bus
= opaque
;
350 qbus_walk_children(bus
, qdev_reset_one
, qbus_reset_one
, NULL
);
353 /* can be used as ->unplug() callback for the simple cases */
354 int qdev_simple_unplug_cb(DeviceState
*dev
)
362 /* Like qdev_init(), but terminate program via error_report() instead of
363 returning an error value. This is okay during machine creation.
364 Don't use for hotplug, because there callers need to recover from
365 failure. Exception: if you know the device's init() callback can't
366 fail, then qdev_init_nofail() can't fail either, and is therefore
367 usable even then. But relying on the device implementation that
368 way is somewhat unclean, and best avoided. */
369 void qdev_init_nofail(DeviceState
*dev
)
371 DeviceInfo
*info
= dev
->info
;
373 if (qdev_init(dev
) < 0) {
374 error_report("Initialization of device %s failed", info
->name
);
379 /* Unlink device from bus and free the structure. */
380 void qdev_free(DeviceState
*dev
)
385 if (dev
->state
== DEV_STATE_INITIALIZED
) {
386 while (dev
->num_child_bus
) {
387 bus
= QLIST_FIRST(&dev
->child_bus
);
391 vmstate_unregister(dev
, dev
->info
->vmsd
, dev
);
393 dev
->info
->exit(dev
);
395 qemu_opts_del(dev
->opts
);
397 QLIST_REMOVE(dev
, sibling
);
398 for (prop
= dev
->info
->props
; prop
&& prop
->name
; prop
++) {
399 if (prop
->info
->free
) {
400 prop
->info
->free(dev
, prop
);
406 void qdev_machine_creation_done(void)
409 * ok, initial machine setup is done, starting from now we can
410 * only create hotpluggable devices
415 bool qdev_machine_modified(void)
417 return qdev_hot_added
|| qdev_hot_removed
;
420 /* Get a character (serial) device interface. */
421 CharDriverState
*qdev_init_chardev(DeviceState
*dev
)
423 static int next_serial
;
425 /* FIXME: This function needs to go away: use chardev properties! */
426 return serial_hds
[next_serial
++];
429 BusState
*qdev_get_parent_bus(DeviceState
*dev
)
431 return dev
->parent_bus
;
434 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
)
436 assert(dev
->num_gpio_in
== 0);
437 dev
->num_gpio_in
= n
;
438 dev
->gpio_in
= qemu_allocate_irqs(handler
, dev
, n
);
441 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
)
443 assert(dev
->num_gpio_out
== 0);
444 dev
->num_gpio_out
= n
;
445 dev
->gpio_out
= pins
;
448 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
)
450 assert(n
>= 0 && n
< dev
->num_gpio_in
);
451 return dev
->gpio_in
[n
];
454 void qdev_connect_gpio_out(DeviceState
* dev
, int n
, qemu_irq pin
)
456 assert(n
>= 0 && n
< dev
->num_gpio_out
);
457 dev
->gpio_out
[n
] = pin
;
460 void qdev_set_nic_properties(DeviceState
*dev
, NICInfo
*nd
)
462 qdev_prop_set_macaddr(dev
, "mac", nd
->macaddr
);
464 qdev_prop_set_vlan(dev
, "vlan", nd
->vlan
);
466 qdev_prop_set_netdev(dev
, "netdev", nd
->netdev
);
467 if (nd
->nvectors
!= DEV_NVECTORS_UNSPECIFIED
&&
468 qdev_prop_exists(dev
, "vectors")) {
469 qdev_prop_set_uint32(dev
, "vectors", nd
->nvectors
);
471 nd
->instantiated
= 1;
474 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
)
478 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
479 if (strcmp(name
, bus
->name
) == 0) {
486 int qbus_walk_children(BusState
*bus
, qdev_walkerfn
*devfn
,
487 qbus_walkerfn
*busfn
, void *opaque
)
493 err
= busfn(bus
, opaque
);
499 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
500 err
= qdev_walk_children(dev
, devfn
, busfn
, opaque
);
509 int qdev_walk_children(DeviceState
*dev
, qdev_walkerfn
*devfn
,
510 qbus_walkerfn
*busfn
, void *opaque
)
516 err
= devfn(dev
, opaque
);
522 QLIST_FOREACH(bus
, &dev
->child_bus
, sibling
) {
523 err
= qbus_walk_children(bus
, devfn
, busfn
, opaque
);
532 static BusState
*qbus_find_recursive(BusState
*bus
, const char *name
,
536 BusState
*child
, *ret
;
539 if (name
&& (strcmp(bus
->name
, name
) != 0)) {
542 if (info
&& (bus
->info
!= info
)) {
549 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
550 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
551 ret
= qbus_find_recursive(child
, name
, info
);
560 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
)
562 DeviceState
*dev
, *ret
;
565 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
566 if (dev
->id
&& strcmp(dev
->id
, id
) == 0)
568 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
569 ret
= qdev_find_recursive(child
, id
);
578 static void qbus_list_bus(DeviceState
*dev
)
581 const char *sep
= " ";
583 error_printf("child busses at \"%s\":",
584 dev
->id
? dev
->id
: dev
->info
->name
);
585 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
586 error_printf("%s\"%s\"", sep
, child
->name
);
592 static void qbus_list_dev(BusState
*bus
)
595 const char *sep
= " ";
597 error_printf("devices at \"%s\":", bus
->name
);
598 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
599 error_printf("%s\"%s\"", sep
, dev
->info
->name
);
601 error_printf("/\"%s\"", dev
->id
);
607 static BusState
*qbus_find_bus(DeviceState
*dev
, char *elem
)
611 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
612 if (strcmp(child
->name
, elem
) == 0) {
619 static DeviceState
*qbus_find_dev(BusState
*bus
, char *elem
)
624 * try to match in order:
625 * (1) instance id, if present
627 * (3) driver alias, if present
629 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
630 if (dev
->id
&& strcmp(dev
->id
, elem
) == 0) {
634 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
635 if (strcmp(dev
->info
->name
, elem
) == 0) {
639 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
640 if (dev
->info
->alias
&& strcmp(dev
->info
->alias
, elem
) == 0) {
647 static BusState
*qbus_find(const char *path
)
654 /* find start element */
655 if (path
[0] == '/') {
656 bus
= main_system_bus
;
659 if (sscanf(path
, "%127[^/]%n", elem
, &len
) != 1) {
663 bus
= qbus_find_recursive(main_system_bus
, elem
, NULL
);
665 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
672 assert(path
[pos
] == '/' || !path
[pos
]);
673 while (path
[pos
] == '/') {
676 if (path
[pos
] == '\0') {
681 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
686 dev
= qbus_find_dev(bus
, elem
);
688 qerror_report(QERR_DEVICE_NOT_FOUND
, elem
);
689 if (!monitor_cur_is_qmp()) {
695 assert(path
[pos
] == '/' || !path
[pos
]);
696 while (path
[pos
] == '/') {
699 if (path
[pos
] == '\0') {
700 /* last specified element is a device. If it has exactly
701 * one child bus accept it nevertheless */
702 switch (dev
->num_child_bus
) {
704 qerror_report(QERR_DEVICE_NO_BUS
, elem
);
707 return QLIST_FIRST(&dev
->child_bus
);
709 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES
, elem
);
710 if (!monitor_cur_is_qmp()) {
718 if (sscanf(path
+pos
, "%127[^/]%n", elem
, &len
) != 1) {
723 bus
= qbus_find_bus(dev
, elem
);
725 qerror_report(QERR_BUS_NOT_FOUND
, elem
);
726 if (!monitor_cur_is_qmp()) {
734 void qbus_create_inplace(BusState
*bus
, BusInfo
*info
,
735 DeviceState
*parent
, const char *name
)
741 bus
->parent
= parent
;
744 /* use supplied name */
745 bus
->name
= qemu_strdup(name
);
746 } else if (parent
&& parent
->id
) {
747 /* parent device has id -> use it for bus name */
748 len
= strlen(parent
->id
) + 16;
749 buf
= qemu_malloc(len
);
750 snprintf(buf
, len
, "%s.%d", parent
->id
, parent
->num_child_bus
);
753 /* no id -> use lowercase bus type for bus name */
754 len
= strlen(info
->name
) + 16;
755 buf
= qemu_malloc(len
);
756 len
= snprintf(buf
, len
, "%s.%d", info
->name
,
757 parent
? parent
->num_child_bus
: 0);
758 for (i
= 0; i
< len
; i
++)
759 buf
[i
] = qemu_tolower(buf
[i
]);
763 QLIST_INIT(&bus
->children
);
765 QLIST_INSERT_HEAD(&parent
->child_bus
, bus
, sibling
);
766 parent
->num_child_bus
++;
767 } else if (bus
!= main_system_bus
) {
768 /* TODO: once all bus devices are qdevified,
769 only reset handler for main_system_bus should be registered here. */
770 qemu_register_reset(qbus_reset_all_fn
, bus
);
774 BusState
*qbus_create(BusInfo
*info
, DeviceState
*parent
, const char *name
)
778 bus
= qemu_mallocz(info
->size
);
779 bus
->qdev_allocated
= 1;
780 qbus_create_inplace(bus
, info
, parent
, name
);
784 void qbus_free(BusState
*bus
)
788 while ((dev
= QLIST_FIRST(&bus
->children
)) != NULL
) {
792 QLIST_REMOVE(bus
, sibling
);
793 bus
->parent
->num_child_bus
--;
795 assert(bus
!= main_system_bus
); /* main_system_bus is never freed */
796 qemu_unregister_reset(qbus_reset_all_fn
, bus
);
798 qemu_free((void*)bus
->name
);
799 if (bus
->qdev_allocated
) {
804 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
805 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
);
807 static void qdev_print_props(Monitor
*mon
, DeviceState
*dev
, Property
*props
,
808 const char *prefix
, int indent
)
814 while (props
->name
) {
816 * TODO Properties without a print method are just for dirty
817 * hacks. qdev_prop_ptr is the only such PropertyInfo. It's
818 * marked for removal. The test props->info->print should be
819 * removed along with it.
821 if (props
->info
->print
) {
822 props
->info
->print(dev
, props
, buf
, sizeof(buf
));
823 qdev_printf("%s-prop: %s = %s\n", prefix
, props
->name
, buf
);
829 static void qdev_print(Monitor
*mon
, DeviceState
*dev
, int indent
)
832 qdev_printf("dev: %s, id \"%s\"\n", dev
->info
->name
,
833 dev
->id
? dev
->id
: "");
835 if (dev
->num_gpio_in
) {
836 qdev_printf("gpio-in %d\n", dev
->num_gpio_in
);
838 if (dev
->num_gpio_out
) {
839 qdev_printf("gpio-out %d\n", dev
->num_gpio_out
);
841 qdev_print_props(mon
, dev
, dev
->info
->props
, "dev", indent
);
842 qdev_print_props(mon
, dev
, dev
->parent_bus
->info
->props
, "bus", indent
);
843 if (dev
->parent_bus
->info
->print_dev
)
844 dev
->parent_bus
->info
->print_dev(mon
, dev
, indent
);
845 QLIST_FOREACH(child
, &dev
->child_bus
, sibling
) {
846 qbus_print(mon
, child
, indent
);
850 static void qbus_print(Monitor
*mon
, BusState
*bus
, int indent
)
852 struct DeviceState
*dev
;
854 qdev_printf("bus: %s\n", bus
->name
);
856 qdev_printf("type %s\n", bus
->info
->name
);
857 QLIST_FOREACH(dev
, &bus
->children
, sibling
) {
858 qdev_print(mon
, dev
, indent
);
863 void do_info_qtree(Monitor
*mon
)
866 qbus_print(mon
, main_system_bus
, 0);
869 void do_info_qdm(Monitor
*mon
)
873 for (info
= device_info_list
; info
!= NULL
; info
= info
->next
) {
874 qdev_print_devinfo(info
);
878 int do_device_add(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
882 opts
= qemu_opts_from_qdict(qemu_find_opts("device"), qdict
);
886 if (!monitor_cur_is_qmp() && qdev_device_help(opts
)) {
890 if (!qdev_device_add(opts
)) {
897 int do_device_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
)
899 const char *id
= qdict_get_str(qdict
, "id");
902 dev
= qdev_find_recursive(main_system_bus
, id
);
904 qerror_report(QERR_DEVICE_NOT_FOUND
, id
);
907 return qdev_unplug(dev
);
910 static int qdev_get_fw_dev_path_helper(DeviceState
*dev
, char *p
, int size
)
914 if (dev
&& dev
->parent_bus
) {
916 l
= qdev_get_fw_dev_path_helper(dev
->parent_bus
->parent
, p
, size
);
917 if (dev
->parent_bus
->info
->get_fw_dev_path
) {
918 d
= dev
->parent_bus
->info
->get_fw_dev_path(dev
);
919 l
+= snprintf(p
+ l
, size
- l
, "%s", d
);
922 l
+= snprintf(p
+ l
, size
- l
, "%s", dev
->info
->name
);
925 l
+= snprintf(p
+ l
, size
- l
, "/");
930 char* qdev_get_fw_dev_path(DeviceState
*dev
)
935 l
= qdev_get_fw_dev_path_helper(dev
, path
, 128);