4 #include "qemu/queue.h"
5 #include "qemu/option.h"
6 #include "qemu/typedefs.h"
7 #include "qemu/bitmap.h"
8 #include "qom/object.h"
10 #include "qapi/error.h"
11 #include "hw/hotplug.h"
14 DEV_NVECTORS_UNSPECIFIED
= -1,
17 #define TYPE_DEVICE "device"
18 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
19 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
20 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
22 typedef enum DeviceCategory
{
23 DEVICE_CATEGORY_BRIDGE
,
25 DEVICE_CATEGORY_STORAGE
,
26 DEVICE_CATEGORY_NETWORK
,
27 DEVICE_CATEGORY_INPUT
,
28 DEVICE_CATEGORY_DISPLAY
,
29 DEVICE_CATEGORY_SOUND
,
34 typedef int (*qdev_initfn
)(DeviceState
*dev
);
35 typedef int (*qdev_event
)(DeviceState
*dev
);
36 typedef void (*qdev_resetfn
)(DeviceState
*dev
);
37 typedef void (*DeviceRealize
)(DeviceState
*dev
, Error
**errp
);
38 typedef void (*DeviceUnrealize
)(DeviceState
*dev
, Error
**errp
);
39 typedef void (*BusRealize
)(BusState
*bus
, Error
**errp
);
40 typedef void (*BusUnrealize
)(BusState
*bus
, Error
**errp
);
42 struct VMStateDescription
;
46 * @props: Properties accessing state fields.
47 * @realize: Callback function invoked when the #DeviceState:realized
48 * property is changed to %true. The default invokes @init if not %NULL.
49 * @unrealize: Callback function invoked when the #DeviceState:realized
50 * property is changed to %false.
51 * @init: Callback function invoked when the #DeviceState::realized property
52 * is changed to %true. Deprecated, new types inheriting directly from
53 * TYPE_DEVICE should use @realize instead, new leaf types should consult
54 * their respective parent type.
55 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
56 * as readonly "hotpluggable" property of #DeviceState instance
59 * Devices are constructed in two stages,
60 * 1) object instantiation via object_initialize() and
61 * 2) device realization via #DeviceState:realized property.
62 * The former may not fail (it might assert or exit), the latter may return
63 * error information to the caller and must be re-entrant.
64 * Trivial field initializations should go into #TypeInfo.instance_init.
65 * Operations depending on @props static properties should go into @realize.
66 * After successful realization, setting static properties will fail.
68 * As an interim step, the #DeviceState:realized property is set by deprecated
69 * functions qdev_init() and qdev_init_nofail().
70 * In the future, devices will propagate this state change to their children
71 * and along busses they expose.
72 * The point in time will be deferred to machine creation, so that values
73 * set in @realize will not be introspectable beforehand. Therefore devices
74 * must not create children during @realize; they should initialize them via
75 * object_initialize() in their own #TypeInfo.instance_init and forward the
76 * realization events appropriately.
78 * The @init callback is considered private to a particular bus implementation
79 * (immediate abstract child types of TYPE_DEVICE). Derived leaf types set an
80 * "init" callback on their parent class instead.
82 * Any type may override the @realize and/or @unrealize callbacks but needs
83 * to call the parent type's implementation if keeping their functionality
84 * is desired. Refer to QOM documentation for further discussion and examples.
88 * If a type derived directly from TYPE_DEVICE implements @realize, it does
89 * not need to implement @init and therefore does not need to store and call
90 * #DeviceClass' default @realize callback.
91 * For other types consult the documentation and implementation of the
92 * respective parent types.
96 typedef struct DeviceClass
{
98 ObjectClass parent_class
;
101 DECLARE_BITMAP(categories
, DEVICE_CATEGORY_MAX
);
107 * Shall we hide this device model from -device / device_add?
108 * All devices should support instantiation with device_add, and
109 * this flag should not exist. But we're not there, yet. Some
110 * devices fail to instantiate with cryptic error messages.
111 * Others instantiate, but don't work. Exposing users to such
112 * behavior would be cruel; this flag serves to protect them. It
113 * should never be set without a comment explaining why it is set.
114 * TODO remove once we're there
116 bool cannot_instantiate_with_device_add_yet
;
120 void (*reset
)(DeviceState
*dev
);
121 DeviceRealize realize
;
122 DeviceUnrealize unrealize
;
125 const struct VMStateDescription
*vmsd
;
127 /* Private to qdev / bus. */
128 qdev_initfn init
; /* TODO remove, once users are converted to realize */
130 qdev_event exit
; /* TODO remove, once users are converted to unrealize */
131 const char *bus_type
;
134 typedef struct NamedGPIOList NamedGPIOList
;
136 struct NamedGPIOList
{
142 QLIST_ENTRY(NamedGPIOList
) node
;
147 * @realized: Indicates whether the device has been fully constructed.
149 * This structure should not be accessed directly. We declare it here
150 * so that it can be embedded in individual device state structures.
159 bool pending_deleted_event
;
162 BusState
*parent_bus
;
163 QLIST_HEAD(, NamedGPIOList
) gpios
;
164 QLIST_HEAD(, BusState
) child_bus
;
166 int instance_id_alias
;
167 int alias_required_for_version
;
170 #define TYPE_BUS "bus"
171 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
172 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
173 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
176 ObjectClass parent_class
;
178 /* FIXME first arg should be BusState */
179 void (*print_dev
)(Monitor
*mon
, DeviceState
*dev
, int indent
);
180 char *(*get_dev_path
)(DeviceState
*dev
);
182 * This callback is used to create Open Firmware device path in accordance
183 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
184 * bindings can be found at http://playground.sun.com/1275/bindings/.
186 char *(*get_fw_dev_path
)(DeviceState
*dev
);
187 void (*reset
)(BusState
*bus
);
189 BusUnrealize unrealize
;
191 /* maximum devices allowed on the bus, 0: no limit. */
193 /* number of automatically allocated bus ids (e.g. ide.0) */
197 typedef struct BusChild
{
200 QTAILQ_ENTRY(BusChild
) sibling
;
203 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
207 * @hotplug_device: link to a hotplug device associated with bus.
214 HotplugHandler
*hotplug_handler
;
217 QTAILQ_HEAD(ChildrenHead
, BusChild
) children
;
218 QLIST_ENTRY(BusState
) sibling
;
229 PropertyInfo
*arrayinfo
;
233 struct PropertyInfo
{
235 const char *legacy_name
;
236 const char **enum_table
;
237 int (*print
)(DeviceState
*dev
, Property
*prop
, char *dest
, size_t len
);
238 ObjectPropertyAccessor
*get
;
239 ObjectPropertyAccessor
*set
;
240 ObjectPropertyRelease
*release
;
245 * @user_provided: Set to true if property comes from user-provided config
246 * (command-line or config file).
247 * @used: Set to true if property was used when initializing a device.
249 typedef struct GlobalProperty
{
251 const char *property
;
255 QTAILQ_ENTRY(GlobalProperty
) next
;
258 /*** Board API. This should go away once we have a machine config file. ***/
260 DeviceState
*qdev_create(BusState
*bus
, const char *name
);
261 DeviceState
*qdev_try_create(BusState
*bus
, const char *name
);
262 int qdev_init(DeviceState
*dev
) QEMU_WARN_UNUSED_RESULT
;
263 void qdev_init_nofail(DeviceState
*dev
);
264 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
265 int required_for_version
);
266 void qdev_unplug(DeviceState
*dev
, Error
**errp
);
267 int qdev_simple_unplug_cb(DeviceState
*dev
);
268 void qdev_machine_creation_done(void);
269 bool qdev_machine_modified(void);
271 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
);
272 qemu_irq
qdev_get_gpio_in_named(DeviceState
*dev
, const char *name
, int n
);
274 void qdev_connect_gpio_out(DeviceState
*dev
, int n
, qemu_irq pin
);
275 void qdev_connect_gpio_out_named(DeviceState
*dev
, const char *name
, int n
,
278 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
);
280 /*** Device API. ***/
282 /* Register device properties. */
283 /* GPIO inputs also double as IRQ sinks. */
284 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
);
285 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
);
286 void qdev_init_gpio_in_named(DeviceState
*dev
, qemu_irq_handler handler
,
287 const char *name
, int n
);
288 void qdev_init_gpio_out_named(DeviceState
*dev
, qemu_irq
*pins
,
289 const char *name
, int n
);
291 BusState
*qdev_get_parent_bus(DeviceState
*dev
);
295 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
);
297 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
298 typedef int (qbus_walkerfn
)(BusState
*bus
, void *opaque
);
299 typedef int (qdev_walkerfn
)(DeviceState
*dev
, void *opaque
);
301 void qbus_create_inplace(void *bus
, size_t size
, const char *typename
,
302 DeviceState
*parent
, const char *name
);
303 BusState
*qbus_create(const char *typename
, DeviceState
*parent
, const char *name
);
304 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
305 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
307 int qbus_walk_children(BusState
*bus
,
308 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
309 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
311 int qdev_walk_children(DeviceState
*dev
,
312 qdev_walkerfn
*pre_devfn
, qbus_walkerfn
*pre_busfn
,
313 qdev_walkerfn
*post_devfn
, qbus_walkerfn
*post_busfn
,
316 void qdev_reset_all(DeviceState
*dev
);
320 * @bus: Bus to be reset.
322 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
323 * to it, including recursive processing of all buses below @bus itself. A
324 * hard reset means that qbus_reset_all will reset all state of the device.
325 * For PCI devices, for example, this will include the base address registers
326 * or configuration space.
328 void qbus_reset_all(BusState
*bus
);
329 void qbus_reset_all_fn(void *opaque
);
331 /* This should go away once we get rid of the NULL bus hack */
332 BusState
*sysbus_get_default(void);
334 char *qdev_get_fw_dev_path(DeviceState
*dev
);
339 * Initialize platform devices before machine init. This is a hack until full
340 * support for composition is added.
342 void qdev_machine_init(void);
347 * Reset a single device (by calling the reset method).
349 void device_reset(DeviceState
*dev
);
351 const struct VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
);
353 const char *qdev_fw_name(DeviceState
*dev
);
355 Object
*qdev_get_machine(void);
357 /* FIXME: make this a link<> */
358 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
);
360 extern int qdev_hotplug
;
362 char *qdev_get_dev_path(DeviceState
*dev
);
364 static inline void qbus_set_hotplug_handler(BusState
*bus
, DeviceState
*handler
,
367 object_property_set_link(OBJECT(bus
), OBJECT(handler
),
368 QDEV_HOTPLUG_HANDLER_PROPERTY
, errp
);
369 bus
->allow_hotplug
= 1;