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 (*qdev_resetfn)(DeviceState *dev); 36 typedef void (*DeviceRealize)(DeviceState *dev, Error **errp); 37 typedef void (*DeviceUnrealize)(DeviceState *dev, Error **errp); 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 void (*reset)(DeviceState *dev); 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 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 struct Property { 225 const char *name; 226 PropertyInfo *info; 227 ptrdiff_t offset; 228 uint8_t bitnr; 229 QType qtype; 230 int64_t defval; 231 int arrayoffset; 232 PropertyInfo *arrayinfo; 233 int arrayfieldsize; 234 }; 235 236 struct PropertyInfo { 237 const char *name; 238 const char *description; 239 const char * const *enum_table; 240 int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len); 241 ObjectPropertyAccessor *get; 242 ObjectPropertyAccessor *set; 243 ObjectPropertyRelease *release; 244 }; 245 246 /** 247 * GlobalProperty: 248 * @user_provided: Set to true if property comes from user-provided config 249 * (command-line or config file). 250 * @used: Set to true if property was used when initializing a device. 251 * @errp: Error destination, used like first argument of error_setg() 252 * in case property setting fails later. If @errp is NULL, we 253 * print warnings instead of ignoring errors silently. For 254 * hotplugged devices, errp is always ignored and warnings are 255 * printed instead. 256 */ 257 typedef struct GlobalProperty { 258 const char *driver; 259 const char *property; 260 const char *value; 261 bool user_provided; 262 bool used; 263 Error **errp; 264 } GlobalProperty; 265 266 /*** Board API. This should go away once we have a machine config file. ***/ 267 268 DeviceState *qdev_create(BusState *bus, const char *name); 269 DeviceState *qdev_try_create(BusState *bus, const char *name); 270 void qdev_init_nofail(DeviceState *dev); 271 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id, 272 int required_for_version); 273 HotplugHandler *qdev_get_hotplug_handler(DeviceState *dev); 274 void qdev_unplug(DeviceState *dev, Error **errp); 275 void qdev_simple_device_unplug_cb(HotplugHandler *hotplug_dev, 276 DeviceState *dev, Error **errp); 277 void qdev_machine_creation_done(void); 278 bool qdev_machine_modified(void); 279 280 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n); 281 qemu_irq qdev_get_gpio_in_named(DeviceState *dev, const char *name, int n); 282 283 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin); 284 void qdev_connect_gpio_out_named(DeviceState *dev, const char *name, int n, 285 qemu_irq pin); 286 qemu_irq qdev_get_gpio_out_connector(DeviceState *dev, const char *name, int n); 287 qemu_irq qdev_intercept_gpio_out(DeviceState *dev, qemu_irq icpt, 288 const char *name, int n); 289 290 BusState *qdev_get_child_bus(DeviceState *dev, const char *name); 291 292 /*** Device API. ***/ 293 294 /* Register device properties. */ 295 /* GPIO inputs also double as IRQ sinks. */ 296 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n); 297 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n); 298 void qdev_init_gpio_in_named(DeviceState *dev, qemu_irq_handler handler, 299 const char *name, int n); 300 void qdev_init_gpio_out_named(DeviceState *dev, qemu_irq *pins, 301 const char *name, int n); 302 303 void qdev_pass_gpios(DeviceState *dev, DeviceState *container, 304 const char *name); 305 306 BusState *qdev_get_parent_bus(DeviceState *dev); 307 308 /*** BUS API. ***/ 309 310 DeviceState *qdev_find_recursive(BusState *bus, const char *id); 311 312 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */ 313 typedef int (qbus_walkerfn)(BusState *bus, void *opaque); 314 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque); 315 316 void qbus_create_inplace(void *bus, size_t size, const char *typename, 317 DeviceState *parent, const char *name); 318 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name); 319 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion, 320 * < 0 if either devfn or busfn terminate walk somewhere in cursion, 321 * 0 otherwise. */ 322 int qbus_walk_children(BusState *bus, 323 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, 324 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, 325 void *opaque); 326 int qdev_walk_children(DeviceState *dev, 327 qdev_walkerfn *pre_devfn, qbus_walkerfn *pre_busfn, 328 qdev_walkerfn *post_devfn, qbus_walkerfn *post_busfn, 329 void *opaque); 330 331 void qdev_reset_all(DeviceState *dev); 332 void qdev_reset_all_fn(void *opaque); 333 334 /** 335 * @qbus_reset_all: 336 * @bus: Bus to be reset. 337 * 338 * Reset @bus and perform a bus-level ("hard") reset of all devices connected 339 * to it, including recursive processing of all buses below @bus itself. A 340 * hard reset means that qbus_reset_all will reset all state of the device. 341 * For PCI devices, for example, this will include the base address registers 342 * or configuration space. 343 */ 344 void qbus_reset_all(BusState *bus); 345 void qbus_reset_all_fn(void *opaque); 346 347 /* This should go away once we get rid of the NULL bus hack */ 348 BusState *sysbus_get_default(void); 349 350 char *qdev_get_fw_dev_path(DeviceState *dev); 351 char *qdev_get_own_fw_dev_path_from_handler(BusState *bus, DeviceState *dev); 352 353 /** 354 * @qdev_machine_init 355 * 356 * Initialize platform devices before machine init. This is a hack until full 357 * support for composition is added. 358 */ 359 void qdev_machine_init(void); 360 361 /** 362 * @device_reset 363 * 364 * Reset a single device (by calling the reset method). 365 */ 366 void device_reset(DeviceState *dev); 367 368 const struct VMStateDescription *qdev_get_vmsd(DeviceState *dev); 369 370 const char *qdev_fw_name(DeviceState *dev); 371 372 Object *qdev_get_machine(void); 373 374 /* FIXME: make this a link<> */ 375 void qdev_set_parent_bus(DeviceState *dev, BusState *bus); 376 377 extern bool qdev_hotplug; 378 extern bool qdev_hot_removed; 379 380 char *qdev_get_dev_path(DeviceState *dev); 381 382 GSList *qdev_build_hotpluggable_device_list(Object *peripheral); 383 384 void qbus_set_hotplug_handler(BusState *bus, DeviceState *handler, 385 Error **errp); 386 387 void qbus_set_bus_hotplug_handler(BusState *bus, Error **errp); 388 389 static inline bool qbus_is_hotpluggable(BusState *bus) 390 { 391 return bus->hotplug_handler; 392 } 393 394 void device_listener_register(DeviceListener *listener); 395 void device_listener_unregister(DeviceListener *listener); 396 397 #endif 398