apic: move target-dependent definitions to cpu.h
[qemu.git] / include / hw / qdev-core.h
1 #ifndef QDEV_CORE_H
2 #define QDEV_CORE_H
3
4 #include "qemu/queue.h"
5 #include "qemu/option.h"
6 #include "qemu/bitmap.h"
7 #include "qom/object.h"
8 #include "hw/irq.h"
9 #include "hw/hotplug.h"
10
11 enum {
12 DEV_NVECTORS_UNSPECIFIED = -1,
13 };
14
15 #define TYPE_DEVICE "device"
16 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
17 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
18 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
19
20 typedef enum DeviceCategory {
21 DEVICE_CATEGORY_BRIDGE,
22 DEVICE_CATEGORY_USB,
23 DEVICE_CATEGORY_STORAGE,
24 DEVICE_CATEGORY_NETWORK,
25 DEVICE_CATEGORY_INPUT,
26 DEVICE_CATEGORY_DISPLAY,
27 DEVICE_CATEGORY_SOUND,
28 DEVICE_CATEGORY_MISC,
29 DEVICE_CATEGORY_MAX
30 } DeviceCategory;
31
32 typedef int (*qdev_initfn)(DeviceState *dev);
33 typedef int (*qdev_event)(DeviceState *dev);
34 typedef void (*qdev_resetfn)(DeviceState *dev);
35 typedef void (*DeviceRealize)(DeviceState *dev, Error **errp);
36 typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp);
37 typedef void (*BusRealize)(BusState *bus, Error **errp);
38 typedef void (*BusUnrealize)(BusState *bus, Error **errp);
39
40 struct VMStateDescription;
41
42 /**
43 * DeviceClass:
44 * @props: Properties accessing state fields.
45 * @realize: Callback function invoked when the #DeviceState:realized
46 * property is changed to %true. The default invokes @init if not %NULL.
47 * @unrealize: Callback function invoked when the #DeviceState:realized
48 * property is changed to %false.
49 * @init: Callback function invoked when the #DeviceState::realized property
50 * is changed to %true. Deprecated, new types inheriting directly from
51 * TYPE_DEVICE should use @realize instead, new leaf types should consult
52 * their respective parent type.
53 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available
54 * as readonly "hotpluggable" property of #DeviceState instance
55 *
56 * # Realization #
57 * Devices are constructed in two stages,
58 * 1) object instantiation via object_initialize() and
59 * 2) device realization via #DeviceState:realized property.
60 * The former may not fail (it might assert or exit), the latter may return
61 * error information to the caller and must be re-entrant.
62 * Trivial field initializations should go into #TypeInfo.instance_init.
63 * Operations depending on @props static properties should go into @realize.
64 * After successful realization, setting static properties will fail.
65 *
66 * As an interim step, the #DeviceState:realized property can also be
67 * set with qdev_init_nofail().
68 * In the future, devices will propagate this state change to their children
69 * and along busses they expose.
70 * The point in time will be deferred to machine creation, so that values
71 * set in @realize will not be introspectable beforehand. Therefore devices
72 * must not create children during @realize; they should initialize them via
73 * object_initialize() in their own #TypeInfo.instance_init and forward the
74 * realization events appropriately.
75 *
76 * The @init callback is considered private to a particular bus implementation
77 * (immediate abstract child types of TYPE_DEVICE). Derived leaf types set an
78 * "init" callback on their parent class instead.
79 *
80 * Any type may override the @realize and/or @unrealize callbacks but needs
81 * to call the parent type's implementation if keeping their functionality
82 * is desired. Refer to QOM documentation for further discussion and examples.
83 *
84 * <note>
85 * <para>
86 * If a type derived directly from TYPE_DEVICE implements @realize, it does
87 * not need to implement @init and therefore does not need to store and call
88 * #DeviceClass' default @realize callback.
89 * For other types consult the documentation and implementation of the
90 * respective parent types.
91 * </para>
92 * </note>
93 */
94 typedef struct DeviceClass {
95 /*< private >*/
96 ObjectClass parent_class;
97 /*< public >*/
98
99 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
100 const char *fw_name;
101 const char *desc;
102 Property *props;
103
104 /*
105 * Shall we hide this device model from -device / device_add?
106 * All devices should support instantiation with device_add, and
107 * this flag should not exist. But we're not there, yet. Some
108 * devices fail to instantiate with cryptic error messages.
109 * Others instantiate, but don't work. Exposing users to such
110 * behavior would be cruel; this flag serves to protect them. It
111 * should never be set without a comment explaining why it is set.
112 * TODO remove once we're there
113 */
114 bool cannot_instantiate_with_device_add_yet;
115 /*
116 * Does this device model survive object_unref(object_new(TNAME))?
117 * All device models should, and this flag shouldn't exist. Some
118 * devices crash in object_new(), some crash or hang in
119 * object_unref(). Makes introspecting properties with
120 * qmp_device_list_properties() dangerous. Bad, because it's used
121 * by -device FOO,help. This flag serves to protect that code.
122 * It should never be set without a comment explaining why it is
123 * set.
124 * TODO remove once we're there
125 */
126 bool cannot_destroy_with_object_finalize_yet;
127
128 bool hotpluggable;
129
130 /* callbacks */
131 void (*reset)(DeviceState *dev);
132 DeviceRealize realize;
133 DeviceUnrealize unrealize;
134
135 /* device state */
136 const struct VMStateDescription *vmsd;
137
138 /* Private to qdev / bus. */
139 qdev_initfn init; /* TODO remove, once users are converted to realize */
140 qdev_event exit; /* TODO remove, once users are converted to unrealize */
141 const char *bus_type;
142 } DeviceClass;
143
144 typedef struct NamedGPIOList NamedGPIOList;
145
146 struct NamedGPIOList {
147 char *name;
148 qemu_irq *in;
149 int num_in;
150 int num_out;
151 QLIST_ENTRY(NamedGPIOList) node;
152 };
153
154 /**
155 * DeviceState:
156 * @realized: Indicates whether the device has been fully constructed.
157 *
158 * This structure should not be accessed directly. We declare it here
159 * so that it can be embedded in individual device state structures.
160 */
161 struct DeviceState {
162 /*< private >*/
163 Object parent_obj;
164 /*< public >*/
165
166 const char *id;
167 bool realized;
168 bool pending_deleted_event;
169 QemuOpts *opts;
170 int hotplugged;
171 BusState *parent_bus;
172 QLIST_HEAD(, NamedGPIOList) gpios;
173 QLIST_HEAD(, BusState) child_bus;
174 int num_child_bus;
175 int instance_id_alias;
176 int alias_required_for_version;
177 };
178
179 struct DeviceListener {
180 void (*realize)(DeviceListener *listener, DeviceState *dev);
181 void (*unrealize)(DeviceListener *listener, DeviceState *dev);
182 QTAILQ_ENTRY(DeviceListener) link;
183 };
184
185 #define TYPE_BUS "bus"
186 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
187 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
188 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
189
190 struct BusClass {
191 ObjectClass parent_class;
192
193 /* FIXME first arg should be BusState */
194 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
195 char *(*get_dev_path)(DeviceState *dev);
196 /*
197 * This callback is used to create Open Firmware device path in accordance
198 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
199 * bindings can be found at http://playground.sun.com/1275/bindings/.
200 */
201 char *(*get_fw_dev_path)(DeviceState *dev);
202 void (*reset)(BusState *bus);
203 BusRealize realize;
204 BusUnrealize unrealize;
205
206 /* maximum devices allowed on the bus, 0: no limit. */
207 int max_dev;
208 /* number of automatically allocated bus ids (e.g. ide.0) */
209 int automatic_ids;
210 };
211
212 typedef struct BusChild {
213 DeviceState *child;
214 int index;
215 QTAILQ_ENTRY(BusChild) sibling;
216 } BusChild;
217
218 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
219
220 /**
221 * BusState:
222 * @hotplug_device: link to a hotplug device associated with bus.
223 */
224 struct BusState {
225 Object obj;
226 DeviceState *parent;
227 const char *name;
228 HotplugHandler *hotplug_handler;
229 int max_index;
230 bool realized;
231 QTAILQ_HEAD(ChildrenHead, BusChild) children;
232 QLIST_ENTRY(BusState) sibling;
233 };
234
235 struct Property {
236 const char *name;
237 PropertyInfo *info;
238 ptrdiff_t offset;
239 uint8_t bitnr;
240 QType qtype;
241 int64_t defval;
242 int arrayoffset;
243 PropertyInfo *arrayinfo;
244 int arrayfieldsize;
245 };
246
247 struct PropertyInfo {
248 const char *name;
249 const char *description;
250 const char * const *enum_table;
251 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
252 ObjectPropertyAccessor *get;
253 ObjectPropertyAccessor *set;
254 ObjectPropertyRelease *release;
255 };
256
257 /**
258 * GlobalProperty:
259 * @user_provided: Set to true if property comes from user-provided config
260 * (command-line or config file).
261 * @used: Set to true if property was used when initializing a device.
262 */
263 typedef struct GlobalProperty {
264 const char *driver;
265 const char *property;
266 const char *value;
267 bool user_provided;
268 bool used;
269 QTAILQ_ENTRY(GlobalProperty) next;
270 } GlobalProperty;
271
272 /*** Board API. This should go away once we have a machine config file. ***/
273
274 DeviceState *qdev_create(BusState *bus, const char *name);
275 DeviceState *qdev_try_create(BusState *bus, const char *name);
276 void qdev_init_nofail(DeviceState *dev);
277 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
278 int required_for_version);
279 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
280 void qdev_unplug(DeviceState *dev, Error **errp);
281 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
282 DeviceState *dev, Error **errp);
283 void qdev_machine_creation_done(void);
284 bool qdev_machine_modified(void);
285
286 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
287 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
288
289 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
290 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
291 qemu_irq pin);
292 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
293 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
294 const char *name, int n);
295
296 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
297
298 /*** Device API. ***/
299
300 /* Register device properties. */
301 /* GPIO inputs also double as IRQ sinks. */
302 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
303 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
304 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
305 const char *name, int n);
306 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
307 const char *name, int n);
308
309 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
310 const char *name);
311
312 BusState *qdev_get_parent_bus(DeviceState *dev);
313
314 /*** BUS API. ***/
315
316 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
317
318 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
319 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
320 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
321
322 void qbus_create_inplace(void *bus, size_t size, const char *typename,
323 DeviceState *parent, const char *name);
324 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
325 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
326 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
327 * 0 otherwise. */
328 int qbus_walk_children(BusState *bus,
329 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
330 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
331 void *opaque);
332 int qdev_walk_children(DeviceState *dev,
333 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
334 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
335 void *opaque);
336
337 void qdev_reset_all(DeviceState *dev);
338 void qdev_reset_all_fn(void *opaque);
339
340 /**
341 * @qbus_reset_all:
342 * @bus: Bus to be reset.
343 *
344 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
345 * to it, including recursive processing of all buses below @bus itself. A
346 * hard reset means that qbus_reset_all will reset all state of the device.
347 * For PCI devices, for example, this will include the base address registers
348 * or configuration space.
349 */
350 void qbus_reset_all(BusState *bus);
351 void qbus_reset_all_fn(void *opaque);
352
353 /* This should go away once we get rid of the NULL bus hack */
354 BusState *sysbus_get_default(void);
355
356 char *qdev_get_fw_dev_path(DeviceState *dev);
357 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
358
359 /**
360 * @qdev_machine_init
361 *
362 * Initialize platform devices before machine init. This is a hack until full
363 * support for composition is added.
364 */
365 void qdev_machine_init(void);
366
367 /**
368 * @device_reset
369 *
370 * Reset a single device (by calling the reset method).
371 */
372 void device_reset(DeviceState *dev);
373
374 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
375
376 const char *qdev_fw_name(DeviceState *dev);
377
378 Object *qdev_get_machine(void);
379
380 /* FIXME: make this a link<> */
381 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
382
383 extern int qdev_hotplug;
384
385 char *qdev_get_dev_path(DeviceState *dev);
386
387 GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
388
389 void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
390 Error **errp);
391
392 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
393
394 static inline bool qbus_is_hotpluggable(BusState *bus)
395 {
396 return bus->hotplug_handler;
397 }
398
399 void device_listener_register(DeviceListener *listener);
400 void device_listener_unregister(DeviceListener *listener);
401
402 #endif