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