hw/qdev.h

   1 #ifndef QDEV_H
   2 #define QDEV_H
   3
   4 #include "hw.h"
   5 #include "sysemu.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 };
 102
 103 typedef struct GlobalProperty {
 104     const char *driver;
 105     const char *property;
 106     const char *value;
 107     QTAILQ_ENTRY(GlobalProperty) next;
 108 } GlobalProperty;
 109
 110 /*** Board API.  This should go away once we have a machine config file.  ***/
 111
 112 DeviceState *qdev_create(BusState *bus, const char *name);
 113 int qdev_device_help(QemuOpts *opts);
 114 DeviceState *qdev_device_add(QemuOpts *opts);
 115 int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
 116 void qdev_init_nofail(DeviceState *dev);
 117 void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
 118                                  int required_for_version);
 119 int qdev_unplug(DeviceState *dev);
 120 void qdev_free(DeviceState *dev);
 121 int qdev_simple_unplug_cb(DeviceState *dev);
 122 void qdev_machine_creation_done(void);
 123
 124 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
 125 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
 126
 127 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
 128
 129 /*** Device API.  ***/
 130
 131 typedef int (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
 132 typedef int (*qdev_event)(DeviceState *dev);
 133 typedef void (*qdev_resetfn)(DeviceState *dev);
 134
 135 struct DeviceInfo {
 136     const char *name;
 137     const char *alias;
 138     const char *desc;
 139     size_t size;
 140     Property *props;
 141     int no_user;
 142
 143     /* callbacks */
 144     qdev_resetfn reset;
 145
 146     /* device state */
 147     const VMStateDescription *vmsd;
 148
 149     /* Private to qdev / bus.  */
 150     qdev_initfn init;
 151     qdev_event unplug;
 152     qdev_event exit;
 153     BusInfo *bus_info;
 154     struct DeviceInfo *next;
 155 };
 156 extern DeviceInfo *device_info_list;
 157
 158 void qdev_register(DeviceInfo *info);
 159
 160 /* Register device properties.  */
 161 /* GPIO inputs also double as IRQ sinks.  */
 162 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 163 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 164
 165 CharDriverState *qdev_init_chardev(DeviceState *dev);
 166
 167 BusState *qdev_get_parent_bus(DeviceState *dev);
 168
 169 /*** BUS API. ***/
 170
 171 void qbus_create_inplace(BusState *bus, BusInfo *info,
 172                          DeviceState *parent, const char *name);
 173 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
 174 void qbus_free(BusState *bus);
 175
 176 #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
 177
 178 /*** monitor commands ***/
 179
 180 void do_info_qtree(Monitor *mon);
 181 void do_info_qdm(Monitor *mon);
 182 int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data);
 183 int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data);
 184
 185 /*** qdev-properties.c ***/
 186
 187 extern PropertyInfo qdev_prop_bit;
 188 extern PropertyInfo qdev_prop_uint8;
 189 extern PropertyInfo qdev_prop_uint16;
 190 extern PropertyInfo qdev_prop_uint32;
 191 extern PropertyInfo qdev_prop_int32;
 192 extern PropertyInfo qdev_prop_uint64;
 193 extern PropertyInfo qdev_prop_hex32;
 194 extern PropertyInfo qdev_prop_hex64;
 195 extern PropertyInfo qdev_prop_string;
 196 extern PropertyInfo qdev_prop_chr;
 197 extern PropertyInfo qdev_prop_ptr;
 198 extern PropertyInfo qdev_prop_macaddr;
 199 extern PropertyInfo qdev_prop_drive;
 200 extern PropertyInfo qdev_prop_netdev;
 201 extern PropertyInfo qdev_prop_vlan;
 202 extern PropertyInfo qdev_prop_pci_devfn;
 203
 204 #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
 205         .name      = (_name),                                    \
 206         .info      = &(_prop),                                   \
 207         .offset    = offsetof(_state, _field)                    \
 208             + type_check(_type,typeof_field(_state, _field)),    \
 209         }
 210 #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
 211         .name      = (_name),                                           \
 212         .info      = &(_prop),                                          \
 213         .offset    = offsetof(_state, _field)                           \
 214             + type_check(_type,typeof_field(_state, _field)),           \
 215         .defval    = (_type[]) { _defval },                             \
 216         }
 217 #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) {  \
 218         .name      = (_name),                                    \
 219         .info      = &(qdev_prop_bit),                           \
 220         .bitnr    = (_bit),                                      \
 221         .offset    = offsetof(_state, _field)                    \
 222             + type_check(uint32_t,typeof_field(_state, _field)), \
 223         .defval    = (bool[]) { (_defval) },                     \
 224         }
 225
 226 #define DEFINE_PROP_UINT8(_n, _s, _f, _d)                       \
 227     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
 228 #define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
 229     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
 230 #define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
 231     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
 232 #define DEFINE_PROP_INT32(_n, _s, _f, _d)                      \
 233     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
 234 #define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
 235     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
 236 #define DEFINE_PROP_HEX32(_n, _s, _f, _d)                       \
 237     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
 238 #define DEFINE_PROP_HEX64(_n, _s, _f, _d)                       \
 239     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
 240 #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
 241     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
 242
 243 #define DEFINE_PROP_PTR(_n, _s, _f)             \
 244     DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
 245 #define DEFINE_PROP_CHR(_n, _s, _f)             \
 246     DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
 247 #define DEFINE_PROP_STRING(_n, _s, _f)             \
 248     DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
 249 #define DEFINE_PROP_NETDEV(_n, _s, _f)             \
 250     DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
 251 #define DEFINE_PROP_VLAN(_n, _s, _f)             \
 252     DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
 253 #define DEFINE_PROP_DRIVE(_n, _s, _f)             \
 254     DEFINE_PROP(_n, _s, _f, qdev_prop_drive, DriveInfo*)
 255 #define DEFINE_PROP_MACADDR(_n, _s, _f)         \
 256     DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
 257
 258 #define DEFINE_PROP_END_OF_LIST()               \
 259     {}
 260
 261 /* Set properties between creation and init.  */
 262 void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
 263 int qdev_prop_exists(DeviceState *dev, const char *name);
 264 int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
 265 void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type);
 266 void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
 267 void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
 268 void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
 269 void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
 270 void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
 271 void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
 272 void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value);
 273 void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value);
 274 void qdev_prop_set_drive(DeviceState *dev, const char *name, DriveInfo *value);
 275 void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
 276 /* FIXME: Remove opaque pointer properties.  */
 277 void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
 278 void qdev_prop_set_defaults(DeviceState *dev, Property *props);
 279
 280 void qdev_prop_register_global_list(GlobalProperty *props);
 281 void qdev_prop_set_globals(DeviceState *dev);
 282
 283 /* This is a nasty hack to allow passing a NULL bus to qdev_create.  */
 284 extern struct BusInfo system_bus_info;
 285
 286 #endif