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