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"
11 DEV_NVECTORS_UNSPECIFIED
= -1,
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)
19 typedef enum DeviceCategory
{
20 DEVICE_CATEGORY_BRIDGE
,
22 DEVICE_CATEGORY_STORAGE
,
23 DEVICE_CATEGORY_NETWORK
,
24 DEVICE_CATEGORY_INPUT
,
25 DEVICE_CATEGORY_DISPLAY
,
26 DEVICE_CATEGORY_SOUND
,
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
);
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
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.
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.
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.
75 * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types
76 * derived directly from it need not call their parent's @realize and
78 * For other types consult the documentation and implementation of the
79 * respective parent types.
84 * To hide a device, a DeviceListener function should_be_hidden() needs to
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.
96 typedef struct DeviceClass
{
98 ObjectClass parent_class
;
101 DECLARE_BITMAP(categories
, DEVICE_CATEGORY_MAX
);
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.
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
120 * TODO remove once we're there
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
132 DeviceRealize realize
;
133 DeviceUnrealize unrealize
;
136 const VMStateDescription
*vmsd
;
138 /* Private to qdev / bus. */
139 const char *bus_type
;
142 typedef struct NamedGPIOList NamedGPIOList
;
144 struct NamedGPIOList
{
149 QLIST_ENTRY(NamedGPIOList
) node
;
152 typedef struct Clock Clock
;
153 typedef struct NamedClockList NamedClockList
;
155 struct NamedClockList
{
160 QLIST_ENTRY(NamedClockList
) node
;
165 * @realized: Indicates whether the device has been fully constructed.
166 * @reset: ResettableState for the device; handled by Resettable interface.
168 * This structure should not be accessed directly. We declare it here
169 * so that it can be embedded in individual device state structures.
177 char *canonical_path
;
179 bool pending_deleted_event
;
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
;
188 int instance_id_alias
;
189 int alias_required_for_version
;
190 ResettableState reset
;
193 struct DeviceListener
{
194 void (*realize
)(DeviceListener
*listener
, DeviceState
*dev
);
195 void (*unrealize
)(DeviceListener
*listener
, DeviceState
*dev
);
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.
201 int (*should_be_hidden
)(DeviceListener
*listener
, QemuOpts
*device_opts
);
202 QTAILQ_ENTRY(DeviceListener
) link
;
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)
211 ObjectClass parent_class
;
213 /* FIXME first arg should be BusState */
214 void (*print_dev
)(Monitor
*mon
, DeviceState
*dev
, int indent
);
215 char *(*get_dev_path
)(DeviceState
*dev
);
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/.
221 char *(*get_fw_dev_path
)(DeviceState
*dev
);
222 void (*reset
)(BusState
*bus
);
224 BusUnrealize unrealize
;
226 /* maximum devices allowed on the bus, 0: no limit. */
228 /* number of automatically allocated bus ids (e.g. ide.0) */
232 typedef struct BusChild
{
235 QTAILQ_ENTRY(BusChild
) sibling
;
238 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
242 * @hotplug_handler: link to a hotplug handler associated with bus.
243 * @reset: ResettableState for the bus; handled by Resettable interface.
249 HotplugHandler
*hotplug_handler
;
253 QTAILQ_HEAD(, BusChild
) children
;
254 QLIST_ENTRY(BusState
) sibling
;
255 ResettableState reset
;
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
269 const PropertyInfo
*info
;
278 const PropertyInfo
*arrayinfo
;
280 const char *link_type
;
283 struct PropertyInfo
{
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
;
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.
301 * An error is fatal for non-hotplugged devices, when the global is applied.
303 typedef struct GlobalProperty
{
305 const char *property
;
312 compat_props_add(GPtrArray
*arr
,
313 GlobalProperty props
[], size_t nelem
)
316 for (i
= 0; i
< nelem
; i
++) {
317 g_ptr_array_add(arr
, (void *)&props
[i
]);
321 /*** Board API. This should go away once we have a machine config file. ***/
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 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
332 int required_for_version
);
333 HotplugHandler
*qdev_get_bus_hotplug_handler(DeviceState
*dev
);
334 HotplugHandler
*qdev_get_machine_hotplug_handler(DeviceState
*dev
);
335 bool qdev_hotplug_allowed(DeviceState
*dev
, Error
**errp
);
337 * qdev_get_hotplug_handler: Get handler responsible for device wiring
339 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it.
341 * Note: in case @dev has a parent bus, it will be returned as handler unless
342 * machine handler overrides it.
344 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface
345 * or NULL if there aren't any.
347 HotplugHandler
*qdev_get_hotplug_handler(DeviceState
*dev
);
348 void qdev_unplug(DeviceState
*dev
, Error
**errp
);
349 void qdev_simple_device_unplug_cb(HotplugHandler
*hotplug_dev
,
350 DeviceState
*dev
, Error
**errp
);
351 void qdev_machine_creation_done(void);
352 bool qdev_machine_modified(void);
354 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
);
355 qemu_irq
qdev_get_gpio_in_named(DeviceState
*dev
, const char *name
, int n
);
357 void qdev_connect_gpio_out(DeviceState
*dev
, int n
, qemu_irq pin
);
358 void qdev_connect_gpio_out_named(DeviceState
*dev
, const char *name
, int n
,
360 qemu_irq
qdev_get_gpio_out_connector(DeviceState
*dev
, const char *name
, int n
);
361 qemu_irq
qdev_intercept_gpio_out(DeviceState
*dev
, qemu_irq icpt
,
362 const char *name
, int n
);
364 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
);
366 /*** Device API. ***/
368 /* Register device properties. */
369 /* GPIO inputs also double as IRQ sinks. */
370 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
);
371 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
);
372 void qdev_init_gpio_out_named(DeviceState
*dev
, qemu_irq
*pins
,
373 const char *name
, int n
);
375 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines
376 * for the specified device
378 * @dev: Device to create input GPIOs for
379 * @handler: Function to call when GPIO line value is set
380 * @opaque: Opaque data pointer to pass to @handler
381 * @name: Name of the GPIO input (must be unique for this device)
382 * @n: Number of GPIO lines in this input set
384 void qdev_init_gpio_in_named_with_opaque(DeviceState
*dev
,
385 qemu_irq_handler handler
,
387 const char *name
, int n
);
390 * qdev_init_gpio_in_named: create an array of input GPIO lines
391 * for the specified device
393 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer
394 * passed to the handler is @dev (which is the most commonly desired behaviour).
396 static inline void qdev_init_gpio_in_named(DeviceState
*dev
,
397 qemu_irq_handler handler
,
398 const char *name
, int n
)
400 qdev_init_gpio_in_named_with_opaque(dev
, handler
, dev
, name
, n
);
403 void qdev_pass_gpios(DeviceState
*dev
, DeviceState
*container
,
406 BusState
*qdev_get_parent_bus(DeviceState
*dev
);
410 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
);
412 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
413 typedef int (qbus_walkerfn
)(BusState
*bus
, void *opaque
);
414 typedef int (qdev_walkerfn
)(DeviceState
*dev
, void *opaque
);
416 void qbus_create_inplace(void *bus
, size_t size
, const char *typename
,
417 DeviceState
*parent
, const char *name
);
418 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
);
419 bool qbus_realize(BusState
*bus
, Error
**errp
);
420 void qbus_unrealize(BusState
*bus
);
422 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
423 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
425 int qbus_walk_children(BusState
*bus
,
426 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
427 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
429 int qdev_walk_children(DeviceState
*dev
,
430 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
431 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
436 * Reset @dev. See @qbus_reset_all() for more details.
438 * Note: This function is deprecated and will be removed when it becomes unused.
439 * Please use device_cold_reset() now.
441 void qdev_reset_all(DeviceState
*dev
);
442 void qdev_reset_all_fn(void *opaque
);
446 * @bus: Bus to be reset.
448 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
449 * to it, including recursive processing of all buses below @bus itself. A
450 * hard reset means that qbus_reset_all will reset all state of the device.
451 * For PCI devices, for example, this will include the base address registers
452 * or configuration space.
454 * Note: This function is deprecated and will be removed when it becomes unused.
455 * Please use bus_cold_reset() now.
457 void qbus_reset_all(BusState
*bus
);
458 void qbus_reset_all_fn(void *opaque
);
462 * Reset device @dev and perform a recursive processing using the resettable
463 * interface. It triggers a RESET_TYPE_COLD.
465 void device_cold_reset(DeviceState
*dev
);
470 * Reset bus @bus and perform a recursive processing using the resettable
471 * interface. It triggers a RESET_TYPE_COLD.
473 void bus_cold_reset(BusState
*bus
);
476 * device_is_in_reset:
477 * Return true if the device @dev is currently being reset.
479 bool device_is_in_reset(DeviceState
*dev
);
483 * Return true if the bus @bus is currently being reset.
485 bool bus_is_in_reset(BusState
*bus
);
487 /* This should go away once we get rid of the NULL bus hack */
488 BusState
*sysbus_get_default(void);
490 char *qdev_get_fw_dev_path(DeviceState
*dev
);
491 char *qdev_get_own_fw_dev_path_from_handler(BusState
*bus
, DeviceState
*dev
);
496 * Initialize platform devices before machine init. This is a hack until full
497 * support for composition is added.
499 void qdev_machine_init(void);
502 * device_legacy_reset:
504 * Reset a single device (by calling the reset method).
505 * Note: This function is deprecated and will be removed when it becomes unused.
506 * Please use device_cold_reset() now.
508 void device_legacy_reset(DeviceState
*dev
);
510 void device_class_set_props(DeviceClass
*dc
, Property
*props
);
513 * device_class_set_parent_reset:
514 * TODO: remove the function when DeviceClass's reset method
515 * is not used anymore.
517 void device_class_set_parent_reset(DeviceClass
*dc
,
518 DeviceReset dev_reset
,
519 DeviceReset
*parent_reset
);
520 void device_class_set_parent_realize(DeviceClass
*dc
,
521 DeviceRealize dev_realize
,
522 DeviceRealize
*parent_realize
);
523 void device_class_set_parent_unrealize(DeviceClass
*dc
,
524 DeviceUnrealize dev_unrealize
,
525 DeviceUnrealize
*parent_unrealize
);
527 const VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
);
529 const char *qdev_fw_name(DeviceState
*dev
);
531 Object
*qdev_get_machine(void);
533 /* FIXME: make this a link<> */
534 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
);
536 extern bool qdev_hotplug
;
537 extern bool qdev_hot_removed
;
539 char *qdev_get_dev_path(DeviceState
*dev
);
541 void qbus_set_hotplug_handler(BusState
*bus
, Object
*handler
, Error
**errp
);
543 void qbus_set_bus_hotplug_handler(BusState
*bus
, Error
**errp
);
545 static inline bool qbus_is_hotpluggable(BusState
*bus
)
547 return bus
->hotplug_handler
;
550 void device_listener_register(DeviceListener
*listener
);
551 void device_listener_unregister(DeviceListener
*listener
);
554 * @qdev_should_hide_device:
555 * @opts: QemuOpts as passed on cmdline.
557 * Check if a device should be added.
558 * When a device is added via qdev_device_add() this will be called,
559 * and return if the device should be added now or not.
561 bool qdev_should_hide_device(QemuOpts
*opts
);