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