include/hw/qdev-core.h

   1 #ifndef QDEV_CORE_H
   2 #define QDEV_CORE_H
   3
   4 #include "qemu/queue.h"
   5 #include "qemu/option.h"
   6 #include "qemu/typedefs.h"
   7 #include "qemu/bitmap.h"
   8 #include "qom/object.h"
   9 #include "hw/irq.h"
  10 #include "hw/hotplug.h"
  11
  12 enum {
  13     DEV_NVECTORS_UNSPECIFIED = -1,
  14 };
  15
  16 #define TYPE_DEVICE "device"
  17 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
  18 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
  19 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
  20
  21 typedef enum DeviceCategory {
  22     DEVICE_CATEGORY_BRIDGE,
  23     DEVICE_CATEGORY_USB,
  24     DEVICE_CATEGORY_STORAGE,
  25     DEVICE_CATEGORY_NETWORK,
  26     DEVICE_CATEGORY_INPUT,
  27     DEVICE_CATEGORY_DISPLAY,
  28     DEVICE_CATEGORY_SOUND,
  29     DEVICE_CATEGORY_MISC,
  30     DEVICE_CATEGORY_MAX
  31 } DeviceCategory;
  32
  33 typedef int (*qdev_initfn)(DeviceState *dev);
  34 typedef int (*qdev_event)(DeviceState *dev);
  35 typedef void (*qdev_resetfn)(DeviceState *dev);
  36 typedef void (*DeviceRealize)(DeviceState *dev, Error **errp);
  37 typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp);
  38 typedef void (*BusRealize)(BusState *bus, Error **errp);
  39 typedef void (*BusUnrealize)(BusState *bus, Error **errp);
  40
  41 struct VMStateDescription;
  42
  43 /**
  44  * DeviceClass:
  45  * @props: Properties accessing state fields.
  46  * @realize: Callback function invoked when the #DeviceState:realized
  47  * property is changed to %true. The default invokes @init if not %NULL.
  48  * @unrealize: Callback function invoked when the #DeviceState:realized
  49  * property is changed to %false.
  50  * @init: Callback function invoked when the #DeviceState::realized property
  51  * is changed to %true. Deprecated, new types inheriting directly from
  52  * TYPE_DEVICE should use @realize instead, new leaf types should consult
  53  * their respective parent type.
  54  * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
  55  * as readonly "hotpluggable" property of #DeviceState instance
  56  *
  57  * # Realization #
  58  * Devices are constructed in two stages,
  59  * 1) object instantiation via object_initialize() and
  60  * 2) device realization via #DeviceState:realized property.
  61  * The former may not fail (it might assert or exit), the latter may return
  62  * error information to the caller and must be re-entrant.
  63  * Trivial field initializations should go into #TypeInfo.instance_init.
  64  * Operations depending on @props static properties should go into @realize.
  65  * After successful realization, setting static properties will fail.
  66  *
  67  * As an interim step, the #DeviceState:realized property can also be
  68  * set with qdev_init_nofail().
  69  * In the future, devices will propagate this state change to their children
  70  * and along busses they expose.
  71  * The point in time will be deferred to machine creation, so that values
  72  * set in @realize will not be introspectable beforehand. Therefore devices
  73  * must not create children during @realize; they should initialize them via
  74  * object_initialize() in their own #TypeInfo.instance_init and forward the
  75  * realization events appropriately.
  76  *
  77  * The @init callback is considered private to a particular bus implementation
  78  * (immediate abstract child types of TYPE_DEVICE). Derived leaf types set an
  79  * "init" callback on their parent class instead.
  80  *
  81  * Any type may override the @realize and/or @unrealize callbacks but needs
  82  * to call the parent type's implementation if keeping their functionality
  83  * is desired. Refer to QOM documentation for further discussion and examples.
  84  *
  85  * <note>
  86  *   <para>
  87  * If a type derived directly from TYPE_DEVICE implements @realize, it does
  88  * not need to implement @init and therefore does not need to store and call
  89  * #DeviceClass' default @realize callback.
  90  * For other types consult the documentation and implementation of the
  91  * respective parent types.
  92  *   </para>
  93  * </note>
  94  */
  95 typedef struct DeviceClass {
  96     /*< private >*/
  97     ObjectClass parent_class;
  98     /*< public >*/
  99
 100     DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
 101     const char *fw_name;
 102     const char *desc;
 103     Property *props;
 104
 105     /*
 106      * Shall we hide this device model from -device / device_add?
 107      * All devices should support instantiation with device_add, and
 108      * this flag should not exist.  But we're not there, yet.  Some
 109      * devices fail to instantiate with cryptic error messages.
 110      * Others instantiate, but don't work.  Exposing users to such
 111      * behavior would be cruel; this flag serves to protect them.  It
 112      * should never be set without a comment explaining why it is set.
 113      * TODO remove once we're there
 114      */
 115     bool cannot_instantiate_with_device_add_yet;
 116     /*
 117      * Does this device model survive object_unref(object_new(TNAME))?
 118      * All device models should, and this flag shouldn't exist.  Some
 119      * devices crash in object_new(), some crash or hang in
 120      * object_unref().  Makes introspecting properties with
 121      * qmp_device_list_properties() dangerous.  Bad, because it's used
 122      * by -device FOO,help.  This flag serves to protect that code.
 123      * It should never be set without a comment explaining why it is
 124      * set.
 125      * TODO remove once we're there
 126      */
 127     bool cannot_destroy_with_object_finalize_yet;
 128
 129     bool hotpluggable;
 130
 131     /* callbacks */
 132     void (*reset)(DeviceState *dev);
 133     DeviceRealize realize;
 134     DeviceUnrealize unrealize;
 135
 136     /* device state */
 137     const struct VMStateDescription *vmsd;
 138
 139     /* Private to qdev / bus.  */
 140     qdev_initfn init; /* TODO remove, once users are converted to realize */
 141     qdev_event exit; /* TODO remove, once users are converted to unrealize */
 142     const char *bus_type;
 143 } DeviceClass;
 144
 145 typedef struct NamedGPIOList NamedGPIOList;
 146
 147 struct NamedGPIOList {
 148     char *name;
 149     qemu_irq *in;
 150     int num_in;
 151     int num_out;
 152     QLIST_ENTRY(NamedGPIOList) node;
 153 };
 154
 155 /**
 156  * DeviceState:
 157  * @realized: Indicates whether the device has been fully constructed.
 158  *
 159  * This structure should not be accessed directly.  We declare it here
 160  * so that it can be embedded in individual device state structures.
 161  */
 162 struct DeviceState {
 163     /*< private >*/
 164     Object parent_obj;
 165     /*< public >*/
 166
 167     const char *id;
 168     bool realized;
 169     bool pending_deleted_event;
 170     QemuOpts *opts;
 171     int hotplugged;
 172     BusState *parent_bus;
 173     QLIST_HEAD(, NamedGPIOList) gpios;
 174     QLIST_HEAD(, BusState) child_bus;
 175     int num_child_bus;
 176     int instance_id_alias;
 177     int alias_required_for_version;
 178 };
 179
 180 struct DeviceListener {
 181     void (*realize)(DeviceListener *listener, DeviceState *dev);
 182     void (*unrealize)(DeviceListener *listener, DeviceState *dev);
 183     QTAILQ_ENTRY(DeviceListener) link;
 184 };
 185
 186 #define TYPE_BUS "bus"
 187 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
 188 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
 189 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
 190
 191 struct BusClass {
 192     ObjectClass parent_class;
 193
 194     /* FIXME first arg should be BusState */
 195     void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
 196     char *(*get_dev_path)(DeviceState *dev);
 197     /*
 198      * This callback is used to create Open Firmware device path in accordance
 199      * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
 200      * bindings can be found at http://playground.sun.com/1275/bindings/.
 201      */
 202     char *(*get_fw_dev_path)(DeviceState *dev);
 203     void (*reset)(BusState *bus);
 204     BusRealize realize;
 205     BusUnrealize unrealize;
 206
 207     /* maximum devices allowed on the bus, 0: no limit. */
 208     int max_dev;
 209     /* number of automatically allocated bus ids (e.g. ide.0) */
 210     int automatic_ids;
 211 };
 212
 213 typedef struct BusChild {
 214     DeviceState *child;
 215     int index;
 216     QTAILQ_ENTRY(BusChild) sibling;
 217 } BusChild;
 218
 219 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
 220
 221 /**
 222  * BusState:
 223  * @hotplug_device: link to a hotplug device associated with bus.
 224  */
 225 struct BusState {
 226     Object obj;
 227     DeviceState *parent;
 228     const char *name;
 229     HotplugHandler *hotplug_handler;
 230     int max_index;
 231     bool realized;
 232     QTAILQ_HEAD(ChildrenHead, BusChild) children;
 233     QLIST_ENTRY(BusState) sibling;
 234 };
 235
 236 struct Property {
 237     const char   *name;
 238     PropertyInfo *info;
 239     ptrdiff_t    offset;
 240     uint8_t      bitnr;
 241     QType        qtype;
 242     int64_t      defval;
 243     int          arrayoffset;
 244     PropertyInfo *arrayinfo;
 245     int          arrayfieldsize;
 246 };
 247
 248 struct PropertyInfo {
 249     const char *name;
 250     const char *description;
 251     const char * const *enum_table;
 252     int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
 253     ObjectPropertyAccessor *get;
 254     ObjectPropertyAccessor *set;
 255     ObjectPropertyRelease *release;
 256 };
 257
 258 /**
 259  * GlobalProperty:
 260  * @user_provided: Set to true if property comes from user-provided config
 261  * (command-line or config file).
 262  * @used: Set to true if property was used when initializing a device.
 263  */
 264 typedef struct GlobalProperty {
 265     const char *driver;
 266     const char *property;
 267     const char *value;
 268     bool user_provided;
 269     bool used;
 270     QTAILQ_ENTRY(GlobalProperty) next;
 271 } GlobalProperty;
 272
 273 /*** Board API.  This should go away once we have a machine config file.  ***/
 274
 275 DeviceState *qdev_create(BusState *bus, const char *name);
 276 DeviceState *qdev_try_create(BusState *bus, const char *name);
 277 void qdev_init_nofail(DeviceState *dev);
 278 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
 279                                  int required_for_version);
 280 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
 281 void qdev_unplug(DeviceState *dev, Error **errp);
 282 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
 283                                   DeviceState *dev, Error **errp);
 284 void qdev_machine_creation_done(void);
 285 bool qdev_machine_modified(void);
 286
 287 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
 288 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
 289
 290 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 291 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
 292                                  qemu_irq pin);
 293 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
 294 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
 295                                  const char *name, int n);
 296
 297 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
 298
 299 /*** Device API.  ***/
 300
 301 /* Register device properties.  */
 302 /* GPIO inputs also double as IRQ sinks.  */
 303 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 304 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 305 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
 306                              const char *name, int n);
 307 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
 308                               const char *name, int n);
 309
 310 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
 311                      const char *name);
 312
 313 BusState *qdev_get_parent_bus(DeviceState *dev);
 314
 315 /*** BUS API. ***/
 316
 317 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
 318
 319 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
 320 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
 321 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
 322
 323 void qbus_create_inplace(void *bus, size_t size, const char *typename,
 324                          DeviceState *parent, const char *name);
 325 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
 326 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
 327  *         < 0 if either devfn or busfn terminate walk somewhere in cursion,
 328  *           0 otherwise. */
 329 int qbus_walk_children(BusState *bus,
 330                        qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
 331                        qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
 332                        void *opaque);
 333 int qdev_walk_children(DeviceState *dev,
 334                        qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
 335                        qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
 336                        void *opaque);
 337
 338 void qdev_reset_all(DeviceState *dev);
 339 void qdev_reset_all_fn(void *opaque);
 340
 341 /**
 342  * @qbus_reset_all:
 343  * @bus: Bus to be reset.
 344  *
 345  * Reset @bus and perform a bus-level ("hard") reset of all devices connected
 346  * to it, including recursive processing of all buses below @bus itself.  A
 347  * hard reset means that qbus_reset_all will reset all state of the device.
 348  * For PCI devices, for example, this will include the base address registers
 349  * or configuration space.
 350  */
 351 void qbus_reset_all(BusState *bus);
 352 void qbus_reset_all_fn(void *opaque);
 353
 354 /* This should go away once we get rid of the NULL bus hack */
 355 BusState *sysbus_get_default(void);
 356
 357 char *qdev_get_fw_dev_path(DeviceState *dev);
 358 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
 359
 360 /**
 361  * @qdev_machine_init
 362  *
 363  * Initialize platform devices before machine init.  This is a hack until full
 364  * support for composition is added.
 365  */
 366 void qdev_machine_init(void);
 367
 368 /**
 369  * @device_reset
 370  *
 371  * Reset a single device (by calling the reset method).
 372  */
 373 void device_reset(DeviceState *dev);
 374
 375 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
 376
 377 const char *qdev_fw_name(DeviceState *dev);
 378
 379 Object *qdev_get_machine(void);
 380
 381 /* FIXME: make this a link<> */
 382 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
 383
 384 extern int qdev_hotplug;
 385
 386 char *qdev_get_dev_path(DeviceState *dev);
 387
 388 GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
 389
 390 void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
 391                               Error **errp);
 392
 393 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
 394
 395 static inline bool qbus_is_hotpluggable(BusState *bus)
 396 {
 397    return bus->hotplug_handler;
 398 }
 399
 400 void device_listener_register(DeviceListener *listener);
 401 void device_listener_unregister(DeviceListener *listener);
 402
 403 #endif