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