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