Similarly, use the object properties also to set the default values of the qdev properties. This requires reordering registration and initialization. Reviewed-by: Anthony Liguori <aliguori@us.ibm.com> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
674 lines
17 KiB
C
674 lines
17 KiB
C
/*
|
|
* Dynamic device configuration and creation.
|
|
*
|
|
* Copyright (c) 2009 CodeSourcery
|
|
*
|
|
* This library is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 2 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library; if not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/* The theory here is that it should be possible to create a machine without
|
|
knowledge of specific devices. Historically board init routines have
|
|
passed a bunch of arguments to each device, requiring the board know
|
|
exactly which device it is dealing with. This file provides an abstract
|
|
API for device configuration and initialization. Devices will generally
|
|
inherit from a particular bus (e.g. PCI or I2C) rather than
|
|
this API directly. */
|
|
|
|
#include "net.h"
|
|
#include "qdev.h"
|
|
#include "sysemu.h"
|
|
|
|
int qdev_hotplug = 0;
|
|
static bool qdev_hot_added = false;
|
|
static bool qdev_hot_removed = false;
|
|
|
|
/* This is a nasty hack to allow passing a NULL bus to qdev_create. */
|
|
static BusState *main_system_bus;
|
|
static void main_system_bus_create(void);
|
|
|
|
/* Register a new device type. */
|
|
const VMStateDescription *qdev_get_vmsd(DeviceState *dev)
|
|
{
|
|
DeviceClass *dc = DEVICE_GET_CLASS(dev);
|
|
return dc->vmsd;
|
|
}
|
|
|
|
BusInfo *qdev_get_bus_info(DeviceState *dev)
|
|
{
|
|
DeviceClass *dc = DEVICE_GET_CLASS(dev);
|
|
return dc->bus_info;
|
|
}
|
|
|
|
Property *qdev_get_props(DeviceState *dev)
|
|
{
|
|
DeviceClass *dc = DEVICE_GET_CLASS(dev);
|
|
return dc->props;
|
|
}
|
|
|
|
const char *qdev_fw_name(DeviceState *dev)
|
|
{
|
|
DeviceClass *dc = DEVICE_GET_CLASS(dev);
|
|
|
|
if (dc->fw_name) {
|
|
return dc->fw_name;
|
|
}
|
|
|
|
return object_get_typename(OBJECT(dev));
|
|
}
|
|
|
|
bool qdev_exists(const char *name)
|
|
{
|
|
return !!object_class_by_name(name);
|
|
}
|
|
|
|
static void qdev_property_add_legacy(DeviceState *dev, Property *prop,
|
|
Error **errp);
|
|
|
|
void qdev_set_parent_bus(DeviceState *dev, BusState *bus)
|
|
{
|
|
Property *prop;
|
|
|
|
if (qdev_hotplug) {
|
|
assert(bus->allow_hotplug);
|
|
}
|
|
|
|
dev->parent_bus = bus;
|
|
QTAILQ_INSERT_HEAD(&bus->children, dev, sibling);
|
|
|
|
for (prop = qdev_get_bus_info(dev)->props; prop && prop->name; prop++) {
|
|
qdev_property_add_legacy(dev, prop, NULL);
|
|
qdev_property_add_static(dev, prop, NULL);
|
|
}
|
|
qdev_prop_set_defaults(dev, dev->parent_bus->info->props);
|
|
}
|
|
|
|
/* Create a new device. This only initializes the device state structure
|
|
and allows properties to be set. qdev_init should be called to
|
|
initialize the actual device emulation. */
|
|
DeviceState *qdev_create(BusState *bus, const char *name)
|
|
{
|
|
DeviceState *dev;
|
|
|
|
dev = qdev_try_create(bus, name);
|
|
if (!dev) {
|
|
if (bus) {
|
|
hw_error("Unknown device '%s' for bus '%s'\n", name,
|
|
bus->info->name);
|
|
} else {
|
|
hw_error("Unknown device '%s' for default sysbus\n", name);
|
|
}
|
|
}
|
|
|
|
return dev;
|
|
}
|
|
|
|
DeviceState *qdev_try_create(BusState *bus, const char *name)
|
|
{
|
|
DeviceState *dev;
|
|
|
|
dev = DEVICE(object_new(name));
|
|
if (!dev) {
|
|
return NULL;
|
|
}
|
|
|
|
if (!bus) {
|
|
bus = sysbus_get_default();
|
|
}
|
|
|
|
qdev_set_parent_bus(dev, bus);
|
|
qdev_prop_set_globals(dev);
|
|
|
|
return dev;
|
|
}
|
|
|
|
/* Initialize a device. Device properties should be set before calling
|
|
this function. IRQs and MMIO regions should be connected/mapped after
|
|
calling this function.
|
|
On failure, destroy the device and return negative value.
|
|
Return 0 on success. */
|
|
int qdev_init(DeviceState *dev)
|
|
{
|
|
DeviceClass *dc = DEVICE_GET_CLASS(dev);
|
|
int rc;
|
|
|
|
assert(dev->state == DEV_STATE_CREATED);
|
|
|
|
rc = dc->init(dev);
|
|
if (rc < 0) {
|
|
qdev_free(dev);
|
|
return rc;
|
|
}
|
|
if (qdev_get_vmsd(dev)) {
|
|
vmstate_register_with_alias_id(dev, -1, qdev_get_vmsd(dev), dev,
|
|
dev->instance_id_alias,
|
|
dev->alias_required_for_version);
|
|
}
|
|
dev->state = DEV_STATE_INITIALIZED;
|
|
if (dev->hotplugged) {
|
|
device_reset(dev);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
|
|
int required_for_version)
|
|
{
|
|
assert(dev->state == DEV_STATE_CREATED);
|
|
dev->instance_id_alias = alias_id;
|
|
dev->alias_required_for_version = required_for_version;
|
|
}
|
|
|
|
int qdev_unplug(DeviceState *dev)
|
|
{
|
|
DeviceClass *dc = DEVICE_GET_CLASS(dev);
|
|
|
|
if (!dev->parent_bus->allow_hotplug) {
|
|
qerror_report(QERR_BUS_NO_HOTPLUG, dev->parent_bus->name);
|
|
return -1;
|
|
}
|
|
assert(dc->unplug != NULL);
|
|
|
|
qdev_hot_removed = true;
|
|
|
|
return dc->unplug(dev);
|
|
}
|
|
|
|
static int qdev_reset_one(DeviceState *dev, void *opaque)
|
|
{
|
|
device_reset(dev);
|
|
|
|
return 0;
|
|
}
|
|
|
|
BusState *sysbus_get_default(void)
|
|
{
|
|
if (!main_system_bus) {
|
|
main_system_bus_create();
|
|
}
|
|
return main_system_bus;
|
|
}
|
|
|
|
static int qbus_reset_one(BusState *bus, void *opaque)
|
|
{
|
|
if (bus->info->reset) {
|
|
return bus->info->reset(bus);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
void qdev_reset_all(DeviceState *dev)
|
|
{
|
|
qdev_walk_children(dev, qdev_reset_one, qbus_reset_one, NULL);
|
|
}
|
|
|
|
void qbus_reset_all_fn(void *opaque)
|
|
{
|
|
BusState *bus = opaque;
|
|
qbus_walk_children(bus, qdev_reset_one, qbus_reset_one, NULL);
|
|
}
|
|
|
|
/* can be used as ->unplug() callback for the simple cases */
|
|
int qdev_simple_unplug_cb(DeviceState *dev)
|
|
{
|
|
/* just zap it */
|
|
object_unparent(OBJECT(dev));
|
|
qdev_free(dev);
|
|
return 0;
|
|
}
|
|
|
|
|
|
/* Like qdev_init(), but terminate program via error_report() instead of
|
|
returning an error value. This is okay during machine creation.
|
|
Don't use for hotplug, because there callers need to recover from
|
|
failure. Exception: if you know the device's init() callback can't
|
|
fail, then qdev_init_nofail() can't fail either, and is therefore
|
|
usable even then. But relying on the device implementation that
|
|
way is somewhat unclean, and best avoided. */
|
|
void qdev_init_nofail(DeviceState *dev)
|
|
{
|
|
if (qdev_init(dev) < 0) {
|
|
error_report("Initialization of device %s failed",
|
|
object_get_typename(OBJECT(dev)));
|
|
exit(1);
|
|
}
|
|
}
|
|
|
|
/* Unlink device from bus and free the structure. */
|
|
void qdev_free(DeviceState *dev)
|
|
{
|
|
object_delete(OBJECT(dev));
|
|
}
|
|
|
|
void qdev_machine_creation_done(void)
|
|
{
|
|
/*
|
|
* ok, initial machine setup is done, starting from now we can
|
|
* only create hotpluggable devices
|
|
*/
|
|
qdev_hotplug = 1;
|
|
}
|
|
|
|
bool qdev_machine_modified(void)
|
|
{
|
|
return qdev_hot_added || qdev_hot_removed;
|
|
}
|
|
|
|
BusState *qdev_get_parent_bus(DeviceState *dev)
|
|
{
|
|
return dev->parent_bus;
|
|
}
|
|
|
|
void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n)
|
|
{
|
|
assert(dev->num_gpio_in == 0);
|
|
dev->num_gpio_in = n;
|
|
dev->gpio_in = qemu_allocate_irqs(handler, dev, n);
|
|
}
|
|
|
|
void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n)
|
|
{
|
|
assert(dev->num_gpio_out == 0);
|
|
dev->num_gpio_out = n;
|
|
dev->gpio_out = pins;
|
|
}
|
|
|
|
qemu_irq qdev_get_gpio_in(DeviceState *dev, int n)
|
|
{
|
|
assert(n >= 0 && n < dev->num_gpio_in);
|
|
return dev->gpio_in[n];
|
|
}
|
|
|
|
void qdev_connect_gpio_out(DeviceState * dev, int n, qemu_irq pin)
|
|
{
|
|
assert(n >= 0 && n < dev->num_gpio_out);
|
|
dev->gpio_out[n] = pin;
|
|
}
|
|
|
|
void qdev_set_nic_properties(DeviceState *dev, NICInfo *nd)
|
|
{
|
|
qdev_prop_set_macaddr(dev, "mac", nd->macaddr.a);
|
|
if (nd->vlan)
|
|
qdev_prop_set_vlan(dev, "vlan", nd->vlan);
|
|
if (nd->netdev)
|
|
qdev_prop_set_netdev(dev, "netdev", nd->netdev);
|
|
if (nd->nvectors != DEV_NVECTORS_UNSPECIFIED &&
|
|
qdev_prop_exists(dev, "vectors")) {
|
|
qdev_prop_set_uint32(dev, "vectors", nd->nvectors);
|
|
}
|
|
nd->instantiated = 1;
|
|
}
|
|
|
|
BusState *qdev_get_child_bus(DeviceState *dev, const char *name)
|
|
{
|
|
BusState *bus;
|
|
|
|
QLIST_FOREACH(bus, &dev->child_bus, sibling) {
|
|
if (strcmp(name, bus->name) == 0) {
|
|
return bus;
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
|
|
qbus_walkerfn *busfn, void *opaque)
|
|
{
|
|
DeviceState *dev;
|
|
int err;
|
|
|
|
if (busfn) {
|
|
err = busfn(bus, opaque);
|
|
if (err) {
|
|
return err;
|
|
}
|
|
}
|
|
|
|
QTAILQ_FOREACH(dev, &bus->children, sibling) {
|
|
err = qdev_walk_children(dev, devfn, busfn, opaque);
|
|
if (err < 0) {
|
|
return err;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
|
|
qbus_walkerfn *busfn, void *opaque)
|
|
{
|
|
BusState *bus;
|
|
int err;
|
|
|
|
if (devfn) {
|
|
err = devfn(dev, opaque);
|
|
if (err) {
|
|
return err;
|
|
}
|
|
}
|
|
|
|
QLIST_FOREACH(bus, &dev->child_bus, sibling) {
|
|
err = qbus_walk_children(bus, devfn, busfn, opaque);
|
|
if (err < 0) {
|
|
return err;
|
|
}
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
DeviceState *qdev_find_recursive(BusState *bus, const char *id)
|
|
{
|
|
DeviceState *dev, *ret;
|
|
BusState *child;
|
|
|
|
QTAILQ_FOREACH(dev, &bus->children, sibling) {
|
|
if (dev->id && strcmp(dev->id, id) == 0)
|
|
return dev;
|
|
QLIST_FOREACH(child, &dev->child_bus, sibling) {
|
|
ret = qdev_find_recursive(child, id);
|
|
if (ret) {
|
|
return ret;
|
|
}
|
|
}
|
|
}
|
|
return NULL;
|
|
}
|
|
|
|
void qbus_create_inplace(BusState *bus, BusInfo *info,
|
|
DeviceState *parent, const char *name)
|
|
{
|
|
char *buf;
|
|
int i,len;
|
|
|
|
bus->info = info;
|
|
bus->parent = parent;
|
|
|
|
if (name) {
|
|
/* use supplied name */
|
|
bus->name = g_strdup(name);
|
|
} else if (parent && parent->id) {
|
|
/* parent device has id -> use it for bus name */
|
|
len = strlen(parent->id) + 16;
|
|
buf = g_malloc(len);
|
|
snprintf(buf, len, "%s.%d", parent->id, parent->num_child_bus);
|
|
bus->name = buf;
|
|
} else {
|
|
/* no id -> use lowercase bus type for bus name */
|
|
len = strlen(info->name) + 16;
|
|
buf = g_malloc(len);
|
|
len = snprintf(buf, len, "%s.%d", info->name,
|
|
parent ? parent->num_child_bus : 0);
|
|
for (i = 0; i < len; i++)
|
|
buf[i] = qemu_tolower(buf[i]);
|
|
bus->name = buf;
|
|
}
|
|
|
|
QTAILQ_INIT(&bus->children);
|
|
if (parent) {
|
|
QLIST_INSERT_HEAD(&parent->child_bus, bus, sibling);
|
|
parent->num_child_bus++;
|
|
} else if (bus != main_system_bus) {
|
|
/* TODO: once all bus devices are qdevified,
|
|
only reset handler for main_system_bus should be registered here. */
|
|
qemu_register_reset(qbus_reset_all_fn, bus);
|
|
}
|
|
}
|
|
|
|
BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name)
|
|
{
|
|
BusState *bus;
|
|
|
|
bus = g_malloc0(info->size);
|
|
bus->qdev_allocated = 1;
|
|
qbus_create_inplace(bus, info, parent, name);
|
|
return bus;
|
|
}
|
|
|
|
static void main_system_bus_create(void)
|
|
{
|
|
/* assign main_system_bus before qbus_create_inplace()
|
|
* in order to make "if (bus != main_system_bus)" work */
|
|
main_system_bus = g_malloc0(system_bus_info.size);
|
|
main_system_bus->qdev_allocated = 1;
|
|
qbus_create_inplace(main_system_bus, &system_bus_info, NULL,
|
|
"main-system-bus");
|
|
}
|
|
|
|
void qbus_free(BusState *bus)
|
|
{
|
|
DeviceState *dev;
|
|
|
|
while ((dev = QTAILQ_FIRST(&bus->children)) != NULL) {
|
|
qdev_free(dev);
|
|
}
|
|
if (bus->parent) {
|
|
QLIST_REMOVE(bus, sibling);
|
|
bus->parent->num_child_bus--;
|
|
} else {
|
|
assert(bus != main_system_bus); /* main_system_bus is never freed */
|
|
qemu_unregister_reset(qbus_reset_all_fn, bus);
|
|
}
|
|
g_free((void*)bus->name);
|
|
if (bus->qdev_allocated) {
|
|
g_free(bus);
|
|
}
|
|
}
|
|
|
|
static int qdev_get_fw_dev_path_helper(DeviceState *dev, char *p, int size)
|
|
{
|
|
int l = 0;
|
|
|
|
if (dev && dev->parent_bus) {
|
|
char *d;
|
|
l = qdev_get_fw_dev_path_helper(dev->parent_bus->parent, p, size);
|
|
if (dev->parent_bus->info->get_fw_dev_path) {
|
|
d = dev->parent_bus->info->get_fw_dev_path(dev);
|
|
l += snprintf(p + l, size - l, "%s", d);
|
|
g_free(d);
|
|
} else {
|
|
l += snprintf(p + l, size - l, "%s", object_get_typename(OBJECT(dev)));
|
|
}
|
|
}
|
|
l += snprintf(p + l , size - l, "/");
|
|
|
|
return l;
|
|
}
|
|
|
|
char* qdev_get_fw_dev_path(DeviceState *dev)
|
|
{
|
|
char path[128];
|
|
int l;
|
|
|
|
l = qdev_get_fw_dev_path_helper(dev, path, 128);
|
|
|
|
path[l-1] = '\0';
|
|
|
|
return strdup(path);
|
|
}
|
|
|
|
static char *qdev_get_type(Object *obj, Error **errp)
|
|
{
|
|
return g_strdup(object_get_typename(obj));
|
|
}
|
|
|
|
/**
|
|
* Legacy property handling
|
|
*/
|
|
|
|
static void qdev_get_legacy_property(Object *obj, Visitor *v, void *opaque,
|
|
const char *name, Error **errp)
|
|
{
|
|
DeviceState *dev = DEVICE(obj);
|
|
Property *prop = opaque;
|
|
|
|
char buffer[1024];
|
|
char *ptr = buffer;
|
|
|
|
prop->info->print(dev, prop, buffer, sizeof(buffer));
|
|
visit_type_str(v, &ptr, name, errp);
|
|
}
|
|
|
|
static void qdev_set_legacy_property(Object *obj, Visitor *v, void *opaque,
|
|
const char *name, Error **errp)
|
|
{
|
|
DeviceState *dev = DEVICE(obj);
|
|
Property *prop = opaque;
|
|
Error *local_err = NULL;
|
|
char *ptr = NULL;
|
|
int ret;
|
|
|
|
if (dev->state != DEV_STATE_CREATED) {
|
|
error_set(errp, QERR_PERMISSION_DENIED);
|
|
return;
|
|
}
|
|
|
|
visit_type_str(v, &ptr, name, &local_err);
|
|
if (local_err) {
|
|
error_propagate(errp, local_err);
|
|
return;
|
|
}
|
|
|
|
ret = prop->info->parse(dev, prop, ptr);
|
|
error_set_from_qdev_prop_error(errp, ret, dev, prop, ptr);
|
|
g_free(ptr);
|
|
}
|
|
|
|
/**
|
|
* @qdev_add_legacy_property - adds a legacy property
|
|
*
|
|
* Do not use this is new code! Properties added through this interface will
|
|
* be given names and types in the "legacy" namespace.
|
|
*
|
|
* Legacy properties are string versions of other OOM properties. The format
|
|
* of the string depends on the property type.
|
|
*/
|
|
void qdev_property_add_legacy(DeviceState *dev, Property *prop,
|
|
Error **errp)
|
|
{
|
|
gchar *name, *type;
|
|
|
|
if (!prop->info->print && !prop->info->parse) {
|
|
return;
|
|
}
|
|
name = g_strdup_printf("legacy-%s", prop->name);
|
|
type = g_strdup_printf("legacy<%s>",
|
|
prop->info->legacy_name ?: prop->info->name);
|
|
|
|
object_property_add(OBJECT(dev), name, type,
|
|
prop->info->print ? qdev_get_legacy_property : prop->info->get,
|
|
prop->info->parse ? qdev_set_legacy_property : prop->info->set,
|
|
NULL,
|
|
prop, errp);
|
|
|
|
g_free(type);
|
|
g_free(name);
|
|
}
|
|
|
|
/**
|
|
* @qdev_property_add_static - add a @Property to a device.
|
|
*
|
|
* Static properties access data in a struct. The actual type of the
|
|
* property and the field depends on the property type.
|
|
*/
|
|
void qdev_property_add_static(DeviceState *dev, Property *prop,
|
|
Error **errp)
|
|
{
|
|
/*
|
|
* TODO qdev_prop_ptr does not have getters or setters. It must
|
|
* go now that it can be replaced with links. The test should be
|
|
* removed along with it: all static properties are read/write.
|
|
*/
|
|
if (!prop->info->get && !prop->info->set) {
|
|
return;
|
|
}
|
|
|
|
object_property_add(OBJECT(dev), prop->name, prop->info->name,
|
|
prop->info->get, prop->info->set,
|
|
prop->info->release,
|
|
prop, errp);
|
|
}
|
|
|
|
static void device_initfn(Object *obj)
|
|
{
|
|
DeviceState *dev = DEVICE(obj);
|
|
Property *prop;
|
|
|
|
if (qdev_hotplug) {
|
|
dev->hotplugged = 1;
|
|
qdev_hot_added = true;
|
|
}
|
|
|
|
dev->instance_id_alias = -1;
|
|
dev->state = DEV_STATE_CREATED;
|
|
|
|
for (prop = qdev_get_props(dev); prop && prop->name; prop++) {
|
|
qdev_property_add_legacy(dev, prop, NULL);
|
|
qdev_property_add_static(dev, prop, NULL);
|
|
}
|
|
|
|
object_property_add_str(OBJECT(dev), "type", qdev_get_type, NULL, NULL);
|
|
qdev_prop_set_defaults(dev, qdev_get_props(dev));
|
|
}
|
|
|
|
/* Unlink device from bus and free the structure. */
|
|
static void device_finalize(Object *obj)
|
|
{
|
|
DeviceState *dev = DEVICE(obj);
|
|
BusState *bus;
|
|
DeviceClass *dc = DEVICE_GET_CLASS(dev);
|
|
|
|
if (dev->state == DEV_STATE_INITIALIZED) {
|
|
while (dev->num_child_bus) {
|
|
bus = QLIST_FIRST(&dev->child_bus);
|
|
qbus_free(bus);
|
|
}
|
|
if (qdev_get_vmsd(dev)) {
|
|
vmstate_unregister(dev, qdev_get_vmsd(dev), dev);
|
|
}
|
|
if (dc->exit) {
|
|
dc->exit(dev);
|
|
}
|
|
if (dev->opts) {
|
|
qemu_opts_del(dev->opts);
|
|
}
|
|
}
|
|
QTAILQ_REMOVE(&dev->parent_bus->children, dev, sibling);
|
|
}
|
|
|
|
void device_reset(DeviceState *dev)
|
|
{
|
|
DeviceClass *klass = DEVICE_GET_CLASS(dev);
|
|
|
|
if (klass->reset) {
|
|
klass->reset(dev);
|
|
}
|
|
}
|
|
|
|
static TypeInfo device_type_info = {
|
|
.name = TYPE_DEVICE,
|
|
.parent = TYPE_OBJECT,
|
|
.instance_size = sizeof(DeviceState),
|
|
.instance_init = device_initfn,
|
|
.instance_finalize = device_finalize,
|
|
.abstract = true,
|
|
.class_size = sizeof(DeviceClass),
|
|
};
|
|
|
|
static void init_qdev(void)
|
|
{
|
|
type_register_static(&device_type_info);
|
|
}
|
|
|
|
device_init(init_qdev);
|