4 #include "qemu/queue.h"
5 #include "qemu/bitmap.h"
7 #include "qemu/rcu_queue.h"
8 #include "qom/object.h"
9 #include "hw/hotplug.h"
10 #include "hw/resettable.h"
13 DEV_NVECTORS_UNSPECIFIED
= -1,
16 #define TYPE_DEVICE "device"
17 OBJECT_DECLARE_TYPE(DeviceState
, DeviceClass
, 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().
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 hide_device() needs to
86 * It can be used to defer adding a device and therefore hide it from
87 * the guest. The handler registering to this DeviceListener can save
88 * the QOpts passed to it for re-using it later. It must return if it
89 * wants the device to be hidden or visible. When the handler function
90 * decides the device shall be visible it will be added with
91 * qdev_device_add() and realized as any other device. Otherwise
92 * qdev_device_add() will return early without adding the device. The
93 * guest will not see a "hidden" device until it was marked visible
94 * and qdev_device_add called again.
99 ObjectClass parent_class
;
102 DECLARE_BITMAP(categories
, DEVICE_CATEGORY_MAX
);
107 * The underscore at the end ensures a compile-time error if someone
108 * assigns to dc->props instead of using device_class_set_props.
113 * Can this device be instantiated with -device / device_add?
114 * All devices should support instantiation with device_add, and
115 * this flag should not exist. But we're not there, yet. Some
116 * devices fail to instantiate with cryptic error messages.
117 * Others instantiate, but don't work. Exposing users to such
118 * behavior would be cruel; clearing this flag will protect them.
119 * It should never be cleared without a comment explaining why it
121 * TODO remove once we're there
128 * Reset method here is deprecated and replaced by methods in the
129 * resettable class interface to implement a multi-phase reset.
130 * TODO: remove once every reset callback is unused
133 DeviceRealize realize
;
134 DeviceUnrealize unrealize
;
137 const VMStateDescription
*vmsd
;
139 /* Private to qdev / bus. */
140 const char *bus_type
;
143 typedef struct NamedGPIOList NamedGPIOList
;
145 struct NamedGPIOList
{
150 QLIST_ENTRY(NamedGPIOList
) node
;
153 typedef struct Clock Clock
;
154 typedef struct NamedClockList NamedClockList
;
156 struct NamedClockList
{
161 QLIST_ENTRY(NamedClockList
) node
;
166 * @realized: Indicates whether the device has been fully constructed.
167 * When accessed outside big qemu lock, must be accessed with
168 * qatomic_load_acquire()
169 * @reset: ResettableState for the device; handled by Resettable interface.
171 * This structure should not be accessed directly. We declare it here
172 * so that it can be embedded in individual device state structures.
180 char *canonical_path
;
182 bool pending_deleted_event
;
185 bool allow_unplug_during_migration
;
186 BusState
*parent_bus
;
187 QLIST_HEAD(, NamedGPIOList
) gpios
;
188 QLIST_HEAD(, NamedClockList
) clocks
;
189 QLIST_HEAD(, BusState
) child_bus
;
191 int instance_id_alias
;
192 int alias_required_for_version
;
193 ResettableState reset
;
196 struct DeviceListener
{
197 void (*realize
)(DeviceListener
*listener
, DeviceState
*dev
);
198 void (*unrealize
)(DeviceListener
*listener
, DeviceState
*dev
);
200 * This callback is called upon init of the DeviceState and
201 * informs qdev if a device should be visible or hidden. We can
202 * hide a failover device depending for example on the device
205 * On errors, it returns false and errp is set. Device creation
206 * should fail in this case.
208 bool (*hide_device
)(DeviceListener
*listener
, const QDict
*device_opts
,
209 bool from_json
, Error
**errp
);
210 QTAILQ_ENTRY(DeviceListener
) link
;
213 #define TYPE_BUS "bus"
214 DECLARE_OBJ_CHECKERS(BusState
, BusClass
,
218 ObjectClass parent_class
;
220 /* FIXME first arg should be BusState */
221 void (*print_dev
)(Monitor
*mon
, DeviceState
*dev
, int indent
);
222 char *(*get_dev_path
)(DeviceState
*dev
);
225 * This callback is used to create Open Firmware device path in accordance
226 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
227 * bindings can be found at http://playground.sun.com/1275/bindings/.
229 char *(*get_fw_dev_path
)(DeviceState
*dev
);
231 void (*reset
)(BusState
*bus
);
234 * Return whether the device can be added to @bus,
235 * based on the address that was set (via device properties)
236 * before realize. If not, on return @errp contains the
237 * human-readable error message.
239 bool (*check_address
)(BusState
*bus
, DeviceState
*dev
, Error
**errp
);
242 BusUnrealize unrealize
;
244 /* maximum devices allowed on the bus, 0: no limit. */
246 /* number of automatically allocated bus ids (e.g. ide.0) */
250 typedef struct BusChild
{
254 QTAILQ_ENTRY(BusChild
) sibling
;
257 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
261 * @hotplug_handler: link to a hotplug handler associated with bus.
262 * @reset: ResettableState for the bus; handled by Resettable interface.
268 HotplugHandler
*hotplug_handler
;
275 * children is a RCU QTAILQ, thus readers must use RCU to access it,
276 * and writers must hold the big qemu lock
279 QTAILQ_HEAD(, BusChild
) children
;
280 QLIST_ENTRY(BusState
) sibling
;
281 ResettableState reset
;
286 * @used: Set to true if property was used when initializing a device.
287 * @optional: If set to true, GlobalProperty will be skipped without errors
288 * if the property doesn't exist.
290 * An error is fatal for non-hotplugged devices, when the global is applied.
292 typedef struct GlobalProperty
{
294 const char *property
;
301 compat_props_add(GPtrArray
*arr
,
302 GlobalProperty props
[], size_t nelem
)
305 for (i
= 0; i
< nelem
; i
++) {
306 g_ptr_array_add(arr
, (void *)&props
[i
]);
310 /*** Board API. This should go away once we have a machine config file. ***/
313 * qdev_new: Create a device on the heap
314 * @name: device type to create (we assert() that this type exists)
316 * This only allocates the memory and initializes the device state
317 * structure, ready for the caller to set properties if they wish.
318 * The device still needs to be realized.
319 * The returned object has a reference count of 1.
321 DeviceState
*qdev_new(const char *name
);
323 * qdev_try_new: Try to create a device on the heap
324 * @name: device type to create
326 * This is like qdev_new(), except it returns %NULL when type @name
327 * does not exist, rather than asserting.
329 DeviceState
*qdev_try_new(const char *name
);
331 * qdev_realize: Realize @dev.
332 * @dev: device to realize
333 * @bus: bus to plug it into (may be NULL)
334 * @errp: pointer to error object
336 * "Realize" the device, i.e. perform the second phase of device
338 * @dev must not be plugged into a bus already.
339 * If @bus, plug @dev into @bus. This takes a reference to @dev.
340 * If @dev has no QOM parent, make one up, taking another reference.
341 * On success, return true.
342 * On failure, store an error through @errp and return false.
344 * If you created @dev using qdev_new(), you probably want to use
345 * qdev_realize_and_unref() instead.
347 bool qdev_realize(DeviceState
*dev
, BusState
*bus
, Error
**errp
);
349 * qdev_realize_and_unref: Realize @dev and drop a reference
350 * @dev: device to realize
351 * @bus: bus to plug it into (may be NULL)
352 * @errp: pointer to error object
354 * Realize @dev and drop a reference.
355 * This is like qdev_realize(), except the caller must hold a
356 * (private) reference, which is dropped on return regardless of
357 * success or failure. Intended use::
361 * qdev_realize_and_unref(dev, bus, errp);
363 * Now @dev can go away without further ado.
365 * If you are embedding the device into some other QOM device and
366 * initialized it via some variant on object_initialize_child() then
367 * do not use this function, because that family of functions arrange
368 * for the only reference to the child device to be held by the parent
369 * via the child<> property, and so the reference-count-drop done here
370 * would be incorrect. For that use case you want qdev_realize().
372 bool qdev_realize_and_unref(DeviceState
*dev
, BusState
*bus
, Error
**errp
);
374 * qdev_unrealize: Unrealize a device
375 * @dev: device to unrealize
377 * This function will "unrealize" a device, which is the first phase
378 * of correctly destroying a device that has been realized. It will:
380 * - unrealize any child buses by calling qbus_unrealize()
381 * (this will recursively unrealize any devices on those buses)
382 * - call the the unrealize method of @dev
384 * The device can then be freed by causing its reference count to go
387 * Warning: most devices in QEMU do not expect to be unrealized. Only
388 * devices which are hot-unpluggable should be unrealized (as part of
389 * the unplugging process); all other devices are expected to last for
390 * the life of the simulation and should not be unrealized and freed.
392 void qdev_unrealize(DeviceState
*dev
);
393 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
394 int required_for_version
);
395 HotplugHandler
*qdev_get_bus_hotplug_handler(DeviceState
*dev
);
396 HotplugHandler
*qdev_get_machine_hotplug_handler(DeviceState
*dev
);
397 bool qdev_hotplug_allowed(DeviceState
*dev
, Error
**errp
);
399 * qdev_get_hotplug_handler: Get handler responsible for device wiring
401 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it.
403 * Note: in case @dev has a parent bus, it will be returned as handler unless
404 * machine handler overrides it.
406 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface
407 * or NULL if there aren't any.
409 HotplugHandler
*qdev_get_hotplug_handler(DeviceState
*dev
);
410 void qdev_unplug(DeviceState
*dev
, Error
**errp
);
411 void qdev_simple_device_unplug_cb(HotplugHandler
*hotplug_dev
,
412 DeviceState
*dev
, Error
**errp
);
413 void qdev_machine_creation_done(void);
414 bool qdev_machine_modified(void);
417 * GpioPolarity: Polarity of a GPIO line
419 * GPIO lines use either positive (active-high) logic,
420 * or negative (active-low) logic.
422 * In active-high logic (%GPIO_POLARITY_ACTIVE_HIGH), a pin is
423 * active when the voltage on the pin is high (relative to ground);
424 * whereas in active-low logic (%GPIO_POLARITY_ACTIVE_LOW), a pin
425 * is active when the voltage on the pin is low (or grounded).
428 GPIO_POLARITY_ACTIVE_LOW
,
429 GPIO_POLARITY_ACTIVE_HIGH
433 * qdev_get_gpio_in: Get one of a device's anonymous input GPIO lines
434 * @dev: Device whose GPIO we want
435 * @n: Number of the anonymous GPIO line (which must be in range)
437 * Returns the qemu_irq corresponding to an anonymous input GPIO line
438 * (which the device has set up with qdev_init_gpio_in()). The index
439 * @n of the GPIO line must be valid (i.e. be at least 0 and less than
440 * the total number of anonymous input GPIOs the device has); this
441 * function will assert() if passed an invalid index.
443 * This function is intended to be used by board code or SoC "container"
444 * device models to wire up the GPIO lines; usually the return value
445 * will be passed to qdev_connect_gpio_out() or a similar function to
446 * connect another device's output GPIO line to this input.
448 * For named input GPIO lines, use qdev_get_gpio_in_named().
450 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
);
452 * qdev_get_gpio_in_named: Get one of a device's named input GPIO lines
453 * @dev: Device whose GPIO we want
454 * @name: Name of the input GPIO array
455 * @n: Number of the GPIO line in that array (which must be in range)
457 * Returns the qemu_irq corresponding to a named input GPIO line
458 * (which the device has set up with qdev_init_gpio_in_named()).
459 * The @name string must correspond to an input GPIO array which exists on
460 * the device, and the index @n of the GPIO line must be valid (i.e.
461 * be at least 0 and less than the total number of input GPIOs in that
462 * array); this function will assert() if passed an invalid name or index.
464 * For anonymous input GPIO lines, use qdev_get_gpio_in().
466 qemu_irq
qdev_get_gpio_in_named(DeviceState
*dev
, const char *name
, int n
);
469 * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
470 * @dev: Device whose GPIO to connect
471 * @n: Number of the anonymous output GPIO line (which must be in range)
472 * @pin: qemu_irq to connect the output line to
474 * This function connects an anonymous output GPIO line on a device
475 * up to an arbitrary qemu_irq, so that when the device asserts that
476 * output GPIO line, the qemu_irq's callback is invoked.
477 * The index @n of the GPIO line must be valid (i.e. be at least 0 and
478 * less than the total number of anonymous output GPIOs the device has
479 * created with qdev_init_gpio_out()); otherwise this function will assert().
481 * Outbound GPIO lines can be connected to any qemu_irq, but the common
482 * case is connecting them to another device's inbound GPIO line, using
483 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named().
485 * It is not valid to try to connect one outbound GPIO to multiple
486 * qemu_irqs at once, or to connect multiple outbound GPIOs to the
487 * same qemu_irq. (Warning: there is no assertion or other guard to
488 * catch this error: the model will just not do the right thing.)
489 * Instead, for fan-out you can use the TYPE_IRQ_SPLIT device: connect
490 * a device's outbound GPIO to the splitter's input, and connect each
491 * of the splitter's outputs to a different device. For fan-in you
492 * can use the TYPE_OR_IRQ device, which is a model of a logical OR
493 * gate with multiple inputs and one output.
495 * For named output GPIO lines, use qdev_connect_gpio_out_named().
497 void qdev_connect_gpio_out(DeviceState
*dev
, int n
, qemu_irq pin
);
499 * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
500 * @dev: Device whose GPIO to connect
501 * @name: Name of the output GPIO array
502 * @n: Number of the anonymous output GPIO line (which must be in range)
503 * @pin: qemu_irq to connect the output line to
505 * This function connects an anonymous output GPIO line on a device
506 * up to an arbitrary qemu_irq, so that when the device asserts that
507 * output GPIO line, the qemu_irq's callback is invoked.
508 * The @name string must correspond to an output GPIO array which exists on
509 * the device, and the index @n of the GPIO line must be valid (i.e.
510 * be at least 0 and less than the total number of input GPIOs in that
511 * array); this function will assert() if passed an invalid name or index.
513 * Outbound GPIO lines can be connected to any qemu_irq, but the common
514 * case is connecting them to another device's inbound GPIO line, using
515 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named().
517 * It is not valid to try to connect one outbound GPIO to multiple
518 * qemu_irqs at once, or to connect multiple outbound GPIOs to the
519 * same qemu_irq; see qdev_connect_gpio_out() for details.
521 * For named output GPIO lines, use qdev_connect_gpio_out_named().
523 void qdev_connect_gpio_out_named(DeviceState
*dev
, const char *name
, int n
,
526 * qdev_get_gpio_out_connector: Get the qemu_irq connected to an output GPIO
527 * @dev: Device whose output GPIO we are interested in
528 * @name: Name of the output GPIO array
529 * @n: Number of the output GPIO line within that array
531 * Returns whatever qemu_irq is currently connected to the specified
532 * output GPIO line of @dev. This will be NULL if the output GPIO line
533 * has never been wired up to the anything. Note that the qemu_irq
534 * returned does not belong to @dev -- it will be the input GPIO or
535 * IRQ of whichever device the board code has connected up to @dev's
538 * You probably don't need to use this function -- it is used only
539 * by the platform-bus subsystem.
541 qemu_irq
qdev_get_gpio_out_connector(DeviceState
*dev
, const char *name
, int n
);
543 * qdev_intercept_gpio_out: Intercept an existing GPIO connection
544 * @dev: Device to intercept the outbound GPIO line from
545 * @icpt: New qemu_irq to connect instead
546 * @name: Name of the output GPIO array
547 * @n: Number of the GPIO line in the array
549 * This function is provided only for use by the qtest testing framework
550 * and is not suitable for use in non-testing parts of QEMU.
552 * This function breaks an existing connection of an outbound GPIO
553 * line from @dev, and replaces it with the new qemu_irq @icpt, as if
554 * ``qdev_connect_gpio_out_named(dev, icpt, name, n)`` had been called.
555 * The previously connected qemu_irq is returned, so it can be restored
556 * by a second call to qdev_intercept_gpio_out() if desired.
558 qemu_irq
qdev_intercept_gpio_out(DeviceState
*dev
, qemu_irq icpt
,
559 const char *name
, int n
);
561 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
);
563 /*** Device API. ***/
566 * qdev_init_gpio_in: create an array of anonymous input GPIO lines
567 * @dev: Device to create input GPIOs for
568 * @handler: Function to call when GPIO line value is set
569 * @n: Number of GPIO lines to create
571 * Devices should use functions in the qdev_init_gpio_in* family in
572 * their instance_init or realize methods to create any input GPIO
573 * lines they need. There is no functional difference between
574 * anonymous and named GPIO lines. Stylistically, named GPIOs are
575 * preferable (easier to understand at callsites) unless a device
576 * has exactly one uniform kind of GPIO input whose purpose is obvious.
577 * Note that input GPIO lines can serve as 'sinks' for IRQ lines.
579 * See qdev_get_gpio_in() for how code that uses such a device can get
580 * hold of an input GPIO line to manipulate it.
582 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
);
584 * qdev_init_gpio_out: create an array of anonymous output GPIO lines
585 * @dev: Device to create output GPIOs for
586 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
587 * @n: Number of GPIO lines to create
589 * Devices should use functions in the qdev_init_gpio_out* family
590 * in their instance_init or realize methods to create any output
591 * GPIO lines they need. There is no functional difference between
592 * anonymous and named GPIO lines. Stylistically, named GPIOs are
593 * preferable (easier to understand at callsites) unless a device
594 * has exactly one uniform kind of GPIO output whose purpose is obvious.
596 * The @pins argument should be a pointer to either a "qemu_irq"
597 * (if @n == 1) or a "qemu_irq []" array (if @n > 1) in the device's
598 * state structure. The device implementation can then raise and
599 * lower the GPIO line by calling qemu_set_irq(). (If anything is
600 * connected to the other end of the GPIO this will cause the handler
601 * function for that input GPIO to be called.)
603 * See qdev_connect_gpio_out() for how code that uses such a device
604 * can connect to one of its output GPIO lines.
606 * There is no need to release the @pins allocated array because it
607 * will be automatically released when @dev calls its instance_finalize()
610 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
);
612 * qdev_init_gpio_out: create an array of named output GPIO lines
613 * @dev: Device to create output GPIOs for
614 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
615 * @name: Name to give this array of GPIO lines
616 * @n: Number of GPIO lines to create
618 * Like qdev_init_gpio_out(), but creates an array of GPIO output lines
619 * with a name. Code using the device can then connect these GPIO lines
620 * using qdev_connect_gpio_out_named().
622 void qdev_init_gpio_out_named(DeviceState
*dev
, qemu_irq
*pins
,
623 const char *name
, int n
);
625 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines
626 * for the specified device
628 * @dev: Device to create input GPIOs for
629 * @handler: Function to call when GPIO line value is set
630 * @opaque: Opaque data pointer to pass to @handler
631 * @name: Name of the GPIO input (must be unique for this device)
632 * @n: Number of GPIO lines in this input set
634 void qdev_init_gpio_in_named_with_opaque(DeviceState
*dev
,
635 qemu_irq_handler handler
,
637 const char *name
, int n
);
640 * qdev_init_gpio_in_named: create an array of input GPIO lines
641 * for the specified device
643 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer
644 * passed to the handler is @dev (which is the most commonly desired behaviour).
646 static inline void qdev_init_gpio_in_named(DeviceState
*dev
,
647 qemu_irq_handler handler
,
648 const char *name
, int n
)
650 qdev_init_gpio_in_named_with_opaque(dev
, handler
, dev
, name
, n
);
654 * qdev_pass_gpios: create GPIO lines on container which pass through to device
655 * @dev: Device which has GPIO lines
656 * @container: Container device which needs to expose them
657 * @name: Name of GPIO array to pass through (NULL for the anonymous GPIO array)
659 * In QEMU, complicated devices like SoCs are often modelled with a
660 * "container" QOM device which itself contains other QOM devices and
661 * which wires them up appropriately. This function allows the container
662 * to create GPIO arrays on itself which simply pass through to a GPIO
663 * array of one of its internal devices.
665 * If @dev has both input and output GPIOs named @name then both will
666 * be passed through. It is not possible to pass a subset of the array
667 * with this function.
669 * To users of the container device, the GPIO array created on @container
670 * behaves exactly like any other.
672 void qdev_pass_gpios(DeviceState
*dev
, DeviceState
*container
,
675 BusState
*qdev_get_parent_bus(DeviceState
*dev
);
679 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
);
681 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
682 typedef int (qbus_walkerfn
)(BusState
*bus
, void *opaque
);
683 typedef int (qdev_walkerfn
)(DeviceState
*dev
, void *opaque
);
685 void qbus_init(void *bus
, size_t size
, const char *typename
,
686 DeviceState
*parent
, const char *name
);
687 BusState
*qbus_new(const char *typename
, DeviceState
*parent
, const char *name
);
688 bool qbus_realize(BusState
*bus
, Error
**errp
);
689 void qbus_unrealize(BusState
*bus
);
691 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
692 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
694 int qbus_walk_children(BusState
*bus
,
695 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
696 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
698 int qdev_walk_children(DeviceState
*dev
,
699 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
700 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
705 * Reset @dev. See @qbus_reset_all() for more details.
707 * Note: This function is deprecated and will be removed when it becomes unused.
708 * Please use device_cold_reset() now.
710 void qdev_reset_all(DeviceState
*dev
);
711 void qdev_reset_all_fn(void *opaque
);
715 * @bus: Bus to be reset.
717 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
718 * to it, including recursive processing of all buses below @bus itself. A
719 * hard reset means that qbus_reset_all will reset all state of the device.
720 * For PCI devices, for example, this will include the base address registers
721 * or configuration space.
723 * Note: This function is deprecated and will be removed when it becomes unused.
724 * Please use bus_cold_reset() now.
726 void qbus_reset_all(BusState
*bus
);
727 void qbus_reset_all_fn(void *opaque
);
731 * Reset device @dev and perform a recursive processing using the resettable
732 * interface. It triggers a RESET_TYPE_COLD.
734 void device_cold_reset(DeviceState
*dev
);
739 * Reset bus @bus and perform a recursive processing using the resettable
740 * interface. It triggers a RESET_TYPE_COLD.
742 void bus_cold_reset(BusState
*bus
);
745 * device_is_in_reset:
746 * Return true if the device @dev is currently being reset.
748 bool device_is_in_reset(DeviceState
*dev
);
752 * Return true if the bus @bus is currently being reset.
754 bool bus_is_in_reset(BusState
*bus
);
756 /* This should go away once we get rid of the NULL bus hack */
757 BusState
*sysbus_get_default(void);
759 char *qdev_get_fw_dev_path(DeviceState
*dev
);
760 char *qdev_get_own_fw_dev_path_from_handler(BusState
*bus
, DeviceState
*dev
);
763 * device_legacy_reset:
765 * Reset a single device (by calling the reset method).
766 * Note: This function is deprecated and will be removed when it becomes unused.
767 * Please use device_cold_reset() now.
769 void device_legacy_reset(DeviceState
*dev
);
771 void device_class_set_props(DeviceClass
*dc
, Property
*props
);
774 * device_class_set_parent_reset:
775 * TODO: remove the function when DeviceClass's reset method
776 * is not used anymore.
778 void device_class_set_parent_reset(DeviceClass
*dc
,
779 DeviceReset dev_reset
,
780 DeviceReset
*parent_reset
);
781 void device_class_set_parent_realize(DeviceClass
*dc
,
782 DeviceRealize dev_realize
,
783 DeviceRealize
*parent_realize
);
784 void device_class_set_parent_unrealize(DeviceClass
*dc
,
785 DeviceUnrealize dev_unrealize
,
786 DeviceUnrealize
*parent_unrealize
);
788 const VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
);
790 const char *qdev_fw_name(DeviceState
*dev
);
792 void qdev_assert_realized_properly(void);
793 Object
*qdev_get_machine(void);
795 /* FIXME: make this a link<> */
796 bool qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
, Error
**errp
);
798 extern bool qdev_hot_removed
;
800 char *qdev_get_dev_path(DeviceState
*dev
);
802 void qbus_set_hotplug_handler(BusState
*bus
, Object
*handler
);
803 void qbus_set_bus_hotplug_handler(BusState
*bus
);
805 static inline bool qbus_is_hotpluggable(BusState
*bus
)
807 return bus
->hotplug_handler
;
811 * qbus_mark_full: Mark this bus as full, so no more devices can be attached
812 * @bus: Bus to mark as full
814 * By default, QEMU will allow devices to be plugged into a bus up
815 * to the bus class's device count limit. Calling this function
816 * marks a particular bus as full, so that no more devices can be
817 * plugged into it. In particular this means that the bus will not
818 * be considered as a candidate for plugging in devices created by
819 * the user on the commandline or via the monitor.
820 * If a machine has multiple buses of a given type, such as I2C,
821 * where some of those buses in the real hardware are used only for
822 * internal devices and some are exposed via expansion ports, you
823 * can use this function to mark the internal-only buses as full
824 * after you have created all their internal devices. Then user
825 * created devices will appear on the expansion-port bus where
826 * guest software expects them.
828 static inline void qbus_mark_full(BusState
*bus
)
833 void device_listener_register(DeviceListener
*listener
);
834 void device_listener_unregister(DeviceListener
*listener
);
837 * @qdev_should_hide_device:
838 * @opts: options QDict
839 * @from_json: true if @opts entries are typed, false for all strings
840 * @errp: pointer to error object
842 * Check if a device should be added.
843 * When a device is added via qdev_device_add() this will be called,
844 * and return if the device should be added now or not.
846 bool qdev_should_hide_device(const QDict
*opts
, bool from_json
, Error
**errp
);
848 typedef enum MachineInitPhase
{
849 /* current_machine is NULL. */
852 /* current_machine is not NULL, but current_machine->accel is NULL. */
853 PHASE_MACHINE_CREATED
,
856 * current_machine->accel is not NULL, but the machine properties have
857 * not been validated and machine_class->init has not yet been called.
862 * machine_class->init has been called, thus creating any embedded
863 * devices and validating machine properties. Devices created at
864 * this time are considered to be cold-plugged.
866 PHASE_MACHINE_INITIALIZED
,
869 * QEMU is ready to start CPUs and devices created at this time
870 * are considered to be hot-plugged. The monitor is not restricted
871 * to "preconfig" commands.
876 extern bool phase_check(MachineInitPhase phase
);
877 extern void phase_advance(MachineInitPhase phase
);