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