qdev hotplug: infrastructure and monitor commands.
[qemu.git] / hw / qdev.c
blobebddcaedbddfb6af7bf7a627aaa8924749049c26
1 /*
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
26 this API directly. */
28 #include "net.h"
29 #include "qdev.h"
30 #include "sysemu.h"
31 #include "monitor.h"
33 /* This is a nasty hack to allow passing a NULL bus to qdev_create. */
34 static int qdev_hotplug = 0;
36 static BusState *main_system_bus;
38 static DeviceInfo *device_info_list;
40 static BusState *qbus_find_recursive(BusState *bus, const char *name,
41 const BusInfo *info);
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));
48 assert(!info->next);
50 info->next = device_info_list;
51 device_info_list = info;
54 static DeviceInfo *qdev_find_info(BusInfo *bus_info, const char *name)
56 DeviceInfo *info;
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)
61 continue;
62 if (strcmp(info->name, name) != 0)
63 continue;
64 return info;
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)
70 continue;
71 if (!info->alias)
72 continue;
73 if (strcmp(info->alias, name) != 0)
74 continue;
75 return info;
77 return NULL;
80 /* Create a new device. This only initializes the device state structure
81 and allows properties to be set. qdev_init should be called to
82 initialize the actual device emulation. */
83 DeviceState *qdev_create(BusState *bus, const char *name)
85 DeviceInfo *info;
86 DeviceState *dev;
88 if (!bus) {
89 if (!main_system_bus) {
90 main_system_bus = qbus_create(&system_bus_info, NULL, "main-system-bus");
92 bus = main_system_bus;
95 info = qdev_find_info(bus->info, name);
96 if (!info) {
97 hw_error("Unknown device '%s' for bus '%s'\n", name, bus->info->name);
100 dev = qemu_mallocz(info->size);
101 dev->info = info;
102 dev->parent_bus = bus;
103 qdev_prop_set_defaults(dev, dev->info->props);
104 qdev_prop_set_defaults(dev, dev->parent_bus->info->props);
105 qdev_prop_set_compat(dev);
106 QLIST_INSERT_HEAD(&bus->children, dev, sibling);
107 if (qdev_hotplug) {
108 assert(bus->allow_hotplug);
109 dev->hotplugged = 1;
111 dev->state = DEV_STATE_CREATED;
112 return dev;
115 static int qdev_print_devinfo(DeviceInfo *info, char *dest, int len)
117 int pos = 0;
118 int ret;
120 ret = snprintf(dest+pos, len-pos, "name \"%s\", bus %s",
121 info->name, info->bus_info->name);
122 pos += MIN(len-pos,ret);
123 if (info->alias) {
124 ret = snprintf(dest+pos, len-pos, ", alias \"%s\"", info->alias);
125 pos += MIN(len-pos,ret);
127 if (info->desc) {
128 ret = snprintf(dest+pos, len-pos, ", desc \"%s\"", info->desc);
129 pos += MIN(len-pos,ret);
131 if (info->no_user) {
132 ret = snprintf(dest+pos, len-pos, ", no-user");
133 pos += MIN(len-pos,ret);
135 return pos;
138 static int set_property(const char *name, const char *value, void *opaque)
140 DeviceState *dev = opaque;
142 if (strcmp(name, "driver") == 0)
143 return 0;
144 if (strcmp(name, "bus") == 0)
145 return 0;
147 if (qdev_prop_parse(dev, name, value) == -1) {
148 qemu_error("can't set property \"%s\" to \"%s\" for \"%s\"\n",
149 name, value, dev->info->name);
150 return -1;
152 return 0;
155 DeviceState *qdev_device_add(QemuOpts *opts)
157 const char *driver, *path, *id;
158 DeviceInfo *info;
159 DeviceState *qdev;
160 BusState *bus;
162 driver = qemu_opt_get(opts, "driver");
163 if (!driver) {
164 qemu_error("-device: no driver specified\n");
165 return NULL;
167 if (strcmp(driver, "?") == 0) {
168 char msg[256];
169 for (info = device_info_list; info != NULL; info = info->next) {
170 qdev_print_devinfo(info, msg, sizeof(msg));
171 qemu_error("%s\n", msg);
173 return NULL;
176 /* find driver */
177 info = qdev_find_info(NULL, driver);
178 if (!info) {
179 qemu_error("Device \"%s\" not found. Try -device '?' for a list.\n",
180 driver);
181 return NULL;
183 if (info->no_user) {
184 qemu_error("device \"%s\" can't be added via command line\n",
185 info->name);
186 return NULL;
189 /* find bus */
190 path = qemu_opt_get(opts, "bus");
191 if (path != NULL) {
192 bus = qbus_find(path);
193 } else {
194 bus = qbus_find_recursive(main_system_bus, NULL, info->bus_info);
196 if (!bus) {
197 qemu_error("Did not find %s bus for %s\n",
198 path ? path : info->bus_info->name, info->name);
199 return NULL;
201 if (qdev_hotplug && !bus->allow_hotplug) {
202 qemu_error("Bus %s does not support hotplugging\n",
203 bus->name);
204 return NULL;
207 /* create device, set properties */
208 qdev = qdev_create(bus, driver);
209 id = qemu_opts_id(opts);
210 if (id) {
211 qdev->id = id;
213 if (qemu_opt_foreach(opts, set_property, qdev, 1) != 0) {
214 qdev_free(qdev);
215 return NULL;
217 if (qdev_init(qdev) != 0) {
218 qdev_free(qdev);
219 return NULL;
221 return qdev;
224 /* Initialize a device. Device properties should be set before calling
225 this function. IRQs and MMIO regions should be connected/mapped after
226 calling this function. */
227 int qdev_init(DeviceState *dev)
229 int rc;
231 assert(dev->state == DEV_STATE_CREATED);
232 rc = dev->info->init(dev, dev->info);
233 if (rc < 0)
234 return rc;
235 if (dev->info->reset)
236 qemu_register_reset(dev->info->reset, dev);
237 if (dev->info->vmsd)
238 vmstate_register(-1, dev->info->vmsd, dev);
239 dev->state = DEV_STATE_INITIALIZED;
240 return 0;
243 int qdev_unplug(DeviceState *dev)
245 if (!dev->parent_bus->allow_hotplug) {
246 qemu_error("Bus %s does not support hotplugging\n",
247 dev->parent_bus->name);
248 return -1;
250 return dev->info->unplug(dev);
253 /* can be used as ->unplug() callback for the simple cases */
254 int qdev_simple_unplug_cb(DeviceState *dev)
256 /* just zap it */
257 qdev_free(dev);
258 return 0;
261 /* Unlink device from bus and free the structure. */
262 void qdev_free(DeviceState *dev)
264 BusState *bus;
266 if (dev->state == DEV_STATE_INITIALIZED) {
267 while (dev->num_child_bus) {
268 bus = QLIST_FIRST(&dev->child_bus);
269 qbus_free(bus);
271 #if 0 /* FIXME: need sane vmstate_unregister function */
272 if (dev->info->vmsd)
273 vmstate_unregister(dev->info->vmsd, dev);
274 #endif
275 if (dev->info->reset)
276 qemu_unregister_reset(dev->info->reset, dev);
277 if (dev->info->exit)
278 dev->info->exit(dev);
280 QLIST_REMOVE(dev, sibling);
281 qemu_free(dev);
284 void qdev_machine_creation_done(void)
287 * ok, initial machine setup is done, starting from now we can
288 * only create hotpluggable devices
290 qdev_hotplug = 1;
293 /* Get a character (serial) device interface. */
294 CharDriverState *qdev_init_chardev(DeviceState *dev)
296 static int next_serial;
297 static int next_virtconsole;
298 /* FIXME: This is a nasty hack that needs to go away. */
299 if (strncmp(dev->info->name, "virtio", 6) == 0) {
300 return virtcon_hds[next_virtconsole++];
301 } else {
302 return serial_hds[next_serial++];
306 BusState *qdev_get_parent_bus(DeviceState *dev)
308 return dev->parent_bus;
311 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
313 assert(dev->num_gpio_in == 0);
314 dev->num_gpio_in = n;
315 dev->gpio_in = qemu_allocate_irqs(handler, dev, n);
318 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
320 assert(dev->num_gpio_out == 0);
321 dev->num_gpio_out = n;
322 dev->gpio_out = pins;
325 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
327 assert(n >= 0 && n < dev->num_gpio_in);
328 return dev->gpio_in[n];
331 void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
333 assert(n >= 0 && n < dev->num_gpio_out);
334 dev->gpio_out[n] = pin;
337 VLANClientState *qdev_get_vlan_client(DeviceState *dev,
338 NetCanReceive *can_receive,
339 NetReceive *receive,
340 NetReceiveIOV *receive_iov,
341 NetCleanup *cleanup,
342 void *opaque)
344 NICInfo *nd = dev->nd;
345 assert(nd);
346 nd->vc = qemu_new_vlan_client(nd->vlan, nd->model, nd->name, can_receive,
347 receive, receive_iov, cleanup, opaque);
348 return nd->vc;
352 void qdev_get_macaddr(DeviceState *dev, uint8_t *macaddr)
354 memcpy(macaddr, dev->nd->macaddr, 6);
357 static int next_block_unit[IF_COUNT];
359 /* Get a block device. This should only be used for single-drive devices
360 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
361 appropriate bus. */
362 BlockDriverState *qdev_init_bdrv(DeviceState *dev, BlockInterfaceType type)
364 int unit = next_block_unit[type]++;
365 DriveInfo *dinfo;
367 dinfo = drive_get(type, 0, unit);
368 return dinfo ? dinfo->bdrv : NULL;
371 BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
373 BusState *bus;
375 QLIST_FOREACH(bus, &dev->child_bus, sibling) {
376 if (strcmp(name, bus->name) == 0) {
377 return bus;
380 return NULL;
383 static BusState *qbus_find_recursive(BusState *bus, const char *name,
384 const BusInfo *info)
386 DeviceState *dev;
387 BusState *child, *ret;
388 int match = 1;
390 if (name && (strcmp(bus->name, name) != 0)) {
391 match = 0;
393 if (info && (bus->info != info)) {
394 match = 0;
396 if (match) {
397 return bus;
400 QLIST_FOREACH(dev, &bus->children, sibling) {
401 QLIST_FOREACH(child, &dev->child_bus, sibling) {
402 ret = qbus_find_recursive(child, name, info);
403 if (ret) {
404 return ret;
408 return NULL;
411 static DeviceState *qdev_find_recursive(BusState *bus, const char *id)
413 DeviceState *dev, *ret;
414 BusState *child;
416 QLIST_FOREACH(dev, &bus->children, sibling) {
417 if (dev->id && strcmp(dev->id, id) == 0)
418 return dev;
419 QLIST_FOREACH(child, &dev->child_bus, sibling) {
420 ret = qdev_find_recursive(child, id);
421 if (ret) {
422 return ret;
426 return NULL;
429 static void qbus_list_bus(DeviceState *dev, char *dest, int len)
431 BusState *child;
432 const char *sep = " ";
433 int pos = 0;
435 pos += snprintf(dest+pos, len-pos,"child busses at \"%s\":",
436 dev->id ? dev->id : dev->info->name);
437 QLIST_FOREACH(child, &dev->child_bus, sibling) {
438 pos += snprintf(dest+pos, len-pos, "%s\"%s\"", sep, child->name);
439 sep = ", ";
443 static void qbus_list_dev(BusState *bus, char *dest, int len)
445 DeviceState *dev;
446 const char *sep = " ";
447 int pos = 0;
449 pos += snprintf(dest+pos, len-pos, "devices at \"%s\":",
450 bus->name);
451 QLIST_FOREACH(dev, &bus->children, sibling) {
452 pos += snprintf(dest+pos, len-pos, "%s\"%s\"",
453 sep, dev->info->name);
454 if (dev->id)
455 pos += snprintf(dest+pos, len-pos, "/\"%s\"", dev->id);
456 sep = ", ";
460 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
462 BusState *child;
464 QLIST_FOREACH(child, &dev->child_bus, sibling) {
465 if (strcmp(child->name, elem) == 0) {
466 return child;
469 return NULL;
472 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
474 DeviceState *dev;
477 * try to match in order:
478 * (1) instance id, if present
479 * (2) driver name
480 * (3) driver alias, if present
482 QLIST_FOREACH(dev, &bus->children, sibling) {
483 if (dev->id && strcmp(dev->id, elem) == 0) {
484 return dev;
487 QLIST_FOREACH(dev, &bus->children, sibling) {
488 if (strcmp(dev->info->name, elem) == 0) {
489 return dev;
492 QLIST_FOREACH(dev, &bus->children, sibling) {
493 if (dev->info->alias && strcmp(dev->info->alias, elem) == 0) {
494 return dev;
497 return NULL;
500 static BusState *qbus_find(const char *path)
502 DeviceState *dev;
503 BusState *bus;
504 char elem[128], msg[256];
505 int pos, len;
507 /* find start element */
508 if (path[0] == '/') {
509 bus = main_system_bus;
510 pos = 0;
511 } else {
512 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
513 qemu_error("path parse error (\"%s\")\n", path);
514 return NULL;
516 bus = qbus_find_recursive(main_system_bus, elem, NULL);
517 if (!bus) {
518 qemu_error("bus \"%s\" not found\n", elem);
519 return NULL;
521 pos = len;
524 for (;;) {
525 if (path[pos] == '\0') {
526 /* we are done */
527 return bus;
530 /* find device */
531 if (sscanf(path+pos, "/%127[^/]%n", elem, &len) != 1) {
532 qemu_error("path parse error (\"%s\" pos %d)\n", path, pos);
533 return NULL;
535 pos += len;
536 dev = qbus_find_dev(bus, elem);
537 if (!dev) {
538 qbus_list_dev(bus, msg, sizeof(msg));
539 qemu_error("device \"%s\" not found\n%s\n", elem, msg);
540 return NULL;
542 if (path[pos] == '\0') {
543 /* last specified element is a device. If it has exactly
544 * one child bus accept it nevertheless */
545 switch (dev->num_child_bus) {
546 case 0:
547 qemu_error("device has no child bus (%s)\n", path);
548 return NULL;
549 case 1:
550 return QLIST_FIRST(&dev->child_bus);
551 default:
552 qbus_list_bus(dev, msg, sizeof(msg));
553 qemu_error("device has multiple child busses (%s)\n%s\n",
554 path, msg);
555 return NULL;
559 /* find bus */
560 if (sscanf(path+pos, "/%127[^/]%n", elem, &len) != 1) {
561 qemu_error("path parse error (\"%s\" pos %d)\n", path, pos);
562 return NULL;
564 pos += len;
565 bus = qbus_find_bus(dev, elem);
566 if (!bus) {
567 qbus_list_bus(dev, msg, sizeof(msg));
568 qemu_error("child bus \"%s\" not found\n%s\n", elem, msg);
569 return NULL;
574 void qbus_create_inplace(BusState *bus, BusInfo *info,
575 DeviceState *parent, const char *name)
577 char *buf;
578 int i,len;
580 bus->info = info;
581 bus->parent = parent;
583 if (name) {
584 /* use supplied name */
585 bus->name = qemu_strdup(name);
586 } else if (parent && parent->id) {
587 /* parent device has id -> use it for bus name */
588 len = strlen(parent->id) + 16;
589 buf = qemu_malloc(len);
590 snprintf(buf, len, "%s.%d", parent->id, parent->num_child_bus);
591 bus->name = buf;
592 } else {
593 /* no id -> use lowercase bus type for bus name */
594 len = strlen(info->name) + 16;
595 buf = qemu_malloc(len);
596 len = snprintf(buf, len, "%s.%d", info->name,
597 parent ? parent->num_child_bus : 0);
598 for (i = 0; i < len; i++)
599 buf[i] = qemu_tolower(buf[i]);
600 bus->name = buf;
603 QLIST_INIT(&bus->children);
604 if (parent) {
605 QLIST_INSERT_HEAD(&parent->child_bus, bus, sibling);
606 parent->num_child_bus++;
611 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name)
613 BusState *bus;
615 bus = qemu_mallocz(info->size);
616 bus->qdev_allocated = 1;
617 qbus_create_inplace(bus, info, parent, name);
618 return bus;
621 void qbus_free(BusState *bus)
623 DeviceState *dev;
625 while ((dev = QLIST_FIRST(&bus->children)) != NULL) {
626 qdev_free(dev);
628 if (bus->parent) {
629 QLIST_REMOVE(bus, sibling);
630 bus->parent->num_child_bus--;
632 if (bus->qdev_allocated) {
633 qemu_free(bus);
637 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
638 static void qbus_print(Monitor *mon, BusState *bus, int indent);
640 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
641 const char *prefix, int indent)
643 char buf[64];
645 if (!props)
646 return;
647 while (props->name) {
648 if (props->info->print) {
649 props->info->print(dev, props, buf, sizeof(buf));
650 qdev_printf("%s-prop: %s = %s\n", prefix, props->name, buf);
652 props++;
656 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
658 BusState *child;
659 qdev_printf("dev: %s, id \"%s\"\n", dev->info->name,
660 dev->id ? dev->id : "");
661 indent += 2;
662 if (dev->num_gpio_in) {
663 qdev_printf("gpio-in %d\n", dev->num_gpio_in);
665 if (dev->num_gpio_out) {
666 qdev_printf("gpio-out %d\n", dev->num_gpio_out);
668 qdev_print_props(mon, dev, dev->info->props, "dev", indent);
669 qdev_print_props(mon, dev, dev->parent_bus->info->props, "bus", indent);
670 if (dev->parent_bus->info->print_dev)
671 dev->parent_bus->info->print_dev(mon, dev, indent);
672 QLIST_FOREACH(child, &dev->child_bus, sibling) {
673 qbus_print(mon, child, indent);
677 static void qbus_print(Monitor *mon, BusState *bus, int indent)
679 struct DeviceState *dev;
681 qdev_printf("bus: %s\n", bus->name);
682 indent += 2;
683 qdev_printf("type %s\n", bus->info->name);
684 QLIST_FOREACH(dev, &bus->children, sibling) {
685 qdev_print(mon, dev, indent);
688 #undef qdev_printf
690 void do_info_qtree(Monitor *mon)
692 if (main_system_bus)
693 qbus_print(mon, main_system_bus, 0);
696 void do_info_qdm(Monitor *mon)
698 DeviceInfo *info;
699 char msg[256];
701 for (info = device_info_list; info != NULL; info = info->next) {
702 qdev_print_devinfo(info, msg, sizeof(msg));
703 monitor_printf(mon, "%s\n", msg);
707 void do_device_add(Monitor *mon, const QDict *qdict)
709 QemuOpts *opts;
711 opts = qemu_opts_parse(&qemu_device_opts,
712 qdict_get_str(qdict, "config"), "driver");
713 if (opts)
714 qdev_device_add(opts);
717 void do_device_del(Monitor *mon, const QDict *qdict)
719 const char *id = qdict_get_str(qdict, "id");
720 DeviceState *dev;
722 dev = qdev_find_recursive(main_system_bus, id);
723 if (NULL == dev) {
724 qemu_error("Device '%s' not found\n", id);
725 return;
727 qdev_unplug(dev);