]>
Commit | Line | Data |
---|---|---|
074a86fc AL |
1 | #ifndef QDEV_CORE_H |
2 | #define QDEV_CORE_H | |
3 | ||
1de7afc9 | 4 | #include "qemu/queue.h" |
949fc823 | 5 | #include "qemu/bitmap.h" |
14cccb61 | 6 | #include "qom/object.h" |
0ee4de6c | 7 | #include "hw/hotplug.h" |
074a86fc | 8 | |
074a86fc AL |
9 | enum { |
10 | DEV_NVECTORS_UNSPECIFIED = -1, | |
11 | }; | |
12 | ||
13 | #define TYPE_DEVICE "device" | |
14 | #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE) | |
15 | #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE) | |
16 | #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE) | |
17 | ||
3d1237fb MA |
18 | typedef enum DeviceCategory { |
19 | DEVICE_CATEGORY_BRIDGE, | |
20 | DEVICE_CATEGORY_USB, | |
21 | DEVICE_CATEGORY_STORAGE, | |
22 | DEVICE_CATEGORY_NETWORK, | |
23 | DEVICE_CATEGORY_INPUT, | |
24 | DEVICE_CATEGORY_DISPLAY, | |
25 | DEVICE_CATEGORY_SOUND, | |
26 | DEVICE_CATEGORY_MISC, | |
ba31cc72 | 27 | DEVICE_CATEGORY_CPU, |
3d1237fb MA |
28 | DEVICE_CATEGORY_MAX |
29 | } DeviceCategory; | |
30 | ||
249d4172 AF |
31 | typedef void (*DeviceRealize)(DeviceState *dev, Error **errp); |
32 | typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp); | |
b850f664 | 33 | typedef void (*DeviceReset)(DeviceState *dev); |
02e7f85d BD |
34 | typedef void (*BusRealize)(BusState *bus, Error **errp); |
35 | typedef void (*BusUnrealize)(BusState *bus, Error **errp); | |
074a86fc | 36 | |
249d4172 AF |
37 | /** |
38 | * DeviceClass: | |
39 | * @props: Properties accessing state fields. | |
40 | * @realize: Callback function invoked when the #DeviceState:realized | |
ff46d9d4 | 41 | * property is changed to %true. |
249d4172 AF |
42 | * @unrealize: Callback function invoked when the #DeviceState:realized |
43 | * property is changed to %false. | |
1a37eca1 IM |
44 | * @hotpluggable: indicates if #DeviceClass is hotpluggable, available |
45 | * as readonly "hotpluggable" property of #DeviceState instance | |
249d4172 AF |
46 | * |
47 | * # Realization # | |
48 | * Devices are constructed in two stages, | |
49 | * 1) object instantiation via object_initialize() and | |
50 | * 2) device realization via #DeviceState:realized property. | |
6038f989 TH |
51 | * The former may not fail (and must not abort or exit, since it is called |
52 | * during device introspection already), and the latter may return error | |
53 | * information to the caller and must be re-entrant. | |
249d4172 AF |
54 | * Trivial field initializations should go into #TypeInfo.instance_init. |
55 | * Operations depending on @props static properties should go into @realize. | |
56 | * After successful realization, setting static properties will fail. | |
57 | * | |
daeba969 MA |
58 | * As an interim step, the #DeviceState:realized property can also be |
59 | * set with qdev_init_nofail(). | |
249d4172 AF |
60 | * In the future, devices will propagate this state change to their children |
61 | * and along busses they expose. | |
62 | * The point in time will be deferred to machine creation, so that values | |
63 | * set in @realize will not be introspectable beforehand. Therefore devices | |
64 | * must not create children during @realize; they should initialize them via | |
65 | * object_initialize() in their own #TypeInfo.instance_init and forward the | |
66 | * realization events appropriately. | |
67 | * | |
249d4172 | 68 | * Any type may override the @realize and/or @unrealize callbacks but needs |
782beb52 AF |
69 | * to call the parent type's implementation if keeping their functionality |
70 | * is desired. Refer to QOM documentation for further discussion and examples. | |
71 | * | |
72 | * <note> | |
73 | * <para> | |
ff46d9d4 PMD |
74 | * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types |
75 | * derived directly from it need not call their parent's @realize and | |
76 | * @unrealize. | |
782beb52 AF |
77 | * For other types consult the documentation and implementation of the |
78 | * respective parent types. | |
79 | * </para> | |
80 | * </note> | |
249d4172 | 81 | */ |
074a86fc | 82 | typedef struct DeviceClass { |
249d4172 | 83 | /*< private >*/ |
074a86fc | 84 | ObjectClass parent_class; |
249d4172 | 85 | /*< public >*/ |
074a86fc | 86 | |
3d1237fb | 87 | DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX); |
074a86fc AL |
88 | const char *fw_name; |
89 | const char *desc; | |
90 | Property *props; | |
efec3dd6 MA |
91 | |
92 | /* | |
e90f2a8c | 93 | * Can this device be instantiated with -device / device_add? |
efec3dd6 MA |
94 | * All devices should support instantiation with device_add, and |
95 | * this flag should not exist. But we're not there, yet. Some | |
96 | * devices fail to instantiate with cryptic error messages. | |
97 | * Others instantiate, but don't work. Exposing users to such | |
e90f2a8c EH |
98 | * behavior would be cruel; clearing this flag will protect them. |
99 | * It should never be cleared without a comment explaining why it | |
100 | * is cleared. | |
efec3dd6 MA |
101 | * TODO remove once we're there |
102 | */ | |
e90f2a8c | 103 | bool user_creatable; |
1a37eca1 | 104 | bool hotpluggable; |
074a86fc AL |
105 | |
106 | /* callbacks */ | |
b850f664 | 107 | DeviceReset reset; |
249d4172 AF |
108 | DeviceRealize realize; |
109 | DeviceUnrealize unrealize; | |
074a86fc AL |
110 | |
111 | /* device state */ | |
8a9358cc | 112 | const VMStateDescription *vmsd; |
074a86fc AL |
113 | |
114 | /* Private to qdev / bus. */ | |
074a86fc AL |
115 | const char *bus_type; |
116 | } DeviceClass; | |
117 | ||
a5f54290 PC |
118 | typedef struct NamedGPIOList NamedGPIOList; |
119 | ||
120 | struct NamedGPIOList { | |
121 | char *name; | |
122 | qemu_irq *in; | |
123 | int num_in; | |
a5f54290 PC |
124 | int num_out; |
125 | QLIST_ENTRY(NamedGPIOList) node; | |
126 | }; | |
127 | ||
7983c8a3 AF |
128 | /** |
129 | * DeviceState: | |
130 | * @realized: Indicates whether the device has been fully constructed. | |
131 | * | |
132 | * This structure should not be accessed directly. We declare it here | |
133 | * so that it can be embedded in individual device state structures. | |
134 | */ | |
074a86fc | 135 | struct DeviceState { |
7983c8a3 | 136 | /*< private >*/ |
074a86fc | 137 | Object parent_obj; |
7983c8a3 | 138 | /*< public >*/ |
074a86fc AL |
139 | |
140 | const char *id; | |
04162f8f | 141 | char *canonical_path; |
7983c8a3 | 142 | bool realized; |
352e8da7 | 143 | bool pending_deleted_event; |
074a86fc AL |
144 | QemuOpts *opts; |
145 | int hotplugged; | |
146 | BusState *parent_bus; | |
a5f54290 | 147 | QLIST_HEAD(, NamedGPIOList) gpios; |
074a86fc AL |
148 | QLIST_HEAD(, BusState) child_bus; |
149 | int num_child_bus; | |
150 | int instance_id_alias; | |
151 | int alias_required_for_version; | |
152 | }; | |
153 | ||
707ff800 PD |
154 | struct DeviceListener { |
155 | void (*realize)(DeviceListener *listener, DeviceState *dev); | |
156 | void (*unrealize)(DeviceListener *listener, DeviceState *dev); | |
157 | QTAILQ_ENTRY(DeviceListener) link; | |
158 | }; | |
159 | ||
074a86fc AL |
160 | #define TYPE_BUS "bus" |
161 | #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS) | |
162 | #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS) | |
163 | #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS) | |
164 | ||
165 | struct BusClass { | |
166 | ObjectClass parent_class; | |
167 | ||
168 | /* FIXME first arg should be BusState */ | |
169 | void (*print_dev)(Monitor *mon, DeviceState *dev, int indent); | |
170 | char *(*get_dev_path)(DeviceState *dev); | |
171 | /* | |
172 | * This callback is used to create Open Firmware device path in accordance | |
173 | * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus | |
174 | * bindings can be found at http://playground.sun.com/1275/bindings/. | |
175 | */ | |
176 | char *(*get_fw_dev_path)(DeviceState *dev); | |
dcc20931 | 177 | void (*reset)(BusState *bus); |
02e7f85d BD |
178 | BusRealize realize; |
179 | BusUnrealize unrealize; | |
180 | ||
1395af6f FK |
181 | /* maximum devices allowed on the bus, 0: no limit. */ |
182 | int max_dev; | |
61de3676 AG |
183 | /* number of automatically allocated bus ids (e.g. ide.0) */ |
184 | int automatic_ids; | |
074a86fc AL |
185 | }; |
186 | ||
187 | typedef struct BusChild { | |
188 | DeviceState *child; | |
189 | int index; | |
190 | QTAILQ_ENTRY(BusChild) sibling; | |
191 | } BusChild; | |
192 | ||
0ee4de6c IM |
193 | #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler" |
194 | ||
074a86fc AL |
195 | /** |
196 | * BusState: | |
27c6ef1b | 197 | * @hotplug_handler: link to a hotplug handler associated with bus. |
074a86fc AL |
198 | */ |
199 | struct BusState { | |
200 | Object obj; | |
201 | DeviceState *parent; | |
f73480c3 | 202 | char *name; |
0ee4de6c | 203 | HotplugHandler *hotplug_handler; |
074a86fc | 204 | int max_index; |
02e7f85d | 205 | bool realized; |
12b2e9f3 | 206 | int num_children; |
eae3eb3e | 207 | QTAILQ_HEAD(, BusChild) children; |
074a86fc AL |
208 | QLIST_ENTRY(BusState) sibling; |
209 | }; | |
210 | ||
5cc56cc6 PM |
211 | /** |
212 | * Property: | |
213 | * @set_default: true if the default value should be set from @defval, | |
214 | * in which case @info->set_default_value must not be NULL | |
215 | * (if false then no default value is set by the property system | |
216 | * and the field retains whatever value it was given by instance_init). | |
217 | * @defval: default value for the property. This is used only if @set_default | |
218 | * is true. | |
219 | */ | |
074a86fc AL |
220 | struct Property { |
221 | const char *name; | |
1b6b7d10 | 222 | const PropertyInfo *info; |
3b6ca402 | 223 | ptrdiff_t offset; |
074a86fc | 224 | uint8_t bitnr; |
5cc56cc6 | 225 | bool set_default; |
76318657 MAL |
226 | union { |
227 | int64_t i; | |
3fb2111f | 228 | uint64_t u; |
76318657 | 229 | } defval; |
0be6bfac | 230 | int arrayoffset; |
1b6b7d10 | 231 | const PropertyInfo *arrayinfo; |
0be6bfac | 232 | int arrayfieldsize; |
5b4ff3c6 | 233 | const char *link_type; |
074a86fc AL |
234 | }; |
235 | ||
236 | struct PropertyInfo { | |
237 | const char *name; | |
51b2e8c3 | 238 | const char *description; |
f7abe0ec | 239 | const QEnumLookup *enum_table; |
074a86fc | 240 | int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len); |
a2740ad5 | 241 | void (*set_default_value)(Object *obj, const Property *prop); |
faabdbb7 | 242 | void (*create)(Object *obj, Property *prop, Error **errp); |
074a86fc AL |
243 | ObjectPropertyAccessor *get; |
244 | ObjectPropertyAccessor *set; | |
245 | ObjectPropertyRelease *release; | |
246 | }; | |
247 | ||
9f9260a3 DS |
248 | /** |
249 | * GlobalProperty: | |
b3ce84fe | 250 | * @used: Set to true if property was used when initializing a device. |
92fd453c DDAG |
251 | * @optional: If set to true, GlobalProperty will be skipped without errors |
252 | * if the property doesn't exist. | |
cff8b715 MAL |
253 | * |
254 | * An error is fatal for non-hotplugged devices, when the global is applied. | |
9f9260a3 | 255 | */ |
074a86fc AL |
256 | typedef struct GlobalProperty { |
257 | const char *driver; | |
258 | const char *property; | |
259 | const char *value; | |
b3ce84fe | 260 | bool used; |
92fd453c | 261 | bool optional; |
074a86fc AL |
262 | } GlobalProperty; |
263 | ||
ea9ce893 MAL |
264 | static inline void |
265 | compat_props_add(GPtrArray *arr, | |
266 | GlobalProperty props[], size_t nelem) | |
267 | { | |
268 | int i; | |
269 | for (i = 0; i < nelem; i++) { | |
270 | g_ptr_array_add(arr, (void *)&props[i]); | |
271 | } | |
272 | } | |
273 | ||
074a86fc AL |
274 | /*** Board API. This should go away once we have a machine config file. ***/ |
275 | ||
276 | DeviceState *qdev_create(BusState *bus, const char *name); | |
277 | DeviceState *qdev_try_create(BusState *bus, const char *name); | |
074a86fc AL |
278 | void qdev_init_nofail(DeviceState *dev); |
279 | void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id, | |
280 | int required_for_version); | |
14405c27 | 281 | HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev); |
03fcbd9d | 282 | HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev); |
d2321d31 | 283 | bool qdev_hotplug_allowed(DeviceState *dev, Error **errp); |
17cc0128 IM |
284 | /** |
285 | * qdev_get_hotplug_handler: Get handler responsible for device wiring | |
286 | * | |
287 | * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it. | |
288 | * | |
289 | * Note: in case @dev has a parent bus, it will be returned as handler unless | |
290 | * machine handler overrides it. | |
291 | * | |
292 | * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface | |
293 | * or NULL if there aren't any. | |
294 | */ | |
c06b2ffb | 295 | HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev); |
074a86fc | 296 | void qdev_unplug(DeviceState *dev, Error **errp); |
014176f9 IM |
297 | void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev, |
298 | DeviceState *dev, Error **errp); | |
074a86fc AL |
299 | void qdev_machine_creation_done(void); |
300 | bool qdev_machine_modified(void); | |
301 | ||
302 | qemu_irq qdev_get_gpio_in(DeviceState *dev, int n); | |
a5f54290 PC |
303 | qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n); |
304 | ||
074a86fc | 305 | void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin); |
a5f54290 PC |
306 | void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n, |
307 | qemu_irq pin); | |
b7973186 | 308 | qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n); |
0c24db2b PC |
309 | qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt, |
310 | const char *name, int n); | |
074a86fc AL |
311 | |
312 | BusState *qdev_get_child_bus(DeviceState *dev, const char *name); | |
313 | ||
314 | /*** Device API. ***/ | |
315 | ||
316 | /* Register device properties. */ | |
317 | /* GPIO inputs also double as IRQ sinks. */ | |
318 | void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n); | |
319 | void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n); | |
a5f54290 PC |
320 | void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins, |
321 | const char *name, int n); | |
4a151677 PM |
322 | /** |
323 | * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines | |
324 | * for the specified device | |
325 | * | |
326 | * @dev: Device to create input GPIOs for | |
327 | * @handler: Function to call when GPIO line value is set | |
328 | * @opaque: Opaque data pointer to pass to @handler | |
329 | * @name: Name of the GPIO input (must be unique for this device) | |
330 | * @n: Number of GPIO lines in this input set | |
331 | */ | |
332 | void qdev_init_gpio_in_named_with_opaque(DeviceState *dev, | |
333 | qemu_irq_handler handler, | |
334 | void *opaque, | |
335 | const char *name, int n); | |
336 | ||
337 | /** | |
338 | * qdev_init_gpio_in_named: create an array of input GPIO lines | |
339 | * for the specified device | |
340 | * | |
341 | * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer | |
342 | * passed to the handler is @dev (which is the most commonly desired behaviour). | |
343 | */ | |
344 | static inline void qdev_init_gpio_in_named(DeviceState *dev, | |
345 | qemu_irq_handler handler, | |
346 | const char *name, int n) | |
347 | { | |
348 | qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n); | |
349 | } | |
074a86fc | 350 | |
17a96a14 PC |
351 | void qdev_pass_gpios(DeviceState *dev, DeviceState *container, |
352 | const char *name); | |
353 | ||
074a86fc AL |
354 | BusState *qdev_get_parent_bus(DeviceState *dev); |
355 | ||
356 | /*** BUS API. ***/ | |
357 | ||
358 | DeviceState *qdev_find_recursive(BusState *bus, const char *id); | |
359 | ||
360 | /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */ | |
361 | typedef int (qbus_walkerfn)(BusState *bus, void *opaque); | |
362 | typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque); | |
363 | ||
fb17dfe0 | 364 | void qbus_create_inplace(void *bus, size_t size, const char *typename, |
074a86fc AL |
365 | DeviceState *parent, const char *name); |
366 | BusState *qbus_create(const char *typename, DeviceState *parent, const char *name); | |
367 | /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion, | |
368 | * < 0 if either devfn or busfn terminate walk somewhere in cursion, | |
369 | * 0 otherwise. */ | |
0293214b PB |
370 | int qbus_walk_children(BusState *bus, |
371 | qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, | |
372 | qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, | |
373 | void *opaque); | |
374 | int qdev_walk_children(DeviceState *dev, | |
375 | qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, | |
376 | qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, | |
377 | void *opaque); | |
378 | ||
074a86fc | 379 | void qdev_reset_all(DeviceState *dev); |
ff8de075 | 380 | void qdev_reset_all_fn(void *opaque); |
d0508c36 PB |
381 | |
382 | /** | |
383 | * @qbus_reset_all: | |
384 | * @bus: Bus to be reset. | |
385 | * | |
386 | * Reset @bus and perform a bus-level ("hard") reset of all devices connected | |
387 | * to it, including recursive processing of all buses below @bus itself. A | |
388 | * hard reset means that qbus_reset_all will reset all state of the device. | |
389 | * For PCI devices, for example, this will include the base address registers | |
390 | * or configuration space. | |
391 | */ | |
392 | void qbus_reset_all(BusState *bus); | |
074a86fc AL |
393 | void qbus_reset_all_fn(void *opaque); |
394 | ||
074a86fc AL |
395 | /* This should go away once we get rid of the NULL bus hack */ |
396 | BusState *sysbus_get_default(void); | |
397 | ||
398 | char *qdev_get_fw_dev_path(DeviceState *dev); | |
0be63901 | 399 | char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev); |
074a86fc AL |
400 | |
401 | /** | |
402 | * @qdev_machine_init | |
403 | * | |
404 | * Initialize platform devices before machine init. This is a hack until full | |
405 | * support for composition is added. | |
406 | */ | |
407 | void qdev_machine_init(void); | |
408 | ||
409 | /** | |
410 | * @device_reset | |
411 | * | |
412 | * Reset a single device (by calling the reset method). | |
413 | */ | |
414 | void device_reset(DeviceState *dev); | |
415 | ||
46795cf2 PMD |
416 | void device_class_set_parent_reset(DeviceClass *dc, |
417 | DeviceReset dev_reset, | |
418 | DeviceReset *parent_reset); | |
419 | void device_class_set_parent_realize(DeviceClass *dc, | |
420 | DeviceRealize dev_realize, | |
421 | DeviceRealize *parent_realize); | |
422 | void device_class_set_parent_unrealize(DeviceClass *dc, | |
423 | DeviceUnrealize dev_unrealize, | |
424 | DeviceUnrealize *parent_unrealize); | |
425 | ||
8a9358cc | 426 | const VMStateDescription *qdev_get_vmsd(DeviceState *dev); |
074a86fc AL |
427 | |
428 | const char *qdev_fw_name(DeviceState *dev); | |
429 | ||
430 | Object *qdev_get_machine(void); | |
431 | ||
432 | /* FIXME: make this a link<> */ | |
433 | void qdev_set_parent_bus(DeviceState *dev, BusState *bus); | |
434 | ||
9bed84c1 | 435 | extern bool qdev_hotplug; |
21def24a | 436 | extern bool qdev_hot_removed; |
074a86fc AL |
437 | |
438 | char *qdev_get_dev_path(DeviceState *dev); | |
439 | ||
4cae4d5a | 440 | GSList *qdev_build_hotpluggable_device_list(Object *peripheral); |
66e56b13 | 441 | |
94d1cc5f | 442 | void qbus_set_hotplug_handler(BusState *bus, Object *handler, Error **errp); |
431bbb26 IM |
443 | |
444 | void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp); | |
39b888bd IM |
445 | |
446 | static inline bool qbus_is_hotpluggable(BusState *bus) | |
447 | { | |
2d9a982f | 448 | return bus->hotplug_handler; |
39b888bd | 449 | } |
707ff800 PD |
450 | |
451 | void device_listener_register(DeviceListener *listener); | |
452 | void device_listener_unregister(DeviceListener *listener); | |
453 | ||
074a86fc | 454 | #endif |