[qemu.git] / include / hw / qdev-properties.h

#ifndef QEMU_QDEV_PROPERTIES_H
#define QEMU_QDEV_PROPERTIES_H

#include "hw/qdev-core.h"

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

extern PropertyInfo qdev_prop_bit;
extern PropertyInfo qdev_prop_bool;
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_size;
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_bios_chs_trans;
extern PropertyInfo qdev_prop_drive;
extern PropertyInfo qdev_prop_netdev;
extern PropertyInfo qdev_prop_vlan;
extern PropertyInfo qdev_prop_pci_devfn;
extern PropertyInfo qdev_prop_blocksize;
extern PropertyInfo qdev_prop_pci_host_devaddr;
extern PropertyInfo qdev_prop_arraylen;

#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)),           \
        .qtype     = QTYPE_QINT,                                        \
        .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)), \
        .qtype     = QTYPE_QBOOL,                                \
        .defval    = (bool)_defval,                              \
        }

#define DEFINE_PROP_BOOL(_name, _state, _field, _defval) {       \
        .name      = (_name),                                    \
        .info      = &(qdev_prop_bool),                          \
        .offset    = offsetof(_state, _field)                    \
            + type_check(bool, typeof_field(_state, _field)),    \
        .qtype     = QTYPE_QBOOL,                                \
        .defval    = (bool)_defval,                              \
        }

#define PROP_ARRAY_LEN_PREFIX "len-"

/**
 * DEFINE_PROP_ARRAY:
 * @_name: name of the array
 * @_state: name of the device state structure type
 * @_field: uint32_t field in @_state to hold the array length
 * @_arrayfield: field in @_state (of type '@_arraytype *') which
 *               will point to the array
 * @_arrayprop: PropertyInfo defining what property the array elements have
 * @_arraytype: C type of the array elements
 *
 * Define device properties for a variable-length array _name.  A
 * static property "len-arrayname" is defined. When the device creator
 * sets this property to the desired length of array, further dynamic
 * properties "arrayname[0]", "arrayname[1]", ...  are defined so the
 * device creator can set the array element values. Setting the
 * "len-arrayname" property more than once is an error.
 *
 * When the array length is set, the @_field member of the device
 * struct is set to the array length, and @_arrayfield is set to point
 * to (zero-initialised) memory allocated for the array.  For a zero
 * length array, @_field will be set to 0 and @_arrayfield to NULL.
 * It is the responsibility of the device deinit code to free the
 * @_arrayfield memory.
 */
#define DEFINE_PROP_ARRAY(_name, _state, _field,                        \
                          _arrayfield, _arrayprop, _arraytype) {        \
        .name = (PROP_ARRAY_LEN_PREFIX _name),                          \
        .info = &(qdev_prop_arraylen),                                  \
        .offset = offsetof(_state, _field)                              \
            + type_check(uint32_t, typeof_field(_state, _field)),       \
        .qtype = QTYPE_QINT,                                            \
        .arrayinfo = &(_arrayprop),                                     \
        .arrayfieldsize = sizeof(_arraytype),                           \
        .arrayoffset = offsetof(_state, _arrayfield),                   \
        }

#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_SIZE(_n, _s, _f, _d)                       \
    DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_size, uint64_t)
#define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
    DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, int32_t)

/*
 * Please avoid pointer properties.  If you must use them, you must
 * cover them in their device's class init function as follows:
 *
 * - If the property must be set, the device cannot be used with
 *   device_add, so add code like this:
 *   |* Reason: pointer property "NAME-OF-YOUR-PROP" *|
 *   DeviceClass *dc = DEVICE_CLASS(class);
 *   dc->cannot_instantiate_with_device_add_yet = true;
 *
 * - If the property may safely remain null, document it like this:
 *   |*
 *    * Note: pointer property "interrupt_vector" may remain null, thus
 *    * no need for dc->cannot_instantiate_with_device_add_yet = true;
 *    *|
 */
#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, NICPeers)
#define DEFINE_PROP_VLAN(_n, _s, _f)             \
    DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, NICPeers)
#define DEFINE_PROP_DRIVE(_n, _s, _f) \
    DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockBackend *)
#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_BIOS_CHS_TRANS(_n, _s, _f, _d) \
    DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_bios_chs_trans, int)
#define DEFINE_PROP_BLOCKSIZE(_n, _s, _f, _d) \
    DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_blocksize, uint16_t)
#define DEFINE_PROP_PCI_HOST_DEVADDR(_n, _s, _f) \
    DEFINE_PROP(_n, _s, _f, qdev_prop_pci_host_devaddr, PCIHostDeviceAddress)

#define DEFINE_PROP_END_OF_LIST()               \
    {}

/* Set properties between creation and init.  */
void *qdev_get_prop_ptr(DeviceState *dev, Property *prop);
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, const char *value);
void qdev_prop_set_chr(DeviceState *dev, const char *name, CharDriverState *value);
void qdev_prop_set_netdev(DeviceState *dev, const char *name, NetClientState *value);
int qdev_prop_set_drive(DeviceState *dev, const char *name,
                        BlockBackend *value) QEMU_WARN_UNUSED_RESULT;
void qdev_prop_set_drive_nofail(DeviceState *dev, const char *name,
                                BlockBackend *value);
void qdev_prop_set_macaddr(DeviceState *dev, const char *name, uint8_t *value);
void qdev_prop_set_enum(DeviceState *dev, const char *name, int value);
/* FIXME: Remove opaque pointer properties.  */
void qdev_prop_set_ptr(DeviceState *dev, const char *name, void *value);

void qdev_prop_register_global(GlobalProperty *prop);
void qdev_prop_register_global_list(GlobalProperty *props);
int qdev_prop_check_globals(void);
void qdev_prop_set_globals(DeviceState *dev, Error **errp);
void qdev_prop_set_globals_for_type(DeviceState *dev, const char *typename,
                                    Error **errp);
void error_set_from_qdev_prop_error(Error **errp, int ret, DeviceState *dev,
                                    Property *prop, const char *value);

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

void qdev_alias_all_properties(DeviceState *target, Object *source);

/**
 * @qdev_prop_set_after_realize:
 * @dev: device
 * @name: name of property
 * @errp: indirect pointer to Error to be set
 * Set the Error object to report that an attempt was made to set a property
 * on a device after it has already been realized. This is a utility function
 * which allows property-setter functions to easily report the error in
 * a friendly format identifying both the device and the property.
 */
void qdev_prop_set_after_realize(DeviceState *dev, const char *name,
                                 Error **errp);

/**
 * qdev_prop_allow_set_link_before_realize:
 *
 * Set the #Error object if an attempt is made to set the link after realize.
 * This function should be used as the check() argument to
 * object_property_add_link().
 */
void qdev_prop_allow_set_link_before_realize(Object *obj, const char *name,
                                             Object *val, Error **errp);

#endif
Commit	Line	Data
074a86fc AL	1	#ifndef QEMU_QDEV_PROPERTIES_H
	2	#define QEMU_QDEV_PROPERTIES_H
	3
83c9f4ca	4	#include "hw/qdev-core.h"
074a86fc AL	5
	6	/* qdev-properties.c */
	7
	8	extern PropertyInfo qdev_prop_bit;
72cc5137	9	extern PropertyInfo qdev_prop_bool;
074a86fc AL	10	extern PropertyInfo qdev_prop_uint8;
	11	extern PropertyInfo qdev_prop_uint16;
	12	extern PropertyInfo qdev_prop_uint32;
	13	extern PropertyInfo qdev_prop_int32;
	14	extern PropertyInfo qdev_prop_uint64;
e8cd45c7	15	extern PropertyInfo qdev_prop_size;
074a86fc AL	16	extern PropertyInfo qdev_prop_string;
	17	extern PropertyInfo qdev_prop_chr;
	18	extern PropertyInfo qdev_prop_ptr;
	19	extern PropertyInfo qdev_prop_macaddr;
	20	extern PropertyInfo qdev_prop_losttickpolicy;
	21	extern PropertyInfo qdev_prop_bios_chs_trans;
	22	extern PropertyInfo qdev_prop_drive;
	23	extern PropertyInfo qdev_prop_netdev;
	24	extern PropertyInfo qdev_prop_vlan;
	25	extern PropertyInfo qdev_prop_pci_devfn;
	26	extern PropertyInfo qdev_prop_blocksize;
	27	extern PropertyInfo qdev_prop_pci_host_devaddr;
0be6bfac	28	extern PropertyInfo qdev_prop_arraylen;
074a86fc AL	29
	30	#define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
	31	.name = (_name), \
	32	.info = &(_prop), \
	33	.offset = offsetof(_state, _field) \
1ceef9f2	34	+ type_check(_type, typeof_field(_state, _field)), \
074a86fc AL	35	}
	36	#define DEFINE_PROP_DEFAULT(_name, _state, _field, _defval, _prop, _type) { \
	37	.name = (_name), \
	38	.info = &(_prop), \
	39	.offset = offsetof(_state, _field) \
	40	+ type_check(_type,typeof_field(_state, _field)), \
	41	.qtype = QTYPE_QINT, \
	42	.defval = (_type)_defval, \
	43	}
	44	#define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) { \
	45	.name = (_name), \
	46	.info = &(qdev_prop_bit), \
	47	.bitnr = (_bit), \
	48	.offset = offsetof(_state, _field) \
	49	+ type_check(uint32_t,typeof_field(_state, _field)), \
	50	.qtype = QTYPE_QBOOL, \
	51	.defval = (bool)_defval, \
	52	}
	53
72cc5137 IM	54	#define DEFINE_PROP_BOOL(_name, _state, _field, _defval) { \
	55	.name = (_name), \
	56	.info = &(qdev_prop_bool), \
	57	.offset = offsetof(_state, _field) \
	58	+ type_check(bool, typeof_field(_state, _field)), \
	59	.qtype = QTYPE_QBOOL, \
	60	.defval = (bool)_defval, \
	61	}
	62
0be6bfac PM	63	#define PROP_ARRAY_LEN_PREFIX "len-"
	64
	65	/**
	66	* DEFINE_PROP_ARRAY:
	67	* @_name: name of the array
	68	* @_state: name of the device state structure type
	69	* @_field: uint32_t field in @_state to hold the array length
	70	* @_arrayfield: field in @_state (of type '@_arraytype *') which
	71	* will point to the array
	72	* @_arrayprop: PropertyInfo defining what property the array elements have
	73	* @_arraytype: C type of the array elements
	74	*
	75	* Define device properties for a variable-length array _name. A
	76	* static property "len-arrayname" is defined. When the device creator
	77	* sets this property to the desired length of array, further dynamic
	78	* properties "arrayname[0]", "arrayname[1]", ... are defined so the
	79	* device creator can set the array element values. Setting the
	80	* "len-arrayname" property more than once is an error.
	81	*
	82	* When the array length is set, the @_field member of the device
	83	* struct is set to the array length, and @_arrayfield is set to point
	84	* to (zero-initialised) memory allocated for the array. For a zero
	85	* length array, @_field will be set to 0 and @_arrayfield to NULL.
	86	* It is the responsibility of the device deinit code to free the
	87	* @_arrayfield memory.
	88	*/
	89	#define DEFINE_PROP_ARRAY(_name, _state, _field, \
	90	_arrayfield, _arrayprop, _arraytype) { \
	91	.name = (PROP_ARRAY_LEN_PREFIX _name), \
	92	.info = &(qdev_prop_arraylen), \
	93	.offset = offsetof(_state, _field) \
	94	+ type_check(uint32_t, typeof_field(_state, _field)), \
	95	.qtype = QTYPE_QINT, \
	96	.arrayinfo = &(_arrayprop), \
	97	.arrayfieldsize = sizeof(_arraytype), \
	98	.arrayoffset = offsetof(_state, _arrayfield), \
	99	}
	100
074a86fc AL	101	#define DEFINE_PROP_UINT8(_n, _s, _f, _d) \
	102	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
	103	#define DEFINE_PROP_UINT16(_n, _s, _f, _d) \
	104	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
	105	#define DEFINE_PROP_UINT32(_n, _s, _f, _d) \
	106	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
	107	#define DEFINE_PROP_INT32(_n, _s, _f, _d) \
	108	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_int32, int32_t)
	109	#define DEFINE_PROP_UINT64(_n, _s, _f, _d) \
	110	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
e8cd45c7 VL	111	#define DEFINE_PROP_SIZE(_n, _s, _f, _d) \
e8cd45c7 VL	112	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_size, uint64_t)
074a86fc AL	113	#define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \
	114	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_pci_devfn, int32_t)
	115
c272758f MA	116	/*
	117	* Please avoid pointer properties. If you must use them, you must
	118	* cover them in their device's class init function as follows:
	119	*
	120	* - If the property must be set, the device cannot be used with
	121	* device_add, so add code like this:
	122	* \|* Reason: pointer property "NAME-OF-YOUR-PROP" *\|
	123	* DeviceClass *dc = DEVICE_CLASS(class);
	124	* dc->cannot_instantiate_with_device_add_yet = true;
	125	*
	126	* - If the property may safely remain null, document it like this:
	127	* \|*
	128	* * Note: pointer property "interrupt_vector" may remain null, thus
	129	* * no need for dc->cannot_instantiate_with_device_add_yet = true;
	130	* *\|
	131	*/
074a86fc AL	132	#define DEFINE_PROP_PTR(_n, _s, _f) \
074a86fc AL	133	DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
c272758f	134
074a86fc AL	135	#define DEFINE_PROP_CHR(_n, _s, _f) \
	136	DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharDriverState*)
	137	#define DEFINE_PROP_STRING(_n, _s, _f) \
	138	DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
	139	#define DEFINE_PROP_NETDEV(_n, _s, _f) \
1ceef9f2	140	DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, NICPeers)
074a86fc	141	#define DEFINE_PROP_VLAN(_n, _s, _f) \
1ceef9f2	142	DEFINE_PROP(_n, _s, _f, qdev_prop_vlan, NICPeers)
074a86fc	143	#define DEFINE_PROP_DRIVE(_n, _s, _f) \
4be74634	144	DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockBackend *)
074a86fc AL	145	#define DEFINE_PROP_MACADDR(_n, _s, _f) \
	146	DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
	147	#define DEFINE_PROP_LOSTTICKPOLICY(_n, _s, _f, _d) \
	148	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
	149	LostTickPolicy)
	150	#define DEFINE_PROP_BIOS_CHS_TRANS(_n, _s, _f, _d) \
	151	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_bios_chs_trans, int)
	152	#define DEFINE_PROP_BLOCKSIZE(_n, _s, _f, _d) \
	153	DEFINE_PROP_DEFAULT(_n, _s, _f, _d, qdev_prop_blocksize, uint16_t)
	154	#define DEFINE_PROP_PCI_HOST_DEVADDR(_n, _s, _f) \
	155	DEFINE_PROP(_n, _s, _f, qdev_prop_pci_host_devaddr, PCIHostDeviceAddress)
	156
	157	#define DEFINE_PROP_END_OF_LIST() \
	158	{}
	159
	160	/* Set properties between creation and init. */
	161	void qdev_get_prop_ptr(DeviceState dev, Property *prop);
074a86fc AL	162	void qdev_prop_set_bit(DeviceState dev, const char name, bool value);
	163	void qdev_prop_set_uint8(DeviceState dev, const char name, uint8_t value);
	164	void qdev_prop_set_uint16(DeviceState dev, const char name, uint16_t value);
	165	void qdev_prop_set_uint32(DeviceState dev, const char name, uint32_t value);
	166	void qdev_prop_set_int32(DeviceState dev, const char name, int32_t value);
	167	void qdev_prop_set_uint64(DeviceState dev, const char name, uint64_t value);
	168	void qdev_prop_set_string(DeviceState dev, const char name, const char *value);
	169	void qdev_prop_set_chr(DeviceState dev, const char name, CharDriverState *value);
	170	void qdev_prop_set_netdev(DeviceState dev, const char name, NetClientState *value);
4be74634 MA	171	int qdev_prop_set_drive(DeviceState dev, const char name,
	172	BlockBackend *value) QEMU_WARN_UNUSED_RESULT;
	173	void qdev_prop_set_drive_nofail(DeviceState dev, const char name,
	174	BlockBackend *value);
074a86fc AL	175	void qdev_prop_set_macaddr(DeviceState dev, const char name, uint8_t *value);
	176	void qdev_prop_set_enum(DeviceState dev, const char name, int value);
	177	/* FIXME: Remove opaque pointer properties. */
	178	void qdev_prop_set_ptr(DeviceState dev, const char name, void *value);
	179
a404b612	180	void qdev_prop_register_global(GlobalProperty *prop);
074a86fc	181	void qdev_prop_register_global_list(GlobalProperty *props);
d828c430	182	int qdev_prop_check_globals(void);
b1fe9bcb	183	void qdev_prop_set_globals(DeviceState dev, Error *errp);
868d378b AF	184	void qdev_prop_set_globals_for_type(DeviceState dev, const char typename,
868d378b AF	185	Error **errp);
074a86fc AL	186	void error_set_from_qdev_prop_error(Error *errp, int ret, DeviceState dev,
	187	Property prop, const char value);
	188
	189	/**
	190	* @qdev_property_add_static - add a @Property to a device referencing a
	191	* field in a struct.
	192	*/
	193	void qdev_property_add_static(DeviceState dev, Property prop, Error **errp);
	194
67cc7e0a SH	195	void qdev_alias_all_properties(DeviceState target, Object source);
67cc7e0a SH	196
b000dfbd PM	197	/**
	198	* @qdev_prop_set_after_realize:
	199	* @dev: device
	200	* @name: name of property
	201	* @errp: indirect pointer to Error to be set
	202	* Set the Error object to report that an attempt was made to set a property
	203	* on a device after it has already been realized. This is a utility function
	204	* which allows property-setter functions to easily report the error in
	205	* a friendly format identifying both the device and the property.
	206	*/
	207	void qdev_prop_set_after_realize(DeviceState dev, const char name,
	208	Error **errp);
39f72ef9 SH	209
	210	/**
	211	* qdev_prop_allow_set_link_before_realize:
	212	*
	213	* Set the #Error object if an attempt is made to set the link after realize.
	214	* This function should be used as the check() argument to
	215	* object_property_add_link().
	216	*/
	217	void qdev_prop_allow_set_link_before_realize(Object obj, const char name,
	218	Object val, Error *errp);
	219
074a86fc	220	#endif