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 #ifdef __FreeBSD__
  40 #include <sys/types.h>
  41 #include <machine/cpufunc.h>
  42 #else
  43 #include <sys/io.h>
  44 #endif
  45
  46 #include <rte_ethdev.h>
  47
  48 struct virtqueue;
  49
  50 /* VirtIO PCI vendor/device ID. */
  51 #define VIRTIO_PCI_VENDORID     0x1AF4
  52 #define VIRTIO_PCI_DEVICEID_MIN 0x1000
  53 #define VIRTIO_PCI_DEVICEID_MAX 0x103F
  54
  55 /* VirtIO ABI version, this must match exactly. */
  56 #define VIRTIO_PCI_ABI_VERSION 0
  57
  58 /*
  59  * VirtIO Header, located in BAR 0.
  60  */
  61 #define VIRTIO_PCI_HOST_FEATURES  0  /* host's supported features (32bit, RO)*/
  62 #define VIRTIO_PCI_GUEST_FEATURES 4  /* guest's supported features (32, RW) */
  63 #define VIRTIO_PCI_QUEUE_PFN      8  /* physical address of VQ (32, RW) */
  64 #define VIRTIO_PCI_QUEUE_NUM      12 /* number of ring entries (16, RO) */
  65 #define VIRTIO_PCI_QUEUE_SEL      14 /* current VQ selection (16, RW) */
  66 #define VIRTIO_PCI_QUEUE_NOTIFY   16 /* notify host regarding VQ (16, RW) */
  67 #define VIRTIO_PCI_STATUS         18 /* device status register (8, RW) */
  68 #define VIRTIO_PCI_ISR            19 /* interrupt status register, reading
  69                                       * also clears the register (8, RO) */
  70 /* Only if MSIX is enabled: */
  71 #define VIRTIO_MSI_CONFIG_VECTOR  20 /* configuration change vector (16, RW) */
  72 #define VIRTIO_MSI_QUEUE_VECTOR   22 /* vector for selected VQ notifications
  73                                       (16, RW) */
  74
  75 /* The bit of the ISR which indicates a device has an interrupt. */
  76 #define VIRTIO_PCI_ISR_INTR   0x1
  77 /* The bit of the ISR which indicates a device configuration change. */
  78 #define VIRTIO_PCI_ISR_CONFIG 0x2
  79 /* Vector value used to disable MSI for queue. */
  80 #define VIRTIO_MSI_NO_VECTOR 0xFFFF
  81
  82 /* VirtIO device IDs. */
  83 #define VIRTIO_ID_NETWORK  0x01
  84 #define VIRTIO_ID_BLOCK    0x02
  85 #define VIRTIO_ID_CONSOLE  0x03
  86 #define VIRTIO_ID_ENTROPY  0x04
  87 #define VIRTIO_ID_BALLOON  0x05
  88 #define VIRTIO_ID_IOMEMORY 0x06
  89 #define VIRTIO_ID_9P       0x09
  90
  91 /* Status byte for guest to report progress. */
  92 #define VIRTIO_CONFIG_STATUS_RESET     0x00
  93 #define VIRTIO_CONFIG_STATUS_ACK       0x01
  94 #define VIRTIO_CONFIG_STATUS_DRIVER    0x02
  95 #define VIRTIO_CONFIG_STATUS_DRIVER_OK 0x04
  96 #define VIRTIO_CONFIG_STATUS_FAILED    0x80
  97
  98 /*
  99  * Each virtqueue indirect descriptor list must be physically contiguous.
 100  * To allow us to malloc(9) each list individually, limit the number
 101  * supported to what will fit in one page. With 4KB pages, this is a limit
 102  * of 256 descriptors. If there is ever a need for more, we can switch to
 103  * contigmalloc(9) for the larger allocations, similar to what
 104  * bus_dmamem_alloc(9) does.
 105  *
 106  * Note the sizeof(struct vring_desc) is 16 bytes.
 107  */
 108 #define VIRTIO_MAX_INDIRECT ((int) (PAGE_SIZE / 16))
 109
 110 /* The feature bitmap for virtio net */
 111 #define VIRTIO_NET_F_CSUM       0       /* Host handles pkts w/ partial csum */
 112 #define VIRTIO_NET_F_GUEST_CSUM 1       /* Guest handles pkts w/ partial csum */
 113 #define VIRTIO_NET_F_MAC        5       /* Host has given MAC address. */
 114 #define VIRTIO_NET_F_GUEST_TSO4 7       /* Guest can handle TSOv4 in. */
 115 #define VIRTIO_NET_F_GUEST_TSO6 8       /* Guest can handle TSOv6 in. */
 116 #define VIRTIO_NET_F_GUEST_ECN  9       /* Guest can handle TSO[6] w/ ECN in. */
 117 #define VIRTIO_NET_F_GUEST_UFO  10      /* Guest can handle UFO in. */
 118 #define VIRTIO_NET_F_HOST_TSO4  11      /* Host can handle TSOv4 in. */
 119 #define VIRTIO_NET_F_HOST_TSO6  12      /* Host can handle TSOv6 in. */
 120 #define VIRTIO_NET_F_HOST_ECN   13      /* Host can handle TSO[6] w/ ECN in. */
 121 #define VIRTIO_NET_F_HOST_UFO   14      /* Host can handle UFO in. */
 122 #define VIRTIO_NET_F_MRG_RXBUF  15      /* Host can merge receive buffers. */
 123 #define VIRTIO_NET_F_STATUS     16      /* virtio_net_config.status available */
 124 #define VIRTIO_NET_F_CTRL_VQ    17      /* Control channel available */
 125 #define VIRTIO_NET_F_CTRL_RX    18      /* Control channel RX mode support */
 126 #define VIRTIO_NET_F_CTRL_VLAN  19      /* Control channel VLAN filtering */
 127 #define VIRTIO_NET_F_CTRL_RX_EXTRA 20   /* Extra RX mode control support */
 128 #define VIRTIO_NET_F_GUEST_ANNOUNCE 21  /* Guest can announce device on the
 129                                          * network */
 130 #define VIRTIO_NET_F_MQ         22      /* Device supports Receive Flow
 131                                          * Steering */
 132 #define VIRTIO_NET_F_CTRL_MAC_ADDR 23   /* Set MAC address */
 133
 134 /* Do we get callbacks when the ring is completely used, even if we've
 135  * suppressed them? */
 136 #define VIRTIO_F_NOTIFY_ON_EMPTY        24
 137
 138 /* Can the device handle any descriptor layout? */
 139 #define VIRTIO_F_ANY_LAYOUT             27
 140
 141 /* We support indirect buffer descriptors */
 142 #define VIRTIO_RING_F_INDIRECT_DESC     28
 143
 144 /*
 145  * Some VirtIO feature bits (currently bits 28 through 31) are
 146  * reserved for the transport being used (eg. virtio_ring), the
 147  * rest are per-device feature bits.
 148  */
 149 #define VIRTIO_TRANSPORT_F_START 28
 150 #define VIRTIO_TRANSPORT_F_END   32
 151
 152 /* The Guest publishes the used index for which it expects an interrupt
 153  * at the end of the avail ring. Host should ignore the avail->flags field. */
 154 /* The Host publishes the avail index for which it expects a kick
 155  * at the end of the used ring. Guest should ignore the used->flags field. */
 156 #define VIRTIO_RING_F_EVENT_IDX         29
 157
 158 #define VIRTIO_NET_S_LINK_UP    1       /* Link is up */
 159 #define VIRTIO_NET_S_ANNOUNCE   2       /* Announcement is needed */
 160
 161 /*
 162  * Maximum number of virtqueues per device.
 163  */
 164 #define VIRTIO_MAX_VIRTQUEUES 8
 165
 166 struct virtio_hw {
 167         struct virtqueue *cvq;
 168         uint32_t    io_base;
 169         uint32_t    guest_features;
 170         uint32_t    max_tx_queues;
 171         uint32_t    max_rx_queues;
 172         uint16_t    vtnet_hdr_size;
 173         uint8_t     vlan_strip;
 174         uint8_t     use_msix;
 175         uint8_t     started;
 176         uint8_t     mac_addr[ETHER_ADDR_LEN];
 177 };
 178
 179 /*
 180  * This structure is just a reference to read
 181  * net device specific config space; it just a chodu structure
 182  *
 183  */
 184 struct virtio_net_config {
 185         /* The config defining mac address (if VIRTIO_NET_F_MAC) */
 186         uint8_t    mac[ETHER_ADDR_LEN];
 187         /* See VIRTIO_NET_F_STATUS and VIRTIO_NET_S_* above */
 188         uint16_t   status;
 189         uint16_t   max_virtqueue_pairs;
 190 } __attribute__((packed));
 191
 192 /*
 193  * The remaining space is defined by each driver as the per-driver
 194  * configuration space.
 195  */
 196 #define VIRTIO_PCI_CONFIG(hw) (((hw)->use_msix) ? 24 : 20)
 197
 198 /*
 199  * How many bits to shift physical queue address written to QUEUE_PFN.
 200  * 12 is historical, and due to x86 page size.
 201  */
 202 #define VIRTIO_PCI_QUEUE_ADDR_SHIFT 12
 203
 204 /* The alignment to use between consumer and producer parts of vring. */
 205 #define VIRTIO_PCI_VRING_ALIGN 4096
 206
 207 #ifdef __FreeBSD__
 208
 209 static inline void
 210 outb_p(unsigned char data, unsigned int port)
 211 {
 212
 213         outb(port, (u_char)data);
 214 }
 215
 216 static inline void
 217 outw_p(unsigned short data, unsigned int port)
 218 {
 219         outw(port, (u_short)data);
 220 }
 221
 222 static inline void
 223 outl_p(unsigned int data, unsigned int port)
 224 {
 225         outl(port, (u_int)data);
 226 }
 227 #endif
 228
 229 #define VIRTIO_PCI_REG_ADDR(hw, reg) \
 230         (unsigned short)((hw)->io_base + (reg))
 231
 232 #define VIRTIO_READ_REG_1(hw, reg) \
 233         inb((VIRTIO_PCI_REG_ADDR((hw), (reg))))
 234 #define VIRTIO_WRITE_REG_1(hw, reg, value) \
 235         outb_p((unsigned char)(value), (VIRTIO_PCI_REG_ADDR((hw), (reg))))
 236
 237 #define VIRTIO_READ_REG_2(hw, reg) \
 238         inw((VIRTIO_PCI_REG_ADDR((hw), (reg))))
 239 #define VIRTIO_WRITE_REG_2(hw, reg, value) \
 240         outw_p((unsigned short)(value), (VIRTIO_PCI_REG_ADDR((hw), (reg))))
 241
 242 #define VIRTIO_READ_REG_4(hw, reg) \
 243         inl((VIRTIO_PCI_REG_ADDR((hw), (reg))))
 244 #define VIRTIO_WRITE_REG_4(hw, reg, value) \
 245         outl_p((unsigned int)(value), (VIRTIO_PCI_REG_ADDR((hw), (reg))))
 246
 247 static inline int
 248 vtpci_with_feature(struct virtio_hw *hw, uint32_t bit)
 249 {
 250         return (hw->guest_features & (1u << bit)) != 0;
 251 }
 252
 253 /*
 254  * Function declaration from virtio_pci.c
 255  */
 256 void vtpci_reset(struct virtio_hw *);
 257
 258 void vtpci_reinit_complete(struct virtio_hw *);
 259
 260 void vtpci_set_status(struct virtio_hw *, uint8_t);
 261
 262 uint32_t vtpci_negotiate_features(struct virtio_hw *, uint32_t);
 263
 264 void vtpci_write_dev_config(struct virtio_hw *, uint64_t, void *, int);
 265
 266 void vtpci_read_dev_config(struct virtio_hw *, uint64_t, void *, int);
 267
 268 uint8_t vtpci_isr(struct virtio_hw *);
 269
 270 uint16_t vtpci_irq_config(struct virtio_hw *, uint16_t);
 271
 272 #endif /* _VIRTIO_PCI_H_ */