hw/qdev.h

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