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