4 * Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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
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.
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.
34 #ifndef _VIRTIO_NET_H_
35 #define _VIRTIO_NET_H_
37 /* Used to indicate that the device is running on a data core */
38 #define VIRTIO_DEV_RUNNING 1
40 /* Backend value set by guest. */
41 #define VIRTIO_DEV_STOPPED -1
43 #define PAGE_SIZE 4096
45 /* Enum for virtqueue management. */
46 enum {VIRTIO_RXQ, VIRTIO_TXQ, VIRTIO_QNUM};
48 #define BUF_VECTOR_MAX 256
51 * Structure contains buffer address, length and descriptor index
52 * from vring to do scatter RX.
61 * Structure contains variables relevant to TX/RX virtqueues.
63 struct vhost_virtqueue
65 struct vring_desc *desc; /* Virtqueue descriptor ring. */
66 struct vring_avail *avail; /* Virtqueue available ring. */
67 struct vring_used *used; /* Virtqueue used ring. */
68 uint32_t size; /* Size of descriptor ring. */
69 uint32_t backend; /* Backend value to determine if device should started/stopped. */
70 uint16_t vhost_hlen; /* Vhost header length (varies depending on RX merge buffers. */
71 volatile uint16_t last_used_idx; /* Last index used on the available ring */
72 volatile uint16_t last_used_idx_res; /* Used for multiple devices reserving buffers. */
73 eventfd_t callfd; /* Currently unused as polling mode is enabled. */
74 eventfd_t kickfd; /* Used to notify the guest (trigger interrupt). */
75 /* Used for scatter RX. */
76 struct buf_vector buf_vec[BUF_VECTOR_MAX];
77 } __rte_cache_aligned;
80 * Device structure contains all configuration information relating to the device.
84 struct vhost_virtqueue *virtqueue[VIRTIO_QNUM]; /* Contains all virtqueue information. */
85 struct virtio_memory *mem; /* QEMU memory and memory region information. */
86 struct ether_addr mac_address; /* Device MAC address (Obtained on first TX packet). */
87 uint64_t features; /* Negotiated feature set. */
88 uint64_t device_fh; /* device identifier. */
89 uint32_t vmdq_rx_q; /* RX VMDQ queue number. */
90 uint32_t flags; /* Device flags. Only used to check if device is running on data core. */
91 uint32_t vlan_tag; /* Vlan tag for device. Currently set to device_id (0-63). */
92 uint16_t coreid; /* Data core that the device is added to. */
93 volatile uint8_t ready; /* A device is set as ready if the MAC address has been set. */
94 volatile uint8_t remove; /* Device is marked for removal from the data core. */
95 } __rte_cache_aligned;
98 * Device linked list structure for configuration.
100 struct virtio_net_config_ll
102 struct virtio_net dev; /* Virtio device. */
103 struct virtio_net_config_ll *next; /* Next entry on linked list. */
107 * Information relating to memory regions including offsets to addresses in QEMUs memory file.
109 struct virtio_memory_regions {
110 uint64_t guest_phys_address; /* Base guest physical address of region. */
111 uint64_t guest_phys_address_end; /* End guest physical address of region. */
112 uint64_t memory_size; /* Size of region. */
113 uint64_t userspace_address; /* Base userspace address of region. */
114 uint64_t address_offset; /* Offset of region for address translation. */
118 * Information relating to memory regions including offsets to
119 * addresses in host physical space.
121 struct virtio_memory_regions_hpa {
122 /* Base guest physical address of region. */
123 uint64_t guest_phys_address;
124 /* End guest physical address of region. */
125 uint64_t guest_phys_address_end;
126 /* Size of region. */
127 uint64_t memory_size;
128 /* Offset of region for gpa to hpa translation. */
129 uint64_t host_phys_addr_offset;
133 * Memory structure includes region and mapping information.
135 struct virtio_memory {
136 uint64_t base_address; /* Base QEMU userspace address of the memory file. */
137 uint64_t mapped_address; /* Mapped address of memory file base in our applications memory space. */
138 uint64_t mapped_size; /* Total size of memory file. */
139 uint32_t nregions; /* Number of memory regions. */
140 /* Number of memory regions for gpa to hpa translation. */
141 uint32_t nregions_hpa;
142 /* Memory region information for gpa to hpa translation. */
143 struct virtio_memory_regions_hpa *regions_hpa;
144 /* Memory region information. */
145 struct virtio_memory_regions regions[0];
149 * Device operations to add/remove device.
151 struct virtio_net_device_ops {
152 int (* new_device) (struct virtio_net *); /* Add device. */
153 void (* destroy_device) (volatile struct virtio_net *); /* Remove device. */
156 int init_virtio_net(struct virtio_net_device_ops const * const);
157 int deinit_virtio_net(void);
159 struct vhost_net_device_ops const * get_virtio_net_callbacks(void);
161 #endif /* _VIRTIO_NET_H_ */