/tools/qemu-xen/hw/qdev.h
C Header | 332 lines | 256 code | 51 blank | 25 comment | 0 complexity | f231e13fa8d41610f2a557d6bf65e18f MD5 | raw file
- #ifndef QDEV_H
- #define QDEV_H
- #include "hw.h"
- #include "qemu-queue.h"
- #include "qemu-char.h"
- #include "qemu-option.h"
- typedef struct Property Property;
- typedef struct PropertyInfo PropertyInfo;
- typedef struct CompatProperty CompatProperty;
- typedef struct DeviceInfo DeviceInfo;
- typedef struct BusState BusState;
- typedef struct BusInfo BusInfo;
- enum DevState {
- DEV_STATE_CREATED = 1,
- DEV_STATE_INITIALIZED,
- };
- enum {
- DEV_NVECTORS_UNSPECIFIED = -1,
- };
- /* This structure should not be accessed directly. We declare it here
- so that it can be embedded in individual device state structures. */
- struct DeviceState {
- const char *id;
- enum DevState state;
- QemuOpts *opts;
- int hotplugged;
- DeviceInfo *info;
- BusState *parent_bus;
- int num_gpio_out;
- qemu_irq *gpio_out;
- int num_gpio_in;
- qemu_irq *gpio_in;
- QLIST_HEAD(, BusState) child_bus;
- int num_child_bus;
- QTAILQ_ENTRY(DeviceState) sibling;
- int instance_id_alias;
- int alias_required_for_version;
- };
- typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent);
- typedef char *(*bus_get_dev_path)(DeviceState *dev);
- /*
- * This callback is used to create Open Firmware device path in accordance with
- * OF spec http://forthworks.com/standards/of1275.pdf. Indicidual bus bindings
- * can be found here http://playground.sun.com/1275/bindings/.
- */
- typedef char *(*bus_get_fw_dev_path)(DeviceState *dev);
- typedef int (qbus_resetfn)(BusState *bus);
- struct BusInfo {
- const char *name;
- size_t size;
- bus_dev_printfn print_dev;
- bus_get_dev_path get_dev_path;
- bus_get_fw_dev_path get_fw_dev_path;
- qbus_resetfn *reset;
- Property *props;
- };
- struct BusState {
- DeviceState *parent;
- BusInfo *info;
- const char *name;
- int allow_hotplug;
- int qdev_allocated;
- QTAILQ_HEAD(ChildrenHead, DeviceState) children;
- QLIST_ENTRY(BusState) sibling;
- };
- struct Property {
- const char *name;
- PropertyInfo *info;
- int offset;
- int bitnr;
- void *defval;
- };
- enum PropertyType {
- PROP_TYPE_UNSPEC = 0,
- PROP_TYPE_UINT8,
- PROP_TYPE_UINT16,
- PROP_TYPE_UINT32,
- PROP_TYPE_INT32,
- PROP_TYPE_UINT64,
- PROP_TYPE_TADDR,
- PROP_TYPE_MACADDR,
- PROP_TYPE_DRIVE,
- PROP_TYPE_CHR,
- PROP_TYPE_STRING,
- PROP_TYPE_NETDEV,
- PROP_TYPE_VLAN,
- PROP_TYPE_PTR,
- PROP_TYPE_BIT,
- };
- struct PropertyInfo {
- const char *name;
- size_t size;
- enum PropertyType type;
- int (*parse)(DeviceState *dev, Property *prop, const char *str);
- int (*print)(DeviceState *dev, Property *prop, char *dest, size_t len);
- void (*free)(DeviceState *dev, Property *prop);
- };
- typedef struct GlobalProperty {
- const char *driver;
- const char *property;
- const char *value;
- QTAILQ_ENTRY(GlobalProperty) next;
- } GlobalProperty;
- /*** Board API. This should go away once we have a machine config file. ***/
- DeviceState *qdev_create(BusState *bus, const char *name);
- DeviceState *qdev_try_create(BusState *bus, const char *name);
- int qdev_device_help(QemuOpts *opts);
- DeviceState *qdev_device_add(QemuOpts *opts);
- int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
- void qdev_init_nofail(DeviceState *dev);
- void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
- int required_for_version);
- int qdev_unplug(DeviceState *dev);
- void qdev_free(DeviceState *dev);
- int qdev_simple_unplug_cb(DeviceState *dev);
- void qdev_machine_creation_done(void);
- bool qdev_machine_modified(void);
- qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
- void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
- BusState *qdev_get_child_bus(DeviceState *dev, const char *name);
- /*** Device API. ***/
- typedef int (*qdev_initfn)(DeviceState *dev, DeviceInfo *info);
- typedef int (*qdev_event)(DeviceState *dev);
- typedef void (*qdev_resetfn)(DeviceState *dev);
- struct DeviceInfo {
- const char *name;
- const char *fw_name;
- const char *alias;
- const char *desc;
- size_t size;
- Property *props;
- int no_user;
- /* callbacks */
- qdev_resetfn reset;
- /* device state */
- const VMStateDescription *vmsd;
- /* Private to qdev / bus. */
- qdev_initfn init;
- qdev_event unplug;
- qdev_event exit;
- BusInfo *bus_info;
- struct DeviceInfo *next;
- };
- extern DeviceInfo *device_info_list;
- void qdev_register(DeviceInfo *info);
- /* Register device properties. */
- /* GPIO inputs also double as IRQ sinks. */
- void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
- void qdev_init_gpio_out(DeviceState *dev, qemu_irq *pins, int n);
- CharDriverState *qdev_init_chardev(DeviceState *dev);
- BusState *qdev_get_parent_bus(DeviceState *dev);
- /*** BUS API. ***/
- DeviceState *qdev_find_recursive(BusState *bus, const char *id);
- /* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
- typedef int (qbus_walkerfn)(BusState *bus, void *opaque);
- typedef int (qdev_walkerfn)(DeviceState *dev, void *opaque);
- void qbus_create_inplace(BusState *bus, BusInfo *info,
- DeviceState *parent, const char *name);
- BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
- /* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
- * < 0 if either devfn or busfn terminate walk somewhere in cursion,
- * 0 otherwise. */
- int qbus_walk_children(BusState *bus, qdev_walkerfn *devfn,
- qbus_walkerfn *busfn, void *opaque);
- int qdev_walk_children(DeviceState *dev, qdev_walkerfn *devfn,
- qbus_walkerfn *busfn, void *opaque);
- void qdev_reset_all(DeviceState *dev);
- void qbus_reset_all_fn(void *opaque);
- void qbus_free(BusState *bus);
- #define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
- /* This should go away once we get rid of the NULL bus hack */
- BusState *sysbus_get_default(void);
- /*** monitor commands ***/
- void do_info_qtree(Monitor *mon);
- void do_info_qdm(Monitor *mon);
- int do_device_add(Monitor *mon, const QDict *qdict, QObject **ret_data);
- int do_device_del(Monitor *mon, const QDict *qdict, QObject **ret_data);
- /*** qdev-properties.c ***/
- extern PropertyInfo qdev_prop_bit;
- extern PropertyInfo qdev_prop_uint8;
- extern PropertyInfo qdev_prop_uint16;
- extern PropertyInfo qdev_prop_uint32;
- extern PropertyInfo qdev_prop_int32;
- extern PropertyInfo qdev_prop_uint64;
- extern PropertyInfo qdev_prop_hex8;
- extern PropertyInfo qdev_prop_hex32;
- extern PropertyInfo qdev_prop_hex64;
- extern PropertyInfo qdev_prop_string;
- extern PropertyInfo qdev_prop_chr;
- extern PropertyInfo qdev_prop_ptr;
- extern PropertyInfo qdev_prop_macaddr;
- extern PropertyInfo qdev_prop_drive;
- extern PropertyInfo qdev_prop_netdev;
- extern PropertyInfo qdev_prop_vlan;
- extern PropertyInfo qdev_prop_pci_devfn;
- #define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
- .name = (_name), \
- .info = &(_prop), \
- .offset = offsetof(_state, _field) \
- + type_check(_type,typeof_field(_state, _field)), \
- }
- #define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
- .name = (_name), \
- .info = &(_prop), \
- .offset = offsetof(_state, _field) \
- + type_check(_type,typeof_field(_state, _field)), \
- .defval = (_type[]) { _defval }, \
- }
- #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) { \
- .name = (_name), \
- .info = &(qdev_prop_bit), \
- .bitnr = (_bit), \
- .offset = offsetof(_state, _field) \
- + type_check(uint32_t,typeof_field(_state, _field)), \
- .defval = (bool[]) { (_defval) }, \
- }
- #define DEFINE_PROP_UINT8(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
- #define DEFINE_PROP_UINT16(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
- #define DEFINE_PROP_UINT32(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
- #define DEFINE_PROP_INT32(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
- #define DEFINE_PROP_UINT64(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
- #define DEFINE_PROP_HEX8(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t)
- #define DEFINE_PROP_HEX32(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
- #define DEFINE_PROP_HEX64(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
- #define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \
- DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
- #define DEFINE_PROP_PTR(_n, _s, _f) \
- DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
- #define DEFINE_PROP_CHR(_n, _s, _f) \
- DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
- #define DEFINE_PROP_STRING(_n, _s, _f) \
- DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
- #define DEFINE_PROP_NETDEV(_n, _s, _f) \
- DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
- #define DEFINE_PROP_VLAN(_n, _s, _f) \
- DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
- #define DEFINE_PROP_DRIVE(_n, _s, _f) \
- DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
- #define DEFINE_PROP_MACADDR(_n, _s, _f) \
- DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
- #define DEFINE_PROP_END_OF_LIST() \
- {}
- /* Set properties between creation and init. */
- void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
- int qdev_prop_exists(DeviceState *dev, const char *name);
- int qdev_prop_parse(DeviceState *dev, const char *name, const char *value);
- void qdev_prop_set(DeviceState *dev, const char *name, void *src, enum PropertyType type);
- void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value);
- void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
- void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
- void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
- void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
- void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
- void qdev_prop_set_string(DeviceState *dev, const char *name, char *value);
- void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
- void qdev_prop_set_netdev(DeviceState *dev, const char *name, VLANClientState *value);
- void qdev_prop_set_vlan(DeviceState *dev, const char *name, VLANState *value);
- int qdev_prop_set_drive(DeviceState *dev, const char *name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT;
- void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name, BlockDriverState *value);
- void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
- /* FIXME: Remove opaque pointer properties. */
- void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);
- void qdev_prop_set_defaults(DeviceState *dev, Property *props);
- void qdev_prop_register_global_list(GlobalProperty *props);
- void qdev_prop_set_globals(DeviceState *dev);
- static inline const char *qdev_fw_name(DeviceState *dev)
- {
- return dev->info->fw_name ? : dev->info->alias ? : dev->info->name;
- }
- char *qdev_get_fw_dev_path(DeviceState *dev);
- /* This is a nasty hack to allow passing a NULL bus to qdev_create. */
- extern struct BusInfo system_bus_info;
- #endif