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