LXR qemu/include/hw/qdev-properties.h

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