1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _LINUX_VDPA_H 3 #define _LINUX_VDPA_H 4 5 #include <linux/kernel.h> 6 #include <linux/device.h> 7 #include <linux/interrupt.h> 8 #include <linux/vhost_iotlb.h> 9 #include <linux/virtio_net.h> 10 #include <linux/if_ether.h> 11 12 /** 13 * struct vdpa_calllback - vDPA callback definition. 14 * @callback: interrupt callback function 15 * @private: the data passed to the callback function 16 */ 17 struct vdpa_callback { 18 irqreturn_t (*callback)(void *data); 19 void *private; 20 }; 21 22 /** 23 * struct vdpa_notification_area - vDPA notification area 24 * @addr: base address of the notification area 25 * @size: size of the notification area 26 */ 27 struct vdpa_notification_area { 28 resource_size_t addr; 29 resource_size_t size; 30 }; 31 32 /** 33 * struct vdpa_vq_state_split - vDPA split virtqueue state 34 * @avail_index: available index 35 */ 36 struct vdpa_vq_state_split { 37 u16 avail_index; 38 }; 39 40 /** 41 * struct vdpa_vq_state_packed - vDPA packed virtqueue state 42 * @last_avail_counter: last driver ring wrap counter observed by device 43 * @last_avail_idx: device available index 44 * @last_used_counter: device ring wrap counter 45 * @last_used_idx: used index 46 */ 47 struct vdpa_vq_state_packed { 48 u16 last_avail_counter:1; 49 u16 last_avail_idx:15; 50 u16 last_used_counter:1; 51 u16 last_used_idx:15; 52 }; 53 54 struct vdpa_vq_state { 55 union { 56 struct vdpa_vq_state_split split; 57 struct vdpa_vq_state_packed packed; 58 }; 59 }; 60 61 struct vdpa_mgmt_dev; 62 63 /** 64 * struct vdpa_device - representation of a vDPA device 65 * @dev: underlying device 66 * @dma_dev: the actual device that is performing DMA 67 * @driver_override: driver name to force a match 68 * @config: the configuration ops for this device. 69 * @cf_mutex: Protects get and set access to configuration layout. 70 * @index: device index 71 * @features_valid: were features initialized? for legacy guests 72 * @use_va: indicate whether virtual address must be used by this device 73 * @nvqs: maximum number of supported virtqueues 74 * @mdev: management device pointer; caller must setup when registering device as part 75 * of dev_add() mgmtdev ops callback before invoking _vdpa_register_device(). 76 */ 77 struct vdpa_device { 78 struct device dev; 79 struct device *dma_dev; 80 const char *driver_override; 81 const struct vdpa_config_ops *config; 82 struct mutex cf_mutex; /* Protects get/set config */ 83 unsigned int index; 84 bool features_valid; 85 bool use_va; 86 u32 nvqs; 87 struct vdpa_mgmt_dev *mdev; 88 }; 89 90 /** 91 * struct vdpa_iova_range - the IOVA range support by the device 92 * @first: start of the IOVA range 93 * @last: end of the IOVA range 94 */ 95 struct vdpa_iova_range { 96 u64 first; 97 u64 last; 98 }; 99 100 struct vdpa_dev_set_config { 101 struct { 102 u8 mac[ETH_ALEN]; 103 u16 mtu; 104 u16 max_vq_pairs; 105 } net; 106 u64 mask; 107 }; 108 109 /** 110 * Corresponding file area for device memory mapping 111 * @file: vma->vm_file for the mapping 112 * @offset: mapping offset in the vm_file 113 */ 114 struct vdpa_map_file { 115 struct file *file; 116 u64 offset; 117 }; 118 119 /** 120 * struct vdpa_config_ops - operations for configuring a vDPA device. 121 * Note: vDPA device drivers are required to implement all of the 122 * operations unless it is mentioned to be optional in the following 123 * list. 124 * 125 * @set_vq_address: Set the address of virtqueue 126 * @vdev: vdpa device 127 * @idx: virtqueue index 128 * @desc_area: address of desc area 129 * @driver_area: address of driver area 130 * @device_area: address of device area 131 * Returns integer: success (0) or error (< 0) 132 * @set_vq_num: Set the size of virtqueue 133 * @vdev: vdpa device 134 * @idx: virtqueue index 135 * @num: the size of virtqueue 136 * @kick_vq: Kick the virtqueue 137 * @vdev: vdpa device 138 * @idx: virtqueue index 139 * @set_vq_cb: Set the interrupt callback function for 140 * a virtqueue 141 * @vdev: vdpa device 142 * @idx: virtqueue index 143 * @cb: virtio-vdev interrupt callback structure 144 * @set_vq_ready: Set ready status for a virtqueue 145 * @vdev: vdpa device 146 * @idx: virtqueue index 147 * @ready: ready (true) not ready(false) 148 * @get_vq_ready: Get ready status for a virtqueue 149 * @vdev: vdpa device 150 * @idx: virtqueue index 151 * Returns boolean: ready (true) or not (false) 152 * @set_vq_state: Set the state for a virtqueue 153 * @vdev: vdpa device 154 * @idx: virtqueue index 155 * @state: pointer to set virtqueue state (last_avail_idx) 156 * Returns integer: success (0) or error (< 0) 157 * @get_vq_state: Get the state for a virtqueue 158 * @vdev: vdpa device 159 * @idx: virtqueue index 160 * @state: pointer to returned state (last_avail_idx) 161 * @get_vq_notification: Get the notification area for a virtqueue (optional) 162 * @vdev: vdpa device 163 * @idx: virtqueue index 164 * Returns the notifcation area 165 * @get_vq_irq: Get the irq number of a virtqueue (optional, 166 * but must implemented if require vq irq offloading) 167 * @vdev: vdpa device 168 * @idx: virtqueue index 169 * Returns int: irq number of a virtqueue, 170 * negative number if no irq assigned. 171 * @get_vq_align: Get the virtqueue align requirement 172 * for the device 173 * @vdev: vdpa device 174 * Returns virtqueue algin requirement 175 * @get_device_features: Get virtio features supported by the device 176 * @vdev: vdpa device 177 * Returns the virtio features support by the 178 * device 179 * @set_driver_features: Set virtio features supported by the driver 180 * @vdev: vdpa device 181 * @features: feature support by the driver 182 * Returns integer: success (0) or error (< 0) 183 * @get_driver_features: Get the virtio driver features in action 184 * @vdev: vdpa device 185 * Returns the virtio features accepted 186 * @set_config_cb: Set the config interrupt callback 187 * @vdev: vdpa device 188 * @cb: virtio-vdev interrupt callback structure 189 * @get_vq_num_max: Get the max size of virtqueue 190 * @vdev: vdpa device 191 * Returns u16: max size of virtqueue 192 * @get_vq_num_min: Get the min size of virtqueue (optional) 193 * @vdev: vdpa device 194 * Returns u16: min size of virtqueue 195 * @get_device_id: Get virtio device id 196 * @vdev: vdpa device 197 * Returns u32: virtio device id 198 * @get_vendor_id: Get id for the vendor that provides this device 199 * @vdev: vdpa device 200 * Returns u32: virtio vendor id 201 * @get_status: Get the device status 202 * @vdev: vdpa device 203 * Returns u8: virtio device status 204 * @set_status: Set the device status 205 * @vdev: vdpa device 206 * @status: virtio device status 207 * @reset: Reset device 208 * @vdev: vdpa device 209 * Returns integer: success (0) or error (< 0) 210 * @get_config_size: Get the size of the configuration space includes 211 * fields that are conditional on feature bits. 212 * @vdev: vdpa device 213 * Returns size_t: configuration size 214 * @get_config: Read from device specific configuration space 215 * @vdev: vdpa device 216 * @offset: offset from the beginning of 217 * configuration space 218 * @buf: buffer used to read to 219 * @len: the length to read from 220 * configuration space 221 * @set_config: Write to device specific configuration space 222 * @vdev: vdpa device 223 * @offset: offset from the beginning of 224 * configuration space 225 * @buf: buffer used to write from 226 * @len: the length to write to 227 * configuration space 228 * @get_generation: Get device config generation (optional) 229 * @vdev: vdpa device 230 * Returns u32: device generation 231 * @get_iova_range: Get supported iova range (optional) 232 * @vdev: vdpa device 233 * Returns the iova range supported by 234 * the device. 235 * @set_map: Set device memory mapping (optional) 236 * Needed for device that using device 237 * specific DMA translation (on-chip IOMMU) 238 * @vdev: vdpa device 239 * @iotlb: vhost memory mapping to be 240 * used by the vDPA 241 * Returns integer: success (0) or error (< 0) 242 * @dma_map: Map an area of PA to IOVA (optional) 243 * Needed for device that using device 244 * specific DMA translation (on-chip IOMMU) 245 * and preferring incremental map. 246 * @vdev: vdpa device 247 * @iova: iova to be mapped 248 * @size: size of the area 249 * @pa: physical address for the map 250 * @perm: device access permission (VHOST_MAP_XX) 251 * Returns integer: success (0) or error (< 0) 252 * @dma_unmap: Unmap an area of IOVA (optional but 253 * must be implemented with dma_map) 254 * Needed for device that using device 255 * specific DMA translation (on-chip IOMMU) 256 * and preferring incremental unmap. 257 * @vdev: vdpa device 258 * @iova: iova to be unmapped 259 * @size: size of the area 260 * Returns integer: success (0) or error (< 0) 261 * @free: Free resources that belongs to vDPA (optional) 262 * @vdev: vdpa device 263 */ 264 struct vdpa_config_ops { 265 /* Virtqueue ops */ 266 int (*set_vq_address)(struct vdpa_device *vdev, 267 u16 idx, u64 desc_area, u64 driver_area, 268 u64 device_area); 269 void (*set_vq_num)(struct vdpa_device *vdev, u16 idx, u32 num); 270 void (*kick_vq)(struct vdpa_device *vdev, u16 idx); 271 void (*set_vq_cb)(struct vdpa_device *vdev, u16 idx, 272 struct vdpa_callback *cb); 273 void (*set_vq_ready)(struct vdpa_device *vdev, u16 idx, bool ready); 274 bool (*get_vq_ready)(struct vdpa_device *vdev, u16 idx); 275 int (*set_vq_state)(struct vdpa_device *vdev, u16 idx, 276 const struct vdpa_vq_state *state); 277 int (*get_vq_state)(struct vdpa_device *vdev, u16 idx, 278 struct vdpa_vq_state *state); 279 struct vdpa_notification_area 280 (*get_vq_notification)(struct vdpa_device *vdev, u16 idx); 281 /* vq irq is not expected to be changed once DRIVER_OK is set */ 282 int (*get_vq_irq)(struct vdpa_device *vdev, u16 idx); 283 284 /* Device ops */ 285 u32 (*get_vq_align)(struct vdpa_device *vdev); 286 u64 (*get_device_features)(struct vdpa_device *vdev); 287 int (*set_driver_features)(struct vdpa_device *vdev, u64 features); 288 u64 (*get_driver_features)(struct vdpa_device *vdev); 289 void (*set_config_cb)(struct vdpa_device *vdev, 290 struct vdpa_callback *cb); 291 u16 (*get_vq_num_max)(struct vdpa_device *vdev); 292 u16 (*get_vq_num_min)(struct vdpa_device *vdev); 293 u32 (*get_device_id)(struct vdpa_device *vdev); 294 u32 (*get_vendor_id)(struct vdpa_device *vdev); 295 u8 (*get_status)(struct vdpa_device *vdev); 296 void (*set_status)(struct vdpa_device *vdev, u8 status); 297 int (*reset)(struct vdpa_device *vdev); 298 size_t (*get_config_size)(struct vdpa_device *vdev); 299 void (*get_config)(struct vdpa_device *vdev, unsigned int offset, 300 void *buf, unsigned int len); 301 void (*set_config)(struct vdpa_device *vdev, unsigned int offset, 302 const void *buf, unsigned int len); 303 u32 (*get_generation)(struct vdpa_device *vdev); 304 struct vdpa_iova_range (*get_iova_range)(struct vdpa_device *vdev); 305 306 /* DMA ops */ 307 int (*set_map)(struct vdpa_device *vdev, struct vhost_iotlb *iotlb); 308 int (*dma_map)(struct vdpa_device *vdev, u64 iova, u64 size, 309 u64 pa, u32 perm, void *opaque); 310 int (*dma_unmap)(struct vdpa_device *vdev, u64 iova, u64 size); 311 312 /* Free device resources */ 313 void (*free)(struct vdpa_device *vdev); 314 }; 315 316 struct vdpa_device *__vdpa_alloc_device(struct device *parent, 317 const struct vdpa_config_ops *config, 318 size_t size, const char *name, 319 bool use_va); 320 321 /** 322 * vdpa_alloc_device - allocate and initilaize a vDPA device 323 * 324 * @dev_struct: the type of the parent structure 325 * @member: the name of struct vdpa_device within the @dev_struct 326 * @parent: the parent device 327 * @config: the bus operations that is supported by this device 328 * @name: name of the vdpa device 329 * @use_va: indicate whether virtual address must be used by this device 330 * 331 * Return allocated data structure or ERR_PTR upon error 332 */ 333 #define vdpa_alloc_device(dev_struct, member, parent, config, name, use_va) \ 334 container_of(__vdpa_alloc_device( \ 335 parent, config, \ 336 sizeof(dev_struct) + \ 337 BUILD_BUG_ON_ZERO(offsetof( \ 338 dev_struct, member)), name, use_va), \ 339 dev_struct, member) 340 341 int vdpa_register_device(struct vdpa_device *vdev, u32 nvqs); 342 void vdpa_unregister_device(struct vdpa_device *vdev); 343 344 int _vdpa_register_device(struct vdpa_device *vdev, u32 nvqs); 345 void _vdpa_unregister_device(struct vdpa_device *vdev); 346 347 /** 348 * struct vdpa_driver - operations for a vDPA driver 349 * @driver: underlying device driver 350 * @probe: the function to call when a device is found. Returns 0 or -errno. 351 * @remove: the function to call when a device is removed. 352 */ 353 struct vdpa_driver { 354 struct device_driver driver; 355 int (*probe)(struct vdpa_device *vdev); 356 void (*remove)(struct vdpa_device *vdev); 357 }; 358 359 #define vdpa_register_driver(drv) \ 360 __vdpa_register_driver(drv, THIS_MODULE) 361 int __vdpa_register_driver(struct vdpa_driver *drv, struct module *owner); 362 void vdpa_unregister_driver(struct vdpa_driver *drv); 363 364 #define module_vdpa_driver(__vdpa_driver) \ 365 module_driver(__vdpa_driver, vdpa_register_driver, \ 366 vdpa_unregister_driver) 367 368 static inline struct vdpa_driver *drv_to_vdpa(struct device_driver *driver) 369 { 370 return container_of(driver, struct vdpa_driver, driver); 371 } 372 373 static inline struct vdpa_device *dev_to_vdpa(struct device *_dev) 374 { 375 return container_of(_dev, struct vdpa_device, dev); 376 } 377 378 static inline void *vdpa_get_drvdata(const struct vdpa_device *vdev) 379 { 380 return dev_get_drvdata(&vdev->dev); 381 } 382 383 static inline void vdpa_set_drvdata(struct vdpa_device *vdev, void *data) 384 { 385 dev_set_drvdata(&vdev->dev, data); 386 } 387 388 static inline struct device *vdpa_get_dma_dev(struct vdpa_device *vdev) 389 { 390 return vdev->dma_dev; 391 } 392 393 static inline int vdpa_reset(struct vdpa_device *vdev) 394 { 395 const struct vdpa_config_ops *ops = vdev->config; 396 int ret; 397 398 mutex_lock(&vdev->cf_mutex); 399 vdev->features_valid = false; 400 ret = ops->reset(vdev); 401 mutex_unlock(&vdev->cf_mutex); 402 return ret; 403 } 404 405 static inline int vdpa_set_features_unlocked(struct vdpa_device *vdev, u64 features) 406 { 407 const struct vdpa_config_ops *ops = vdev->config; 408 int ret; 409 410 vdev->features_valid = true; 411 ret = ops->set_driver_features(vdev, features); 412 413 return ret; 414 } 415 416 static inline int vdpa_set_features(struct vdpa_device *vdev, u64 features) 417 { 418 int ret; 419 420 mutex_lock(&vdev->cf_mutex); 421 ret = vdpa_set_features_unlocked(vdev, features); 422 mutex_unlock(&vdev->cf_mutex); 423 424 return ret; 425 } 426 427 void vdpa_get_config(struct vdpa_device *vdev, unsigned int offset, 428 void *buf, unsigned int len); 429 void vdpa_set_config(struct vdpa_device *dev, unsigned int offset, 430 const void *buf, unsigned int length); 431 void vdpa_set_status(struct vdpa_device *vdev, u8 status); 432 433 /** 434 * struct vdpa_mgmtdev_ops - vdpa device ops 435 * @dev_add: Add a vdpa device using alloc and register 436 * @mdev: parent device to use for device addition 437 * @name: name of the new vdpa device 438 * @config: config attributes to apply to the device under creation 439 * Driver need to add a new device using _vdpa_register_device() 440 * after fully initializing the vdpa device. Driver must return 0 441 * on success or appropriate error code. 442 * @dev_del: Remove a vdpa device using unregister 443 * @mdev: parent device to use for device removal 444 * @dev: vdpa device to remove 445 * Driver need to remove the specified device by calling 446 * _vdpa_unregister_device(). 447 */ 448 struct vdpa_mgmtdev_ops { 449 int (*dev_add)(struct vdpa_mgmt_dev *mdev, const char *name, 450 const struct vdpa_dev_set_config *config); 451 void (*dev_del)(struct vdpa_mgmt_dev *mdev, struct vdpa_device *dev); 452 }; 453 454 /** 455 * struct vdpa_mgmt_dev - vdpa management device 456 * @device: Management parent device 457 * @ops: operations supported by management device 458 * @id_table: Pointer to device id table of supported ids 459 * @config_attr_mask: bit mask of attributes of type enum vdpa_attr that 460 * management device support during dev_add callback 461 * @list: list entry 462 */ 463 struct vdpa_mgmt_dev { 464 struct device *device; 465 const struct vdpa_mgmtdev_ops *ops; 466 const struct virtio_device_id *id_table; 467 u64 config_attr_mask; 468 struct list_head list; 469 u64 supported_features; 470 u32 max_supported_vqs; 471 }; 472 473 int vdpa_mgmtdev_register(struct vdpa_mgmt_dev *mdev); 474 void vdpa_mgmtdev_unregister(struct vdpa_mgmt_dev *mdev); 475 476 #endif /* _LINUX_VDPA_H */ 477