]>
Commit | Line | Data |
---|---|---|
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" |
aae9460e | 9 | |
ee6847d1 GH |
10 | typedef struct Property Property; |
11 | ||
12 | typedef struct PropertyInfo PropertyInfo; | |
aae9460e | 13 | |
b6b61144 GH |
14 | typedef struct CompatProperty CompatProperty; |
15 | ||
ee6847d1 | 16 | typedef struct DeviceInfo DeviceInfo; |
aae9460e | 17 | |
02e2da45 | 18 | typedef struct BusState BusState; |
4d6ae674 | 19 | |
10c4c98a GH |
20 | typedef struct BusInfo BusInfo; |
21 | ||
131ec1bd GH |
22 | enum DevState { |
23 | DEV_STATE_CREATED = 1, | |
24 | DEV_STATE_INITIALIZED, | |
25 | }; | |
26 | ||
75422b0d AS |
27 | enum { |
28 | DEV_NVECTORS_UNSPECIFIED = -1, | |
29 | }; | |
30 | ||
44677ded AL |
31 | /** |
32 | * @DevicePropertyAccessor - called when trying to get/set a property | |
33 | * | |
34 | * @dev the device that owns the property | |
35 | * @v the visitor that contains the property data | |
36 | * @opaque the device property opaque | |
37 | * @name the name of the property | |
38 | * @errp a pointer to an Error that is filled if getting/setting fails. | |
39 | */ | |
40 | typedef void (DevicePropertyAccessor)(DeviceState *dev, | |
41 | Visitor *v, | |
42 | void *opaque, | |
43 | const char *name, | |
44 | Error **errp); | |
45 | ||
46 | /** | |
47 | * @DevicePropertyRelease - called when a property is removed from a device | |
48 | * | |
49 | * @dev the device that owns the property | |
50 | * @name the name of the property | |
51 | * @opaque the opaque registered with the property | |
52 | */ | |
53 | typedef void (DevicePropertyRelease)(DeviceState *dev, | |
54 | const char *name, | |
55 | void *opaque); | |
56 | ||
57 | typedef struct DeviceProperty | |
58 | { | |
59 | gchar *name; | |
60 | gchar *type; | |
61 | DevicePropertyAccessor *get; | |
62 | DevicePropertyAccessor *set; | |
63 | DevicePropertyRelease *release; | |
64 | void *opaque; | |
65 | ||
66 | QTAILQ_ENTRY(DeviceProperty) node; | |
67 | } DeviceProperty; | |
68 | ||
aae9460e PB |
69 | /* This structure should not be accessed directly. We declare it here |
70 | so that it can be embedded in individual device state structures. */ | |
02e2da45 | 71 | struct DeviceState { |
f31d07d1 | 72 | const char *id; |
131ec1bd | 73 | enum DevState state; |
ef80b466 | 74 | QemuOpts *opts; |
3418bd25 | 75 | int hotplugged; |
042f84d0 | 76 | DeviceInfo *info; |
02e2da45 | 77 | BusState *parent_bus; |
aae9460e PB |
78 | int num_gpio_out; |
79 | qemu_irq *gpio_out; | |
80 | int num_gpio_in; | |
81 | qemu_irq *gpio_in; | |
72cf2d4f | 82 | QLIST_HEAD(, BusState) child_bus; |
d271de9f | 83 | int num_child_bus; |
d8bb00d6 | 84 | QTAILQ_ENTRY(DeviceState) sibling; |
4d2ffa08 JK |
85 | int instance_id_alias; |
86 | int alias_required_for_version; | |
85ed303b AL |
87 | |
88 | /** | |
89 | * This tracks the number of references between devices. See @qdev_ref for | |
90 | * more information. | |
91 | */ | |
92 | uint32_t ref; | |
44677ded AL |
93 | |
94 | QTAILQ_HEAD(, DeviceProperty) properties; | |
b2b6c39a AL |
95 | |
96 | /* Do not, under any circumstance, use this parent link below anywhere | |
97 | * outside of qdev.c. You have been warned. */ | |
98 | DeviceState *parent; | |
02e2da45 PB |
99 | }; |
100 | ||
10c4c98a | 101 | typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent); |
6772b936 | 102 | typedef char *(*bus_get_dev_path)(DeviceState *dev); |
21150814 GN |
103 | /* |
104 | * This callback is used to create Open Firmware device path in accordance with | |
105 | * OF spec http://forthworks.com/standards/of1275.pdf. Indicidual bus bindings | |
106 | * can be found here http://playground.sun.com/1275/bindings/. | |
107 | */ | |
108 | typedef char *(*bus_get_fw_dev_path)(DeviceState *dev); | |
b4694b7c | 109 | typedef int (qbus_resetfn)(BusState *bus); |
6772b936 | 110 | |
10c4c98a GH |
111 | struct BusInfo { |
112 | const char *name; | |
113 | size_t size; | |
114 | bus_dev_printfn print_dev; | |
6772b936 | 115 | bus_get_dev_path get_dev_path; |
21150814 | 116 | bus_get_fw_dev_path get_fw_dev_path; |
b4694b7c | 117 | qbus_resetfn *reset; |
ee6847d1 | 118 | Property *props; |
10c4c98a | 119 | }; |
02e2da45 PB |
120 | |
121 | struct BusState { | |
122 | DeviceState *parent; | |
10c4c98a | 123 | BusInfo *info; |
02e2da45 | 124 | const char *name; |
3418bd25 | 125 | int allow_hotplug; |
cd739fb6 | 126 | int qdev_allocated; |
f48a7a6e | 127 | QTAILQ_HEAD(ChildrenHead, DeviceState) children; |
72cf2d4f | 128 | QLIST_ENTRY(BusState) sibling; |
aae9460e PB |
129 | }; |
130 | ||
ee6847d1 GH |
131 | struct Property { |
132 | const char *name; | |
133 | PropertyInfo *info; | |
134 | int offset; | |
d2364ee4 | 135 | int bitnr; |
ee6847d1 GH |
136 | void *defval; |
137 | }; | |
138 | ||
139 | enum PropertyType { | |
140 | PROP_TYPE_UNSPEC = 0, | |
c7cc172d | 141 | PROP_TYPE_UINT8, |
ee6847d1 GH |
142 | PROP_TYPE_UINT16, |
143 | PROP_TYPE_UINT32, | |
316940b0 | 144 | PROP_TYPE_INT32, |
5a053d1f | 145 | PROP_TYPE_UINT64, |
ee6847d1 GH |
146 | PROP_TYPE_TADDR, |
147 | PROP_TYPE_MACADDR, | |
14b41872 | 148 | PROP_TYPE_DRIVE, |
313feaab | 149 | PROP_TYPE_CHR, |
59419663 | 150 | PROP_TYPE_STRING, |
2ef924b4 | 151 | PROP_TYPE_NETDEV, |
851bec09 | 152 | PROP_TYPE_VLAN, |
ee6847d1 | 153 | PROP_TYPE_PTR, |
d2364ee4 | 154 | PROP_TYPE_BIT, |
ee6847d1 GH |
155 | }; |
156 | ||
157 | struct PropertyInfo { | |
158 | const char *name; | |
cafe5bdb | 159 | const char *legacy_name; |
ee6847d1 GH |
160 | size_t size; |
161 | enum PropertyType type; | |
80e555c2 PB |
162 | int64_t min; |
163 | int64_t max; | |
ee6847d1 GH |
164 | int (*parse)(DeviceState *dev, Property *prop, const char *str); |
165 | int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len); | |
d21357df | 166 | void (*free)(DeviceState *dev, Property *prop); |
80e555c2 PB |
167 | DevicePropertyAccessor *get; |
168 | DevicePropertyAccessor *set; | |
ee6847d1 GH |
169 | }; |
170 | ||
458fb679 | 171 | typedef struct GlobalProperty { |
b6b61144 GH |
172 | const char *driver; |
173 | const char *property; | |
174 | const char *value; | |
458fb679 GH |
175 | QTAILQ_ENTRY(GlobalProperty) next; |
176 | } GlobalProperty; | |
b6b61144 | 177 | |
aae9460e PB |
178 | /*** Board API. This should go away once we have a machine config file. ***/ |
179 | ||
02e2da45 | 180 | DeviceState *qdev_create(BusState *bus, const char *name); |
0bcdeda7 | 181 | DeviceState *qdev_try_create(BusState *bus, const char *name); |
ff952ba2 | 182 | int qdev_device_help(QemuOpts *opts); |
f31d07d1 | 183 | DeviceState *qdev_device_add(QemuOpts *opts); |
747bbdf7 | 184 | int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT; |
e23a1b33 | 185 | void qdev_init_nofail(DeviceState *dev); |
4d2ffa08 JK |
186 | void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id, |
187 | int required_for_version); | |
3418bd25 | 188 | int qdev_unplug(DeviceState *dev); |
02e2da45 | 189 | void qdev_free(DeviceState *dev); |
3418bd25 GH |
190 | int qdev_simple_unplug_cb(DeviceState *dev); |
191 | void qdev_machine_creation_done(void); | |
0ac8ef71 | 192 | bool qdev_machine_modified(void); |
aae9460e | 193 | |
aae9460e PB |
194 | qemu_irq qdev_get_gpio_in(DeviceState *dev, int n); |
195 | void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin); | |
196 | ||
02e2da45 | 197 | BusState *qdev_get_child_bus(DeviceState *dev, const char *name); |
4d6ae674 | 198 | |
aae9460e PB |
199 | /*** Device API. ***/ |
200 | ||
81a322d4 | 201 | typedef int (*qdev_initfn)(DeviceState *dev, DeviceInfo *info); |
3418bd25 | 202 | typedef int (*qdev_event)(DeviceState *dev); |
7f23f812 | 203 | typedef void (*qdev_resetfn)(DeviceState *dev); |
aae9460e | 204 | |
02e2da45 | 205 | struct DeviceInfo { |
074f2fff | 206 | const char *name; |
779206de | 207 | const char *fw_name; |
3320e56e GH |
208 | const char *alias; |
209 | const char *desc; | |
074f2fff | 210 | size_t size; |
ee6847d1 | 211 | Property *props; |
3320e56e | 212 | int no_user; |
074f2fff | 213 | |
959f733a | 214 | /* callbacks */ |
7f23f812 | 215 | qdev_resetfn reset; |
959f733a | 216 | |
391a079e GH |
217 | /* device state */ |
218 | const VMStateDescription *vmsd; | |
219 | ||
074f2fff | 220 | /* Private to qdev / bus. */ |
02e2da45 | 221 | qdev_initfn init; |
3418bd25 GH |
222 | qdev_event unplug; |
223 | qdev_event exit; | |
10c4c98a | 224 | BusInfo *bus_info; |
042f84d0 | 225 | struct DeviceInfo *next; |
02e2da45 | 226 | }; |
0958b4cc | 227 | extern DeviceInfo *device_info_list; |
02e2da45 | 228 | |
074f2fff | 229 | void qdev_register(DeviceInfo *info); |
aae9460e PB |
230 | |
231 | /* Register device properties. */ | |
067a3ddc | 232 | /* GPIO inputs also double as IRQ sinks. */ |
aae9460e PB |
233 | void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n); |
234 | void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n); | |
235 | ||
236 | CharDriverState *qdev_init_chardev(DeviceState *dev); | |
237 | ||
02e2da45 | 238 | BusState *qdev_get_parent_bus(DeviceState *dev); |
aae9460e | 239 | |
02e2da45 PB |
240 | /*** BUS API. ***/ |
241 | ||
a2ee6b4f IY |
242 | DeviceState *qdev_find_recursive(BusState *bus, const char *id); |
243 | ||
81699d8a AL |
244 | /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */ |
245 | typedef int (qbus_walkerfn)(BusState *bus, void *opaque); | |
246 | typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque); | |
247 | ||
cd739fb6 GH |
248 | void qbus_create_inplace(BusState *bus, BusInfo *info, |
249 | DeviceState *parent, const char *name); | |
10c4c98a | 250 | BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name); |
81699d8a AL |
251 | /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion, |
252 | * < 0 if either devfn or busfn terminate walk somewhere in cursion, | |
253 | * 0 otherwise. */ | |
254 | int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn, | |
255 | qbus_walkerfn *busfn, void *opaque); | |
256 | int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn, | |
257 | qbus_walkerfn *busfn, void *opaque); | |
5af0a04b | 258 | void qdev_reset_all(DeviceState *dev); |
80376c3f IY |
259 | void qbus_reset_all_fn(void *opaque); |
260 | ||
131ec1bd | 261 | void qbus_free(BusState *bus); |
02e2da45 PB |
262 | |
263 | #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev) | |
264 | ||
ec990eb6 AL |
265 | /* This should go away once we get rid of the NULL bus hack */ |
266 | BusState *sysbus_get_default(void); | |
267 | ||
cae4956e GH |
268 | /*** monitor commands ***/ |
269 | ||
270 | void do_info_qtree(Monitor *mon); | |
f6c64e0e | 271 | void do_info_qdm(Monitor *mon); |
8bc27249 | 272 | int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data); |
17a38eaa | 273 | int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data); |
cae4956e | 274 | |
ee6847d1 GH |
275 | /*** qdev-properties.c ***/ |
276 | ||
d2364ee4 | 277 | extern PropertyInfo qdev_prop_bit; |
c7cc172d | 278 | extern PropertyInfo qdev_prop_uint8; |
ee6847d1 GH |
279 | extern PropertyInfo qdev_prop_uint16; |
280 | extern PropertyInfo qdev_prop_uint32; | |
316940b0 | 281 | extern PropertyInfo qdev_prop_int32; |
5a053d1f | 282 | extern PropertyInfo qdev_prop_uint64; |
6835678c | 283 | extern PropertyInfo qdev_prop_hex8; |
ee6847d1 | 284 | extern PropertyInfo qdev_prop_hex32; |
5a053d1f | 285 | extern PropertyInfo qdev_prop_hex64; |
59419663 | 286 | extern PropertyInfo qdev_prop_string; |
313feaab | 287 | extern PropertyInfo qdev_prop_chr; |
ee6847d1 GH |
288 | extern PropertyInfo qdev_prop_ptr; |
289 | extern PropertyInfo qdev_prop_macaddr; | |
14b41872 | 290 | extern PropertyInfo qdev_prop_drive; |
851bec09 GH |
291 | extern PropertyInfo qdev_prop_netdev; |
292 | extern PropertyInfo qdev_prop_vlan; | |
05cb5fe4 | 293 | extern PropertyInfo qdev_prop_pci_devfn; |
ee6847d1 | 294 | |
cf12b95b GH |
295 | #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \ |
296 | .name = (_name), \ | |
297 | .info = &(_prop), \ | |
298 | .offset = offsetof(_state, _field) \ | |
299 | + type_check(_type,typeof_field(_state, _field)), \ | |
300 | } | |
301 | #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \ | |
302 | .name = (_name), \ | |
303 | .info = &(_prop), \ | |
304 | .offset = offsetof(_state, _field) \ | |
305 | + type_check(_type,typeof_field(_state, _field)), \ | |
306 | .defval = (_type[]) { _defval }, \ | |
307 | } | |
d2364ee4 MT |
308 | #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) { \ |
309 | .name = (_name), \ | |
310 | .info = &(qdev_prop_bit), \ | |
311 | .bitnr = (_bit), \ | |
312 | .offset = offsetof(_state, _field) \ | |
313 | + type_check(uint32_t,typeof_field(_state, _field)), \ | |
314 | .defval = (bool[]) { (_defval) }, \ | |
315 | } | |
cf12b95b | 316 | |
c7cc172d JQ |
317 | #define DEFINE_PROP_UINT8(_n, _s, _f, _d) \ |
318 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t) | |
cf12b95b GH |
319 | #define DEFINE_PROP_UINT16(_n, _s, _f, _d) \ |
320 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t) | |
321 | #define DEFINE_PROP_UINT32(_n, _s, _f, _d) \ | |
322 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t) | |
316940b0 GH |
323 | #define DEFINE_PROP_INT32(_n, _s, _f, _d) \ |
324 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t) | |
cf12b95b GH |
325 | #define DEFINE_PROP_UINT64(_n, _s, _f, _d) \ |
326 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t) | |
6835678c JK |
327 | #define DEFINE_PROP_HEX8(_n, _s, _f, _d) \ |
328 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t) | |
cf12b95b GH |
329 | #define DEFINE_PROP_HEX32(_n, _s, _f, _d) \ |
330 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t) | |
331 | #define DEFINE_PROP_HEX64(_n, _s, _f, _d) \ | |
332 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t) | |
333 | #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \ | |
334 | DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t) | |
335 | ||
336 | #define DEFINE_PROP_PTR(_n, _s, _f) \ | |
337 | DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*) | |
313feaab GH |
338 | #define DEFINE_PROP_CHR(_n, _s, _f) \ |
339 | DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*) | |
59419663 GH |
340 | #define DEFINE_PROP_STRING(_n, _s, _f) \ |
341 | DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*) | |
2ef924b4 GH |
342 | #define DEFINE_PROP_NETDEV(_n, _s, _f) \ |
343 | DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*) | |
851bec09 GH |
344 | #define DEFINE_PROP_VLAN(_n, _s, _f) \ |
345 | DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*) | |
f8b6cc00 MA |
346 | #define DEFINE_PROP_DRIVE(_n, _s, _f) \ |
347 | DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *) | |
cf12b95b | 348 | #define DEFINE_PROP_MACADDR(_n, _s, _f) \ |
1503fff3 | 349 | DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr) |
cf12b95b GH |
350 | |
351 | #define DEFINE_PROP_END_OF_LIST() \ | |
352 | {} | |
353 | ||
ee6847d1 GH |
354 | /* Set properties between creation and init. */ |
355 | void *qdev_get_prop_ptr(DeviceState *dev, Property *prop); | |
d8ed79ae | 356 | int qdev_prop_exists(DeviceState *dev, const char *name); |
ee6847d1 GH |
357 | int qdev_prop_parse(DeviceState *dev, const char *name, const char *value); |
358 | void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type); | |
f4594a3b | 359 | void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value); |
c7cc172d | 360 | void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value); |
ee6847d1 GH |
361 | void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value); |
362 | void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value); | |
316940b0 | 363 | void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value); |
5a053d1f | 364 | void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value); |
cc984673 | 365 | void qdev_prop_set_string(DeviceState *dev, const char *name, char *value); |
313feaab | 366 | void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value); |
2ef924b4 | 367 | void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value); |
851bec09 | 368 | void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value); |
18846dee MA |
369 | int qdev_prop_set_drive(DeviceState *dev, const char *name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT; |
370 | void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name, BlockDriverState *value); | |
1503fff3 | 371 | void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value); |
ee6847d1 GH |
372 | /* FIXME: Remove opaque pointer properties. */ |
373 | void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value); | |
374 | void qdev_prop_set_defaults(DeviceState *dev, Property *props); | |
375 | ||
458fb679 GH |
376 | void qdev_prop_register_global_list(GlobalProperty *props); |
377 | void qdev_prop_set_globals(DeviceState *dev); | |
7db4c4e8 PB |
378 | void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev, |
379 | Property *prop, const char *value); | |
b6b61144 | 380 | |
779206de GN |
381 | static inline const char *qdev_fw_name(DeviceState *dev) |
382 | { | |
383 | return dev->info->fw_name ? : dev->info->alias ? : dev->info->name; | |
384 | } | |
385 | ||
1ca4d09a | 386 | char *qdev_get_fw_dev_path(DeviceState *dev); |
a9ff9df1 BS |
387 | /* This is a nasty hack to allow passing a NULL bus to qdev_create. */ |
388 | extern struct BusInfo system_bus_info; | |
389 | ||
85ed303b AL |
390 | /** |
391 | * @qdev_ref | |
392 | * | |
393 | * Increase the reference count of a device. A device cannot be freed as long | |
394 | * as its reference count is greater than zero. | |
395 | * | |
396 | * @dev - the device | |
397 | */ | |
398 | void qdev_ref(DeviceState *dev); | |
399 | ||
400 | /** | |
401 | * @qdef_unref | |
402 | * | |
403 | * Decrease the reference count of a device. A device cannot be freed as long | |
404 | * as its reference count is greater than zero. | |
405 | * | |
406 | * @dev - the device | |
407 | */ | |
408 | void qdev_unref(DeviceState *dev); | |
409 | ||
44677ded AL |
410 | /** |
411 | * @qdev_property_add - add a new property to a device | |
412 | * | |
413 | * @dev - the device to add a property to | |
414 | * | |
415 | * @name - the name of the property. This can contain any character except for | |
416 | * a forward slash. In general, you should use hyphens '-' instead of | |
417 | * underscores '_' when naming properties. | |
418 | * | |
419 | * @type - the type name of the property. This namespace is pretty loosely | |
420 | * defined. Sub namespaces are constructed by using a prefix and then | |
421 | * to angle brackets. For instance, the type 'virtio-net-pci' in the | |
422 | * 'link' namespace would be 'link<virtio-net-pci>'. | |
423 | * | |
424 | * @get - the getter to be called to read a property. If this is NULL, then | |
425 | * the property cannot be read. | |
426 | * | |
427 | * @set - the setter to be called to write a property. If this is NULL, | |
428 | * then the property cannot be written. | |
429 | * | |
430 | * @release - called when the property is removed from the device. This is | |
431 | * meant to allow a property to free its opaque upon device | |
432 | * destruction. This may be NULL. | |
433 | * | |
434 | * @opaque - an opaque pointer to pass to the callbacks for the property | |
435 | * | |
436 | * @errp - returns an error if this function fails | |
437 | */ | |
438 | void qdev_property_add(DeviceState *dev, const char *name, const char *type, | |
439 | DevicePropertyAccessor *get, DevicePropertyAccessor *set, | |
440 | DevicePropertyRelease *release, | |
441 | void *opaque, Error **errp); | |
442 | ||
443 | /** | |
444 | * @qdev_property_get - reads a property from a device | |
445 | * | |
446 | * @dev - the device | |
447 | * | |
448 | * @v - the visitor that will receive the property value. This should be an | |
449 | * Output visitor and the data will be written with @name as the name. | |
450 | * | |
451 | * @name - the name of the property | |
452 | * | |
453 | * @errp - returns an error if this function fails | |
454 | */ | |
455 | void qdev_property_get(DeviceState *dev, Visitor *v, const char *name, | |
456 | Error **errp); | |
457 | ||
458 | /** | |
459 | * @qdev_property_set - writes a property to a device | |
460 | * | |
461 | * @dev - the device | |
462 | * | |
463 | * @v - the visitor that will be used to write the property value. This should | |
464 | * be an Input visitor and the data will be first read with @name as the | |
465 | * name and then written as the property value. | |
466 | * | |
467 | * @name - the name of the property | |
468 | * | |
469 | * @errp - returns an error if this function fails | |
470 | */ | |
471 | void qdev_property_set(DeviceState *dev, Visitor *v, const char *name, | |
472 | Error **errp); | |
473 | ||
474 | /** | |
475 | * @qdev_property_get_type - returns the type of a property | |
476 | * | |
477 | * @dev - the device | |
478 | * | |
479 | * @name - the name of the property | |
480 | * | |
481 | * @errp - returns an error if this function fails | |
482 | * | |
483 | * Returns: | |
484 | * The type name of the property. | |
485 | */ | |
486 | const char *qdev_property_get_type(DeviceState *dev, const char *name, | |
487 | Error **errp); | |
488 | ||
a5296ca9 | 489 | /** |
ca2cc788 PB |
490 | * @qdev_property_add_static - add a @Property to a device referencing a |
491 | * field in a struct. | |
a5296ca9 | 492 | */ |
ca2cc788 | 493 | void qdev_property_add_static(DeviceState *dev, Property *prop, Error **errp); |
a5296ca9 | 494 | |
a10f07a7 AL |
495 | /** |
496 | * @qdev_get_root - returns the root device of the composition tree | |
497 | * | |
498 | * Returns: | |
499 | * The root of the composition tree. | |
500 | */ | |
501 | DeviceState *qdev_get_root(void); | |
502 | ||
f9fbd2fd AL |
503 | /** |
504 | * @qdev_get_canonical_path - returns the canonical path for a device. This | |
505 | * is the path within the composition tree starting from the root. | |
506 | * | |
507 | * Returns: | |
508 | * The canonical path in the composition tree. | |
509 | */ | |
510 | gchar *qdev_get_canonical_path(DeviceState *dev); | |
511 | ||
dc45c21f AL |
512 | /** |
513 | * @qdev_resolve_path - resolves a path returning a device | |
514 | * | |
515 | * There are two types of supported paths--absolute paths and partial paths. | |
516 | * | |
517 | * Absolute paths are derived from the root device and can follow child<> or | |
518 | * link<> properties. Since they can follow link<> properties, they can be | |
519 | * arbitrarily long. Absolute paths look like absolute filenames and are | |
520 | * prefixed with a leading slash. | |
521 | * | |
522 | * Partial paths look like relative filenames. They do not begin with a | |
523 | * prefix. The matching rules for partial paths are subtle but designed to make | |
524 | * specifying devices easy. At each level of the composition tree, the partial | |
525 | * path is matched as an absolute path. The first match is not returned. At | |
526 | * least two matches are searched for. A successful result is only returned if | |
527 | * only one match is founded. If more than one match is found, a flag is | |
528 | * return to indicate that the match was ambiguous. | |
529 | * | |
530 | * @path - the path to resolve | |
531 | * | |
532 | * @ambiguous - returns true if the path resolution failed because of an | |
533 | * ambiguous match | |
534 | * | |
535 | * Returns: | |
536 | * The matched device or NULL on path lookup failure. | |
537 | */ | |
538 | DeviceState *qdev_resolve_path(const char *path, bool *ambiguous); | |
539 | ||
3de1c3e8 AL |
540 | /** |
541 | * @qdev_property_add_child - Add a child property to a device | |
542 | * | |
543 | * Child properties form the composition tree. All devices need to be a child | |
544 | * of another device. Devices can only be a child of one device. | |
545 | * | |
546 | * There is no way for a child to determine what its parent is. It is not | |
547 | * a bidirectional relationship. This is by design. | |
548 | * | |
549 | * @dev - the device to add a property to | |
550 | * | |
551 | * @name - the name of the property | |
552 | * | |
553 | * @child - the child device | |
554 | * | |
555 | * @errp - if an error occurs, a pointer to an area to store the area | |
556 | */ | |
557 | void qdev_property_add_child(DeviceState *dev, const char *name, | |
558 | DeviceState *child, Error **errp); | |
559 | ||
83e94fb8 AL |
560 | /** |
561 | * @qdev_property_add_link - Add a link property to a device | |
562 | * | |
563 | * Links establish relationships between devices. Links are unidirectional | |
564 | * although two links can be combined to form a bidirectional relationship | |
565 | * between devices. | |
566 | * | |
567 | * Links form the graph in the device model. | |
568 | * | |
569 | * @dev - the device to add a property to | |
570 | * | |
571 | * @name - the name of the property | |
572 | * | |
573 | * @type - the qdev type of the link | |
574 | * | |
575 | * @child - a pointer to where the link device reference is stored | |
576 | * | |
577 | * @errp - if an error occurs, a pointer to an area to store the area | |
578 | */ | |
579 | void qdev_property_add_link(DeviceState *dev, const char *name, | |
580 | const char *type, DeviceState **child, | |
581 | Error **errp); | |
582 | ||
6a146eba AL |
583 | /** |
584 | * @qdev_property_add_str | |
585 | * | |
586 | * Add a string property using getters/setters. This function will add a | |
587 | * property of type 'string'. | |
588 | * | |
589 | * @dev - the device to add a property to | |
590 | * | |
591 | * @name - the name of the property | |
592 | * | |
593 | * @get - the getter or NULL if the property is write-only. This function must | |
594 | * return a string to be freed by @g_free(). | |
595 | * | |
596 | * @set - the setter or NULL if the property is read-only | |
597 | * | |
598 | * @errp - if an error occurs, a pointer to an area to store the error | |
599 | */ | |
600 | void qdev_property_add_str(DeviceState *dev, const char *name, | |
601 | char *(*get)(DeviceState *, Error **), | |
602 | void (*set)(DeviceState *, const char *, Error **), | |
603 | Error **errp); | |
604 | ||
cd34d667 AL |
605 | /** |
606 | * @qdev_get_type | |
607 | * | |
608 | * Returns the string representation of the type of this object. | |
609 | * | |
610 | * @dev - the device | |
611 | * | |
612 | * @errp - if an error occurs, a pointer to an area to store the error | |
613 | * | |
614 | * Returns: a string representing the type. This must be freed by the caller | |
615 | * with g_free(). | |
616 | */ | |
617 | char *qdev_get_type(DeviceState *dev, Error **errp); | |
618 | ||
aae9460e | 619 | #endif |