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