4 #include "qemu/atomic.h"
5 #include "qemu/queue.h"
6 #include "qemu/bitmap.h"
8 #include "qemu/rcu_queue.h"
9 #include "qom/object.h"
10 #include "hw/hotplug.h"
11 #include "hw/resettable.h"
14 DEV_NVECTORS_UNSPECIFIED
= -1,
17 #define TYPE_DEVICE "device"
18 OBJECT_DECLARE_TYPE(DeviceState
, DeviceClass
, DEVICE
)
20 typedef enum DeviceCategory
{
21 DEVICE_CATEGORY_BRIDGE
,
23 DEVICE_CATEGORY_STORAGE
,
24 DEVICE_CATEGORY_NETWORK
,
25 DEVICE_CATEGORY_INPUT
,
26 DEVICE_CATEGORY_DISPLAY
,
27 DEVICE_CATEGORY_SOUND
,
30 DEVICE_CATEGORY_WATCHDOG
,
34 typedef void (*DeviceRealize
)(DeviceState
*dev
, Error
**errp
);
35 typedef void (*DeviceUnrealize
)(DeviceState
*dev
);
36 typedef void (*DeviceReset
)(DeviceState
*dev
);
37 typedef void (*BusRealize
)(BusState
*bus
, Error
**errp
);
38 typedef void (*BusUnrealize
)(BusState
*bus
);
42 * @props: Properties accessing state fields.
43 * @realize: Callback function invoked when the #DeviceState:realized
44 * property is changed to %true.
45 * @unrealize: Callback function invoked when the #DeviceState:realized
46 * property is changed to %false.
47 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
48 * as readonly "hotpluggable" property of #DeviceState instance
51 * Devices are constructed in two stages,
52 * 1) object instantiation via object_initialize() and
53 * 2) device realization via #DeviceState:realized property.
54 * The former may not fail (and must not abort or exit, since it is called
55 * during device introspection already), and the latter may return error
56 * information to the caller and must be re-entrant.
57 * Trivial field initializations should go into #TypeInfo.instance_init.
58 * Operations depending on @props static properties should go into @realize.
59 * After successful realization, setting static properties will fail.
61 * As an interim step, the #DeviceState:realized property can also be
62 * set with qdev_realize().
63 * In the future, devices will propagate this state change to their children
64 * and along busses they expose.
65 * The point in time will be deferred to machine creation, so that values
66 * set in @realize will not be introspectable beforehand. Therefore devices
67 * must not create children during @realize; they should initialize them via
68 * object_initialize() in their own #TypeInfo.instance_init and forward the
69 * realization events appropriately.
71 * Any type may override the @realize and/or @unrealize callbacks but needs
72 * to call the parent type's implementation if keeping their functionality
73 * is desired. Refer to QOM documentation for further discussion and examples.
77 * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types
78 * derived directly from it need not call their parent's @realize and
80 * For other types consult the documentation and implementation of the
81 * respective parent types.
86 * To hide a device, a DeviceListener function hide_device() needs to
88 * It can be used to defer adding a device and therefore hide it from
89 * the guest. The handler registering to this DeviceListener can save
90 * the QOpts passed to it for re-using it later. It must return if it
91 * wants the device to be hidden or visible. When the handler function
92 * decides the device shall be visible it will be added with
93 * qdev_device_add() and realized as any other device. Otherwise
94 * qdev_device_add() will return early without adding the device. The
95 * guest will not see a "hidden" device until it was marked visible
96 * and qdev_device_add called again.
101 ObjectClass parent_class
;
104 DECLARE_BITMAP(categories
, DEVICE_CATEGORY_MAX
);
109 * The underscore at the end ensures a compile-time error if someone
110 * assigns to dc->props instead of using device_class_set_props.
115 * Can this device be instantiated with -device / device_add?
116 * All devices should support instantiation with device_add, and
117 * this flag should not exist. But we're not there, yet. Some
118 * devices fail to instantiate with cryptic error messages.
119 * Others instantiate, but don't work. Exposing users to such
120 * behavior would be cruel; clearing this flag will protect them.
121 * It should never be cleared without a comment explaining why it
123 * TODO remove once we're there
130 * Reset method here is deprecated and replaced by methods in the
131 * resettable class interface to implement a multi-phase reset.
132 * TODO: remove once every reset callback is unused
135 DeviceRealize realize
;
136 DeviceUnrealize unrealize
;
139 const VMStateDescription
*vmsd
;
141 /* Private to qdev / bus. */
142 const char *bus_type
;
145 typedef struct NamedGPIOList NamedGPIOList
;
147 struct NamedGPIOList
{
152 QLIST_ENTRY(NamedGPIOList
) node
;
155 typedef struct Clock Clock
;
156 typedef struct NamedClockList NamedClockList
;
158 struct NamedClockList
{
163 QLIST_ENTRY(NamedClockList
) node
;
168 } MemReentrancyGuard
;
172 * @reset: ResettableState for the device; handled by Resettable interface.
174 * This structure should not be accessed directly. We declare it here
175 * so that it can be embedded in individual device state structures.
183 char *canonical_path
;
185 bool pending_deleted_event
;
186 int64_t pending_deleted_expires_ms
;
189 bool allow_unplug_during_migration
;
190 BusState
*parent_bus
;
191 QLIST_HEAD(, NamedGPIOList
) gpios
;
192 QLIST_HEAD(, NamedClockList
) clocks
;
193 QLIST_HEAD(, BusState
) child_bus
;
195 int instance_id_alias
;
196 int alias_required_for_version
;
197 ResettableState reset
;
198 GSList
*unplug_blockers
;
200 /* Is the device currently in mmio/pio/dma? Used to prevent re-entrancy */
201 MemReentrancyGuard mem_reentrancy_guard
;
204 struct DeviceListener
{
205 void (*realize
)(DeviceListener
*listener
, DeviceState
*dev
);
206 void (*unrealize
)(DeviceListener
*listener
, DeviceState
*dev
);
208 * This callback is called upon init of the DeviceState and
209 * informs qdev if a device should be visible or hidden. We can
210 * hide a failover device depending for example on the device
213 * On errors, it returns false and errp is set. Device creation
214 * should fail in this case.
216 bool (*hide_device
)(DeviceListener
*listener
, const QDict
*device_opts
,
217 bool from_json
, Error
**errp
);
218 QTAILQ_ENTRY(DeviceListener
) link
;
221 #define TYPE_BUS "bus"
222 DECLARE_OBJ_CHECKERS(BusState
, BusClass
,
226 ObjectClass parent_class
;
228 /* FIXME first arg should be BusState */
229 void (*print_dev
)(Monitor
*mon
, DeviceState
*dev
, int indent
);
230 char *(*get_dev_path
)(DeviceState
*dev
);
233 * This callback is used to create Open Firmware device path in accordance
234 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
235 * bindings can be found at http://playground.sun.com/1275/bindings/.
237 char *(*get_fw_dev_path
)(DeviceState
*dev
);
239 void (*reset
)(BusState
*bus
);
242 * Return whether the device can be added to @bus,
243 * based on the address that was set (via device properties)
244 * before realize. If not, on return @errp contains the
245 * human-readable error message.
247 bool (*check_address
)(BusState
*bus
, DeviceState
*dev
, Error
**errp
);
250 BusUnrealize unrealize
;
252 /* maximum devices allowed on the bus, 0: no limit. */
254 /* number of automatically allocated bus ids (e.g. ide.0) */
258 typedef struct BusChild
{
262 QTAILQ_ENTRY(BusChild
) sibling
;
265 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
269 * @hotplug_handler: link to a hotplug handler associated with bus.
270 * @reset: ResettableState for the bus; handled by Resettable interface.
276 HotplugHandler
*hotplug_handler
;
283 * children is a RCU QTAILQ, thus readers must use RCU to access it,
284 * and writers must hold the big qemu lock
287 QTAILQ_HEAD(, BusChild
) children
;
288 QLIST_ENTRY(BusState
) sibling
;
289 ResettableState reset
;
294 * @used: Set to true if property was used when initializing a device.
295 * @optional: If set to true, GlobalProperty will be skipped without errors
296 * if the property doesn't exist.
298 * An error is fatal for non-hotplugged devices, when the global is applied.
300 typedef struct GlobalProperty
{
302 const char *property
;
309 compat_props_add(GPtrArray
*arr
,
310 GlobalProperty props
[], size_t nelem
)
313 for (i
= 0; i
< nelem
; i
++) {
314 g_ptr_array_add(arr
, (void *)&props
[i
]);
318 /*** Board API. This should go away once we have a machine config file. ***/
321 * qdev_new: Create a device on the heap
322 * @name: device type to create (we assert() that this type exists)
324 * This only allocates the memory and initializes the device state
325 * structure, ready for the caller to set properties if they wish.
326 * The device still needs to be realized.
327 * The returned object has a reference count of 1.
329 DeviceState
*qdev_new(const char *name
);
332 * qdev_try_new: Try to create a device on the heap
333 * @name: device type to create
335 * This is like qdev_new(), except it returns %NULL when type @name
336 * does not exist, rather than asserting.
338 DeviceState
*qdev_try_new(const char *name
);
342 * @dev: The device to check.
344 * May be called outside big qemu lock.
346 * Returns: %true% if the device has been fully constructed, %false% otherwise.
348 static inline bool qdev_is_realized(DeviceState
*dev
)
350 return qatomic_load_acquire(&dev
->realized
);
354 * qdev_realize: Realize @dev.
355 * @dev: device to realize
356 * @bus: bus to plug it into (may be NULL)
357 * @errp: pointer to error object
359 * "Realize" the device, i.e. perform the second phase of device
361 * @dev must not be plugged into a bus already.
362 * If @bus, plug @dev into @bus. This takes a reference to @dev.
363 * If @dev has no QOM parent, make one up, taking another reference.
364 * On success, return true.
365 * On failure, store an error through @errp and return false.
367 * If you created @dev using qdev_new(), you probably want to use
368 * qdev_realize_and_unref() instead.
370 bool qdev_realize(DeviceState
*dev
, BusState
*bus
, Error
**errp
);
373 * qdev_realize_and_unref: Realize @dev and drop a reference
374 * @dev: device to realize
375 * @bus: bus to plug it into (may be NULL)
376 * @errp: pointer to error object
378 * Realize @dev and drop a reference.
379 * This is like qdev_realize(), except the caller must hold a
380 * (private) reference, which is dropped on return regardless of
381 * success or failure. Intended use::
385 * qdev_realize_and_unref(dev, bus, errp);
387 * Now @dev can go away without further ado.
389 * If you are embedding the device into some other QOM device and
390 * initialized it via some variant on object_initialize_child() then
391 * do not use this function, because that family of functions arrange
392 * for the only reference to the child device to be held by the parent
393 * via the child<> property, and so the reference-count-drop done here
394 * would be incorrect. For that use case you want qdev_realize().
396 bool qdev_realize_and_unref(DeviceState
*dev
, BusState
*bus
, Error
**errp
);
399 * qdev_unrealize: Unrealize a device
400 * @dev: device to unrealize
402 * This function will "unrealize" a device, which is the first phase
403 * of correctly destroying a device that has been realized. It will:
405 * - unrealize any child buses by calling qbus_unrealize()
406 * (this will recursively unrealize any devices on those buses)
407 * - call the unrealize method of @dev
409 * The device can then be freed by causing its reference count to go
412 * Warning: most devices in QEMU do not expect to be unrealized. Only
413 * devices which are hot-unpluggable should be unrealized (as part of
414 * the unplugging process); all other devices are expected to last for
415 * the life of the simulation and should not be unrealized and freed.
417 void qdev_unrealize(DeviceState
*dev
);
418 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
419 int required_for_version
);
420 HotplugHandler
*qdev_get_bus_hotplug_handler(DeviceState
*dev
);
421 HotplugHandler
*qdev_get_machine_hotplug_handler(DeviceState
*dev
);
422 bool qdev_hotplug_allowed(DeviceState
*dev
, Error
**errp
);
424 * qdev_get_hotplug_handler: Get handler responsible for device wiring
426 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it.
428 * Note: in case @dev has a parent bus, it will be returned as handler unless
429 * machine handler overrides it.
431 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface
432 * or NULL if there aren't any.
434 HotplugHandler
*qdev_get_hotplug_handler(DeviceState
*dev
);
435 void qdev_unplug(DeviceState
*dev
, Error
**errp
);
436 void qdev_simple_device_unplug_cb(HotplugHandler
*hotplug_dev
,
437 DeviceState
*dev
, Error
**errp
);
438 void qdev_machine_creation_done(void);
439 bool qdev_machine_modified(void);
442 * qdev_add_unplug_blocker: Add an unplug blocker to a device
444 * @dev: Device to be blocked from unplug
445 * @reason: Reason for blocking
447 void qdev_add_unplug_blocker(DeviceState
*dev
, Error
*reason
);
450 * qdev_del_unplug_blocker: Remove an unplug blocker from a device
452 * @dev: Device to be unblocked
453 * @reason: Pointer to the Error used with qdev_add_unplug_blocker.
454 * Used as a handle to lookup the blocker for deletion.
456 void qdev_del_unplug_blocker(DeviceState
*dev
, Error
*reason
);
459 * qdev_unplug_blocked: Confirm if a device is blocked from unplug
461 * @dev: Device to be tested
462 * @reason: Returns one of the reasons why the device is blocked,
465 * Returns: true if device is blocked from unplug, false otherwise
467 bool qdev_unplug_blocked(DeviceState
*dev
, Error
**errp
);
470 * GpioPolarity: Polarity of a GPIO line
472 * GPIO lines use either positive (active-high) logic,
473 * or negative (active-low) logic.
475 * In active-high logic (%GPIO_POLARITY_ACTIVE_HIGH), a pin is
476 * active when the voltage on the pin is high (relative to ground);
477 * whereas in active-low logic (%GPIO_POLARITY_ACTIVE_LOW), a pin
478 * is active when the voltage on the pin is low (or grounded).
481 GPIO_POLARITY_ACTIVE_LOW
,
482 GPIO_POLARITY_ACTIVE_HIGH
486 * qdev_get_gpio_in: Get one of a device's anonymous input GPIO lines
487 * @dev: Device whose GPIO we want
488 * @n: Number of the anonymous GPIO line (which must be in range)
490 * Returns the qemu_irq corresponding to an anonymous input GPIO line
491 * (which the device has set up with qdev_init_gpio_in()). The index
492 * @n of the GPIO line must be valid (i.e. be at least 0 and less than
493 * the total number of anonymous input GPIOs the device has); this
494 * function will assert() if passed an invalid index.
496 * This function is intended to be used by board code or SoC "container"
497 * device models to wire up the GPIO lines; usually the return value
498 * will be passed to qdev_connect_gpio_out() or a similar function to
499 * connect another device's output GPIO line to this input.
501 * For named input GPIO lines, use qdev_get_gpio_in_named().
503 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
);
506 * qdev_get_gpio_in_named: Get one of a device's named input GPIO lines
507 * @dev: Device whose GPIO we want
508 * @name: Name of the input GPIO array
509 * @n: Number of the GPIO line in that array (which must be in range)
511 * Returns the qemu_irq corresponding to a named input GPIO line
512 * (which the device has set up with qdev_init_gpio_in_named()).
513 * The @name string must correspond to an input GPIO array which exists on
514 * the device, and the index @n of the GPIO line must be valid (i.e.
515 * be at least 0 and less than the total number of input GPIOs in that
516 * array); this function will assert() if passed an invalid name or index.
518 * For anonymous input GPIO lines, use qdev_get_gpio_in().
520 qemu_irq
qdev_get_gpio_in_named(DeviceState
*dev
, const char *name
, int n
);
523 * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
524 * @dev: Device whose GPIO to connect
525 * @n: Number of the anonymous output GPIO line (which must be in range)
526 * @input_pin: qemu_irq to connect the output line to
528 * This function connects an anonymous output GPIO line on a device
529 * up to an arbitrary qemu_irq, so that when the device asserts that
530 * output GPIO line, the qemu_irq's callback is invoked.
531 * The index @n of the GPIO line must be valid (i.e. be at least 0 and
532 * less than the total number of anonymous output GPIOs the device has
533 * created with qdev_init_gpio_out()); otherwise this function will assert().
535 * Outbound GPIO lines can be connected to any qemu_irq, but the common
536 * case is connecting them to another device's inbound GPIO line, using
537 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named().
539 * It is not valid to try to connect one outbound GPIO to multiple
540 * qemu_irqs at once, or to connect multiple outbound GPIOs to the
541 * same qemu_irq. (Warning: there is no assertion or other guard to
542 * catch this error: the model will just not do the right thing.)
543 * Instead, for fan-out you can use the TYPE_SPLIT_IRQ device: connect
544 * a device's outbound GPIO to the splitter's input, and connect each
545 * of the splitter's outputs to a different device. For fan-in you
546 * can use the TYPE_OR_IRQ device, which is a model of a logical OR
547 * gate with multiple inputs and one output.
549 * For named output GPIO lines, use qdev_connect_gpio_out_named().
551 void qdev_connect_gpio_out(DeviceState
*dev
, int n
, qemu_irq pin
);
554 * qdev_connect_gpio_out_named: Connect one of a device's named output
556 * @dev: Device whose GPIO to connect
557 * @name: Name of the output GPIO array
558 * @n: Number of the anonymous output GPIO line (which must be in range)
559 * @input_pin: qemu_irq to connect the output line to
561 * This function connects an anonymous output GPIO line on a device
562 * up to an arbitrary qemu_irq, so that when the device asserts that
563 * output GPIO line, the qemu_irq's callback is invoked.
564 * The @name string must correspond to an output GPIO array which exists on
565 * the device, and the index @n of the GPIO line must be valid (i.e.
566 * be at least 0 and less than the total number of input GPIOs in that
567 * array); this function will assert() if passed an invalid name or index.
569 * Outbound GPIO lines can be connected to any qemu_irq, but the common
570 * case is connecting them to another device's inbound GPIO line, using
571 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named().
573 * It is not valid to try to connect one outbound GPIO to multiple
574 * qemu_irqs at once, or to connect multiple outbound GPIOs to the
575 * same qemu_irq; see qdev_connect_gpio_out() for details.
577 * For anonymous output GPIO lines, use qdev_connect_gpio_out().
579 void qdev_connect_gpio_out_named(DeviceState
*dev
, const char *name
, int n
,
583 * qdev_get_gpio_out_connector: Get the qemu_irq connected to an output GPIO
584 * @dev: Device whose output GPIO we are interested in
585 * @name: Name of the output GPIO array
586 * @n: Number of the output GPIO line within that array
588 * Returns whatever qemu_irq is currently connected to the specified
589 * output GPIO line of @dev. This will be NULL if the output GPIO line
590 * has never been wired up to the anything. Note that the qemu_irq
591 * returned does not belong to @dev -- it will be the input GPIO or
592 * IRQ of whichever device the board code has connected up to @dev's
595 * You probably don't need to use this function -- it is used only
596 * by the platform-bus subsystem.
598 qemu_irq
qdev_get_gpio_out_connector(DeviceState
*dev
, const char *name
, int n
);
601 * qdev_intercept_gpio_out: Intercept an existing GPIO connection
602 * @dev: Device to intercept the outbound GPIO line from
603 * @icpt: New qemu_irq to connect instead
604 * @name: Name of the output GPIO array
605 * @n: Number of the GPIO line in the array
607 * This function is provided only for use by the qtest testing framework
608 * and is not suitable for use in non-testing parts of QEMU.
610 * This function breaks an existing connection of an outbound GPIO
611 * line from @dev, and replaces it with the new qemu_irq @icpt, as if
612 * ``qdev_connect_gpio_out_named(dev, icpt, name, n)`` had been called.
613 * The previously connected qemu_irq is returned, so it can be restored
614 * by a second call to qdev_intercept_gpio_out() if desired.
616 qemu_irq
qdev_intercept_gpio_out(DeviceState
*dev
, qemu_irq icpt
,
617 const char *name
, int n
);
619 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
);
621 /*** Device API. ***/
624 * qdev_init_gpio_in: create an array of anonymous input GPIO lines
625 * @dev: Device to create input GPIOs for
626 * @handler: Function to call when GPIO line value is set
627 * @n: Number of GPIO lines to create
629 * Devices should use functions in the qdev_init_gpio_in* family in
630 * their instance_init or realize methods to create any input GPIO
631 * lines they need. There is no functional difference between
632 * anonymous and named GPIO lines. Stylistically, named GPIOs are
633 * preferable (easier to understand at callsites) unless a device
634 * has exactly one uniform kind of GPIO input whose purpose is obvious.
635 * Note that input GPIO lines can serve as 'sinks' for IRQ lines.
637 * See qdev_get_gpio_in() for how code that uses such a device can get
638 * hold of an input GPIO line to manipulate it.
640 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
);
643 * qdev_init_gpio_out: create an array of anonymous output GPIO lines
644 * @dev: Device to create output GPIOs for
645 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
646 * @n: Number of GPIO lines to create
648 * Devices should use functions in the qdev_init_gpio_out* family
649 * in their instance_init or realize methods to create any output
650 * GPIO lines they need. There is no functional difference between
651 * anonymous and named GPIO lines. Stylistically, named GPIOs are
652 * preferable (easier to understand at callsites) unless a device
653 * has exactly one uniform kind of GPIO output whose purpose is obvious.
655 * The @pins argument should be a pointer to either a "qemu_irq"
656 * (if @n == 1) or a "qemu_irq []" array (if @n > 1) in the device's
657 * state structure. The device implementation can then raise and
658 * lower the GPIO line by calling qemu_set_irq(). (If anything is
659 * connected to the other end of the GPIO this will cause the handler
660 * function for that input GPIO to be called.)
662 * See qdev_connect_gpio_out() for how code that uses such a device
663 * can connect to one of its output GPIO lines.
665 * There is no need to release the @pins allocated array because it
666 * will be automatically released when @dev calls its instance_finalize()
669 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
);
672 * qdev_init_gpio_out_named: create an array of named output GPIO lines
673 * @dev: Device to create output GPIOs for
674 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
675 * @name: Name to give this array of GPIO lines
676 * @n: Number of GPIO lines to create
678 * Like qdev_init_gpio_out(), but creates an array of GPIO output lines
679 * with a name. Code using the device can then connect these GPIO lines
680 * using qdev_connect_gpio_out_named().
682 void qdev_init_gpio_out_named(DeviceState
*dev
, qemu_irq
*pins
,
683 const char *name
, int n
);
686 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines
687 * for the specified device
689 * @dev: Device to create input GPIOs for
690 * @handler: Function to call when GPIO line value is set
691 * @opaque: Opaque data pointer to pass to @handler
692 * @name: Name of the GPIO input (must be unique for this device)
693 * @n: Number of GPIO lines in this input set
695 void qdev_init_gpio_in_named_with_opaque(DeviceState
*dev
,
696 qemu_irq_handler handler
,
698 const char *name
, int n
);
701 * qdev_init_gpio_in_named: create an array of input GPIO lines
702 * for the specified device
704 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer
705 * passed to the handler is @dev (which is the most commonly desired behaviour).
707 static inline void qdev_init_gpio_in_named(DeviceState
*dev
,
708 qemu_irq_handler handler
,
709 const char *name
, int n
)
711 qdev_init_gpio_in_named_with_opaque(dev
, handler
, dev
, name
, n
);
715 * qdev_pass_gpios: create GPIO lines on container which pass through to device
716 * @dev: Device which has GPIO lines
717 * @container: Container device which needs to expose them
718 * @name: Name of GPIO array to pass through (NULL for the anonymous GPIO array)
720 * In QEMU, complicated devices like SoCs are often modelled with a
721 * "container" QOM device which itself contains other QOM devices and
722 * which wires them up appropriately. This function allows the container
723 * to create GPIO arrays on itself which simply pass through to a GPIO
724 * array of one of its internal devices.
726 * If @dev has both input and output GPIOs named @name then both will
727 * be passed through. It is not possible to pass a subset of the array
728 * with this function.
730 * To users of the container device, the GPIO array created on @container
731 * behaves exactly like any other.
733 void qdev_pass_gpios(DeviceState
*dev
, DeviceState
*container
,
736 BusState
*qdev_get_parent_bus(const DeviceState
*dev
);
740 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
);
742 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
743 typedef int (qbus_walkerfn
)(BusState
*bus
, void *opaque
);
744 typedef int (qdev_walkerfn
)(DeviceState
*dev
, void *opaque
);
746 void qbus_init(void *bus
, size_t size
, const char *typename
,
747 DeviceState
*parent
, const char *name
);
748 BusState
*qbus_new(const char *typename
, DeviceState
*parent
, const char *name
);
749 bool qbus_realize(BusState
*bus
, Error
**errp
);
750 void qbus_unrealize(BusState
*bus
);
752 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
753 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
755 int qbus_walk_children(BusState
*bus
,
756 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
757 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
759 int qdev_walk_children(DeviceState
*dev
,
760 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
761 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
766 * Reset device @dev and perform a recursive processing using the resettable
767 * interface. It triggers a RESET_TYPE_COLD.
769 void device_cold_reset(DeviceState
*dev
);
774 * Reset bus @bus and perform a recursive processing using the resettable
775 * interface. It triggers a RESET_TYPE_COLD.
777 void bus_cold_reset(BusState
*bus
);
780 * device_is_in_reset:
781 * Return true if the device @dev is currently being reset.
783 bool device_is_in_reset(DeviceState
*dev
);
787 * Return true if the bus @bus is currently being reset.
789 bool bus_is_in_reset(BusState
*bus
);
791 /* This should go away once we get rid of the NULL bus hack */
792 BusState
*sysbus_get_default(void);
794 char *qdev_get_fw_dev_path(DeviceState
*dev
);
795 char *qdev_get_own_fw_dev_path_from_handler(BusState
*bus
, DeviceState
*dev
);
797 void device_class_set_props(DeviceClass
*dc
, Property
*props
);
800 * device_class_set_parent_reset:
801 * TODO: remove the function when DeviceClass's reset method
802 * is not used anymore.
804 void device_class_set_parent_reset(DeviceClass
*dc
,
805 DeviceReset dev_reset
,
806 DeviceReset
*parent_reset
);
807 void device_class_set_parent_realize(DeviceClass
*dc
,
808 DeviceRealize dev_realize
,
809 DeviceRealize
*parent_realize
);
810 void device_class_set_parent_unrealize(DeviceClass
*dc
,
811 DeviceUnrealize dev_unrealize
,
812 DeviceUnrealize
*parent_unrealize
);
814 const VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
);
816 const char *qdev_fw_name(DeviceState
*dev
);
818 void qdev_assert_realized_properly(void);
819 Object
*qdev_get_machine(void);
821 /* FIXME: make this a link<> */
822 bool qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
, Error
**errp
);
824 extern bool qdev_hot_removed
;
826 char *qdev_get_dev_path(DeviceState
*dev
);
828 void qbus_set_hotplug_handler(BusState
*bus
, Object
*handler
);
829 void qbus_set_bus_hotplug_handler(BusState
*bus
);
831 static inline bool qbus_is_hotpluggable(BusState
*bus
)
833 HotplugHandler
*plug_handler
= bus
->hotplug_handler
;
834 bool ret
= !!plug_handler
;
837 HotplugHandlerClass
*hdc
;
839 hdc
= HOTPLUG_HANDLER_GET_CLASS(plug_handler
);
840 if (hdc
->is_hotpluggable_bus
) {
841 ret
= hdc
->is_hotpluggable_bus(plug_handler
, bus
);
848 * qbus_mark_full: Mark this bus as full, so no more devices can be attached
849 * @bus: Bus to mark as full
851 * By default, QEMU will allow devices to be plugged into a bus up
852 * to the bus class's device count limit. Calling this function
853 * marks a particular bus as full, so that no more devices can be
854 * plugged into it. In particular this means that the bus will not
855 * be considered as a candidate for plugging in devices created by
856 * the user on the commandline or via the monitor.
857 * If a machine has multiple buses of a given type, such as I2C,
858 * where some of those buses in the real hardware are used only for
859 * internal devices and some are exposed via expansion ports, you
860 * can use this function to mark the internal-only buses as full
861 * after you have created all their internal devices. Then user
862 * created devices will appear on the expansion-port bus where
863 * guest software expects them.
865 static inline void qbus_mark_full(BusState
*bus
)
870 void device_listener_register(DeviceListener
*listener
);
871 void device_listener_unregister(DeviceListener
*listener
);
874 * @qdev_should_hide_device:
875 * @opts: options QDict
876 * @from_json: true if @opts entries are typed, false for all strings
877 * @errp: pointer to error object
879 * Check if a device should be added.
880 * When a device is added via qdev_device_add() this will be called,
881 * and return if the device should be added now or not.
883 bool qdev_should_hide_device(const QDict
*opts
, bool from_json
, Error
**errp
);
885 typedef enum MachineInitPhase
{
886 /* current_machine is NULL. */
889 /* current_machine is not NULL, but current_machine->accel is NULL. */
890 PHASE_MACHINE_CREATED
,
893 * current_machine->accel is not NULL, but the machine properties have
894 * not been validated and machine_class->init has not yet been called.
899 * machine_class->init has been called, thus creating any embedded
900 * devices and validating machine properties. Devices created at
901 * this time are considered to be cold-plugged.
903 PHASE_MACHINE_INITIALIZED
,
906 * QEMU is ready to start CPUs and devices created at this time
907 * are considered to be hot-plugged. The monitor is not restricted
908 * to "preconfig" commands.
913 extern bool phase_check(MachineInitPhase phase
);
914 extern void phase_advance(MachineInitPhase phase
);