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