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
10enum {
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
19typedef 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
32typedef int (*qdev_initfn)(DeviceState *dev);
33typedef int (*qdev_event)(DeviceState *dev);
34typedef void (*DeviceRealize)(DeviceState *dev, Error **errp);
35typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp);
36typedef void (*DeviceReset)(DeviceState *dev);
37typedef void (*BusRealize)(BusState *bus, Error **errp);
38typedef void (*BusUnrealize)(BusState *bus, Error **errp);
39
40struct VMStateDescription;
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94typedef struct DeviceClass {
95
96 ObjectClass parent_class;
97
98
99 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
100 const char *fw_name;
101 const char *desc;
102 Property *props;
103
104
105
106
107
108
109
110
111
112
113
114
115 bool user_creatable;
116 bool hotpluggable;
117
118
119 DeviceReset reset;
120 DeviceRealize realize;
121 DeviceUnrealize unrealize;
122
123
124 const struct VMStateDescription *vmsd;
125
126
127 qdev_initfn init;
128 qdev_event exit;
129 const char *bus_type;
130} DeviceClass;
131
132typedef struct NamedGPIOList NamedGPIOList;
133
134struct NamedGPIOList {
135 char *name;
136 qemu_irq *in;
137 int num_in;
138 int num_out;
139 QLIST_ENTRY(NamedGPIOList) node;
140};
141
142
143
144
145
146
147
148
149struct DeviceState {
150
151 Object parent_obj;
152
153
154 const char *id;
155 char *canonical_path;
156 bool realized;
157 bool pending_deleted_event;
158 QemuOpts *opts;
159 int hotplugged;
160 BusState *parent_bus;
161 QLIST_HEAD(, NamedGPIOList) gpios;
162 QLIST_HEAD(, BusState) child_bus;
163 int num_child_bus;
164 int instance_id_alias;
165 int alias_required_for_version;
166};
167
168struct DeviceListener {
169 void (*realize)(DeviceListener *listener, DeviceState *dev);
170 void (*unrealize)(DeviceListener *listener, DeviceState *dev);
171 QTAILQ_ENTRY(DeviceListener) link;
172};
173
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)
178
179struct BusClass {
180 ObjectClass parent_class;
181
182
183 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
184 char *(*get_dev_path)(DeviceState *dev);
185
186
187
188
189
190 char *(*get_fw_dev_path)(DeviceState *dev);
191 void (*reset)(BusState *bus);
192 BusRealize realize;
193 BusUnrealize unrealize;
194
195
196 int max_dev;
197
198 int automatic_ids;
199};
200
201typedef struct BusChild {
202 DeviceState *child;
203 int index;
204 QTAILQ_ENTRY(BusChild) sibling;
205} BusChild;
206
207#define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
208
209
210
211
212
213struct BusState {
214 Object obj;
215 DeviceState *parent;
216 char *name;
217 HotplugHandler *hotplug_handler;
218 int max_index;
219 bool realized;
220 QTAILQ_HEAD(ChildrenHead, BusChild) children;
221 QLIST_ENTRY(BusState) sibling;
222};
223
224
225
226
227
228
229
230
231
232
233struct Property {
234 const char *name;
235 const PropertyInfo *info;
236 ptrdiff_t offset;
237 uint8_t bitnr;
238 bool set_default;
239 union {
240 int64_t i;
241 uint64_t u;
242 } defval;
243 int arrayoffset;
244 const PropertyInfo *arrayinfo;
245 int arrayfieldsize;
246 const char *link_type;
247};
248
249struct PropertyInfo {
250 const char *name;
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;
259};
260
261
262
263
264
265
266
267
268
269
270
271
272typedef struct GlobalProperty {
273 const char *driver;
274 const char *property;
275 const char *value;
276 bool user_provided;
277 bool used;
278 Error **errp;
279} GlobalProperty;
280
281
282
283DeviceState *qdev_create(BusState *bus, const char *name);
284DeviceState *qdev_try_create(BusState *bus, const char *name);
285void qdev_init_nofail(DeviceState *dev);
286void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
287 int required_for_version);
288HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev);
289HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
290void qdev_unplug(DeviceState *dev, Error **errp);
291void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
292 DeviceState *dev, Error **errp);
293void qdev_machine_creation_done(void);
294bool qdev_machine_modified(void);
295
296qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
297qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
298
299void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
300void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
301 qemu_irq pin);
302qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
303qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
304 const char *name, int n);
305
306BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
307
308
309
310
311
312void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
313void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
314void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
315 const char *name, int n);
316
317
318
319
320
321
322
323
324
325
326void qdev_init_gpio_in_named_with_opaque(DeviceState *dev,
327 qemu_irq_handler handler,
328 void *opaque,
329 const char *name, int n);
330
331
332
333
334
335
336
337
338static inline void qdev_init_gpio_in_named(DeviceState *dev,
339 qemu_irq_handler handler,
340 const char *name, int n)
341{
342 qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n);
343}
344
345void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
346 const char *name);
347
348BusState *qdev_get_parent_bus(DeviceState *dev);
349
350
351
352DeviceState *qdev_find_recursive(BusState *bus, const char *id);
353
354
355typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
356typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
357
358void qbus_create_inplace(void *bus, size_t size, const char *typename,
359 DeviceState *parent, const char *name);
360BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
361
362
363
364int qbus_walk_children(BusState *bus,
365 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
366 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
367 void *opaque);
368int qdev_walk_children(DeviceState *dev,
369 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
370 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
371 void *opaque);
372
373void qdev_reset_all(DeviceState *dev);
374void qdev_reset_all_fn(void *opaque);
375
376
377
378
379
380
381
382
383
384
385
386void qbus_reset_all(BusState *bus);
387void qbus_reset_all_fn(void *opaque);
388
389
390BusState *sysbus_get_default(void);
391
392char *qdev_get_fw_dev_path(DeviceState *dev);
393char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
394
395
396
397
398
399
400
401void qdev_machine_init(void);
402
403
404
405
406
407
408void device_reset(DeviceState *dev);
409
410void device_class_set_parent_reset(DeviceClass *dc,
411 DeviceReset dev_reset,
412 DeviceReset *parent_reset);
413void device_class_set_parent_realize(DeviceClass *dc,
414 DeviceRealize dev_realize,
415 DeviceRealize *parent_realize);
416void device_class_set_parent_unrealize(DeviceClass *dc,
417 DeviceUnrealize dev_unrealize,
418 DeviceUnrealize *parent_unrealize);
419
420const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
421
422const char *qdev_fw_name(DeviceState *dev);
423
424Object *qdev_get_machine(void);
425
426
427void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
428
429extern bool qdev_hotplug;
430extern bool qdev_hot_removed;
431
432char *qdev_get_dev_path(DeviceState *dev);
433
434GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
435
436void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
437 Error **errp);
438
439void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
440
441static inline bool qbus_is_hotpluggable(BusState *bus)
442{
443 return bus->hotplug_handler;
444}
445
446void device_listener_register(DeviceListener *listener);
447void device_listener_unregister(DeviceListener *listener);
448
449#endif
450