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