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