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     size_t size;
 160     enum PropertyType type;
 161     int (*parse)(DeviceState *dev, Property *prop, const char *str);
 162     int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
 163     void (*free)(DeviceState *dev, Property *prop);
 164 };
 165
 166 typedef struct GlobalProperty {
 167     const char *driver;
 168     const char *property;
 169     const char *value;
 170     QTAILQ_ENTRY(GlobalProperty) next;
 171 } GlobalProperty;
 172
 173 /*** Board API.  This should go away once we have a machine config file.  ***/
 174
 175 DeviceState *qdev_create(BusState *bus, const char *name);
 176 DeviceState *qdev_try_create(BusState *bus, const char *name);
 177 int qdev_device_help(QemuOpts *opts);
 178 DeviceState *qdev_device_add(QemuOpts *opts);
 179 int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
 180 void qdev_init_nofail(DeviceState *dev);
 181 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
 182                                  int required_for_version);
 183 int qdev_unplug(DeviceState *dev);
 184 void qdev_free(DeviceState *dev);
 185 int qdev_simple_unplug_cb(DeviceState *dev);
 186 void qdev_machine_creation_done(void);
 187 bool qdev_machine_modified(void);
 188
 189 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
 190 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 191
 192 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
 193
 194 /*** Device API.  ***/
 195
 196 typedef int (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
 197 typedef int (*qdev_event)(DeviceState *dev);
 198 typedef void (*qdev_resetfn)(DeviceState *dev);
 199
 200 struct DeviceInfo {
 201     const char *name;
 202     const char *fw_name;
 203     const char *alias;
 204     const char *desc;
 205     size_t size;
 206     Property *props;
 207     int no_user;
 208
 209     /* callbacks */
 210     qdev_resetfn reset;
 211
 212     /* device state */
 213     const VMStateDescription *vmsd;
 214
 215     /* Private to qdev / bus.  */
 216     qdev_initfn init;
 217     qdev_event unplug;
 218     qdev_event exit;
 219     BusInfo *bus_info;
 220     struct DeviceInfo *next;
 221 };
 222 extern DeviceInfo *device_info_list;
 223
 224 void qdev_register(DeviceInfo *info);
 225
 226 /* Register device properties.  */
 227 /* GPIO inputs also double as IRQ sinks.  */
 228 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 229 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 230
 231 CharDriverState *qdev_init_chardev(DeviceState *dev);
 232
 233 BusState *qdev_get_parent_bus(DeviceState *dev);
 234
 235 /*** BUS API. ***/
 236
 237 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
 238
 239 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
 240 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
 241 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
 242
 243 void qbus_create_inplace(BusState *bus, BusInfo *info,
 244                          DeviceState *parent, const char *name);
 245 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
 246 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
 247  *         < 0 if either devfn or busfn terminate walk somewhere in cursion,
 248  *           0 otherwise. */
 249 int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
 250                        qbus_walkerfn *busfn, void *opaque);
 251 int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
 252                        qbus_walkerfn *busfn, void *opaque);
 253 void qdev_reset_all(DeviceState *dev);
 254 void qbus_reset_all_fn(void *opaque);
 255
 256 void qbus_free(BusState *bus);
 257
 258 #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
 259
 260 /* This should go away once we get rid of the NULL bus hack */
 261 BusState *sysbus_get_default(void);
 262
 263 /*** monitor commands ***/
 264
 265 void do_info_qtree(Monitor *mon);
 266 void do_info_qdm(Monitor *mon);
 267 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data);
 268 int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data);
 269
 270 /*** qdev-properties.c ***/
 271
 272 extern PropertyInfo qdev_prop_bit;
 273 extern PropertyInfo qdev_prop_uint8;
 274 extern PropertyInfo qdev_prop_uint16;
 275 extern PropertyInfo qdev_prop_uint32;
 276 extern PropertyInfo qdev_prop_int32;
 277 extern PropertyInfo qdev_prop_uint64;
 278 extern PropertyInfo qdev_prop_hex8;
 279 extern PropertyInfo qdev_prop_hex32;
 280 extern PropertyInfo qdev_prop_hex64;
 281 extern PropertyInfo qdev_prop_string;
 282 extern PropertyInfo qdev_prop_chr;
 283 extern PropertyInfo qdev_prop_ptr;
 284 extern PropertyInfo qdev_prop_macaddr;
 285 extern PropertyInfo qdev_prop_drive;
 286 extern PropertyInfo qdev_prop_netdev;
 287 extern PropertyInfo qdev_prop_vlan;
 288 extern PropertyInfo qdev_prop_pci_devfn;
 289
 290 #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
 291         .name      = (_name),                                    \
 292         .info      = &(_prop),                                   \
 293         .offset    = offsetof(_state, _field)                    \
 294             + type_check(_type,typeof_field(_state, _field)),    \
 295         }
 296 #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
 297         .name      = (_name),                                           \
 298         .info      = &(_prop),                                          \
 299         .offset    = offsetof(_state, _field)                           \
 300             + type_check(_type,typeof_field(_state, _field)),           \
 301         .defval    = (_type[]) { _defval },                             \
 302         }
 303 #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) {  \
 304         .name      = (_name),                                    \
 305         .info      = &(qdev_prop_bit),                           \
 306         .bitnr    = (_bit),                                      \
 307         .offset    = offsetof(_state, _field)                    \
 308             + type_check(uint32_t,typeof_field(_state, _field)), \
 309         .defval    = (bool[]) { (_defval) },                     \
 310         }
 311
 312 #define DEFINE_PROP_UINT8(_n, _s, _f, _d)                       \
 313     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
 314 #define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
 315     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
 316 #define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
 317     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
 318 #define DEFINE_PROP_INT32(_n, _s, _f, _d)                      \
 319     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
 320 #define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
 321     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
 322 #define DEFINE_PROP_HEX8(_n, _s, _f, _d)                       \
 323     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t)
 324 #define DEFINE_PROP_HEX32(_n, _s, _f, _d)                       \
 325     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
 326 #define DEFINE_PROP_HEX64(_n, _s, _f, _d)                       \
 327     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
 328 #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
 329     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
 330
 331 #define DEFINE_PROP_PTR(_n, _s, _f)             \
 332     DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
 333 #define DEFINE_PROP_CHR(_n, _s, _f)             \
 334     DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
 335 #define DEFINE_PROP_STRING(_n, _s, _f)             \
 336     DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
 337 #define DEFINE_PROP_NETDEV(_n, _s, _f)             \
 338     DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
 339 #define DEFINE_PROP_VLAN(_n, _s, _f)             \
 340     DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
 341 #define DEFINE_PROP_DRIVE(_n, _s, _f) \
 342     DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
 343 #define DEFINE_PROP_MACADDR(_n, _s, _f)         \
 344     DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
 345
 346 #define DEFINE_PROP_END_OF_LIST()               \
 347     {}
 348
 349 /* Set properties between creation and init.  */
 350 void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
 351 int qdev_prop_exists(DeviceState *dev, const char *name);
 352 int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
 353 void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type);
 354 void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value);
 355 void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
 356 void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
 357 void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
 358 void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
 359 void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
 360 void qdev_prop_set_string(DeviceState *dev, const char *name, char *value);
 361 void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
 362 void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value);
 363 void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value);
 364 int qdev_prop_set_drive(DeviceState *dev, const char *name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT;
 365 void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name, BlockDriverState *value);
 366 void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
 367 /* FIXME: Remove opaque pointer properties.  */
 368 void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
 369 void qdev_prop_set_defaults(DeviceState *dev, Property *props);
 370
 371 void qdev_prop_register_global_list(GlobalProperty *props);
 372 void qdev_prop_set_globals(DeviceState *dev);
 373
 374 static inline const char *qdev_fw_name(DeviceState *dev)
 375 {
 376     return dev->info->fw_name ? : dev->info->alias ? : dev->info->name;
 377 }
 378
 379 char *qdev_get_fw_dev_path(DeviceState *dev);
 380 /* This is a nasty hack to allow passing a NULL bus to qdev_create.  */
 381 extern struct BusInfo system_bus_info;
 382
 383 /**
 384  * @qdev_ref
 385  *
 386  * Increase the reference count of a device.  A device cannot be freed as long
 387  * as its reference count is greater than zero.
 388  *
 389  * @dev - the device
 390  */
 391 void qdev_ref(DeviceState *dev);
 392
 393 /**
 394  * @qdef_unref
 395  *
 396  * Decrease the reference count of a device.  A device cannot be freed as long
 397  * as its reference count is greater than zero.
 398  *
 399  * @dev - the device
 400  */
 401 void qdev_unref(DeviceState *dev);
 402
 403 /**
 404  * @qdev_property_add - add a new property to a device
 405  *
 406  * @dev - the device to add a property to
 407  *
 408  * @name - the name of the property.  This can contain any character except for
 409  *         a forward slash.  In general, you should use hyphens '-' instead of
 410  *         underscores '_' when naming properties.
 411  *
 412  * @type - the type name of the property.  This namespace is pretty loosely
 413  *         defined.  Sub namespaces are constructed by using a prefix and then
 414  *         to angle brackets.  For instance, the type 'virtio-net-pci' in the
 415  *         'link' namespace would be 'link<virtio-net-pci>'.
 416  *
 417  * @get - the getter to be called to read a property.  If this is NULL, then
 418  *        the property cannot be read.
 419  *
 420  * @set - the setter to be called to write a property.  If this is NULL,
 421  *        then the property cannot be written.
 422  *
 423  * @release - called when the property is removed from the device.  This is
 424  *            meant to allow a property to free its opaque upon device
 425  *            destruction.  This may be NULL.
 426  *
 427  * @opaque - an opaque pointer to pass to the callbacks for the property
 428  *
 429  * @errp - returns an error if this function fails
 430  */
 431 void qdev_property_add(DeviceState *dev, const char *name, const char *type,
 432                        DevicePropertyAccessor *get, DevicePropertyAccessor *set,
 433                        DevicePropertyRelease *release,
 434                        void *opaque, Error **errp);
 435
 436 /**
 437  * @qdev_property_get - reads a property from a device
 438  *
 439  * @dev - the device
 440  *
 441  * @v - the visitor that will receive the property value.  This should be an
 442  *      Output visitor and the data will be written with @name as the name.
 443  *
 444  * @name - the name of the property
 445  *
 446  * @errp - returns an error if this function fails
 447  */
 448 void qdev_property_get(DeviceState *dev, Visitor *v, const char *name,
 449                        Error **errp);
 450
 451 /**
 452  * @qdev_property_set - writes a property to a device
 453  *
 454  * @dev - the device
 455  *
 456  * @v - the visitor that will be used to write the property value.  This should
 457  *      be an Input visitor and the data will be first read with @name as the
 458  *      name and then written as the property value.
 459  *
 460  * @name - the name of the property
 461  *
 462  * @errp - returns an error if this function fails
 463  */
 464 void qdev_property_set(DeviceState *dev, Visitor *v, const char *name,
 465                        Error **errp);
 466
 467 /**
 468  * @qdev_property_get_type - returns the type of a property
 469  *
 470  * @dev - the device
 471  *
 472  * @name - the name of the property
 473  *
 474  * @errp - returns an error if this function fails
 475  *
 476  * Returns:
 477  *   The type name of the property.
 478  */
 479 const char *qdev_property_get_type(DeviceState *dev, const char *name,
 480                                    Error **errp);
 481
 482 /**
 483  * @qdev_property_add_legacy - add a legacy @Property to a device
 484  *
 485  * DO NOT USE THIS IN NEW CODE!
 486  */
 487 void qdev_property_add_legacy(DeviceState *dev, Property *prop, Error **errp);
 488
 489 /**
 490  * @qdev_get_root - returns the root device of the composition tree
 491  *
 492  * Returns:
 493  *   The root of the composition tree.
 494  */
 495 DeviceState *qdev_get_root(void);
 496
 497 /**
 498  * @qdev_get_canonical_path - returns the canonical path for a device.  This
 499  * is the path within the composition tree starting from the root.
 500  *
 501  * Returns:
 502  *   The canonical path in the composition tree.
 503  */
 504 gchar *qdev_get_canonical_path(DeviceState *dev);
 505
 506 /**
 507  * @qdev_resolve_path - resolves a path returning a device
 508  *
 509  * There are two types of supported paths--absolute paths and partial paths.
 510  *
 511  * Absolute paths are derived from the root device and can follow child<> or
 512  * link<> properties.  Since they can follow link<> properties, they can be
 513  * arbitrarily long.  Absolute paths look like absolute filenames and are
 514  * prefixed with a leading slash.
 515  *
 516  * Partial paths look like relative filenames.  They do not begin with a
 517  * prefix.  The matching rules for partial paths are subtle but designed to make
 518  * specifying devices easy.  At each level of the composition tree, the partial
 519  * path is matched as an absolute path.  The first match is not returned.  At
 520  * least two matches are searched for.  A successful result is only returned if
 521  * only one match is founded.  If more than one match is found, a flag is
 522  * return to indicate that the match was ambiguous.
 523  *
 524  * @path - the path to resolve
 525  *
 526  * @ambiguous - returns true if the path resolution failed because of an
 527  *              ambiguous match
 528  *
 529  * Returns:
 530  *   The matched device or NULL on path lookup failure.
 531  */
 532 DeviceState *qdev_resolve_path(const char *path, bool *ambiguous);
 533
 534 /**
 535  * @qdev_property_add_child - Add a child property to a device
 536  *
 537  * Child properties form the composition tree.  All devices need to be a child
 538  * of another device.  Devices can only be a child of one device.
 539  *
 540  * There is no way for a child to determine what its parent is.  It is not
 541  * a bidirectional relationship.  This is by design.
 542  *
 543  * @dev - the device to add a property to
 544  *
 545  * @name - the name of the property
 546  *
 547  * @child - the child device
 548  *
 549  * @errp - if an error occurs, a pointer to an area to store the area
 550  */
 551 void qdev_property_add_child(DeviceState *dev, const char *name,
 552                              DeviceState *child, Error **errp);
 553
 554 /**
 555  * @qdev_property_add_link - Add a link property to a device
 556  *
 557  * Links establish relationships between devices.  Links are unidirectional
 558  * although two links can be combined to form a bidirectional relationship
 559  * between devices.
 560  *
 561  * Links form the graph in the device model.
 562  *
 563  * @dev - the device to add a property to
 564  *
 565  * @name - the name of the property
 566  *
 567  * @type - the qdev type of the link
 568  *
 569  * @child - a pointer to where the link device reference is stored
 570  *
 571  * @errp - if an error occurs, a pointer to an area to store the area
 572  */
 573 void qdev_property_add_link(DeviceState *dev, const char *name,
 574                             const char *type, DeviceState **child,
 575                             Error **errp);
 576
 577 #endif