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

struct DeviceInfo {
    const char *name;
    const char *alias;
    const char *desc;
    size_t size;
    Property *props;
    int no_user;

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