1 #ifndef QDEV_CORE_H 2 #define QDEV_CORE_H 3 4 #include "qemu/queue.h" 5 #include "qemu/bitmap.h" 6 #include "qom/object.h" 7 #include "hw/hotplug.h" 8 #include "hw/resettable.h" 9 10 enum { 11 DEV_NVECTORS_UNSPECIFIED = -1, 12 }; 13 14 #define TYPE_DEVICE "device" 15 typedef struct DeviceClass DeviceClass; 16 DECLARE_OBJ_CHECKERS(DeviceState, DeviceClass, 17 DEVICE, TYPE_DEVICE) 18 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, 28 DEVICE_CATEGORY_CPU, 29 DEVICE_CATEGORY_MAX 30 } DeviceCategory; 31 32 typedef void (*DeviceRealize)(DeviceState *dev, Error **errp); 33 typedef void (*DeviceUnrealize)(DeviceState *dev); 34 typedef void (*DeviceReset)(DeviceState *dev); 35 typedef void (*BusRealize)(BusState *bus, Error **errp); 36 typedef void (*BusUnrealize)(BusState *bus); 37 38 /** 39 * DeviceClass: 40 * @props: Properties accessing state fields. 41 * @realize: Callback function invoked when the #DeviceState:realized 42 * property is changed to %true. 43 * @unrealize: Callback function invoked when the #DeviceState:realized 44 * property is changed to %false. 45 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available 46 * as readonly "hotpluggable" property of #DeviceState instance 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. 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. 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 * 59 * As an interim step, the #DeviceState:realized property can also be 60 * set with qdev_realize(). 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 * 69 * Any type may override the @realize and/or @unrealize callbacks but needs 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> 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. 78 * For other types consult the documentation and implementation of the 79 * respective parent types. 80 * </para> 81 * </note> 82 * 83 * # Hiding a device # 84 * To hide a device, a DeviceListener function should_be_hidden() needs to 85 * be registered. 86 * It can be used to defer adding a device and therefore hide it from the 87 * guest. The handler registering to this DeviceListener can save the QOpts 88 * passed to it for re-using it later and must return that it wants the device 89 * to be/remain hidden or not. When the handler function decides the device 90 * shall not be hidden it will be added in qdev_device_add() and 91 * realized as any other device. Otherwise qdev_device_add() will return early 92 * without adding the device. The guest will not see a "hidden" device 93 * until it was marked don't hide and qdev_device_add called again. 94 * 95 */ 96 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 105 /* 106 * The underscore at the end ensures a compile-time error if someone 107 * assigns to dc->props instead of using device_class_set_props. 108 */ 109 Property *props_; 110 111 /* 112 * Can this device be instantiated with -device / device_add? 113 * All devices should support instantiation with device_add, and 114 * this flag should not exist. But we're not there, yet. Some 115 * devices fail to instantiate with cryptic error messages. 116 * Others instantiate, but don't work. Exposing users to such 117 * behavior would be cruel; clearing this flag will protect them. 118 * It should never be cleared without a comment explaining why it 119 * is cleared. 120 * TODO remove once we're there 121 */ 122 bool user_creatable; 123 bool hotpluggable; 124 125 /* callbacks */ 126 /* 127 * Reset method here is deprecated and replaced by methods in the 128 * resettable class interface to implement a multi-phase reset. 129 * TODO: remove once every reset callback is unused 130 */ 131 DeviceReset reset; 132 DeviceRealize realize; 133 DeviceUnrealize unrealize; 134 135 /* device state */ 136 const VMStateDescription *vmsd; 137 138 /* Private to qdev / bus. */ 139 const char *bus_type; 140 }; 141 142 typedef struct NamedGPIOList NamedGPIOList; 143 144 struct NamedGPIOList { 145 char *name; 146 qemu_irq *in; 147 int num_in; 148 int num_out; 149 QLIST_ENTRY(NamedGPIOList) node; 150 }; 151 152 typedef struct Clock Clock; 153 typedef struct NamedClockList NamedClockList; 154 155 struct NamedClockList { 156 char *name; 157 Clock *clock; 158 bool output; 159 bool alias; 160 QLIST_ENTRY(NamedClockList) node; 161 }; 162 163 /** 164 * DeviceState: 165 * @realized: Indicates whether the device has been fully constructed. 166 * @reset: ResettableState for the device; handled by Resettable interface. 167 * 168 * This structure should not be accessed directly. We declare it here 169 * so that it can be embedded in individual device state structures. 170 */ 171 struct DeviceState { 172 /*< private >*/ 173 Object parent_obj; 174 /*< public >*/ 175 176 const char *id; 177 char *canonical_path; 178 bool realized; 179 bool pending_deleted_event; 180 QemuOpts *opts; 181 int hotplugged; 182 bool allow_unplug_during_migration; 183 BusState *parent_bus; 184 QLIST_HEAD(, NamedGPIOList) gpios; 185 QLIST_HEAD(, NamedClockList) clocks; 186 QLIST_HEAD(, BusState) child_bus; 187 int num_child_bus; 188 int instance_id_alias; 189 int alias_required_for_version; 190 ResettableState reset; 191 }; 192 193 struct DeviceListener { 194 void (*realize)(DeviceListener *listener, DeviceState *dev); 195 void (*unrealize)(DeviceListener *listener, DeviceState *dev); 196 /* 197 * This callback is called upon init of the DeviceState and allows to 198 * inform qdev that a device should be hidden, depending on the device 199 * opts, for example, to hide a standby device. 200 */ 201 int (*should_be_hidden)(DeviceListener *listener, QemuOpts *device_opts); 202 QTAILQ_ENTRY(DeviceListener) link; 203 }; 204 205 #define TYPE_BUS "bus" 206 DECLARE_OBJ_CHECKERS(BusState, BusClass, 207 BUS, TYPE_BUS) 208 209 struct BusClass { 210 ObjectClass parent_class; 211 212 /* FIXME first arg should be BusState */ 213 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent); 214 char *(*get_dev_path)(DeviceState *dev); 215 /* 216 * This callback is used to create Open Firmware device path in accordance 217 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus 218 * bindings can be found at http://playground.sun.com/1275/bindings/. 219 */ 220 char *(*get_fw_dev_path)(DeviceState *dev); 221 void (*reset)(BusState *bus); 222 BusRealize realize; 223 BusUnrealize unrealize; 224 225 /* maximum devices allowed on the bus, 0: no limit. */ 226 int max_dev; 227 /* number of automatically allocated bus ids (e.g. ide.0) */ 228 int automatic_ids; 229 }; 230 231 typedef struct BusChild { 232 DeviceState *child; 233 int index; 234 QTAILQ_ENTRY(BusChild) sibling; 235 } BusChild; 236 237 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler" 238 239 /** 240 * BusState: 241 * @hotplug_handler: link to a hotplug handler associated with bus. 242 * @reset: ResettableState for the bus; handled by Resettable interface. 243 */ 244 struct BusState { 245 Object obj; 246 DeviceState *parent; 247 char *name; 248 HotplugHandler *hotplug_handler; 249 int max_index; 250 bool realized; 251 int num_children; 252 QTAILQ_HEAD(, BusChild) children; 253 QLIST_ENTRY(BusState) sibling; 254 ResettableState reset; 255 }; 256 257 /** 258 * Property: 259 * @set_default: true if the default value should be set from @defval, 260 * in which case @info->set_default_value must not be NULL 261 * (if false then no default value is set by the property system 262 * and the field retains whatever value it was given by instance_init). 263 * @defval: default value for the property. This is used only if @set_default 264 * is true. 265 */ 266 struct Property { 267 const char *name; 268 const PropertyInfo *info; 269 ptrdiff_t offset; 270 uint8_t bitnr; 271 bool set_default; 272 union { 273 int64_t i; 274 uint64_t u; 275 } defval; 276 int arrayoffset; 277 const PropertyInfo *arrayinfo; 278 int arrayfieldsize; 279 const char *link_type; 280 }; 281 282 struct PropertyInfo { 283 const char *name; 284 const char *description; 285 const QEnumLookup *enum_table; 286 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len); 287 void (*set_default_value)(ObjectProperty *op, const Property *prop); 288 void (*create)(ObjectClass *oc, Property *prop); 289 ObjectPropertyAccessor *get; 290 ObjectPropertyAccessor *set; 291 ObjectPropertyRelease *release; 292 }; 293 294 /** 295 * GlobalProperty: 296 * @used: Set to true if property was used when initializing a device. 297 * @optional: If set to true, GlobalProperty will be skipped without errors 298 * if the property doesn't exist. 299 * 300 * An error is fatal for non-hotplugged devices, when the global is applied. 301 */ 302 typedef struct GlobalProperty { 303 const char *driver; 304 const char *property; 305 const char *value; 306 bool used; 307 bool optional; 308 } GlobalProperty; 309 310 static inline void 311 compat_props_add(GPtrArray *arr, 312 GlobalProperty props[], size_t nelem) 313 { 314 int i; 315 for (i = 0; i < nelem; i++) { 316 g_ptr_array_add(arr, (void *)&props[i]); 317 } 318 } 319 320 /*** Board API. This should go away once we have a machine config file. ***/ 321 322 /** 323 * qdev_new: Create a device on the heap 324 * @name: device type to create (we assert() that this type exists) 325 * 326 * This only allocates the memory and initializes the device state 327 * structure, ready for the caller to set properties if they wish. 328 * The device still needs to be realized. 329 * The returned object has a reference count of 1. 330 */ 331 DeviceState *qdev_new(const char *name); 332 /** 333 * qdev_try_new: Try to create a device on the heap 334 * @name: device type to create 335 * 336 * This is like qdev_new(), except it returns %NULL when type @name 337 * does not exist, rather than asserting. 338 */ 339 DeviceState *qdev_try_new(const char *name); 340 /** 341 * qdev_realize: Realize @dev. 342 * @dev: device to realize 343 * @bus: bus to plug it into (may be NULL) 344 * @errp: pointer to error object 345 * 346 * "Realize" the device, i.e. perform the second phase of device 347 * initialization. 348 * @dev must not be plugged into a bus already. 349 * If @bus, plug @dev into @bus. This takes a reference to @dev. 350 * If @dev has no QOM parent, make one up, taking another reference. 351 * On success, return true. 352 * On failure, store an error through @errp and return false. 353 * 354 * If you created @dev using qdev_new(), you probably want to use 355 * qdev_realize_and_unref() instead. 356 */ 357 bool qdev_realize(DeviceState *dev, BusState *bus, Error **errp); 358 /** 359 * qdev_realize_and_unref: Realize @dev and drop a reference 360 * @dev: device to realize 361 * @bus: bus to plug it into (may be NULL) 362 * @errp: pointer to error object 363 * 364 * Realize @dev and drop a reference. 365 * This is like qdev_realize(), except the caller must hold a 366 * (private) reference, which is dropped on return regardless of 367 * success or failure. Intended use:: 368 * 369 * dev = qdev_new(); 370 * [...] 371 * qdev_realize_and_unref(dev, bus, errp); 372 * 373 * Now @dev can go away without further ado. 374 * 375 * If you are embedding the device into some other QOM device and 376 * initialized it via some variant on object_initialize_child() then 377 * do not use this function, because that family of functions arrange 378 * for the only reference to the child device to be held by the parent 379 * via the child<> property, and so the reference-count-drop done here 380 * would be incorrect. For that use case you want qdev_realize(). 381 */ 382 bool qdev_realize_and_unref(DeviceState *dev, BusState *bus, Error **errp); 383 /** 384 * qdev_unrealize: Unrealize a device 385 * @dev: device to unrealize 386 * 387 * This function will "unrealize" a device, which is the first phase 388 * of correctly destroying a device that has been realized. It will: 389 * 390 * - unrealize any child buses by calling qbus_unrealize() 391 * (this will recursively unrealize any devices on those buses) 392 * - call the the unrealize method of @dev 393 * 394 * The device can then be freed by causing its reference count to go 395 * to zero. 396 * 397 * Warning: most devices in QEMU do not expect to be unrealized. Only 398 * devices which are hot-unpluggable should be unrealized (as part of 399 * the unplugging process); all other devices are expected to last for 400 * the life of the simulation and should not be unrealized and freed. 401 */ 402 void qdev_unrealize(DeviceState *dev); 403 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id, 404 int required_for_version); 405 HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev); 406 HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev); 407 bool qdev_hotplug_allowed(DeviceState *dev, Error **errp); 408 /** 409 * qdev_get_hotplug_handler: Get handler responsible for device wiring 410 * 411 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it. 412 * 413 * Note: in case @dev has a parent bus, it will be returned as handler unless 414 * machine handler overrides it. 415 * 416 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface 417 * or NULL if there aren't any. 418 */ 419 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev); 420 void qdev_unplug(DeviceState *dev, Error **errp); 421 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev, 422 DeviceState *dev, Error **errp); 423 void qdev_machine_creation_done(void); 424 bool qdev_machine_modified(void); 425 426 /** 427 * qdev_get_gpio_in: Get one of a device's anonymous input GPIO lines 428 * @dev: Device whose GPIO we want 429 * @n: Number of the anonymous GPIO line (which must be in range) 430 * 431 * Returns the qemu_irq corresponding to an anonymous input GPIO line 432 * (which the device has set up with qdev_init_gpio_in()). The index 433 * @n of the GPIO line must be valid (i.e. be at least 0 and less than 434 * the total number of anonymous input GPIOs the device has); this 435 * function will assert() if passed an invalid index. 436 * 437 * This function is intended to be used by board code or SoC "container" 438 * device models to wire up the GPIO lines; usually the return value 439 * will be passed to qdev_connect_gpio_out() or a similar function to 440 * connect another device's output GPIO line to this input. 441 * 442 * For named input GPIO lines, use qdev_get_gpio_in_named(). 443 */ 444 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n); 445 /** 446 * qdev_get_gpio_in_named: Get one of a device's named input GPIO lines 447 * @dev: Device whose GPIO we want 448 * @name: Name of the input GPIO array 449 * @n: Number of the GPIO line in that array (which must be in range) 450 * 451 * Returns the qemu_irq corresponding to a named input GPIO line 452 * (which the device has set up with qdev_init_gpio_in_named()). 453 * The @name string must correspond to an input GPIO array which exists on 454 * the device, and the index @n of the GPIO line must be valid (i.e. 455 * be at least 0 and less than the total number of input GPIOs in that 456 * array); this function will assert() if passed an invalid name or index. 457 * 458 * For anonymous input GPIO lines, use qdev_get_gpio_in(). 459 */ 460 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n); 461 462 /** 463 * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines 464 * @dev: Device whose GPIO to connect 465 * @n: Number of the anonymous output GPIO line (which must be in range) 466 * @pin: qemu_irq to connect the output line to 467 * 468 * This function connects an anonymous output GPIO line on a device 469 * up to an arbitrary qemu_irq, so that when the device asserts that 470 * output GPIO line, the qemu_irq's callback is invoked. 471 * The index @n of the GPIO line must be valid (i.e. be at least 0 and 472 * less than the total number of anonymous output GPIOs the device has 473 * created with qdev_init_gpio_out()); otherwise this function will assert(). 474 * 475 * Outbound GPIO lines can be connected to any qemu_irq, but the common 476 * case is connecting them to another device's inbound GPIO line, using 477 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named(). 478 * 479 * It is not valid to try to connect one outbound GPIO to multiple 480 * qemu_irqs at once, or to connect multiple outbound GPIOs to the 481 * same qemu_irq. (Warning: there is no assertion or other guard to 482 * catch this error: the model will just not do the right thing.) 483 * Instead, for fan-out you can use the TYPE_IRQ_SPLIT device: connect 484 * a device's outbound GPIO to the splitter's input, and connect each 485 * of the splitter's outputs to a different device. For fan-in you 486 * can use the TYPE_OR_IRQ device, which is a model of a logical OR 487 * gate with multiple inputs and one output. 488 * 489 * For named output GPIO lines, use qdev_connect_gpio_out_named(). 490 */ 491 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin); 492 /** 493 * qdev_connect_gpio_out: Connect one of a device's anonymous output GPIO lines 494 * @dev: Device whose GPIO to connect 495 * @name: Name of the output GPIO array 496 * @n: Number of the anonymous output GPIO line (which must be in range) 497 * @pin: qemu_irq to connect the output line to 498 * 499 * This function connects an anonymous output GPIO line on a device 500 * up to an arbitrary qemu_irq, so that when the device asserts that 501 * output GPIO line, the qemu_irq's callback is invoked. 502 * The @name string must correspond to an output GPIO array which exists on 503 * the device, and the index @n of the GPIO line must be valid (i.e. 504 * be at least 0 and less than the total number of input GPIOs in that 505 * array); this function will assert() if passed an invalid name or index. 506 * 507 * Outbound GPIO lines can be connected to any qemu_irq, but the common 508 * case is connecting them to another device's inbound GPIO line, using 509 * the qemu_irq returned by qdev_get_gpio_in() or qdev_get_gpio_in_named(). 510 * 511 * It is not valid to try to connect one outbound GPIO to multiple 512 * qemu_irqs at once, or to connect multiple outbound GPIOs to the 513 * same qemu_irq; see qdev_connect_gpio_out() for details. 514 * 515 * For named output GPIO lines, use qdev_connect_gpio_out_named(). 516 */ 517 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n, 518 qemu_irq pin); 519 /** 520 * qdev_get_gpio_out_connector: Get the qemu_irq connected to an output GPIO 521 * @dev: Device whose output GPIO we are interested in 522 * @name: Name of the output GPIO array 523 * @n: Number of the output GPIO line within that array 524 * 525 * Returns whatever qemu_irq is currently connected to the specified 526 * output GPIO line of @dev. This will be NULL if the output GPIO line 527 * has never been wired up to the anything. Note that the qemu_irq 528 * returned does not belong to @dev -- it will be the input GPIO or 529 * IRQ of whichever device the board code has connected up to @dev's 530 * output GPIO. 531 * 532 * You probably don't need to use this function -- it is used only 533 * by the platform-bus subsystem. 534 */ 535 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n); 536 /** 537 * qdev_intercept_gpio_out: Intercept an existing GPIO connection 538 * @dev: Device to intercept the outbound GPIO line from 539 * @icpt: New qemu_irq to connect instead 540 * @name: Name of the output GPIO array 541 * @n: Number of the GPIO line in the array 542 * 543 * This function is provided only for use by the qtest testing framework 544 * and is not suitable for use in non-testing parts of QEMU. 545 * 546 * This function breaks an existing connection of an outbound GPIO 547 * line from @dev, and replaces it with the new qemu_irq @icpt, as if 548 * ``qdev_connect_gpio_out_named(dev, icpt, name, n)`` had been called. 549 * The previously connected qemu_irq is returned, so it can be restored 550 * by a second call to qdev_intercept_gpio_out() if desired. 551 */ 552 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt, 553 const char *name, int n); 554 555 BusState *qdev_get_child_bus(DeviceState *dev, const char *name); 556 557 /*** Device API. ***/ 558 559 /** 560 * qdev_init_gpio_in: create an array of anonymous input GPIO lines 561 * @dev: Device to create input GPIOs for 562 * @handler: Function to call when GPIO line value is set 563 * @n: Number of GPIO lines to create 564 * 565 * Devices should use functions in the qdev_init_gpio_in* family in 566 * their instance_init or realize methods to create any input GPIO 567 * lines they need. There is no functional difference between 568 * anonymous and named GPIO lines. Stylistically, named GPIOs are 569 * preferable (easier to understand at callsites) unless a device 570 * has exactly one uniform kind of GPIO input whose purpose is obvious. 571 * Note that input GPIO lines can serve as 'sinks' for IRQ lines. 572 * 573 * See qdev_get_gpio_in() for how code that uses such a device can get 574 * hold of an input GPIO line to manipulate it. 575 */ 576 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n); 577 /** 578 * qdev_init_gpio_out: create an array of anonymous output GPIO lines 579 * @dev: Device to create output GPIOs for 580 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines 581 * @n: Number of GPIO lines to create 582 * 583 * Devices should use functions in the qdev_init_gpio_out* family 584 * in their instance_init or realize methods to create any output 585 * GPIO lines they need. There is no functional difference between 586 * anonymous and named GPIO lines. Stylistically, named GPIOs are 587 * preferable (easier to understand at callsites) unless a device 588 * has exactly one uniform kind of GPIO output whose purpose is obvious. 589 * 590 * The @pins argument should be a pointer to either a "qemu_irq" 591 * (if @n == 1) or a "qemu_irq []" array (if @n > 1) in the device's 592 * state structure. The device implementation can then raise and 593 * lower the GPIO line by calling qemu_set_irq(). (If anything is 594 * connected to the other end of the GPIO this will cause the handler 595 * function for that input GPIO to be called.) 596 * 597 * See qdev_connect_gpio_out() for how code that uses such a device 598 * can connect to one of its output GPIO lines. 599 */ 600 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n); 601 /** 602 * qdev_init_gpio_out: create an array of named output GPIO lines 603 * @dev: Device to create output GPIOs for 604 * @pins: Pointer to qemu_irq or qemu_irq array for the GPIO lines 605 * @name: Name to give this array of GPIO lines 606 * @n: Number of GPIO lines to create 607 * 608 * Like qdev_init_gpio_out(), but creates an array of GPIO output lines 609 * with a name. Code using the device can then connect these GPIO lines 610 * using qdev_connect_gpio_out_named(). 611 */ 612 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins, 613 const char *name, int n); 614 /** 615 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines 616 * for the specified device 617 * 618 * @dev: Device to create input GPIOs for 619 * @handler: Function to call when GPIO line value is set 620 * @opaque: Opaque data pointer to pass to @handler 621 * @name: Name of the GPIO input (must be unique for this device) 622 * @n: Number of GPIO lines in this input set 623 */ 624 void qdev_init_gpio_in_named_with_opaque(DeviceState *dev, 625 qemu_irq_handler handler, 626 void *opaque, 627 const char *name, int n); 628 629 /** 630 * qdev_init_gpio_in_named: create an array of input GPIO lines 631 * for the specified device 632 * 633 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer 634 * passed to the handler is @dev (which is the most commonly desired behaviour). 635 */ 636 static inline void qdev_init_gpio_in_named(DeviceState *dev, 637 qemu_irq_handler handler, 638 const char *name, int n) 639 { 640 qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n); 641 } 642 643 /** 644 * qdev_pass_gpios: create GPIO lines on container which pass through to device 645 * @dev: Device which has GPIO lines 646 * @container: Container device which needs to expose them 647 * @name: Name of GPIO array to pass through (NULL for the anonymous GPIO array) 648 * 649 * In QEMU, complicated devices like SoCs are often modelled with a 650 * "container" QOM device which itself contains other QOM devices and 651 * which wires them up appropriately. This function allows the container 652 * to create GPIO arrays on itself which simply pass through to a GPIO 653 * array of one of its internal devices. 654 * 655 * If @dev has both input and output GPIOs named @name then both will 656 * be passed through. It is not possible to pass a subset of the array 657 * with this function. 658 * 659 * To users of the container device, the GPIO array created on @container 660 * behaves exactly like any other. 661 */ 662 void qdev_pass_gpios(DeviceState *dev, DeviceState *container, 663 const char *name); 664 665 BusState *qdev_get_parent_bus(DeviceState *dev); 666 667 /*** BUS API. ***/ 668 669 DeviceState *qdev_find_recursive(BusState *bus, const char *id); 670 671 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */ 672 typedef int (qbus_walkerfn)(BusState *bus, void *opaque); 673 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque); 674 675 void qbus_create_inplace(void *bus, size_t size, const char *typename, 676 DeviceState *parent, const char *name); 677 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name); 678 bool qbus_realize(BusState *bus, Error **errp); 679 void qbus_unrealize(BusState *bus); 680 681 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion, 682 * < 0 if either devfn or busfn terminate walk somewhere in cursion, 683 * 0 otherwise. */ 684 int qbus_walk_children(BusState *bus, 685 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, 686 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, 687 void *opaque); 688 int qdev_walk_children(DeviceState *dev, 689 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, 690 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, 691 void *opaque); 692 693 /** 694 * @qdev_reset_all: 695 * Reset @dev. See @qbus_reset_all() for more details. 696 * 697 * Note: This function is deprecated and will be removed when it becomes unused. 698 * Please use device_cold_reset() now. 699 */ 700 void qdev_reset_all(DeviceState *dev); 701 void qdev_reset_all_fn(void *opaque); 702 703 /** 704 * @qbus_reset_all: 705 * @bus: Bus to be reset. 706 * 707 * Reset @bus and perform a bus-level ("hard") reset of all devices connected 708 * to it, including recursive processing of all buses below @bus itself. A 709 * hard reset means that qbus_reset_all will reset all state of the device. 710 * For PCI devices, for example, this will include the base address registers 711 * or configuration space. 712 * 713 * Note: This function is deprecated and will be removed when it becomes unused. 714 * Please use bus_cold_reset() now. 715 */ 716 void qbus_reset_all(BusState *bus); 717 void qbus_reset_all_fn(void *opaque); 718 719 /** 720 * device_cold_reset: 721 * Reset device @dev and perform a recursive processing using the resettable 722 * interface. It triggers a RESET_TYPE_COLD. 723 */ 724 void device_cold_reset(DeviceState *dev); 725 726 /** 727 * bus_cold_reset: 728 * 729 * Reset bus @bus and perform a recursive processing using the resettable 730 * interface. It triggers a RESET_TYPE_COLD. 731 */ 732 void bus_cold_reset(BusState *bus); 733 734 /** 735 * device_is_in_reset: 736 * Return true if the device @dev is currently being reset. 737 */ 738 bool device_is_in_reset(DeviceState *dev); 739 740 /** 741 * bus_is_in_reset: 742 * Return true if the bus @bus is currently being reset. 743 */ 744 bool bus_is_in_reset(BusState *bus); 745 746 /* This should go away once we get rid of the NULL bus hack */ 747 BusState *sysbus_get_default(void); 748 749 char *qdev_get_fw_dev_path(DeviceState *dev); 750 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev); 751 752 /** 753 * @qdev_machine_init 754 * 755 * Initialize platform devices before machine init. This is a hack until full 756 * support for composition is added. 757 */ 758 void qdev_machine_init(void); 759 760 /** 761 * device_legacy_reset: 762 * 763 * Reset a single device (by calling the reset method). 764 * Note: This function is deprecated and will be removed when it becomes unused. 765 * Please use device_cold_reset() now. 766 */ 767 void device_legacy_reset(DeviceState *dev); 768 769 void device_class_set_props(DeviceClass *dc, Property *props); 770 771 /** 772 * device_class_set_parent_reset: 773 * TODO: remove the function when DeviceClass's reset method 774 * is not used anymore. 775 */ 776 void device_class_set_parent_reset(DeviceClass *dc, 777 DeviceReset dev_reset, 778 DeviceReset *parent_reset); 779 void device_class_set_parent_realize(DeviceClass *dc, 780 DeviceRealize dev_realize, 781 DeviceRealize *parent_realize); 782 void device_class_set_parent_unrealize(DeviceClass *dc, 783 DeviceUnrealize dev_unrealize, 784 DeviceUnrealize *parent_unrealize); 785 786 const VMStateDescription *qdev_get_vmsd(DeviceState *dev); 787 788 const char *qdev_fw_name(DeviceState *dev); 789 790 Object *qdev_get_machine(void); 791 792 /* FIXME: make this a link<> */ 793 void qdev_set_parent_bus(DeviceState *dev, BusState *bus); 794 795 extern bool qdev_hotplug; 796 extern bool qdev_hot_removed; 797 798 char *qdev_get_dev_path(DeviceState *dev); 799 800 void qbus_set_hotplug_handler(BusState *bus, Object *handler); 801 void qbus_set_bus_hotplug_handler(BusState *bus); 802 803 static inline bool qbus_is_hotpluggable(BusState *bus) 804 { 805 return bus->hotplug_handler; 806 } 807 808 void device_listener_register(DeviceListener *listener); 809 void device_listener_unregister(DeviceListener *listener); 810 811 /** 812 * @qdev_should_hide_device: 813 * @opts: QemuOpts as passed on cmdline. 814 * 815 * Check if a device should be added. 816 * When a device is added via qdev_device_add() this will be called, 817 * and return if the device should be added now or not. 818 */ 819 bool qdev_should_hide_device(QemuOpts *opts); 820 821 #endif 822