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