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