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