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