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#include "sysemu/sysemu.h"
10
11enum {
12 DEV_NVECTORS_UNSPECIFIED = -1,
13};
14
15#define TYPE_DEVICE "device"
16#define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
17#define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
18#define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
19
20typedef enum DeviceCategory {
21 DEVICE_CATEGORY_BRIDGE,
22 DEVICE_CATEGORY_USB,
23 DEVICE_CATEGORY_STORAGE,
24 DEVICE_CATEGORY_NETWORK,
25 DEVICE_CATEGORY_INPUT,
26 DEVICE_CATEGORY_DISPLAY,
27 DEVICE_CATEGORY_SOUND,
28 DEVICE_CATEGORY_MISC,
29 DEVICE_CATEGORY_CPU,
30 DEVICE_CATEGORY_MAX
31} DeviceCategory;
32
33typedef void (*DeviceRealize)(DeviceState *dev, Error **errp);
34typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp);
35typedef void (*DeviceReset)(DeviceState *dev);
36typedef void (*BusRealize)(BusState *bus, Error **errp);
37typedef void (*BusUnrealize)(BusState *bus, Error **errp);
38
39struct VMStateDescription;
40
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
86typedef struct DeviceClass {
87
88 ObjectClass parent_class;
89
90
91 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
92 const char *fw_name;
93 const char *desc;
94 Property *props;
95
96
97
98
99
100
101
102
103
104
105
106
107 bool user_creatable;
108 bool hotpluggable;
109
110
111 DeviceReset reset;
112 DeviceRealize realize;
113 DeviceUnrealize unrealize;
114
115
116 const struct VMStateDescription *vmsd;
117
118
119 const char *bus_type;
120} DeviceClass;
121
122typedef struct NamedGPIOList NamedGPIOList;
123
124struct NamedGPIOList {
125 char *name;
126 qemu_irq *in;
127 int num_in;
128 int num_out;
129 QLIST_ENTRY(NamedGPIOList) node;
130};
131
132
133
134
135
136
137
138
139struct DeviceState {
140
141 Object parent_obj;
142
143
144 const char *id;
145 char *canonical_path;
146 bool realized;
147 bool pending_deleted_event;
148 QemuOpts *opts;
149 int hotplugged;
150 BusState *parent_bus;
151 QLIST_HEAD(, NamedGPIOList) gpios;
152 QLIST_HEAD(, BusState) child_bus;
153 int num_child_bus;
154 int instance_id_alias;
155 int alias_required_for_version;
156};
157
158struct DeviceListener {
159 void (*realize)(DeviceListener *listener, DeviceState *dev);
160 void (*unrealize)(DeviceListener *listener, DeviceState *dev);
161 QTAILQ_ENTRY(DeviceListener) link;
162};
163
164#define TYPE_BUS "bus"
165#define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
166#define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
167#define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
168
169struct BusClass {
170 ObjectClass parent_class;
171
172
173 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
174 char *(*get_dev_path)(DeviceState *dev);
175
176
177
178
179
180 char *(*get_fw_dev_path)(DeviceState *dev);
181 void (*reset)(BusState *bus);
182 BusRealize realize;
183 BusUnrealize unrealize;
184
185
186 int max_dev;
187
188 int automatic_ids;
189};
190
191typedef struct BusChild {
192 DeviceState *child;
193 int index;
194 QTAILQ_ENTRY(BusChild) sibling;
195} BusChild;
196
197#define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
198
199
200
201
202
203struct BusState {
204 Object obj;
205 DeviceState *parent;
206 char *name;
207 HotplugHandler *hotplug_handler;
208 int max_index;
209 bool realized;
210 int num_children;
211 QTAILQ_HEAD(, BusChild) children;
212 QLIST_ENTRY(BusState) sibling;
213};
214
215
216
217
218
219
220
221
222
223
224struct Property {
225 const char *name;
226 const PropertyInfo *info;
227 ptrdiff_t offset;
228 uint8_t bitnr;
229 bool set_default;
230 union {
231 int64_t i;
232 uint64_t u;
233 } defval;
234 int arrayoffset;
235 const PropertyInfo *arrayinfo;
236 int arrayfieldsize;
237 const char *link_type;
238};
239
240struct PropertyInfo {
241 const char *name;
242 const char *description;
243 const QEnumLookup *enum_table;
244 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
245 void (*set_default_value)(Object *obj, const Property *prop);
246 void (*create)(Object *obj, Property *prop, Error **errp);
247 ObjectPropertyAccessor *get;
248 ObjectPropertyAccessor *set;
249 ObjectPropertyRelease *release;
250};
251
252
253
254
255
256
257
258
259
260typedef struct GlobalProperty {
261 const char *driver;
262 const char *property;
263 const char *value;
264 bool used;
265 bool optional;
266} GlobalProperty;
267
268static inline void
269compat_props_add(GPtrArray *arr,
270 GlobalProperty props[], size_t nelem)
271{
272 int i;
273 for (i = 0; i < nelem; i++) {
274 g_ptr_array_add(arr, (void *)&props[i]);
275 }
276}
277
278
279
280DeviceState *qdev_create(BusState *bus, const char *name);
281DeviceState *qdev_try_create(BusState *bus, const char *name);
282void qdev_init_nofail(DeviceState *dev);
283void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
284 int required_for_version);
285HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev);
286HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev);
287
288
289
290
291
292
293
294
295
296
297
298HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
299void qdev_unplug(DeviceState *dev, Error **errp);
300void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
301 DeviceState *dev, Error **errp);
302void qdev_machine_creation_done(void);
303bool qdev_machine_modified(void);
304
305qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
306qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
307
308void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
309void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
310 qemu_irq pin);
311qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
312qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
313 const char *name, int n);
314
315BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
316
317
318
319
320
321void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
322void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
323void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
324 const char *name, int n);
325
326
327
328
329
330
331
332
333
334
335void qdev_init_gpio_in_named_with_opaque(DeviceState *dev,
336 qemu_irq_handler handler,
337 void *opaque,
338 const char *name, int n);
339
340
341
342
343
344
345
346
347static inline void qdev_init_gpio_in_named(DeviceState *dev,
348 qemu_irq_handler handler,
349 const char *name, int n)
350{
351 qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n);
352}
353
354void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
355 const char *name);
356
357BusState *qdev_get_parent_bus(DeviceState *dev);
358
359
360
361DeviceState *qdev_find_recursive(BusState *bus, const char *id);
362
363
364typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
365typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
366
367void qbus_create_inplace(void *bus, size_t size, const char *typename,
368 DeviceState *parent, const char *name);
369BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
370
371
372
373int qbus_walk_children(BusState *bus,
374 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
375 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
376 void *opaque);
377int qdev_walk_children(DeviceState *dev,
378 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
379 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
380 void *opaque);
381
382void qdev_reset_all(DeviceState *dev);
383void qdev_reset_all_fn(void *opaque);
384
385
386
387
388
389
390
391
392
393
394
395void qbus_reset_all(BusState *bus);
396void qbus_reset_all_fn(void *opaque);
397
398
399BusState *sysbus_get_default(void);
400
401char *qdev_get_fw_dev_path(DeviceState *dev);
402char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
403
404
405
406
407
408
409
410void qdev_machine_init(void);
411
412
413
414
415
416
417void device_reset(DeviceState *dev);
418
419void device_class_set_parent_reset(DeviceClass *dc,
420 DeviceReset dev_reset,
421 DeviceReset *parent_reset);
422void device_class_set_parent_realize(DeviceClass *dc,
423 DeviceRealize dev_realize,
424 DeviceRealize *parent_realize);
425void device_class_set_parent_unrealize(DeviceClass *dc,
426 DeviceUnrealize dev_unrealize,
427 DeviceUnrealize *parent_unrealize);
428
429const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
430
431const char *qdev_fw_name(DeviceState *dev);
432
433Object *qdev_get_machine(void);
434
435
436void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
437
438extern bool qdev_hotplug;
439extern bool qdev_hot_removed;
440
441char *qdev_get_dev_path(DeviceState *dev);
442
443GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
444
445void qbus_set_hotplug_handler(BusState *bus, Object *handler, Error **errp);
446
447void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
448
449static inline bool qbus_is_hotpluggable(BusState *bus)
450{
451 return bus->hotplug_handler;
452}
453
454void device_listener_register(DeviceListener *listener);
455void device_listener_unregister(DeviceListener *listener);
456
457VMChangeStateEntry *qdev_add_vm_change_state_handler(DeviceState *dev,
458 VMChangeStateHandler *cb,
459 void *opaque);
460
461#endif
462