drivers/net/virtio/virtio_user/virtio_user_dev.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2016 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _VIRTIO_USER_DEV_H
  35 #define _VIRTIO_USER_DEV_H
  36
  37 #include <limits.h>
  38 #include "../virtio_pci.h"
  39 #include "../virtio_ring.h"
  40 #include "vhost.h"
  41
  42 struct virtio_user_dev {
  43         /* for vhost_user backend */
  44         int             vhostfd;
  45
  46         /* for vhost_kernel backend */
  47         char            *ifname;
  48         int             *vhostfds;
  49         int             *tapfds;
  50
  51         /* for both vhost_user and vhost_kernel */
  52         int             callfds[VIRTIO_MAX_VIRTQUEUES];
  53         int             kickfds[VIRTIO_MAX_VIRTQUEUES];
  54         int             mac_specified;
  55         uint32_t        max_queue_pairs;
  56         uint32_t        queue_pairs;
  57         uint32_t        queue_size;
  58         uint64_t        features; /* the negotiated features with driver,
  59                                    * and will be sync with device
  60                                    */
  61         uint64_t        device_features; /* supported features by device */
  62         uint8_t         status;
  63         uint8_t         port_id;
  64         uint8_t         mac_addr[ETHER_ADDR_LEN];
  65         char            path[PATH_MAX];
  66         struct vring    vrings[VIRTIO_MAX_VIRTQUEUES];
  67         struct virtio_user_backend_ops *ops;
  68 };
  69
  70 int is_vhost_user_by_type(const char *path);
  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 void virtio_user_dev_uninit(struct virtio_user_dev *dev);
  76 void virtio_user_handle_cq(struct virtio_user_dev *dev, uint16_t queue_idx);
  77 #endif