Merge remote-tracking branch 'remotes/rth/tags/pull-tcg-20210921' into staging
[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 "qemu/rcu.h"
7 #include "qemu/rcu_queue.h"
8 #include "qom/object.h"
9 #include "hw/hotplug.h"
10 #include "hw/resettable.h"
11
12 enum {
13 DEV_NVECTORS_UNSPECIFIED = -1,
14 };
15
16 #define TYPE_DEVICE "device"
17 OBJECT_DECLARE_TYPE(DeviceState, DeviceClass, 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().
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 hide_device() needs to
85 * be registered.
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.
95 *
96 */
97 struct DeviceClass {
98 /*< private >*/
99 ObjectClass parent_class;
100 /*< public >*/
101
102 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
103 const char *fw_name;
104 const char *desc;
105
106 /*
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.
109 */
110 Property *props_;
111
112 /*
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
120 * is cleared.
121 * TODO remove once we're there
122 */
123 bool user_creatable;
124 bool hotpluggable;
125
126 /* callbacks */
127 /*
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
131 */
132 DeviceReset reset;
133 DeviceRealize realize;
134 DeviceUnrealize unrealize;
135
136 /* device state */
137 const VMStateDescription *vmsd;
138
139 /* Private to qdev / bus. */
140 const char *bus_type;
141 };
142
143 typedef struct NamedGPIOList NamedGPIOList;
144
145 struct NamedGPIOList {
146 char *name;
147 qemu_irq *in;
148 int num_in;
149 int num_out;
150 QLIST_ENTRY(NamedGPIOList) node;
151 };
152
153 typedef struct Clock Clock;
154 typedef struct NamedClockList NamedClockList;
155
156 struct NamedClockList {
157 char *name;
158 Clock *clock;
159 bool output;
160 bool alias;
161 QLIST_ENTRY(NamedClockList) node;
162 };
163
164 /**
165 * DeviceState:
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.
170 *
171 * This structure should not be accessed directly. We declare it here
172 * so that it can be embedded in individual device state structures.
173 */
174 struct DeviceState {
175 /*< private >*/
176 Object parent_obj;
177 /*< public >*/
178
179 const char *id;
180 char *canonical_path;
181 bool realized;
182 bool pending_deleted_event;
183 QemuOpts *opts;
184 int hotplugged;
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;
190 int num_child_bus;
191 int instance_id_alias;
192 int alias_required_for_version;
193 ResettableState reset;
194 };
195
196 struct DeviceListener {
197 void (*realize)(DeviceListener *listener, DeviceState *dev);
198 void (*unrealize)(DeviceListener *listener, DeviceState *dev);
199 /*
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
203 * opts.
204 */
205 bool (*hide_device)(DeviceListener *listener, QemuOpts *device_opts);
206 QTAILQ_ENTRY(DeviceListener) link;
207 };
208
209 #define TYPE_BUS "bus"
210 DECLARE_OBJ_CHECKERS(BusState, BusClass,
211 BUS, TYPE_BUS)
212
213 struct BusClass {
214 ObjectClass parent_class;
215
216 /* FIXME first arg should be BusState */
217 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
218 char *(*get_dev_path)(DeviceState *dev);
219
220 /*
221 * This callback is used to create Open Firmware device path in accordance
222 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
223 * bindings can be found at http://playground.sun.com/1275/bindings/.
224 */
225 char *(*get_fw_dev_path)(DeviceState *dev);
226
227 void (*reset)(BusState *bus);
228
229 /*
230 * Return whether the device can be added to @bus,
231 * based on the address that was set (via device properties)
232 * before realize. If not, on return @errp contains the
233 * human-readable error message.
234 */
235 bool (*check_address)(BusState *bus, DeviceState *dev, Error **errp);
236
237 BusRealize realize;
238 BusUnrealize unrealize;
239
240 /* maximum devices allowed on the bus, 0: no limit. */
241 int max_dev;
242 /* number of automatically allocated bus ids (e.g. ide.0) */
243 int automatic_ids;
244 };
245
246 typedef struct BusChild {
247 struct rcu_head rcu;
248 DeviceState *child;
249 int index;
250 QTAILQ_ENTRY(BusChild) sibling;
251 } BusChild;
252
253 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
254
255 /**
256 * BusState:
257 * @hotplug_handler: link to a hotplug handler associated with bus.
258 * @reset: ResettableState for the bus; handled by Resettable interface.
259 */
260 struct BusState {
261 Object obj;
262 DeviceState *parent;
263 char *name;
264 HotplugHandler *hotplug_handler;
265 int max_index;
266 bool realized;
267 int num_children;
268
269 /*
270 * children is a RCU QTAILQ, thus readers must use RCU to access it,
271 * and writers must hold the big qemu lock
272 */
273
274 QTAILQ_HEAD(, BusChild) children;
275 QLIST_ENTRY(BusState) sibling;
276 ResettableState reset;
277 };
278
279 /**
280 * GlobalProperty:
281 * @used: Set to true if property was used when initializing a device.
282 * @optional: If set to true, GlobalProperty will be skipped without errors
283 * if the property doesn't exist.
284 *
285 * An error is fatal for non-hotplugged devices, when the global is applied.
286 */
287 typedef struct GlobalProperty {
288 const char *driver;
289 const char *property;
290 const char *value;
291 bool used;
292 bool optional;
293 } GlobalProperty;
294
295 static inline void
296 compat_props_add(GPtrArray *arr,
297 GlobalProperty props[], size_t nelem)
298 {
299 int i;
300 for (i = 0; i < nelem; i++) {
301 g_ptr_array_add(arr, (void *)&props[i]);
302 }
303 }
304
305 /*** Board API. This should go away once we have a machine config file. ***/
306
307 /**
308 * qdev_new: Create a device on the heap
309 * @name: device type to create (we assert() that this type exists)
310 *
311 * This only allocates the memory and initializes the device state
312 * structure, ready for the caller to set properties if they wish.
313 * The device still needs to be realized.
314 * The returned object has a reference count of 1.
315 */
316 DeviceState *qdev_new(const char *name);
317 /**
318 * qdev_try_new: Try to create a device on the heap
319 * @name: device type to create
320 *
321 * This is like qdev_new(), except it returns %NULL when type @name
322 * does not exist, rather than asserting.
323 */
324 DeviceState *qdev_try_new(const char *name);
325 /**
326 * qdev_realize: Realize @dev.
327 * @dev: device to realize
328 * @bus: bus to plug it into (may be NULL)
329 * @errp: pointer to error object
330 *
331 * "Realize" the device, i.e. perform the second phase of device
332 * initialization.
333 * @dev must not be plugged into a bus already.
334 * If @bus, plug @dev into @bus. This takes a reference to @dev.
335 * If @dev has no QOM parent, make one up, taking another reference.
336 * On success, return true.
337 * On failure, store an error through @errp and return false.
338 *
339 * If you created @dev using qdev_new(), you probably want to use
340 * qdev_realize_and_unref() instead.
341 */
342 bool qdev_realize(DeviceState *dev, BusState *bus, Error **errp);
343 /**
344 * qdev_realize_and_unref: Realize @dev and drop a reference
345 * @dev: device to realize
346 * @bus: bus to plug it into (may be NULL)
347 * @errp: pointer to error object
348 *
349 * Realize @dev and drop a reference.
350 * This is like qdev_realize(), except the caller must hold a
351 * (private) reference, which is dropped on return regardless of
352 * success or failure. Intended use::
353 *
354 * dev = qdev_new();
355 * [...]
356 * qdev_realize_and_unref(dev, bus, errp);
357 *
358 * Now @dev can go away without further ado.
359 *
360 * If you are embedding the device into some other QOM device and
361 * initialized it via some variant on object_initialize_child() then
362 * do not use this function, because that family of functions arrange
363 * for the only reference to the child device to be held by the parent
364 * via the child<> property, and so the reference-count-drop done here
365 * would be incorrect. For that use case you want qdev_realize().
366 */
367 bool qdev_realize_and_unref(DeviceState *dev, BusState *bus, Error **errp);
368 /**
369 * qdev_unrealize: Unrealize a device
370 * @dev: device to unrealize
371 *
372 * This function will "unrealize" a device, which is the first phase
373 * of correctly destroying a device that has been realized. It will:
374 *
375 * - unrealize any child buses by calling qbus_unrealize()
376 * (this will recursively unrealize any devices on those buses)
377 * - call the the unrealize method of @dev
378 *
379 * The device can then be freed by causing its reference count to go
380 * to zero.
381 *
382 * Warning: most devices in QEMU do not expect to be unrealized. Only
383 * devices which are hot-unpluggable should be unrealized (as part of
384 * the unplugging process); all other devices are expected to last for
385 * the life of the simulation and should not be unrealized and freed.
386 */
387 void qdev_unrealize(DeviceState *dev);
388 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
389 int required_for_version);
390 HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev);
391 HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev);
392 bool qdev_hotplug_allowed(DeviceState *dev, Error **errp);
393 /**
394 * qdev_get_hotplug_handler: Get handler responsible for device wiring
395 *
396 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it.
397 *
398 * Note: in case @dev has a parent bus, it will be returned as handler unless
399 * machine handler overrides it.
400 *
401 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface
402 * or NULL if there aren't any.
403 */
404 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
405 void qdev_unplug(DeviceState *dev, Error **errp);
406 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
407 DeviceState *dev, Error **errp);
408 void qdev_machine_creation_done(void);
409 bool qdev_machine_modified(void);
410
411 /**
412 * GpioPolarity: Polarity of a GPIO line
413 *
414 * GPIO lines use either positive (active-high) logic,
415 * or negative (active-low) logic.
416 *
417 * In active-high logic (%GPIO_POLARITY_ACTIVE_HIGH), a pin is
418 * active when the voltage on the pin is high (relative to ground);
419 * whereas in active-low logic (%GPIO_POLARITY_ACTIVE_LOW), a pin
420 * is active when the voltage on the pin is low (or grounded).
421 */
422 typedef enum {
423 GPIO_POLARITY_ACTIVE_LOW,
424 GPIO_POLARITY_ACTIVE_HIGH
425 } GpioPolarity;
426
427 /**
428 * qdev_get_gpio_in: Get one of a device's anonymous input GPIO lines
429 * @dev: Device whose GPIO we want
430 * @n: Number of the anonymous GPIO line (which must be in range)
431 *
432 * Returns the qemu_irq corresponding to an anonymous input GPIO line
433 * (which the device has set up with qdev_init_gpio_in()). The index
434 * @n of the GPIO line must be valid (i.e. be at least 0 and less than
435 * the total number of anonymous input GPIOs the device has); this
436 * function will assert() if passed an invalid index.
437 *
438 * This function is intended to be used by board code or SoC "container"
439 * device models to wire up the GPIO lines; usually the return value
440 * will be passed to qdev_connect_gpio_out() or a similar function to
441 * connect another device's output GPIO line to this input.
442 *
443 * For named input GPIO lines, use qdev_get_gpio_in_named().
444 */
445 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
446 /**
447 * qdev_get_gpio_in_named: Get one of a device's named input GPIO lines
448 * @dev: Device whose GPIO we want
449 * @name: Name of the input GPIO array
450 * @n: Number of the GPIO line in that array (which must be in range)
451 *
452 * Returns the qemu_irq corresponding to a named input GPIO line
453 * (which the device has set up with qdev_init_gpio_in_named()).
454 * The @name string must correspond to an input GPIO array which exists on
455 * the device, and the index @n of the GPIO line must be valid (i.e.
456 * be at least 0 and less than the total number of input GPIOs in that
457 * array); this function will assert() if passed an invalid name or index.
458 *
459 * For anonymous input GPIO lines, use qdev_get_gpio_in().
460 */
461 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
462
463 /**
464 * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
465 * @dev: Device whose GPIO to connect
466 * @n: Number of the anonymous output GPIO line (which must be in range)
467 * @pin: qemu_irq to connect the output line to
468 *
469 * This function connects an anonymous output GPIO line on a device
470 * up to an arbitrary qemu_irq, so that when the device asserts that
471 * output GPIO line, the qemu_irq's callback is invoked.
472 * The index @n of the GPIO line must be valid (i.e. be at least 0 and
473 * less than the total number of anonymous output GPIOs the device has
474 * created with qdev_init_gpio_out()); otherwise this function will assert().
475 *
476 * Outbound GPIO lines can be connected to any qemu_irq, but the common
477 * case is connecting them to another device's inbound GPIO line, using
478 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named().
479 *
480 * It is not valid to try to connect one outbound GPIO to multiple
481 * qemu_irqs at once, or to connect multiple outbound GPIOs to the
482 * same qemu_irq. (Warning: there is no assertion or other guard to
483 * catch this error: the model will just not do the right thing.)
484 * Instead, for fan-out you can use the TYPE_IRQ_SPLIT device: connect
485 * a device's outbound GPIO to the splitter's input, and connect each
486 * of the splitter's outputs to a different device. For fan-in you
487 * can use the TYPE_OR_IRQ device, which is a model of a logical OR
488 * gate with multiple inputs and one output.
489 *
490 * For named output GPIO lines, use qdev_connect_gpio_out_named().
491 */
492 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
493 /**
494 * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines
495 * @dev: Device whose GPIO to connect
496 * @name: Name of the output GPIO array
497 * @n: Number of the anonymous output GPIO line (which must be in range)
498 * @pin: qemu_irq to connect the output line to
499 *
500 * This function connects an anonymous output GPIO line on a device
501 * up to an arbitrary qemu_irq, so that when the device asserts that
502 * output GPIO line, the qemu_irq's callback is invoked.
503 * The @name string must correspond to an output GPIO array which exists on
504 * the device, and the index @n of the GPIO line must be valid (i.e.
505 * be at least 0 and less than the total number of input GPIOs in that
506 * array); this function will assert() if passed an invalid name or index.
507 *
508 * Outbound GPIO lines can be connected to any qemu_irq, but the common
509 * case is connecting them to another device's inbound GPIO line, using
510 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named().
511 *
512 * It is not valid to try to connect one outbound GPIO to multiple
513 * qemu_irqs at once, or to connect multiple outbound GPIOs to the
514 * same qemu_irq; see qdev_connect_gpio_out() for details.
515 *
516 * For named output GPIO lines, use qdev_connect_gpio_out_named().
517 */
518 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
519 qemu_irq pin);
520 /**
521 * qdev_get_gpio_out_connector: Get the qemu_irq connected to an output GPIO
522 * @dev: Device whose output GPIO we are interested in
523 * @name: Name of the output GPIO array
524 * @n: Number of the output GPIO line within that array
525 *
526 * Returns whatever qemu_irq is currently connected to the specified
527 * output GPIO line of @dev. This will be NULL if the output GPIO line
528 * has never been wired up to the anything. Note that the qemu_irq
529 * returned does not belong to @dev -- it will be the input GPIO or
530 * IRQ of whichever device the board code has connected up to @dev's
531 * output GPIO.
532 *
533 * You probably don't need to use this function -- it is used only
534 * by the platform-bus subsystem.
535 */
536 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
537 /**
538 * qdev_intercept_gpio_out: Intercept an existing GPIO connection
539 * @dev: Device to intercept the outbound GPIO line from
540 * @icpt: New qemu_irq to connect instead
541 * @name: Name of the output GPIO array
542 * @n: Number of the GPIO line in the array
543 *
544 * This function is provided only for use by the qtest testing framework
545 * and is not suitable for use in non-testing parts of QEMU.
546 *
547 * This function breaks an existing connection of an outbound GPIO
548 * line from @dev, and replaces it with the new qemu_irq @icpt, as if
549 * ``qdev_connect_gpio_out_named(dev, icpt, name, n)`` had been called.
550 * The previously connected qemu_irq is returned, so it can be restored
551 * by a second call to qdev_intercept_gpio_out() if desired.
552 */
553 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
554 const char *name, int n);
555
556 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
557
558 /*** Device API. ***/
559
560 /**
561 * qdev_init_gpio_in: create an array of anonymous input GPIO lines
562 * @dev: Device to create input GPIOs for
563 * @handler: Function to call when GPIO line value is set
564 * @n: Number of GPIO lines to create
565 *
566 * Devices should use functions in the qdev_init_gpio_in* family in
567 * their instance_init or realize methods to create any input GPIO
568 * lines they need. There is no functional difference between
569 * anonymous and named GPIO lines. Stylistically, named GPIOs are
570 * preferable (easier to understand at callsites) unless a device
571 * has exactly one uniform kind of GPIO input whose purpose is obvious.
572 * Note that input GPIO lines can serve as 'sinks' for IRQ lines.
573 *
574 * See qdev_get_gpio_in() for how code that uses such a device can get
575 * hold of an input GPIO line to manipulate it.
576 */
577 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
578 /**
579 * qdev_init_gpio_out: create an array of anonymous output GPIO lines
580 * @dev: Device to create output GPIOs for
581 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
582 * @n: Number of GPIO lines to create
583 *
584 * Devices should use functions in the qdev_init_gpio_out* family
585 * in their instance_init or realize methods to create any output
586 * GPIO lines they need. There is no functional difference between
587 * anonymous and named GPIO lines. Stylistically, named GPIOs are
588 * preferable (easier to understand at callsites) unless a device
589 * has exactly one uniform kind of GPIO output whose purpose is obvious.
590 *
591 * The @pins argument should be a pointer to either a "qemu_irq"
592 * (if @n == 1) or a "qemu_irq []" array (if @n > 1) in the device's
593 * state structure. The device implementation can then raise and
594 * lower the GPIO line by calling qemu_set_irq(). (If anything is
595 * connected to the other end of the GPIO this will cause the handler
596 * function for that input GPIO to be called.)
597 *
598 * See qdev_connect_gpio_out() for how code that uses such a device
599 * can connect to one of its output GPIO lines.
600 */
601 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
602 /**
603 * qdev_init_gpio_out: create an array of named output GPIO lines
604 * @dev: Device to create output GPIOs for
605 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines
606 * @name: Name to give this array of GPIO lines
607 * @n: Number of GPIO lines to create
608 *
609 * Like qdev_init_gpio_out(), but creates an array of GPIO output lines
610 * with a name. Code using the device can then connect these GPIO lines
611 * using qdev_connect_gpio_out_named().
612 */
613 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
614 const char *name, int n);
615 /**
616 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines
617 * for the specified device
618 *
619 * @dev: Device to create input GPIOs for
620 * @handler: Function to call when GPIO line value is set
621 * @opaque: Opaque data pointer to pass to @handler
622 * @name: Name of the GPIO input (must be unique for this device)
623 * @n: Number of GPIO lines in this input set
624 */
625 void qdev_init_gpio_in_named_with_opaque(DeviceState *dev,
626 qemu_irq_handler handler,
627 void *opaque,
628 const char *name, int n);
629
630 /**
631 * qdev_init_gpio_in_named: create an array of input GPIO lines
632 * for the specified device
633 *
634 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer
635 * passed to the handler is @dev (which is the most commonly desired behaviour).
636 */
637 static inline void qdev_init_gpio_in_named(DeviceState *dev,
638 qemu_irq_handler handler,
639 const char *name, int n)
640 {
641 qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n);
642 }
643
644 /**
645 * qdev_pass_gpios: create GPIO lines on container which pass through to device
646 * @dev: Device which has GPIO lines
647 * @container: Container device which needs to expose them
648 * @name: Name of GPIO array to pass through (NULL for the anonymous GPIO array)
649 *
650 * In QEMU, complicated devices like SoCs are often modelled with a
651 * "container" QOM device which itself contains other QOM devices and
652 * which wires them up appropriately. This function allows the container
653 * to create GPIO arrays on itself which simply pass through to a GPIO
654 * array of one of its internal devices.
655 *
656 * If @dev has both input and output GPIOs named @name then both will
657 * be passed through. It is not possible to pass a subset of the array
658 * with this function.
659 *
660 * To users of the container device, the GPIO array created on @container
661 * behaves exactly like any other.
662 */
663 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
664 const char *name);
665
666 BusState *qdev_get_parent_bus(DeviceState *dev);
667
668 /*** BUS API. ***/
669
670 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
671
672 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
673 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
674 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
675
676 void qbus_create_inplace(void *bus, size_t size, const char *typename,
677 DeviceState *parent, const char *name);
678 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
679 bool qbus_realize(BusState *bus, Error **errp);
680 void qbus_unrealize(BusState *bus);
681
682 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
683 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
684 * 0 otherwise. */
685 int qbus_walk_children(BusState *bus,
686 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
687 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
688 void *opaque);
689 int qdev_walk_children(DeviceState *dev,
690 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
691 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
692 void *opaque);
693
694 /**
695 * @qdev_reset_all:
696 * Reset @dev. See @qbus_reset_all() for more details.
697 *
698 * Note: This function is deprecated and will be removed when it becomes unused.
699 * Please use device_cold_reset() now.
700 */
701 void qdev_reset_all(DeviceState *dev);
702 void qdev_reset_all_fn(void *opaque);
703
704 /**
705 * @qbus_reset_all:
706 * @bus: Bus to be reset.
707 *
708 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
709 * to it, including recursive processing of all buses below @bus itself. A
710 * hard reset means that qbus_reset_all will reset all state of the device.
711 * For PCI devices, for example, this will include the base address registers
712 * or configuration space.
713 *
714 * Note: This function is deprecated and will be removed when it becomes unused.
715 * Please use bus_cold_reset() now.
716 */
717 void qbus_reset_all(BusState *bus);
718 void qbus_reset_all_fn(void *opaque);
719
720 /**
721 * device_cold_reset:
722 * Reset device @dev and perform a recursive processing using the resettable
723 * interface. It triggers a RESET_TYPE_COLD.
724 */
725 void device_cold_reset(DeviceState *dev);
726
727 /**
728 * bus_cold_reset:
729 *
730 * Reset bus @bus and perform a recursive processing using the resettable
731 * interface. It triggers a RESET_TYPE_COLD.
732 */
733 void bus_cold_reset(BusState *bus);
734
735 /**
736 * device_is_in_reset:
737 * Return true if the device @dev is currently being reset.
738 */
739 bool device_is_in_reset(DeviceState *dev);
740
741 /**
742 * bus_is_in_reset:
743 * Return true if the bus @bus is currently being reset.
744 */
745 bool bus_is_in_reset(BusState *bus);
746
747 /* This should go away once we get rid of the NULL bus hack */
748 BusState *sysbus_get_default(void);
749
750 char *qdev_get_fw_dev_path(DeviceState *dev);
751 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
752
753 /**
754 * device_legacy_reset:
755 *
756 * Reset a single device (by calling the reset method).
757 * Note: This function is deprecated and will be removed when it becomes unused.
758 * Please use device_cold_reset() now.
759 */
760 void device_legacy_reset(DeviceState *dev);
761
762 void device_class_set_props(DeviceClass *dc, Property *props);
763
764 /**
765 * device_class_set_parent_reset:
766 * TODO: remove the function when DeviceClass's reset method
767 * is not used anymore.
768 */
769 void device_class_set_parent_reset(DeviceClass *dc,
770 DeviceReset dev_reset,
771 DeviceReset *parent_reset);
772 void device_class_set_parent_realize(DeviceClass *dc,
773 DeviceRealize dev_realize,
774 DeviceRealize *parent_realize);
775 void device_class_set_parent_unrealize(DeviceClass *dc,
776 DeviceUnrealize dev_unrealize,
777 DeviceUnrealize *parent_unrealize);
778
779 const VMStateDescription *qdev_get_vmsd(DeviceState *dev);
780
781 const char *qdev_fw_name(DeviceState *dev);
782
783 void qdev_assert_realized_properly(void);
784 Object *qdev_get_machine(void);
785
786 /* FIXME: make this a link<> */
787 bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp);
788
789 extern bool qdev_hot_removed;
790
791 char *qdev_get_dev_path(DeviceState *dev);
792
793 void qbus_set_hotplug_handler(BusState *bus, Object *handler);
794 void qbus_set_bus_hotplug_handler(BusState *bus);
795
796 static inline bool qbus_is_hotpluggable(BusState *bus)
797 {
798 return bus->hotplug_handler;
799 }
800
801 void device_listener_register(DeviceListener *listener);
802 void device_listener_unregister(DeviceListener *listener);
803
804 /**
805 * @qdev_should_hide_device:
806 * @opts: QemuOpts as passed on cmdline.
807 *
808 * Check if a device should be added.
809 * When a device is added via qdev_device_add() this will be called,
810 * and return if the device should be added now or not.
811 */
812 bool qdev_should_hide_device(QemuOpts *opts);
813
814 typedef enum MachineInitPhase {
815 /* current_machine is NULL. */
816 PHASE_NO_MACHINE,
817
818 /* current_machine is not NULL, but current_machine->accel is NULL. */
819 PHASE_MACHINE_CREATED,
820
821 /*
822 * current_machine->accel is not NULL, but the machine properties have
823 * not been validated and machine_class->init has not yet been called.
824 */
825 PHASE_ACCEL_CREATED,
826
827 /*
828 * machine_class->init has been called, thus creating any embedded
829 * devices and validating machine properties. Devices created at
830 * this time are considered to be cold-plugged.
831 */
832 PHASE_MACHINE_INITIALIZED,
833
834 /*
835 * QEMU is ready to start CPUs and devices created at this time
836 * are considered to be hot-plugged. The monitor is not restricted
837 * to "preconfig" commands.
838 */
839 PHASE_MACHINE_READY,
840 } MachineInitPhase;
841
842 extern bool phase_check(MachineInitPhase phase);
843 extern void phase_advance(MachineInitPhase phase);
844
845 #endif