hw/qdev.h

   1 #ifndef QDEV_H
   2 #define QDEV_H
   3
   4 #include "hw.h"
   5 #include "qemu-queue.h"
   6 #include "qemu-char.h"
   7 #include "qemu-option.h"
   8 #include "qapi/qapi-visit-core.h"
   9 #include "qemu/object.h"
  10 #include "error.h"
  11
  12 typedef struct Property Property;
  13
  14 typedef struct PropertyInfo PropertyInfo;
  15
  16 typedef struct CompatProperty CompatProperty;
  17
  18 typedef struct BusState BusState;
  19
  20 typedef struct BusClass BusClass;
  21
  22 enum DevState {
  23     DEV_STATE_CREATED = 1,
  24     DEV_STATE_INITIALIZED,
  25 };
  26
  27 enum {
  28     DEV_NVECTORS_UNSPECIFIED = -1,
  29 };
  30
  31 #define TYPE_DEVICE "device"
  32 #define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
  33 #define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
  34 #define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
  35
  36 typedef int (*qdev_initfn)(DeviceState *dev);
  37 typedef int (*qdev_event)(DeviceState *dev);
  38 typedef void (*qdev_resetfn)(DeviceState *dev);
  39
  40 typedef struct DeviceClass {
  41     ObjectClass parent_class;
  42
  43     const char *fw_name;
  44     const char *desc;
  45     Property *props;
  46     int no_user;
  47
  48     /* callbacks */
  49     void (*reset)(DeviceState *dev);
  50
  51     /* device state */
  52     const VMStateDescription *vmsd;
  53
  54     /* Private to qdev / bus.  */
  55     qdev_initfn init;
  56     qdev_event unplug;
  57     qdev_event exit;
  58     const char *bus_type;
  59 } DeviceClass;
  60
  61 /* This structure should not be accessed directly.  We declare it here
  62    so that it can be embedded in individual device state structures.  */
  63 struct DeviceState {
  64     Object parent_obj;
  65
  66     const char *id;
  67     enum DevState state;
  68     QemuOpts *opts;
  69     int hotplugged;
  70     BusState *parent_bus;
  71     int num_gpio_out;
  72     qemu_irq *gpio_out;
  73     int num_gpio_in;
  74     qemu_irq *gpio_in;
  75     QLIST_HEAD(, BusState) child_bus;
  76     int num_child_bus;
  77     int instance_id_alias;
  78     int alias_required_for_version;
  79 };
  80
  81 /*
  82  * This callback is used to create Open Firmware device path in accordance with
  83  * OF spec http://forthworks.com/standards/of1275.pdf. Indicidual bus bindings
  84  * can be found here http://playground.sun.com/1275/bindings/.
  85  */
  86
  87 #define TYPE_BUS "bus"
  88 #define BUS(obj) OBJECT_CHECK(BusState, (obj), TYPE_BUS)
  89 #define BUS_CLASS(klass) OBJECT_CLASS_CHECK(BusClass, (klass), TYPE_BUS)
  90 #define BUS_GET_CLASS(obj) OBJECT_GET_CLASS(BusClass, (obj), TYPE_BUS)
  91
  92 struct BusClass {
  93     ObjectClass parent_class;
  94
  95     /* FIXME first arg should be BusState */
  96     void (*print_dev)(Monitor *mon, DeviceState *dev, int indent);
  97     char *(*get_dev_path)(DeviceState *dev);
  98     char *(*get_fw_dev_path)(DeviceState *dev);
  99     int (*reset)(BusState *bus);
 100 };
 101
 102 typedef struct BusChild {
 103     DeviceState *child;
 104     int index;
 105     QTAILQ_ENTRY(BusChild) sibling;
 106 } BusChild;
 107
 108 /**
 109  * BusState:
 110  * @qom_allocated: Indicates whether the object was allocated by QOM.
 111  * @glib_allocated: Indicates whether the object was initialized in-place
 112  * yet is expected to be freed with g_free().
 113  */
 114 struct BusState {
 115     Object obj;
 116     DeviceState *parent;
 117     const char *name;
 118     int allow_hotplug;
 119     bool qom_allocated;
 120     bool glib_allocated;
 121     int max_index;
 122     QTAILQ_HEAD(ChildrenHead, BusChild) children;
 123     QLIST_ENTRY(BusState) sibling;
 124 };
 125
 126 struct Property {
 127     const char   *name;
 128     PropertyInfo *info;
 129     int          offset;
 130     uint8_t      bitnr;
 131     uint8_t      qtype;
 132     int64_t      defval;
 133 };
 134
 135 struct PropertyInfo {
 136     const char *name;
 137     const char *legacy_name;
 138     const char **enum_table;
 139     int (*parse)(DeviceState *dev, Property *prop, const char *str);
 140     int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
 141     ObjectPropertyAccessor *get;
 142     ObjectPropertyAccessor *set;
 143     ObjectPropertyRelease *release;
 144 };
 145
 146 typedef struct GlobalProperty {
 147     const char *driver;
 148     const char *property;
 149     const char *value;
 150     QTAILQ_ENTRY(GlobalProperty) next;
 151 } GlobalProperty;
 152
 153 /*** Board API.  This should go away once we have a machine config file.  ***/
 154
 155 DeviceState *qdev_create(BusState *bus, const char *name);
 156 DeviceState *qdev_try_create(BusState *bus, const char *name);
 157 bool qdev_exists(const char *name);
 158 int qdev_device_help(QemuOpts *opts);
 159 DeviceState *qdev_device_add(QemuOpts *opts);
 160 int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
 161 void qdev_init_nofail(DeviceState *dev);
 162 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
 163                                  int required_for_version);
 164 void qdev_unplug(DeviceState *dev, Error **errp);
 165 void qdev_free(DeviceState *dev);
 166 int qdev_simple_unplug_cb(DeviceState *dev);
 167 void qdev_machine_creation_done(void);
 168 bool qdev_machine_modified(void);
 169
 170 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
 171 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 172
 173 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
 174
 175 /*** Device API.  ***/
 176
 177 /* Register device properties.  */
 178 /* GPIO inputs also double as IRQ sinks.  */
 179 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 180 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 181
 182 BusState *qdev_get_parent_bus(DeviceState *dev);
 183
 184 /*** BUS API. ***/
 185
 186 DeviceState *qdev_find_recursive(BusState *bus, const char *id);
 187
 188 /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
 189 typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
 190 typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
 191
 192 void qbus_create_inplace(BusState *bus, const char *typename,
 193                          DeviceState *parent, const char *name);
 194 BusState *qbus_create(const char *typename, DeviceState *parent, const char *name);
 195 /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
 196  *         < 0 if either devfn or busfn terminate walk somewhere in cursion,
 197  *           0 otherwise. */
 198 int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
 199                        qbus_walkerfn *busfn, void *opaque);
 200 int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
 201                        qbus_walkerfn *busfn, void *opaque);
 202 void qdev_reset_all(DeviceState *dev);
 203 void qbus_reset_all_fn(void *opaque);
 204
 205 void qbus_free(BusState *bus);
 206
 207 #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
 208
 209 /* This should go away once we get rid of the NULL bus hack */
 210 BusState *sysbus_get_default(void);
 211
 212 /*** monitor commands ***/
 213
 214 void do_info_qtree(Monitor *mon);
 215 void do_info_qdm(Monitor *mon);
 216 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data);
 217 int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data);
 218
 219 /*** qdev-properties.c ***/
 220
 221 extern PropertyInfo qdev_prop_bit;
 222 extern PropertyInfo qdev_prop_uint8;
 223 extern PropertyInfo qdev_prop_uint16;
 224 extern PropertyInfo qdev_prop_uint32;
 225 extern PropertyInfo qdev_prop_int32;
 226 extern PropertyInfo qdev_prop_uint64;
 227 extern PropertyInfo qdev_prop_hex8;
 228 extern PropertyInfo qdev_prop_hex32;
 229 extern PropertyInfo qdev_prop_hex64;
 230 extern PropertyInfo qdev_prop_string;
 231 extern PropertyInfo qdev_prop_chr;
 232 extern PropertyInfo qdev_prop_ptr;
 233 extern PropertyInfo qdev_prop_macaddr;
 234 extern PropertyInfo qdev_prop_losttickpolicy;
 235 extern PropertyInfo qdev_prop_drive;
 236 extern PropertyInfo qdev_prop_netdev;
 237 extern PropertyInfo qdev_prop_vlan;
 238 extern PropertyInfo qdev_prop_pci_devfn;
 239 extern PropertyInfo qdev_prop_blocksize;
 240
 241 #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
 242         .name      = (_name),                                    \
 243         .info      = &(_prop),                                   \
 244         .offset    = offsetof(_state, _field)                    \
 245             + type_check(_type,typeof_field(_state, _field)),    \
 246         }
 247 #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
 248         .name      = (_name),                                           \
 249         .info      = &(_prop),                                          \
 250         .offset    = offsetof(_state, _field)                           \
 251             + type_check(_type,typeof_field(_state, _field)),           \
 252         .qtype     = QTYPE_QINT,                                        \
 253         .defval    = (_type)_defval,                                    \
 254         }
 255 #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) {  \
 256         .name      = (_name),                                    \
 257         .info      = &(qdev_prop_bit),                           \
 258         .bitnr    = (_bit),                                      \
 259         .offset    = offsetof(_state, _field)                    \
 260             + type_check(uint32_t,typeof_field(_state, _field)), \
 261         .qtype     = QTYPE_QBOOL,                                \
 262         .defval    = (bool)_defval,                              \
 263         }
 264
 265 #define DEFINE_PROP_UINT8(_n, _s, _f, _d)                       \
 266     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
 267 #define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
 268     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
 269 #define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
 270     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
 271 #define DEFINE_PROP_INT32(_n, _s, _f, _d)                      \
 272     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
 273 #define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
 274     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
 275 #define DEFINE_PROP_HEX8(_n, _s, _f, _d)                       \
 276     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t)
 277 #define DEFINE_PROP_HEX32(_n, _s, _f, _d)                       \
 278     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
 279 #define DEFINE_PROP_HEX64(_n, _s, _f, _d)                       \
 280     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
 281 #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
 282     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, int32_t)
 283
 284 #define DEFINE_PROP_PTR(_n, _s, _f)             \
 285     DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
 286 #define DEFINE_PROP_CHR(_n, _s, _f)             \
 287     DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
 288 #define DEFINE_PROP_STRING(_n, _s, _f)             \
 289     DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
 290 #define DEFINE_PROP_NETDEV(_n, _s, _f)             \
 291     DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
 292 #define DEFINE_PROP_VLAN(_n, _s, _f)             \
 293     DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
 294 #define DEFINE_PROP_DRIVE(_n, _s, _f) \
 295     DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
 296 #define DEFINE_PROP_MACADDR(_n, _s, _f)         \
 297     DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
 298 #define DEFINE_PROP_LOSTTICKPOLICY(_n, _s, _f, _d) \
 299     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
 300                         LostTickPolicy)
 301 #define DEFINE_PROP_BLOCKSIZE(_n, _s, _f, _d) \
 302     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_blocksize, uint16_t)
 303
 304 #define DEFINE_PROP_END_OF_LIST()               \
 305     {}
 306
 307 /* Set properties between creation and init.  */
 308 void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
 309 int qdev_prop_exists(DeviceState *dev, const char *name);
 310 int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
 311 void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value);
 312 void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
 313 void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
 314 void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
 315 void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
 316 void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
 317 void qdev_prop_set_string(DeviceState *dev, const char *name, char *value);
 318 void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
 319 void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value);
 320 void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value);
 321 int qdev_prop_set_drive(DeviceState *dev, const char *name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT;
 322 void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name, BlockDriverState *value);
 323 void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
 324 void qdev_prop_set_enum(DeviceState *dev, const char *name, int value);
 325 /* FIXME: Remove opaque pointer properties.  */
 326 void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
 327
 328 void qdev_prop_register_global_list(GlobalProperty *props);
 329 void qdev_prop_set_globals(DeviceState *dev);
 330 void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev,
 331                                     Property *prop, const char *value);
 332
 333 char *qdev_get_fw_dev_path(DeviceState *dev);
 334
 335 /**
 336  * @qdev_property_add_static - add a @Property to a device referencing a
 337  * field in a struct.
 338  */
 339 void qdev_property_add_static(DeviceState *dev, Property *prop, Error **errp);
 340
 341 /**
 342  * @qdev_machine_init
 343  *
 344  * Initialize platform devices before machine init.  This is a hack until full
 345  * support for composition is added.
 346  */
 347 void qdev_machine_init(void);
 348
 349 /**
 350  * @device_reset
 351  *
 352  * Reset a single device (by calling the reset method).
 353  */
 354 void device_reset(DeviceState *dev);
 355
 356 const VMStateDescription *qdev_get_vmsd(DeviceState *dev);
 357
 358 const char *qdev_fw_name(DeviceState *dev);
 359
 360 Object *qdev_get_machine(void);
 361
 362 /* FIXME: make this a link<> */
 363 void qdev_set_parent_bus(DeviceState *dev, BusState *bus);
 364
 365 extern int qdev_hotplug;
 366
 367 char *qdev_get_dev_path(DeviceState *dev);
 368
 369 #endif