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