4 #include "qemu/queue.h"
5 #include "qemu/bitmap.h"
6 #include "qom/object.h"
8 #include "hw/hotplug.h"
11 DEV_NVECTORS_UNSPECIFIED
= -1,
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)
19 typedef enum DeviceCategory
{
20 DEVICE_CATEGORY_BRIDGE
,
22 DEVICE_CATEGORY_STORAGE
,
23 DEVICE_CATEGORY_NETWORK
,
24 DEVICE_CATEGORY_INPUT
,
25 DEVICE_CATEGORY_DISPLAY
,
26 DEVICE_CATEGORY_SOUND
,
32 typedef void (*DeviceRealize
)(DeviceState
*dev
, Error
**errp
);
33 typedef void (*DeviceUnrealize
)(DeviceState
*dev
, Error
**errp
);
34 typedef void (*DeviceReset
)(DeviceState
*dev
);
35 typedef void (*BusRealize
)(BusState
*bus
, Error
**errp
);
36 typedef void (*BusUnrealize
)(BusState
*bus
, Error
**errp
);
38 struct VMStateDescription
;
42 * @props: Properties accessing state fields.
43 * @realize: Callback function invoked when the #DeviceState:realized
44 * property is changed to %true.
45 * @unrealize: Callback function invoked when the #DeviceState:realized
46 * property is changed to %false.
47 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
48 * as readonly "hotpluggable" property of #DeviceState instance
51 * Devices are constructed in two stages,
52 * 1) object instantiation via object_initialize() and
53 * 2) device realization via #DeviceState:realized property.
54 * The former may not fail (and must not abort or exit, since it is called
55 * during device introspection already), and the latter may return error
56 * information to the caller and must be re-entrant.
57 * Trivial field initializations should go into #TypeInfo.instance_init.
58 * Operations depending on @props static properties should go into @realize.
59 * After successful realization, setting static properties will fail.
61 * As an interim step, the #DeviceState:realized property can also be
62 * set with qdev_init_nofail().
63 * In the future, devices will propagate this state change to their children
64 * and along busses they expose.
65 * The point in time will be deferred to machine creation, so that values
66 * set in @realize will not be introspectable beforehand. Therefore devices
67 * must not create children during @realize; they should initialize them via
68 * object_initialize() in their own #TypeInfo.instance_init and forward the
69 * realization events appropriately.
71 * Any type may override the @realize and/or @unrealize callbacks but needs
72 * to call the parent type's implementation if keeping their functionality
73 * is desired. Refer to QOM documentation for further discussion and examples.
77 * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types
78 * derived directly from it need not call their parent's @realize and
80 * For other types consult the documentation and implementation of the
81 * respective parent types.
85 typedef struct DeviceClass
{
87 ObjectClass parent_class
;
90 DECLARE_BITMAP(categories
, DEVICE_CATEGORY_MAX
);
96 * Can this device be instantiated with -device / device_add?
97 * All devices should support instantiation with device_add, and
98 * this flag should not exist. But we're not there, yet. Some
99 * devices fail to instantiate with cryptic error messages.
100 * Others instantiate, but don't work. Exposing users to such
101 * behavior would be cruel; clearing this flag will protect them.
102 * It should never be cleared without a comment explaining why it
104 * TODO remove once we're there
111 DeviceRealize realize
;
112 DeviceUnrealize unrealize
;
115 const struct VMStateDescription
*vmsd
;
117 /* Private to qdev / bus. */
118 const char *bus_type
;
121 typedef struct NamedGPIOList NamedGPIOList
;
123 struct NamedGPIOList
{
128 QLIST_ENTRY(NamedGPIOList
) node
;
133 * @realized: Indicates whether the device has been fully constructed.
135 * This structure should not be accessed directly. We declare it here
136 * so that it can be embedded in individual device state structures.
144 char *canonical_path
;
146 bool pending_deleted_event
;
149 BusState
*parent_bus
;
150 QLIST_HEAD(, NamedGPIOList
) gpios
;
151 QLIST_HEAD(, BusState
) child_bus
;
153 int instance_id_alias
;
154 int alias_required_for_version
;
157 struct DeviceListener
{
158 void (*realize
)(DeviceListener
*listener
, DeviceState
*dev
);
159 void (*unrealize
)(DeviceListener
*listener
, DeviceState
*dev
);
160 QTAILQ_ENTRY(DeviceListener
) link
;
163 #define TYPE_BUS "bus"
164 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
165 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
166 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
169 ObjectClass parent_class
;
171 /* FIXME first arg should be BusState */
172 void (*print_dev
)(Monitor
*mon
, DeviceState
*dev
, int indent
);
173 char *(*get_dev_path
)(DeviceState
*dev
);
175 * This callback is used to create Open Firmware device path in accordance
176 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
177 * bindings can be found at http://playground.sun.com/1275/bindings/.
179 char *(*get_fw_dev_path
)(DeviceState
*dev
);
180 void (*reset
)(BusState
*bus
);
182 BusUnrealize unrealize
;
184 /* maximum devices allowed on the bus, 0: no limit. */
186 /* number of automatically allocated bus ids (e.g. ide.0) */
190 typedef struct BusChild
{
193 QTAILQ_ENTRY(BusChild
) sibling
;
196 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
200 * @hotplug_handler: link to a hotplug handler associated with bus.
206 HotplugHandler
*hotplug_handler
;
209 QTAILQ_HEAD(, BusChild
) children
;
210 QLIST_ENTRY(BusState
) sibling
;
215 * @set_default: true if the default value should be set from @defval,
216 * in which case @info->set_default_value must not be NULL
217 * (if false then no default value is set by the property system
218 * and the field retains whatever value it was given by instance_init).
219 * @defval: default value for the property. This is used only if @set_default
224 const PropertyInfo
*info
;
233 const PropertyInfo
*arrayinfo
;
235 const char *link_type
;
238 struct PropertyInfo
{
240 const char *description
;
241 const QEnumLookup
*enum_table
;
242 int (*print
)(DeviceState
*dev
, Property
*prop
, char *dest
, size_t len
);
243 void (*set_default_value
)(Object
*obj
, const Property
*prop
);
244 void (*create
)(Object
*obj
, Property
*prop
, Error
**errp
);
245 ObjectPropertyAccessor
*get
;
246 ObjectPropertyAccessor
*set
;
247 ObjectPropertyRelease
*release
;
252 * @used: Set to true if property was used when initializing a device.
253 * @optional: If set to true, GlobalProperty will be skipped without errors
254 * if the property doesn't exist.
256 * An error is fatal for non-hotplugged devices, when the global is applied.
258 typedef struct GlobalProperty
{
260 const char *property
;
267 compat_props_add(GPtrArray
*arr
,
268 GlobalProperty props
[], size_t nelem
)
271 for (i
= 0; i
< nelem
; i
++) {
272 g_ptr_array_add(arr
, (void *)&props
[i
]);
276 /*** Board API. This should go away once we have a machine config file. ***/
278 DeviceState
*qdev_create(BusState
*bus
, const char *name
);
279 DeviceState
*qdev_try_create(BusState
*bus
, const char *name
);
280 void qdev_init_nofail(DeviceState
*dev
);
281 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
282 int required_for_version
);
283 HotplugHandler
*qdev_get_machine_hotplug_handler(DeviceState
*dev
);
284 HotplugHandler
*qdev_get_hotplug_handler(DeviceState
*dev
);
285 void qdev_unplug(DeviceState
*dev
, Error
**errp
);
286 void qdev_simple_device_unplug_cb(HotplugHandler
*hotplug_dev
,
287 DeviceState
*dev
, Error
**errp
);
288 void qdev_machine_creation_done(void);
289 bool qdev_machine_modified(void);
291 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
);
292 qemu_irq
qdev_get_gpio_in_named(DeviceState
*dev
, const char *name
, int n
);
294 void qdev_connect_gpio_out(DeviceState
*dev
, int n
, qemu_irq pin
);
295 void qdev_connect_gpio_out_named(DeviceState
*dev
, const char *name
, int n
,
297 qemu_irq
qdev_get_gpio_out_connector(DeviceState
*dev
, const char *name
, int n
);
298 qemu_irq
qdev_intercept_gpio_out(DeviceState
*dev
, qemu_irq icpt
,
299 const char *name
, int n
);
301 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
);
303 /*** Device API. ***/
305 /* Register device properties. */
306 /* GPIO inputs also double as IRQ sinks. */
307 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
);
308 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
);
309 void qdev_init_gpio_out_named(DeviceState
*dev
, qemu_irq
*pins
,
310 const char *name
, int n
);
312 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines
313 * for the specified device
315 * @dev: Device to create input GPIOs for
316 * @handler: Function to call when GPIO line value is set
317 * @opaque: Opaque data pointer to pass to @handler
318 * @name: Name of the GPIO input (must be unique for this device)
319 * @n: Number of GPIO lines in this input set
321 void qdev_init_gpio_in_named_with_opaque(DeviceState
*dev
,
322 qemu_irq_handler handler
,
324 const char *name
, int n
);
327 * qdev_init_gpio_in_named: create an array of input GPIO lines
328 * for the specified device
330 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer
331 * passed to the handler is @dev (which is the most commonly desired behaviour).
333 static inline void qdev_init_gpio_in_named(DeviceState
*dev
,
334 qemu_irq_handler handler
,
335 const char *name
, int n
)
337 qdev_init_gpio_in_named_with_opaque(dev
, handler
, dev
, name
, n
);
340 void qdev_pass_gpios(DeviceState
*dev
, DeviceState
*container
,
343 BusState
*qdev_get_parent_bus(DeviceState
*dev
);
347 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
);
349 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
350 typedef int (qbus_walkerfn
)(BusState
*bus
, void *opaque
);
351 typedef int (qdev_walkerfn
)(DeviceState
*dev
, void *opaque
);
353 void qbus_create_inplace(void *bus
, size_t size
, const char *typename
,
354 DeviceState
*parent
, const char *name
);
355 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
);
356 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
357 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
359 int qbus_walk_children(BusState
*bus
,
360 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
361 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
363 int qdev_walk_children(DeviceState
*dev
,
364 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
365 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
368 void qdev_reset_all(DeviceState
*dev
);
369 void qdev_reset_all_fn(void *opaque
);
373 * @bus: Bus to be reset.
375 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
376 * to it, including recursive processing of all buses below @bus itself. A
377 * hard reset means that qbus_reset_all will reset all state of the device.
378 * For PCI devices, for example, this will include the base address registers
379 * or configuration space.
381 void qbus_reset_all(BusState
*bus
);
382 void qbus_reset_all_fn(void *opaque
);
384 /* This should go away once we get rid of the NULL bus hack */
385 BusState
*sysbus_get_default(void);
387 char *qdev_get_fw_dev_path(DeviceState
*dev
);
388 char *qdev_get_own_fw_dev_path_from_handler(BusState
*bus
, DeviceState
*dev
);
393 * Initialize platform devices before machine init. This is a hack until full
394 * support for composition is added.
396 void qdev_machine_init(void);
401 * Reset a single device (by calling the reset method).
403 void device_reset(DeviceState
*dev
);
405 void device_class_set_parent_reset(DeviceClass
*dc
,
406 DeviceReset dev_reset
,
407 DeviceReset
*parent_reset
);
408 void device_class_set_parent_realize(DeviceClass
*dc
,
409 DeviceRealize dev_realize
,
410 DeviceRealize
*parent_realize
);
411 void device_class_set_parent_unrealize(DeviceClass
*dc
,
412 DeviceUnrealize dev_unrealize
,
413 DeviceUnrealize
*parent_unrealize
);
415 const struct VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
);
417 const char *qdev_fw_name(DeviceState
*dev
);
419 Object
*qdev_get_machine(void);
421 void object_apply_compat_props(Object
*obj
);
423 /* FIXME: make this a link<> */
424 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
);
426 extern bool qdev_hotplug
;
427 extern bool qdev_hot_removed
;
429 char *qdev_get_dev_path(DeviceState
*dev
);
431 GSList
*qdev_build_hotpluggable_device_list(Object
*peripheral
);
433 void qbus_set_hotplug_handler(BusState
*bus
, Object
*handler
, Error
**errp
);
435 void qbus_set_bus_hotplug_handler(BusState
*bus
, Error
**errp
);
437 static inline bool qbus_is_hotpluggable(BusState
*bus
)
439 return bus
->hotplug_handler
;
442 void device_listener_register(DeviceListener
*listener
);
443 void device_listener_unregister(DeviceListener
*listener
);