hw: Add support for LSI SAS1068 (mptsas) device
[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 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.
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 /*
118 * Does this device model survive object_unref(object_new(TNAME))?
119 * All device models should, and this flag shouldn't exist. Some
120 * devices crash in object_new(), some crash or hang in
121 * object_unref(). Makes introspecting properties with
122 * qmp_device_list_properties() dangerous. Bad, because it's used
123 * by -device FOO,help. This flag serves to protect that code.
124 * It should never be set without a comment explaining why it is
125 * set.
126 * TODO remove once we're there
127 */
128 bool cannot_destroy_with_object_finalize_yet;
129
130 bool hotpluggable;
131
132 /* callbacks */
133 void (*reset)(DeviceState *dev);
134 DeviceRealize realize;
135 DeviceUnrealize unrealize;
136
137 /* device state */
138 const struct VMStateDescription *vmsd;
139
140 /* Private to qdev / bus. */
141 qdev_initfn init; /* TODO remove, once users are converted to realize */
142 qdev_event exit; /* TODO remove, once users are converted to unrealize */
143 const char *bus_type;
144 } DeviceClass;
145
146 typedef struct NamedGPIOList NamedGPIOList;
147
148 struct NamedGPIOList {
149 char *name;
150 qemu_irq *in;
151 int num_in;
152 int num_out;
153 QLIST_ENTRY(NamedGPIOList) node;
154 };
155
156 /**
157 * DeviceState:
158 * @realized: Indicates whether the device has been fully constructed.
159 *
160 * This structure should not be accessed directly. We declare it here
161 * so that it can be embedded in individual device state structures.
162 */
163 struct DeviceState {
164 /*< private >*/
165 Object parent_obj;
166 /*< public >*/
167
168 const char *id;
169 bool realized;
170 bool pending_deleted_event;
171 QemuOpts *opts;
172 int hotplugged;
173 BusState *parent_bus;
174 QLIST_HEAD(, NamedGPIOList) gpios;
175 QLIST_HEAD(, BusState) child_bus;
176 int num_child_bus;
177 int instance_id_alias;
178 int alias_required_for_version;
179 };
180
181 struct DeviceListener {
182 void (*realize)(DeviceListener *listener, DeviceState *dev);
183 void (*unrealize)(DeviceListener *listener, DeviceState *dev);
184 QTAILQ_ENTRY(DeviceListener) link;
185 };
186
187 #define TYPE_BUS "bus"
188 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
189 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
190 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
191
192 struct BusClass {
193 ObjectClass parent_class;
194
195 /* FIXME first arg should be BusState */
196 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
197 char *(*get_dev_path)(DeviceState *dev);
198 /*
199 * This callback is used to create Open Firmware device path in accordance
200 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus
201 * bindings can be found at http://playground.sun.com/1275/bindings/.
202 */
203 char *(*get_fw_dev_path)(DeviceState *dev);
204 void (*reset)(BusState *bus);
205 BusRealize realize;
206 BusUnrealize unrealize;
207
208 /* maximum devices allowed on the bus, 0: no limit. */
209 int max_dev;
210 /* number of automatically allocated bus ids (e.g. ide.0) */
211 int automatic_ids;
212 };
213
214 typedef struct BusChild {
215 DeviceState *child;
216 int index;
217 QTAILQ_ENTRY(BusChild) sibling;
218 } BusChild;
219
220 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler"
221
222 /**
223 * BusState:
224 * @hotplug_device: link to a hotplug device associated with bus.
225 */
226 struct BusState {
227 Object obj;
228 DeviceState *parent;
229 const char *name;
230 HotplugHandler *hotplug_handler;
231 int max_index;
232 bool realized;
233 QTAILQ_HEAD(ChildrenHead, BusChild) children;
234 QLIST_ENTRY(BusState) sibling;
235 };
236
237 struct Property {
238 const char *name;
239 PropertyInfo *info;
240 ptrdiff_t offset;
241 uint8_t bitnr;
242 QType qtype;
243 int64_t defval;
244 int arrayoffset;
245 PropertyInfo *arrayinfo;
246 int arrayfieldsize;
247 };
248
249 struct PropertyInfo {
250 const char *name;
251 const char *description;
252 const char * const *enum_table;
253 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
254 ObjectPropertyAccessor *get;
255 ObjectPropertyAccessor *set;
256 ObjectPropertyRelease *release;
257 };
258
259 /**
260 * GlobalProperty:
261 * @user_provided: Set to true if property comes from user-provided config
262 * (command-line or config file).
263 * @used: Set to true if property was used when initializing a device.
264 */
265 typedef struct GlobalProperty {
266 const char *driver;
267 const char *property;
268 const char *value;
269 bool user_provided;
270 bool used;
271 QTAILQ_ENTRY(GlobalProperty) next;
272 } GlobalProperty;
273
274 /*** Board API. This should go away once we have a machine config file. ***/
275
276 DeviceState *qdev_create(BusState *bus, const char *name);
277 DeviceState *qdev_try_create(BusState *bus, const char *name);
278 void qdev_init_nofail(DeviceState *dev);
279 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
280 int required_for_version);
281 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev);
282 void qdev_unplug(DeviceState *dev, Error **errp);
283 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev,
284 DeviceState *dev, Error **errp);
285 void qdev_machine_creation_done(void);
286 bool qdev_machine_modified(void);
287
288 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
289 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n);
290
291 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
292 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n,
293 qemu_irq pin);
294 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n);
295 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt,
296 const char *name, int n);
297
298 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
299
300 /*** Device API. ***/
301
302 /* Register device properties. */
303 /* GPIO inputs also double as IRQ sinks. */
304 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
305 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
306 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler,
307 const char *name, int n);
308 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins,
309 const char *name, int n);
310
311 void qdev_pass_gpios(DeviceState *dev, DeviceState *container,
312 const char *name);
313
314 BusState *qdev_get_parent_bus(DeviceState *dev);
315
316 /*** BUS API. ***/
317
318 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
319
320 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
321 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
322 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
323
324 void qbus_create_inplace(void *bus, size_t size, const char *typename,
325 DeviceState *parent, const char *name);
326 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
327 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
328 * < 0 if either devfn or busfn terminate walk somewhere in cursion,
329 * 0 otherwise. */
330 int qbus_walk_children(BusState *bus,
331 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
332 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
333 void *opaque);
334 int qdev_walk_children(DeviceState *dev,
335 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn,
336 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn,
337 void *opaque);
338
339 void qdev_reset_all(DeviceState *dev);
340 void qdev_reset_all_fn(void *opaque);
341
342 /**
343 * @qbus_reset_all:
344 * @bus: Bus to be reset.
345 *
346 * Reset @bus and perform a bus-level ("hard") reset of all devices connected
347 * to it, including recursive processing of all buses below @bus itself. A
348 * hard reset means that qbus_reset_all will reset all state of the device.
349 * For PCI devices, for example, this will include the base address registers
350 * or configuration space.
351 */
352 void qbus_reset_all(BusState *bus);
353 void qbus_reset_all_fn(void *opaque);
354
355 /* This should go away once we get rid of the NULL bus hack */
356 BusState *sysbus_get_default(void);
357
358 char *qdev_get_fw_dev_path(DeviceState *dev);
359 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev);
360
361 /**
362 * @qdev_machine_init
363 *
364 * Initialize platform devices before machine init. This is a hack until full
365 * support for composition is added.
366 */
367 void qdev_machine_init(void);
368
369 /**
370 * @device_reset
371 *
372 * Reset a single device (by calling the reset method).
373 */
374 void device_reset(DeviceState *dev);
375
376 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev);
377
378 const char *qdev_fw_name(DeviceState *dev);
379
380 Object *qdev_get_machine(void);
381
382 /* FIXME: make this a link<> */
383 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
384
385 extern int qdev_hotplug;
386
387 char *qdev_get_dev_path(DeviceState *dev);
388
389 GSList *qdev_build_hotpluggable_device_list(Object *peripheral);
390
391 void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler,
392 Error **errp);
393
394 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp);
395
396 static inline bool qbus_is_hotpluggable(BusState *bus)
397 {
398 return bus->hotplug_handler;
399 }
400
401 void device_listener_register(DeviceListener *listener);
402 void device_listener_unregister(DeviceListener *listener);
403
404 #endif