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

#ifndef QEMU_QDEV_PROPERTIES_H
#define QEMU_QDEV_PROPERTIES_H

#include "qapi/qapi-types-block.h"
#include "qapi/qapi-types-misc.h"
#include "hw/qdev-core.h"

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

extern const PropertyInfo qdev_prop_bit;
extern const PropertyInfo qdev_prop_bit64;
extern const PropertyInfo qdev_prop_bool;
extern const PropertyInfo qdev_prop_uint8;
extern const PropertyInfo qdev_prop_uint16;
extern const PropertyInfo qdev_prop_uint32;
extern const PropertyInfo qdev_prop_int32;
extern const PropertyInfo qdev_prop_uint64;
extern const PropertyInfo qdev_prop_int64;
extern const PropertyInfo qdev_prop_size;
extern const PropertyInfo qdev_prop_string;
extern const PropertyInfo qdev_prop_chr;
extern const PropertyInfo qdev_prop_tpm;
extern const PropertyInfo qdev_prop_ptr;
extern const PropertyInfo qdev_prop_macaddr;
extern const PropertyInfo qdev_prop_on_off_auto;
extern const PropertyInfo qdev_prop_losttickpolicy;
extern const PropertyInfo qdev_prop_blockdev_on_error;
extern const PropertyInfo qdev_prop_bios_chs_trans;
extern const PropertyInfo qdev_prop_fdc_drive_type;
extern const PropertyInfo qdev_prop_drive;
extern const PropertyInfo qdev_prop_netdev;
extern const PropertyInfo qdev_prop_pci_devfn;
extern const PropertyInfo qdev_prop_blocksize;
extern const PropertyInfo qdev_prop_pci_host_devaddr;
extern const PropertyInfo qdev_prop_uuid;
extern const PropertyInfo qdev_prop_arraylen;
extern const PropertyInfo qdev_prop_link;
extern const PropertyInfo qdev_prop_off_auto_pcibar;
extern const PropertyInfo qdev_prop_pcie_link_speed;
extern const PropertyInfo qdev_prop_pcie_link_width;

#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_SIGNED(_name, _state, _field, _defval, _prop, _type) { \
        .name      = (_name),                                           \
        .info      = &(_prop),                                          \
        .offset    = offsetof(_state, _field)                           \
            + type_check(_type,typeof_field(_state, _field)),           \
        .set_default = true,                                            \
        .defval.i  = (_type)_defval,                                    \
        }

#define DEFINE_PROP_SIGNED_NODEFAULT(_name, _state, _field, _prop, _type) { \
        .name      = (_name),                                           \
        .info      = &(_prop),                                          \
        .offset    = offsetof(_state, _field)                           \
            + type_check(_type, typeof_field(_state, _field)),          \
        }

#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)), \
        .set_default = true,                                     \
        .defval.u  = (bool)_defval,                              \
        }

#define DEFINE_PROP_UNSIGNED(_name, _state, _field, _defval, _prop, _type) { \
        .name      = (_name),                                           \
        .info      = &(_prop),                                          \
        .offset    = offsetof(_state, _field)                           \
            + type_check(_type, typeof_field(_state, _field)),          \
        .set_default = true,                                            \
        .defval.u  = (_type)_defval,                                    \
        }

#define DEFINE_PROP_UNSIGNED_NODEFAULT(_name, _state, _field, _prop, _type) { \
        .name      = (_name),                                           \
        .info      = &(_prop),                                          \
        .offset    = offsetof(_state, _field)                           \
            + type_check(_type, typeof_field(_state, _field)),          \
        }

#define DEFINE_PROP_BIT64(_name, _state, _field, _bit, _defval) {       \
        .name      = (_name),                                           \
        .info      = &(qdev_prop_bit64),                                \
        .bitnr    = (_bit),                                             \
        .offset    = offsetof(_state, _field)                           \
            + type_check(uint64_t, typeof_field(_state, _field)),       \
        .set_default = true,                                            \
        .defval.u  = (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)),    \
        .set_default = true,                                     \
        .defval.u    = (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),                                  \
        .set_default = true,                                            \
        .defval.u = 0,                                                  \
        .offset = offsetof(_state, _field)                              \
            + type_check(uint32_t, typeof_field(_state, _field)),       \
        .arrayinfo = &(_arrayprop),                                     \
        .arrayfieldsize = sizeof(_arraytype),                           \
        .arrayoffset = offsetof(_state, _arrayfield),                   \
        }

#define DEFINE_PROP_LINK(_name, _state, _field, _type, _ptr_type) {     \
        .name = (_name),                                                \
        .info = &(qdev_prop_link),                                      \
        .offset = offsetof(_state, _field)                              \
            + type_check(_ptr_type, typeof_field(_state, _field)),      \
        .link_type  = _type,                                            \
        }

#define DEFINE_PROP_UINT8(_n, _s, _f, _d)                       \
    DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
#define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
    DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
#define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
    DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
#define DEFINE_PROP_INT32(_n, _s, _f, _d)                      \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_int32, int32_t)
#define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
    DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
#define DEFINE_PROP_INT64(_n, _s, _f, _d)                      \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_int64, int64_t)
#define DEFINE_PROP_SIZE(_n, _s, _f, _d)                       \
    DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_size, uint64_t)
#define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d)                   \
    DEFINE_PROP_SIGNED(_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->user_creatable = false;
 *
 * - If the property may safely remain null, document it like this:
 *   |*
 *    * Note: pointer property "interrupt_vector" may remain null, thus
 *    * no need for dc->user_creatable = false;
 *    *|
 */
#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, CharBackend)
#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_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_ON_OFF_AUTO(_n, _s, _f, _d) \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_on_off_auto, OnOffAuto)
#define DEFINE_PROP_LOSTTICKPOLICY(_n, _s, _f, _d) \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
                        LostTickPolicy)
#define DEFINE_PROP_BLOCKDEV_ON_ERROR(_n, _s, _f, _d) \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_blockdev_on_error, \
                        BlockdevOnError)
#define DEFINE_PROP_BIOS_CHS_TRANS(_n, _s, _f, _d) \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_bios_chs_trans, int)
#define DEFINE_PROP_BLOCKSIZE(_n, _s, _f) \
    DEFINE_PROP_UNSIGNED(_n, _s, _f, 0, 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_MEMORY_REGION(_n, _s, _f)             \
    DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, MemoryRegion *)
#define DEFINE_PROP_OFF_AUTO_PCIBAR(_n, _s, _f, _d) \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_off_auto_pcibar, \
                        OffAutoPCIBAR)
#define DEFINE_PROP_PCIE_LINK_SPEED(_n, _s, _f, _d) \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_pcie_link_speed, \
                        PCIExpLinkSpeed)
#define DEFINE_PROP_PCIE_LINK_WIDTH(_n, _s, _f, _d) \
    DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_pcie_link_width, \
                        PCIExpLinkWidth)

#define DEFINE_PROP_UUID(_name, _state, _field) {                  \
        .name      = (_name),                                      \
        .info      = &qdev_prop_uuid,                              \
        .offset    = offsetof(_state, _field)                      \
            + type_check(QemuUUID, typeof_field(_state, _field)),  \
        .set_default = true,                                       \
        }

#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, Chardev *value);
void qdev_prop_set_netdev(DeviceState *dev, const char *name, NetClientState *value);
void qdev_prop_set_drive(DeviceState *dev, const char *name,
                         BlockBackend *value, Error **errp);
void qdev_prop_set_macaddr(DeviceState *dev, const char *name,
                           const 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);
int qdev_prop_check_globals(void);
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);

/**
 * qdev_property_add_static:
 * @dev: Device to add the property to.
 * @prop: The qdev property definition.
 * @errp: location to store error information.
 *
 * Add a static QOM property to @dev for qdev property @prop.
 * On error, store error in @errp.  Static properties access data in a struct.
 * The type of the QOM property is derived from prop->info.
 */
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(const 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
112ed241 MA	4	#include "qapi/qapi-types-block.h"
112ed241 MA	5	#include "qapi/qapi-types-misc.h"
83c9f4ca	6	#include "hw/qdev-core.h"
074a86fc AL	7
	8	/* qdev-properties.c */
	9
1b6b7d10 FZ	10	extern const PropertyInfo qdev_prop_bit;
	11	extern const PropertyInfo qdev_prop_bit64;
	12	extern const PropertyInfo qdev_prop_bool;
	13	extern const PropertyInfo qdev_prop_uint8;
	14	extern const PropertyInfo qdev_prop_uint16;
	15	extern const PropertyInfo qdev_prop_uint32;
	16	extern const PropertyInfo qdev_prop_int32;
	17	extern const PropertyInfo qdev_prop_uint64;
07d1d063	18	extern const PropertyInfo qdev_prop_int64;
1b6b7d10 FZ	19	extern const PropertyInfo qdev_prop_size;
	20	extern const PropertyInfo qdev_prop_string;
	21	extern const PropertyInfo qdev_prop_chr;
493b7830	22	extern const PropertyInfo qdev_prop_tpm;
1b6b7d10 FZ	23	extern const PropertyInfo qdev_prop_ptr;
	24	extern const PropertyInfo qdev_prop_macaddr;
	25	extern const PropertyInfo qdev_prop_on_off_auto;
	26	extern const PropertyInfo qdev_prop_losttickpolicy;
	27	extern const PropertyInfo qdev_prop_blockdev_on_error;
	28	extern const PropertyInfo qdev_prop_bios_chs_trans;
	29	extern const PropertyInfo qdev_prop_fdc_drive_type;
	30	extern const PropertyInfo qdev_prop_drive;
	31	extern const PropertyInfo qdev_prop_netdev;
1b6b7d10 FZ	32	extern const PropertyInfo qdev_prop_pci_devfn;
	33	extern const PropertyInfo qdev_prop_blocksize;
	34	extern const PropertyInfo qdev_prop_pci_host_devaddr;
87e6ed56	35	extern const PropertyInfo qdev_prop_uuid;
1b6b7d10 FZ	36	extern const PropertyInfo qdev_prop_arraylen;
1b6b7d10 FZ	37	extern const PropertyInfo qdev_prop_link;
c3bbbdbf	38	extern const PropertyInfo qdev_prop_off_auto_pcibar;
4695a2c5 AW	39	extern const PropertyInfo qdev_prop_pcie_link_speed;
4695a2c5 AW	40	extern const PropertyInfo qdev_prop_pcie_link_width;
074a86fc AL	41
	42	#define DEFINE_PROP(_name, _state, _field, _prop, _type) { \
	43	.name = (_name), \
	44	.info = &(_prop), \
	45	.offset = offsetof(_state, _field) \
1ceef9f2	46	+ type_check(_type, typeof_field(_state, _field)), \
074a86fc	47	}
3fb2111f	48
85bbd1e7	49	#define DEFINE_PROP_SIGNED(_name, _state, _field, _defval, _prop, _type) { \
074a86fc AL	50	.name = (_name), \
	51	.info = &(_prop), \
	52	.offset = offsetof(_state, _field) \
	53	+ type_check(_type,typeof_field(_state, _field)), \
5cc56cc6	54	.set_default = true, \
76318657	55	.defval.i = (_type)_defval, \
074a86fc	56	}
3fb2111f	57
5cc56cc6 PM	58	#define DEFINE_PROP_SIGNED_NODEFAULT(_name, _state, _field, _prop, _type) { \
	59	.name = (_name), \
	60	.info = &(_prop), \
	61	.offset = offsetof(_state, _field) \
	62	+ type_check(_type, typeof_field(_state, _field)), \
	63	}
	64
074a86fc AL	65	#define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval) { \
	66	.name = (_name), \
	67	.info = &(qdev_prop_bit), \
	68	.bitnr = (_bit), \
	69	.offset = offsetof(_state, _field) \
	70	+ type_check(uint32_t,typeof_field(_state, _field)), \
5cc56cc6	71	.set_default = true, \
3fb2111f MAL	72	.defval.u = (bool)_defval, \
	73	}
	74
	75	#define DEFINE_PROP_UNSIGNED(_name, _state, _field, _defval, _prop, _type) { \
	76	.name = (_name), \
	77	.info = &(_prop), \
	78	.offset = offsetof(_state, _field) \
	79	+ type_check(_type, typeof_field(_state, _field)), \
5cc56cc6	80	.set_default = true, \
3fb2111f	81	.defval.u = (_type)_defval, \
074a86fc	82	}
3fb2111f	83
5cc56cc6 PM	84	#define DEFINE_PROP_UNSIGNED_NODEFAULT(_name, _state, _field, _prop, _type) { \
	85	.name = (_name), \
	86	.info = &(_prop), \
	87	.offset = offsetof(_state, _field) \
	88	+ type_check(_type, typeof_field(_state, _field)), \
	89	}
	90
fdba6d96 GH	91	#define DEFINE_PROP_BIT64(_name, _state, _field, _bit, _defval) { \
fdba6d96 GH	92	.name = (_name), \
8aedc369	93	.info = &(qdev_prop_bit64), \
fdba6d96 GH	94	.bitnr = (_bit), \
	95	.offset = offsetof(_state, _field) \
	96	+ type_check(uint64_t, typeof_field(_state, _field)), \
5cc56cc6	97	.set_default = true, \
3fb2111f	98	.defval.u = (bool)_defval, \
fdba6d96	99	}
074a86fc	100
72cc5137 IM	101	#define DEFINE_PROP_BOOL(_name, _state, _field, _defval) { \
	102	.name = (_name), \
	103	.info = &(qdev_prop_bool), \
	104	.offset = offsetof(_state, _field) \
	105	+ type_check(bool, typeof_field(_state, _field)), \
5cc56cc6	106	.set_default = true, \
3fb2111f	107	.defval.u = (bool)_defval, \
72cc5137 IM	108	}
72cc5137 IM	109
0be6bfac PM	110	#define PROP_ARRAY_LEN_PREFIX "len-"
	111
	112	/**
	113	* DEFINE_PROP_ARRAY:
	114	* @_name: name of the array
	115	* @_state: name of the device state structure type
	116	* @_field: uint32_t field in @_state to hold the array length
	117	* @_arrayfield: field in @_state (of type '@_arraytype *') which
	118	* will point to the array
	119	* @_arrayprop: PropertyInfo defining what property the array elements have
	120	* @_arraytype: C type of the array elements
	121	*
	122	* Define device properties for a variable-length array _name. A
	123	* static property "len-arrayname" is defined. When the device creator
	124	* sets this property to the desired length of array, further dynamic
	125	* properties "arrayname[0]", "arrayname[1]", ... are defined so the
	126	* device creator can set the array element values. Setting the
	127	* "len-arrayname" property more than once is an error.
	128	*
	129	* When the array length is set, the @_field member of the device
	130	* struct is set to the array length, and @_arrayfield is set to point
	131	* to (zero-initialised) memory allocated for the array. For a zero
	132	* length array, @_field will be set to 0 and @_arrayfield to NULL.
	133	* It is the responsibility of the device deinit code to free the
	134	* @_arrayfield memory.
	135	*/
	136	#define DEFINE_PROP_ARRAY(_name, _state, _field, \
	137	_arrayfield, _arrayprop, _arraytype) { \
	138	.name = (PROP_ARRAY_LEN_PREFIX _name), \
	139	.info = &(qdev_prop_arraylen), \
5cc56cc6	140	.set_default = true, \
d9a7b125	141	.defval.u = 0, \
0be6bfac PM	142	.offset = offsetof(_state, _field) \
0be6bfac PM	143	+ type_check(uint32_t, typeof_field(_state, _field)), \
0be6bfac PM	144	.arrayinfo = &(_arrayprop), \
	145	.arrayfieldsize = sizeof(_arraytype), \
	146	.arrayoffset = offsetof(_state, _arrayfield), \
	147	}
	148
5b4ff3c6 FZ	149	#define DEFINE_PROP_LINK(_name, _state, _field, _type, _ptr_type) { \
	150	.name = (_name), \
	151	.info = &(qdev_prop_link), \
	152	.offset = offsetof(_state, _field) \
	153	+ type_check(_ptr_type, typeof_field(_state, _field)), \
	154	.link_type = _type, \
	155	}
	156
074a86fc	157	#define DEFINE_PROP_UINT8(_n, _s, _f, _d) \
3fb2111f	158	DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
074a86fc	159	#define DEFINE_PROP_UINT16(_n, _s, _f, _d) \
3fb2111f	160	DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
074a86fc	161	#define DEFINE_PROP_UINT32(_n, _s, _f, _d) \
3fb2111f	162	DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
074a86fc	163	#define DEFINE_PROP_INT32(_n, _s, _f, _d) \
85bbd1e7	164	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_int32, int32_t)
074a86fc	165	#define DEFINE_PROP_UINT64(_n, _s, _f, _d) \
3fb2111f	166	DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
07d1d063 PX	167	#define DEFINE_PROP_INT64(_n, _s, _f, _d) \
07d1d063 PX	168	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_int64, int64_t)
e8cd45c7	169	#define DEFINE_PROP_SIZE(_n, _s, _f, _d) \
3fb2111f	170	DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_size, uint64_t)
074a86fc	171	#define DEFINE_PROP_PCI_DEVFN(_n, _s, _f, _d) \
85bbd1e7	172	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_pci_devfn, int32_t)
074a86fc	173
c272758f MA	174	/*
	175	* Please avoid pointer properties. If you must use them, you must
	176	* cover them in their device's class init function as follows:
	177	*
	178	* - If the property must be set, the device cannot be used with
	179	* device_add, so add code like this:
	180	* \|* Reason: pointer property "NAME-OF-YOUR-PROP" *\|
	181	* DeviceClass *dc = DEVICE_CLASS(class);
e90f2a8c	182	* dc->user_creatable = false;
c272758f MA	183	*
	184	* - If the property may safely remain null, document it like this:
	185	* \|*
	186	* * Note: pointer property "interrupt_vector" may remain null, thus
e90f2a8c	187	* * no need for dc->user_creatable = false;
c272758f MA	188	* *\|
c272758f MA	189	*/
074a86fc AL	190	#define DEFINE_PROP_PTR(_n, _s, _f) \
074a86fc AL	191	DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, void*)
c272758f	192
074a86fc	193	#define DEFINE_PROP_CHR(_n, _s, _f) \
becdfa00	194	DEFINE_PROP(_n, _s, _f, qdev_prop_chr, CharBackend)
074a86fc AL	195	#define DEFINE_PROP_STRING(_n, _s, _f) \
	196	DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
	197	#define DEFINE_PROP_NETDEV(_n, _s, _f) \
1ceef9f2	198	DEFINE_PROP(_n, _s, _f, qdev_prop_netdev, NICPeers)
074a86fc	199	#define DEFINE_PROP_DRIVE(_n, _s, _f) \
4be74634	200	DEFINE_PROP(_n, _s, _f, qdev_prop_drive, BlockBackend *)
074a86fc AL	201	#define DEFINE_PROP_MACADDR(_n, _s, _f) \
074a86fc AL	202	DEFINE_PROP(_n, _s, _f, qdev_prop_macaddr, MACAddr)
55e8a154	203	#define DEFINE_PROP_ON_OFF_AUTO(_n, _s, _f, _d) \
85bbd1e7	204	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_on_off_auto, OnOffAuto)
074a86fc	205	#define DEFINE_PROP_LOSTTICKPOLICY(_n, _s, _f, _d) \
85bbd1e7	206	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_losttickpolicy, \
074a86fc	207	LostTickPolicy)
8c398252	208	#define DEFINE_PROP_BLOCKDEV_ON_ERROR(_n, _s, _f, _d) \
85bbd1e7	209	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_blockdev_on_error, \
8c398252	210	BlockdevOnError)
074a86fc	211	#define DEFINE_PROP_BIOS_CHS_TRANS(_n, _s, _f, _d) \
85bbd1e7	212	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_bios_chs_trans, int)
0eb28a42	213	#define DEFINE_PROP_BLOCKSIZE(_n, _s, _f) \
3fb2111f	214	DEFINE_PROP_UNSIGNED(_n, _s, _f, 0, qdev_prop_blocksize, uint16_t)
074a86fc AL	215	#define DEFINE_PROP_PCI_HOST_DEVADDR(_n, _s, _f) \
074a86fc AL	216	DEFINE_PROP(_n, _s, _f, qdev_prop_pci_host_devaddr, PCIHostDeviceAddress)
ed03d749 FK	217	#define DEFINE_PROP_MEMORY_REGION(_n, _s, _f) \
ed03d749 FK	218	DEFINE_PROP(_n, _s, _f, qdev_prop_ptr, MemoryRegion *)
c3bbbdbf AW	219	#define DEFINE_PROP_OFF_AUTO_PCIBAR(_n, _s, _f, _d) \
	220	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_off_auto_pcibar, \
	221	OffAutoPCIBAR)
4695a2c5 AW	222	#define DEFINE_PROP_PCIE_LINK_SPEED(_n, _s, _f, _d) \
	223	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_pcie_link_speed, \
	224	PCIExpLinkSpeed)
	225	#define DEFINE_PROP_PCIE_LINK_WIDTH(_n, _s, _f, _d) \
	226	DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_pcie_link_width, \
	227	PCIExpLinkWidth)
074a86fc	228
87e6ed56 RK	229	#define DEFINE_PROP_UUID(_name, _state, _field) { \
	230	.name = (_name), \
	231	.info = &qdev_prop_uuid, \
	232	.offset = offsetof(_state, _field) \
	233	+ type_check(QemuUUID, typeof_field(_state, _field)), \
	234	.set_default = true, \
	235	}
	236
074a86fc AL	237	#define DEFINE_PROP_END_OF_LIST() \
	238	{}
	239
	240	/* Set properties between creation and init. */
	241	void qdev_get_prop_ptr(DeviceState dev, Property *prop);
074a86fc AL	242	void qdev_prop_set_bit(DeviceState dev, const char name, bool value);
	243	void qdev_prop_set_uint8(DeviceState dev, const char name, uint8_t value);
	244	void qdev_prop_set_uint16(DeviceState dev, const char name, uint16_t value);
	245	void qdev_prop_set_uint32(DeviceState dev, const char name, uint32_t value);
	246	void qdev_prop_set_int32(DeviceState dev, const char name, int32_t value);
	247	void qdev_prop_set_uint64(DeviceState dev, const char name, uint64_t value);
	248	void qdev_prop_set_string(DeviceState dev, const char name, const char *value);
0ec7b3e7	249	void qdev_prop_set_chr(DeviceState dev, const char name, Chardev *value);
074a86fc	250	void qdev_prop_set_netdev(DeviceState dev, const char name, NetClientState *value);
9b3d111a MA	251	void qdev_prop_set_drive(DeviceState dev, const char name,
9b3d111a MA	252	BlockBackend value, Error *errp);
606fd0e2 KK	253	void qdev_prop_set_macaddr(DeviceState dev, const char name,
606fd0e2 KK	254	const uint8_t *value);
074a86fc AL	255	void qdev_prop_set_enum(DeviceState dev, const char name, int value);
	256	/* FIXME: Remove opaque pointer properties. */
	257	void qdev_prop_set_ptr(DeviceState dev, const char name, void *value);
	258
a404b612	259	void qdev_prop_register_global(GlobalProperty *prop);
d828c430	260	int qdev_prop_check_globals(void);
25f8dd96	261	void qdev_prop_set_globals(DeviceState *dev);
074a86fc AL	262	void error_set_from_qdev_prop_error(Error *errp, int ret, DeviceState dev,
	263	Property prop, const char value);
	264
	265	/**
d9d8d452 C	266	* qdev_property_add_static:
	267	* @dev: Device to add the property to.
	268	* @prop: The qdev property definition.
	269	* @errp: location to store error information.
	270	*
	271	* Add a static QOM property to @dev for qdev property @prop.
	272	* On error, store error in @errp. Static properties access data in a struct.
	273	* The type of the QOM property is derived from prop->info.
074a86fc AL	274	*/
	275	void qdev_property_add_static(DeviceState dev, Property prop, Error **errp);
	276
67cc7e0a SH	277	void qdev_alias_all_properties(DeviceState target, Object source);
67cc7e0a SH	278
b000dfbd PM	279	/**
	280	* @qdev_prop_set_after_realize:
	281	* @dev: device
	282	* @name: name of property
	283	* @errp: indirect pointer to Error to be set
	284	* Set the Error object to report that an attempt was made to set a property
	285	* on a device after it has already been realized. This is a utility function
	286	* which allows property-setter functions to easily report the error in
	287	* a friendly format identifying both the device and the property.
	288	*/
	289	void qdev_prop_set_after_realize(DeviceState dev, const char name,
	290	Error **errp);
39f72ef9 SH	291
	292	/**
	293	* qdev_prop_allow_set_link_before_realize:
	294	*
	295	* Set the #Error object if an attempt is made to set the link after realize.
	296	* This function should be used as the check() argument to
	297	* object_property_add_link().
	298	*/
8f5d58ef IM	299	void qdev_prop_allow_set_link_before_realize(const Object *obj,
8f5d58ef IM	300	const char *name,
39f72ef9 SH	301	Object val, Error *errp);
39f72ef9 SH	302
074a86fc	303	#endif