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