mips-dis: Add missing static attributes
[qemu.git] / hw / qdev.c
blobd3bf0fa43dc41d392de4ee27ce8ea521b298dab9
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 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,
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 static DeviceState *qdev_create_from_info(BusState *bus, DeviceInfo *info)
82 DeviceState *dev;
84 assert(bus->info == info->bus_info);
85 dev = qemu_mallocz(info->size);
86 dev->info = info;
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);
92 if (qdev_hotplug) {
93 assert(bus->allow_hotplug);
94 dev->hotplugged = 1;
96 dev->state = DEV_STATE_CREATED;
97 return dev;
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)
105 DeviceInfo *info;
107 if (!bus) {
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);
115 if (!info) {
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);
126 if (info->alias) {
127 error_printf(", alias \"%s\"", info->alias);
129 if (info->desc) {
130 error_printf(", desc \"%s\"", info->desc);
132 if (info->no_user) {
133 error_printf(", no-user");
135 error_printf("\n");
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 return -1;
150 return 0;
153 int qdev_device_help(QemuOpts *opts)
155 const char *driver;
156 DeviceInfo *info;
157 Property *prop;
159 driver = qemu_opt_get(opts, "driver");
160 if (driver && !strcmp(driver, "?")) {
161 for (info = device_info_list; info != NULL; info = info->next) {
162 if (info->no_user) {
163 continue; /* not available, don't show */
165 qdev_print_devinfo(info);
167 return 1;
170 if (!qemu_opt_get(opts, "?")) {
171 return 0;
174 info = qdev_find_info(NULL, driver);
175 if (!info) {
176 return 0;
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
184 * it.
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);
191 return 1;
194 DeviceState *qdev_device_add(QemuOpts *opts)
196 const char *driver, *path, *id;
197 DeviceInfo *info;
198 DeviceState *qdev;
199 BusState *bus;
201 driver = qemu_opt_get(opts, "driver");
202 if (!driver) {
203 qerror_report(QERR_MISSING_PARAMETER, "driver");
204 return NULL;
207 /* find driver */
208 info = qdev_find_info(NULL, driver);
209 if (!info || info->no_user) {
210 qerror_report(QERR_INVALID_PARAMETER_VALUE, "driver", "a driver name");
211 error_printf_unless_qmp("Try with argument '?' for a list.\n");
212 return NULL;
215 /* find bus */
216 path = qemu_opt_get(opts, "bus");
217 if (path != NULL) {
218 bus = qbus_find(path);
219 if (!bus) {
220 return NULL;
222 if (bus->info != info->bus_info) {
223 qerror_report(QERR_BAD_BUS_FOR_DEVICE,
224 driver, bus->info->name);
225 return NULL;
227 } else {
228 bus = qbus_find_recursive(main_system_bus, NULL, info->bus_info);
229 if (!bus) {
230 qerror_report(QERR_NO_BUS_FOR_DEVICE,
231 info->name, info->bus_info->name);
232 return NULL;
235 if (qdev_hotplug && !bus->allow_hotplug) {
236 qerror_report(QERR_BUS_NO_HOTPLUG, bus->name);
237 return NULL;
240 /* create device, set properties */
241 qdev = qdev_create_from_info(bus, info);
242 id = qemu_opts_id(opts);
243 if (id) {
244 qdev->id = id;
246 if (qemu_opt_foreach(opts, set_property, qdev, 1) != 0) {
247 qdev_free(qdev);
248 return NULL;
250 if (qdev_init(qdev) < 0) {
251 qerror_report(QERR_DEVICE_INIT_FAILED, driver);
252 return NULL;
254 qdev->opts = opts;
255 return qdev;
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)
272 int rc;
274 assert(dev->state == DEV_STATE_CREATED);
275 rc = dev->info->init(dev, dev->info);
276 if (rc < 0) {
277 qdev_free(dev);
278 return rc;
280 qemu_register_reset(qdev_reset, dev);
281 if (dev->info->vmsd)
282 vmstate_register(-1, dev->info->vmsd, dev);
283 dev->state = DEV_STATE_INITIALIZED;
284 return 0;
287 int qdev_unplug(DeviceState *dev)
289 if (!dev->parent_bus->allow_hotplug) {
290 qerror_report(QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
291 return -1;
293 assert(dev->info->unplug != NULL);
295 return dev->info->unplug(dev);
298 /* can be used as ->unplug() callback for the simple cases */
299 int qdev_simple_unplug_cb(DeviceState *dev)
301 /* just zap it */
302 qdev_free(dev);
303 return 0;
306 /* Like qdev_init(), but terminate program via hw_error() instead of
307 returning an error value. This is okay during machine creation.
308 Don't use for hotplug, because there callers need to recover from
309 failure. Exception: if you know the device's init() callback can't
310 fail, then qdev_init_nofail() can't fail either, and is therefore
311 usable even then. But relying on the device implementation that
312 way is somewhat unclean, and best avoided. */
313 void qdev_init_nofail(DeviceState *dev)
315 DeviceInfo *info = dev->info;
317 if (qdev_init(dev) < 0)
318 hw_error("Initialization of device %s failed\n", info->name);
321 /* Unlink device from bus and free the structure. */
322 void qdev_free(DeviceState *dev)
324 BusState *bus;
326 if (dev->state == DEV_STATE_INITIALIZED) {
327 while (dev->num_child_bus) {
328 bus = QLIST_FIRST(&dev->child_bus);
329 qbus_free(bus);
331 if (dev->info->vmsd)
332 vmstate_unregister(dev->info->vmsd, dev);
333 if (dev->info->exit)
334 dev->info->exit(dev);
335 if (dev->opts)
336 qemu_opts_del(dev->opts);
338 qemu_unregister_reset(qdev_reset, dev);
339 QLIST_REMOVE(dev, sibling);
340 qemu_free(dev);
343 void qdev_machine_creation_done(void)
346 * ok, initial machine setup is done, starting from now we can
347 * only create hotpluggable devices
349 qdev_hotplug = 1;
352 /* Get a character (serial) device interface. */
353 CharDriverState *qdev_init_chardev(DeviceState *dev)
355 static int next_serial;
357 /* FIXME: This function needs to go away: use chardev properties! */
358 return serial_hds[next_serial++];
361 BusState *qdev_get_parent_bus(DeviceState *dev)
363 return dev->parent_bus;
366 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
368 assert(dev->num_gpio_in == 0);
369 dev->num_gpio_in = n;
370 dev->gpio_in = qemu_allocate_irqs(handler, dev, n);
373 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
375 assert(dev->num_gpio_out == 0);
376 dev->num_gpio_out = n;
377 dev->gpio_out = pins;
380 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
382 assert(n >= 0 && n < dev->num_gpio_in);
383 return dev->gpio_in[n];
386 void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
388 assert(n >= 0 && n < dev->num_gpio_out);
389 dev->gpio_out[n] = pin;
392 void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd)
394 qdev_prop_set_macaddr(dev, "mac", nd->macaddr);
395 if (nd->vlan)
396 qdev_prop_set_vlan(dev, "vlan", nd->vlan);
397 if (nd->netdev)
398 qdev_prop_set_netdev(dev, "netdev", nd->netdev);
399 if (nd->nvectors != DEV_NVECTORS_UNSPECIFIED &&
400 qdev_prop_exists(dev, "vectors")) {
401 qdev_prop_set_uint32(dev, "vectors", nd->nvectors);
405 static int next_block_unit[IF_COUNT];
407 /* Get a block device. This should only be used for single-drive devices
408 (e.g. SD/Floppy/MTD). Multi-disk devices (scsi/ide) should use the
409 appropriate bus. */
410 BlockDriverState *qdev_init_bdrv(DeviceState *dev, BlockInterfaceType type)
412 int unit = next_block_unit[type]++;
413 DriveInfo *dinfo;
415 dinfo = drive_get(type, 0, unit);
416 return dinfo ? dinfo->bdrv : NULL;
419 BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
421 BusState *bus;
423 QLIST_FOREACH(bus, &dev->child_bus, sibling) {
424 if (strcmp(name, bus->name) == 0) {
425 return bus;
428 return NULL;
431 static BusState *qbus_find_recursive(BusState *bus, const char *name,
432 const BusInfo *info)
434 DeviceState *dev;
435 BusState *child, *ret;
436 int match = 1;
438 if (name && (strcmp(bus->name, name) != 0)) {
439 match = 0;
441 if (info && (bus->info != info)) {
442 match = 0;
444 if (match) {
445 return bus;
448 QLIST_FOREACH(dev, &bus->children, sibling) {
449 QLIST_FOREACH(child, &dev->child_bus, sibling) {
450 ret = qbus_find_recursive(child, name, info);
451 if (ret) {
452 return ret;
456 return NULL;
459 static DeviceState *qdev_find_recursive(BusState *bus, const char *id)
461 DeviceState *dev, *ret;
462 BusState *child;
464 QLIST_FOREACH(dev, &bus->children, sibling) {
465 if (dev->id && strcmp(dev->id, id) == 0)
466 return dev;
467 QLIST_FOREACH(child, &dev->child_bus, sibling) {
468 ret = qdev_find_recursive(child, id);
469 if (ret) {
470 return ret;
474 return NULL;
477 static void qbus_list_bus(DeviceState *dev)
479 BusState *child;
480 const char *sep = " ";
482 error_printf("child busses at \"%s\":",
483 dev->id ? dev->id : dev->info->name);
484 QLIST_FOREACH(child, &dev->child_bus, sibling) {
485 error_printf("%s\"%s\"", sep, child->name);
486 sep = ", ";
488 error_printf("\n");
491 static void qbus_list_dev(BusState *bus)
493 DeviceState *dev;
494 const char *sep = " ";
496 error_printf("devices at \"%s\":", bus->name);
497 QLIST_FOREACH(dev, &bus->children, sibling) {
498 error_printf("%s\"%s\"", sep, dev->info->name);
499 if (dev->id)
500 error_printf("/\"%s\"", dev->id);
501 sep = ", ";
503 error_printf("\n");
506 static BusState *qbus_find_bus(DeviceState *dev, char *elem)
508 BusState *child;
510 QLIST_FOREACH(child, &dev->child_bus, sibling) {
511 if (strcmp(child->name, elem) == 0) {
512 return child;
515 return NULL;
518 static DeviceState *qbus_find_dev(BusState *bus, char *elem)
520 DeviceState *dev;
523 * try to match in order:
524 * (1) instance id, if present
525 * (2) driver name
526 * (3) driver alias, if present
528 QLIST_FOREACH(dev, &bus->children, sibling) {
529 if (dev->id && strcmp(dev->id, elem) == 0) {
530 return dev;
533 QLIST_FOREACH(dev, &bus->children, sibling) {
534 if (strcmp(dev->info->name, elem) == 0) {
535 return dev;
538 QLIST_FOREACH(dev, &bus->children, sibling) {
539 if (dev->info->alias && strcmp(dev->info->alias, elem) == 0) {
540 return dev;
543 return NULL;
546 static BusState *qbus_find(const char *path)
548 DeviceState *dev;
549 BusState *bus;
550 char elem[128];
551 int pos, len;
553 /* find start element */
554 if (path[0] == '/') {
555 bus = main_system_bus;
556 pos = 0;
557 } else {
558 if (sscanf(path, "%127[^/]%n", elem, &len) != 1) {
559 assert(!path[0]);
560 elem[0] = len = 0;
562 bus = qbus_find_recursive(main_system_bus, elem, NULL);
563 if (!bus) {
564 qerror_report(QERR_BUS_NOT_FOUND, elem);
565 return NULL;
567 pos = len;
570 for (;;) {
571 assert(path[pos] == '/' || !path[pos]);
572 while (path[pos] == '/') {
573 pos++;
575 if (path[pos] == '\0') {
576 return bus;
579 /* find device */
580 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
581 assert(0);
582 elem[0] = len = 0;
584 pos += len;
585 dev = qbus_find_dev(bus, elem);
586 if (!dev) {
587 qerror_report(QERR_DEVICE_NOT_FOUND, elem);
588 if (!monitor_cur_is_qmp()) {
589 qbus_list_dev(bus);
591 return NULL;
594 assert(path[pos] == '/' || !path[pos]);
595 while (path[pos] == '/') {
596 pos++;
598 if (path[pos] == '\0') {
599 /* last specified element is a device. If it has exactly
600 * one child bus accept it nevertheless */
601 switch (dev->num_child_bus) {
602 case 0:
603 qerror_report(QERR_DEVICE_NO_BUS, elem);
604 return NULL;
605 case 1:
606 return QLIST_FIRST(&dev->child_bus);
607 default:
608 qerror_report(QERR_DEVICE_MULTIPLE_BUSSES, elem);
609 if (!monitor_cur_is_qmp()) {
610 qbus_list_bus(dev);
612 return NULL;
616 /* find bus */
617 if (sscanf(path+pos, "%127[^/]%n", elem, &len) != 1) {
618 assert(0);
619 elem[0] = len = 0;
621 pos += len;
622 bus = qbus_find_bus(dev, elem);
623 if (!bus) {
624 qerror_report(QERR_BUS_NOT_FOUND, elem);
625 if (!monitor_cur_is_qmp()) {
626 qbus_list_bus(dev);
628 return NULL;
633 void qbus_create_inplace(BusState *bus, BusInfo *info,
634 DeviceState *parent, const char *name)
636 char *buf;
637 int i,len;
639 bus->info = info;
640 bus->parent = parent;
642 if (name) {
643 /* use supplied name */
644 bus->name = qemu_strdup(name);
645 } else if (parent && parent->id) {
646 /* parent device has id -> use it for bus name */
647 len = strlen(parent->id) + 16;
648 buf = qemu_malloc(len);
649 snprintf(buf, len, "%s.%d", parent->id, parent->num_child_bus);
650 bus->name = buf;
651 } else {
652 /* no id -> use lowercase bus type for bus name */
653 len = strlen(info->name) + 16;
654 buf = qemu_malloc(len);
655 len = snprintf(buf, len, "%s.%d", info->name,
656 parent ? parent->num_child_bus : 0);
657 for (i = 0; i < len; i++)
658 buf[i] = qemu_tolower(buf[i]);
659 bus->name = buf;
662 QLIST_INIT(&bus->children);
663 if (parent) {
664 QLIST_INSERT_HEAD(&parent->child_bus, bus, sibling);
665 parent->num_child_bus++;
670 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name)
672 BusState *bus;
674 bus = qemu_mallocz(info->size);
675 bus->qdev_allocated = 1;
676 qbus_create_inplace(bus, info, parent, name);
677 return bus;
680 void qbus_free(BusState *bus)
682 DeviceState *dev;
684 while ((dev = QLIST_FIRST(&bus->children)) != NULL) {
685 qdev_free(dev);
687 if (bus->parent) {
688 QLIST_REMOVE(bus, sibling);
689 bus->parent->num_child_bus--;
691 if (bus->qdev_allocated) {
692 qemu_free(bus);
696 #define qdev_printf(fmt, ...) monitor_printf(mon, "%*s" fmt, indent, "", ## __VA_ARGS__)
697 static void qbus_print(Monitor *mon, BusState *bus, int indent);
699 static void qdev_print_props(Monitor *mon, DeviceState *dev, Property *props,
700 const char *prefix, int indent)
702 char buf[64];
704 if (!props)
705 return;
706 while (props->name) {
708 * TODO Properties without a print method are just for dirty
709 * hacks. qdev_prop_ptr is the only such PropertyInfo. It's
710 * marked for removal. The test props->info->print should be
711 * removed along with it.
713 if (props->info->print) {
714 props->info->print(dev, props, buf, sizeof(buf));
715 qdev_printf("%s-prop: %s = %s\n", prefix, props->name, buf);
717 props++;
721 static void qdev_print(Monitor *mon, DeviceState *dev, int indent)
723 BusState *child;
724 qdev_printf("dev: %s, id \"%s\"\n", dev->info->name,
725 dev->id ? dev->id : "");
726 indent += 2;
727 if (dev->num_gpio_in) {
728 qdev_printf("gpio-in %d\n", dev->num_gpio_in);
730 if (dev->num_gpio_out) {
731 qdev_printf("gpio-out %d\n", dev->num_gpio_out);
733 qdev_print_props(mon, dev, dev->info->props, "dev", indent);
734 qdev_print_props(mon, dev, dev->parent_bus->info->props, "bus", indent);
735 if (dev->parent_bus->info->print_dev)
736 dev->parent_bus->info->print_dev(mon, dev, indent);
737 QLIST_FOREACH(child, &dev->child_bus, sibling) {
738 qbus_print(mon, child, indent);
742 static void qbus_print(Monitor *mon, BusState *bus, int indent)
744 struct DeviceState *dev;
746 qdev_printf("bus: %s\n", bus->name);
747 indent += 2;
748 qdev_printf("type %s\n", bus->info->name);
749 QLIST_FOREACH(dev, &bus->children, sibling) {
750 qdev_print(mon, dev, indent);
753 #undef qdev_printf
755 void do_info_qtree(Monitor *mon)
757 if (main_system_bus)
758 qbus_print(mon, main_system_bus, 0);
761 void do_info_qdm(Monitor *mon)
763 DeviceInfo *info;
765 for (info = device_info_list; info != NULL; info = info->next) {
766 qdev_print_devinfo(info);
771 * do_device_add(): Add a device
773 * Argument qdict contains
774 * - "driver": the name of the new device's driver
775 * - "bus": the device's parent bus (device tree path)
776 * - "id": the device's ID (must be unique)
777 * - device properties
779 * Example:
781 * { "driver": "usb-net", "id": "eth1", "netdev": "netdev1" }
783 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data)
785 QemuOpts *opts;
787 opts = qemu_opts_from_qdict(&qemu_device_opts, qdict);
788 if (!opts) {
789 return -1;
791 if (!monitor_cur_is_qmp() && qdev_device_help(opts)) {
792 qemu_opts_del(opts);
793 return 0;
795 if (!qdev_device_add(opts)) {
796 qemu_opts_del(opts);
797 return -1;
799 return 0;
802 int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data)
804 const char *id = qdict_get_str(qdict, "id");
805 DeviceState *dev;
807 dev = qdev_find_recursive(main_system_bus, id);
808 if (NULL == dev) {
809 qerror_report(QERR_DEVICE_NOT_FOUND, id);
810 return -1;
812 return qdev_unplug(dev);