qdev: New qdev_new(), qdev_realize(), etc.
[qemu.git] / include / hw / qdev-core.h
1 #ifndef QDEV_CORE_H
2 #define QDEV_CORE_H
3
4 #include "qemu/queue.h"
5 #include "qemu/bitmap.h"
6 #include "qom/object.h"
7 #include "hw/hotplug.h"
8 #include "hw/resettable.h"
9
10 enum {
11 DEV_NVECTORS_UNSPECIFIED = -1,
12 };
13
14 #define TYPE_DEVICE "device"
15 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
16 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
17 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
18
19 typedef enum DeviceCategory {
20 DEVICE_CATEGORY_BRIDGE,
21 DEVICE_CATEGORY_USB,
22 DEVICE_CATEGORY_STORAGE,
23 DEVICE_CATEGORY_NETWORK,
24 DEVICE_CATEGORY_INPUT,
25 DEVICE_CATEGORY_DISPLAY,
26 DEVICE_CATEGORY_SOUND,
27 DEVICE_CATEGORY_MISC,
28 DEVICE_CATEGORY_CPU,
29 DEVICE_CATEGORY_MAX
30 } DeviceCategory;
31
32 typedef void (*DeviceRealize)(DeviceState *dev, Error **errp);
33 typedef void (*DeviceUnrealize)(DeviceState *dev);
34 typedef void (*DeviceReset)(DeviceState *dev);
35 typedef void (*BusRealize)(BusState *bus, Error **errp);
36 typedef void (*BusUnrealize)(BusState *bus);
37
38 /**
39 * DeviceClass:
40 * @props: Properties accessing state fields.
41 * @realize: Callback function invoked when the #DeviceState:realized
42 * property is changed to %true.
43 * @unrealize: Callback function invoked when the #DeviceState:realized
44 * property is changed to %false.
45 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
46 * as readonly "hotpluggable" property of #DeviceState instance
47 *
48 * # Realization #
49 * Devices are constructed in two stages,
50 * 1) object instantiation via object_initialize() and
51 * 2) device realization via #DeviceState:realized property.
52 * The former may not fail (and must not abort or exit, since it is called
53 * during device introspection already), and the latter may return error
54 * information to the caller and must be re-entrant.
55 * Trivial field initializations should go into #TypeInfo.instance_init.
56 * Operations depending on @props static properties should go into @realize.
57 * After successful realization, setting static properties will fail.
58 *
59 * As an interim step, the #DeviceState:realized property can also be
60 * set with qdev_realize() or qdev_init_nofail().
61 * In the future, devices will propagate this state change to their children
62 * and along busses they expose.
63 * The point in time will be deferred to machine creation, so that values
64 * set in @realize will not be introspectable beforehand. Therefore devices
65 * must not create children during @realize; they should initialize them via
66 * object_initialize() in their own #TypeInfo.instance_init and forward the
67 * realization events appropriately.
68 *
69 * Any type may override the @realize and/or @unrealize callbacks but needs
70 * to call the parent type's implementation if keeping their functionality
71 * is desired. Refer to QOM documentation for further discussion and examples.
72 *
73 * <note>
74 * <para>
75 * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types
76 * derived directly from it need not call their parent's @realize and
77 * @unrealize.
78 * For other types consult the documentation and implementation of the
79 * respective parent types.
80 * </para>
81 * </note>
82 *
83 * # Hiding a device #
84 * To hide a device, a DeviceListener function should_be_hidden() needs to
85 * be registered.
86 * It can be used to defer adding a device and therefore hide it from the
87 * guest. The handler registering to this DeviceListener can save the QOpts
88 * passed to it for re-using it later and must return that it wants the device
89 * to be/remain hidden or not. When the handler function decides the device
90 * shall not be hidden it will be added in qdev_device_add() and
91 * realized as any other device. Otherwise qdev_device_add() will return early
92 * without adding the device. The guest will not see a "hidden" device
93 * until it was marked don't hide and qdev_device_add called again.
94 *
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
105 /*
106 * The underscore at the end ensures a compile-time error if someone
107 * assigns to dc->props instead of using device_class_set_props.
108 */
109 Property *props_;
110
111 /*
112 * Can this device be instantiated with -device / device_add?
113 * All devices should support instantiation with device_add, and
114 * this flag should not exist. But we're not there, yet. Some
115 * devices fail to instantiate with cryptic error messages.
116 * Others instantiate, but don't work. Exposing users to such
117 * behavior would be cruel; clearing this flag will protect them.
118 * It should never be cleared without a comment explaining why it
119 * is cleared.
120 * TODO remove once we're there
121 */
122 bool user_creatable;
123 bool hotpluggable;
124
125 /* callbacks */
126 /*
127 * Reset method here is deprecated and replaced by methods in the
128 * resettable class interface to implement a multi-phase reset.
129 * TODO: remove once every reset callback is unused
130 */
131 DeviceReset reset;
132 DeviceRealize realize;
133 DeviceUnrealize unrealize;
134
135 /* device state */
136 const VMStateDescription *vmsd;
137
138 /* Private to qdev / bus. */
139 const char *bus_type;
140 } DeviceClass;
141
142 typedef struct NamedGPIOList NamedGPIOList;
143
144 struct NamedGPIOList {
145 char *name;
146 qemu_irq *in;
147 int num_in;
148 int num_out;
149 QLIST_ENTRY(NamedGPIOList) node;
150 };
151
152 typedef struct Clock Clock;
153 typedef struct NamedClockList NamedClockList;
154
155 struct NamedClockList {
156 char *name;
157 Clock *clock;
158 bool output;
159 bool alias;
160 QLIST_ENTRY(NamedClockList) node;
161 };
162
163 /**
164 * DeviceState:
165 * @realized: Indicates whether the device has been fully constructed.
166 * @reset: ResettableState for the device; handled by Resettable interface.
167 *
168 * This structure should not be accessed directly. We declare it here
169 * so that it can be embedded in individual device state structures.
170 */
171 struct DeviceState {
172 /*< private >*/
173 Object parent_obj;
174 /*< public >*/
175
176 const char *id;
177 char *canonical_path;
178 bool realized;
179 bool pending_deleted_event;
180 QemuOpts *opts;
181 int hotplugged;
182 bool allow_unplug_during_migration;
183 BusState *parent_bus;
184 QLIST_HEAD(, NamedGPIOList) gpios;
185 QLIST_HEAD(, NamedClockList) clocks;
186 QLIST_HEAD(, BusState) child_bus;
187 int num_child_bus;
188 int instance_id_alias;
189 int alias_required_for_version;
190 ResettableState reset;
191 };
192
193 struct DeviceListener {
194 void (*realize)(DeviceListener *listener, DeviceState *dev);
195 void (*unrealize)(DeviceListener *listener, DeviceState *dev);
196 /*
197 * This callback is called upon init of the DeviceState and allows to
198 * inform qdev that a device should be hidden, depending on the device
199 * opts, for example, to hide a standby device.
200 */
201 int (*should_be_hidden)(DeviceListener *listener, QemuOpts *device_opts);
202 QTAILQ_ENTRY(DeviceListener) link;
203 };
204
205 #define TYPE_BUS "bus"
206 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
207 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
208 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
209
210 struct BusClass {
211 ObjectClass parent_class;
212
213 /* FIXME first arg should be BusState */
214 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
215 char *(*get_dev_path)(DeviceState *dev);
216 /*
217 * This callback is used to create Open Firmware device path in accordance
218 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
219 * bindings can be found at http://playground.sun.com/1275/bindings/.
220 */
221 char *(*get_fw_dev_path)(DeviceState *dev);
222 void (*reset)(BusState *bus);
223 BusRealize realize;
224 BusUnrealize unrealize;
225
226 /* maximum devices allowed on the bus, 0: no limit. */
227 int max_dev;
228 /* number of automatically allocated bus ids (e.g. ide.0) */
229 int automatic_ids;
230 };
231
232 typedef struct BusChild {
233 DeviceState *child;
234 int index;
235 QTAILQ_ENTRY(BusChild) sibling;
236 } BusChild;
237
238 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
239
240 /**
241 * BusState:
242 * @hotplug_handler: link to a hotplug handler associated with bus.
243 * @reset: ResettableState for the bus; handled by Resettable interface.
244 */
245 struct BusState {
246 Object obj;
247 DeviceState *parent;
248 char *name;
249 HotplugHandler *hotplug_handler;
250 int max_index;
251 bool realized;
252 int num_children;
253 QTAILQ_HEAD(, BusChild) children;
254 QLIST_ENTRY(BusState) sibling;
255 ResettableState reset;
256 };
257
258 /**
259 * Property:
260 * @set_default: true if the default value should be set from @defval,
261 * in which case @info->set_default_value must not be NULL
262 * (if false then no default value is set by the property system
263 * and the field retains whatever value it was given by instance_init).
264 * @defval: default value for the property. This is used only if @set_default
265 * is true.
266 */
267 struct Property {
268 const char *name;
269 const PropertyInfo *info;
270 ptrdiff_t offset;
271 uint8_t bitnr;
272 bool set_default;
273 union {
274 int64_t i;
275 uint64_t u;
276 } defval;
277 int arrayoffset;
278 const PropertyInfo *arrayinfo;
279 int arrayfieldsize;
280 const char *link_type;
281 };
282
283 struct PropertyInfo {
284 const char *name;
285 const char *description;
286 const QEnumLookup *enum_table;
287 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
288 void (*set_default_value)(ObjectProperty *op, const Property *prop);
289 void (*create)(ObjectClass *oc, Property *prop);
290 ObjectPropertyAccessor *get;
291 ObjectPropertyAccessor *set;
292 ObjectPropertyRelease *release;
293 };
294
295 /**
296 * GlobalProperty:
297 * @used: Set to true if property was used when initializing a device.
298 * @optional: If set to true, GlobalProperty will be skipped without errors
299 * if the property doesn't exist.
300 *
301 * An error is fatal for non-hotplugged devices, when the global is applied.
302 */
303 typedef struct GlobalProperty {
304 const char *driver;
305 const char *property;
306 const char *value;
307 bool used;
308 bool optional;
309 } GlobalProperty;
310
311 static inline void
312 compat_props_add(GPtrArray *arr,
313 GlobalProperty props[], size_t nelem)
314 {
315 int i;
316 for (i = 0; i < nelem; i++) {
317 g_ptr_array_add(arr, (void *)&props[i]);
318 }
319 }
320
321 /*** Board API. This should go away once we have a machine config file. ***/
322
323 DeviceState *qdev_create(BusState *bus, const char *name);
324 DeviceState *qdev_try_create(BusState *bus, const char *name);
325 DeviceState *qdev_new(const char *name);
326 DeviceState *qdev_try_new(const char *name);
327 void qdev_init_nofail(DeviceState *dev);
328 bool qdev_realize(DeviceState *dev, BusState *bus, Error **errp);
329 bool qdev_realize_and_unref(DeviceState *dev, BusState *bus, Error **errp);
330 void qdev_unrealize(DeviceState *dev);
331
332 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
333 int required_for_version);
334 HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev);
335 HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev);
336 bool qdev_hotplug_allowed(DeviceState *dev, Error **errp);
337 /**
338 * qdev_get_hotplug_handler: Get handler responsible for device wiring
339 *
340 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it.
341 *
342 * Note: in case @dev has a parent bus, it will be returned as handler unless
343 * machine handler overrides it.
344 *
345 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface
346 * or NULL if there aren't any.
347 */
348 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
349 void qdev_unplug(DeviceState *dev, Error **errp);
350 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
351 DeviceState *dev, Error **errp);
352 void qdev_machine_creation_done(void);
353 bool qdev_machine_modified(void);
354
355 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
356 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
357
358 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
359 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
360 qemu_irq pin);
361 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
362 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
363 const char *name, int n);
364
365 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
366
367 /*** Device API. ***/
368
369 /* Register device properties. */
370 /* GPIO inputs also double as IRQ sinks. */
371 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
372 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
373 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
374 const char *name, int n);
375 /**
376 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines
377 * for the specified device
378 *
379 * @dev: Device to create input GPIOs for
380 * @handler: Function to call when GPIO line value is set
381 * @opaque: Opaque data pointer to pass to @handler
382 * @name: Name of the GPIO input (must be unique for this device)
383 * @n: Number of GPIO lines in this input set
384 */
385 void qdev_init_gpio_in_named_with_opaque(DeviceState *dev,
386 qemu_irq_handler handler,
387 void *opaque,
388 const char *name, int n);
389
390 /**
391 * qdev_init_gpio_in_named: create an array of input GPIO lines
392 * for the specified device
393 *
394 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer
395 * passed to the handler is @dev (which is the most commonly desired behaviour).
396 */
397 static inline void qdev_init_gpio_in_named(DeviceState *dev,
398 qemu_irq_handler handler,
399 const char *name, int n)
400 {
401 qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n);
402 }
403
404 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
405 const char *name);
406
407 BusState *qdev_get_parent_bus(DeviceState *dev);
408
409 /*** BUS API. ***/
410
411 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
412
413 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
414 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
415 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
416
417 void qbus_create_inplace(void *bus, size_t size, const char *typename,
418 DeviceState *parent, const char *name);
419 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
420 bool qbus_realize(BusState *bus, Error **errp);
421 void qbus_unrealize(BusState *bus);
422
423 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
424 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
425 * 0 otherwise. */
426 int qbus_walk_children(BusState *bus,
427 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
428 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
429 void *opaque);
430 int qdev_walk_children(DeviceState *dev,
431 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
432 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
433 void *opaque);
434
435 /**
436 * @qdev_reset_all:
437 * Reset @dev. See @qbus_reset_all() for more details.
438 *
439 * Note: This function is deprecated and will be removed when it becomes unused.
440 * Please use device_cold_reset() now.
441 */
442 void qdev_reset_all(DeviceState *dev);
443 void qdev_reset_all_fn(void *opaque);
444
445 /**
446 * @qbus_reset_all:
447 * @bus: Bus to be reset.
448 *
449 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
450 * to it, including recursive processing of all buses below @bus itself. A
451 * hard reset means that qbus_reset_all will reset all state of the device.
452 * For PCI devices, for example, this will include the base address registers
453 * or configuration space.
454 *
455 * Note: This function is deprecated and will be removed when it becomes unused.
456 * Please use bus_cold_reset() now.
457 */
458 void qbus_reset_all(BusState *bus);
459 void qbus_reset_all_fn(void *opaque);
460
461 /**
462 * device_cold_reset:
463 * Reset device @dev and perform a recursive processing using the resettable
464 * interface. It triggers a RESET_TYPE_COLD.
465 */
466 void device_cold_reset(DeviceState *dev);
467
468 /**
469 * bus_cold_reset:
470 *
471 * Reset bus @bus and perform a recursive processing using the resettable
472 * interface. It triggers a RESET_TYPE_COLD.
473 */
474 void bus_cold_reset(BusState *bus);
475
476 /**
477 * device_is_in_reset:
478 * Return true if the device @dev is currently being reset.
479 */
480 bool device_is_in_reset(DeviceState *dev);
481
482 /**
483 * bus_is_in_reset:
484 * Return true if the bus @bus is currently being reset.
485 */
486 bool bus_is_in_reset(BusState *bus);
487
488 /* This should go away once we get rid of the NULL bus hack */
489 BusState *sysbus_get_default(void);
490
491 char *qdev_get_fw_dev_path(DeviceState *dev);
492 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
493
494 /**
495 * @qdev_machine_init
496 *
497 * Initialize platform devices before machine init. This is a hack until full
498 * support for composition is added.
499 */
500 void qdev_machine_init(void);
501
502 /**
503 * device_legacy_reset:
504 *
505 * Reset a single device (by calling the reset method).
506 * Note: This function is deprecated and will be removed when it becomes unused.
507 * Please use device_cold_reset() now.
508 */
509 void device_legacy_reset(DeviceState *dev);
510
511 void device_class_set_props(DeviceClass *dc, Property *props);
512
513 /**
514 * device_class_set_parent_reset:
515 * TODO: remove the function when DeviceClass's reset method
516 * is not used anymore.
517 */
518 void device_class_set_parent_reset(DeviceClass *dc,
519 DeviceReset dev_reset,
520 DeviceReset *parent_reset);
521 void device_class_set_parent_realize(DeviceClass *dc,
522 DeviceRealize dev_realize,
523 DeviceRealize *parent_realize);
524 void device_class_set_parent_unrealize(DeviceClass *dc,
525 DeviceUnrealize dev_unrealize,
526 DeviceUnrealize *parent_unrealize);
527
528 const VMStateDescription *qdev_get_vmsd(DeviceState *dev);
529
530 const char *qdev_fw_name(DeviceState *dev);
531
532 Object *qdev_get_machine(void);
533
534 /* FIXME: make this a link<> */
535 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
536
537 extern bool qdev_hotplug;
538 extern bool qdev_hot_removed;
539
540 char *qdev_get_dev_path(DeviceState *dev);
541
542 void qbus_set_hotplug_handler(BusState *bus, Object *handler, Error **errp);
543
544 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
545
546 static inline bool qbus_is_hotpluggable(BusState *bus)
547 {
548 return bus->hotplug_handler;
549 }
550
551 void device_listener_register(DeviceListener *listener);
552 void device_listener_unregister(DeviceListener *listener);
553
554 /**
555 * @qdev_should_hide_device:
556 * @opts: QemuOpts as passed on cmdline.
557 *
558 * Check if a device should be added.
559 * When a device is added via qdev_device_add() this will be called,
560 * and return if the device should be added now or not.
561 */
562 bool qdev_should_hide_device(QemuOpts *opts);
563
564 #endif