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