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 /*
 139  * This feature indicates that the driver passes extra data (besides
 140  * identifying the virtqueue) in its device notifications.
 141  */
 142 #define VIRTIO_F_NOTIFICATION_DATA 38
 143
 144 /* Device set linkspeed and duplex */
 145 #define VIRTIO_NET_F_SPEED_DUPLEX 63
 146
 147 /* The Guest publishes the used index for which it expects an interrupt
 148  * at the end of the avail ring. Host should ignore the avail->flags field. */
 149 /* The Host publishes the avail index for which it expects a kick
 150  * at the end of the used ring. Guest should ignore the used->flags field. */
 151 #define VIRTIO_RING_F_EVENT_IDX         29
 152
 153 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
 154 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
 155
 156 /*
 157  * Maximum number of virtqueues per device.
 158  */
 159 #define VIRTIO_MAX_VIRTQUEUE_PAIRS 8
 160 #define VIRTIO_MAX_VIRTQUEUES (VIRTIO_MAX_VIRTQUEUE_PAIRS * 2 + 1)
 161
 162 /* Common configuration */
 163 #define VIRTIO_PCI_CAP_COMMON_CFG       1
 164 /* Notifications */
 165 #define VIRTIO_PCI_CAP_NOTIFY_CFG       2
 166 /* ISR Status */
 167 #define VIRTIO_PCI_CAP_ISR_CFG          3
 168 /* Device specific configuration */
 169 #define VIRTIO_PCI_CAP_DEVICE_CFG       4
 170 /* PCI configuration access */
 171 #define VIRTIO_PCI_CAP_PCI_CFG          5
 172
 173 /* This is the PCI capability header: */
 174 struct virtio_pci_cap {
 175         uint8_t cap_vndr;               /* Generic PCI field: PCI_CAP_ID_VNDR */
 176         uint8_t cap_next;               /* Generic PCI field: next ptr. */
 177         uint8_t cap_len;                /* Generic PCI field: capability length */
 178         uint8_t cfg_type;               /* Identifies the structure. */
 179         uint8_t bar;                    /* Where to find it. */
 180         uint8_t padding[3];             /* Pad to full dword. */
 181         uint32_t offset;                /* Offset within bar. */
 182         uint32_t length;                /* Length of the structure, in bytes. */
 183 };
 184
 185 struct virtio_pci_notify_cap {
 186         struct virtio_pci_cap cap;
 187         uint32_t notify_off_multiplier; /* Multiplier for queue_notify_off. */
 188 };
 189
 190 /* Fields in VIRTIO_PCI_CAP_COMMON_CFG: */
 191 struct virtio_pci_common_cfg {
 192         /* About the whole device. */
 193         uint32_t device_feature_select; /* read-write */
 194         uint32_t device_feature;        /* read-only */
 195         uint32_t guest_feature_select;  /* read-write */
 196         uint32_t guest_feature;         /* read-write */
 197         uint16_t msix_config;           /* read-write */
 198         uint16_t num_queues;            /* read-only */
 199         uint8_t device_status;          /* read-write */
 200         uint8_t config_generation;      /* read-only */
 201
 202         /* About a specific virtqueue. */
 203         uint16_t queue_select;          /* read-write */
 204         uint16_t queue_size;            /* read-write, power of 2. */
 205         uint16_t queue_msix_vector;     /* read-write */
 206         uint16_t queue_enable;          /* read-write */
 207         uint16_t queue_notify_off;      /* read-only */
 208         uint32_t queue_desc_lo;         /* read-write */
 209         uint32_t queue_desc_hi;         /* read-write */
 210         uint32_t queue_avail_lo;        /* read-write */
 211         uint32_t queue_avail_hi;        /* read-write */
 212         uint32_t queue_used_lo;         /* read-write */
 213         uint32_t queue_used_hi;         /* read-write */
 214 };
 215
 216 struct virtio_hw;
 217
 218 struct virtio_pci_ops {
 219         void (*read_dev_cfg)(struct virtio_hw *hw, size_t offset,
 220                              void *dst, int len);
 221         void (*write_dev_cfg)(struct virtio_hw *hw, size_t offset,
 222                               const void *src, int len);
 223
 224         uint8_t (*get_status)(struct virtio_hw *hw);
 225         void    (*set_status)(struct virtio_hw *hw, uint8_t status);
 226
 227         uint64_t (*get_features)(struct virtio_hw *hw);
 228         void     (*set_features)(struct virtio_hw *hw, uint64_t features);
 229
 230         uint8_t (*get_isr)(struct virtio_hw *hw);
 231
 232         uint16_t (*set_config_irq)(struct virtio_hw *hw, uint16_t vec);
 233
 234         uint16_t (*set_queue_irq)(struct virtio_hw *hw, struct virtqueue *vq,
 235                         uint16_t vec);
 236
 237         uint16_t (*get_queue_num)(struct virtio_hw *hw, uint16_t queue_id);
 238         int (*setup_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 239         void (*del_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 240         void (*notify_queue)(struct virtio_hw *hw, struct virtqueue *vq);
 241 };
 242
 243 struct virtio_net_config;
 244
 245 struct virtio_hw {
 246         struct virtnet_ctl *cvq;
 247         uint64_t    req_guest_features;
 248         uint64_t    guest_features;
 249         uint32_t    max_queue_pairs;
 250         bool        started;
 251         uint16_t        max_mtu;
 252         uint16_t    vtnet_hdr_size;
 253         uint8_t     vlan_strip;
 254         uint8_t     use_msix;
 255         uint8_t     modern;
 256         uint8_t     use_vec_rx;
 257         uint8_t     use_vec_tx;
 258         uint8_t     use_inorder_rx;
 259         uint8_t     use_inorder_tx;
 260         uint8_t     weak_barriers;
 261         bool        has_tx_offload;
 262         bool        has_rx_offload;
 263         uint16_t    port_id;
 264         uint8_t     mac_addr[RTE_ETHER_ADDR_LEN];
 265         uint32_t    notify_off_multiplier;
 266         uint32_t    speed;  /* link speed in MB */
 267         uint8_t     duplex;
 268         uint8_t     *isr;
 269         uint16_t    *notify_base;
 270         struct virtio_pci_common_cfg *common_cfg;
 271         struct virtio_net_config *dev_cfg;
 272         void        *virtio_user_dev;
 273         /*
 274          * App management thread and virtio interrupt handler thread
 275          * both can change device state, this lock is meant to avoid
 276          * such a contention.
 277          */
 278         rte_spinlock_t state_lock;
 279         struct rte_mbuf **inject_pkts;
 280         bool        opened;
 281
 282         struct virtqueue **vqs;
 283 };
 284
 285
 286 /*
 287  * While virtio_hw is stored in shared memory, this structure stores
 288  * some infos that may vary in the multiple process model locally.
 289  * For example, the vtpci_ops pointer.
 290  */
 291 struct virtio_hw_internal {
 292         const struct virtio_pci_ops *vtpci_ops;
 293         struct rte_pci_ioport io;
 294 };
 295
 296 #define VTPCI_OPS(hw)   (virtio_hw_internal[(hw)->port_id].vtpci_ops)
 297 #define VTPCI_IO(hw)    (&virtio_hw_internal[(hw)->port_id].io)
 298
 299 extern struct virtio_hw_internal virtio_hw_internal[RTE_MAX_ETHPORTS];
 300
 301
 302 /*
 303  * This structure is just a reference to read
 304  * net device specific config space; it just a chodu structure
 305  *
 306  */
 307 struct virtio_net_config {
 308         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
 309         uint8_t    mac[RTE_ETHER_ADDR_LEN];
 310         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
 311         uint16_t   status;
 312         uint16_t   max_virtqueue_pairs;
 313         uint16_t   mtu;
 314         /*
 315          * speed, in units of 1Mb. All values 0 to INT_MAX are legal.
 316          * Any other value stands for unknown.
 317          */
 318         uint32_t speed;
 319         /*
 320          * 0x00 - half duplex
 321          * 0x01 - full duplex
 322          * Any other value stands for unknown.
 323          */
 324         uint8_t duplex;
 325
 326 } __rte_packed;
 327
 328 /*
 329  * How many bits to shift physical queue address written to QUEUE_PFN.
 330  * 12 is historical, and due to x86 page size.
 331  */
 332 #define VIRTIO_PCI_QUEUE_ADDR_SHIFT 12
 333
 334 /* The alignment to use between consumer and producer parts of vring. */
 335 #define VIRTIO_PCI_VRING_ALIGN 4096
 336
 337 enum virtio_msix_status {
 338         VIRTIO_MSIX_NONE = 0,
 339         VIRTIO_MSIX_DISABLED = 1,
 340         VIRTIO_MSIX_ENABLED = 2
 341 };
 342
 343 static inline int
 344 vtpci_with_feature(struct virtio_hw *hw, uint64_t bit)
 345 {
 346         return (hw->guest_features & (1ULL << bit)) != 0;
 347 }
 348
 349 static inline int
 350 vtpci_packed_queue(struct virtio_hw *hw)
 351 {
 352         return vtpci_with_feature(hw, VIRTIO_F_RING_PACKED);
 353 }
 354
 355 /*
 356  * Function declaration from virtio_pci.c
 357  */
 358 int vtpci_init(struct rte_pci_device *dev, struct virtio_hw *hw);
 359 void vtpci_reset(struct virtio_hw *);
 360
 361 void vtpci_reinit_complete(struct virtio_hw *);
 362
 363 uint8_t vtpci_get_status(struct virtio_hw *);
 364 void vtpci_set_status(struct virtio_hw *, uint8_t);
 365
 366 uint64_t vtpci_negotiate_features(struct virtio_hw *, uint64_t);
 367
 368 void vtpci_write_dev_config(struct virtio_hw *, size_t, const void *, int);
 369
 370 void vtpci_read_dev_config(struct virtio_hw *, size_t, void *, int);
 371
 372 uint8_t vtpci_isr(struct virtio_hw *);
 373
 374 enum virtio_msix_status vtpci_msix_detect(struct rte_pci_device *dev);
 375
 376 extern const struct virtio_pci_ops legacy_ops;
 377 extern const struct virtio_pci_ops modern_ops;
 378 extern const struct virtio_pci_ops virtio_user_ops;
 379
 380 #endif /* _VIRTIO_PCI_H_ */