drivers/net/virtio/virtio_user/virtio_user_dev.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2016 Intel Corporation
   3  */
   4
   5 #ifndef _VIRTIO_USER_DEV_H
   6 #define _VIRTIO_USER_DEV_H
   7
   8 #include <limits.h>
   9 #include <stdbool.h>
  10
  11 #include "../virtio.h"
  12 #include "../virtio_ring.h"
  13
  14 enum virtio_user_backend_type {
  15         VIRTIO_USER_BACKEND_UNKNOWN,
  16         VIRTIO_USER_BACKEND_VHOST_USER,
  17         VIRTIO_USER_BACKEND_VHOST_KERNEL,
  18         VIRTIO_USER_BACKEND_VHOST_VDPA,
  19 };
  20
  21 struct virtio_user_queue {
  22         uint16_t used_idx;
  23         bool avail_wrap_counter;
  24         bool used_wrap_counter;
  25 };
  26
  27 struct virtio_user_dev {
  28         struct virtio_hw hw;
  29         enum virtio_user_backend_type backend_type;
  30         bool            is_server;  /* server or client mode */
  31
  32         /* for vhost_vdpa backend */
  33         int             vhostfd;
  34
  35         /* for both vhost_user and vhost_kernel */
  36         int             callfds[VIRTIO_MAX_VIRTQUEUES];
  37         int             kickfds[VIRTIO_MAX_VIRTQUEUES];
  38         int             mac_specified;
  39         uint32_t        max_queue_pairs;
  40         uint32_t        queue_pairs;
  41         uint32_t        queue_size;
  42         uint64_t        features; /* the negotiated features with driver,
  43                                    * and will be sync with device
  44                                    */
  45         uint64_t        device_features; /* supported features by device */
  46         uint64_t        frontend_features; /* enabled frontend features */
  47         uint64_t        unsupported_features; /* unsupported features mask */
  48         uint64_t        protocol_features; /* negotiated protocol features */
  49         uint8_t         status;
  50         uint16_t        net_status;
  51         uint16_t        port_id;
  52         uint8_t         mac_addr[RTE_ETHER_ADDR_LEN];
  53         char            path[PATH_MAX];
  54         char            *ifname;
  55
  56         union {
  57                 struct vring            vrings[VIRTIO_MAX_VIRTQUEUES];
  58                 struct vring_packed     packed_vrings[VIRTIO_MAX_VIRTQUEUES];
  59         };
  60         struct virtio_user_queue packed_queues[VIRTIO_MAX_VIRTQUEUES];
  61         bool            qp_enabled[VIRTIO_MAX_VIRTQUEUE_PAIRS];
  62
  63         struct virtio_user_backend_ops *ops;
  64         pthread_mutex_t mutex;
  65         bool            started;
  66
  67         void *backend_data;
  68 };
  69
  70 int virtio_user_dev_set_features(struct virtio_user_dev *dev);
  71 int virtio_user_start_device(struct virtio_user_dev *dev);
  72 int virtio_user_stop_device(struct virtio_user_dev *dev);
  73 int virtio_user_dev_init(struct virtio_user_dev *dev, char *path, int queues,
  74                          int cq, int queue_size, const char *mac, char **ifname,
  75                          int server, int mrg_rxbuf, int in_order,
  76                          int packed_vq,
  77                          enum virtio_user_backend_type backend_type);
  78 void virtio_user_dev_uninit(struct virtio_user_dev *dev);
  79 void virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx);
  80 void virtio_user_handle_cq_packed(struct virtio_user_dev *dev,
  81                                   uint16_t queue_idx);
  82 uint8_t virtio_user_handle_mq(struct virtio_user_dev *dev, uint16_t q_pairs);
  83 int virtio_user_dev_set_status(struct virtio_user_dev *dev, uint8_t status);
  84 int virtio_user_dev_update_status(struct virtio_user_dev *dev);
  85 int virtio_user_dev_update_link_state(struct virtio_user_dev *dev);
  86 void virtio_user_dev_delayed_handler(void *param);
  87 int virtio_user_dev_server_reconnect(struct virtio_user_dev *dev);
  88 extern const char * const virtio_user_backend_strings[];
  89 #endif