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