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;
35 /* This is a nasty hack to allow passing a NULL bus to qdev_create. */
36 static BusState *main_system_bus;
38 DeviceInfo *device_info_list;
40 static BusState *qbus_find_recursive(BusState *bus, const char *name,
42 static BusState *qbus_find(const char *path);
44 /* Register a new device type. */
45 void qdev_register(DeviceInfo *info)
47 assert(info->size >= sizeof(DeviceState));
50 info->next = device_info_list;
51 device_info_list = info;
54 static DeviceInfo *qdev_find_info(BusInfo *bus_info, const char *name)
58 /* first check device names */
59 for (info = device_info_list; info != NULL; info = info->next) {
60 if (bus_info && info->bus_info != bus_info)
62 if (strcmp(info->name, name) != 0)
67 /* failing that check the aliases */
68 for (info = device_info_list; info != NULL; info = info->next) {
69 if (bus_info && info->bus_info != bus_info)
73 if (strcmp(info->alias, name) != 0)
80 static DeviceState *qdev_create_from_info(BusState *bus, DeviceInfo *info)
84 assert(bus->info == info->bus_info);
85 dev = qemu_mallocz(info->size);
87 dev->parent_bus = bus;
88 qdev_prop_set_defaults(dev, dev->info->props);
89 qdev_prop_set_defaults(dev, dev->parent_bus->info->props);
90 qdev_prop_set_globals(dev);
91 QLIST_INSERT_HEAD(&bus->children, dev, sibling);
93 assert(bus->allow_hotplug);
96 dev->state = DEV_STATE_CREATED;
100 /* Create a new device. This only initializes the device state structure
101 and allows properties to be set. qdev_init should be called to
102 initialize the actual device emulation. */
103 DeviceState *qdev_create(BusState *bus, const char *name)
108 if (!main_system_bus) {
109 main_system_bus = qbus_create(&system_bus_info, NULL, "main-system-bus");
111 bus = main_system_bus;
114 info = qdev_find_info(bus->info, name);
116 hw_error("Unknown device '%s' for bus '%s'\n", name, bus->info->name);
119 return qdev_create_from_info(bus, info);
122 static void qdev_print_devinfo(DeviceInfo *info)
124 error_printf("name \"%s\", bus %s",
125 info->name, info->bus_info->name);
127 error_printf(", alias \"%s\"", info->alias);
130 error_printf(", desc \"%s\"", info->desc);
133 error_printf(", no-user");
138 static int set_property(const char *name, const char *value, void *opaque)
140 DeviceState *dev = opaque;
142 if (strcmp(name, "driver") == 0)
144 if (strcmp(name, "bus") == 0)
147 if (qdev_prop_parse(dev, name, value) == -1) {
153 int qdev_device_help(QemuOpts *opts)
159 driver = qemu_opt_get(opts, "driver");
160 if (driver && !strcmp(driver, "?")) {
161 for (info = device_info_list; info != NULL; info = info->next) {
163 continue; /* not available, don't show */
165 qdev_print_devinfo(info);
170 if (!qemu_opt_get(opts, "?")) {
174 info = qdev_find_info(NULL, driver);
179 for (prop = info->props; prop && prop->name; prop++) {
181 * TODO Properties without a parser are just for dirty hacks.
182 * qdev_prop_ptr is the only such PropertyInfo. It's marked
183 * for removal. This conditional should be removed along with
186 if (!prop->info->parse) {
187 continue; /* no way to set it, don't show */
189 error_printf("%s.%s=%s\n", info->name, prop->name, prop->info->name);
194 DeviceState *qdev_device_add(QemuOpts *opts)
196 const char *driver, *path, *id;
201 driver = qemu_opt_get(opts, "driver");
203 qerror_report(QERR_MISSING_PARAMETER, "driver");
208 info = qdev_find_info(NULL, driver);
209 if (!info || info->no_user) {
210 qerror_report(QERR_INVALID_PARAMETER, "driver");
211 error_printf_unless_qmp("Try with argument '?' for a list.\n");
216 path = qemu_opt_get(opts, "bus");
218 bus = qbus_find(path);
222 if (bus->info != info->bus_info) {
223 qerror_report(QERR_BAD_BUS_FOR_DEVICE,
224 driver, bus->info->name);
228 bus = qbus_find_recursive(main_system_bus, NULL, info->bus_info);
230 qerror_report(QERR_NO_BUS_FOR_DEVICE,
231 info->name, info->bus_info->name);
235 if (qdev_hotplug && !bus->allow_hotplug) {
236 qerror_report(QERR_BUS_NO_HOTPLUG, bus->name);
240 /* create device, set properties */
241 qdev = qdev_create_from_info(bus, info);
242 id = qemu_opts_id(opts);
246 if (qemu_opt_foreach(opts, set_property, qdev, 1) != 0) {
250 if (qdev_init(qdev) < 0) {
251 qerror_report(QERR_DEVICE_INIT_FAILED, driver);
258 static void qdev_reset(void *opaque)
260 DeviceState *dev = opaque;
261 if (dev->info->reset)
262 dev->info->reset(dev);
265 /* Initialize a device. Device properties should be set before calling
266 this function. IRQs and MMIO regions should be connected/mapped after
267 calling this function.
268 On failure, destroy the device and return negative value.
269 Return 0 on success. */
270 int qdev_init(DeviceState *dev)
274 assert(dev->state == DEV_STATE_CREATED);
275 rc = dev->info->init(dev, dev->info);
280 qemu_register_reset(qdev_reset, dev);
282 vmstate_register(-1, dev->info->vmsd, dev);
283 dev->state = DEV_STATE_INITIALIZED;
287 int qdev_unplug(DeviceState *dev)
289 if (!dev->parent_bus->allow_hotplug) {
290 error_report("Bus %s does not support hotplugging",
291 dev->parent_bus->name);
294 assert(dev->info->unplug != NULL);
296 return dev->info->unplug(dev);
299 /* can be used as ->unplug() callback for the simple cases */
300 int qdev_simple_unplug_cb(DeviceState *dev)
307 /* Like qdev_init(), but terminate program via hw_error() instead of
308 returning an error value. This is okay during machine creation.
309 Don't use for hotplug, because there callers need to recover from
310 failure. Exception: if you know the device's init() callback can't
311 fail, then qdev_init_nofail() can't fail either, and is therefore
312 usable even then. But relying on the device implementation that
313 way is somewhat unclean, and best avoided. */
314 void qdev_init_nofail(DeviceState *dev)
316 DeviceInfo *info = dev->info;
318 if (qdev_init(dev) < 0)
319 hw_error("Initialization of device %s failed\n", info->name);
322 /* Unlink device from bus and free the structure. */
323 void qdev_free(DeviceState *dev)
327 if (dev->state == DEV_STATE_INITIALIZED) {
328 while (dev->num_child_bus) {
329 bus = QLIST_FIRST(&dev->child_bus);
333 vmstate_unregister(dev->info->vmsd, dev);
335 dev->info->exit(dev);
337 qemu_opts_del(dev->opts);
339 qemu_unregister_reset(qdev_reset, dev);
340 QLIST_REMOVE(dev, sibling);
344 void qdev_machine_creation_done(void)
347 * ok, initial machine setup is done, starting from now we can
348 * only create hotpluggable devices
353 /* Get a character (serial) device interface. */
354 CharDriverState *qdev_init_chardev(DeviceState *dev)
356 static int next_serial;
358 /* FIXME: This function needs to go away: use chardev properties! */
359 return serial_hds[next_serial++];
362 BusState *qdev_get_parent_bus(DeviceState *dev)
364 return dev->parent_bus;
367 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
369 assert(dev->num_gpio_in == 0);
370 dev->num_gpio_in = n;
371 dev->gpio_in = qemu_allocate_irqs(handler, dev, n);
374 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
376 assert(dev->num_gpio_out == 0);
377 dev->num_gpio_out = n;
378 dev->gpio_out = pins;
381 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
383 assert(n >= 0 && n < dev->num_gpio_in);
384 return dev->gpio_in[n];
387 void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
389 assert(n >= 0 && n < dev->num_gpio_out);
390 dev->gpio_out[n] = pin;
393 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd)
395 qdev_prop_set_macaddr(dev, "mac", nd->macaddr);
397 qdev_prop_set_vlan(dev, "vlan", nd->vlan);
399 qdev_prop_set_netdev(dev, "netdev", nd->netdev);
400 if (nd->nvectors != DEV_NVECTORS_UNSPECIFIED &&
401 qdev_prop_exists(dev, "vectors")) {
402 qdev_prop_set_uint32(dev, "vectors", nd->nvectors);
406 static int next_block_unit[IF_COUNT];
408 /* Get a block device. This should only be used for single-drive devices
409 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
411 BlockDriverState *qdev_init_bdrv(DeviceState *dev, BlockInterfaceType type)
413 int unit = next_block_unit[type]++;
416 dinfo = drive_get(type, 0, unit);
417 return dinfo ? dinfo->bdrv : NULL;
420 BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
424 QLIST_FOREACH(bus, &dev->child_bus, sibling) {
425 if (strcmp(name, bus->name) == 0) {
432 static BusState *qbus_find_recursive(BusState *bus, const char *name,
436 BusState *child, *ret;
439 if (name && (strcmp(bus->name, name) != 0)) {
442 if (info && (bus->info != info)) {
449 QLIST_FOREACH(dev, &bus->children, sibling) {
450 QLIST_FOREACH(child, &dev->child_bus, sibling) {
451 ret = qbus_find_recursive(child, name, info);
460 static DeviceState *qdev_find_recursive(BusState *bus, const char *id)
462 DeviceState *dev, *ret;
465 QLIST_FOREACH(dev, &bus->children, sibling) {
466 if (dev->id && strcmp(dev->id, id) == 0)
468 QLIST_FOREACH(child, &dev->child_bus, sibling) {
469 ret = qdev_find_recursive(child, id);
478 static void qbus_list_bus(DeviceState *dev)
481 const char *sep = " ";
483 error_printf("child busses at \"%s\":",
484 dev->id ? dev->id : dev->info->name);
485 QLIST_FOREACH(child, &dev->child_bus, sibling) {
486 error_printf("%s\"%s\"", sep, child->name);
492 static void qbus_list_dev(BusState *bus)
495 const char *sep = " ";
497 error_printf("devices at \"%s\":", bus->name);
498 QLIST_FOREACH(dev, &bus->children, sibling) {
499 error_printf("%s\"%s\"", sep, dev->info->name);
501 error_printf("/\"%s\"", dev->id);
507 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
511 QLIST_FOREACH(child, &dev->child_bus, sibling) {
512 if (strcmp(child->name, elem) == 0) {
519 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
524 * try to match in order:
525 * (1) instance id, if present
527 * (3) driver alias, if present
529 QLIST_FOREACH(dev, &bus->children, sibling) {
530 if (dev->id && strcmp(dev->id, elem) == 0) {
534 QLIST_FOREACH(dev, &bus->children, sibling) {
535 if (strcmp(dev->info->name, elem) == 0) {
539 QLIST_FOREACH(dev, &bus->children, sibling) {
540 if (dev->info->alias && strcmp(dev->info->alias, elem) == 0) {
547 static BusState *qbus_find(const char *path)
554 /* find start element */
555 if (path[0] == '/') {
556 bus = main_system_bus;
559 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
563 bus = qbus_find_recursive(main_system_bus, elem, NULL);
565 qerror_report(QERR_BUS_NOT_FOUND, elem);
572 assert(path[pos] == '/' || !path[pos]);
573 while (path[pos] == '/') {
576 if (path[pos] == '\0') {
581 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
586 dev = qbus_find_dev(bus, elem);
588 qerror_report(QERR_DEVICE_NOT_FOUND, elem);
589 if (!monitor_cur_is_qmp()) {
595 assert(path[pos] == '/' || !path[pos]);
596 while (path[pos] == '/') {
599 if (path[pos] == '\0') {
600 /* last specified element is a device. If it has exactly
601 * one child bus accept it nevertheless */
602 switch (dev->num_child_bus) {
604 qerror_report(QERR_DEVICE_NO_BUS, elem);
607 return QLIST_FIRST(&dev->child_bus);
609 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES, elem);
610 if (!monitor_cur_is_qmp()) {
618 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
623 bus = qbus_find_bus(dev, elem);
625 qerror_report(QERR_BUS_NOT_FOUND, elem);
626 if (!monitor_cur_is_qmp()) {
634 void qbus_create_inplace(BusState *bus, BusInfo *info,
635 DeviceState *parent, const char *name)
641 bus->parent = parent;
644 /* use supplied name */
645 bus->name = qemu_strdup(name);
646 } else if (parent && parent->id) {
647 /* parent device has id -> use it for bus name */
648 len = strlen(parent->id) + 16;
649 buf = qemu_malloc(len);
650 snprintf(buf, len, "%s.%d", parent->id, parent->num_child_bus);
653 /* no id -> use lowercase bus type for bus name */
654 len = strlen(info->name) + 16;
655 buf = qemu_malloc(len);
656 len = snprintf(buf, len, "%s.%d", info->name,
657 parent ? parent->num_child_bus : 0);
658 for (i = 0; i < len; i++)
659 buf[i] = qemu_tolower(buf[i]);
663 QLIST_INIT(&bus->children);
665 QLIST_INSERT_HEAD(&parent->child_bus, bus, sibling);
666 parent->num_child_bus++;
671 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name)
675 bus = qemu_mallocz(info->size);
676 bus->qdev_allocated = 1;
677 qbus_create_inplace(bus, info, parent, name);
681 void qbus_free(BusState *bus)
685 while ((dev = QLIST_FIRST(&bus->children)) != NULL) {
689 QLIST_REMOVE(bus, sibling);
690 bus->parent->num_child_bus--;
692 if (bus->qdev_allocated) {
697 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
698 static void qbus_print(Monitor *mon, BusState *bus, int indent);
700 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
701 const char *prefix, int indent)
707 while (props->name) {
709 * TODO Properties without a print method are just for dirty
710 * hacks. qdev_prop_ptr is the only such PropertyInfo. It's
711 * marked for removal. The test props->info->print should be
712 * removed along with it.
714 if (props->info->print) {
715 props->info->print(dev, props, buf, sizeof(buf));
716 qdev_printf("%s-prop: %s = %s\n", prefix, props->name, buf);
722 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
725 qdev_printf("dev: %s, id \"%s\"\n", dev->info->name,
726 dev->id ? dev->id : "");
728 if (dev->num_gpio_in) {
729 qdev_printf("gpio-in %d\n", dev->num_gpio_in);
731 if (dev->num_gpio_out) {
732 qdev_printf("gpio-out %d\n", dev->num_gpio_out);
734 qdev_print_props(mon, dev, dev->info->props, "dev", indent);
735 qdev_print_props(mon, dev, dev->parent_bus->info->props, "bus", indent);
736 if (dev->parent_bus->info->print_dev)
737 dev->parent_bus->info->print_dev(mon, dev, indent);
738 QLIST_FOREACH(child, &dev->child_bus, sibling) {
739 qbus_print(mon, child, indent);
743 static void qbus_print(Monitor *mon, BusState *bus, int indent)
745 struct DeviceState *dev;
747 qdev_printf("bus: %s\n", bus->name);
749 qdev_printf("type %s\n", bus->info->name);
750 QLIST_FOREACH(dev, &bus->children, sibling) {
751 qdev_print(mon, dev, indent);
756 void do_info_qtree(Monitor *mon)
759 qbus_print(mon, main_system_bus, 0);
762 void do_info_qdm(Monitor *mon)
766 for (info = device_info_list; info != NULL; info = info->next) {
767 qdev_print_devinfo(info);
772 * do_device_add(): Add a device
774 * Argument qdict contains
775 * - "driver": the name of the new device's driver
776 * - "bus": the device's parent bus (device tree path)
777 * - "id": the device's ID (must be unique)
778 * - device properties
782 * { "driver": "usb-net", "id": "eth1", "netdev": "netdev1" }
784 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
788 opts = qemu_opts_from_qdict(&qemu_device_opts, qdict);
792 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
796 if (!qdev_device_add(opts)) {
803 void do_device_del(Monitor *mon, const QDict *qdict)
805 const char *id = qdict_get_str(qdict, "id");
808 dev = qdev_find_recursive(main_system_bus, id);
810 error_report("Device '%s' not found", id);