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