]>
Commit | Line | Data |
---|---|---|
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/irq.h" | |
8 | #include "hw/hotplug.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, Error **errp); | |
34 | typedef void (*DeviceReset)(DeviceState *dev); | |
35 | typedef void (*BusRealize)(BusState *bus, Error **errp); | |
36 | typedef void (*BusUnrealize)(BusState *bus, Error **errp); | |
37 | ||
38 | struct VMStateDescription; | |
39 | ||
40 | /** | |
41 | * DeviceClass: | |
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 | |
49 | * | |
50 | * # Realization # | |
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. | |
60 | * | |
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. | |
70 | * | |
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. | |
74 | * | |
75 | * <note> | |
76 | * <para> | |
77 | * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types | |
78 | * derived directly from it need not call their parent's @realize and | |
79 | * @unrealize. | |
80 | * For other types consult the documentation and implementation of the | |
81 | * respective parent types. | |
82 | * </para> | |
83 | * </note> | |
84 | */ | |
85 | typedef struct DeviceClass { | |
86 | /*< private >*/ | |
87 | ObjectClass parent_class; | |
88 | /*< public >*/ | |
89 | ||
90 | DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX); | |
91 | const char *fw_name; | |
92 | const char *desc; | |
93 | Property *props; | |
94 | ||
95 | /* | |
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 | |
103 | * is cleared. | |
104 | * TODO remove once we're there | |
105 | */ | |
106 | bool user_creatable; | |
107 | bool hotpluggable; | |
108 | ||
109 | /* callbacks */ | |
110 | DeviceReset reset; | |
111 | DeviceRealize realize; | |
112 | DeviceUnrealize unrealize; | |
113 | ||
114 | /* device state */ | |
115 | const struct VMStateDescription *vmsd; | |
116 | ||
117 | /* Private to qdev / bus. */ | |
118 | const char *bus_type; | |
119 | } DeviceClass; | |
120 | ||
121 | typedef struct NamedGPIOList NamedGPIOList; | |
122 | ||
123 | struct NamedGPIOList { | |
124 | char *name; | |
125 | qemu_irq *in; | |
126 | int num_in; | |
127 | int num_out; | |
128 | QLIST_ENTRY(NamedGPIOList) node; | |
129 | }; | |
130 | ||
131 | /** | |
132 | * DeviceState: | |
133 | * @realized: Indicates whether the device has been fully constructed. | |
134 | * | |
135 | * This structure should not be accessed directly. We declare it here | |
136 | * so that it can be embedded in individual device state structures. | |
137 | */ | |
138 | struct DeviceState { | |
139 | /*< private >*/ | |
140 | Object parent_obj; | |
141 | /*< public >*/ | |
142 | ||
143 | const char *id; | |
144 | char *canonical_path; | |
145 | bool realized; | |
146 | bool pending_deleted_event; | |
147 | QemuOpts *opts; | |
148 | int hotplugged; | |
149 | BusState *parent_bus; | |
150 | QLIST_HEAD(, NamedGPIOList) gpios; | |
151 | QLIST_HEAD(, BusState) child_bus; | |
152 | int num_child_bus; | |
153 | int instance_id_alias; | |
154 | int alias_required_for_version; | |
155 | }; | |
156 | ||
157 | struct DeviceListener { | |
158 | void (*realize)(DeviceListener *listener, DeviceState *dev); | |
159 | void (*unrealize)(DeviceListener *listener, DeviceState *dev); | |
160 | QTAILQ_ENTRY(DeviceListener) link; | |
161 | }; | |
162 | ||
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) | |
167 | ||
168 | struct BusClass { | |
169 | ObjectClass parent_class; | |
170 | ||
171 | /* FIXME first arg should be BusState */ | |
172 | void (*print_dev)(Monitor *mon, DeviceState *dev, int indent); | |
173 | char *(*get_dev_path)(DeviceState *dev); | |
174 | /* | |
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/. | |
178 | */ | |
179 | char *(*get_fw_dev_path)(DeviceState *dev); | |
180 | void (*reset)(BusState *bus); | |
181 | BusRealize realize; | |
182 | BusUnrealize unrealize; | |
183 | ||
184 | /* maximum devices allowed on the bus, 0: no limit. */ | |
185 | int max_dev; | |
186 | /* number of automatically allocated bus ids (e.g. ide.0) */ | |
187 | int automatic_ids; | |
188 | }; | |
189 | ||
190 | typedef struct BusChild { | |
191 | DeviceState *child; | |
192 | int index; | |
193 | QTAILQ_ENTRY(BusChild) sibling; | |
194 | } BusChild; | |
195 | ||
196 | #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler" | |
197 | ||
198 | /** | |
199 | * BusState: | |
200 | * @hotplug_handler: link to a hotplug handler associated with bus. | |
201 | */ | |
202 | struct BusState { | |
203 | Object obj; | |
204 | DeviceState *parent; | |
205 | char *name; | |
206 | HotplugHandler *hotplug_handler; | |
207 | int max_index; | |
208 | bool realized; | |
209 | int num_children; | |
210 | QTAILQ_HEAD(, BusChild) children; | |
211 | QLIST_ENTRY(BusState) sibling; | |
212 | }; | |
213 | ||
214 | /** | |
215 | * Property: | |
216 | * @set_default: true if the default value should be set from @defval, | |
217 | * in which case @info->set_default_value must not be NULL | |
218 | * (if false then no default value is set by the property system | |
219 | * and the field retains whatever value it was given by instance_init). | |
220 | * @defval: default value for the property. This is used only if @set_default | |
221 | * is true. | |
222 | */ | |
223 | struct Property { | |
224 | const char *name; | |
225 | const PropertyInfo *info; | |
226 | ptrdiff_t offset; | |
227 | uint8_t bitnr; | |
228 | bool set_default; | |
229 | union { | |
230 | int64_t i; | |
231 | uint64_t u; | |
232 | } defval; | |
233 | int arrayoffset; | |
234 | const PropertyInfo *arrayinfo; | |
235 | int arrayfieldsize; | |
236 | const char *link_type; | |
237 | }; | |
238 | ||
239 | struct PropertyInfo { | |
240 | const char *name; | |
241 | const char *description; | |
242 | const QEnumLookup *enum_table; | |
243 | int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len); | |
244 | void (*set_default_value)(Object *obj, const Property *prop); | |
245 | void (*create)(Object *obj, Property *prop, Error **errp); | |
246 | ObjectPropertyAccessor *get; | |
247 | ObjectPropertyAccessor *set; | |
248 | ObjectPropertyRelease *release; | |
249 | }; | |
250 | ||
251 | /** | |
252 | * GlobalProperty: | |
253 | * @used: Set to true if property was used when initializing a device. | |
254 | * @optional: If set to true, GlobalProperty will be skipped without errors | |
255 | * if the property doesn't exist. | |
256 | * | |
257 | * An error is fatal for non-hotplugged devices, when the global is applied. | |
258 | */ | |
259 | typedef struct GlobalProperty { | |
260 | const char *driver; | |
261 | const char *property; | |
262 | const char *value; | |
263 | bool used; | |
264 | bool optional; | |
265 | } GlobalProperty; | |
266 | ||
267 | static inline void | |
268 | compat_props_add(GPtrArray *arr, | |
269 | GlobalProperty props[], size_t nelem) | |
270 | { | |
271 | int i; | |
272 | for (i = 0; i < nelem; i++) { | |
273 | g_ptr_array_add(arr, (void *)&props[i]); | |
274 | } | |
275 | } | |
276 | ||
277 | /*** Board API. This should go away once we have a machine config file. ***/ | |
278 | ||
279 | DeviceState *qdev_create(BusState *bus, const char *name); | |
280 | DeviceState *qdev_try_create(BusState *bus, const char *name); | |
281 | void qdev_init_nofail(DeviceState *dev); | |
282 | void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id, | |
283 | int required_for_version); | |
284 | HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev); | |
285 | /** | |
286 | * qdev_get_hotplug_handler: Get handler responsible for device wiring | |
287 | * | |
288 | * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it. | |
289 | * | |
290 | * Note: in case @dev has a parent bus, it will be returned as handler unless | |
291 | * machine handler overrides it. | |
292 | * | |
293 | * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface | |
294 | * or NULL if there aren't any. | |
295 | */ | |
296 | HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev); | |
297 | void qdev_unplug(DeviceState *dev, Error **errp); | |
298 | void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev, | |
299 | DeviceState *dev, Error **errp); | |
300 | void qdev_machine_creation_done(void); | |
301 | bool qdev_machine_modified(void); | |
302 | ||
303 | qemu_irq qdev_get_gpio_in(DeviceState *dev, int n); | |
304 | qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n); | |
305 | ||
306 | void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin); | |
307 | void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n, | |
308 | qemu_irq pin); | |
309 | qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n); | |
310 | qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt, | |
311 | const char *name, int n); | |
312 | ||
313 | BusState *qdev_get_child_bus(DeviceState *dev, const char *name); | |
314 | ||
315 | /*** Device API. ***/ | |
316 | ||
317 | /* Register device properties. */ | |
318 | /* GPIO inputs also double as IRQ sinks. */ | |
319 | void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n); | |
320 | void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n); | |
321 | void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins, | |
322 | const char *name, int n); | |
323 | /** | |
324 | * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines | |
325 | * for the specified device | |
326 | * | |
327 | * @dev: Device to create input GPIOs for | |
328 | * @handler: Function to call when GPIO line value is set | |
329 | * @opaque: Opaque data pointer to pass to @handler | |
330 | * @name: Name of the GPIO input (must be unique for this device) | |
331 | * @n: Number of GPIO lines in this input set | |
332 | */ | |
333 | void qdev_init_gpio_in_named_with_opaque(DeviceState *dev, | |
334 | qemu_irq_handler handler, | |
335 | void *opaque, | |
336 | const char *name, int n); | |
337 | ||
338 | /** | |
339 | * qdev_init_gpio_in_named: create an array of input GPIO lines | |
340 | * for the specified device | |
341 | * | |
342 | * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer | |
343 | * passed to the handler is @dev (which is the most commonly desired behaviour). | |
344 | */ | |
345 | static inline void qdev_init_gpio_in_named(DeviceState *dev, | |
346 | qemu_irq_handler handler, | |
347 | const char *name, int n) | |
348 | { | |
349 | qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n); | |
350 | } | |
351 | ||
352 | void qdev_pass_gpios(DeviceState *dev, DeviceState *container, | |
353 | const char *name); | |
354 | ||
355 | BusState *qdev_get_parent_bus(DeviceState *dev); | |
356 | ||
357 | /*** BUS API. ***/ | |
358 | ||
359 | DeviceState *qdev_find_recursive(BusState *bus, const char *id); | |
360 | ||
361 | /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */ | |
362 | typedef int (qbus_walkerfn)(BusState *bus, void *opaque); | |
363 | typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque); | |
364 | ||
365 | void qbus_create_inplace(void *bus, size_t size, const char *typename, | |
366 | DeviceState *parent, const char *name); | |
367 | BusState *qbus_create(const char *typename, DeviceState *parent, const char *name); | |
368 | /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion, | |
369 | * < 0 if either devfn or busfn terminate walk somewhere in cursion, | |
370 | * 0 otherwise. */ | |
371 | int qbus_walk_children(BusState *bus, | |
372 | qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, | |
373 | qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, | |
374 | void *opaque); | |
375 | int qdev_walk_children(DeviceState *dev, | |
376 | qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, | |
377 | qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, | |
378 | void *opaque); | |
379 | ||
380 | void qdev_reset_all(DeviceState *dev); | |
381 | void qdev_reset_all_fn(void *opaque); | |
382 | ||
383 | /** | |
384 | * @qbus_reset_all: | |
385 | * @bus: Bus to be reset. | |
386 | * | |
387 | * Reset @bus and perform a bus-level ("hard") reset of all devices connected | |
388 | * to it, including recursive processing of all buses below @bus itself. A | |
389 | * hard reset means that qbus_reset_all will reset all state of the device. | |
390 | * For PCI devices, for example, this will include the base address registers | |
391 | * or configuration space. | |
392 | */ | |
393 | void qbus_reset_all(BusState *bus); | |
394 | void qbus_reset_all_fn(void *opaque); | |
395 | ||
396 | /* This should go away once we get rid of the NULL bus hack */ | |
397 | BusState *sysbus_get_default(void); | |
398 | ||
399 | char *qdev_get_fw_dev_path(DeviceState *dev); | |
400 | char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev); | |
401 | ||
402 | /** | |
403 | * @qdev_machine_init | |
404 | * | |
405 | * Initialize platform devices before machine init. This is a hack until full | |
406 | * support for composition is added. | |
407 | */ | |
408 | void qdev_machine_init(void); | |
409 | ||
410 | /** | |
411 | * @device_reset | |
412 | * | |
413 | * Reset a single device (by calling the reset method). | |
414 | */ | |
415 | void device_reset(DeviceState *dev); | |
416 | ||
417 | void device_class_set_parent_reset(DeviceClass *dc, | |
418 | DeviceReset dev_reset, | |
419 | DeviceReset *parent_reset); | |
420 | void device_class_set_parent_realize(DeviceClass *dc, | |
421 | DeviceRealize dev_realize, | |
422 | DeviceRealize *parent_realize); | |
423 | void device_class_set_parent_unrealize(DeviceClass *dc, | |
424 | DeviceUnrealize dev_unrealize, | |
425 | DeviceUnrealize *parent_unrealize); | |
426 | ||
427 | const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev); | |
428 | ||
429 | const char *qdev_fw_name(DeviceState *dev); | |
430 | ||
431 | Object *qdev_get_machine(void); | |
432 | ||
433 | void object_apply_compat_props(Object *obj); | |
434 | ||
435 | /* FIXME: make this a link<> */ | |
436 | void qdev_set_parent_bus(DeviceState *dev, BusState *bus); | |
437 | ||
438 | extern bool qdev_hotplug; | |
439 | extern bool qdev_hot_removed; | |
440 | ||
441 | char *qdev_get_dev_path(DeviceState *dev); | |
442 | ||
443 | GSList *qdev_build_hotpluggable_device_list(Object *peripheral); | |
444 | ||
445 | void qbus_set_hotplug_handler(BusState *bus, Object *handler, Error **errp); | |
446 | ||
447 | void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp); | |
448 | ||
449 | static inline bool qbus_is_hotpluggable(BusState *bus) | |
450 | { | |
451 | return bus->hotplug_handler; | |
452 | } | |
453 | ||
454 | void device_listener_register(DeviceListener *listener); | |
455 | void device_listener_unregister(DeviceListener *listener); | |
456 | ||
457 | #endif |