4 #include "qemu/queue.h"
5 #include "qemu/option.h"
6 #include "qemu/typedefs.h"
7 #include "qemu/bitmap.h"
8 #include "qom/object.h"
10 #include "qapi/error.h"
11 #include "hw/hotplug.h"
14 DEV_NVECTORS_UNSPECIFIED = -1,
17 #define TYPE_DEVICE "device"
18 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
19 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
20 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
22 typedef enum DeviceCategory {
23 DEVICE_CATEGORY_BRIDGE,
25 DEVICE_CATEGORY_STORAGE,
26 DEVICE_CATEGORY_NETWORK,
27 DEVICE_CATEGORY_INPUT,
28 DEVICE_CATEGORY_DISPLAY,
29 DEVICE_CATEGORY_SOUND,
34 typedef int (*qdev_initfn)(DeviceState *dev);
35 typedef int (*qdev_event)(DeviceState *dev);
36 typedef void (*qdev_resetfn)(DeviceState *dev);
37 typedef void (*DeviceRealize)(DeviceState *dev, Error **errp);
38 typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp);
39 typedef void (*BusRealize)(BusState *bus, Error **errp);
40 typedef void (*BusUnrealize)(BusState *bus, Error **errp);
42 struct VMStateDescription;
46 * @props: Properties accessing state fields.
47 * @realize: Callback function invoked when the #DeviceState:realized
48 * property is changed to %true. The default invokes @init if not %NULL.
49 * @unrealize: Callback function invoked when the #DeviceState:realized
50 * property is changed to %false.
51 * @init: Callback function invoked when the #DeviceState::realized property
52 * is changed to %true. Deprecated, new types inheriting directly from
53 * TYPE_DEVICE should use @realize instead, new leaf types should consult
54 * their respective parent type.
55 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
56 * as readonly "hotpluggable" property of #DeviceState instance
59 * Devices are constructed in two stages,
60 * 1) object instantiation via object_initialize() and
61 * 2) device realization via #DeviceState:realized property.
62 * The former may not fail (it might assert or exit), the latter may return
63 * error information to the caller and must be re-entrant.
64 * Trivial field initializations should go into #TypeInfo.instance_init.
65 * Operations depending on @props static properties should go into @realize.
66 * After successful realization, setting static properties will fail.
68 * As an interim step, the #DeviceState:realized property is set by deprecated
69 * functions qdev_init() and qdev_init_nofail().
70 * In the future, devices will propagate this state change to their children
71 * and along busses they expose.
72 * The point in time will be deferred to machine creation, so that values
73 * set in @realize will not be introspectable beforehand. Therefore devices
74 * must not create children during @realize; they should initialize them via
75 * object_initialize() in their own #TypeInfo.instance_init and forward the
76 * realization events appropriately.
78 * The @init callback is considered private to a particular bus implementation
79 * (immediate abstract child types of TYPE_DEVICE). Derived leaf types set an
80 * "init" callback on their parent class instead.
82 * Any type may override the @realize and/or @unrealize callbacks but needs
83 * to call the parent type's implementation if keeping their functionality
84 * is desired. Refer to QOM documentation for further discussion and examples.
88 * If a type derived directly from TYPE_DEVICE implements @realize, it does
89 * not need to implement @init and therefore does not need to store and call
90 * #DeviceClass' default @realize callback.
91 * For other types consult the documentation and implementation of the
92 * respective parent types.
96 typedef struct DeviceClass {
98 ObjectClass parent_class;
101 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
107 * Shall we hide this device model from -device / device_add?
108 * All devices should support instantiation with device_add, and
109 * this flag should not exist. But we're not there, yet. Some
110 * devices fail to instantiate with cryptic error messages.
111 * Others instantiate, but don't work. Exposing users to such
112 * behavior would be cruel; this flag serves to protect them. It
113 * should never be set without a comment explaining why it is set.
114 * TODO remove once we're there
116 bool cannot_instantiate_with_device_add_yet;
120 void (*reset)(DeviceState *dev);
121 DeviceRealize realize;
122 DeviceUnrealize unrealize;
125 const struct VMStateDescription *vmsd;
127 /* Private to qdev / bus. */
128 qdev_initfn init; /* TODO remove, once users are converted to realize */
129 qdev_event exit; /* TODO remove, once users are converted to unrealize */
130 const char *bus_type;
133 typedef struct NamedGPIOList NamedGPIOList;
135 struct NamedGPIOList {
140 QLIST_ENTRY(NamedGPIOList) node;
145 * @realized: Indicates whether the device has been fully constructed.
147 * This structure should not be accessed directly. We declare it here
148 * so that it can be embedded in individual device state structures.
157 bool pending_deleted_event;
160 BusState *parent_bus;
161 QLIST_HEAD(, NamedGPIOList) gpios;
162 QLIST_HEAD(, BusState) child_bus;
164 int instance_id_alias;
165 int alias_required_for_version;
168 #define TYPE_BUS "bus"
169 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
170 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
171 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
174 ObjectClass parent_class;
176 /* FIXME first arg should be BusState */
177 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
178 char *(*get_dev_path)(DeviceState *dev);
180 * This callback is used to create Open Firmware device path in accordance
181 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
182 * bindings can be found at http://playground.sun.com/1275/bindings/.
184 char *(*get_fw_dev_path)(DeviceState *dev);
185 void (*reset)(BusState *bus);
187 BusUnrealize unrealize;
189 /* maximum devices allowed on the bus, 0: no limit. */
191 /* number of automatically allocated bus ids (e.g. ide.0) */
195 typedef struct BusChild {
198 QTAILQ_ENTRY(BusChild) sibling;
201 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
205 * @hotplug_device: link to a hotplug device associated with bus.
211 HotplugHandler *hotplug_handler;
214 QTAILQ_HEAD(ChildrenHead, BusChild) children;
215 QLIST_ENTRY(BusState) sibling;
226 PropertyInfo *arrayinfo;
230 struct PropertyInfo {
232 const char *description;
233 const char **enum_table;
234 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
235 ObjectPropertyAccessor *get;
236 ObjectPropertyAccessor *set;
237 ObjectPropertyRelease *release;
242 * @user_provided: Set to true if property comes from user-provided config
243 * (command-line or config file).
244 * @used: Set to true if property was used when initializing a device.
246 typedef struct GlobalProperty {
248 const char *property;
252 QTAILQ_ENTRY(GlobalProperty) next;
255 /*** Board API. This should go away once we have a machine config file. ***/
257 DeviceState *qdev_create(BusState *bus, const char *name);
258 DeviceState *qdev_try_create(BusState *bus, const char *name);
259 int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
260 void qdev_init_nofail(DeviceState *dev);
261 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
262 int required_for_version);
263 void qdev_unplug(DeviceState *dev, Error **errp);
264 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
265 DeviceState *dev, Error **errp);
266 void qdev_machine_creation_done(void);
267 bool qdev_machine_modified(void);
269 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
270 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
272 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
273 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
275 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
276 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
277 const char *name, int n);
279 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
281 /*** Device API. ***/
283 /* Register device properties. */
284 /* GPIO inputs also double as IRQ sinks. */
285 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
286 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
287 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
288 const char *name, int n);
289 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
290 const char *name, int n);
292 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
295 BusState *qdev_get_parent_bus(DeviceState *dev);
299 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
301 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
302 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
303 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
305 void qbus_create_inplace(void *bus, size_t size, const char *typename,
306 DeviceState *parent, const char *name);
307 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
308 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
309 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
311 int qbus_walk_children(BusState *bus,
312 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
313 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
315 int qdev_walk_children(DeviceState *dev,
316 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
317 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
320 void qdev_reset_all(DeviceState *dev);
324 * @bus: Bus to be reset.
326 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
327 * to it, including recursive processing of all buses below @bus itself. A
328 * hard reset means that qbus_reset_all will reset all state of the device.
329 * For PCI devices, for example, this will include the base address registers
330 * or configuration space.
332 void qbus_reset_all(BusState *bus);
333 void qbus_reset_all_fn(void *opaque);
335 /* This should go away once we get rid of the NULL bus hack */
336 BusState *sysbus_get_default(void);
338 char *qdev_get_fw_dev_path(DeviceState *dev);
343 * Initialize platform devices before machine init. This is a hack until full
344 * support for composition is added.
346 void qdev_machine_init(void);
351 * Reset a single device (by calling the reset method).
353 void device_reset(DeviceState *dev);
355 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
357 const char *qdev_fw_name(DeviceState *dev);
359 Object *qdev_get_machine(void);
361 /* FIXME: make this a link<> */
362 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
364 extern int qdev_hotplug;
366 char *qdev_get_dev_path(DeviceState *dev);
368 int qdev_build_hotpluggable_device_list(Object *obj, void *opaque);
370 void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
373 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
375 static inline bool qbus_is_hotpluggable(BusState *bus)
377 return bus->hotplug_handler;