vmxnet3: Drop net_vmxnet3_info.can_receive
[qemu.git] / include / hw / qdev-core.h
blob038b54d94b27561cba4f89a96874929fa09c9966
1 #ifndef QDEV_CORE_H
2 #define QDEV_CORE_H
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"
9 #include "hw/irq.h"
10 #include "qapi/error.h"
11 #include "hw/hotplug.h"
13 enum {
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,
24 DEVICE_CATEGORY_USB,
25 DEVICE_CATEGORY_STORAGE,
26 DEVICE_CATEGORY_NETWORK,
27 DEVICE_CATEGORY_INPUT,
28 DEVICE_CATEGORY_DISPLAY,
29 DEVICE_CATEGORY_SOUND,
30 DEVICE_CATEGORY_MISC,
31 DEVICE_CATEGORY_MAX
32 } DeviceCategory;
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;
44 /**
45 * DeviceClass:
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
58 * # Realization #
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 can also be
69 * set with 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.
86 * <note>
87 * <para>
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.
93 * </para>
94 * </note>
96 typedef struct DeviceClass {
97 /*< private >*/
98 ObjectClass parent_class;
99 /*< public >*/
101 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
102 const char *fw_name;
103 const char *desc;
104 Property *props;
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;
117 bool hotpluggable;
119 /* callbacks */
120 void (*reset)(DeviceState *dev);
121 DeviceRealize realize;
122 DeviceUnrealize unrealize;
124 /* device state */
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;
131 } DeviceClass;
133 typedef struct NamedGPIOList NamedGPIOList;
135 struct NamedGPIOList {
136 char *name;
137 qemu_irq *in;
138 int num_in;
139 int num_out;
140 QLIST_ENTRY(NamedGPIOList) node;
144 * DeviceState:
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.
150 struct DeviceState {
151 /*< private >*/
152 Object parent_obj;
153 /*< public >*/
155 const char *id;
156 bool realized;
157 bool pending_deleted_event;
158 QemuOpts *opts;
159 int hotplugged;
160 BusState *parent_bus;
161 QLIST_HEAD(, NamedGPIOList) gpios;
162 QLIST_HEAD(, BusState) child_bus;
163 int num_child_bus;
164 int instance_id_alias;
165 int alias_required_for_version;
168 struct DeviceListener {
169 void (*realize)(DeviceListener *listener, DeviceState *dev);
170 void (*unrealize)(DeviceListener *listener, DeviceState *dev);
171 QTAILQ_ENTRY(DeviceListener) link;
174 #define TYPE_BUS "bus"
175 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
176 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
177 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
179 struct BusClass {
180 ObjectClass parent_class;
182 /* FIXME first arg should be BusState */
183 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
184 char *(*get_dev_path)(DeviceState *dev);
186 * This callback is used to create Open Firmware device path in accordance
187 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
188 * bindings can be found at http://playground.sun.com/1275/bindings/.
190 char *(*get_fw_dev_path)(DeviceState *dev);
191 void (*reset)(BusState *bus);
192 BusRealize realize;
193 BusUnrealize unrealize;
195 /* maximum devices allowed on the bus, 0: no limit. */
196 int max_dev;
197 /* number of automatically allocated bus ids (e.g. ide.0) */
198 int automatic_ids;
201 typedef struct BusChild {
202 DeviceState *child;
203 int index;
204 QTAILQ_ENTRY(BusChild) sibling;
205 } BusChild;
207 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
210 * BusState:
211 * @hotplug_device: link to a hotplug device associated with bus.
213 struct BusState {
214 Object obj;
215 DeviceState *parent;
216 const char *name;
217 HotplugHandler *hotplug_handler;
218 int max_index;
219 bool realized;
220 QTAILQ_HEAD(ChildrenHead, BusChild) children;
221 QLIST_ENTRY(BusState) sibling;
224 struct Property {
225 const char *name;
226 PropertyInfo *info;
227 int offset;
228 uint8_t bitnr;
229 qtype_code qtype;
230 int64_t defval;
231 int arrayoffset;
232 PropertyInfo *arrayinfo;
233 int arrayfieldsize;
236 struct PropertyInfo {
237 const char *name;
238 const char *description;
239 const char * const *enum_table;
240 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
241 ObjectPropertyAccessor *get;
242 ObjectPropertyAccessor *set;
243 ObjectPropertyRelease *release;
247 * GlobalProperty:
248 * @user_provided: Set to true if property comes from user-provided config
249 * (command-line or config file).
250 * @used: Set to true if property was used when initializing a device.
252 typedef struct GlobalProperty {
253 const char *driver;
254 const char *property;
255 const char *value;
256 bool user_provided;
257 bool used;
258 QTAILQ_ENTRY(GlobalProperty) next;
259 } GlobalProperty;
261 /*** Board API. This should go away once we have a machine config file. ***/
263 DeviceState *qdev_create(BusState *bus, const char *name);
264 DeviceState *qdev_try_create(BusState *bus, const char *name);
265 void qdev_init_nofail(DeviceState *dev);
266 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
267 int required_for_version);
268 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
269 void qdev_unplug(DeviceState *dev, Error **errp);
270 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
271 DeviceState *dev, Error **errp);
272 void qdev_machine_creation_done(void);
273 bool qdev_machine_modified(void);
275 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
276 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
278 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
279 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
280 qemu_irq pin);
281 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
282 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
283 const char *name, int n);
285 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
287 /*** Device API. ***/
289 /* Register device properties. */
290 /* GPIO inputs also double as IRQ sinks. */
291 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
292 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
293 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
294 const char *name, int n);
295 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
296 const char *name, int n);
298 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
299 const char *name);
301 BusState *qdev_get_parent_bus(DeviceState *dev);
303 /*** BUS API. ***/
305 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
307 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
308 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
309 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
311 void qbus_create_inplace(void *bus, size_t size, const char *typename,
312 DeviceState *parent, const char *name);
313 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
314 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
315 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
316 * 0 otherwise. */
317 int qbus_walk_children(BusState *bus,
318 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
319 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
320 void *opaque);
321 int qdev_walk_children(DeviceState *dev,
322 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
323 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
324 void *opaque);
326 void qdev_reset_all(DeviceState *dev);
329 * @qbus_reset_all:
330 * @bus: Bus to be reset.
332 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
333 * to it, including recursive processing of all buses below @bus itself. A
334 * hard reset means that qbus_reset_all will reset all state of the device.
335 * For PCI devices, for example, this will include the base address registers
336 * or configuration space.
338 void qbus_reset_all(BusState *bus);
339 void qbus_reset_all_fn(void *opaque);
341 /* This should go away once we get rid of the NULL bus hack */
342 BusState *sysbus_get_default(void);
344 char *qdev_get_fw_dev_path(DeviceState *dev);
345 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
348 * @qdev_machine_init
350 * Initialize platform devices before machine init. This is a hack until full
351 * support for composition is added.
353 void qdev_machine_init(void);
356 * @device_reset
358 * Reset a single device (by calling the reset method).
360 void device_reset(DeviceState *dev);
362 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
364 const char *qdev_fw_name(DeviceState *dev);
366 Object *qdev_get_machine(void);
368 /* FIXME: make this a link<> */
369 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
371 extern int qdev_hotplug;
373 char *qdev_get_dev_path(DeviceState *dev);
375 GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
377 void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
378 Error **errp);
380 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
382 static inline bool qbus_is_hotpluggable(BusState *bus)
384 return bus->hotplug_handler;
387 void device_listener_register(DeviceListener *listener);
388 void device_listener_unregister(DeviceListener *listener);
390 #endif