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