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 void (*DeviceRealize)(DeviceState *dev, Error **errp);
33typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp);
34typedef void (*DeviceReset)(DeviceState *dev);
35typedef void (*BusRealize)(BusState *bus, Error **errp);
36typedef void (*BusUnrealize)(BusState *bus, Error **errp);
37
38struct VMStateDescription;
39
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
85typedef struct DeviceClass {
86
87 ObjectClass parent_class;
88
89
90 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
91 const char *fw_name;
92 const char *desc;
93 Property *props;
94
95
96
97
98
99
100
101
102
103
104
105
106 bool user_creatable;
107 bool hotpluggable;
108
109
110 DeviceReset reset;
111 DeviceRealize realize;
112 DeviceUnrealize unrealize;
113
114
115 const struct VMStateDescription *vmsd;
116
117
118 const char *bus_type;
119} DeviceClass;
120
121typedef struct NamedGPIOList NamedGPIOList;
122
123struct 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
133
134
135
136
137
138struct DeviceState {
139
140 Object parent_obj;
141
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
157struct 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
168struct BusClass {
169 ObjectClass parent_class;
170
171
172 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
173 char *(*get_dev_path)(DeviceState *dev);
174
175
176
177
178
179 char *(*get_fw_dev_path)(DeviceState *dev);
180 void (*reset)(BusState *bus);
181 BusRealize realize;
182 BusUnrealize unrealize;
183
184
185 int max_dev;
186
187 int automatic_ids;
188};
189
190typedef 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
200
201
202struct BusState {
203 Object obj;
204 DeviceState *parent;
205 char *name;
206 HotplugHandler *hotplug_handler;
207 int max_index;
208 bool realized;
209 QTAILQ_HEAD(ChildrenHead, BusChild) children;
210 QLIST_ENTRY(BusState) sibling;
211};
212
213
214
215
216
217
218
219
220
221
222struct Property {
223 const char *name;
224 const PropertyInfo *info;
225 ptrdiff_t offset;
226 uint8_t bitnr;
227 bool set_default;
228 union {
229 int64_t i;
230 uint64_t u;
231 } defval;
232 int arrayoffset;
233 const PropertyInfo *arrayinfo;
234 int arrayfieldsize;
235 const char *link_type;
236};
237
238struct PropertyInfo {
239 const char *name;
240 const char *description;
241 const QEnumLookup *enum_table;
242 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
243 void (*set_default_value)(Object *obj, const Property *prop);
244 void (*create)(Object *obj, Property *prop, Error **errp);
245 ObjectPropertyAccessor *get;
246 ObjectPropertyAccessor *set;
247 ObjectPropertyRelease *release;
248};
249
250
251
252
253
254
255
256
257
258
259
260
261typedef struct GlobalProperty {
262 const char *driver;
263 const char *property;
264 const char *value;
265 bool user_provided;
266 bool used;
267 Error **errp;
268} GlobalProperty;
269
270
271
272DeviceState *qdev_create(BusState *bus, const char *name);
273DeviceState *qdev_try_create(BusState *bus, const char *name);
274void qdev_init_nofail(DeviceState *dev);
275void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
276 int required_for_version);
277HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev);
278HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
279void qdev_unplug(DeviceState *dev, Error **errp);
280void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
281 DeviceState *dev, Error **errp);
282void qdev_machine_creation_done(void);
283bool qdev_machine_modified(void);
284
285qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
286qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
287
288void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
289void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
290 qemu_irq pin);
291qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
292qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
293 const char *name, int n);
294
295BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
296
297
298
299
300
301void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
302void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
303void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
304 const char *name, int n);
305
306
307
308
309
310
311
312
313
314
315void qdev_init_gpio_in_named_with_opaque(DeviceState *dev,
316 qemu_irq_handler handler,
317 void *opaque,
318 const char *name, int n);
319
320
321
322
323
324
325
326
327static inline void qdev_init_gpio_in_named(DeviceState *dev,
328 qemu_irq_handler handler,
329 const char *name, int n)
330{
331 qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n);
332}
333
334void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
335 const char *name);
336
337BusState *qdev_get_parent_bus(DeviceState *dev);
338
339
340
341DeviceState *qdev_find_recursive(BusState *bus, const char *id);
342
343
344typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
345typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
346
347void qbus_create_inplace(void *bus, size_t size, const char *typename,
348 DeviceState *parent, const char *name);
349BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
350
351
352
353int qbus_walk_children(BusState *bus,
354 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
355 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
356 void *opaque);
357int qdev_walk_children(DeviceState *dev,
358 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
359 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
360 void *opaque);
361
362void qdev_reset_all(DeviceState *dev);
363void qdev_reset_all_fn(void *opaque);
364
365
366
367
368
369
370
371
372
373
374
375void qbus_reset_all(BusState *bus);
376void qbus_reset_all_fn(void *opaque);
377
378
379BusState *sysbus_get_default(void);
380
381char *qdev_get_fw_dev_path(DeviceState *dev);
382char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
383
384
385
386
387
388
389
390void qdev_machine_init(void);
391
392
393
394
395
396
397void device_reset(DeviceState *dev);
398
399void device_class_set_parent_reset(DeviceClass *dc,
400 DeviceReset dev_reset,
401 DeviceReset *parent_reset);
402void device_class_set_parent_realize(DeviceClass *dc,
403 DeviceRealize dev_realize,
404 DeviceRealize *parent_realize);
405void device_class_set_parent_unrealize(DeviceClass *dc,
406 DeviceUnrealize dev_unrealize,
407 DeviceUnrealize *parent_unrealize);
408
409const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
410
411const char *qdev_fw_name(DeviceState *dev);
412
413Object *qdev_get_machine(void);
414
415
416void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
417
418extern bool qdev_hotplug;
419extern bool qdev_hot_removed;
420
421char *qdev_get_dev_path(DeviceState *dev);
422
423GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
424
425void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
426 Error **errp);
427
428void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
429
430static inline bool qbus_is_hotpluggable(BusState *bus)
431{
432 return bus->hotplug_handler;
433}
434
435void device_listener_register(DeviceListener *listener);
436void device_listener_unregister(DeviceListener *listener);
437
438#endif
439