numa: add -numa node,memdev= option
[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/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"
12
13 enum {
14 DEV_NVECTORS_UNSPECIFIED = -1,
15 };
16
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)
21
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;
33
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);
41
42 struct VMStateDescription;
43
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
57 *
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.
67 *
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.
77 *
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.
81 *
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.
85 *
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>
95 */
96 typedef struct DeviceClass {
97 /*< private >*/
98 ObjectClass parent_class;
99 /*< public >*/
100
101 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX);
102 const char *fw_name;
103 const char *desc;
104 Property *props;
105
106 /*
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
115 */
116 bool cannot_instantiate_with_device_add_yet;
117 bool hotpluggable;
118
119 /* callbacks */
120 void (*reset)(DeviceState *dev);
121 DeviceRealize realize;
122 DeviceUnrealize unrealize;
123
124 /* device state */
125 const struct VMStateDescription *vmsd;
126
127 /* Private to qdev / bus. */
128 qdev_initfn init; /* TODO remove, once users are converted to realize */
129 qdev_event unplug;
130 qdev_event exit; /* TODO remove, once users are converted to unrealize */
131 const char *bus_type;
132 } DeviceClass;
133
134 typedef struct NamedGPIOList NamedGPIOList;
135
136 struct NamedGPIOList {
137 char *name;
138 qemu_irq *in;
139 int num_in;
140 qemu_irq *out;
141 int num_out;
142 QLIST_ENTRY(NamedGPIOList) node;
143 };
144
145 /**
146 * DeviceState:
147 * @realized: Indicates whether the device has been fully constructed.
148 *
149 * This structure should not be accessed directly. We declare it here
150 * so that it can be embedded in individual device state structures.
151 */
152 struct DeviceState {
153 /*< private >*/
154 Object parent_obj;
155 /*< public >*/
156
157 const char *id;
158 bool realized;
159 QemuOpts *opts;
160 int hotplugged;
161 BusState *parent_bus;
162 QLIST_HEAD(, NamedGPIOList) gpios;
163 QLIST_HEAD(, BusState) child_bus;
164 int num_child_bus;
165 int instance_id_alias;
166 int alias_required_for_version;
167 };
168
169 #define TYPE_BUS "bus"
170 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
171 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
172 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
173
174 struct BusClass {
175 ObjectClass parent_class;
176
177 /* FIXME first arg should be BusState */
178 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
179 char *(*get_dev_path)(DeviceState *dev);
180 /*
181 * This callback is used to create Open Firmware device path in accordance
182 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
183 * bindings can be found at http://playground.sun.com/1275/bindings/.
184 */
185 char *(*get_fw_dev_path)(DeviceState *dev);
186 void (*reset)(BusState *bus);
187 BusRealize realize;
188 BusUnrealize unrealize;
189
190 /* maximum devices allowed on the bus, 0: no limit. */
191 int max_dev;
192 /* number of automatically allocated bus ids (e.g. ide.0) */
193 int automatic_ids;
194 };
195
196 typedef struct BusChild {
197 DeviceState *child;
198 int index;
199 QTAILQ_ENTRY(BusChild) sibling;
200 } BusChild;
201
202 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
203
204 /**
205 * BusState:
206 * @hotplug_device: link to a hotplug device associated with bus.
207 */
208 struct BusState {
209 Object obj;
210 DeviceState *parent;
211 const char *name;
212 int allow_hotplug;
213 HotplugHandler *hotplug_handler;
214 int max_index;
215 bool realized;
216 QTAILQ_HEAD(ChildrenHead, BusChild) children;
217 QLIST_ENTRY(BusState) sibling;
218 };
219
220 struct Property {
221 const char *name;
222 PropertyInfo *info;
223 int offset;
224 uint8_t bitnr;
225 uint8_t qtype;
226 int64_t defval;
227 int arrayoffset;
228 PropertyInfo *arrayinfo;
229 int arrayfieldsize;
230 };
231
232 struct PropertyInfo {
233 const char *name;
234 const char *legacy_name;
235 const char **enum_table;
236 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
237 ObjectPropertyAccessor *get;
238 ObjectPropertyAccessor *set;
239 ObjectPropertyRelease *release;
240 };
241
242 /**
243 * GlobalProperty:
244 * @not_used: Track use of a global property. Defaults to false in all C99
245 * struct initializations.
246 *
247 * This prevents reports of .compat_props when they are not used.
248 */
249 typedef struct GlobalProperty {
250 const char *driver;
251 const char *property;
252 const char *value;
253 bool not_used;
254 QTAILQ_ENTRY(GlobalProperty) next;
255 } GlobalProperty;
256
257 /*** Board API. This should go away once we have a machine config file. ***/
258
259 DeviceState *qdev_create(BusState *bus, const char *name);
260 DeviceState *qdev_try_create(BusState *bus, const char *name);
261 int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
262 void qdev_init_nofail(DeviceState *dev);
263 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
264 int required_for_version);
265 void qdev_unplug(DeviceState *dev, Error **errp);
266 int qdev_simple_unplug_cb(DeviceState *dev);
267 void qdev_machine_creation_done(void);
268 bool qdev_machine_modified(void);
269
270 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
271 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
272
273 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
274 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
275 qemu_irq pin);
276
277 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
278
279 /*** Device API. ***/
280
281 /* Register device properties. */
282 /* GPIO inputs also double as IRQ sinks. */
283 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
284 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
285 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
286 const char *name, int n);
287 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
288 const char *name, int n);
289
290 BusState *qdev_get_parent_bus(DeviceState *dev);
291
292 /*** BUS API. ***/
293
294 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
295
296 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
297 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
298 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
299
300 void qbus_create_inplace(void *bus, size_t size, const char *typename,
301 DeviceState *parent, const char *name);
302 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
303 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
304 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
305 * 0 otherwise. */
306 int qbus_walk_children(BusState *bus,
307 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
308 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
309 void *opaque);
310 int qdev_walk_children(DeviceState *dev,
311 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
312 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
313 void *opaque);
314
315 void qdev_reset_all(DeviceState *dev);
316
317 /**
318 * @qbus_reset_all:
319 * @bus: Bus to be reset.
320 *
321 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
322 * to it, including recursive processing of all buses below @bus itself. A
323 * hard reset means that qbus_reset_all will reset all state of the device.
324 * For PCI devices, for example, this will include the base address registers
325 * or configuration space.
326 */
327 void qbus_reset_all(BusState *bus);
328 void qbus_reset_all_fn(void *opaque);
329
330 /* This should go away once we get rid of the NULL bus hack */
331 BusState *sysbus_get_default(void);
332
333 char *qdev_get_fw_dev_path(DeviceState *dev);
334
335 /**
336 * @qdev_machine_init
337 *
338 * Initialize platform devices before machine init. This is a hack until full
339 * support for composition is added.
340 */
341 void qdev_machine_init(void);
342
343 /**
344 * @device_reset
345 *
346 * Reset a single device (by calling the reset method).
347 */
348 void device_reset(DeviceState *dev);
349
350 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
351
352 const char *qdev_fw_name(DeviceState *dev);
353
354 Object *qdev_get_machine(void);
355
356 /* FIXME: make this a link<> */
357 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
358
359 extern int qdev_hotplug;
360
361 char *qdev_get_dev_path(DeviceState *dev);
362
363 static inline void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
364 Error **errp)
365 {
366 object_property_set_link(OBJECT(bus), OBJECT(handler),
367 QDEV_HOTPLUG_HANDLER_PROPERTY, errp);
368 bus->allow_hotplug = 1;
369 }
370 #endif