drivers/net/virtio/virtio_pci.h

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