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