[qemu.git] / hw / qdev.h

#ifndef QDEV_H
#define QDEV_H

#include "hw.h"
#include "qemu-queue.h"
#include "qemu-char.h"
#include "qemu-option.h"
#include "qapi/qapi-visit-core.h"
#include "qemu/object.h"

typedef struct Property Property;

typedef struct PropertyInfo PropertyInfo;

typedef struct CompatProperty CompatProperty;

typedef struct BusState BusState;

typedef struct BusInfo BusInfo;

enum DevState {
    DEV_STATE_CREATED = 1,
    DEV_STATE_INITIALIZED,
};

enum {
    DEV_NVECTORS_UNSPECIFIED = -1,
};

#define TYPE_DEVICE "device"
#define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
#define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
#define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)

typedef int (*qdev_initfn)(DeviceState *dev);
typedef int (*qdev_event)(DeviceState *dev);
typedef void (*qdev_resetfn)(DeviceState *dev);

typedef struct DeviceClass {
    ObjectClass parent_class;

    const char *fw_name;
    const char *desc;
    Property *props;
    int no_user;

    /* callbacks */
    void (*reset)(DeviceState *dev);

    /* device state */
    const VMStateDescription *vmsd;

    /* Private to qdev / bus.  */
    qdev_initfn init;
    qdev_event unplug;
    qdev_event exit;
    BusInfo *bus_info;
} DeviceClass;

/* This structure should not be accessed directly.  We declare it here
   so that it can be embedded in individual device state structures.  */
struct DeviceState {
    Object parent_obj;

    const char *id;
    enum DevState state;
    QemuOpts *opts;
    int hotplugged;
    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_LOSTTICKPOLICY,
    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;
    const char *legacy_name;
    size_t size;
    enum PropertyType type;
    int64_t min;
    int64_t max;
    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);
    ObjectPropertyAccessor *get;
    ObjectPropertyAccessor *set;
};

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);
bool qdev_exists(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.  ***/

/* 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);

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_losttickpolicy;
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_LOSTTICKPOLICY(_n, _s, _f, _d) \
    DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
                        LostTickPolicy)

#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);
void qdev_prop_set_losttickpolicy(DeviceState *dev, const char *name,
                                  LostTickPolicy *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);
void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev,
                                    Property *prop, const char *value);

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;

/**
 * @qdev_property_add_static - add a @Property to a device referencing a
 * field in a struct.
 */
void qdev_property_add_static(DeviceState *dev, Property *prop, Error **errp);

/**
 * @qdev_machine_init
 *
 * Initialize platform devices before machine init.  This is a hack until full
 * support for composition is added.
 */
void qdev_machine_init(void);

/**
 * @device_reset
 *
 * Reset a single device (by calling the reset method).
 */
void device_reset(DeviceState *dev);

const VMStateDescription *qdev_get_vmsd(DeviceState *dev);

const char *qdev_fw_name(DeviceState *dev);

BusInfo *qdev_get_bus_info(DeviceState *dev);

Property *qdev_get_props(DeviceState *dev);

/* FIXME: make this a link<> */
void qdev_set_parent_bus(DeviceState *dev, BusState *bus);

extern int qdev_hotplug;

#endif
Commit	Line	Data
aae9460e PB	1	#ifndef QDEV_H
	2	#define QDEV_H
	3
	4	#include "hw.h"
72cf2d4f	5	#include "qemu-queue.h"
313feaab	6	#include "qemu-char.h"
f31d07d1	7	#include "qemu-option.h"
44677ded	8	#include "qapi/qapi-visit-core.h"
32fea402	9	#include "qemu/object.h"
aae9460e	10
ee6847d1 GH	11	typedef struct Property Property;
	12
	13	typedef struct PropertyInfo PropertyInfo;
aae9460e	14
b6b61144 GH	15	typedef struct CompatProperty CompatProperty;
b6b61144 GH	16
02e2da45	17	typedef struct BusState BusState;
4d6ae674	18
10c4c98a GH	19	typedef struct BusInfo BusInfo;
10c4c98a GH	20
131ec1bd GH	21	enum DevState {
	22	DEV_STATE_CREATED = 1,
	23	DEV_STATE_INITIALIZED,
	24	};
	25
75422b0d AS	26	enum {
	27	DEV_NVECTORS_UNSPECIFIED = -1,
	28	};
	29
32fea402 AL	30	#define TYPE_DEVICE "device"
32fea402 AL	31	#define DEVICE(obj) OBJECT_CHECK(DeviceState, (obj), TYPE_DEVICE)
30fbb9fc AL	32	#define DEVICE_CLASS(klass) OBJECT_CLASS_CHECK(DeviceClass, (klass), TYPE_DEVICE)
30fbb9fc AL	33	#define DEVICE_GET_CLASS(obj) OBJECT_GET_CLASS(DeviceClass, (obj), TYPE_DEVICE)
32fea402	34
d307af79	35	typedef int (qdev_initfn)(DeviceState dev);
6e008585 AL	36	typedef int (qdev_event)(DeviceState dev);
	37	typedef void (qdev_resetfn)(DeviceState dev);
	38
32fea402 AL	39	typedef struct DeviceClass {
32fea402 AL	40	ObjectClass parent_class;
6e008585 AL	41
6e008585 AL	42	const char *fw_name;
6e008585 AL	43	const char *desc;
	44	Property *props;
	45	int no_user;
	46
	47	/* callbacks */
94afdadc	48	void (reset)(DeviceState dev);
6e008585 AL	49
	50	/* device state */
	51	const VMStateDescription *vmsd;
	52
	53	/* Private to qdev / bus. */
	54	qdev_initfn init;
	55	qdev_event unplug;
	56	qdev_event exit;
	57	BusInfo *bus_info;
32fea402 AL	58	} DeviceClass;
32fea402 AL	59
aae9460e PB	60	/* This structure should not be accessed directly. We declare it here
aae9460e PB	61	so that it can be embedded in individual device state structures. */
02e2da45	62	struct DeviceState {
32fea402 AL	63	Object parent_obj;
32fea402 AL	64
f31d07d1	65	const char *id;
131ec1bd	66	enum DevState state;
ef80b466	67	QemuOpts *opts;
3418bd25	68	int hotplugged;
02e2da45	69	BusState *parent_bus;
aae9460e PB	70	int num_gpio_out;
	71	qemu_irq *gpio_out;
	72	int num_gpio_in;
	73	qemu_irq *gpio_in;
72cf2d4f	74	QLIST_HEAD(, BusState) child_bus;
d271de9f	75	int num_child_bus;
d8bb00d6	76	QTAILQ_ENTRY(DeviceState) sibling;
4d2ffa08 JK	77	int instance_id_alias;
4d2ffa08 JK	78	int alias_required_for_version;
02e2da45 PB	79	};
02e2da45 PB	80
10c4c98a	81	typedef void (bus_dev_printfn)(Monitor mon, DeviceState *dev, int indent);
6772b936	82	typedef char (bus_get_dev_path)(DeviceState *dev);
21150814 GN	83	/*
	84	* This callback is used to create Open Firmware device path in accordance with
	85	* OF spec http://forthworks.com/standards/of1275.pdf. Indicidual bus bindings
	86	* can be found here http://playground.sun.com/1275/bindings/.
	87	*/
	88	typedef char (bus_get_fw_dev_path)(DeviceState *dev);
b4694b7c	89	typedef int (qbus_resetfn)(BusState *bus);
6772b936	90
10c4c98a GH	91	struct BusInfo {
	92	const char *name;
	93	size_t size;
	94	bus_dev_printfn print_dev;
6772b936	95	bus_get_dev_path get_dev_path;
21150814	96	bus_get_fw_dev_path get_fw_dev_path;
b4694b7c	97	qbus_resetfn *reset;
ee6847d1	98	Property *props;
10c4c98a	99	};
02e2da45 PB	100
	101	struct BusState {
	102	DeviceState *parent;
10c4c98a	103	BusInfo *info;
02e2da45	104	const char *name;
3418bd25	105	int allow_hotplug;
cd739fb6	106	int qdev_allocated;
f48a7a6e	107	QTAILQ_HEAD(ChildrenHead, DeviceState) children;
72cf2d4f	108	QLIST_ENTRY(BusState) sibling;
aae9460e PB	109	};
aae9460e PB	110
ee6847d1 GH	111	struct Property {
	112	const char *name;
	113	PropertyInfo *info;
	114	int offset;
d2364ee4	115	int bitnr;
ee6847d1 GH	116	void *defval;
	117	};
	118
	119	enum PropertyType {
	120	PROP_TYPE_UNSPEC = 0,
c7cc172d	121	PROP_TYPE_UINT8,
ee6847d1 GH	122	PROP_TYPE_UINT16,
ee6847d1 GH	123	PROP_TYPE_UINT32,
316940b0	124	PROP_TYPE_INT32,
5a053d1f	125	PROP_TYPE_UINT64,
ee6847d1 GH	126	PROP_TYPE_TADDR,
ee6847d1 GH	127	PROP_TYPE_MACADDR,
4e4fa398	128	PROP_TYPE_LOSTTICKPOLICY,
14b41872	129	PROP_TYPE_DRIVE,
313feaab	130	PROP_TYPE_CHR,
59419663	131	PROP_TYPE_STRING,
2ef924b4	132	PROP_TYPE_NETDEV,
851bec09	133	PROP_TYPE_VLAN,
ee6847d1	134	PROP_TYPE_PTR,
d2364ee4	135	PROP_TYPE_BIT,
ee6847d1 GH	136	};
	137
	138	struct PropertyInfo {
	139	const char *name;
cafe5bdb	140	const char *legacy_name;
ee6847d1 GH	141	size_t size;
ee6847d1 GH	142	enum PropertyType type;
80e555c2 PB	143	int64_t min;
80e555c2 PB	144	int64_t max;
ee6847d1 GH	145	int (parse)(DeviceState dev, Property prop, const char str);
ee6847d1 GH	146	int (print)(DeviceState dev, Property prop, char dest, size_t len);
d21357df	147	void (free)(DeviceState dev, Property *prop);
57c9fafe AL	148	ObjectPropertyAccessor *get;
57c9fafe AL	149	ObjectPropertyAccessor *set;
ee6847d1 GH	150	};
ee6847d1 GH	151
458fb679	152	typedef struct GlobalProperty {
b6b61144 GH	153	const char *driver;
	154	const char *property;
	155	const char *value;
458fb679 GH	156	QTAILQ_ENTRY(GlobalProperty) next;
458fb679 GH	157	} GlobalProperty;
b6b61144	158
aae9460e PB	159	/* Board API. This should go away once we have a machine config file. */
aae9460e PB	160
02e2da45	161	DeviceState qdev_create(BusState bus, const char *name);
0bcdeda7	162	DeviceState qdev_try_create(BusState bus, const char *name);
a369da5f	163	bool qdev_exists(const char *name);
ff952ba2	164	int qdev_device_help(QemuOpts *opts);
f31d07d1	165	DeviceState qdev_device_add(QemuOpts opts);
747bbdf7	166	int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
e23a1b33	167	void qdev_init_nofail(DeviceState *dev);
4d2ffa08 JK	168	void qdev_set_legacy_instance_id(DeviceState *dev, int alias_id,
4d2ffa08 JK	169	int required_for_version);
3418bd25	170	int qdev_unplug(DeviceState *dev);
02e2da45	171	void qdev_free(DeviceState *dev);
3418bd25 GH	172	int qdev_simple_unplug_cb(DeviceState *dev);
3418bd25 GH	173	void qdev_machine_creation_done(void);
0ac8ef71	174	bool qdev_machine_modified(void);
aae9460e	175
aae9460e PB	176	qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
	177	void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
	178
02e2da45	179	BusState qdev_get_child_bus(DeviceState dev, const char *name);
4d6ae674	180
aae9460e PB	181	/* Device API. */
aae9460e PB	182
aae9460e	183	/* Register device properties. */
067a3ddc	184	/* GPIO inputs also double as IRQ sinks. */
aae9460e PB	185	void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
	186	void qdev_init_gpio_out(DeviceState dev, qemu_irq pins, int n);
	187
02e2da45	188	BusState qdev_get_parent_bus(DeviceState dev);
aae9460e	189
02e2da45 PB	190	/* BUS API. */
02e2da45 PB	191
a2ee6b4f IY	192	DeviceState qdev_find_recursive(BusState bus, const char *id);
a2ee6b4f IY	193
81699d8a AL	194	/* Returns 0 to walk children, > 0 to skip walk, < 0 to terminate walk. */
	195	typedef int (qbus_walkerfn)(BusState bus, void opaque);
	196	typedef int (qdev_walkerfn)(DeviceState dev, void opaque);
	197
cd739fb6 GH	198	void qbus_create_inplace(BusState bus, BusInfo info,
cd739fb6 GH	199	DeviceState parent, const char name);
10c4c98a	200	BusState qbus_create(BusInfo info, DeviceState parent, const char name);
81699d8a AL	201	/* Returns > 0 if either devfn or busfn skip walk somewhere in cursion,
	202	* < 0 if either devfn or busfn terminate walk somewhere in cursion,
	203	* 0 otherwise. */
	204	int qbus_walk_children(BusState bus, qdev_walkerfn devfn,
	205	qbus_walkerfn busfn, void opaque);
	206	int qdev_walk_children(DeviceState dev, qdev_walkerfn devfn,
	207	qbus_walkerfn busfn, void opaque);
5af0a04b	208	void qdev_reset_all(DeviceState *dev);
80376c3f IY	209	void qbus_reset_all_fn(void *opaque);
80376c3f IY	210
131ec1bd	211	void qbus_free(BusState *bus);
02e2da45 PB	212
	213	#define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
	214
ec990eb6 AL	215	/* This should go away once we get rid of the NULL bus hack */
	216	BusState *sysbus_get_default(void);
	217
cae4956e GH	218	/* monitor commands */
	219
	220	void do_info_qtree(Monitor *mon);
f6c64e0e	221	void do_info_qdm(Monitor *mon);
8bc27249	222	int do_device_add(Monitor mon, const QDict qdict, QObject **ret_data);
17a38eaa	223	int do_device_del(Monitor mon, const QDict qdict, QObject **ret_data);
cae4956e	224
ee6847d1 GH	225	/* qdev-properties.c */
ee6847d1 GH	226
d2364ee4	227	extern PropertyInfo qdev_prop_bit;
c7cc172d	228	extern PropertyInfo qdev_prop_uint8;
ee6847d1 GH	229	extern PropertyInfo qdev_prop_uint16;
ee6847d1 GH	230	extern PropertyInfo qdev_prop_uint32;
316940b0	231	extern PropertyInfo qdev_prop_int32;
5a053d1f	232	extern PropertyInfo qdev_prop_uint64;
6835678c	233	extern PropertyInfo qdev_prop_hex8;
ee6847d1	234	extern PropertyInfo qdev_prop_hex32;
5a053d1f	235	extern PropertyInfo qdev_prop_hex64;
59419663	236	extern PropertyInfo qdev_prop_string;
313feaab	237	extern PropertyInfo qdev_prop_chr;
ee6847d1 GH	238	extern PropertyInfo qdev_prop_ptr;
ee6847d1 GH	239	extern PropertyInfo qdev_prop_macaddr;
4e4fa398	240	extern PropertyInfo qdev_prop_losttickpolicy;
14b41872	241	extern PropertyInfo qdev_prop_drive;
851bec09 GH	242	extern PropertyInfo qdev_prop_netdev;
851bec09 GH	243	extern PropertyInfo qdev_prop_vlan;
05cb5fe4	244	extern PropertyInfo qdev_prop_pci_devfn;
ee6847d1	245
cf12b95b GH	246	#define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
	247	.name = (_name), \
	248	.info = &(_prop), \
	249	.offset = offsetof(_state, _field) \
	250	+ type_check(_type,typeof_field(_state, _field)), \
	251	}
	252	#define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
	253	.name = (_name), \
	254	.info = &(_prop), \
	255	.offset = offsetof(_state, _field) \
	256	+ type_check(_type,typeof_field(_state, _field)), \
	257	.defval = (_type[]) { _defval }, \
	258	}
d2364ee4 MT	259	#define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) { \
	260	.name = (_name), \
	261	.info = &(qdev_prop_bit), \
	262	.bitnr = (_bit), \
	263	.offset = offsetof(_state, _field) \
	264	+ type_check(uint32_t,typeof_field(_state, _field)), \
	265	.defval = (bool[]) { (_defval) }, \
	266	}
cf12b95b	267
c7cc172d JQ	268	#define DEFINE_PROP_UINT8(_n, _s, _f, _d) \
c7cc172d JQ	269	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
cf12b95b GH	270	#define DEFINE_PROP_UINT16(_n, _s, _f, _d) \
	271	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
	272	#define DEFINE_PROP_UINT32(_n, _s, _f, _d) \
	273	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
316940b0 GH	274	#define DEFINE_PROP_INT32(_n, _s, _f, _d) \
316940b0 GH	275	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
cf12b95b GH	276	#define DEFINE_PROP_UINT64(_n, _s, _f, _d) \
cf12b95b GH	277	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
6835678c JK	278	#define DEFINE_PROP_HEX8(_n, _s, _f, _d) \
6835678c JK	279	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex8, uint8_t)
cf12b95b GH	280	#define DEFINE_PROP_HEX32(_n, _s, _f, _d) \
	281	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
	282	#define DEFINE_PROP_HEX64(_n, _s, _f, _d) \
	283	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
	284	#define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \
	285	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
	286
	287	#define DEFINE_PROP_PTR(_n, _s, _f) \
	288	DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
313feaab GH	289	#define DEFINE_PROP_CHR(_n, _s, _f) \
313feaab GH	290	DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
59419663 GH	291	#define DEFINE_PROP_STRING(_n, _s, _f) \
59419663 GH	292	DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
2ef924b4 GH	293	#define DEFINE_PROP_NETDEV(_n, _s, _f) \
2ef924b4 GH	294	DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, VLANClientState*)
851bec09 GH	295	#define DEFINE_PROP_VLAN(_n, _s, _f) \
851bec09 GH	296	DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, VLANState*)
f8b6cc00 MA	297	#define DEFINE_PROP_DRIVE(_n, _s, _f) \
f8b6cc00 MA	298	DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockDriverState *)
cf12b95b	299	#define DEFINE_PROP_MACADDR(_n, _s, _f) \
1503fff3	300	DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
4e4fa398 JK	301	#define DEFINE_PROP_LOSTTICKPOLICY(_n, _s, _f, _d) \
	302	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
	303	LostTickPolicy)
cf12b95b GH	304
	305	#define DEFINE_PROP_END_OF_LIST() \
	306	{}
	307
ee6847d1 GH	308	/* Set properties between creation and init. */
ee6847d1 GH	309	void qdev_get_prop_ptr(DeviceState dev, Property *prop);
d8ed79ae	310	int qdev_prop_exists(DeviceState dev, const char name);
ee6847d1 GH	311	int qdev_prop_parse(DeviceState dev, const char name, const char *value);
ee6847d1 GH	312	void qdev_prop_set(DeviceState dev, const char name, void *src, enum PropertyType type);
f4594a3b	313	void qdev_prop_set_bit(DeviceState dev, const char name, bool value);
c7cc172d	314	void qdev_prop_set_uint8(DeviceState dev, const char name, uint8_t value);
ee6847d1 GH	315	void qdev_prop_set_uint16(DeviceState dev, const char name, uint16_t value);
ee6847d1 GH	316	void qdev_prop_set_uint32(DeviceState dev, const char name, uint32_t value);
316940b0	317	void qdev_prop_set_int32(DeviceState dev, const char name, int32_t value);
5a053d1f	318	void qdev_prop_set_uint64(DeviceState dev, const char name, uint64_t value);
cc984673	319	void qdev_prop_set_string(DeviceState dev, const char name, char *value);
313feaab	320	void qdev_prop_set_chr(DeviceState dev, const char name, CharDriverState *value);
2ef924b4	321	void qdev_prop_set_netdev(DeviceState dev, const char name, VLANClientState *value);
851bec09	322	void qdev_prop_set_vlan(DeviceState dev, const char name, VLANState *value);
18846dee MA	323	int qdev_prop_set_drive(DeviceState dev, const char name, BlockDriverState *value) QEMU_WARN_UNUSED_RESULT;
18846dee MA	324	void qdev_prop_set_drive_nofail(DeviceState dev, const char name, BlockDriverState *value);
1503fff3	325	void qdev_prop_set_macaddr(DeviceState dev, const char name, uint8_t *value);
4e4fa398 JK	326	void qdev_prop_set_losttickpolicy(DeviceState dev, const char name,
4e4fa398 JK	327	LostTickPolicy *value);
ee6847d1 GH	328	/* FIXME: Remove opaque pointer properties. */
	329	void qdev_prop_set_ptr(DeviceState dev, const char name, void *value);
	330	void qdev_prop_set_defaults(DeviceState dev, Property props);
	331
458fb679 GH	332	void qdev_prop_register_global_list(GlobalProperty *props);
458fb679 GH	333	void qdev_prop_set_globals(DeviceState *dev);
7db4c4e8 PB	334	void error_set_from_qdev_prop_error(Error *errp, int ret, DeviceState dev,
7db4c4e8 PB	335	Property prop, const char value);
b6b61144	336
1ca4d09a	337	char qdev_get_fw_dev_path(DeviceState dev);
4be9f0d1	338
a9ff9df1 BS	339	/* This is a nasty hack to allow passing a NULL bus to qdev_create. */
	340	extern struct BusInfo system_bus_info;
	341
a5296ca9	342	/**
ca2cc788 PB	343	* @qdev_property_add_static - add a @Property to a device referencing a
ca2cc788 PB	344	* field in a struct.
a5296ca9	345	*/
ca2cc788	346	void qdev_property_add_static(DeviceState dev, Property prop, Error **errp);
a5296ca9	347
1de81d28 AL	348	/**
	349	* @qdev_machine_init
	350	*
	351	* Initialize platform devices before machine init. This is a hack until full
	352	* support for composition is added.
	353	*/
	354	void qdev_machine_init(void);
	355
94afdadc AL	356	/**
	357	* @device_reset
	358	*
	359	* Reset a single device (by calling the reset method).
	360	*/
	361	void device_reset(DeviceState *dev);
	362
4be9f0d1 AL	363	const VMStateDescription qdev_get_vmsd(DeviceState dev);
	364
	365	const char qdev_fw_name(DeviceState dev);
	366
	367	BusInfo qdev_get_bus_info(DeviceState dev);
	368
	369	Property qdev_get_props(DeviceState dev);
	370
9fbe6127 AL	371	/* FIXME: make this a link<> */
	372	void qdev_set_parent_bus(DeviceState dev, BusState bus);
	373
ee46d8a5 AL	374	extern int qdev_hotplug;
ee46d8a5 AL	375
aae9460e	376	#endif