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