xref: /openbmc/qemu/include/hw/qdev-properties.h (revision d2dfe0b5)
1 #ifndef QEMU_QDEV_PROPERTIES_H
2 #define QEMU_QDEV_PROPERTIES_H
3 
4 #include "hw/qdev-core.h"
5 
6 /**
7  * Property:
8  * @set_default: true if the default value should be set from @defval,
9  *    in which case @info->set_default_value must not be NULL
10  *    (if false then no default value is set by the property system
11  *     and the field retains whatever value it was given by instance_init).
12  * @defval: default value for the property. This is used only if @set_default
13  *     is true.
14  */
15 struct Property {
16     const char   *name;
17     const PropertyInfo *info;
18     ptrdiff_t    offset;
19     uint8_t      bitnr;
20     uint64_t     bitmask;
21     bool         set_default;
22     union {
23         int64_t i;
24         uint64_t u;
25     } defval;
26     int          arrayoffset;
27     const PropertyInfo *arrayinfo;
28     int          arrayfieldsize;
29     const char   *link_type;
30 };
31 
32 struct PropertyInfo {
33     const char *name;
34     const char *description;
35     const QEnumLookup *enum_table;
36     bool realized_set_allowed; /* allow setting property on realized device */
37     int (*print)(Object *obj, Property *prop, char *dest, size_t len);
38     void (*set_default_value)(ObjectProperty *op, const Property *prop);
39     ObjectProperty *(*create)(ObjectClass *oc, const char *name,
40                               Property *prop);
41     ObjectPropertyAccessor *get;
42     ObjectPropertyAccessor *set;
43     ObjectPropertyRelease *release;
44 };
45 
46 
47 /*** qdev-properties.c ***/
48 
49 extern const PropertyInfo qdev_prop_bit;
50 extern const PropertyInfo qdev_prop_bit64;
51 extern const PropertyInfo qdev_prop_bool;
52 extern const PropertyInfo qdev_prop_enum;
53 extern const PropertyInfo qdev_prop_uint8;
54 extern const PropertyInfo qdev_prop_uint16;
55 extern const PropertyInfo qdev_prop_uint32;
56 extern const PropertyInfo qdev_prop_int32;
57 extern const PropertyInfo qdev_prop_uint64;
58 extern const PropertyInfo qdev_prop_uint64_checkmask;
59 extern const PropertyInfo qdev_prop_int64;
60 extern const PropertyInfo qdev_prop_size;
61 extern const PropertyInfo qdev_prop_string;
62 extern const PropertyInfo qdev_prop_on_off_auto;
63 extern const PropertyInfo qdev_prop_size32;
64 extern const PropertyInfo qdev_prop_arraylen;
65 extern const PropertyInfo qdev_prop_link;
66 
67 #define DEFINE_PROP(_name, _state, _field, _prop, _type, ...) {  \
68         .name      = (_name),                                    \
69         .info      = &(_prop),                                   \
70         .offset    = offsetof(_state, _field)                    \
71             + type_check(_type, typeof_field(_state, _field)),   \
72         __VA_ARGS__                                              \
73         }
74 
75 #define DEFINE_PROP_SIGNED(_name, _state, _field, _defval, _prop, _type) \
76     DEFINE_PROP(_name, _state, _field, _prop, _type,                     \
77                 .set_default = true,                                     \
78                 .defval.i    = (_type)_defval)
79 
80 #define DEFINE_PROP_SIGNED_NODEFAULT(_name, _state, _field, _prop, _type) \
81     DEFINE_PROP(_name, _state, _field, _prop, _type)
82 
83 #define DEFINE_PROP_BIT(_name, _state, _field, _bit, _defval)   \
84     DEFINE_PROP(_name, _state, _field, qdev_prop_bit, uint32_t, \
85                 .bitnr       = (_bit),                          \
86                 .set_default = true,                            \
87                 .defval.u    = (bool)_defval)
88 
89 #define DEFINE_PROP_UNSIGNED(_name, _state, _field, _defval, _prop, _type) \
90     DEFINE_PROP(_name, _state, _field, _prop, _type,                       \
91                 .set_default = true,                                       \
92                 .defval.u  = (_type)_defval)
93 
94 #define DEFINE_PROP_UNSIGNED_NODEFAULT(_name, _state, _field, _prop, _type) \
95     DEFINE_PROP(_name, _state, _field, _prop, _type)
96 
97 #define DEFINE_PROP_BIT64(_name, _state, _field, _bit, _defval)   \
98     DEFINE_PROP(_name, _state, _field, qdev_prop_bit64, uint64_t, \
99                 .bitnr    = (_bit),                               \
100                 .set_default = true,                              \
101                 .defval.u  = (bool)_defval)
102 
103 #define DEFINE_PROP_BOOL(_name, _state, _field, _defval)     \
104     DEFINE_PROP(_name, _state, _field, qdev_prop_bool, bool, \
105                 .set_default = true,                         \
106                 .defval.u    = (bool)_defval)
107 
108 /**
109  * The DEFINE_PROP_UINT64_CHECKMASK macro checks a user-supplied value
110  * against corresponding bitmask, rejects the value if it violates.
111  * The default value is set in instance_init().
112  */
113 #define DEFINE_PROP_UINT64_CHECKMASK(_name, _state, _field, _bitmask)   \
114     DEFINE_PROP(_name, _state, _field, qdev_prop_uint64_checkmask, uint64_t, \
115                 .bitmask    = (_bitmask),                     \
116                 .set_default = false)
117 
118 #define PROP_ARRAY_LEN_PREFIX "len-"
119 
120 /**
121  * DEFINE_PROP_ARRAY:
122  * @_name: name of the array
123  * @_state: name of the device state structure type
124  * @_field: uint32_t field in @_state to hold the array length
125  * @_arrayfield: field in @_state (of type '@_arraytype *') which
126  *               will point to the array
127  * @_arrayprop: PropertyInfo defining what property the array elements have
128  * @_arraytype: C type of the array elements
129  *
130  * Define device properties for a variable-length array _name.  A
131  * static property "len-arrayname" is defined. When the device creator
132  * sets this property to the desired length of array, further dynamic
133  * properties "arrayname[0]", "arrayname[1]", ...  are defined so the
134  * device creator can set the array element values. Setting the
135  * "len-arrayname" property more than once is an error.
136  *
137  * When the array length is set, the @_field member of the device
138  * struct is set to the array length, and @_arrayfield is set to point
139  * to (zero-initialised) memory allocated for the array.  For a zero
140  * length array, @_field will be set to 0 and @_arrayfield to NULL.
141  * It is the responsibility of the device deinit code to free the
142  * @_arrayfield memory.
143  */
144 #define DEFINE_PROP_ARRAY(_name, _state, _field,               \
145                           _arrayfield, _arrayprop, _arraytype) \
146     DEFINE_PROP((PROP_ARRAY_LEN_PREFIX _name),                 \
147                 _state, _field, qdev_prop_arraylen, uint32_t,  \
148                 .set_default = true,                           \
149                 .defval.u = 0,                                 \
150                 .arrayinfo = &(_arrayprop),                    \
151                 .arrayfieldsize = sizeof(_arraytype),          \
152                 .arrayoffset = offsetof(_state, _arrayfield))
153 
154 #define DEFINE_PROP_LINK(_name, _state, _field, _type, _ptr_type)     \
155     DEFINE_PROP(_name, _state, _field, qdev_prop_link, _ptr_type,     \
156                 .link_type  = _type)
157 
158 #define DEFINE_PROP_UINT8(_n, _s, _f, _d)                       \
159     DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint8, uint8_t)
160 #define DEFINE_PROP_UINT16(_n, _s, _f, _d)                      \
161     DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint16, uint16_t)
162 #define DEFINE_PROP_UINT32(_n, _s, _f, _d)                      \
163     DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint32, uint32_t)
164 #define DEFINE_PROP_INT32(_n, _s, _f, _d)                      \
165     DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_int32, int32_t)
166 #define DEFINE_PROP_UINT64(_n, _s, _f, _d)                      \
167     DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_uint64, uint64_t)
168 #define DEFINE_PROP_INT64(_n, _s, _f, _d)                      \
169     DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_int64, int64_t)
170 #define DEFINE_PROP_SIZE(_n, _s, _f, _d)                       \
171     DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_size, uint64_t)
172 #define DEFINE_PROP_STRING(_n, _s, _f)             \
173     DEFINE_PROP(_n, _s, _f, qdev_prop_string, char*)
174 #define DEFINE_PROP_ON_OFF_AUTO(_n, _s, _f, _d) \
175     DEFINE_PROP_SIGNED(_n, _s, _f, _d, qdev_prop_on_off_auto, OnOffAuto)
176 #define DEFINE_PROP_SIZE32(_n, _s, _f, _d)                       \
177     DEFINE_PROP_UNSIGNED(_n, _s, _f, _d, qdev_prop_size32, uint32_t)
178 
179 #define DEFINE_PROP_END_OF_LIST()               \
180     {}
181 
182 /*
183  * Set properties between creation and realization.
184  *
185  * Returns: %true on success, %false on error.
186  */
187 bool qdev_prop_set_drive_err(DeviceState *dev, const char *name,
188                              BlockBackend *value, Error **errp);
189 
190 /*
191  * Set properties between creation and realization.
192  * @value must be valid.  Each property may be set at most once.
193  */
194 void qdev_prop_set_bit(DeviceState *dev, const char *name, bool value);
195 void qdev_prop_set_uint8(DeviceState *dev, const char *name, uint8_t value);
196 void qdev_prop_set_uint16(DeviceState *dev, const char *name, uint16_t value);
197 void qdev_prop_set_uint32(DeviceState *dev, const char *name, uint32_t value);
198 void qdev_prop_set_int32(DeviceState *dev, const char *name, int32_t value);
199 void qdev_prop_set_uint64(DeviceState *dev, const char *name, uint64_t value);
200 void qdev_prop_set_string(DeviceState *dev, const char *name, const char *value);
201 void qdev_prop_set_chr(DeviceState *dev, const char *name, Chardev *value);
202 void qdev_prop_set_netdev(DeviceState *dev, const char *name, NetClientState *value);
203 void qdev_prop_set_drive(DeviceState *dev, const char *name,
204                          BlockBackend *value);
205 void qdev_prop_set_macaddr(DeviceState *dev, const char *name,
206                            const uint8_t *value);
207 void qdev_prop_set_enum(DeviceState *dev, const char *name, int value);
208 
209 void *object_field_prop_ptr(Object *obj, Property *prop);
210 
211 void qdev_prop_register_global(GlobalProperty *prop);
212 const GlobalProperty *qdev_find_global_prop(Object *obj,
213                                             const char *name);
214 int qdev_prop_check_globals(void);
215 void qdev_prop_set_globals(DeviceState *dev);
216 void error_set_from_qdev_prop_error(Error **errp, int ret, Object *obj,
217                                     const char *name, const char *value);
218 
219 /**
220  * qdev_property_add_static:
221  * @dev: Device to add the property to.
222  * @prop: The qdev property definition.
223  *
224  * Add a static QOM property to @dev for qdev property @prop.
225  * On error, store error in @errp.  Static properties access data in a struct.
226  * The type of the QOM property is derived from prop->info.
227  */
228 void qdev_property_add_static(DeviceState *dev, Property *prop);
229 
230 /**
231  * qdev_alias_all_properties: Create aliases on source for all target properties
232  * @target: Device which has properties to be aliased
233  * @source: Object to add alias properties to
234  *
235  * Add alias properties to the @source object for all qdev properties on
236  * the @target DeviceState.
237  *
238  * This is useful when @target is an internal implementation object
239  * owned by @source, and you want to expose all the properties of that
240  * implementation object as properties on the @source object so that users
241  * of @source can set them.
242  */
243 void qdev_alias_all_properties(DeviceState *target, Object *source);
244 
245 /**
246  * @qdev_prop_set_after_realize:
247  * @dev: device
248  * @name: name of property
249  * @errp: indirect pointer to Error to be set
250  * Set the Error object to report that an attempt was made to set a property
251  * on a device after it has already been realized. This is a utility function
252  * which allows property-setter functions to easily report the error in
253  * a friendly format identifying both the device and the property.
254  */
255 void qdev_prop_set_after_realize(DeviceState *dev, const char *name,
256                                  Error **errp);
257 
258 /**
259  * qdev_prop_allow_set_link_before_realize:
260  *
261  * Set the #Error object if an attempt is made to set the link after realize.
262  * This function should be used as the check() argument to
263  * object_property_add_link().
264  */
265 void qdev_prop_allow_set_link_before_realize(const Object *obj,
266                                              const char *name,
267                                              Object *val, Error **errp);
268 
269 #endif
270