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