hw/qdev.h

   1 #ifndef QDEV_H
   2 #define QDEV_H
   3
   4 #include "hw.h"
   5 #include "blockdev.h"
   6 #include "qemu-queue.h"
   7 #include "qemu-char.h"
   8 #include "qemu-option.h"
   9
  10 typedef struct Property Property;
  11
  12 typedef struct PropertyInfo PropertyInfo;
  13
  14 typedef struct CompatProperty CompatProperty;
  15
  16 typedef struct DeviceInfo DeviceInfo;
  17
  18 typedef struct BusState BusState;
  19
  20 typedef struct BusInfo BusInfo;
  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 /* This structure should not be accessed directly.  We declare it here
  32    so that it can be embedded in individual device state structures.  */
  33 struct DeviceState {
  34     const char *id;
  35     enum DevState state;
  36     QemuOpts *opts;
  37     int hotplugged;
  38     DeviceInfo *info;
  39     BusState *parent_bus;
  40     int num_gpio_out;
  41     qemu_irq *gpio_out;
  42     int num_gpio_in;
  43     qemu_irq *gpio_in;
  44     QLIST_HEAD(, BusState) child_bus;
  45     int num_child_bus;
  46     QLIST_ENTRY(DeviceState) sibling;
  47     int instance_id_alias;
  48     int alias_required_for_version;
  49 };
  50
  51 typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent);
  52 struct BusInfo {
  53     const char *name;
  54     size_t size;
  55     bus_dev_printfn print_dev;
  56     Property *props;
  57 };
  58
  59 struct BusState {
  60     DeviceState *parent;
  61     BusInfo *info;
  62     const char *name;
  63     int allow_hotplug;
  64     int qdev_allocated;
  65     QLIST_HEAD(, DeviceState) children;
  66     QLIST_ENTRY(BusState) sibling;
  67 };
  68
  69 struct Property {
  70     const char   *name;
  71     PropertyInfo *info;
  72     int          offset;
  73     int          bitnr;
  74     void         *defval;
  75 };
  76
  77 enum PropertyType {
  78     PROP_TYPE_UNSPEC = 0,
  79     PROP_TYPE_UINT8,
  80     PROP_TYPE_UINT16,
  81     PROP_TYPE_UINT32,
  82     PROP_TYPE_INT32,
  83     PROP_TYPE_UINT64,
  84     PROP_TYPE_TADDR,
  85     PROP_TYPE_MACADDR,
  86     PROP_TYPE_DRIVE,
  87     PROP_TYPE_CHR,
  88     PROP_TYPE_STRING,
  89     PROP_TYPE_NETDEV,
  90     PROP_TYPE_VLAN,
  91     PROP_TYPE_PTR,
  92     PROP_TYPE_BIT,
  93 };
  94
  95 struct PropertyInfo {
  96     const char *name;
  97     size_t size;
  98     enum PropertyType type;
  99     int (*parse)(DeviceState *dev, Property *prop, const char *str);
 100     int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
 101     void (*free)(DeviceState *dev, Property *prop);
 102 };
 103
 104 typedef struct GlobalProperty {
 105     const char *driver;
 106     const char *property;
 107     const char *value;
 108     QTAILQ_ENTRY(GlobalProperty) next;
 109 } GlobalProperty;
 110
 111 /*** Board API.  This should go away once we have a machine config file.  ***/
 112
 113 DeviceState *qdev_create(BusState *bus, const char *name);
 114 int qdev_device_help(QemuOpts *opts);
 115 DeviceState *qdev_device_add(QemuOpts *opts);
 116 int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
 117 void qdev_init_nofail(DeviceState *dev);
 118 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
 119                                  int required_for_version);
 120 int qdev_unplug(DeviceState *dev);
 121 void qdev_free(DeviceState *dev);
 122 int qdev_simple_unplug_cb(DeviceState *dev);
 123 void qdev_machine_creation_done(void);
 124
 125 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
 126 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 127
 128 BlockDriverState *qdev_init_bdrv(DeviceState *dev, BlockInterfaceType type);
 129
 130 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
 131
 132 /*** Device API.  ***/
 133
 134 typedef int (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
 135 typedef int (*qdev_event)(DeviceState *dev);
 136 typedef void (*qdev_resetfn)(DeviceState *dev);
 137
 138 struct DeviceInfo {
 139     const char *name;
 140     const char *alias;
 141     const char *desc;
 142     size_t size;
 143     Property *props;
 144     int no_user;
 145
 146     /* callbacks */
 147     qdev_resetfn reset;
 148
 149     /* device state */
 150     const VMStateDescription *vmsd;
 151
 152     /* Private to qdev / bus.  */
 153     qdev_initfn init;
 154     qdev_event unplug;
 155     qdev_event exit;
 156     BusInfo *bus_info;
 157     struct DeviceInfo *next;
 158 };
 159 extern DeviceInfo *device_info_list;
 160
 161 void qdev_register(DeviceInfo *info);
 162
 163 /* Register device properties.  */
 164 /* GPIO inputs also double as IRQ sinks.  */
 165 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 166 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 167
 168 CharDriverState *qdev_init_chardev(DeviceState *dev);
 169
 170 BusState *qdev_get_parent_bus(DeviceState *dev);
 171
 172 /*** BUS API. ***/
 173
 174 void qbus_create_inplace(BusState *bus, BusInfo *info,
 175                          DeviceState *parent, const char *name);
 176 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
 177 void qbus_free(BusState *bus);
 178
 179 #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
 180
 181 /*** monitor commands ***/
 182
 183 void do_info_qtree(Monitor *mon);
 184 void do_info_qdm(Monitor *mon);
 185 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data);
 186 int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data);
 187
 188 /*** qdev-properties.c ***/
 189
 190 extern PropertyInfo qdev_prop_bit;
 191 extern PropertyInfo qdev_prop_uint8;
 192 extern PropertyInfo qdev_prop_uint16;
 193 extern PropertyInfo qdev_prop_uint32;
 194 extern PropertyInfo qdev_prop_int32;
 195 extern PropertyInfo qdev_prop_uint64;
 196 extern PropertyInfo qdev_prop_hex32;
 197 extern PropertyInfo qdev_prop_hex64;
 198 extern PropertyInfo qdev_prop_string;
 199 extern PropertyInfo qdev_prop_chr;
 200 extern PropertyInfo qdev_prop_ptr;
 201 extern PropertyInfo qdev_prop_macaddr;
 202 extern PropertyInfo qdev_prop_drive;
 203 extern PropertyInfo qdev_prop_netdev;
 204 extern PropertyInfo qdev_prop_vlan;
 205 extern PropertyInfo qdev_prop_pci_devfn;
 206
 207 #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
 208         .name      = (_name),                                    \
 209         .info      = &(_prop),                                   \
 210         .offset    = offsetof(_state, _field)                    \
 211             + type_check(_type,typeof_field(_state, _field)),    \
 212         }
 213 #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
 214         .name      = (_name),                                           \
 215         .info      = &(_prop),                                          \
 216         .offset    = offsetof(_state, _field)                           \
 217             + type_check(_type,typeof_field(_state, _field)),           \
 218         .defval    = (_type[]) { _defval },                             \
 219         }
 220 #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) {  \
 221         .name      = (_name),                                    \
 222         .info      = &(qdev_prop_bit),                           \
 223         .bitnr    = (_bit),                                      \
 224         .offset    = offsetof(_state, _field)                    \
 225             + type_check(uint32_t,typeof_field(_state, _field)), \
 226         .defval    = (bool[]) { (_defval) },                     \
 227         }
 228
 229 #define DEFINE_PROP_UINT8(_n, _s, _f, _d)                       \
 230     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
 231 #define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
 232     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
 233 #define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
 234     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
 235 #define DEFINE_PROP_INT32(_n, _s, _f, _d)                      \
 236     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
 237 #define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
 238     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
 239 #define DEFINE_PROP_HEX32(_n, _s, _f, _d)                       \
 240     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
 241 #define DEFINE_PROP_HEX64(_n, _s, _f, _d)                       \
 242     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
 243 #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
 244     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
 245
 246 #define DEFINE_PROP_PTR(_n, _s, _f)             \
 247     DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
 248 #define DEFINE_PROP_CHR(_n, _s, _f)             \
 249     DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
 250 #define DEFINE_PROP_STRING(_n, _s, _f)             \
 251     DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
 252 #define DEFINE_PROP_NETDEV(_n, _s, _f)             \
 253     DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
 254 #define DEFINE_PROP_VLAN(_n, _s, _f)             \
 255     DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
 256 #define DEFINE_PROP_DRIVE(_n, _s, _f) \
 257     DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
 258 #define DEFINE_PROP_MACADDR(_n, _s, _f)         \
 259     DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
 260
 261 #define DEFINE_PROP_END_OF_LIST()               \
 262     {}
 263
 264 /* Set properties between creation and init.  */
 265 void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
 266 int qdev_prop_exists(DeviceState *dev, const char *name);
 267 int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
 268 void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type);
 269 void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
 270 void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
 271 void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
 272 void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
 273 void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
 274 void qdev_prop_set_string(DeviceState *dev, const char *name, char *value);
 275 void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
 276 void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value);
 277 void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value);
 278 int qdev_prop_set_drive(DeviceState *dev, const char *name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT;
 279 void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name, BlockDriverState *value);
 280 void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
 281 /* FIXME: Remove opaque pointer properties.  */
 282 void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
 283 void qdev_prop_set_defaults(DeviceState *dev, Property *props);
 284
 285 void qdev_prop_register_global_list(GlobalProperty *props);
 286 void qdev_prop_set_globals(DeviceState *dev);
 287
 288 /* This is a nasty hack to allow passing a NULL bus to qdev_create.  */
 289 extern struct BusInfo system_bus_info;
 290
 291 #endif