ppc/pnv: Add a HIOMAP erase command
[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 "qom/object.h"
7 #include "hw/hotplug.h"
8 #include "hw/resettable.h"
9
10 enum {
11 DEV_NVECTORS_UNSPECIFIED = -1,
12 };
13
14 #define TYPE_DEVICE "device"
15 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
16 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
17 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
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 typedef 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 } DeviceClass;
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 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
207 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
208 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
209
210 struct BusClass {
211 ObjectClass parent_class;
212
213 /* FIXME first arg should be BusState */
214 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
215 char *(*get_dev_path)(DeviceState *dev);
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 void (*reset)(BusState *bus);
223 BusRealize realize;
224 BusUnrealize unrealize;
225
226 /* maximum devices allowed on the bus, 0: no limit. */
227 int max_dev;
228 /* number of automatically allocated bus ids (e.g. ide.0) */
229 int automatic_ids;
230 };
231
232 typedef struct BusChild {
233 DeviceState *child;
234 int index;
235 QTAILQ_ENTRY(BusChild) sibling;
236 } BusChild;
237
238 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
239
240 /**
241 * BusState:
242 * @hotplug_handler: link to a hotplug handler associated with bus.
243 * @reset: ResettableState for the bus; handled by Resettable interface.
244 */
245 struct BusState {
246 Object obj;
247 DeviceState *parent;
248 char *name;
249 HotplugHandler *hotplug_handler;
250 int max_index;
251 bool realized;
252 int num_children;
253 QTAILQ_HEAD(, BusChild) children;
254 QLIST_ENTRY(BusState) sibling;
255 ResettableState reset;
256 };
257
258 /**
259 * Property:
260 * @set_default: true if the default value should be set from @defval,
261 * in which case @info->set_default_value must not be NULL
262 * (if false then no default value is set by the property system
263 * and the field retains whatever value it was given by instance_init).
264 * @defval: default value for the property. This is used only if @set_default
265 * is true.
266 */
267 struct Property {
268 const char *name;
269 const PropertyInfo *info;
270 ptrdiff_t offset;
271 uint8_t bitnr;
272 bool set_default;
273 union {
274 int64_t i;
275 uint64_t u;
276 } defval;
277 int arrayoffset;
278 const PropertyInfo *arrayinfo;
279 int arrayfieldsize;
280 const char *link_type;
281 };
282
283 struct PropertyInfo {
284 const char *name;
285 const char *description;
286 const QEnumLookup *enum_table;
287 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
288 void (*set_default_value)(ObjectProperty *op, const Property *prop);
289 void (*create)(ObjectClass *oc, Property *prop);
290 ObjectPropertyAccessor *get;
291 ObjectPropertyAccessor *set;
292 ObjectPropertyRelease *release;
293 };
294
295 /**
296 * GlobalProperty:
297 * @used: Set to true if property was used when initializing a device.
298 * @optional: If set to true, GlobalProperty will be skipped without errors
299 * if the property doesn't exist.
300 *
301 * An error is fatal for non-hotplugged devices, when the global is applied.
302 */
303 typedef struct GlobalProperty {
304 const char *driver;
305 const char *property;
306 const char *value;
307 bool used;
308 bool optional;
309 } GlobalProperty;
310
311 static inline void
312 compat_props_add(GPtrArray *arr,
313 GlobalProperty props[], size_t nelem)
314 {
315 int i;
316 for (i = 0; i < nelem; i++) {
317 g_ptr_array_add(arr, (void *)&props[i]);
318 }
319 }
320
321 /*** Board API. This should go away once we have a machine config file. ***/
322
323 /**
324 * qdev_new: Create a device on the heap
325 * @name: device type to create (we assert() that this type exists)
326 *
327 * This only allocates the memory and initializes the device state
328 * structure, ready for the caller to set properties if they wish.
329 * The device still needs to be realized.
330 * The returned object has a reference count of 1.
331 */
332 DeviceState *qdev_new(const char *name);
333 /**
334 * qdev_try_new: Try to create a device on the heap
335 * @name: device type to create
336 *
337 * This is like qdev_new(), except it returns %NULL when type @name
338 * does not exist, rather than asserting.
339 */
340 DeviceState *qdev_try_new(const char *name);
341 /**
342 * qdev_realize: Realize @dev.
343 * @dev: device to realize
344 * @bus: bus to plug it into (may be NULL)
345 * @errp: pointer to error object
346 *
347 * "Realize" the device, i.e. perform the second phase of device
348 * initialization.
349 * @dev must not be plugged into a bus already.
350 * If @bus, plug @dev into @bus. This takes a reference to @dev.
351 * If @dev has no QOM parent, make one up, taking another reference.
352 * On success, return true.
353 * On failure, store an error through @errp and return false.
354 *
355 * If you created @dev using qdev_new(), you probably want to use
356 * qdev_realize_and_unref() instead.
357 */
358 bool qdev_realize(DeviceState *dev, BusState *bus, Error **errp);
359 /**
360 * qdev_realize_and_unref: Realize @dev and drop a reference
361 * @dev: device to realize
362 * @bus: bus to plug it into (may be NULL)
363 * @errp: pointer to error object
364 *
365 * Realize @dev and drop a reference.
366 * This is like qdev_realize(), except the caller must hold a
367 * (private) reference, which is dropped on return regardless of
368 * success or failure. Intended use::
369 *
370 * dev = qdev_new();
371 * [...]
372 * qdev_realize_and_unref(dev, bus, errp);
373 *
374 * Now @dev can go away without further ado.
375 *
376 * If you are embedding the device into some other QOM device and
377 * initialized it via some variant on object_initialize_child() then
378 * do not use this function, because that family of functions arrange
379 * for the only reference to the child device to be held by the parent
380 * via the child<> property, and so the reference-count-drop done here
381 * would be incorrect. For that use case you want qdev_realize().
382 */
383 bool qdev_realize_and_unref(DeviceState *dev, BusState *bus, Error **errp);
384 /**
385 * qdev_unrealize: Unrealize a device
386 * @dev: device to unrealize
387 *
388 * This function will "unrealize" a device, which is the first phase
389 * of correctly destroying a device that has been realized. It will:
390 *
391 * - unrealize any child buses by calling qbus_unrealize()
392 * (this will recursively unrealize any devices on those buses)
393 * - call the the unrealize method of @dev
394 *
395 * The device can then be freed by causing its reference count to go
396 * to zero.
397 *
398 * Warning: most devices in QEMU do not expect to be unrealized. Only
399 * devices which are hot-unpluggable should be unrealized (as part of
400 * the unplugging process); all other devices are expected to last for
401 * the life of the simulation and should not be unrealized and freed.
402 */
403 void qdev_unrealize(DeviceState *dev);
404 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
405 int required_for_version);
406 HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev);
407 HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev);
408 bool qdev_hotplug_allowed(DeviceState *dev, Error **errp);
409 /**
410 * qdev_get_hotplug_handler: Get handler responsible for device wiring
411 *
412 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it.
413 *
414 * Note: in case @dev has a parent bus, it will be returned as handler unless
415 * machine handler overrides it.
416 *
417 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface
418 * or NULL if there aren't any.
419 */
420 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
421 void qdev_unplug(DeviceState *dev, Error **errp);
422 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
423 DeviceState *dev, Error **errp);
424 void qdev_machine_creation_done(void);
425 bool qdev_machine_modified(void);
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 * @qdev_machine_init
755 *
756 * Initialize platform devices before machine init. This is a hack until full
757 * support for composition is added.
758 */
759 void qdev_machine_init(void);
760
761 /**
762 * device_legacy_reset:
763 *
764 * Reset a single device (by calling the reset method).
765 * Note: This function is deprecated and will be removed when it becomes unused.
766 * Please use device_cold_reset() now.
767 */
768 void device_legacy_reset(DeviceState *dev);
769
770 void device_class_set_props(DeviceClass *dc, Property *props);
771
772 /**
773 * device_class_set_parent_reset:
774 * TODO: remove the function when DeviceClass's reset method
775 * is not used anymore.
776 */
777 void device_class_set_parent_reset(DeviceClass *dc,
778 DeviceReset dev_reset,
779 DeviceReset *parent_reset);
780 void device_class_set_parent_realize(DeviceClass *dc,
781 DeviceRealize dev_realize,
782 DeviceRealize *parent_realize);
783 void device_class_set_parent_unrealize(DeviceClass *dc,
784 DeviceUnrealize dev_unrealize,
785 DeviceUnrealize *parent_unrealize);
786
787 const VMStateDescription *qdev_get_vmsd(DeviceState *dev);
788
789 const char *qdev_fw_name(DeviceState *dev);
790
791 Object *qdev_get_machine(void);
792
793 /* FIXME: make this a link<> */
794 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
795
796 extern bool qdev_hotplug;
797 extern bool qdev_hot_removed;
798
799 char *qdev_get_dev_path(DeviceState *dev);
800
801 void qbus_set_hotplug_handler(BusState *bus, Object *handler);
802 void qbus_set_bus_hotplug_handler(BusState *bus);
803
804 static inline bool qbus_is_hotpluggable(BusState *bus)
805 {
806 return bus->hotplug_handler;
807 }
808
809 void device_listener_register(DeviceListener *listener);
810 void device_listener_unregister(DeviceListener *listener);
811
812 /**
813 * @qdev_should_hide_device:
814 * @opts: QemuOpts as passed on cmdline.
815 *
816 * Check if a device should be added.
817 * When a device is added via qdev_device_add() this will be called,
818 * and return if the device should be added now or not.
819 */
820 bool qdev_should_hide_device(QemuOpts *opts);
821
822 #endif