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/irq.h" 8 #include "hw/hotplug.h" 9 #include "sysemu/sysemu.h" 10 11 enum { 12 DEV_NVECTORS_UNSPECIFIED = -1, 13 }; 14 15 #define TYPE_DEVICE "device" 16 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE) 17 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE) 18 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE) 19 20 typedef enum DeviceCategory { 21 DEVICE_CATEGORY_BRIDGE, 22 DEVICE_CATEGORY_USB, 23 DEVICE_CATEGORY_STORAGE, 24 DEVICE_CATEGORY_NETWORK, 25 DEVICE_CATEGORY_INPUT, 26 DEVICE_CATEGORY_DISPLAY, 27 DEVICE_CATEGORY_SOUND, 28 DEVICE_CATEGORY_MISC, 29 DEVICE_CATEGORY_CPU, 30 DEVICE_CATEGORY_MAX 31 } DeviceCategory; 32 33 typedef void (*DeviceRealize)(DeviceState *dev, Error **errp); 34 typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp); 35 typedef void (*DeviceReset)(DeviceState *dev); 36 typedef void (*BusRealize)(BusState *bus, Error **errp); 37 typedef void (*BusUnrealize)(BusState *bus, Error **errp); 38 39 struct VMStateDescription; 40 41 /** 42 * DeviceClass: 43 * @props: Properties accessing state fields. 44 * @realize: Callback function invoked when the #DeviceState:realized 45 * property is changed to %true. 46 * @unrealize: Callback function invoked when the #DeviceState:realized 47 * property is changed to %false. 48 * @hotpluggable: indicates if #DeviceClass is hotpluggable, available 49 * as readonly "hotpluggable" property of #DeviceState instance 50 * 51 * # Realization # 52 * Devices are constructed in two stages, 53 * 1) object instantiation via object_initialize() and 54 * 2) device realization via #DeviceState:realized property. 55 * The former may not fail (and must not abort or exit, since it is called 56 * during device introspection already), and the latter may return error 57 * information to the caller and must be re-entrant. 58 * Trivial field initializations should go into #TypeInfo.instance_init. 59 * Operations depending on @props static properties should go into @realize. 60 * After successful realization, setting static properties will fail. 61 * 62 * As an interim step, the #DeviceState:realized property can also be 63 * set with qdev_init_nofail(). 64 * In the future, devices will propagate this state change to their children 65 * and along busses they expose. 66 * The point in time will be deferred to machine creation, so that values 67 * set in @realize will not be introspectable beforehand. Therefore devices 68 * must not create children during @realize; they should initialize them via 69 * object_initialize() in their own #TypeInfo.instance_init and forward the 70 * realization events appropriately. 71 * 72 * Any type may override the @realize and/or @unrealize callbacks but needs 73 * to call the parent type's implementation if keeping their functionality 74 * is desired. Refer to QOM documentation for further discussion and examples. 75 * 76 * <note> 77 * <para> 78 * Since TYPE_DEVICE doesn't implement @realize and @unrealize, types 79 * derived directly from it need not call their parent's @realize and 80 * @unrealize. 81 * For other types consult the documentation and implementation of the 82 * respective parent types. 83 * </para> 84 * </note> 85 */ 86 typedef struct DeviceClass { 87 /*< private >*/ 88 ObjectClass parent_class; 89 /*< public >*/ 90 91 DECLARE_BITMAP(categories, DEVICE_CATEGORY_MAX); 92 const char *fw_name; 93 const char *desc; 94 Property *props; 95 96 /* 97 * Can this device be instantiated with -device / device_add? 98 * All devices should support instantiation with device_add, and 99 * this flag should not exist. But we're not there, yet. Some 100 * devices fail to instantiate with cryptic error messages. 101 * Others instantiate, but don't work. Exposing users to such 102 * behavior would be cruel; clearing this flag will protect them. 103 * It should never be cleared without a comment explaining why it 104 * is cleared. 105 * TODO remove once we're there 106 */ 107 bool user_creatable; 108 bool hotpluggable; 109 110 /* callbacks */ 111 DeviceReset reset; 112 DeviceRealize realize; 113 DeviceUnrealize unrealize; 114 115 /* device state */ 116 const struct VMStateDescription *vmsd; 117 118 /* Private to qdev / bus. */ 119 const char *bus_type; 120 } DeviceClass; 121 122 typedef struct NamedGPIOList NamedGPIOList; 123 124 struct NamedGPIOList { 125 char *name; 126 qemu_irq *in; 127 int num_in; 128 int num_out; 129 QLIST_ENTRY(NamedGPIOList) node; 130 }; 131 132 /** 133 * DeviceState: 134 * @realized: Indicates whether the device has been fully constructed. 135 * 136 * This structure should not be accessed directly. We declare it here 137 * so that it can be embedded in individual device state structures. 138 */ 139 struct DeviceState { 140 /*< private >*/ 141 Object parent_obj; 142 /*< public >*/ 143 144 const char *id; 145 char *canonical_path; 146 bool realized; 147 bool pending_deleted_event; 148 QemuOpts *opts; 149 int hotplugged; 150 BusState *parent_bus; 151 QLIST_HEAD(, NamedGPIOList) gpios; 152 QLIST_HEAD(, BusState) child_bus; 153 int num_child_bus; 154 int instance_id_alias; 155 int alias_required_for_version; 156 }; 157 158 struct DeviceListener { 159 void (*realize)(DeviceListener *listener, DeviceState *dev); 160 void (*unrealize)(DeviceListener *listener, DeviceState *dev); 161 QTAILQ_ENTRY(DeviceListener) link; 162 }; 163 164 #define TYPE_BUS "bus" 165 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS) 166 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS) 167 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS) 168 169 struct BusClass { 170 ObjectClass parent_class; 171 172 /* FIXME first arg should be BusState */ 173 void (*print_dev)(Monitor *mon, DeviceState *dev, int indent); 174 char *(*get_dev_path)(DeviceState *dev); 175 /* 176 * This callback is used to create Open Firmware device path in accordance 177 * with OF spec http://forthworks.com/standards/of1275.pdf. Individual bus 178 * bindings can be found at http://playground.sun.com/1275/bindings/. 179 */ 180 char *(*get_fw_dev_path)(DeviceState *dev); 181 void (*reset)(BusState *bus); 182 BusRealize realize; 183 BusUnrealize unrealize; 184 185 /* maximum devices allowed on the bus, 0: no limit. */ 186 int max_dev; 187 /* number of automatically allocated bus ids (e.g. ide.0) */ 188 int automatic_ids; 189 }; 190 191 typedef struct BusChild { 192 DeviceState *child; 193 int index; 194 QTAILQ_ENTRY(BusChild) sibling; 195 } BusChild; 196 197 #define QDEV_HOTPLUG_HANDLER_PROPERTY "hotplug-handler" 198 199 /** 200 * BusState: 201 * @hotplug_handler: link to a hotplug handler associated with bus. 202 */ 203 struct BusState { 204 Object obj; 205 DeviceState *parent; 206 char *name; 207 HotplugHandler *hotplug_handler; 208 int max_index; 209 bool realized; 210 int num_children; 211 QTAILQ_HEAD(, BusChild) children; 212 QLIST_ENTRY(BusState) sibling; 213 }; 214 215 /** 216 * Property: 217 * @set_default: true if the default value should be set from @defval, 218 * in which case @info->set_default_value must not be NULL 219 * (if false then no default value is set by the property system 220 * and the field retains whatever value it was given by instance_init). 221 * @defval: default value for the property. This is used only if @set_default 222 * is true. 223 */ 224 struct Property { 225 const char *name; 226 const PropertyInfo *info; 227 ptrdiff_t offset; 228 uint8_t bitnr; 229 bool set_default; 230 union { 231 int64_t i; 232 uint64_t u; 233 } defval; 234 int arrayoffset; 235 const PropertyInfo *arrayinfo; 236 int arrayfieldsize; 237 const char *link_type; 238 }; 239 240 struct PropertyInfo { 241 const char *name; 242 const char *description; 243 const QEnumLookup *enum_table; 244 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len); 245 void (*set_default_value)(Object *obj, const Property *prop); 246 void (*create)(Object *obj, Property *prop, Error **errp); 247 ObjectPropertyAccessor *get; 248 ObjectPropertyAccessor *set; 249 ObjectPropertyRelease *release; 250 }; 251 252 /** 253 * GlobalProperty: 254 * @used: Set to true if property was used when initializing a device. 255 * @optional: If set to true, GlobalProperty will be skipped without errors 256 * if the property doesn't exist. 257 * 258 * An error is fatal for non-hotplugged devices, when the global is applied. 259 */ 260 typedef struct GlobalProperty { 261 const char *driver; 262 const char *property; 263 const char *value; 264 bool used; 265 bool optional; 266 } GlobalProperty; 267 268 static inline void 269 compat_props_add(GPtrArray *arr, 270 GlobalProperty props[], size_t nelem) 271 { 272 int i; 273 for (i = 0; i < nelem; i++) { 274 g_ptr_array_add(arr, (void *)&props[i]); 275 } 276 } 277 278 /*** Board API. This should go away once we have a machine config file. ***/ 279 280 DeviceState *qdev_create(BusState *bus, const char *name); 281 DeviceState *qdev_try_create(BusState *bus, const char *name); 282 void qdev_init_nofail(DeviceState *dev); 283 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id, 284 int required_for_version); 285 HotplugHandler *qdev_get_bus_hotplug_handler(DeviceState *dev); 286 HotplugHandler *qdev_get_machine_hotplug_handler(DeviceState *dev); 287 /** 288 * qdev_get_hotplug_handler: Get handler responsible for device wiring 289 * 290 * Find HOTPLUG_HANDLER for @dev that provides [pre|un]plug callbacks for it. 291 * 292 * Note: in case @dev has a parent bus, it will be returned as handler unless 293 * machine handler overrides it. 294 * 295 * Returns: pointer to object that implements TYPE_HOTPLUG_HANDLER interface 296 * or NULL if there aren't any. 297 */ 298 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev); 299 void qdev_unplug(DeviceState *dev, Error **errp); 300 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev, 301 DeviceState *dev, Error **errp); 302 void qdev_machine_creation_done(void); 303 bool qdev_machine_modified(void); 304 305 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n); 306 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n); 307 308 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin); 309 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n, 310 qemu_irq pin); 311 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n); 312 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt, 313 const char *name, int n); 314 315 BusState *qdev_get_child_bus(DeviceState *dev, const char *name); 316 317 /*** Device API. ***/ 318 319 /* Register device properties. */ 320 /* GPIO inputs also double as IRQ sinks. */ 321 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n); 322 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n); 323 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins, 324 const char *name, int n); 325 /** 326 * qdev_init_gpio_in_named_with_opaque: create an array of input GPIO lines 327 * for the specified device 328 * 329 * @dev: Device to create input GPIOs for 330 * @handler: Function to call when GPIO line value is set 331 * @opaque: Opaque data pointer to pass to @handler 332 * @name: Name of the GPIO input (must be unique for this device) 333 * @n: Number of GPIO lines in this input set 334 */ 335 void qdev_init_gpio_in_named_with_opaque(DeviceState *dev, 336 qemu_irq_handler handler, 337 void *opaque, 338 const char *name, int n); 339 340 /** 341 * qdev_init_gpio_in_named: create an array of input GPIO lines 342 * for the specified device 343 * 344 * Like qdev_init_gpio_in_named_with_opaque(), but the opaque pointer 345 * passed to the handler is @dev (which is the most commonly desired behaviour). 346 */ 347 static inline void qdev_init_gpio_in_named(DeviceState *dev, 348 qemu_irq_handler handler, 349 const char *name, int n) 350 { 351 qdev_init_gpio_in_named_with_opaque(dev, handler, dev, name, n); 352 } 353 354 void qdev_pass_gpios(DeviceState *dev, DeviceState *container, 355 const char *name); 356 357 BusState *qdev_get_parent_bus(DeviceState *dev); 358 359 /*** BUS API. ***/ 360 361 DeviceState *qdev_find_recursive(BusState *bus, const char *id); 362 363 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */ 364 typedef int (qbus_walkerfn)(BusState *bus, void *opaque); 365 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque); 366 367 void qbus_create_inplace(void *bus, size_t size, const char *typename, 368 DeviceState *parent, const char *name); 369 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name); 370 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion, 371 * < 0 if either devfn or busfn terminate walk somewhere in cursion, 372 * 0 otherwise. */ 373 int qbus_walk_children(BusState *bus, 374 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, 375 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, 376 void *opaque); 377 int qdev_walk_children(DeviceState *dev, 378 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, 379 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, 380 void *opaque); 381 382 void qdev_reset_all(DeviceState *dev); 383 void qdev_reset_all_fn(void *opaque); 384 385 /** 386 * @qbus_reset_all: 387 * @bus: Bus to be reset. 388 * 389 * Reset @bus and perform a bus-level ("hard") reset of all devices connected 390 * to it, including recursive processing of all buses below @bus itself. A 391 * hard reset means that qbus_reset_all will reset all state of the device. 392 * For PCI devices, for example, this will include the base address registers 393 * or configuration space. 394 */ 395 void qbus_reset_all(BusState *bus); 396 void qbus_reset_all_fn(void *opaque); 397 398 /* This should go away once we get rid of the NULL bus hack */ 399 BusState *sysbus_get_default(void); 400 401 char *qdev_get_fw_dev_path(DeviceState *dev); 402 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev); 403 404 /** 405 * @qdev_machine_init 406 * 407 * Initialize platform devices before machine init. This is a hack until full 408 * support for composition is added. 409 */ 410 void qdev_machine_init(void); 411 412 /** 413 * @device_reset 414 * 415 * Reset a single device (by calling the reset method). 416 */ 417 void device_reset(DeviceState *dev); 418 419 void device_class_set_parent_reset(DeviceClass *dc, 420 DeviceReset dev_reset, 421 DeviceReset *parent_reset); 422 void device_class_set_parent_realize(DeviceClass *dc, 423 DeviceRealize dev_realize, 424 DeviceRealize *parent_realize); 425 void device_class_set_parent_unrealize(DeviceClass *dc, 426 DeviceUnrealize dev_unrealize, 427 DeviceUnrealize *parent_unrealize); 428 429 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev); 430 431 const char *qdev_fw_name(DeviceState *dev); 432 433 Object *qdev_get_machine(void); 434 435 /* FIXME: make this a link<> */ 436 void qdev_set_parent_bus(DeviceState *dev, BusState *bus); 437 438 extern bool qdev_hotplug; 439 extern bool qdev_hot_removed; 440 441 char *qdev_get_dev_path(DeviceState *dev); 442 443 GSList *qdev_build_hotpluggable_device_list(Object *peripheral); 444 445 void qbus_set_hotplug_handler(BusState *bus, Object *handler, Error **errp); 446 447 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp); 448 449 static inline bool qbus_is_hotpluggable(BusState *bus) 450 { 451 return bus->hotplug_handler; 452 } 453 454 void device_listener_register(DeviceListener *listener); 455 void device_listener_unregister(DeviceListener *listener); 456 457 VMChangeStateEntry *qdev_add_vm_change_state_handler(DeviceState *dev, 458 VMChangeStateHandler *cb, 459 void *opaque); 460 461 #endif 462