hw/qdev.h

   1 #ifndef QDEV_H
   2 #define QDEV_H
   3
   4 #include "hw.h"
   5 #include "sysemu.h"
   6 #include "sys-queue.h"
   7 #include "qemu-option.h"
   8
   9 typedef struct Property Property;
  10
  11 typedef struct PropertyInfo PropertyInfo;
  12
  13 typedef struct CompatProperty CompatProperty;
  14
  15 typedef struct DeviceInfo DeviceInfo;
  16
  17 typedef struct BusState BusState;
  18
  19 typedef struct BusInfo BusInfo;
  20
  21 /* This structure should not be accessed directly.  We declare it here
  22    so that it can be embedded in individual device state structures.  */
  23 struct DeviceState {
  24     const char *id;
  25     DeviceInfo *info;
  26     BusState *parent_bus;
  27     int num_gpio_out;
  28     qemu_irq *gpio_out;
  29     int num_gpio_in;
  30     qemu_irq *gpio_in;
  31     LIST_HEAD(, BusState) child_bus;
  32     int num_child_bus;
  33     NICInfo *nd;
  34     LIST_ENTRY(DeviceState) sibling;
  35 };
  36
  37 typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent);
  38 struct BusInfo {
  39     const char *name;
  40     size_t size;
  41     bus_dev_printfn print_dev;
  42     Property *props;
  43 };
  44
  45 struct BusState {
  46     DeviceState *parent;
  47     BusInfo *info;
  48     const char *name;
  49     LIST_HEAD(, DeviceState) children;
  50     LIST_ENTRY(BusState) sibling;
  51 };
  52
  53 struct Property {
  54     const char   *name;
  55     PropertyInfo *info;
  56     int          offset;
  57     void         *defval;
  58 };
  59
  60 enum PropertyType {
  61     PROP_TYPE_UNSPEC = 0,
  62     PROP_TYPE_UINT16,
  63     PROP_TYPE_UINT32,
  64     PROP_TYPE_UINT64,
  65     PROP_TYPE_TADDR,
  66     PROP_TYPE_MACADDR,
  67     PROP_TYPE_DRIVE,
  68     PROP_TYPE_PTR,
  69 };
  70
  71 struct PropertyInfo {
  72     const char *name;
  73     size_t size;
  74     enum PropertyType type;
  75     int (*parse)(DeviceState *dev, Property *prop, const char *str);
  76     int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
  77 };
  78
  79 struct CompatProperty {
  80     const char *driver;
  81     const char *property;
  82     const char *value;
  83 };
  84
  85 /*** Board API.  This should go away once we have a machine config file.  ***/
  86
  87 DeviceState *qdev_create(BusState *bus, const char *name);
  88 DeviceState *qdev_device_add(QemuOpts *opts);
  89 void qdev_init(DeviceState *dev);
  90 void qdev_free(DeviceState *dev);
  91
  92 qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
  93 void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
  94
  95 BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
  96
  97 /*** Device API.  ***/
  98
  99 typedef void (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
 100 typedef void (*SCSIAttachFn)(DeviceState *host, BlockDriverState *bdrv,
 101               int unit);
 102
 103 struct DeviceInfo {
 104     const char *name;
 105     const char *alias;
 106     const char *desc;
 107     size_t size;
 108     Property *props;
 109     int no_user;
 110
 111     /* Private to qdev / bus.  */
 112     qdev_initfn init;
 113     BusInfo *bus_info;
 114     struct DeviceInfo *next;
 115 };
 116
 117 void qdev_register(DeviceInfo *info);
 118
 119 /* Register device properties.  */
 120 /* GPIO inputs also double as IRQ sinks.  */
 121 void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
 122 void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
 123
 124 void scsi_bus_new(DeviceState *host, SCSIAttachFn attach);
 125
 126 CharDriverState *qdev_init_chardev(DeviceState *dev);
 127
 128 BusState *qdev_get_parent_bus(DeviceState *dev);
 129
 130 /* Convery from a base type to a parent type, with compile time checking.  */
 131 #ifdef __GNUC__
 132 #define DO_UPCAST(type, field, dev) ( __extension__ ( { \
 133     char __attribute__((unused)) offset_must_be_zero[ \
 134         -offsetof(type, field)]; \
 135     container_of(dev, type, field);}))
 136 #else
 137 #define DO_UPCAST(type, field, dev) container_of(dev, type, field)
 138 #endif
 139
 140 /*** BUS API. ***/
 141
 142 BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
 143
 144 #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
 145
 146 /*** monitor commands ***/
 147
 148 void do_info_qtree(Monitor *mon);
 149 void do_info_qdrv(Monitor *mon);
 150
 151 /*** qdev-properties.c ***/
 152
 153 extern PropertyInfo qdev_prop_uint16;
 154 extern PropertyInfo qdev_prop_uint32;
 155 extern PropertyInfo qdev_prop_uint64;
 156 extern PropertyInfo qdev_prop_hex32;
 157 extern PropertyInfo qdev_prop_hex64;
 158 extern PropertyInfo qdev_prop_ptr;
 159 extern PropertyInfo qdev_prop_macaddr;
 160 extern PropertyInfo qdev_prop_drive;
 161 extern PropertyInfo qdev_prop_pci_devfn;
 162
 163 #define typeof_field(type, field) typeof(((type *)0)->field)
 164 #define type_check(t1,t2) ((t1*)0 - (t2*)0)
 165
 166 #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
 167         .name      = (_name),                                    \
 168         .info      = &(_prop),                                   \
 169         .offset    = offsetof(_state, _field)                    \
 170             + type_check(_type,typeof_field(_state, _field)),    \
 171         }
 172 #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
 173         .name      = (_name),                                           \
 174         .info      = &(_prop),                                          \
 175         .offset    = offsetof(_state, _field)                           \
 176             + type_check(_type,typeof_field(_state, _field)),           \
 177         .defval    = (_type[]) { _defval },                             \
 178         }
 179
 180 #define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
 181     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
 182 #define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
 183     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
 184 #define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
 185     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
 186 #define DEFINE_PROP_HEX32(_n, _s, _f, _d)                       \
 187     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
 188 #define DEFINE_PROP_HEX64(_n, _s, _f, _d)                       \
 189     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
 190 #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
 191     DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
 192
 193 #define DEFINE_PROP_PTR(_n, _s, _f)             \
 194     DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
 195 #define DEFINE_PROP_MACADDR(_n, _s, _f)         \
 196     DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, uint8_t[6])
 197
 198 #define DEFINE_PROP_END_OF_LIST()               \
 199     {}
 200
 201 /* Set properties between creation and init.  */
 202 void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
 203 int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
 204 void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type);
 205 void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
 206 void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
 207 void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
 208 void qdev_prop_set_drive(DeviceState *dev, const char *name, DriveInfo *value);
 209 /* FIXME: Remove opaque pointer properties.  */
 210 void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
 211 void qdev_prop_set_defaults(DeviceState *dev, Property *props);
 212
 213 void qdev_prop_register_compat(CompatProperty *props);
 214 void qdev_prop_set_compat(DeviceState *dev);
 215
 216 /* This is a nasty hack to allow passing a NULL bus to qdev_create.  */
 217 extern struct BusInfo system_bus_info;
 218
 219 #endif