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