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