hw/qdev.h

   1 #ifndef QDEV_H
   2 #define QDEV_H
   3
   4 #include "hw.h"
   5 #include "qemu-queue.h"
   6 #include "qemu-char.h"
   7 #include "qemu-option.h"
   8 #include "qapi/qapi-visit-core.h"
   9
  10 typedef struct Property Property;
  11
  12 typedef struct PropertyInfo PropertyInfo;
  13
  14 typedef struct CompatProperty CompatProperty;
  15
  16 typedef struct DeviceInfo DeviceInfo;
  17
  18 typedef struct BusState BusState;
  19
  20 typedef struct BusInfo BusInfo;
  21
  22 enum DevState {
  23     DEV_STATE_CREATED = 1,
  24     DEV_STATE_INITIALIZED,
  25 };
  26
  27 enum {
  28     DEV_NVECTORS_UNSPECIFIED = -1,
  29 };
  30
  31 /**
  32  * @DevicePropertyAccessor - called when trying to get/set a property
  33  *
  34  * @dev the device that owns the property
  35  * @v the visitor that contains the property data
  36  * @opaque the device property opaque
  37  * @name the name of the property
  38  * @errp a pointer to an Error that is filled if getting/setting fails.
  39  */
  40 typedef void (DevicePropertyAccessor)(DeviceState *dev,
  41                                       Visitor *v,
  42                                       void *opaque,
  43                                       const char *name,
  44                                       Error **errp);
  45
  46 /**
  47  * @DevicePropertyRelease - called when a property is removed from a device
  48  *
  49  * @dev the device that owns the property
  50  * @name the name of the property
  51  * @opaque the opaque registered with the property
  52  */
  53 typedef void (DevicePropertyRelease)(DeviceState *dev,
  54                                      const char *name,
  55                                      void *opaque);
  56
  57 typedef struct DeviceProperty
  58 {
  59     gchar *name;
  60     gchar *type;
  61     DevicePropertyAccessor *get;
  62     DevicePropertyAccessor *set;
  63     DevicePropertyRelease *release;
  64     void *opaque;
  65
  66     QTAILQ_ENTRY(DeviceProperty) node;
  67 } DeviceProperty;
  68
  69 /* This structure should not be accessed directly.  We declare it here
  70    so that it can be embedded in individual device state structures.  */
  71 struct DeviceState {
  72     const char *id;
  73     enum DevState state;
  74     QemuOpts *opts;
  75     int hotplugged;
  76     DeviceInfo *info;
  77     BusState *parent_bus;
  78     int num_gpio_out;
  79     qemu_irq *gpio_out;
  80     int num_gpio_in;
  81     qemu_irq *gpio_in;
  82     QLIST_HEAD(, BusState) child_bus;
  83     int num_child_bus;
  84     QTAILQ_ENTRY(DeviceState) sibling;
  85     int instance_id_alias;
  86     int alias_required_for_version;
  87
  88     /**
  89      * This tracks the number of references between devices.  See @qdev_ref for
  90      * more information.
  91      */
  92     uint32_t ref;
  93
  94     QTAILQ_HEAD(, DeviceProperty) properties;
  95
  96     /* Do not, under any circumstance, use this parent link below anywhere
  97      * outside of qdev.c.  You have been warned. */
  98     DeviceState *parent;
  99 };
 100
 101 typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent);
 102 typedef char *(*bus_get_dev_path)(DeviceState *dev);
 103 /*
 104  * This callback is used to create Open Firmware device path in accordance with
 105  * OF spec http://forthworks.com/standards/of1275.pdf. Indicidual bus bindings
 106  * can be found here http://playground.sun.com/1275/bindings/.
 107  */
 108 typedef char *(*bus_get_fw_dev_path)(DeviceState *dev);
 109 typedef int (qbus_resetfn)(BusState *bus);
 110
 111 struct BusInfo {
 112     const char *name;
 113     size_t size;
 114     bus_dev_printfn print_dev;
 115     bus_get_dev_path get_dev_path;
 116     bus_get_fw_dev_path get_fw_dev_path;
 117     qbus_resetfn *reset;
 118     Property *props;
 119 };
 120
 121 struct BusState {
 122     DeviceState *parent;
 123     BusInfo *info;
 124     const char *name;
 125     int allow_hotplug;
 126     int qdev_allocated;
 127     QTAILQ_HEAD(ChildrenHead, DeviceState) children;
 128     QLIST_ENTRY(BusState) sibling;
 129 };
 130
 131 struct Property {
 132     const char   *name;
 133     PropertyInfo *info;
 134     int          offset;
 135     int          bitnr;
 136     void         *defval;
 137 };
 138
 139 enum PropertyType {
 140     PROP_TYPE_UNSPEC = 0,
 141     PROP_TYPE_UINT8,
 142     PROP_TYPE_UINT16,
 143     PROP_TYPE_UINT32,
 144     PROP_TYPE_INT32,
 145     PROP_TYPE_UINT64,
 146     PROP_TYPE_TADDR,
 147     PROP_TYPE_MACADDR,
 148     PROP_TYPE_DRIVE,
 149     PROP_TYPE_CHR,
 150     PROP_TYPE_STRING,
 151     PROP_TYPE_NETDEV,
 152     PROP_TYPE_VLAN,
 153     PROP_TYPE_PTR,
 154     PROP_TYPE_BIT,
 155 };
 156
 157 struct PropertyInfo {
 158     const char *name;
 159     const char *legacy_name;
 160     size_t size;
 161     enum PropertyType type;
 162     int64_t min;
 163     int64_t max;
 164     int (*parse)(DeviceState *dev, Property *prop, const char *str);
 165     int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
 166     void (*free)(DeviceState *dev, Property *prop);
 167     DevicePropertyAccessor *get;
 168     DevicePropertyAccessor *set;
 169 };
 170
 171 typedef struct GlobalProperty {
 172     const char *driver;
 173     const char *property;
 174     const char *value;
 175     QTAILQ_ENTRY(GlobalProperty) next;
 176 } GlobalProperty;
 177
 178 /*** Board API.  This should go away once we have a machine config file.  ***/
 179
 180 DeviceState *qdev_create(BusState *bus, const char *name);
 181 DeviceState *qdev_try_create(BusState *bus, const char *name);
 182 int qdev_device_help(QemuOpts *opts);
 183 DeviceState *qdev_device_add(QemuOpts *opts);
 184 int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
 185 void qdev_init_nofail(DeviceState *dev);
 186 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
 187                                  int required_for_version);
 188 int qdev_unplug(DeviceState *dev);
 189 void qdev_free(DeviceState *dev);
 190 int qdev_simple_unplug_cb(DeviceState *dev);
 191 void qdev_machine_creation_done(void);
 192 bool qdev_machine_modified(void);
 193
 194 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
 195 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 196
 197 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
 198
 199 /*** Device API.  ***/
 200
 201 typedef int (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
 202 typedef int (*qdev_event)(DeviceState *dev);
 203 typedef void (*qdev_resetfn)(DeviceState *dev);
 204
 205 struct DeviceInfo {
 206     const char *name;
 207     const char *fw_name;
 208     const char *alias;
 209     const char *desc;
 210     size_t size;
 211     Property *props;
 212     int no_user;
 213
 214     /* callbacks */
 215     qdev_resetfn reset;
 216
 217     /* device state */
 218     const VMStateDescription *vmsd;
 219
 220     /* Private to qdev / bus.  */
 221     qdev_initfn init;
 222     qdev_event unplug;
 223     qdev_event exit;
 224     BusInfo *bus_info;
 225     struct DeviceInfo *next;
 226 };
 227 extern DeviceInfo *device_info_list;
 228
 229 void qdev_register(DeviceInfo *info);
 230
 231 /* Register device properties.  */
 232 /* GPIO inputs also double as IRQ sinks.  */
 233 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 234 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 235
 236 CharDriverState *qdev_init_chardev(DeviceState *dev);
 237
 238 BusState *qdev_get_parent_bus(DeviceState *dev);
 239
 240 /*** BUS API. ***/
 241
 242 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
 243
 244 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
 245 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
 246 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
 247
 248 void qbus_create_inplace(BusState *bus, BusInfo *info,
 249                          DeviceState *parent, const char *name);
 250 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
 251 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
 252  *         < 0 if either devfn or busfn terminate walk somewhere in cursion,
 253  *           0 otherwise. */
 254 int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
 255                        qbus_walkerfn *busfn, void *opaque);
 256 int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
 257                        qbus_walkerfn *busfn, void *opaque);
 258 void qdev_reset_all(DeviceState *dev);
 259 void qbus_reset_all_fn(void *opaque);
 260
 261 void qbus_free(BusState *bus);
 262
 263 #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
 264
 265 /* This should go away once we get rid of the NULL bus hack */
 266 BusState *sysbus_get_default(void);
 267
 268 /*** monitor commands ***/
 269
 270 void do_info_qtree(Monitor *mon);
 271 void do_info_qdm(Monitor *mon);
 272 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data);
 273 int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data);
 274
 275 /*** qdev-properties.c ***/
 276
 277 extern PropertyInfo qdev_prop_bit;
 278 extern PropertyInfo qdev_prop_uint8;
 279 extern PropertyInfo qdev_prop_uint16;
 280 extern PropertyInfo qdev_prop_uint32;
 281 extern PropertyInfo qdev_prop_int32;
 282 extern PropertyInfo qdev_prop_uint64;
 283 extern PropertyInfo qdev_prop_hex8;
 284 extern PropertyInfo qdev_prop_hex32;
 285 extern PropertyInfo qdev_prop_hex64;
 286 extern PropertyInfo qdev_prop_string;
 287 extern PropertyInfo qdev_prop_chr;
 288 extern PropertyInfo qdev_prop_ptr;
 289 extern PropertyInfo qdev_prop_macaddr;
 290 extern PropertyInfo qdev_prop_drive;
 291 extern PropertyInfo qdev_prop_netdev;
 292 extern PropertyInfo qdev_prop_vlan;
 293 extern PropertyInfo qdev_prop_pci_devfn;
 294
 295 #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
 296         .name      = (_name),                                    \
 297         .info      = &(_prop),                                   \
 298         .offset    = offsetof(_state, _field)                    \
 299             + type_check(_type,typeof_field(_state, _field)),    \
 300         }
 301 #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
 302         .name      = (_name),                                           \
 303         .info      = &(_prop),                                          \
 304         .offset    = offsetof(_state, _field)                           \
 305             + type_check(_type,typeof_field(_state, _field)),           \
 306         .defval    = (_type[]) { _defval },                             \
 307         }
 308 #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) {  \
 309         .name      = (_name),                                    \
 310         .info      = &(qdev_prop_bit),                           \
 311         .bitnr    = (_bit),                                      \
 312         .offset    = offsetof(_state, _field)                    \
 313             + type_check(uint32_t,typeof_field(_state, _field)), \
 314         .defval    = (bool[]) { (_defval) },                     \
 315         }
 316
 317 #define DEFINE_PROP_UINT8(_n, _s, _f, _d)                       \
 318     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
 319 #define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
 320     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
 321 #define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
 322     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
 323 #define DEFINE_PROP_INT32(_n, _s, _f, _d)                      \
 324     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
 325 #define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
 326     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
 327 #define DEFINE_PROP_HEX8(_n, _s, _f, _d)                       \
 328     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t)
 329 #define DEFINE_PROP_HEX32(_n, _s, _f, _d)                       \
 330     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
 331 #define DEFINE_PROP_HEX64(_n, _s, _f, _d)                       \
 332     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
 333 #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
 334     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
 335
 336 #define DEFINE_PROP_PTR(_n, _s, _f)             \
 337     DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
 338 #define DEFINE_PROP_CHR(_n, _s, _f)             \
 339     DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
 340 #define DEFINE_PROP_STRING(_n, _s, _f)             \
 341     DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
 342 #define DEFINE_PROP_NETDEV(_n, _s, _f)             \
 343     DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
 344 #define DEFINE_PROP_VLAN(_n, _s, _f)             \
 345     DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
 346 #define DEFINE_PROP_DRIVE(_n, _s, _f) \
 347     DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
 348 #define DEFINE_PROP_MACADDR(_n, _s, _f)         \
 349     DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
 350
 351 #define DEFINE_PROP_END_OF_LIST()               \
 352     {}
 353
 354 /* Set properties between creation and init.  */
 355 void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
 356 int qdev_prop_exists(DeviceState *dev, const char *name);
 357 int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
 358 void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type);
 359 void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value);
 360 void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
 361 void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
 362 void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
 363 void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
 364 void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
 365 void qdev_prop_set_string(DeviceState *dev, const char *name, char *value);
 366 void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
 367 void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value);
 368 void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value);
 369 int qdev_prop_set_drive(DeviceState *dev, const char *name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT;
 370 void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name, BlockDriverState *value);
 371 void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
 372 /* FIXME: Remove opaque pointer properties.  */
 373 void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
 374 void qdev_prop_set_defaults(DeviceState *dev, Property *props);
 375
 376 void qdev_prop_register_global_list(GlobalProperty *props);
 377 void qdev_prop_set_globals(DeviceState *dev);
 378 void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev,
 379                                     Property *prop, const char *value);
 380
 381 static inline const char *qdev_fw_name(DeviceState *dev)
 382 {
 383     return dev->info->fw_name ? : dev->info->alias ? : dev->info->name;
 384 }
 385
 386 char *qdev_get_fw_dev_path(DeviceState *dev);
 387 /* This is a nasty hack to allow passing a NULL bus to qdev_create.  */
 388 extern struct BusInfo system_bus_info;
 389
 390 /**
 391  * @qdev_ref
 392  *
 393  * Increase the reference count of a device.  A device cannot be freed as long
 394  * as its reference count is greater than zero.
 395  *
 396  * @dev - the device
 397  */
 398 void qdev_ref(DeviceState *dev);
 399
 400 /**
 401  * @qdef_unref
 402  *
 403  * Decrease the reference count of a device.  A device cannot be freed as long
 404  * as its reference count is greater than zero.
 405  *
 406  * @dev - the device
 407  */
 408 void qdev_unref(DeviceState *dev);
 409
 410 /**
 411  * @qdev_property_add - add a new property to a device
 412  *
 413  * @dev - the device to add a property to
 414  *
 415  * @name - the name of the property.  This can contain any character except for
 416  *         a forward slash.  In general, you should use hyphens '-' instead of
 417  *         underscores '_' when naming properties.
 418  *
 419  * @type - the type name of the property.  This namespace is pretty loosely
 420  *         defined.  Sub namespaces are constructed by using a prefix and then
 421  *         to angle brackets.  For instance, the type 'virtio-net-pci' in the
 422  *         'link' namespace would be 'link<virtio-net-pci>'.
 423  *
 424  * @get - the getter to be called to read a property.  If this is NULL, then
 425  *        the property cannot be read.
 426  *
 427  * @set - the setter to be called to write a property.  If this is NULL,
 428  *        then the property cannot be written.
 429  *
 430  * @release - called when the property is removed from the device.  This is
 431  *            meant to allow a property to free its opaque upon device
 432  *            destruction.  This may be NULL.
 433  *
 434  * @opaque - an opaque pointer to pass to the callbacks for the property
 435  *
 436  * @errp - returns an error if this function fails
 437  */
 438 void qdev_property_add(DeviceState *dev, const char *name, const char *type,
 439                        DevicePropertyAccessor *get, DevicePropertyAccessor *set,
 440                        DevicePropertyRelease *release,
 441                        void *opaque, Error **errp);
 442
 443 /**
 444  * @qdev_property_get - reads a property from a device
 445  *
 446  * @dev - the device
 447  *
 448  * @v - the visitor that will receive the property value.  This should be an
 449  *      Output visitor and the data will be written with @name as the name.
 450  *
 451  * @name - the name of the property
 452  *
 453  * @errp - returns an error if this function fails
 454  */
 455 void qdev_property_get(DeviceState *dev, Visitor *v, const char *name,
 456                        Error **errp);
 457
 458 /**
 459  * @qdev_property_set - writes a property to a device
 460  *
 461  * @dev - the device
 462  *
 463  * @v - the visitor that will be used to write the property value.  This should
 464  *      be an Input visitor and the data will be first read with @name as the
 465  *      name and then written as the property value.
 466  *
 467  * @name - the name of the property
 468  *
 469  * @errp - returns an error if this function fails
 470  */
 471 void qdev_property_set(DeviceState *dev, Visitor *v, const char *name,
 472                        Error **errp);
 473
 474 /**
 475  * @qdev_property_get_type - returns the type of a property
 476  *
 477  * @dev - the device
 478  *
 479  * @name - the name of the property
 480  *
 481  * @errp - returns an error if this function fails
 482  *
 483  * Returns:
 484  *   The type name of the property.
 485  */
 486 const char *qdev_property_get_type(DeviceState *dev, const char *name,
 487                                    Error **errp);
 488
 489 /**
 490  * @qdev_property_add_static - add a @Property to a device referencing a
 491  * field in a struct.
 492  */
 493 void qdev_property_add_static(DeviceState *dev, Property *prop, Error **errp);
 494
 495 /**
 496  * @qdev_get_root - returns the root device of the composition tree
 497  *
 498  * Returns:
 499  *   The root of the composition tree.
 500  */
 501 DeviceState *qdev_get_root(void);
 502
 503 /**
 504  * @qdev_get_canonical_path - returns the canonical path for a device.  This
 505  * is the path within the composition tree starting from the root.
 506  *
 507  * Returns:
 508  *   The canonical path in the composition tree.
 509  */
 510 gchar *qdev_get_canonical_path(DeviceState *dev);
 511
 512 /**
 513  * @qdev_resolve_path - resolves a path returning a device
 514  *
 515  * There are two types of supported paths--absolute paths and partial paths.
 516  *
 517  * Absolute paths are derived from the root device and can follow child<> or
 518  * link<> properties.  Since they can follow link<> properties, they can be
 519  * arbitrarily long.  Absolute paths look like absolute filenames and are
 520  * prefixed with a leading slash.
 521  *
 522  * Partial paths look like relative filenames.  They do not begin with a
 523  * prefix.  The matching rules for partial paths are subtle but designed to make
 524  * specifying devices easy.  At each level of the composition tree, the partial
 525  * path is matched as an absolute path.  The first match is not returned.  At
 526  * least two matches are searched for.  A successful result is only returned if
 527  * only one match is founded.  If more than one match is found, a flag is
 528  * return to indicate that the match was ambiguous.
 529  *
 530  * @path - the path to resolve
 531  *
 532  * @ambiguous - returns true if the path resolution failed because of an
 533  *              ambiguous match
 534  *
 535  * Returns:
 536  *   The matched device or NULL on path lookup failure.
 537  */
 538 DeviceState *qdev_resolve_path(const char *path, bool *ambiguous);
 539
 540 /**
 541  * @qdev_property_add_child - Add a child property to a device
 542  *
 543  * Child properties form the composition tree.  All devices need to be a child
 544  * of another device.  Devices can only be a child of one device.
 545  *
 546  * There is no way for a child to determine what its parent is.  It is not
 547  * a bidirectional relationship.  This is by design.
 548  *
 549  * @dev - the device to add a property to
 550  *
 551  * @name - the name of the property
 552  *
 553  * @child - the child device
 554  *
 555  * @errp - if an error occurs, a pointer to an area to store the area
 556  */
 557 void qdev_property_add_child(DeviceState *dev, const char *name,
 558                              DeviceState *child, Error **errp);
 559
 560 /**
 561  * @qdev_property_add_link - Add a link property to a device
 562  *
 563  * Links establish relationships between devices.  Links are unidirectional
 564  * although two links can be combined to form a bidirectional relationship
 565  * between devices.
 566  *
 567  * Links form the graph in the device model.
 568  *
 569  * @dev - the device to add a property to
 570  *
 571  * @name - the name of the property
 572  *
 573  * @type - the qdev type of the link
 574  *
 575  * @child - a pointer to where the link device reference is stored
 576  *
 577  * @errp - if an error occurs, a pointer to an area to store the area
 578  */
 579 void qdev_property_add_link(DeviceState *dev, const char *name,
 580                             const char *type, DeviceState **child,
 581                             Error **errp);
 582
 583 /**
 584  * @qdev_property_add_str
 585  *
 586  * Add a string property using getters/setters.  This function will add a
 587  * property of type 'string'.
 588  *
 589  * @dev - the device to add a property to
 590  *
 591  * @name - the name of the property
 592  *
 593  * @get - the getter or NULL if the property is write-only.  This function must
 594  *        return a string to be freed by @g_free().
 595  *
 596  * @set - the setter or NULL if the property is read-only
 597  *
 598  * @errp - if an error occurs, a pointer to an area to store the error
 599  */
 600 void qdev_property_add_str(DeviceState *dev, const char *name,
 601                            char *(*get)(DeviceState *, Error **),
 602                            void (*set)(DeviceState *, const char *, Error **),
 603                            Error **errp);
 604
 605 /**
 606  * @qdev_get_type
 607  *
 608  * Returns the string representation of the type of this object.
 609  *
 610  * @dev - the device
 611  *
 612  * @errp - if an error occurs, a pointer to an area to store the error
 613  *
 614  * Returns: a string representing the type.  This must be freed by the caller
 615  *          with g_free().
 616  */
 617 char *qdev_get_type(DeviceState *dev, Error **errp);
 618
 619 /**
 620  * @qdev_machine_init
 621  *
 622  * Initialize platform devices before machine init.  This is a hack until full
 623  * support for composition is added.
 624  */
 625 void qdev_machine_init(void);
 626
 627 #endif