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