drivers/net/virtio/virtio.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  * Copyright(c) 2021 Red Hat, Inc.
   4  */
   5
   6 #ifndef _VIRTIO_H_
   7 #define _VIRTIO_H_
   8
   9 #include <rte_ether.h>
  10
  11 /* The feature bitmap for virtio net */
  12 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
  13 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
  14 #define VIRTIO_NET_F_MTU        3       /* Initial MTU advice. */
  15 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
  16 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
  17 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
  18 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
  19 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
  20 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
  21 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
  22 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
  23 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
  24 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
  25 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
  26 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
  27 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
  28 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
  29 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
  30 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce device on the network */
  31 #define VIRTIO_NET_F_MQ         22      /* Device supports Receive Flow Steering */
  32 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23   /* Set MAC address */
  33
  34 /*
  35  * Do we get callbacks when the ring is completely used,
  36  * even if we've suppressed them?
  37  */
  38 #define VIRTIO_F_NOTIFY_ON_EMPTY        24
  39
  40 /* Can the device handle any descriptor layout? */
  41 #define VIRTIO_F_ANY_LAYOUT             27
  42
  43 /* We support indirect buffer descriptors */
  44 #define VIRTIO_RING_F_INDIRECT_DESC     28
  45
  46 #define VIRTIO_F_VERSION_1              32
  47 #define VIRTIO_F_IOMMU_PLATFORM 33
  48 #define VIRTIO_F_RING_PACKED            34
  49
  50 /*
  51  * Some VirtIO feature bits (currently bits 28 through 31) are
  52  * reserved for the transport being used (eg. virtio_ring), the
  53  * rest are per-device feature bits.
  54  */
  55 #define VIRTIO_TRANSPORT_F_START 28
  56 #define VIRTIO_TRANSPORT_F_END   34
  57
  58 /*
  59  * Inorder feature indicates that all buffers are used by the device
  60  * in the same order in which they have been made available.
  61  */
  62 #define VIRTIO_F_IN_ORDER 35
  63
  64 /*
  65  * This feature indicates that memory accesses by the driver and the device
  66  * are ordered in a way described by the platform.
  67  */
  68 #define VIRTIO_F_ORDER_PLATFORM 36
  69
  70 /*
  71  * This feature indicates that the driver passes extra data (besides
  72  * identifying the virtqueue) in its device notifications.
  73  */
  74 #define VIRTIO_F_NOTIFICATION_DATA 38
  75
  76 /* Device set linkspeed and duplex */
  77 #define VIRTIO_NET_F_SPEED_DUPLEX 63
  78
  79 /*
  80  * The Guest publishes the used index for which it expects an interrupt
  81  * at the end of the avail ring. Host should ignore the avail->flags field
  82  *
  83  * The Host publishes the avail index for which it expects a kick
  84  * at the end of the used ring. Guest should ignore the used->flags field.
  85  */
  86 #define VIRTIO_RING_F_EVENT_IDX         29
  87
  88 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
  89 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
  90
  91 struct virtio_hw {
  92         struct virtqueue **vqs;
  93         uint64_t guest_features;
  94         uint16_t vtnet_hdr_size;
  95         uint8_t started;
  96         uint8_t weak_barriers;
  97         uint8_t vlan_strip;
  98         uint8_t has_tx_offload;
  99         uint8_t has_rx_offload;
 100         uint8_t use_vec_rx;
 101         uint8_t use_vec_tx;
 102         uint8_t use_inorder_rx;
 103         uint8_t use_inorder_tx;
 104         uint8_t opened;
 105         uint16_t port_id;
 106         uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
 107         uint32_t speed;  /* link speed in MB */
 108         uint8_t duplex;
 109         uint8_t use_msix;
 110         uint16_t max_mtu;
 111         /*
 112          * App management thread and virtio interrupt handler thread
 113          * both can change device state, this lock is meant to avoid
 114          * such a contention.
 115          */
 116         rte_spinlock_t state_lock;
 117         struct rte_mbuf **inject_pkts;
 118         uint16_t max_queue_pairs;
 119         uint64_t req_guest_features;
 120         struct virtnet_ctl *cvq;
 121 };
 122
 123 struct virtio_ops {
 124         void (*read_dev_cfg)(struct virtio_hw *hw, size_t offset, void *dst, int len);
 125         void (*write_dev_cfg)(struct virtio_hw *hw, size_t offset, const void *src, int len);
 126         uint8_t (*get_status)(struct virtio_hw *hw);
 127         void (*set_status)(struct virtio_hw *hw, uint8_t status);
 128         uint64_t (*get_features)(struct virtio_hw *hw);
 129         void (*set_features)(struct virtio_hw *hw, uint64_t features);
 130         int (*features_ok)(struct virtio_hw *hw);
 131         uint8_t (*get_isr)(struct virtio_hw *hw);
 132         uint16_t (*set_config_irq)(struct virtio_hw *hw, uint16_t vec);
 133         uint16_t (*set_queue_irq)(struct virtio_hw *hw, struct virtqueue *vq, uint16_t vec);
 134         uint16_t (*get_queue_num)(struct virtio_hw *hw, uint16_t queue_id);
 135         int (*setup_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 136         void (*del_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 137         void (*notify_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 138         void (*intr_detect)(struct virtio_hw *hw);
 139         int (*dev_close)(struct virtio_hw *hw);
 140 };
 141
 142 /*
 143  * This structure stores per-process data. Only virtio_ops for now.
 144  */
 145 struct virtio_hw_internal {
 146         const struct virtio_ops *virtio_ops;
 147 };
 148
 149 #define VIRTIO_OPS(hw)  (virtio_hw_internal[(hw)->port_id].virtio_ops)
 150
 151 extern struct virtio_hw_internal virtio_hw_internal[RTE_MAX_ETHPORTS];
 152
 153
 154 static inline int
 155 virtio_with_feature(struct virtio_hw *hw, uint64_t bit)
 156 {
 157         return (hw->guest_features & (1ULL << bit)) != 0;
 158 }
 159
 160 static inline int
 161 virtio_with_packed_queue(struct virtio_hw *hw)
 162 {
 163         return virtio_with_feature(hw, VIRTIO_F_RING_PACKED);
 164 }
 165
 166 uint64_t virtio_negotiate_features(struct virtio_hw *hw, uint64_t host_features);
 167
 168 #endif /* _VIRTIO_H_ */