[mirror_qemu.git] / hw / qdev.h

#ifndef QDEV_H
#define QDEV_H

#include "hw.h"
#include "sysemu.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,
};

/* 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;
    NICInfo *nd;
    QLIST_ENTRY(DeviceState) sibling;
};

typedef void (*bus_dev_printfn)(Monitor *mon, DeviceState *dev, int indent);
struct BusInfo {
    const char *name;
    size_t size;
    bus_dev_printfn print_dev;
    Property *props;
};

struct BusState {
    DeviceState *parent;
    BusInfo *info;
    const char *name;
    int allow_hotplug;
    int qdev_allocated;
    QLIST_HEAD(, DeviceState) children;
    QLIST_ENTRY(BusState) sibling;
};

struct Property {
    const char   *name;
    PropertyInfo *info;
    int          offset;
    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_PTR,
};

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);
};

struct CompatProperty {
    const char *driver;
    const char *property;
    const char *value;
};

/*** Board API.  This should go away once we have a machine config file.  ***/

DeviceState *qdev_create(BusState *bus, const char *name);
DeviceState *qdev_device_add(QemuOpts *opts);
int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
void qdev_init_nofail(DeviceState *dev);
int qdev_unplug(DeviceState *dev);
void qdev_free(DeviceState *dev);
int qdev_simple_unplug_cb(DeviceState *dev);
void qdev_machine_creation_done(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 *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;
};

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

/* Convert from a base type to a parent type, with compile time checking.  */
#ifdef __GNUC__
#define DO_UPCAST(type, field, dev) ( __extension__ ( { \
    char __attribute__((unused)) offset_must_be_zero[ \
        -offsetof(type, field)]; \
    container_of(dev, type, field);}))
#else
#define DO_UPCAST(type, field, dev) container_of(dev, type, field)
#endif

/*** BUS API. ***/

void qbus_create_inplace(BusState *bus, BusInfo *info,
                         DeviceState *parent, const char *name);
BusState *qbus_create(BusInfo *info, DeviceState *parent, const char *name);
void qbus_free(BusState *bus);

#define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)

/*** monitor commands ***/

void do_info_qtree(Monitor *mon);
void do_info_qdm(Monitor *mon);
void do_device_add(Monitor *mon, const QDict *qdict);
void do_device_del(Monitor *mon, const QDict *qdict);

/*** qdev-properties.c ***/

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_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_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_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_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_DRIVE(_n, _s, _f)             \
    DEFINE_PROP(_n, _s, _f, qdev_prop_drive, DriveInfo*)
#define DEFINE_PROP_MACADDR(_n, _s, _f)         \
    DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, uint8_t[6])

#define DEFINE_PROP_END_OF_LIST()               \
    {}

/* Set properties between creation and init.  */
void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
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_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_chr(DeviceState *dev, const char *name, CharDriverState *value);
void qdev_prop_set_drive(DeviceState *dev, const char *name, DriveInfo *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_compat(CompatProperty *props);
void qdev_prop_set_compat(DeviceState *dev);

/* This is a nasty hack to allow passing a NULL bus to qdev_create.  */
extern struct BusInfo system_bus_info;

#endif
Commit	Line	Data
aae9460e PB	1	#ifndef QDEV_H
	2	#define QDEV_H
	3
	4	#include "hw.h"
14b41872	5	#include "sysemu.h"
72cf2d4f	6	#include "qemu-queue.h"
313feaab	7	#include "qemu-char.h"
f31d07d1	8	#include "qemu-option.h"
aae9460e	9
ee6847d1 GH	10	typedef struct Property Property;
	11
	12	typedef struct PropertyInfo PropertyInfo;
aae9460e	13
b6b61144 GH	14	typedef struct CompatProperty CompatProperty;
b6b61144 GH	15
ee6847d1	16	typedef struct DeviceInfo DeviceInfo;
aae9460e	17
02e2da45	18	typedef struct BusState BusState;
4d6ae674	19
10c4c98a GH	20	typedef struct BusInfo BusInfo;
10c4c98a GH	21
131ec1bd GH	22	enum DevState {
	23	DEV_STATE_CREATED = 1,
	24	DEV_STATE_INITIALIZED,
	25	};
	26
aae9460e PB	27	/* This structure should not be accessed directly. We declare it here
aae9460e PB	28	so that it can be embedded in individual device state structures. */
02e2da45	29	struct DeviceState {
f31d07d1	30	const char *id;
131ec1bd	31	enum DevState state;
ef80b466	32	QemuOpts *opts;
3418bd25	33	int hotplugged;
042f84d0	34	DeviceInfo *info;
02e2da45	35	BusState *parent_bus;
aae9460e PB	36	int num_gpio_out;
	37	qemu_irq *gpio_out;
	38	int num_gpio_in;
	39	qemu_irq *gpio_in;
72cf2d4f	40	QLIST_HEAD(, BusState) child_bus;
d271de9f	41	int num_child_bus;
9d07d757	42	NICInfo *nd;
72cf2d4f	43	QLIST_ENTRY(DeviceState) sibling;
02e2da45 PB	44	};
02e2da45 PB	45
10c4c98a GH	46	typedef void (bus_dev_printfn)(Monitor mon, DeviceState *dev, int indent);
	47	struct BusInfo {
	48	const char *name;
	49	size_t size;
	50	bus_dev_printfn print_dev;
ee6847d1	51	Property *props;
10c4c98a	52	};
02e2da45 PB	53
	54	struct BusState {
	55	DeviceState *parent;
10c4c98a	56	BusInfo *info;
02e2da45	57	const char *name;
3418bd25	58	int allow_hotplug;
cd739fb6	59	int qdev_allocated;
72cf2d4f BS	60	QLIST_HEAD(, DeviceState) children;
72cf2d4f BS	61	QLIST_ENTRY(BusState) sibling;
aae9460e PB	62	};
aae9460e PB	63
ee6847d1 GH	64	struct Property {
	65	const char *name;
	66	PropertyInfo *info;
	67	int offset;
	68	void *defval;
	69	};
	70
	71	enum PropertyType {
	72	PROP_TYPE_UNSPEC = 0,
c7cc172d	73	PROP_TYPE_UINT8,
ee6847d1 GH	74	PROP_TYPE_UINT16,
ee6847d1 GH	75	PROP_TYPE_UINT32,
316940b0	76	PROP_TYPE_INT32,
5a053d1f	77	PROP_TYPE_UINT64,
ee6847d1 GH	78	PROP_TYPE_TADDR,
ee6847d1 GH	79	PROP_TYPE_MACADDR,
14b41872	80	PROP_TYPE_DRIVE,
313feaab	81	PROP_TYPE_CHR,
59419663	82	PROP_TYPE_STRING,
ee6847d1 GH	83	PROP_TYPE_PTR,
	84	};
	85
	86	struct PropertyInfo {
	87	const char *name;
	88	size_t size;
	89	enum PropertyType type;
	90	int (parse)(DeviceState dev, Property prop, const char str);
	91	int (print)(DeviceState dev, Property prop, char dest, size_t len);
	92	};
	93
b6b61144 GH	94	struct CompatProperty {
	95	const char *driver;
	96	const char *property;
	97	const char *value;
	98	};
	99
aae9460e PB	100	/* Board API. This should go away once we have a machine config file. */
aae9460e PB	101
02e2da45	102	DeviceState qdev_create(BusState bus, const char *name);
f31d07d1	103	DeviceState qdev_device_add(QemuOpts opts);
747bbdf7	104	int qdev_init(DeviceState *dev) QEMU_WARN_UNUSED_RESULT;
e23a1b33	105	void qdev_init_nofail(DeviceState *dev);
3418bd25	106	int qdev_unplug(DeviceState *dev);
02e2da45	107	void qdev_free(DeviceState *dev);
3418bd25 GH	108	int qdev_simple_unplug_cb(DeviceState *dev);
3418bd25 GH	109	void qdev_machine_creation_done(void);
aae9460e	110
aae9460e PB	111	qemu_irq qdev_get_gpio_in(DeviceState *dev, int n);
	112	void qdev_connect_gpio_out(DeviceState *dev, int n, qemu_irq pin);
	113
02e2da45	114	BusState qdev_get_child_bus(DeviceState dev, const char *name);
4d6ae674	115
aae9460e PB	116	/* Device API. */
aae9460e PB	117
81a322d4	118	typedef int (qdev_initfn)(DeviceState dev, DeviceInfo *info);
3418bd25	119	typedef int (qdev_event)(DeviceState dev);
7f23f812	120	typedef void (qdev_resetfn)(DeviceState dev);
aae9460e	121
02e2da45	122	struct DeviceInfo {
074f2fff	123	const char *name;
3320e56e GH	124	const char *alias;
3320e56e GH	125	const char *desc;
074f2fff	126	size_t size;
ee6847d1	127	Property *props;
3320e56e	128	int no_user;
074f2fff	129
959f733a	130	/* callbacks */
7f23f812	131	qdev_resetfn reset;
959f733a	132
391a079e GH	133	/* device state */
	134	const VMStateDescription *vmsd;
	135
074f2fff	136	/* Private to qdev / bus. */
02e2da45	137	qdev_initfn init;
3418bd25 GH	138	qdev_event unplug;
3418bd25 GH	139	qdev_event exit;
10c4c98a	140	BusInfo *bus_info;
042f84d0	141	struct DeviceInfo *next;
02e2da45 PB	142	};
02e2da45 PB	143
074f2fff	144	void qdev_register(DeviceInfo *info);
aae9460e PB	145
aae9460e PB	146	/* Register device properties. */
067a3ddc	147	/* GPIO inputs also double as IRQ sinks. */
aae9460e PB	148	void qdev_init_gpio_in(DeviceState *dev, qemu_irq_handler handler, int n);
	149	void qdev_init_gpio_out(DeviceState dev, qemu_irq pins, int n);
	150
	151	CharDriverState qdev_init_chardev(DeviceState dev);
	152
02e2da45	153	BusState qdev_get_parent_bus(DeviceState dev);
aae9460e	154
979ba184	155	/* Convert from a base type to a parent type, with compile time checking. */
aae9460e PB	156	#ifdef __GNUC__
	157	#define DO_UPCAST(type, field, dev) ( __extension__ ( { \
	158	char __attribute__((unused)) offset_must_be_zero[ \
	159	-offsetof(type, field)]; \
	160	container_of(dev, type, field);}))
	161	#else
	162	#define DO_UPCAST(type, field, dev) container_of(dev, type, field)
	163	#endif
	164
02e2da45 PB	165	/* BUS API. */
02e2da45 PB	166
cd739fb6 GH	167	void qbus_create_inplace(BusState bus, BusInfo info,
cd739fb6 GH	168	DeviceState parent, const char name);
10c4c98a	169	BusState qbus_create(BusInfo info, DeviceState parent, const char name);
131ec1bd	170	void qbus_free(BusState *bus);
02e2da45 PB	171
	172	#define FROM_QBUS(type, dev) DO_UPCAST(type, qbus, dev)
	173
cae4956e GH	174	/* monitor commands */
	175
	176	void do_info_qtree(Monitor *mon);
f6c64e0e	177	void do_info_qdm(Monitor *mon);
3418bd25 GH	178	void do_device_add(Monitor mon, const QDict qdict);
3418bd25 GH	179	void do_device_del(Monitor mon, const QDict qdict);
cae4956e	180
ee6847d1 GH	181	/* qdev-properties.c */
ee6847d1 GH	182
c7cc172d	183	extern PropertyInfo qdev_prop_uint8;
ee6847d1 GH	184	extern PropertyInfo qdev_prop_uint16;
ee6847d1 GH	185	extern PropertyInfo qdev_prop_uint32;
316940b0	186	extern PropertyInfo qdev_prop_int32;
5a053d1f	187	extern PropertyInfo qdev_prop_uint64;
ee6847d1	188	extern PropertyInfo qdev_prop_hex32;
5a053d1f	189	extern PropertyInfo qdev_prop_hex64;
59419663	190	extern PropertyInfo qdev_prop_string;
313feaab	191	extern PropertyInfo qdev_prop_chr;
ee6847d1 GH	192	extern PropertyInfo qdev_prop_ptr;
ee6847d1 GH	193	extern PropertyInfo qdev_prop_macaddr;
14b41872	194	extern PropertyInfo qdev_prop_drive;
05cb5fe4	195	extern PropertyInfo qdev_prop_pci_devfn;
ee6847d1	196
cf12b95b GH	197	#define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
	198	.name = (_name), \
	199	.info = &(_prop), \
	200	.offset = offsetof(_state, _field) \
	201	+ type_check(_type,typeof_field(_state, _field)), \
	202	}
	203	#define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
	204	.name = (_name), \
	205	.info = &(_prop), \
	206	.offset = offsetof(_state, _field) \
	207	+ type_check(_type,typeof_field(_state, _field)), \
	208	.defval = (_type[]) { _defval }, \
	209	}
	210
c7cc172d JQ	211	#define DEFINE_PROP_UINT8(_n, _s, _f, _d) \
c7cc172d JQ	212	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
cf12b95b GH	213	#define DEFINE_PROP_UINT16(_n, _s, _f, _d) \
	214	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
	215	#define DEFINE_PROP_UINT32(_n, _s, _f, _d) \
	216	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
316940b0 GH	217	#define DEFINE_PROP_INT32(_n, _s, _f, _d) \
316940b0 GH	218	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
cf12b95b GH	219	#define DEFINE_PROP_UINT64(_n, _s, _f, _d) \
	220	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
	221	#define DEFINE_PROP_HEX32(_n, _s, _f, _d) \
	222	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex32, uint32_t)
	223	#define DEFINE_PROP_HEX64(_n, _s, _f, _d) \
	224	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_hex64, uint64_t)
	225	#define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \
	226	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, uint32_t)
	227
	228	#define DEFINE_PROP_PTR(_n, _s, _f) \
	229	DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
313feaab GH	230	#define DEFINE_PROP_CHR(_n, _s, _f) \
313feaab GH	231	DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
59419663 GH	232	#define DEFINE_PROP_STRING(_n, _s, _f) \
59419663 GH	233	DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
f6c64e0e	234	#define DEFINE_PROP_DRIVE(_n, _s, _f) \
c981d39c	235	DEFINE_PROP(_n, _s, _f, qdev_prop_drive, DriveInfo*)
cf12b95b GH	236	#define DEFINE_PROP_MACADDR(_n, _s, _f) \
	237	DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, uint8_t[6])
	238
	239	#define DEFINE_PROP_END_OF_LIST() \
	240	{}
	241
ee6847d1 GH	242	/* Set properties between creation and init. */
	243	void qdev_get_prop_ptr(DeviceState dev, Property *prop);
	244	int qdev_prop_parse(DeviceState dev, const char name, const char *value);
	245	void qdev_prop_set(DeviceState dev, const char name, void *src, enum PropertyType type);
c7cc172d	246	void qdev_prop_set_uint8(DeviceState dev, const char name, uint8_t value);
ee6847d1 GH	247	void qdev_prop_set_uint16(DeviceState dev, const char name, uint16_t value);
ee6847d1 GH	248	void qdev_prop_set_uint32(DeviceState dev, const char name, uint32_t value);
316940b0	249	void qdev_prop_set_int32(DeviceState dev, const char name, int32_t value);
5a053d1f	250	void qdev_prop_set_uint64(DeviceState dev, const char name, uint64_t value);
313feaab	251	void qdev_prop_set_chr(DeviceState dev, const char name, CharDriverState *value);
14b41872	252	void qdev_prop_set_drive(DeviceState dev, const char name, DriveInfo *value);
ee6847d1 GH	253	/* FIXME: Remove opaque pointer properties. */
	254	void qdev_prop_set_ptr(DeviceState dev, const char name, void *value);
	255	void qdev_prop_set_defaults(DeviceState dev, Property props);
	256
b6b61144 GH	257	void qdev_prop_register_compat(CompatProperty *props);
	258	void qdev_prop_set_compat(DeviceState *dev);
	259
a9ff9df1 BS	260	/* This is a nasty hack to allow passing a NULL bus to qdev_create. */
	261	extern struct BusInfo system_bus_info;
	262
aae9460e	263	#endif