drivers/net/virtio/virtio_pci.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2010-2014 Intel Corporation
   3  */
   4
   5 #ifndef _VIRTIO_PCI_H_
   6 #define _VIRTIO_PCI_H_
   7
   8 #include <stdint.h>
   9 #include <stdbool.h>
  10
  11 #include <rte_pci.h>
  12 #include <rte_bus_pci.h>
  13 #include <rte_ethdev_driver.h>
  14
  15 struct virtqueue;
  16 struct virtnet_ctl;
  17
  18 /* VirtIO PCI vendor/device ID. */
  19 #define VIRTIO_PCI_VENDORID     0x1AF4
  20 #define VIRTIO_PCI_LEGACY_DEVICEID_NET 0x1000
  21 #define VIRTIO_PCI_MODERN_DEVICEID_NET 0x1041
  22
  23 /* VirtIO ABI version, this must match exactly. */
  24 #define VIRTIO_PCI_ABI_VERSION 0
  25
  26 /*
  27  * VirtIO Header, located in BAR 0.
  28  */
  29 #define VIRTIO_PCI_HOST_FEATURES  0  /* host's supported features (32bit, RO)*/
  30 #define VIRTIO_PCI_GUEST_FEATURES 4  /* guest's supported features (32, RW) */
  31 #define VIRTIO_PCI_QUEUE_PFN      8  /* physical address of VQ (32, RW) */
  32 #define VIRTIO_PCI_QUEUE_NUM      12 /* number of ring entries (16, RO) */
  33 #define VIRTIO_PCI_QUEUE_SEL      14 /* current VQ selection (16, RW) */
  34 #define VIRTIO_PCI_QUEUE_NOTIFY   16 /* notify host regarding VQ (16, RW) */
  35 #define VIRTIO_PCI_STATUS         18 /* device status register (8, RW) */
  36 #define VIRTIO_PCI_ISR            19 /* interrupt status register, reading
  37                                       * also clears the register (8, RO) */
  38 /* Only if MSIX is enabled: */
  39 #define VIRTIO_MSI_CONFIG_VECTOR  20 /* configuration change vector (16, RW) */
  40 #define VIRTIO_MSI_QUEUE_VECTOR   22 /* vector for selected VQ notifications
  41                                       (16, RW) */
  42
  43 /* The bit of the ISR which indicates a device has an interrupt. */
  44 #define VIRTIO_PCI_ISR_INTR   0x1
  45 /* The bit of the ISR which indicates a device configuration change. */
  46 #define VIRTIO_PCI_ISR_CONFIG 0x2
  47 /* Vector value used to disable MSI for queue. */
  48 #define VIRTIO_MSI_NO_VECTOR 0xFFFF
  49
  50 /* VirtIO device IDs. */
  51 #define VIRTIO_ID_NETWORK  0x01
  52 #define VIRTIO_ID_BLOCK    0x02
  53 #define VIRTIO_ID_CONSOLE  0x03
  54 #define VIRTIO_ID_ENTROPY  0x04
  55 #define VIRTIO_ID_BALLOON  0x05
  56 #define VIRTIO_ID_IOMEMORY 0x06
  57 #define VIRTIO_ID_9P       0x09
  58
  59 /* Status byte for guest to report progress. */
  60 #define VIRTIO_CONFIG_STATUS_RESET     0x00
  61 #define VIRTIO_CONFIG_STATUS_ACK       0x01
  62 #define VIRTIO_CONFIG_STATUS_DRIVER    0x02
  63 #define VIRTIO_CONFIG_STATUS_DRIVER_OK 0x04
  64 #define VIRTIO_CONFIG_STATUS_FEATURES_OK 0x08
  65 #define VIRTIO_CONFIG_STATUS_FAILED    0x80
  66
  67 /*
  68  * Each virtqueue indirect descriptor list must be physically contiguous.
  69  * To allow us to malloc(9) each list individually, limit the number
  70  * supported to what will fit in one page. With 4KB pages, this is a limit
  71  * of 256 descriptors. If there is ever a need for more, we can switch to
  72  * contigmalloc(9) for the larger allocations, similar to what
  73  * bus_dmamem_alloc(9) does.
  74  *
  75  * Note the sizeof(struct vring_desc) is 16 bytes.
  76  */
  77 #define VIRTIO_MAX_INDIRECT ((int) (PAGE_SIZE / 16))
  78
  79 /* The feature bitmap for virtio net */
  80 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
  81 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
  82 #define VIRTIO_NET_F_MTU        3       /* Initial MTU advice. */
  83 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
  84 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
  85 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
  86 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
  87 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
  88 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
  89 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
  90 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
  91 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
  92 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
  93 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
  94 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
  95 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
  96 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
  97 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
  98 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce device on the
  99                                          * network */
 100 #define VIRTIO_NET_F_MQ         22      /* Device supports Receive Flow
 101                                          * Steering */
 102 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23   /* Set MAC address */
 103
 104 /* Do we get callbacks when the ring is completely used, even if we've
 105  * suppressed them? */
 106 #define VIRTIO_F_NOTIFY_ON_EMPTY        24
 107
 108 /* Can the device handle any descriptor layout? */
 109 #define VIRTIO_F_ANY_LAYOUT             27
 110
 111 /* We support indirect buffer descriptors */
 112 #define VIRTIO_RING_F_INDIRECT_DESC     28
 113
 114 #define VIRTIO_F_VERSION_1              32
 115 #define VIRTIO_F_IOMMU_PLATFORM 33
 116 #define VIRTIO_F_RING_PACKED            34
 117
 118 /*
 119  * Some VirtIO feature bits (currently bits 28 through 31) are
 120  * reserved for the transport being used (eg. virtio_ring), the
 121  * rest are per-device feature bits.
 122  */
 123 #define VIRTIO_TRANSPORT_F_START 28
 124 #define VIRTIO_TRANSPORT_F_END   34
 125
 126 /*
 127  * Inorder feature indicates that all buffers are used by the device
 128  * in the same order in which they have been made available.
 129  */
 130 #define VIRTIO_F_IN_ORDER 35
 131
 132 /*
 133  * This feature indicates that memory accesses by the driver and the device
 134  * are ordered in a way described by the platform.
 135  */
 136 #define VIRTIO_F_ORDER_PLATFORM 36
 137
 138 /* The Guest publishes the used index for which it expects an interrupt
 139  * at the end of the avail ring. Host should ignore the avail->flags field. */
 140 /* The Host publishes the avail index for which it expects a kick
 141  * at the end of the used ring. Guest should ignore the used->flags field. */
 142 #define VIRTIO_RING_F_EVENT_IDX         29
 143
 144 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
 145 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
 146
 147 /*
 148  * Maximum number of virtqueues per device.
 149  */
 150 #define VIRTIO_MAX_VIRTQUEUE_PAIRS 8
 151 #define VIRTIO_MAX_VIRTQUEUES (VIRTIO_MAX_VIRTQUEUE_PAIRS * 2 + 1)
 152
 153 /* Common configuration */
 154 #define VIRTIO_PCI_CAP_COMMON_CFG       1
 155 /* Notifications */
 156 #define VIRTIO_PCI_CAP_NOTIFY_CFG       2
 157 /* ISR Status */
 158 #define VIRTIO_PCI_CAP_ISR_CFG          3
 159 /* Device specific configuration */
 160 #define VIRTIO_PCI_CAP_DEVICE_CFG       4
 161 /* PCI configuration access */
 162 #define VIRTIO_PCI_CAP_PCI_CFG          5
 163
 164 /* This is the PCI capability header: */
 165 struct virtio_pci_cap {
 166         uint8_t cap_vndr;               /* Generic PCI field: PCI_CAP_ID_VNDR */
 167         uint8_t cap_next;               /* Generic PCI field: next ptr. */
 168         uint8_t cap_len;                /* Generic PCI field: capability length */
 169         uint8_t cfg_type;               /* Identifies the structure. */
 170         uint8_t bar;                    /* Where to find it. */
 171         uint8_t padding[3];             /* Pad to full dword. */
 172         uint32_t offset;                /* Offset within bar. */
 173         uint32_t length;                /* Length of the structure, in bytes. */
 174 };
 175
 176 struct virtio_pci_notify_cap {
 177         struct virtio_pci_cap cap;
 178         uint32_t notify_off_multiplier; /* Multiplier for queue_notify_off. */
 179 };
 180
 181 /* Fields in VIRTIO_PCI_CAP_COMMON_CFG: */
 182 struct virtio_pci_common_cfg {
 183         /* About the whole device. */
 184         uint32_t device_feature_select; /* read-write */
 185         uint32_t device_feature;        /* read-only */
 186         uint32_t guest_feature_select;  /* read-write */
 187         uint32_t guest_feature;         /* read-write */
 188         uint16_t msix_config;           /* read-write */
 189         uint16_t num_queues;            /* read-only */
 190         uint8_t device_status;          /* read-write */
 191         uint8_t config_generation;      /* read-only */
 192
 193         /* About a specific virtqueue. */
 194         uint16_t queue_select;          /* read-write */
 195         uint16_t queue_size;            /* read-write, power of 2. */
 196         uint16_t queue_msix_vector;     /* read-write */
 197         uint16_t queue_enable;          /* read-write */
 198         uint16_t queue_notify_off;      /* read-only */
 199         uint32_t queue_desc_lo;         /* read-write */
 200         uint32_t queue_desc_hi;         /* read-write */
 201         uint32_t queue_avail_lo;        /* read-write */
 202         uint32_t queue_avail_hi;        /* read-write */
 203         uint32_t queue_used_lo;         /* read-write */
 204         uint32_t queue_used_hi;         /* read-write */
 205 };
 206
 207 struct virtio_hw;
 208
 209 struct virtio_pci_ops {
 210         void (*read_dev_cfg)(struct virtio_hw *hw, size_t offset,
 211                              void *dst, int len);
 212         void (*write_dev_cfg)(struct virtio_hw *hw, size_t offset,
 213                               const void *src, int len);
 214
 215         uint8_t (*get_status)(struct virtio_hw *hw);
 216         void    (*set_status)(struct virtio_hw *hw, uint8_t status);
 217
 218         uint64_t (*get_features)(struct virtio_hw *hw);
 219         void     (*set_features)(struct virtio_hw *hw, uint64_t features);
 220
 221         uint8_t (*get_isr)(struct virtio_hw *hw);
 222
 223         uint16_t (*set_config_irq)(struct virtio_hw *hw, uint16_t vec);
 224
 225         uint16_t (*set_queue_irq)(struct virtio_hw *hw, struct virtqueue *vq,
 226                         uint16_t vec);
 227
 228         uint16_t (*get_queue_num)(struct virtio_hw *hw, uint16_t queue_id);
 229         int (*setup_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 230         void (*del_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 231         void (*notify_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 232 };
 233
 234 struct virtio_net_config;
 235
 236 struct virtio_hw {
 237         struct virtnet_ctl *cvq;
 238         uint64_t    req_guest_features;
 239         uint64_t    guest_features;
 240         uint32_t    max_queue_pairs;
 241         bool        started;
 242         uint16_t        max_mtu;
 243         uint16_t    vtnet_hdr_size;
 244         uint8_t     vlan_strip;
 245         uint8_t     use_msix;
 246         uint8_t     modern;
 247         uint8_t     use_simple_rx;
 248         uint8_t     use_inorder_rx;
 249         uint8_t     use_inorder_tx;
 250         uint8_t     weak_barriers;
 251         bool        has_tx_offload;
 252         bool        has_rx_offload;
 253         uint16_t    port_id;
 254         uint8_t     mac_addr[RTE_ETHER_ADDR_LEN];
 255         uint32_t    notify_off_multiplier;
 256         uint8_t     *isr;
 257         uint16_t    *notify_base;
 258         struct virtio_pci_common_cfg *common_cfg;
 259         struct virtio_net_config *dev_cfg;
 260         void        *virtio_user_dev;
 261         /*
 262          * App management thread and virtio interrupt handler thread
 263          * both can change device state, this lock is meant to avoid
 264          * such a contention.
 265          */
 266         rte_spinlock_t state_lock;
 267         struct rte_mbuf **inject_pkts;
 268         bool        opened;
 269
 270         struct virtqueue **vqs;
 271 };
 272
 273
 274 /*
 275  * While virtio_hw is stored in shared memory, this structure stores
 276  * some infos that may vary in the multiple process model locally.
 277  * For example, the vtpci_ops pointer.
 278  */
 279 struct virtio_hw_internal {
 280         const struct virtio_pci_ops *vtpci_ops;
 281         struct rte_pci_ioport io;
 282 };
 283
 284 #define VTPCI_OPS(hw)   (virtio_hw_internal[(hw)->port_id].vtpci_ops)
 285 #define VTPCI_IO(hw)    (&virtio_hw_internal[(hw)->port_id].io)
 286
 287 extern struct virtio_hw_internal virtio_hw_internal[RTE_MAX_ETHPORTS];
 288
 289
 290 /*
 291  * This structure is just a reference to read
 292  * net device specific config space; it just a chodu structure
 293  *
 294  */
 295 struct virtio_net_config {
 296         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
 297         uint8_t    mac[RTE_ETHER_ADDR_LEN];
 298         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
 299         uint16_t   status;
 300         uint16_t   max_virtqueue_pairs;
 301         uint16_t   mtu;
 302 } __attribute__((packed));
 303
 304 /*
 305  * How many bits to shift physical queue address written to QUEUE_PFN.
 306  * 12 is historical, and due to x86 page size.
 307  */
 308 #define VIRTIO_PCI_QUEUE_ADDR_SHIFT 12
 309
 310 /* The alignment to use between consumer and producer parts of vring. */
 311 #define VIRTIO_PCI_VRING_ALIGN 4096
 312
 313 enum virtio_msix_status {
 314         VIRTIO_MSIX_NONE = 0,
 315         VIRTIO_MSIX_DISABLED = 1,
 316         VIRTIO_MSIX_ENABLED = 2
 317 };
 318
 319 static inline int
 320 vtpci_with_feature(struct virtio_hw *hw, uint64_t bit)
 321 {
 322         return (hw->guest_features & (1ULL << bit)) != 0;
 323 }
 324
 325 static inline int
 326 vtpci_packed_queue(struct virtio_hw *hw)
 327 {
 328         return vtpci_with_feature(hw, VIRTIO_F_RING_PACKED);
 329 }
 330
 331 /*
 332  * Function declaration from virtio_pci.c
 333  */
 334 int vtpci_init(struct rte_pci_device *dev, struct virtio_hw *hw);
 335 void vtpci_reset(struct virtio_hw *);
 336
 337 void vtpci_reinit_complete(struct virtio_hw *);
 338
 339 uint8_t vtpci_get_status(struct virtio_hw *);
 340 void vtpci_set_status(struct virtio_hw *, uint8_t);
 341
 342 uint64_t vtpci_negotiate_features(struct virtio_hw *, uint64_t);
 343
 344 void vtpci_write_dev_config(struct virtio_hw *, size_t, const void *, int);
 345
 346 void vtpci_read_dev_config(struct virtio_hw *, size_t, void *, int);
 347
 348 uint8_t vtpci_isr(struct virtio_hw *);
 349
 350 enum virtio_msix_status vtpci_msix_detect(struct rte_pci_device *dev);
 351
 352 extern const struct virtio_pci_ops legacy_ops;
 353 extern const struct virtio_pci_ops modern_ops;
 354 extern const struct virtio_pci_ops virtio_user_ops;
 355
 356 #endif /* _VIRTIO_PCI_H_ */