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/bitmap.h"
   7 #include "qom/object.h"
   8 #include "hw/irq.h"
   9 #include "hw/hotplug.h"
  10
  11 enum {
  12     DEV_NVECTORS_UNSPECIFIED = -1,
  13 };
  14
  15 #define TYPE_DEVICE "device"
  16 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
  17 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
  18 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
  19
  20 typedef enum DeviceCategory {
  21     DEVICE_CATEGORY_BRIDGE,
  22     DEVICE_CATEGORY_USB,
  23     DEVICE_CATEGORY_STORAGE,
  24     DEVICE_CATEGORY_NETWORK,
  25     DEVICE_CATEGORY_INPUT,
  26     DEVICE_CATEGORY_DISPLAY,
  27     DEVICE_CATEGORY_SOUND,
  28     DEVICE_CATEGORY_MISC,
  29     DEVICE_CATEGORY_CPU,
  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      * Can this device be instantiated with -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; clearing this flag will protect them.
 112      * It should never be cleared without a comment explaining why it
 113      * is cleared.
 114      * TODO remove once we're there
 115      */
 116     bool user_creatable;
 117     bool hotpluggable;
 118
 119     /* callbacks */
 120     void (*reset)(DeviceState *dev);
 121     DeviceRealize realize;
 122     DeviceUnrealize unrealize;
 123
 124     /* device state */
 125     const struct VMStateDescription *vmsd;
 126
 127     /* Private to qdev / bus.  */
 128     qdev_initfn init; /* TODO remove, once users are converted to realize */
 129     qdev_event exit; /* TODO remove, once users are converted to unrealize */
 130     const char *bus_type;
 131 } DeviceClass;
 132
 133 typedef struct NamedGPIOList NamedGPIOList;
 134
 135 struct NamedGPIOList {
 136     char *name;
 137     qemu_irq *in;
 138     int num_in;
 139     int num_out;
 140     QLIST_ENTRY(NamedGPIOList) node;
 141 };
 142
 143 /**
 144  * DeviceState:
 145  * @realized: Indicates whether the device has been fully constructed.
 146  *
 147  * This structure should not be accessed directly.  We declare it here
 148  * so that it can be embedded in individual device state structures.
 149  */
 150 struct DeviceState {
 151     /*< private >*/
 152     Object parent_obj;
 153     /*< public >*/
 154
 155     const char *id;
 156     bool realized;
 157     bool pending_deleted_event;
 158     QemuOpts *opts;
 159     int hotplugged;
 160     BusState *parent_bus;
 161     QLIST_HEAD(, NamedGPIOList) gpios;
 162     QLIST_HEAD(, BusState) child_bus;
 163     int num_child_bus;
 164     int instance_id_alias;
 165     int alias_required_for_version;
 166 };
 167
 168 struct DeviceListener {
 169     void (*realize)(DeviceListener *listener, DeviceState *dev);
 170     void (*unrealize)(DeviceListener *listener, DeviceState *dev);
 171     QTAILQ_ENTRY(DeviceListener) link;
 172 };
 173
 174 #define TYPE_BUS "bus"
 175 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
 176 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
 177 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
 178
 179 struct BusClass {
 180     ObjectClass parent_class;
 181
 182     /* FIXME first arg should be BusState */
 183     void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
 184     char *(*get_dev_path)(DeviceState *dev);
 185     /*
 186      * This callback is used to create Open Firmware device path in accordance
 187      * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
 188      * bindings can be found at http://playground.sun.com/1275/bindings/.
 189      */
 190     char *(*get_fw_dev_path)(DeviceState *dev);
 191     void (*reset)(BusState *bus);
 192     BusRealize realize;
 193     BusUnrealize unrealize;
 194
 195     /* maximum devices allowed on the bus, 0: no limit. */
 196     int max_dev;
 197     /* number of automatically allocated bus ids (e.g. ide.0) */
 198     int automatic_ids;
 199 };
 200
 201 typedef struct BusChild {
 202     DeviceState *child;
 203     int index;
 204     QTAILQ_ENTRY(BusChild) sibling;
 205 } BusChild;
 206
 207 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
 208
 209 /**
 210  * BusState:
 211  * @hotplug_device: link to a hotplug device associated with bus.
 212  */
 213 struct BusState {
 214     Object obj;
 215     DeviceState *parent;
 216     char *name;
 217     HotplugHandler *hotplug_handler;
 218     int max_index;
 219     bool realized;
 220     QTAILQ_HEAD(ChildrenHead, BusChild) children;
 221     QLIST_ENTRY(BusState) sibling;
 222 };
 223
 224 /**
 225  * Property:
 226  * @set_default: true if the default value should be set from @defval,
 227  *    in which case @info->set_default_value must not be NULL
 228  *    (if false then no default value is set by the property system
 229  *     and the field retains whatever value it was given by instance_init).
 230  * @defval: default value for the property. This is used only if @set_default
 231  *     is true.
 232  */
 233 struct Property {
 234     const char   *name;
 235     const PropertyInfo *info;
 236     ptrdiff_t    offset;
 237     uint8_t      bitnr;
 238     bool         set_default;
 239     union {
 240         int64_t i;
 241         uint64_t u;
 242     } defval;
 243     int          arrayoffset;
 244     const PropertyInfo *arrayinfo;
 245     int          arrayfieldsize;
 246     const char   *link_type;
 247 };
 248
 249 struct PropertyInfo {
 250     const char *name;
 251     const char *description;
 252     const char * const *enum_table;
 253     int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
 254     void (*set_default_value)(Object *obj, const Property *prop);
 255     void (*create)(Object *obj, Property *prop, Error **errp);
 256     ObjectPropertyAccessor *get;
 257     ObjectPropertyAccessor *set;
 258     ObjectPropertyRelease *release;
 259 };
 260
 261 /**
 262  * GlobalProperty:
 263  * @user_provided: Set to true if property comes from user-provided config
 264  * (command-line or config file).
 265  * @used: Set to true if property was used when initializing a device.
 266  * @errp: Error destination, used like first argument of error_setg()
 267  *        in case property setting fails later. If @errp is NULL, we
 268  *        print warnings instead of ignoring errors silently. For
 269  *        hotplugged devices, errp is always ignored and warnings are
 270  *        printed instead.
 271  */
 272 typedef struct GlobalProperty {
 273     const char *driver;
 274     const char *property;
 275     const char *value;
 276     bool user_provided;
 277     bool used;
 278     Error **errp;
 279 } GlobalProperty;
 280
 281 /*** Board API.  This should go away once we have a machine config file.  ***/
 282
 283 DeviceState *qdev_create(BusState *bus, const char *name);
 284 DeviceState *qdev_try_create(BusState *bus, const char *name);
 285 void qdev_init_nofail(DeviceState *dev);
 286 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
 287                                  int required_for_version);
 288 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
 289 void qdev_unplug(DeviceState *dev, Error **errp);
 290 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
 291                                   DeviceState *dev, Error **errp);
 292 void qdev_machine_creation_done(void);
 293 bool qdev_machine_modified(void);
 294
 295 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
 296 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
 297
 298 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 299 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
 300                                  qemu_irq pin);
 301 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
 302 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
 303                                  const char *name, int n);
 304
 305 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
 306
 307 /*** Device API.  ***/
 308
 309 /* Register device properties.  */
 310 /* GPIO inputs also double as IRQ sinks.  */
 311 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 312 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 313 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
 314                              const char *name, int n);
 315 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
 316                               const char *name, int n);
 317
 318 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
 319                      const char *name);
 320
 321 BusState *qdev_get_parent_bus(DeviceState *dev);
 322
 323 /*** BUS API. ***/
 324
 325 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
 326
 327 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
 328 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
 329 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
 330
 331 void qbus_create_inplace(void *bus, size_t size, const char *typename,
 332                          DeviceState *parent, const char *name);
 333 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
 334 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
 335  *         < 0 if either devfn or busfn terminate walk somewhere in cursion,
 336  *           0 otherwise. */
 337 int qbus_walk_children(BusState *bus,
 338                        qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
 339                        qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
 340                        void *opaque);
 341 int qdev_walk_children(DeviceState *dev,
 342                        qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
 343                        qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
 344                        void *opaque);
 345
 346 void qdev_reset_all(DeviceState *dev);
 347 void qdev_reset_all_fn(void *opaque);
 348
 349 /**
 350  * @qbus_reset_all:
 351  * @bus: Bus to be reset.
 352  *
 353  * Reset @bus and perform a bus-level ("hard") reset of all devices connected
 354  * to it, including recursive processing of all buses below @bus itself.  A
 355  * hard reset means that qbus_reset_all will reset all state of the device.
 356  * For PCI devices, for example, this will include the base address registers
 357  * or configuration space.
 358  */
 359 void qbus_reset_all(BusState *bus);
 360 void qbus_reset_all_fn(void *opaque);
 361
 362 /* This should go away once we get rid of the NULL bus hack */
 363 BusState *sysbus_get_default(void);
 364
 365 char *qdev_get_fw_dev_path(DeviceState *dev);
 366 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
 367
 368 /**
 369  * @qdev_machine_init
 370  *
 371  * Initialize platform devices before machine init.  This is a hack until full
 372  * support for composition is added.
 373  */
 374 void qdev_machine_init(void);
 375
 376 /**
 377  * @device_reset
 378  *
 379  * Reset a single device (by calling the reset method).
 380  */
 381 void device_reset(DeviceState *dev);
 382
 383 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
 384
 385 const char *qdev_fw_name(DeviceState *dev);
 386
 387 Object *qdev_get_machine(void);
 388
 389 /* FIXME: make this a link<> */
 390 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
 391
 392 extern bool qdev_hotplug;
 393 extern bool qdev_hot_removed;
 394
 395 char *qdev_get_dev_path(DeviceState *dev);
 396
 397 GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
 398
 399 void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
 400                               Error **errp);
 401
 402 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
 403
 404 static inline bool qbus_is_hotpluggable(BusState *bus)
 405 {
 406    return bus->hotplug_handler;
 407 }
 408
 409 void device_listener_register(DeviceListener *listener);
 410 void device_listener_unregister(DeviceListener *listener);
 411
 412 #endif