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 int (*qdev_initfn
)(DeviceState
*dev
);
33 typedef int (*qdev_event
)(DeviceState
*dev
);
34 typedef void (*DeviceRealize
)(DeviceState
*dev
, Error
**errp
);
35 typedef void (*DeviceUnrealize
)(DeviceState
*dev
, Error
**errp
);
36 typedef void (*DeviceReset
)(DeviceState
*dev
);
37 typedef void (*BusRealize
)(BusState
*bus
, Error
**errp
);
38 typedef void (*BusUnrealize
)(BusState
*bus
, Error
**errp
);
40 struct VMStateDescription
;
44 * @props: Properties accessing state fields.
45 * @realize: Callback function invoked when the #DeviceState:realized
46 * property is changed to %true. The default invokes @init if not %NULL.
47 * @unrealize: Callback function invoked when the #DeviceState:realized
48 * property is changed to %false.
49 * @init: Callback function invoked when the #DeviceState::realized property
50 * is changed to %true. Deprecated, new types inheriting directly from
51 * TYPE_DEVICE should use @realize instead, new leaf types should consult
52 * their respective parent type.
53 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
54 * as readonly "hotpluggable" property of #DeviceState instance
57 * Devices are constructed in two stages,
58 * 1) object instantiation via object_initialize() and
59 * 2) device realization via #DeviceState:realized property.
60 * The former may not fail (it might assert or exit), the latter may return
61 * error information to the caller and must be re-entrant.
62 * Trivial field initializations should go into #TypeInfo.instance_init.
63 * Operations depending on @props static properties should go into @realize.
64 * After successful realization, setting static properties will fail.
66 * As an interim step, the #DeviceState:realized property can also be
67 * set with qdev_init_nofail().
68 * In the future, devices will propagate this state change to their children
69 * and along busses they expose.
70 * The point in time will be deferred to machine creation, so that values
71 * set in @realize will not be introspectable beforehand. Therefore devices
72 * must not create children during @realize; they should initialize them via
73 * object_initialize() in their own #TypeInfo.instance_init and forward the
74 * realization events appropriately.
76 * The @init callback is considered private to a particular bus implementation
77 * (immediate abstract child types of TYPE_DEVICE). Derived leaf types set an
78 * "init" callback on their parent class instead.
80 * Any type may override the @realize and/or @unrealize callbacks but needs
81 * to call the parent type's implementation if keeping their functionality
82 * is desired. Refer to QOM documentation for further discussion and examples.
86 * If a type derived directly from TYPE_DEVICE implements @realize, it does
87 * not need to implement @init and therefore does not need to store and call
88 * #DeviceClass' default @realize callback.
89 * For other types consult the documentation and implementation of the
90 * respective parent types.
94 typedef struct DeviceClass
{
96 ObjectClass parent_class
;
99 DECLARE_BITMAP(categories
, DEVICE_CATEGORY_MAX
);
105 * Can this device be instantiated with -device / device_add?
106 * All devices should support instantiation with device_add, and
107 * this flag should not exist. But we're not there, yet. Some
108 * devices fail to instantiate with cryptic error messages.
109 * Others instantiate, but don't work. Exposing users to such
110 * behavior would be cruel; clearing this flag will protect them.
111 * It should never be cleared without a comment explaining why it
113 * TODO remove once we're there
120 DeviceRealize realize
;
121 DeviceUnrealize unrealize
;
124 const struct VMStateDescription
*vmsd
;
126 /* Private to qdev / bus. */
127 qdev_initfn init
; /* TODO remove, once users are converted to realize */
128 qdev_event exit
; /* TODO remove, once users are converted to unrealize */
129 const char *bus_type
;
132 typedef struct NamedGPIOList NamedGPIOList
;
134 struct NamedGPIOList
{
139 QLIST_ENTRY(NamedGPIOList
) node
;
144 * @realized: Indicates whether the device has been fully constructed.
146 * This structure should not be accessed directly. We declare it here
147 * so that it can be embedded in individual device state structures.
155 char *canonical_path
;
157 bool pending_deleted_event
;
160 BusState
*parent_bus
;
161 QLIST_HEAD(, NamedGPIOList
) gpios
;
162 QLIST_HEAD(, BusState
) child_bus
;
164 int instance_id_alias
;
165 int alias_required_for_version
;
168 struct DeviceListener
{
169 void (*realize
)(DeviceListener
*listener
, DeviceState
*dev
);
170 void (*unrealize
)(DeviceListener
*listener
, DeviceState
*dev
);
171 QTAILQ_ENTRY(DeviceListener
) link
;
174 #define TYPE_BUS "bus"
175 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
176 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
177 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
180 ObjectClass parent_class
;
182 /* FIXME first arg should be BusState */
183 void (*print_dev
)(Monitor
*mon
, DeviceState
*dev
, int indent
);
184 char *(*get_dev_path
)(DeviceState
*dev
);
186 * This callback is used to create Open Firmware device path in accordance
187 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
188 * bindings can be found at http://playground.sun.com/1275/bindings/.
190 char *(*get_fw_dev_path
)(DeviceState
*dev
);
191 void (*reset
)(BusState
*bus
);
193 BusUnrealize unrealize
;
195 /* maximum devices allowed on the bus, 0: no limit. */
197 /* number of automatically allocated bus ids (e.g. ide.0) */
201 typedef struct BusChild
{
204 QTAILQ_ENTRY(BusChild
) sibling
;
207 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
211 * @hotplug_device: link to a hotplug device associated with bus.
217 HotplugHandler
*hotplug_handler
;
220 QTAILQ_HEAD(ChildrenHead
, BusChild
) children
;
221 QLIST_ENTRY(BusState
) sibling
;
226 * @set_default: true if the default value should be set from @defval,
227 * in which case @info->set_default_value must not be NULL
228 * (if false then no default value is set by the property system
229 * and the field retains whatever value it was given by instance_init).
230 * @defval: default value for the property. This is used only if @set_default
235 const PropertyInfo
*info
;
244 const PropertyInfo
*arrayinfo
;
246 const char *link_type
;
249 struct PropertyInfo
{
251 const char *description
;
252 const QEnumLookup
*enum_table
;
253 int (*print
)(DeviceState
*dev
, Property
*prop
, char *dest
, size_t len
);
254 void (*set_default_value
)(Object
*obj
, const Property
*prop
);
255 void (*create
)(Object
*obj
, Property
*prop
, Error
**errp
);
256 ObjectPropertyAccessor
*get
;
257 ObjectPropertyAccessor
*set
;
258 ObjectPropertyRelease
*release
;
263 * @user_provided: Set to true if property comes from user-provided config
264 * (command-line or config file).
265 * @used: Set to true if property was used when initializing a device.
266 * @errp: Error destination, used like first argument of error_setg()
267 * in case property setting fails later. If @errp is NULL, we
268 * print warnings instead of ignoring errors silently. For
269 * hotplugged devices, errp is always ignored and warnings are
272 typedef struct GlobalProperty
{
274 const char *property
;
281 /*** Board API. This should go away once we have a machine config file. ***/
283 DeviceState
*qdev_create(BusState
*bus
, const char *name
);
284 DeviceState
*qdev_try_create(BusState
*bus
, const char *name
);
285 void qdev_init_nofail(DeviceState
*dev
);
286 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
287 int required_for_version
);
288 HotplugHandler
*qdev_get_machine_hotplug_handler(DeviceState
*dev
);
289 HotplugHandler
*qdev_get_hotplug_handler(DeviceState
*dev
);
290 void qdev_unplug(DeviceState
*dev
, Error
**errp
);
291 void qdev_simple_device_unplug_cb(HotplugHandler
*hotplug_dev
,
292 DeviceState
*dev
, Error
**errp
);
293 void qdev_machine_creation_done(void);
294 bool qdev_machine_modified(void);
296 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
);
297 qemu_irq
qdev_get_gpio_in_named(DeviceState
*dev
, const char *name
, int n
);
299 void qdev_connect_gpio_out(DeviceState
*dev
, int n
, qemu_irq pin
);
300 void qdev_connect_gpio_out_named(DeviceState
*dev
, const char *name
, int n
,
302 qemu_irq
qdev_get_gpio_out_connector(DeviceState
*dev
, const char *name
, int n
);
303 qemu_irq
qdev_intercept_gpio_out(DeviceState
*dev
, qemu_irq icpt
,
304 const char *name
, int n
);
306 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
);
308 /*** Device API. ***/
310 /* Register device properties. */
311 /* GPIO inputs also double as IRQ sinks. */
312 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
);
313 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
);
314 void qdev_init_gpio_out_named(DeviceState
*dev
, qemu_irq
*pins
,
315 const char *name
, int n
);
317 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines
318 * for the specified device
320 * @dev: Device to create input GPIOs for
321 * @handler: Function to call when GPIO line value is set
322 * @opaque: Opaque data pointer to pass to @handler
323 * @name: Name of the GPIO input (must be unique for this device)
324 * @n: Number of GPIO lines in this input set
326 void qdev_init_gpio_in_named_with_opaque(DeviceState
*dev
,
327 qemu_irq_handler handler
,
329 const char *name
, int n
);
332 * qdev_init_gpio_in_named: create an array of input GPIO lines
333 * for the specified device
335 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer
336 * passed to the handler is @dev (which is the most commonly desired behaviour).
338 static inline void qdev_init_gpio_in_named(DeviceState
*dev
,
339 qemu_irq_handler handler
,
340 const char *name
, int n
)
342 qdev_init_gpio_in_named_with_opaque(dev
, handler
, dev
, name
, n
);
345 void qdev_pass_gpios(DeviceState
*dev
, DeviceState
*container
,
348 BusState
*qdev_get_parent_bus(DeviceState
*dev
);
352 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
);
354 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
355 typedef int (qbus_walkerfn
)(BusState
*bus
, void *opaque
);
356 typedef int (qdev_walkerfn
)(DeviceState
*dev
, void *opaque
);
358 void qbus_create_inplace(void *bus
, size_t size
, const char *typename
,
359 DeviceState
*parent
, const char *name
);
360 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
);
361 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
362 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
364 int qbus_walk_children(BusState
*bus
,
365 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
366 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
368 int qdev_walk_children(DeviceState
*dev
,
369 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
370 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
373 void qdev_reset_all(DeviceState
*dev
);
374 void qdev_reset_all_fn(void *opaque
);
378 * @bus: Bus to be reset.
380 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
381 * to it, including recursive processing of all buses below @bus itself. A
382 * hard reset means that qbus_reset_all will reset all state of the device.
383 * For PCI devices, for example, this will include the base address registers
384 * or configuration space.
386 void qbus_reset_all(BusState
*bus
);
387 void qbus_reset_all_fn(void *opaque
);
389 /* This should go away once we get rid of the NULL bus hack */
390 BusState
*sysbus_get_default(void);
392 char *qdev_get_fw_dev_path(DeviceState
*dev
);
393 char *qdev_get_own_fw_dev_path_from_handler(BusState
*bus
, DeviceState
*dev
);
398 * Initialize platform devices before machine init. This is a hack until full
399 * support for composition is added.
401 void qdev_machine_init(void);
406 * Reset a single device (by calling the reset method).
408 void device_reset(DeviceState
*dev
);
410 void device_class_set_parent_reset(DeviceClass
*dc
,
411 DeviceReset dev_reset
,
412 DeviceReset
*parent_reset
);
413 void device_class_set_parent_realize(DeviceClass
*dc
,
414 DeviceRealize dev_realize
,
415 DeviceRealize
*parent_realize
);
416 void device_class_set_parent_unrealize(DeviceClass
*dc
,
417 DeviceUnrealize dev_unrealize
,
418 DeviceUnrealize
*parent_unrealize
);
420 const struct VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
);
422 const char *qdev_fw_name(DeviceState
*dev
);
424 Object
*qdev_get_machine(void);
426 /* FIXME: make this a link<> */
427 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
);
429 extern bool qdev_hotplug
;
430 extern bool qdev_hot_removed
;
432 char *qdev_get_dev_path(DeviceState
*dev
);
434 GSList
*qdev_build_hotpluggable_device_list(Object
*peripheral
);
436 void qbus_set_hotplug_handler(BusState
*bus
, DeviceState
*handler
,
439 void qbus_set_bus_hotplug_handler(BusState
*bus
, Error
**errp
);
441 static inline bool qbus_is_hotpluggable(BusState
*bus
)
443 return bus
->hotplug_handler
;
446 void device_listener_register(DeviceListener
*listener
);
447 void device_listener_unregister(DeviceListener
*listener
);