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