5 #include "qemu-queue.h"
7 #include "qemu-option.h"
8 #include "qapi/qapi-visit-core.h"
9 #include "qemu/object.h"
12 typedef struct Property Property
;
14 typedef struct PropertyInfo PropertyInfo
;
16 typedef struct CompatProperty CompatProperty
;
18 typedef struct BusState BusState
;
20 typedef struct BusInfo BusInfo
;
23 DEV_STATE_CREATED
= 1,
24 DEV_STATE_INITIALIZED
,
28 DEV_NVECTORS_UNSPECIFIED
= -1,
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)
36 typedef int (*qdev_initfn
)(DeviceState
*dev
);
37 typedef int (*qdev_event
)(DeviceState
*dev
);
38 typedef void (*qdev_resetfn
)(DeviceState
*dev
);
40 typedef struct DeviceClass
{
41 ObjectClass parent_class
;
49 void (*reset
)(DeviceState
*dev
);
52 const VMStateDescription
*vmsd
;
54 /* Private to qdev / bus. */
61 /* This structure should not be accessed directly. We declare it here
62 so that it can be embedded in individual device state structures. */
75 QLIST_HEAD(, BusState
) child_bus
;
77 QTAILQ_ENTRY(DeviceState
) sibling
;
78 int instance_id_alias
;
79 int alias_required_for_version
;
82 typedef void (*bus_dev_printfn
)(Monitor
*mon
, DeviceState
*dev
, int indent
);
83 typedef char *(*bus_get_dev_path
)(DeviceState
*dev
);
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/.
89 typedef char *(*bus_get_fw_dev_path
)(DeviceState
*dev
);
90 typedef int (qbus_resetfn
)(BusState
*bus
);
95 bus_dev_printfn print_dev
;
96 bus_get_dev_path get_dev_path
;
97 bus_get_fw_dev_path get_fw_dev_path
;
107 QTAILQ_HEAD(ChildrenHead
, DeviceState
) children
;
108 QLIST_ENTRY(BusState
) sibling
;
120 struct PropertyInfo
{
122 const char *legacy_name
;
123 const char **enum_table
;
124 int (*parse
)(DeviceState
*dev
, Property
*prop
, const char *str
);
125 int (*print
)(DeviceState
*dev
, Property
*prop
, char *dest
, size_t len
);
126 ObjectPropertyAccessor
*get
;
127 ObjectPropertyAccessor
*set
;
128 ObjectPropertyRelease
*release
;
131 typedef struct GlobalProperty
{
133 const char *property
;
135 QTAILQ_ENTRY(GlobalProperty
) next
;
138 /*** Board API. This should go away once we have a machine config file. ***/
140 DeviceState
*qdev_create(BusState
*bus
, const char *name
);
141 DeviceState
*qdev_try_create(BusState
*bus
, const char *name
);
142 bool qdev_exists(const char *name
);
143 int qdev_device_help(QemuOpts
*opts
);
144 DeviceState
*qdev_device_add(QemuOpts
*opts
);
145 int qdev_init(DeviceState
*dev
) QEMU_WARN_UNUSED_RESULT
;
146 void qdev_init_nofail(DeviceState
*dev
);
147 void qdev_set_legacy_instance_id(DeviceState
*dev
, int alias_id
,
148 int required_for_version
);
149 void qdev_unplug(DeviceState
*dev
, Error
**errp
);
150 void qdev_free(DeviceState
*dev
);
151 int qdev_simple_unplug_cb(DeviceState
*dev
);
152 void qdev_machine_creation_done(void);
153 bool qdev_machine_modified(void);
155 qemu_irq
qdev_get_gpio_in(DeviceState
*dev
, int n
);
156 void qdev_connect_gpio_out(DeviceState
*dev
, int n
, qemu_irq pin
);
158 BusState
*qdev_get_child_bus(DeviceState
*dev
, const char *name
);
160 /*** Device API. ***/
162 /* Register device properties. */
163 /* GPIO inputs also double as IRQ sinks. */
164 void qdev_init_gpio_in(DeviceState
*dev
, qemu_irq_handler handler
, int n
);
165 void qdev_init_gpio_out(DeviceState
*dev
, qemu_irq
*pins
, int n
);
167 BusState
*qdev_get_parent_bus(DeviceState
*dev
);
171 DeviceState
*qdev_find_recursive(BusState
*bus
, const char *id
);
173 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
174 typedef int (qbus_walkerfn
)(BusState
*bus
, void *opaque
);
175 typedef int (qdev_walkerfn
)(DeviceState
*dev
, void *opaque
);
177 void qbus_create_inplace(BusState
*bus
, BusInfo
*info
,
178 DeviceState
*parent
, const char *name
);
179 BusState
*qbus_create(BusInfo
*info
, DeviceState
*parent
, const char *name
);
180 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
181 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
183 int qbus_walk_children(BusState
*bus
, qdev_walkerfn
*devfn
,
184 qbus_walkerfn
*busfn
, void *opaque
);
185 int qdev_walk_children(DeviceState
*dev
, qdev_walkerfn
*devfn
,
186 qbus_walkerfn
*busfn
, void *opaque
);
187 void qdev_reset_all(DeviceState
*dev
);
188 void qbus_reset_all_fn(void *opaque
);
190 void qbus_free(BusState
*bus
);
192 #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
194 /* This should go away once we get rid of the NULL bus hack */
195 BusState
*sysbus_get_default(void);
197 /*** monitor commands ***/
199 void do_info_qtree(Monitor
*mon
);
200 void do_info_qdm(Monitor
*mon
);
201 int do_device_add(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
);
202 int do_device_del(Monitor
*mon
, const QDict
*qdict
, QObject
**ret_data
);
204 /*** qdev-properties.c ***/
206 extern PropertyInfo qdev_prop_bit
;
207 extern PropertyInfo qdev_prop_uint8
;
208 extern PropertyInfo qdev_prop_uint16
;
209 extern PropertyInfo qdev_prop_uint32
;
210 extern PropertyInfo qdev_prop_int32
;
211 extern PropertyInfo qdev_prop_uint64
;
212 extern PropertyInfo qdev_prop_hex8
;
213 extern PropertyInfo qdev_prop_hex32
;
214 extern PropertyInfo qdev_prop_hex64
;
215 extern PropertyInfo qdev_prop_string
;
216 extern PropertyInfo qdev_prop_chr
;
217 extern PropertyInfo qdev_prop_ptr
;
218 extern PropertyInfo qdev_prop_macaddr
;
219 extern PropertyInfo qdev_prop_losttickpolicy
;
220 extern PropertyInfo qdev_prop_drive
;
221 extern PropertyInfo qdev_prop_netdev
;
222 extern PropertyInfo qdev_prop_vlan
;
223 extern PropertyInfo qdev_prop_pci_devfn
;
224 extern PropertyInfo qdev_prop_blocksize
;
226 #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
229 .offset = offsetof(_state, _field) \
230 + type_check(_type,typeof_field(_state, _field)), \
232 #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
235 .offset = offsetof(_state, _field) \
236 + type_check(_type,typeof_field(_state, _field)), \
237 .qtype = QTYPE_QINT, \
238 .defval = (_type)_defval, \
240 #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) { \
242 .info = &(qdev_prop_bit), \
244 .offset = offsetof(_state, _field) \
245 + type_check(uint32_t,typeof_field(_state, _field)), \
246 .qtype = QTYPE_QBOOL, \
247 .defval = (bool)_defval, \
250 #define DEFINE_PROP_UINT8(_n, _s, _f, _d) \
251 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
252 #define DEFINE_PROP_UINT16(_n, _s, _f, _d) \
253 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
254 #define DEFINE_PROP_UINT32(_n, _s, _f, _d) \
255 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
256 #define DEFINE_PROP_INT32(_n, _s, _f, _d) \
257 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
258 #define DEFINE_PROP_UINT64(_n, _s, _f, _d) \
259 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
260 #define DEFINE_PROP_HEX8(_n, _s, _f, _d) \
261 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t)
262 #define DEFINE_PROP_HEX32(_n, _s, _f, _d) \
263 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
264 #define DEFINE_PROP_HEX64(_n, _s, _f, _d) \
265 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
266 #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \
267 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, int32_t)
269 #define DEFINE_PROP_PTR(_n, _s, _f) \
270 DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
271 #define DEFINE_PROP_CHR(_n, _s, _f) \
272 DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
273 #define DEFINE_PROP_STRING(_n, _s, _f) \
274 DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
275 #define DEFINE_PROP_NETDEV(_n, _s, _f) \
276 DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
277 #define DEFINE_PROP_VLAN(_n, _s, _f) \
278 DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
279 #define DEFINE_PROP_DRIVE(_n, _s, _f) \
280 DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
281 #define DEFINE_PROP_MACADDR(_n, _s, _f) \
282 DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
283 #define DEFINE_PROP_LOSTTICKPOLICY(_n, _s, _f, _d) \
284 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
286 #define DEFINE_PROP_BLOCKSIZE(_n, _s, _f, _d) \
287 DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_blocksize, uint16_t)
289 #define DEFINE_PROP_END_OF_LIST() \
292 /* Set properties between creation and init. */
293 void *qdev_get_prop_ptr(DeviceState
*dev
, Property
*prop
);
294 int qdev_prop_exists(DeviceState
*dev
, const char *name
);
295 int qdev_prop_parse(DeviceState
*dev
, const char *name
, const char *value
);
296 void qdev_prop_set_bit(DeviceState
*dev
, const char *name
, bool value
);
297 void qdev_prop_set_uint8(DeviceState
*dev
, const char *name
, uint8_t value
);
298 void qdev_prop_set_uint16(DeviceState
*dev
, const char *name
, uint16_t value
);
299 void qdev_prop_set_uint32(DeviceState
*dev
, const char *name
, uint32_t value
);
300 void qdev_prop_set_int32(DeviceState
*dev
, const char *name
, int32_t value
);
301 void qdev_prop_set_uint64(DeviceState
*dev
, const char *name
, uint64_t value
);
302 void qdev_prop_set_string(DeviceState
*dev
, const char *name
, char *value
);
303 void qdev_prop_set_chr(DeviceState
*dev
, const char *name
, CharDriverState
*value
);
304 void qdev_prop_set_netdev(DeviceState
*dev
, const char *name
, VLANClientState
*value
);
305 void qdev_prop_set_vlan(DeviceState
*dev
, const char *name
, VLANState
*value
);
306 int qdev_prop_set_drive(DeviceState
*dev
, const char *name
, BlockDriverState
*value
) QEMU_WARN_UNUSED_RESULT
;
307 void qdev_prop_set_drive_nofail(DeviceState
*dev
, const char *name
, BlockDriverState
*value
);
308 void qdev_prop_set_macaddr(DeviceState
*dev
, const char *name
, uint8_t *value
);
309 void qdev_prop_set_enum(DeviceState
*dev
, const char *name
, int value
);
310 /* FIXME: Remove opaque pointer properties. */
311 void qdev_prop_set_ptr(DeviceState
*dev
, const char *name
, void *value
);
312 void qdev_prop_set_defaults(DeviceState
*dev
, Property
*props
);
314 void qdev_prop_register_global_list(GlobalProperty
*props
);
315 void qdev_prop_set_globals(DeviceState
*dev
);
316 void error_set_from_qdev_prop_error(Error
**errp
, int ret
, DeviceState
*dev
,
317 Property
*prop
, const char *value
);
319 char *qdev_get_fw_dev_path(DeviceState
*dev
);
321 /* This is a nasty hack to allow passing a NULL bus to qdev_create. */
322 extern struct BusInfo system_bus_info
;
325 * @qdev_property_add_static - add a @Property to a device referencing a
328 void qdev_property_add_static(DeviceState
*dev
, Property
*prop
, Error
**errp
);
333 * Initialize platform devices before machine init. This is a hack until full
334 * support for composition is added.
336 void qdev_machine_init(void);
341 * Reset a single device (by calling the reset method).
343 void device_reset(DeviceState
*dev
);
345 const VMStateDescription
*qdev_get_vmsd(DeviceState
*dev
);
347 const char *qdev_fw_name(DeviceState
*dev
);
349 Object
*qdev_get_machine(void);
351 /* FIXME: make this a link<> */
352 void qdev_set_parent_bus(DeviceState
*dev
, BusState
*bus
);
354 extern int qdev_hotplug
;