]> git.proxmox.com Git - mirror_qemu.git/blame - hw/qdev.h
Merge branch 'memory/core' of git://git.kernel.org/pub/scm/virt/kvm/qemu-kvm
[mirror_qemu.git] / hw / qdev.h
CommitLineData
aae9460e
PB
1#ifndef QDEV_H
2#define QDEV_H
3
4#include "hw.h"
72cf2d4f 5#include "qemu-queue.h"
313feaab 6#include "qemu-char.h"
f31d07d1 7#include "qemu-option.h"
44677ded 8#include "qapi/qapi-visit-core.h"
32fea402 9#include "qemu/object.h"
aae9460e 10
ee6847d1
GH
11typedef struct Property Property;
12
13typedef struct PropertyInfo PropertyInfo;
aae9460e 14
b6b61144
GH
15typedef struct CompatProperty CompatProperty;
16
02e2da45 17typedef struct BusState BusState;
4d6ae674 18
10c4c98a
GH
19typedef struct BusInfo BusInfo;
20
131ec1bd
GH
21enum DevState {
22 DEV_STATE_CREATED = 1,
23 DEV_STATE_INITIALIZED,
24};
25
75422b0d
AS
26enum {
27 DEV_NVECTORS_UNSPECIFIED = -1,
28};
29
32fea402
AL
30#define TYPE_DEVICE "device"
31#define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
30fbb9fc
AL
32#define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
33#define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
32fea402 34
d307af79 35typedef int (*qdev_initfn)(DeviceState *dev);
6e008585
AL
36typedef int (*qdev_event)(DeviceState *dev);
37typedef void (*qdev_resetfn)(DeviceState *dev);
38
32fea402
AL
39typedef struct DeviceClass {
40 ObjectClass parent_class;
6e008585
AL
41
42 const char *fw_name;
6e008585
AL
43 const char *desc;
44 Property *props;
45 int no_user;
46
47 /* callbacks */
94afdadc 48 void (*reset)(DeviceState *dev);
6e008585
AL
49
50 /* device state */
51 const VMStateDescription *vmsd;
52
53 /* Private to qdev / bus. */
54 qdev_initfn init;
55 qdev_event unplug;
56 qdev_event exit;
57 BusInfo *bus_info;
32fea402
AL
58} DeviceClass;
59
aae9460e
PB
60/* This structure should not be accessed directly. We declare it here
61 so that it can be embedded in individual device state structures. */
02e2da45 62struct DeviceState {
32fea402
AL
63 Object parent_obj;
64
f31d07d1 65 const char *id;
131ec1bd 66 enum DevState state;
ef80b466 67 QemuOpts *opts;
3418bd25 68 int hotplugged;
02e2da45 69 BusState *parent_bus;
aae9460e
PB
70 int num_gpio_out;
71 qemu_irq *gpio_out;
72 int num_gpio_in;
73 qemu_irq *gpio_in;
72cf2d4f 74 QLIST_HEAD(, BusState) child_bus;
d271de9f 75 int num_child_bus;
d8bb00d6 76 QTAILQ_ENTRY(DeviceState) sibling;
4d2ffa08
JK
77 int instance_id_alias;
78 int alias_required_for_version;
02e2da45
PB
79};
80
10c4c98a 81typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent);
6772b936 82typedef char *(*bus_get_dev_path)(DeviceState *dev);
21150814
GN
83/*
84 * This callback is used to create Open Firmware device path in accordance with
85 * OF spec http://forthworks.com/standards/of1275.pdf. Indicidual bus bindings
86 * can be found here http://playground.sun.com/1275/bindings/.
87 */
88typedef char *(*bus_get_fw_dev_path)(DeviceState *dev);
b4694b7c 89typedef int (qbus_resetfn)(BusState *bus);
6772b936 90
10c4c98a
GH
91struct BusInfo {
92 const char *name;
93 size_t size;
94 bus_dev_printfn print_dev;
6772b936 95 bus_get_dev_path get_dev_path;
21150814 96 bus_get_fw_dev_path get_fw_dev_path;
b4694b7c 97 qbus_resetfn *reset;
ee6847d1 98 Property *props;
10c4c98a 99};
02e2da45
PB
100
101struct BusState {
102 DeviceState *parent;
10c4c98a 103 BusInfo *info;
02e2da45 104 const char *name;
3418bd25 105 int allow_hotplug;
cd739fb6 106 int qdev_allocated;
f48a7a6e 107 QTAILQ_HEAD(ChildrenHead, DeviceState) children;
72cf2d4f 108 QLIST_ENTRY(BusState) sibling;
aae9460e
PB
109};
110
ee6847d1
GH
111struct Property {
112 const char *name;
113 PropertyInfo *info;
114 int offset;
4f2d3d70
PB
115 uint8_t bitnr;
116 uint8_t qtype;
117 int64_t defval;
ee6847d1
GH
118};
119
ee6847d1
GH
120struct PropertyInfo {
121 const char *name;
cafe5bdb 122 const char *legacy_name;
1ce05125 123 const char **enum_table;
80e555c2
PB
124 int64_t min;
125 int64_t max;
ee6847d1
GH
126 int (*parse)(DeviceState *dev, Property *prop, const char *str);
127 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
57c9fafe
AL
128 ObjectPropertyAccessor *get;
129 ObjectPropertyAccessor *set;
dd0ba250 130 ObjectPropertyRelease *release;
ee6847d1
GH
131};
132
458fb679 133typedef struct GlobalProperty {
b6b61144
GH
134 const char *driver;
135 const char *property;
136 const char *value;
458fb679
GH
137 QTAILQ_ENTRY(GlobalProperty) next;
138} GlobalProperty;
b6b61144 139
aae9460e
PB
140/*** Board API. This should go away once we have a machine config file. ***/
141
02e2da45 142DeviceState *qdev_create(BusState *bus, const char *name);
0bcdeda7 143DeviceState *qdev_try_create(BusState *bus, const char *name);
a369da5f 144bool qdev_exists(const char *name);
ff952ba2 145int qdev_device_help(QemuOpts *opts);
f31d07d1 146DeviceState *qdev_device_add(QemuOpts *opts);
747bbdf7 147int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
e23a1b33 148void qdev_init_nofail(DeviceState *dev);
4d2ffa08
JK
149void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
150 int required_for_version);
3418bd25 151int qdev_unplug(DeviceState *dev);
02e2da45 152void qdev_free(DeviceState *dev);
3418bd25
GH
153int qdev_simple_unplug_cb(DeviceState *dev);
154void qdev_machine_creation_done(void);
0ac8ef71 155bool qdev_machine_modified(void);
aae9460e 156
aae9460e
PB
157qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
158void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
159
02e2da45 160BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
4d6ae674 161
aae9460e
PB
162/*** Device API. ***/
163
aae9460e 164/* Register device properties. */
067a3ddc 165/* GPIO inputs also double as IRQ sinks. */
aae9460e
PB
166void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
167void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
168
02e2da45 169BusState *qdev_get_parent_bus(DeviceState *dev);
aae9460e 170
02e2da45
PB
171/*** BUS API. ***/
172
a2ee6b4f
IY
173DeviceState *qdev_find_recursive(BusState *bus, const char *id);
174
81699d8a
AL
175/* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
176typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
177typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
178
cd739fb6
GH
179void qbus_create_inplace(BusState *bus, BusInfo *info,
180 DeviceState *parent, const char *name);
10c4c98a 181BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
81699d8a
AL
182/* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
183 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
184 * 0 otherwise. */
185int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
186 qbus_walkerfn *busfn, void *opaque);
187int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
188 qbus_walkerfn *busfn, void *opaque);
5af0a04b 189void qdev_reset_all(DeviceState *dev);
80376c3f
IY
190void qbus_reset_all_fn(void *opaque);
191
131ec1bd 192void qbus_free(BusState *bus);
02e2da45
PB
193
194#define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
195
ec990eb6
AL
196/* This should go away once we get rid of the NULL bus hack */
197BusState *sysbus_get_default(void);
198
cae4956e
GH
199/*** monitor commands ***/
200
201void do_info_qtree(Monitor *mon);
f6c64e0e 202void do_info_qdm(Monitor *mon);
8bc27249 203int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data);
17a38eaa 204int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data);
cae4956e 205
ee6847d1
GH
206/*** qdev-properties.c ***/
207
d2364ee4 208extern PropertyInfo qdev_prop_bit;
c7cc172d 209extern PropertyInfo qdev_prop_uint8;
ee6847d1
GH
210extern PropertyInfo qdev_prop_uint16;
211extern PropertyInfo qdev_prop_uint32;
316940b0 212extern PropertyInfo qdev_prop_int32;
5a053d1f 213extern PropertyInfo qdev_prop_uint64;
6835678c 214extern PropertyInfo qdev_prop_hex8;
ee6847d1 215extern PropertyInfo qdev_prop_hex32;
5a053d1f 216extern PropertyInfo qdev_prop_hex64;
59419663 217extern PropertyInfo qdev_prop_string;
313feaab 218extern PropertyInfo qdev_prop_chr;
ee6847d1
GH
219extern PropertyInfo qdev_prop_ptr;
220extern PropertyInfo qdev_prop_macaddr;
4e4fa398 221extern PropertyInfo qdev_prop_losttickpolicy;
14b41872 222extern PropertyInfo qdev_prop_drive;
851bec09
GH
223extern PropertyInfo qdev_prop_netdev;
224extern PropertyInfo qdev_prop_vlan;
05cb5fe4 225extern PropertyInfo qdev_prop_pci_devfn;
ee6847d1 226
cf12b95b
GH
227#define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
228 .name = (_name), \
229 .info = &(_prop), \
230 .offset = offsetof(_state, _field) \
231 + type_check(_type,typeof_field(_state, _field)), \
232 }
233#define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
234 .name = (_name), \
235 .info = &(_prop), \
236 .offset = offsetof(_state, _field) \
237 + type_check(_type,typeof_field(_state, _field)), \
4f2d3d70
PB
238 .qtype = QTYPE_QINT, \
239 .defval = (_type)_defval, \
cf12b95b 240 }
d2364ee4
MT
241#define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) { \
242 .name = (_name), \
243 .info = &(qdev_prop_bit), \
244 .bitnr = (_bit), \
245 .offset = offsetof(_state, _field) \
246 + type_check(uint32_t,typeof_field(_state, _field)), \
4f2d3d70
PB
247 .qtype = QTYPE_QBOOL, \
248 .defval = (bool)_defval, \
d2364ee4 249 }
cf12b95b 250
c7cc172d
JQ
251#define DEFINE_PROP_UINT8(_n, _s, _f, _d) \
252 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
cf12b95b
GH
253#define DEFINE_PROP_UINT16(_n, _s, _f, _d) \
254 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
255#define DEFINE_PROP_UINT32(_n, _s, _f, _d) \
256 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
316940b0
GH
257#define DEFINE_PROP_INT32(_n, _s, _f, _d) \
258 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
cf12b95b
GH
259#define DEFINE_PROP_UINT64(_n, _s, _f, _d) \
260 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
6835678c
JK
261#define DEFINE_PROP_HEX8(_n, _s, _f, _d) \
262 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t)
cf12b95b
GH
263#define DEFINE_PROP_HEX32(_n, _s, _f, _d) \
264 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
265#define DEFINE_PROP_HEX64(_n, _s, _f, _d) \
266 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
267#define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \
268 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
269
270#define DEFINE_PROP_PTR(_n, _s, _f) \
271 DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
313feaab
GH
272#define DEFINE_PROP_CHR(_n, _s, _f) \
273 DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
59419663
GH
274#define DEFINE_PROP_STRING(_n, _s, _f) \
275 DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
2ef924b4
GH
276#define DEFINE_PROP_NETDEV(_n, _s, _f) \
277 DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
851bec09
GH
278#define DEFINE_PROP_VLAN(_n, _s, _f) \
279 DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
f8b6cc00
MA
280#define DEFINE_PROP_DRIVE(_n, _s, _f) \
281 DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
cf12b95b 282#define DEFINE_PROP_MACADDR(_n, _s, _f) \
1503fff3 283 DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
4e4fa398
JK
284#define DEFINE_PROP_LOSTTICKPOLICY(_n, _s, _f, _d) \
285 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
286 LostTickPolicy)
cf12b95b
GH
287
288#define DEFINE_PROP_END_OF_LIST() \
289 {}
290
ee6847d1
GH
291/* Set properties between creation and init. */
292void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
d8ed79ae 293int qdev_prop_exists(DeviceState *dev, const char *name);
ee6847d1 294int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
f4594a3b 295void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value);
c7cc172d 296void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
ee6847d1
GH
297void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
298void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
316940b0 299void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
5a053d1f 300void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
cc984673 301void qdev_prop_set_string(DeviceState *dev, const char *name, char *value);
313feaab 302void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
2ef924b4 303void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value);
851bec09 304void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value);
18846dee
MA
305int qdev_prop_set_drive(DeviceState *dev, const char *name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT;
306void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name, BlockDriverState *value);
1503fff3 307void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
9b170e60 308void qdev_prop_set_enum(DeviceState *dev, const char *name, int value);
ee6847d1
GH
309/* FIXME: Remove opaque pointer properties. */
310void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
311void qdev_prop_set_defaults(DeviceState *dev, Property *props);
312
458fb679
GH
313void qdev_prop_register_global_list(GlobalProperty *props);
314void qdev_prop_set_globals(DeviceState *dev);
7db4c4e8
PB
315void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev,
316 Property *prop, const char *value);
b6b61144 317
1ca4d09a 318char *qdev_get_fw_dev_path(DeviceState *dev);
4be9f0d1 319
a9ff9df1
BS
320/* This is a nasty hack to allow passing a NULL bus to qdev_create. */
321extern struct BusInfo system_bus_info;
322
a5296ca9 323/**
ca2cc788
PB
324 * @qdev_property_add_static - add a @Property to a device referencing a
325 * field in a struct.
a5296ca9 326 */
ca2cc788 327void qdev_property_add_static(DeviceState *dev, Property *prop, Error **errp);
a5296ca9 328
1de81d28
AL
329/**
330 * @qdev_machine_init
331 *
332 * Initialize platform devices before machine init. This is a hack until full
333 * support for composition is added.
334 */
335void qdev_machine_init(void);
336
94afdadc
AL
337/**
338 * @device_reset
339 *
340 * Reset a single device (by calling the reset method).
341 */
342void device_reset(DeviceState *dev);
343
4be9f0d1
AL
344const VMStateDescription *qdev_get_vmsd(DeviceState *dev);
345
346const char *qdev_fw_name(DeviceState *dev);
347
348BusInfo *qdev_get_bus_info(DeviceState *dev);
349
350Property *qdev_get_props(DeviceState *dev);
351
f05f6b4a
PB
352Object *qdev_get_machine(void);
353
9fbe6127
AL
354/* FIXME: make this a link<> */
355void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
356
ee46d8a5
AL
357extern int qdev_hotplug;
358
aae9460e 359#endif