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