]>
Commit | Line | Data |
---|---|---|
074a86fc AL |
1 | #ifndef QDEV_CORE_H |
2 | #define QDEV_CORE_H | |
3 | ||
1de7afc9 | 4 | #include "qemu/queue.h" |
949fc823 | 5 | #include "qemu/bitmap.h" |
2d24a646 ML |
6 | #include "qemu/rcu.h" |
7 | #include "qemu/rcu_queue.h" | |
14cccb61 | 8 | #include "qom/object.h" |
0ee4de6c | 9 | #include "hw/hotplug.h" |
c11256aa | 10 | #include "hw/resettable.h" |
074a86fc | 11 | |
074a86fc AL |
12 | enum { |
13 | DEV_NVECTORS_UNSPECIFIED = -1, | |
14 | }; | |
15 | ||
16 | #define TYPE_DEVICE "device" | |
a489d195 | 17 | OBJECT_DECLARE_TYPE(DeviceState, DeviceClass, DEVICE) |
074a86fc | 18 | |
3d1237fb MA |
19 | typedef enum DeviceCategory { |
20 | DEVICE_CATEGORY_BRIDGE, | |
21 | DEVICE_CATEGORY_USB, | |
22 | DEVICE_CATEGORY_STORAGE, | |
23 | DEVICE_CATEGORY_NETWORK, | |
24 | DEVICE_CATEGORY_INPUT, | |
25 | DEVICE_CATEGORY_DISPLAY, | |
26 | DEVICE_CATEGORY_SOUND, | |
27 | DEVICE_CATEGORY_MISC, | |
ba31cc72 | 28 | DEVICE_CATEGORY_CPU, |
3d1237fb MA |
29 | DEVICE_CATEGORY_MAX |
30 | } DeviceCategory; | |
31 | ||
249d4172 | 32 | typedef void (*DeviceRealize)(DeviceState *dev, Error **errp); |
b69c3c21 | 33 | typedef void (*DeviceUnrealize)(DeviceState *dev); |
b850f664 | 34 | typedef void (*DeviceReset)(DeviceState *dev); |
02e7f85d | 35 | typedef void (*BusRealize)(BusState *bus, Error **errp); |
b69c3c21 | 36 | typedef void (*BusUnrealize)(BusState *bus); |
074a86fc | 37 | |
249d4172 AF |
38 | /** |
39 | * DeviceClass: | |
40 | * @props: Properties accessing state fields. | |
41 | * @realize: Callback function invoked when the #DeviceState:realized | |
ff46d9d4 | 42 | * property is changed to %true. |
249d4172 AF |
43 | * @unrealize: Callback function invoked when the #DeviceState:realized |
44 | * property is changed to %false. | |
1a37eca1 IM |
45 | * @hotpluggable: indicates if #DeviceClass is hotpluggable, available |
46 | * as readonly "hotpluggable" property of #DeviceState instance | |
249d4172 AF |
47 | * |
48 | * # Realization # | |
49 | * Devices are constructed in two stages, | |
50 | * 1) object instantiation via object_initialize() and | |
51 | * 2) device realization via #DeviceState:realized property. | |
6038f989 TH |
52 | * The former may not fail (and must not abort or exit, since it is called |
53 | * during device introspection already), and the latter may return error | |
54 | * information to the caller and must be re-entrant. | |
249d4172 AF |
55 | * Trivial field initializations should go into #TypeInfo.instance_init. |
56 | * Operations depending on @props static properties should go into @realize. | |
57 | * After successful realization, setting static properties will fail. | |
58 | * | |
daeba969 | 59 | * As an interim step, the #DeviceState:realized property can also be |
c835fac3 | 60 | * set with qdev_realize(). |
249d4172 AF |
61 | * In the future, devices will propagate this state change to their children |
62 | * and along busses they expose. | |
63 | * The point in time will be deferred to machine creation, so that values | |
64 | * set in @realize will not be introspectable beforehand. Therefore devices | |
65 | * must not create children during @realize; they should initialize them via | |
66 | * object_initialize() in their own #TypeInfo.instance_init and forward the | |
67 | * realization events appropriately. | |
68 | * | |
249d4172 | 69 | * Any type may override the @realize and/or @unrealize callbacks but needs |
782beb52 AF |
70 | * to call the parent type's implementation if keeping their functionality |
71 | * is desired. Refer to QOM documentation for further discussion and examples. | |
72 | * | |
73 | * <note> | |
74 | * <para> | |
ff46d9d4 PMD |
75 | * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types |
76 | * derived directly from it need not call their parent's @realize and | |
77 | * @unrealize. | |
782beb52 AF |
78 | * For other types consult the documentation and implementation of the |
79 | * respective parent types. | |
80 | * </para> | |
81 | * </note> | |
f3a85056 JF |
82 | * |
83 | * # Hiding a device # | |
b91ad981 | 84 | * To hide a device, a DeviceListener function hide_device() needs to |
f3a85056 | 85 | * be registered. |
b91ad981 JQ |
86 | * It can be used to defer adding a device and therefore hide it from |
87 | * the guest. The handler registering to this DeviceListener can save | |
88 | * the QOpts passed to it for re-using it later. It must return if it | |
89 | * wants the device to be hidden or visible. When the handler function | |
90 | * decides the device shall be visible it will be added with | |
91 | * qdev_device_add() and realized as any other device. Otherwise | |
92 | * qdev_device_add() will return early without adding the device. The | |
93 | * guest will not see a "hidden" device until it was marked visible | |
94 | * and qdev_device_add called again. | |
f3a85056 | 95 | * |
249d4172 | 96 | */ |
db1015e9 | 97 | struct DeviceClass { |
249d4172 | 98 | /*< private >*/ |
074a86fc | 99 | ObjectClass parent_class; |
249d4172 | 100 | /*< public >*/ |
074a86fc | 101 | |
3d1237fb | 102 | DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX); |
074a86fc AL |
103 | const char *fw_name; |
104 | const char *desc; | |
385d8f22 PB |
105 | |
106 | /* | |
107 | * The underscore at the end ensures a compile-time error if someone | |
108 | * assigns to dc->props instead of using device_class_set_props. | |
109 | */ | |
110 | Property *props_; | |
efec3dd6 MA |
111 | |
112 | /* | |
e90f2a8c | 113 | * Can this device be instantiated with -device / device_add? |
efec3dd6 MA |
114 | * All devices should support instantiation with device_add, and |
115 | * this flag should not exist. But we're not there, yet. Some | |
116 | * devices fail to instantiate with cryptic error messages. | |
117 | * Others instantiate, but don't work. Exposing users to such | |
e90f2a8c EH |
118 | * behavior would be cruel; clearing this flag will protect them. |
119 | * It should never be cleared without a comment explaining why it | |
120 | * is cleared. | |
efec3dd6 MA |
121 | * TODO remove once we're there |
122 | */ | |
e90f2a8c | 123 | bool user_creatable; |
1a37eca1 | 124 | bool hotpluggable; |
074a86fc AL |
125 | |
126 | /* callbacks */ | |
c11256aa DH |
127 | /* |
128 | * Reset method here is deprecated and replaced by methods in the | |
129 | * resettable class interface to implement a multi-phase reset. | |
130 | * TODO: remove once every reset callback is unused | |
131 | */ | |
b850f664 | 132 | DeviceReset reset; |
249d4172 AF |
133 | DeviceRealize realize; |
134 | DeviceUnrealize unrealize; | |
074a86fc AL |
135 | |
136 | /* device state */ | |
8a9358cc | 137 | const VMStateDescription *vmsd; |
074a86fc AL |
138 | |
139 | /* Private to qdev / bus. */ | |
074a86fc | 140 | const char *bus_type; |
db1015e9 | 141 | }; |
074a86fc | 142 | |
a5f54290 PC |
143 | typedef struct NamedGPIOList NamedGPIOList; |
144 | ||
145 | struct NamedGPIOList { | |
146 | char *name; | |
147 | qemu_irq *in; | |
148 | int num_in; | |
a5f54290 PC |
149 | int num_out; |
150 | QLIST_ENTRY(NamedGPIOList) node; | |
151 | }; | |
152 | ||
0e6934f2 DH |
153 | typedef struct Clock Clock; |
154 | typedef struct NamedClockList NamedClockList; | |
155 | ||
156 | struct NamedClockList { | |
157 | char *name; | |
158 | Clock *clock; | |
159 | bool output; | |
160 | bool alias; | |
161 | QLIST_ENTRY(NamedClockList) node; | |
162 | }; | |
163 | ||
7983c8a3 AF |
164 | /** |
165 | * DeviceState: | |
166 | * @realized: Indicates whether the device has been fully constructed. | |
5dae6fad ML |
167 | * When accessed outside big qemu lock, must be accessed with |
168 | * qatomic_load_acquire() | |
c11256aa | 169 | * @reset: ResettableState for the device; handled by Resettable interface. |
7983c8a3 AF |
170 | * |
171 | * This structure should not be accessed directly. We declare it here | |
172 | * so that it can be embedded in individual device state structures. | |
173 | */ | |
074a86fc | 174 | struct DeviceState { |
7983c8a3 | 175 | /*< private >*/ |
074a86fc | 176 | Object parent_obj; |
7983c8a3 | 177 | /*< public >*/ |
074a86fc AL |
178 | |
179 | const char *id; | |
04162f8f | 180 | char *canonical_path; |
7983c8a3 | 181 | bool realized; |
352e8da7 | 182 | bool pending_deleted_event; |
074a86fc AL |
183 | QemuOpts *opts; |
184 | int hotplugged; | |
a1190ab6 | 185 | bool allow_unplug_during_migration; |
074a86fc | 186 | BusState *parent_bus; |
a5f54290 | 187 | QLIST_HEAD(, NamedGPIOList) gpios; |
0e6934f2 | 188 | QLIST_HEAD(, NamedClockList) clocks; |
074a86fc AL |
189 | QLIST_HEAD(, BusState) child_bus; |
190 | int num_child_bus; | |
191 | int instance_id_alias; | |
192 | int alias_required_for_version; | |
c11256aa | 193 | ResettableState reset; |
074a86fc AL |
194 | }; |
195 | ||
707ff800 PD |
196 | struct DeviceListener { |
197 | void (*realize)(DeviceListener *listener, DeviceState *dev); | |
198 | void (*unrealize)(DeviceListener *listener, DeviceState *dev); | |
f3a85056 | 199 | /* |
b91ad981 JQ |
200 | * This callback is called upon init of the DeviceState and |
201 | * informs qdev if a device should be visible or hidden. We can | |
202 | * hide a failover device depending for example on the device | |
203 | * opts. | |
f3a85056 | 204 | */ |
b91ad981 | 205 | bool (*hide_device)(DeviceListener *listener, QemuOpts *device_opts); |
707ff800 PD |
206 | QTAILQ_ENTRY(DeviceListener) link; |
207 | }; | |
208 | ||
074a86fc | 209 | #define TYPE_BUS "bus" |
8110fa1d EH |
210 | DECLARE_OBJ_CHECKERS(BusState, BusClass, |
211 | BUS, TYPE_BUS) | |
074a86fc AL |
212 | |
213 | struct BusClass { | |
214 | ObjectClass parent_class; | |
215 | ||
216 | /* FIXME first arg should be BusState */ | |
217 | void (*print_dev)(Monitor *mon, DeviceState *dev, int indent); | |
218 | char *(*get_dev_path)(DeviceState *dev); | |
bb755ba4 | 219 | |
074a86fc AL |
220 | /* |
221 | * This callback is used to create Open Firmware device path in accordance | |
222 | * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus | |
223 | * bindings can be found at http://playground.sun.com/1275/bindings/. | |
224 | */ | |
225 | char *(*get_fw_dev_path)(DeviceState *dev); | |
bb755ba4 | 226 | |
dcc20931 | 227 | void (*reset)(BusState *bus); |
bb755ba4 PB |
228 | |
229 | /* | |
230 | * Return whether the device can be added to @bus, | |
231 | * based on the address that was set (via device properties) | |
232 | * before realize. If not, on return @errp contains the | |
233 | * human-readable error message. | |
234 | */ | |
235 | bool (*check_address)(BusState *bus, DeviceState *dev, Error **errp); | |
236 | ||
02e7f85d BD |
237 | BusRealize realize; |
238 | BusUnrealize unrealize; | |
239 | ||
1395af6f FK |
240 | /* maximum devices allowed on the bus, 0: no limit. */ |
241 | int max_dev; | |
61de3676 AG |
242 | /* number of automatically allocated bus ids (e.g. ide.0) */ |
243 | int automatic_ids; | |
074a86fc AL |
244 | }; |
245 | ||
246 | typedef struct BusChild { | |
2d24a646 | 247 | struct rcu_head rcu; |
074a86fc AL |
248 | DeviceState *child; |
249 | int index; | |
250 | QTAILQ_ENTRY(BusChild) sibling; | |
251 | } BusChild; | |
252 | ||
0ee4de6c IM |
253 | #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler" |
254 | ||
074a86fc AL |
255 | /** |
256 | * BusState: | |
27c6ef1b | 257 | * @hotplug_handler: link to a hotplug handler associated with bus. |
c11256aa | 258 | * @reset: ResettableState for the bus; handled by Resettable interface. |
074a86fc AL |
259 | */ |
260 | struct BusState { | |
261 | Object obj; | |
262 | DeviceState *parent; | |
f73480c3 | 263 | char *name; |
0ee4de6c | 264 | HotplugHandler *hotplug_handler; |
074a86fc | 265 | int max_index; |
02e7f85d | 266 | bool realized; |
1518562b | 267 | bool full; |
12b2e9f3 | 268 | int num_children; |
2d24a646 ML |
269 | |
270 | /* | |
271 | * children is a RCU QTAILQ, thus readers must use RCU to access it, | |
272 | * and writers must hold the big qemu lock | |
273 | */ | |
274 | ||
eae3eb3e | 275 | QTAILQ_HEAD(, BusChild) children; |
074a86fc | 276 | QLIST_ENTRY(BusState) sibling; |
c11256aa | 277 | ResettableState reset; |
074a86fc AL |
278 | }; |
279 | ||
9f9260a3 DS |
280 | /** |
281 | * GlobalProperty: | |
b3ce84fe | 282 | * @used: Set to true if property was used when initializing a device. |
92fd453c DDAG |
283 | * @optional: If set to true, GlobalProperty will be skipped without errors |
284 | * if the property doesn't exist. | |
cff8b715 MAL |
285 | * |
286 | * An error is fatal for non-hotplugged devices, when the global is applied. | |
9f9260a3 | 287 | */ |
074a86fc AL |
288 | typedef struct GlobalProperty { |
289 | const char *driver; | |
290 | const char *property; | |
291 | const char *value; | |
b3ce84fe | 292 | bool used; |
92fd453c | 293 | bool optional; |
074a86fc AL |
294 | } GlobalProperty; |
295 | ||
ea9ce893 MAL |
296 | static inline void |
297 | compat_props_add(GPtrArray *arr, | |
298 | GlobalProperty props[], size_t nelem) | |
299 | { | |
300 | int i; | |
301 | for (i = 0; i < nelem; i++) { | |
302 | g_ptr_array_add(arr, (void *)&props[i]); | |
303 | } | |
304 | } | |
305 | ||
074a86fc AL |
306 | /*** Board API. This should go away once we have a machine config file. ***/ |
307 | ||
b51238e2 PM |
308 | /** |
309 | * qdev_new: Create a device on the heap | |
310 | * @name: device type to create (we assert() that this type exists) | |
311 | * | |
312 | * This only allocates the memory and initializes the device state | |
313 | * structure, ready for the caller to set properties if they wish. | |
314 | * The device still needs to be realized. | |
315 | * The returned object has a reference count of 1. | |
316 | */ | |
9940b2cf | 317 | DeviceState *qdev_new(const char *name); |
b51238e2 PM |
318 | /** |
319 | * qdev_try_new: Try to create a device on the heap | |
320 | * @name: device type to create | |
321 | * | |
322 | * This is like qdev_new(), except it returns %NULL when type @name | |
323 | * does not exist, rather than asserting. | |
324 | */ | |
9940b2cf | 325 | DeviceState *qdev_try_new(const char *name); |
b51238e2 PM |
326 | /** |
327 | * qdev_realize: Realize @dev. | |
328 | * @dev: device to realize | |
329 | * @bus: bus to plug it into (may be NULL) | |
330 | * @errp: pointer to error object | |
331 | * | |
332 | * "Realize" the device, i.e. perform the second phase of device | |
333 | * initialization. | |
334 | * @dev must not be plugged into a bus already. | |
335 | * If @bus, plug @dev into @bus. This takes a reference to @dev. | |
336 | * If @dev has no QOM parent, make one up, taking another reference. | |
337 | * On success, return true. | |
338 | * On failure, store an error through @errp and return false. | |
339 | * | |
340 | * If you created @dev using qdev_new(), you probably want to use | |
341 | * qdev_realize_and_unref() instead. | |
342 | */ | |
9940b2cf | 343 | bool qdev_realize(DeviceState *dev, BusState *bus, Error **errp); |
b51238e2 PM |
344 | /** |
345 | * qdev_realize_and_unref: Realize @dev and drop a reference | |
346 | * @dev: device to realize | |
347 | * @bus: bus to plug it into (may be NULL) | |
348 | * @errp: pointer to error object | |
349 | * | |
350 | * Realize @dev and drop a reference. | |
351 | * This is like qdev_realize(), except the caller must hold a | |
352 | * (private) reference, which is dropped on return regardless of | |
353 | * success or failure. Intended use:: | |
354 | * | |
355 | * dev = qdev_new(); | |
356 | * [...] | |
357 | * qdev_realize_and_unref(dev, bus, errp); | |
358 | * | |
359 | * Now @dev can go away without further ado. | |
360 | * | |
361 | * If you are embedding the device into some other QOM device and | |
362 | * initialized it via some variant on object_initialize_child() then | |
363 | * do not use this function, because that family of functions arrange | |
364 | * for the only reference to the child device to be held by the parent | |
365 | * via the child<> property, and so the reference-count-drop done here | |
366 | * would be incorrect. For that use case you want qdev_realize(). | |
367 | */ | |
9940b2cf | 368 | bool qdev_realize_and_unref(DeviceState *dev, BusState *bus, Error **errp); |
46ea1be1 PM |
369 | /** |
370 | * qdev_unrealize: Unrealize a device | |
371 | * @dev: device to unrealize | |
372 | * | |
373 | * This function will "unrealize" a device, which is the first phase | |
374 | * of correctly destroying a device that has been realized. It will: | |
375 | * | |
376 | * - unrealize any child buses by calling qbus_unrealize() | |
377 | * (this will recursively unrealize any devices on those buses) | |
378 | * - call the the unrealize method of @dev | |
379 | * | |
380 | * The device can then be freed by causing its reference count to go | |
381 | * to zero. | |
382 | * | |
383 | * Warning: most devices in QEMU do not expect to be unrealized. Only | |
384 | * devices which are hot-unpluggable should be unrealized (as part of | |
385 | * the unplugging process); all other devices are expected to last for | |
386 | * the life of the simulation and should not be unrealized and freed. | |
387 | */ | |
9940b2cf | 388 | void qdev_unrealize(DeviceState *dev); |
074a86fc AL |
389 | void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id, |
390 | int required_for_version); | |
14405c27 | 391 | HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev); |
03fcbd9d | 392 | HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev); |
d2321d31 | 393 | bool qdev_hotplug_allowed(DeviceState *dev, Error **errp); |
17cc0128 IM |
394 | /** |
395 | * qdev_get_hotplug_handler: Get handler responsible for device wiring | |
396 | * | |
397 | * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it. | |
398 | * | |
399 | * Note: in case @dev has a parent bus, it will be returned as handler unless | |
400 | * machine handler overrides it. | |
401 | * | |
402 | * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface | |
403 | * or NULL if there aren't any. | |
404 | */ | |
c06b2ffb | 405 | HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev); |
074a86fc | 406 | void qdev_unplug(DeviceState *dev, Error **errp); |
014176f9 IM |
407 | void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev, |
408 | DeviceState *dev, Error **errp); | |
074a86fc AL |
409 | void qdev_machine_creation_done(void); |
410 | bool qdev_machine_modified(void); | |
411 | ||
ddb67f64 PMD |
412 | /** |
413 | * GpioPolarity: Polarity of a GPIO line | |
414 | * | |
415 | * GPIO lines use either positive (active-high) logic, | |
416 | * or negative (active-low) logic. | |
417 | * | |
418 | * In active-high logic (%GPIO_POLARITY_ACTIVE_HIGH), a pin is | |
419 | * active when the voltage on the pin is high (relative to ground); | |
420 | * whereas in active-low logic (%GPIO_POLARITY_ACTIVE_LOW), a pin | |
421 | * is active when the voltage on the pin is low (or grounded). | |
422 | */ | |
423 | typedef enum { | |
424 | GPIO_POLARITY_ACTIVE_LOW, | |
425 | GPIO_POLARITY_ACTIVE_HIGH | |
426 | } GpioPolarity; | |
427 | ||
cd07d7f9 PM |
428 | /** |
429 | * qdev_get_gpio_in: Get one of a device's anonymous input GPIO lines | |
430 | * @dev: Device whose GPIO we want | |
431 | * @n: Number of the anonymous GPIO line (which must be in range) | |
432 | * | |
433 | * Returns the qemu_irq corresponding to an anonymous input GPIO line | |
434 | * (which the device has set up with qdev_init_gpio_in()). The index | |
435 | * @n of the GPIO line must be valid (i.e. be at least 0 and less than | |
436 | * the total number of anonymous input GPIOs the device has); this | |
437 | * function will assert() if passed an invalid index. | |
438 | * | |
439 | * This function is intended to be used by board code or SoC "container" | |
440 | * device models to wire up the GPIO lines; usually the return value | |
441 | * will be passed to qdev_connect_gpio_out() or a similar function to | |
442 | * connect another device's output GPIO line to this input. | |
443 | * | |
444 | * For named input GPIO lines, use qdev_get_gpio_in_named(). | |
445 | */ | |
074a86fc | 446 | qemu_irq qdev_get_gpio_in(DeviceState *dev, int n); |
cd07d7f9 PM |
447 | /** |
448 | * qdev_get_gpio_in_named: Get one of a device's named input GPIO lines | |
449 | * @dev: Device whose GPIO we want | |
450 | * @name: Name of the input GPIO array | |
451 | * @n: Number of the GPIO line in that array (which must be in range) | |
452 | * | |
453 | * Returns the qemu_irq corresponding to a named input GPIO line | |
454 | * (which the device has set up with qdev_init_gpio_in_named()). | |
455 | * The @name string must correspond to an input GPIO array which exists on | |
456 | * the device, and the index @n of the GPIO line must be valid (i.e. | |
457 | * be at least 0 and less than the total number of input GPIOs in that | |
458 | * array); this function will assert() if passed an invalid name or index. | |
459 | * | |
460 | * For anonymous input GPIO lines, use qdev_get_gpio_in(). | |
461 | */ | |
a5f54290 PC |
462 | qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n); |
463 | ||
cd07d7f9 PM |
464 | /** |
465 | * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines | |
466 | * @dev: Device whose GPIO to connect | |
467 | * @n: Number of the anonymous output GPIO line (which must be in range) | |
468 | * @pin: qemu_irq to connect the output line to | |
469 | * | |
470 | * This function connects an anonymous output GPIO line on a device | |
471 | * up to an arbitrary qemu_irq, so that when the device asserts that | |
472 | * output GPIO line, the qemu_irq's callback is invoked. | |
473 | * The index @n of the GPIO line must be valid (i.e. be at least 0 and | |
474 | * less than the total number of anonymous output GPIOs the device has | |
475 | * created with qdev_init_gpio_out()); otherwise this function will assert(). | |
476 | * | |
477 | * Outbound GPIO lines can be connected to any qemu_irq, but the common | |
478 | * case is connecting them to another device's inbound GPIO line, using | |
479 | * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named(). | |
480 | * | |
481 | * It is not valid to try to connect one outbound GPIO to multiple | |
482 | * qemu_irqs at once, or to connect multiple outbound GPIOs to the | |
483 | * same qemu_irq. (Warning: there is no assertion or other guard to | |
484 | * catch this error: the model will just not do the right thing.) | |
485 | * Instead, for fan-out you can use the TYPE_IRQ_SPLIT device: connect | |
486 | * a device's outbound GPIO to the splitter's input, and connect each | |
487 | * of the splitter's outputs to a different device. For fan-in you | |
488 | * can use the TYPE_OR_IRQ device, which is a model of a logical OR | |
489 | * gate with multiple inputs and one output. | |
490 | * | |
491 | * For named output GPIO lines, use qdev_connect_gpio_out_named(). | |
492 | */ | |
074a86fc | 493 | void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin); |
cd07d7f9 PM |
494 | /** |
495 | * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines | |
496 | * @dev: Device whose GPIO to connect | |
497 | * @name: Name of the output GPIO array | |
498 | * @n: Number of the anonymous output GPIO line (which must be in range) | |
499 | * @pin: qemu_irq to connect the output line to | |
500 | * | |
501 | * This function connects an anonymous output GPIO line on a device | |
502 | * up to an arbitrary qemu_irq, so that when the device asserts that | |
503 | * output GPIO line, the qemu_irq's callback is invoked. | |
504 | * The @name string must correspond to an output GPIO array which exists on | |
505 | * the device, and the index @n of the GPIO line must be valid (i.e. | |
506 | * be at least 0 and less than the total number of input GPIOs in that | |
507 | * array); this function will assert() if passed an invalid name or index. | |
508 | * | |
509 | * Outbound GPIO lines can be connected to any qemu_irq, but the common | |
510 | * case is connecting them to another device's inbound GPIO line, using | |
511 | * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named(). | |
512 | * | |
513 | * It is not valid to try to connect one outbound GPIO to multiple | |
514 | * qemu_irqs at once, or to connect multiple outbound GPIOs to the | |
515 | * same qemu_irq; see qdev_connect_gpio_out() for details. | |
516 | * | |
517 | * For named output GPIO lines, use qdev_connect_gpio_out_named(). | |
518 | */ | |
a5f54290 PC |
519 | void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n, |
520 | qemu_irq pin); | |
cd07d7f9 PM |
521 | /** |
522 | * qdev_get_gpio_out_connector: Get the qemu_irq connected to an output GPIO | |
523 | * @dev: Device whose output GPIO we are interested in | |
524 | * @name: Name of the output GPIO array | |
525 | * @n: Number of the output GPIO line within that array | |
526 | * | |
527 | * Returns whatever qemu_irq is currently connected to the specified | |
528 | * output GPIO line of @dev. This will be NULL if the output GPIO line | |
529 | * has never been wired up to the anything. Note that the qemu_irq | |
530 | * returned does not belong to @dev -- it will be the input GPIO or | |
531 | * IRQ of whichever device the board code has connected up to @dev's | |
532 | * output GPIO. | |
533 | * | |
534 | * You probably don't need to use this function -- it is used only | |
535 | * by the platform-bus subsystem. | |
536 | */ | |
b7973186 | 537 | qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n); |
cd07d7f9 PM |
538 | /** |
539 | * qdev_intercept_gpio_out: Intercept an existing GPIO connection | |
540 | * @dev: Device to intercept the outbound GPIO line from | |
541 | * @icpt: New qemu_irq to connect instead | |
542 | * @name: Name of the output GPIO array | |
543 | * @n: Number of the GPIO line in the array | |
544 | * | |
545 | * This function is provided only for use by the qtest testing framework | |
546 | * and is not suitable for use in non-testing parts of QEMU. | |
547 | * | |
548 | * This function breaks an existing connection of an outbound GPIO | |
549 | * line from @dev, and replaces it with the new qemu_irq @icpt, as if | |
550 | * ``qdev_connect_gpio_out_named(dev, icpt, name, n)`` had been called. | |
551 | * The previously connected qemu_irq is returned, so it can be restored | |
552 | * by a second call to qdev_intercept_gpio_out() if desired. | |
553 | */ | |
0c24db2b PC |
554 | qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt, |
555 | const char *name, int n); | |
074a86fc AL |
556 | |
557 | BusState *qdev_get_child_bus(DeviceState *dev, const char *name); | |
558 | ||
559 | /*** Device API. ***/ | |
560 | ||
cd07d7f9 PM |
561 | /** |
562 | * qdev_init_gpio_in: create an array of anonymous input GPIO lines | |
563 | * @dev: Device to create input GPIOs for | |
564 | * @handler: Function to call when GPIO line value is set | |
565 | * @n: Number of GPIO lines to create | |
566 | * | |
567 | * Devices should use functions in the qdev_init_gpio_in* family in | |
568 | * their instance_init or realize methods to create any input GPIO | |
569 | * lines they need. There is no functional difference between | |
570 | * anonymous and named GPIO lines. Stylistically, named GPIOs are | |
571 | * preferable (easier to understand at callsites) unless a device | |
572 | * has exactly one uniform kind of GPIO input whose purpose is obvious. | |
573 | * Note that input GPIO lines can serve as 'sinks' for IRQ lines. | |
574 | * | |
575 | * See qdev_get_gpio_in() for how code that uses such a device can get | |
576 | * hold of an input GPIO line to manipulate it. | |
577 | */ | |
074a86fc | 578 | void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n); |
cd07d7f9 PM |
579 | /** |
580 | * qdev_init_gpio_out: create an array of anonymous output GPIO lines | |
581 | * @dev: Device to create output GPIOs for | |
582 | * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines | |
583 | * @n: Number of GPIO lines to create | |
584 | * | |
585 | * Devices should use functions in the qdev_init_gpio_out* family | |
586 | * in their instance_init or realize methods to create any output | |
587 | * GPIO lines they need. There is no functional difference between | |
588 | * anonymous and named GPIO lines. Stylistically, named GPIOs are | |
589 | * preferable (easier to understand at callsites) unless a device | |
590 | * has exactly one uniform kind of GPIO output whose purpose is obvious. | |
591 | * | |
592 | * The @pins argument should be a pointer to either a "qemu_irq" | |
593 | * (if @n == 1) or a "qemu_irq []" array (if @n > 1) in the device's | |
594 | * state structure. The device implementation can then raise and | |
595 | * lower the GPIO line by calling qemu_set_irq(). (If anything is | |
596 | * connected to the other end of the GPIO this will cause the handler | |
597 | * function for that input GPIO to be called.) | |
598 | * | |
599 | * See qdev_connect_gpio_out() for how code that uses such a device | |
600 | * can connect to one of its output GPIO lines. | |
526dc840 PMD |
601 | * |
602 | * There is no need to release the @pins allocated array because it | |
603 | * will be automatically released when @dev calls its instance_finalize() | |
604 | * handler. | |
cd07d7f9 | 605 | */ |
074a86fc | 606 | void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n); |
cd07d7f9 PM |
607 | /** |
608 | * qdev_init_gpio_out: create an array of named output GPIO lines | |
609 | * @dev: Device to create output GPIOs for | |
610 | * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines | |
611 | * @name: Name to give this array of GPIO lines | |
612 | * @n: Number of GPIO lines to create | |
613 | * | |
614 | * Like qdev_init_gpio_out(), but creates an array of GPIO output lines | |
615 | * with a name. Code using the device can then connect these GPIO lines | |
616 | * using qdev_connect_gpio_out_named(). | |
617 | */ | |
a5f54290 PC |
618 | void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins, |
619 | const char *name, int n); | |
4a151677 PM |
620 | /** |
621 | * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines | |
622 | * for the specified device | |
623 | * | |
624 | * @dev: Device to create input GPIOs for | |
625 | * @handler: Function to call when GPIO line value is set | |
626 | * @opaque: Opaque data pointer to pass to @handler | |
627 | * @name: Name of the GPIO input (must be unique for this device) | |
628 | * @n: Number of GPIO lines in this input set | |
629 | */ | |
630 | void qdev_init_gpio_in_named_with_opaque(DeviceState *dev, | |
631 | qemu_irq_handler handler, | |
632 | void *opaque, | |
633 | const char *name, int n); | |
634 | ||
635 | /** | |
636 | * qdev_init_gpio_in_named: create an array of input GPIO lines | |
637 | * for the specified device | |
638 | * | |
639 | * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer | |
640 | * passed to the handler is @dev (which is the most commonly desired behaviour). | |
641 | */ | |
642 | static inline void qdev_init_gpio_in_named(DeviceState *dev, | |
643 | qemu_irq_handler handler, | |
644 | const char *name, int n) | |
645 | { | |
646 | qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n); | |
647 | } | |
074a86fc | 648 | |
cd07d7f9 PM |
649 | /** |
650 | * qdev_pass_gpios: create GPIO lines on container which pass through to device | |
651 | * @dev: Device which has GPIO lines | |
652 | * @container: Container device which needs to expose them | |
653 | * @name: Name of GPIO array to pass through (NULL for the anonymous GPIO array) | |
654 | * | |
655 | * In QEMU, complicated devices like SoCs are often modelled with a | |
656 | * "container" QOM device which itself contains other QOM devices and | |
657 | * which wires them up appropriately. This function allows the container | |
658 | * to create GPIO arrays on itself which simply pass through to a GPIO | |
659 | * array of one of its internal devices. | |
660 | * | |
661 | * If @dev has both input and output GPIOs named @name then both will | |
662 | * be passed through. It is not possible to pass a subset of the array | |
663 | * with this function. | |
664 | * | |
665 | * To users of the container device, the GPIO array created on @container | |
666 | * behaves exactly like any other. | |
667 | */ | |
17a96a14 PC |
668 | void qdev_pass_gpios(DeviceState *dev, DeviceState *container, |
669 | const char *name); | |
670 | ||
074a86fc AL |
671 | BusState *qdev_get_parent_bus(DeviceState *dev); |
672 | ||
673 | /*** BUS API. ***/ | |
674 | ||
675 | DeviceState *qdev_find_recursive(BusState *bus, const char *id); | |
676 | ||
677 | /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */ | |
678 | typedef int (qbus_walkerfn)(BusState *bus, void *opaque); | |
679 | typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque); | |
680 | ||
fb17dfe0 | 681 | void qbus_create_inplace(void *bus, size_t size, const char *typename, |
074a86fc AL |
682 | DeviceState *parent, const char *name); |
683 | BusState *qbus_create(const char *typename, DeviceState *parent, const char *name); | |
9940b2cf MA |
684 | bool qbus_realize(BusState *bus, Error **errp); |
685 | void qbus_unrealize(BusState *bus); | |
686 | ||
074a86fc AL |
687 | /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion, |
688 | * < 0 if either devfn or busfn terminate walk somewhere in cursion, | |
689 | * 0 otherwise. */ | |
0293214b PB |
690 | int qbus_walk_children(BusState *bus, |
691 | qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, | |
692 | qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, | |
693 | void *opaque); | |
694 | int qdev_walk_children(DeviceState *dev, | |
695 | qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, | |
696 | qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, | |
697 | void *opaque); | |
698 | ||
abb89dbf DH |
699 | /** |
700 | * @qdev_reset_all: | |
701 | * Reset @dev. See @qbus_reset_all() for more details. | |
702 | * | |
703 | * Note: This function is deprecated and will be removed when it becomes unused. | |
704 | * Please use device_cold_reset() now. | |
705 | */ | |
074a86fc | 706 | void qdev_reset_all(DeviceState *dev); |
ff8de075 | 707 | void qdev_reset_all_fn(void *opaque); |
d0508c36 PB |
708 | |
709 | /** | |
710 | * @qbus_reset_all: | |
711 | * @bus: Bus to be reset. | |
712 | * | |
713 | * Reset @bus and perform a bus-level ("hard") reset of all devices connected | |
714 | * to it, including recursive processing of all buses below @bus itself. A | |
715 | * hard reset means that qbus_reset_all will reset all state of the device. | |
716 | * For PCI devices, for example, this will include the base address registers | |
717 | * or configuration space. | |
abb89dbf DH |
718 | * |
719 | * Note: This function is deprecated and will be removed when it becomes unused. | |
720 | * Please use bus_cold_reset() now. | |
d0508c36 PB |
721 | */ |
722 | void qbus_reset_all(BusState *bus); | |
074a86fc AL |
723 | void qbus_reset_all_fn(void *opaque); |
724 | ||
abb89dbf DH |
725 | /** |
726 | * device_cold_reset: | |
727 | * Reset device @dev and perform a recursive processing using the resettable | |
728 | * interface. It triggers a RESET_TYPE_COLD. | |
729 | */ | |
730 | void device_cold_reset(DeviceState *dev); | |
731 | ||
732 | /** | |
733 | * bus_cold_reset: | |
734 | * | |
735 | * Reset bus @bus and perform a recursive processing using the resettable | |
736 | * interface. It triggers a RESET_TYPE_COLD. | |
737 | */ | |
738 | void bus_cold_reset(BusState *bus); | |
739 | ||
c11256aa DH |
740 | /** |
741 | * device_is_in_reset: | |
742 | * Return true if the device @dev is currently being reset. | |
743 | */ | |
744 | bool device_is_in_reset(DeviceState *dev); | |
745 | ||
746 | /** | |
747 | * bus_is_in_reset: | |
748 | * Return true if the bus @bus is currently being reset. | |
749 | */ | |
750 | bool bus_is_in_reset(BusState *bus); | |
751 | ||
074a86fc AL |
752 | /* This should go away once we get rid of the NULL bus hack */ |
753 | BusState *sysbus_get_default(void); | |
754 | ||
755 | char *qdev_get_fw_dev_path(DeviceState *dev); | |
0be63901 | 756 | char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev); |
074a86fc | 757 | |
074a86fc | 758 | /** |
f703a04c | 759 | * device_legacy_reset: |
074a86fc AL |
760 | * |
761 | * Reset a single device (by calling the reset method). | |
abb89dbf DH |
762 | * Note: This function is deprecated and will be removed when it becomes unused. |
763 | * Please use device_cold_reset() now. | |
074a86fc | 764 | */ |
f703a04c | 765 | void device_legacy_reset(DeviceState *dev); |
074a86fc | 766 | |
4f67d30b MAL |
767 | void device_class_set_props(DeviceClass *dc, Property *props); |
768 | ||
c11256aa DH |
769 | /** |
770 | * device_class_set_parent_reset: | |
771 | * TODO: remove the function when DeviceClass's reset method | |
772 | * is not used anymore. | |
773 | */ | |
46795cf2 PMD |
774 | void device_class_set_parent_reset(DeviceClass *dc, |
775 | DeviceReset dev_reset, | |
776 | DeviceReset *parent_reset); | |
777 | void device_class_set_parent_realize(DeviceClass *dc, | |
778 | DeviceRealize dev_realize, | |
779 | DeviceRealize *parent_realize); | |
780 | void device_class_set_parent_unrealize(DeviceClass *dc, | |
781 | DeviceUnrealize dev_unrealize, | |
782 | DeviceUnrealize *parent_unrealize); | |
783 | ||
8a9358cc | 784 | const VMStateDescription *qdev_get_vmsd(DeviceState *dev); |
074a86fc AL |
785 | |
786 | const char *qdev_fw_name(DeviceState *dev); | |
787 | ||
f66dc873 | 788 | void qdev_assert_realized_properly(void); |
074a86fc AL |
789 | Object *qdev_get_machine(void); |
790 | ||
791 | /* FIXME: make this a link<> */ | |
bb755ba4 | 792 | bool qdev_set_parent_bus(DeviceState *dev, BusState *bus, Error **errp); |
074a86fc | 793 | |
21def24a | 794 | extern bool qdev_hot_removed; |
074a86fc AL |
795 | |
796 | char *qdev_get_dev_path(DeviceState *dev); | |
797 | ||
9bc6bfdf | 798 | void qbus_set_hotplug_handler(BusState *bus, Object *handler); |
cd7c8660 | 799 | void qbus_set_bus_hotplug_handler(BusState *bus); |
39b888bd IM |
800 | |
801 | static inline bool qbus_is_hotpluggable(BusState *bus) | |
802 | { | |
2d9a982f | 803 | return bus->hotplug_handler; |
39b888bd | 804 | } |
707ff800 | 805 | |
1518562b PM |
806 | /** |
807 | * qbus_mark_full: Mark this bus as full, so no more devices can be attached | |
808 | * @bus: Bus to mark as full | |
809 | * | |
810 | * By default, QEMU will allow devices to be plugged into a bus up | |
811 | * to the bus class's device count limit. Calling this function | |
812 | * marks a particular bus as full, so that no more devices can be | |
813 | * plugged into it. In particular this means that the bus will not | |
814 | * be considered as a candidate for plugging in devices created by | |
815 | * the user on the commandline or via the monitor. | |
816 | * If a machine has multiple buses of a given type, such as I2C, | |
817 | * where some of those buses in the real hardware are used only for | |
818 | * internal devices and some are exposed via expansion ports, you | |
819 | * can use this function to mark the internal-only buses as full | |
820 | * after you have created all their internal devices. Then user | |
821 | * created devices will appear on the expansion-port bus where | |
822 | * guest software expects them. | |
823 | */ | |
824 | static inline void qbus_mark_full(BusState *bus) | |
825 | { | |
826 | bus->full = true; | |
827 | } | |
828 | ||
707ff800 PD |
829 | void device_listener_register(DeviceListener *listener); |
830 | void device_listener_unregister(DeviceListener *listener); | |
831 | ||
f3a85056 JF |
832 | /** |
833 | * @qdev_should_hide_device: | |
834 | * @opts: QemuOpts as passed on cmdline. | |
835 | * | |
836 | * Check if a device should be added. | |
837 | * When a device is added via qdev_device_add() this will be called, | |
838 | * and return if the device should be added now or not. | |
839 | */ | |
840 | bool qdev_should_hide_device(QemuOpts *opts); | |
841 | ||
2f181fbd PB |
842 | typedef enum MachineInitPhase { |
843 | /* current_machine is NULL. */ | |
844 | PHASE_NO_MACHINE, | |
845 | ||
846 | /* current_machine is not NULL, but current_machine->accel is NULL. */ | |
847 | PHASE_MACHINE_CREATED, | |
848 | ||
849 | /* | |
850 | * current_machine->accel is not NULL, but the machine properties have | |
851 | * not been validated and machine_class->init has not yet been called. | |
852 | */ | |
853 | PHASE_ACCEL_CREATED, | |
854 | ||
855 | /* | |
856 | * machine_class->init has been called, thus creating any embedded | |
857 | * devices and validating machine properties. Devices created at | |
858 | * this time are considered to be cold-plugged. | |
859 | */ | |
860 | PHASE_MACHINE_INITIALIZED, | |
861 | ||
862 | /* | |
863 | * QEMU is ready to start CPUs and devices created at this time | |
864 | * are considered to be hot-plugged. The monitor is not restricted | |
865 | * to "preconfig" commands. | |
866 | */ | |
867 | PHASE_MACHINE_READY, | |
868 | } MachineInitPhase; | |
869 | ||
870 | extern bool phase_check(MachineInitPhase phase); | |
871 | extern void phase_advance(MachineInitPhase phase); | |
872 | ||
074a86fc | 873 | #endif |