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