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