Merge git://git.kernel.org/pub/scm/linux/kernel/git/bpf/bpf
[muen/linux.git] / include / linux / avf / virtchnl.h
1 /*******************************************************************************
2  *
3  * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
4  * Copyright(c) 2013 - 2014 Intel Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms and conditions of the GNU General Public License,
8  * version 2, as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13  * more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
17  *
18  * The full GNU General Public License is included in this distribution in
19  * the file called "COPYING".
20  *
21  * Contact Information:
22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24  *
25  ******************************************************************************/
26
27 #ifndef _VIRTCHNL_H_
28 #define _VIRTCHNL_H_
29
30 /* Description:
31  * This header file describes the VF-PF communication protocol used
32  * by the drivers for all devices starting from our 40G product line
33  *
34  * Admin queue buffer usage:
35  * desc->opcode is always aqc_opc_send_msg_to_pf
36  * flags, retval, datalen, and data addr are all used normally.
37  * The Firmware copies the cookie fields when sending messages between the
38  * PF and VF, but uses all other fields internally. Due to this limitation,
39  * we must send all messages as "indirect", i.e. using an external buffer.
40  *
41  * All the VSI indexes are relative to the VF. Each VF can have maximum of
42  * three VSIs. All the queue indexes are relative to the VSI.  Each VF can
43  * have a maximum of sixteen queues for all of its VSIs.
44  *
45  * The PF is required to return a status code in v_retval for all messages
46  * except RESET_VF, which does not require any response. The return value
47  * is of status_code type, defined in the shared type.h.
48  *
49  * In general, VF driver initialization should roughly follow the order of
50  * these opcodes. The VF driver must first validate the API version of the
51  * PF driver, then request a reset, then get resources, then configure
52  * queues and interrupts. After these operations are complete, the VF
53  * driver may start its queues, optionally add MAC and VLAN filters, and
54  * process traffic.
55  */
56
57 /* START GENERIC DEFINES
58  * Need to ensure the following enums and defines hold the same meaning and
59  * value in current and future projects
60  */
61
62 /* Error Codes */
63 enum virtchnl_status_code {
64         VIRTCHNL_STATUS_SUCCESS                         = 0,
65         VIRTCHNL_ERR_PARAM                              = -5,
66         VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH             = -38,
67         VIRTCHNL_STATUS_ERR_CQP_COMPL_ERROR             = -39,
68         VIRTCHNL_STATUS_ERR_INVALID_VF_ID               = -40,
69         VIRTCHNL_STATUS_NOT_SUPPORTED                   = -64,
70 };
71
72 #define VIRTCHNL_LINK_SPEED_100MB_SHIFT         0x1
73 #define VIRTCHNL_LINK_SPEED_1000MB_SHIFT        0x2
74 #define VIRTCHNL_LINK_SPEED_10GB_SHIFT          0x3
75 #define VIRTCHNL_LINK_SPEED_40GB_SHIFT          0x4
76 #define VIRTCHNL_LINK_SPEED_20GB_SHIFT          0x5
77 #define VIRTCHNL_LINK_SPEED_25GB_SHIFT          0x6
78
79 enum virtchnl_link_speed {
80         VIRTCHNL_LINK_SPEED_UNKNOWN     = 0,
81         VIRTCHNL_LINK_SPEED_100MB       = BIT(VIRTCHNL_LINK_SPEED_100MB_SHIFT),
82         VIRTCHNL_LINK_SPEED_1GB         = BIT(VIRTCHNL_LINK_SPEED_1000MB_SHIFT),
83         VIRTCHNL_LINK_SPEED_10GB        = BIT(VIRTCHNL_LINK_SPEED_10GB_SHIFT),
84         VIRTCHNL_LINK_SPEED_40GB        = BIT(VIRTCHNL_LINK_SPEED_40GB_SHIFT),
85         VIRTCHNL_LINK_SPEED_20GB        = BIT(VIRTCHNL_LINK_SPEED_20GB_SHIFT),
86         VIRTCHNL_LINK_SPEED_25GB        = BIT(VIRTCHNL_LINK_SPEED_25GB_SHIFT),
87 };
88
89 /* for hsplit_0 field of Rx HMC context */
90 /* deprecated with AVF 1.0 */
91 enum virtchnl_rx_hsplit {
92         VIRTCHNL_RX_HSPLIT_NO_SPLIT      = 0,
93         VIRTCHNL_RX_HSPLIT_SPLIT_L2      = 1,
94         VIRTCHNL_RX_HSPLIT_SPLIT_IP      = 2,
95         VIRTCHNL_RX_HSPLIT_SPLIT_TCP_UDP = 4,
96         VIRTCHNL_RX_HSPLIT_SPLIT_SCTP    = 8,
97 };
98
99 /* END GENERIC DEFINES */
100
101 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
102  * of the virtchnl_msg structure.
103  */
104 enum virtchnl_ops {
105 /* The PF sends status change events to VFs using
106  * the VIRTCHNL_OP_EVENT opcode.
107  * VFs send requests to the PF using the other ops.
108  * Use of "advanced opcode" features must be negotiated as part of capabilities
109  * exchange and are not considered part of base mode feature set.
110  */
111         VIRTCHNL_OP_UNKNOWN = 0,
112         VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
113         VIRTCHNL_OP_RESET_VF = 2,
114         VIRTCHNL_OP_GET_VF_RESOURCES = 3,
115         VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
116         VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
117         VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
118         VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
119         VIRTCHNL_OP_ENABLE_QUEUES = 8,
120         VIRTCHNL_OP_DISABLE_QUEUES = 9,
121         VIRTCHNL_OP_ADD_ETH_ADDR = 10,
122         VIRTCHNL_OP_DEL_ETH_ADDR = 11,
123         VIRTCHNL_OP_ADD_VLAN = 12,
124         VIRTCHNL_OP_DEL_VLAN = 13,
125         VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
126         VIRTCHNL_OP_GET_STATS = 15,
127         VIRTCHNL_OP_RSVD = 16,
128         VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */
129         VIRTCHNL_OP_IWARP = 20, /* advanced opcode */
130         VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP = 21, /* advanced opcode */
131         VIRTCHNL_OP_RELEASE_IWARP_IRQ_MAP = 22, /* advanced opcode */
132         VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
133         VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
134         VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
135         VIRTCHNL_OP_SET_RSS_HENA = 26,
136         VIRTCHNL_OP_ENABLE_VLAN_STRIPPING = 27,
137         VIRTCHNL_OP_DISABLE_VLAN_STRIPPING = 28,
138         VIRTCHNL_OP_REQUEST_QUEUES = 29,
139         VIRTCHNL_OP_ENABLE_CHANNELS = 30,
140         VIRTCHNL_OP_DISABLE_CHANNELS = 31,
141         VIRTCHNL_OP_ADD_CLOUD_FILTER = 32,
142         VIRTCHNL_OP_DEL_CLOUD_FILTER = 33,
143 };
144
145 /* These macros are used to generate compilation errors if a structure/union
146  * is not exactly the correct length. It gives a divide by zero error if the
147  * structure/union is not of the correct size, otherwise it creates an enum
148  * that is never used.
149  */
150 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \
151         { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) }
152 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \
153         { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) }
154
155 /* Virtual channel message descriptor. This overlays the admin queue
156  * descriptor. All other data is passed in external buffers.
157  */
158
159 struct virtchnl_msg {
160         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
161         enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
162         enum virtchnl_status_code v_retval;  /* ditto for desc->retval */
163         u32 vfid;                        /* used by PF when sending to VF */
164 };
165
166 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg);
167
168 /* Message descriptions and data structures.*/
169
170 /* VIRTCHNL_OP_VERSION
171  * VF posts its version number to the PF. PF responds with its version number
172  * in the same format, along with a return code.
173  * Reply from PF has its major/minor versions also in param0 and param1.
174  * If there is a major version mismatch, then the VF cannot operate.
175  * If there is a minor version mismatch, then the VF can operate but should
176  * add a warning to the system log.
177  *
178  * This enum element MUST always be specified as == 1, regardless of other
179  * changes in the API. The PF must always respond to this message without
180  * error regardless of version mismatch.
181  */
182 #define VIRTCHNL_VERSION_MAJOR          1
183 #define VIRTCHNL_VERSION_MINOR          1
184 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS       0
185
186 struct virtchnl_version_info {
187         u32 major;
188         u32 minor;
189 };
190
191 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info);
192
193 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0))
194 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1))
195
196 /* VIRTCHNL_OP_RESET_VF
197  * VF sends this request to PF with no parameters
198  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
199  * until reset completion is indicated. The admin queue must be reinitialized
200  * after this operation.
201  *
202  * When reset is complete, PF must ensure that all queues in all VSIs associated
203  * with the VF are stopped, all queue configurations in the HMC are set to 0,
204  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
205  * are cleared.
206  */
207
208 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV
209  * vsi_type should always be 6 for backward compatibility. Add other fields
210  * as needed.
211  */
212 enum virtchnl_vsi_type {
213         VIRTCHNL_VSI_TYPE_INVALID = 0,
214         VIRTCHNL_VSI_SRIOV = 6,
215 };
216
217 /* VIRTCHNL_OP_GET_VF_RESOURCES
218  * Version 1.0 VF sends this request to PF with no parameters
219  * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
220  * PF responds with an indirect message containing
221  * virtchnl_vf_resource and one or more
222  * virtchnl_vsi_resource structures.
223  */
224
225 struct virtchnl_vsi_resource {
226         u16 vsi_id;
227         u16 num_queue_pairs;
228         enum virtchnl_vsi_type vsi_type;
229         u16 qset_handle;
230         u8 default_mac_addr[ETH_ALEN];
231 };
232
233 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource);
234
235 /* VF capability flags
236  * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including
237  * TX/RX Checksum offloading and TSO for non-tunnelled packets.
238  */
239 #define VIRTCHNL_VF_OFFLOAD_L2                  0x00000001
240 #define VIRTCHNL_VF_OFFLOAD_IWARP               0x00000002
241 #define VIRTCHNL_VF_OFFLOAD_RSVD                0x00000004
242 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ              0x00000008
243 #define VIRTCHNL_VF_OFFLOAD_RSS_REG             0x00000010
244 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR           0x00000020
245 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES          0x00000040
246 #define VIRTCHNL_VF_OFFLOAD_VLAN                0x00010000
247 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING          0x00020000
248 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2       0x00040000
249 #define VIRTCHNL_VF_OFFLOAD_RSS_PF              0X00080000
250 #define VIRTCHNL_VF_OFFLOAD_ENCAP               0X00100000
251 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM          0X00200000
252 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM       0X00400000
253 #define VIRTCHNL_VF_OFFLOAD_ADQ                 0X00800000
254
255 /* Define below the capability flags that are not offloads */
256 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED          0x00000080
257 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \
258                                VIRTCHNL_VF_OFFLOAD_VLAN | \
259                                VIRTCHNL_VF_OFFLOAD_RSS_PF)
260
261 struct virtchnl_vf_resource {
262         u16 num_vsis;
263         u16 num_queue_pairs;
264         u16 max_vectors;
265         u16 max_mtu;
266
267         u32 vf_cap_flags;
268         u32 rss_key_size;
269         u32 rss_lut_size;
270
271         struct virtchnl_vsi_resource vsi_res[1];
272 };
273
274 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource);
275
276 /* VIRTCHNL_OP_CONFIG_TX_QUEUE
277  * VF sends this message to set up parameters for one TX queue.
278  * External data buffer contains one instance of virtchnl_txq_info.
279  * PF configures requested queue and returns a status code.
280  */
281
282 /* Tx queue config info */
283 struct virtchnl_txq_info {
284         u16 vsi_id;
285         u16 queue_id;
286         u16 ring_len;           /* number of descriptors, multiple of 8 */
287         u16 headwb_enabled; /* deprecated with AVF 1.0 */
288         u64 dma_ring_addr;
289         u64 dma_headwb_addr; /* deprecated with AVF 1.0 */
290 };
291
292 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info);
293
294 /* VIRTCHNL_OP_CONFIG_RX_QUEUE
295  * VF sends this message to set up parameters for one RX queue.
296  * External data buffer contains one instance of virtchnl_rxq_info.
297  * PF configures requested queue and returns a status code.
298  */
299
300 /* Rx queue config info */
301 struct virtchnl_rxq_info {
302         u16 vsi_id;
303         u16 queue_id;
304         u32 ring_len;           /* number of descriptors, multiple of 32 */
305         u16 hdr_size;
306         u16 splithdr_enabled; /* deprecated with AVF 1.0 */
307         u32 databuffer_size;
308         u32 max_pkt_size;
309         u32 pad1;
310         u64 dma_ring_addr;
311         enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */
312         u32 pad2;
313 };
314
315 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info);
316
317 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES
318  * VF sends this message to set parameters for all active TX and RX queues
319  * associated with the specified VSI.
320  * PF configures queues and returns status.
321  * If the number of queues specified is greater than the number of queues
322  * associated with the VSI, an error is returned and no queues are configured.
323  */
324 struct virtchnl_queue_pair_info {
325         /* NOTE: vsi_id and queue_id should be identical for both queues. */
326         struct virtchnl_txq_info txq;
327         struct virtchnl_rxq_info rxq;
328 };
329
330 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info);
331
332 struct virtchnl_vsi_queue_config_info {
333         u16 vsi_id;
334         u16 num_queue_pairs;
335         u32 pad;
336         struct virtchnl_queue_pair_info qpair[1];
337 };
338
339 /* VIRTCHNL_OP_REQUEST_QUEUES
340  * VF sends this message to request the PF to allocate additional queues to
341  * this VF.  Each VF gets a guaranteed number of queues on init but asking for
342  * additional queues must be negotiated.  This is a best effort request as it
343  * is possible the PF does not have enough queues left to support the request.
344  * If the PF cannot support the number requested it will respond with the
345  * maximum number it is able to support.  If the request is successful, PF will
346  * then reset the VF to institute required changes.
347  */
348
349 /* VF resource request */
350 struct virtchnl_vf_res_request {
351         u16 num_queue_pairs;
352 };
353
354 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info);
355
356 /* VIRTCHNL_OP_CONFIG_IRQ_MAP
357  * VF uses this message to map vectors to queues.
358  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
359  * are to be associated with the specified vector.
360  * The "other" causes are always mapped to vector 0.
361  * PF configures interrupt mapping and returns status.
362  */
363 struct virtchnl_vector_map {
364         u16 vsi_id;
365         u16 vector_id;
366         u16 rxq_map;
367         u16 txq_map;
368         u16 rxitr_idx;
369         u16 txitr_idx;
370 };
371
372 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map);
373
374 struct virtchnl_irq_map_info {
375         u16 num_vectors;
376         struct virtchnl_vector_map vecmap[1];
377 };
378
379 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info);
380
381 /* VIRTCHNL_OP_ENABLE_QUEUES
382  * VIRTCHNL_OP_DISABLE_QUEUES
383  * VF sends these message to enable or disable TX/RX queue pairs.
384  * The queues fields are bitmaps indicating which queues to act upon.
385  * (Currently, we only support 16 queues per VF, but we make the field
386  * u32 to allow for expansion.)
387  * PF performs requested action and returns status.
388  */
389 struct virtchnl_queue_select {
390         u16 vsi_id;
391         u16 pad;
392         u32 rx_queues;
393         u32 tx_queues;
394 };
395
396 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select);
397
398 /* VIRTCHNL_OP_ADD_ETH_ADDR
399  * VF sends this message in order to add one or more unicast or multicast
400  * address filters for the specified VSI.
401  * PF adds the filters and returns status.
402  */
403
404 /* VIRTCHNL_OP_DEL_ETH_ADDR
405  * VF sends this message in order to remove one or more unicast or multicast
406  * filters for the specified VSI.
407  * PF removes the filters and returns status.
408  */
409
410 struct virtchnl_ether_addr {
411         u8 addr[ETH_ALEN];
412         u8 pad[2];
413 };
414
415 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr);
416
417 struct virtchnl_ether_addr_list {
418         u16 vsi_id;
419         u16 num_elements;
420         struct virtchnl_ether_addr list[1];
421 };
422
423 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list);
424
425 /* VIRTCHNL_OP_ADD_VLAN
426  * VF sends this message to add one or more VLAN tag filters for receives.
427  * PF adds the filters and returns status.
428  * If a port VLAN is configured by the PF, this operation will return an
429  * error to the VF.
430  */
431
432 /* VIRTCHNL_OP_DEL_VLAN
433  * VF sends this message to remove one or more VLAN tag filters for receives.
434  * PF removes the filters and returns status.
435  * If a port VLAN is configured by the PF, this operation will return an
436  * error to the VF.
437  */
438
439 struct virtchnl_vlan_filter_list {
440         u16 vsi_id;
441         u16 num_elements;
442         u16 vlan_id[1];
443 };
444
445 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list);
446
447 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
448  * VF sends VSI id and flags.
449  * PF returns status code in retval.
450  * Note: we assume that broadcast accept mode is always enabled.
451  */
452 struct virtchnl_promisc_info {
453         u16 vsi_id;
454         u16 flags;
455 };
456
457 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info);
458
459 #define FLAG_VF_UNICAST_PROMISC 0x00000001
460 #define FLAG_VF_MULTICAST_PROMISC       0x00000002
461
462 /* VIRTCHNL_OP_GET_STATS
463  * VF sends this message to request stats for the selected VSI. VF uses
464  * the virtchnl_queue_select struct to specify the VSI. The queue_id
465  * field is ignored by the PF.
466  *
467  * PF replies with struct eth_stats in an external buffer.
468  */
469
470 /* VIRTCHNL_OP_CONFIG_RSS_KEY
471  * VIRTCHNL_OP_CONFIG_RSS_LUT
472  * VF sends these messages to configure RSS. Only supported if both PF
473  * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
474  * configuration negotiation. If this is the case, then the RSS fields in
475  * the VF resource struct are valid.
476  * Both the key and LUT are initialized to 0 by the PF, meaning that
477  * RSS is effectively disabled until set up by the VF.
478  */
479 struct virtchnl_rss_key {
480         u16 vsi_id;
481         u16 key_len;
482         u8 key[1];         /* RSS hash key, packed bytes */
483 };
484
485 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key);
486
487 struct virtchnl_rss_lut {
488         u16 vsi_id;
489         u16 lut_entries;
490         u8 lut[1];        /* RSS lookup table */
491 };
492
493 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut);
494
495 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS
496  * VIRTCHNL_OP_SET_RSS_HENA
497  * VF sends these messages to get and set the hash filter enable bits for RSS.
498  * By default, the PF sets these to all possible traffic types that the
499  * hardware supports. The VF can query this value if it wants to change the
500  * traffic types that are hashed by the hardware.
501  */
502 struct virtchnl_rss_hena {
503         u64 hena;
504 };
505
506 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena);
507
508 /* VIRTCHNL_OP_ENABLE_CHANNELS
509  * VIRTCHNL_OP_DISABLE_CHANNELS
510  * VF sends these messages to enable or disable channels based on
511  * the user specified queue count and queue offset for each traffic class.
512  * This struct encompasses all the information that the PF needs from
513  * VF to create a channel.
514  */
515 struct virtchnl_channel_info {
516         u16 count; /* number of queues in a channel */
517         u16 offset; /* queues in a channel start from 'offset' */
518         u32 pad;
519         u64 max_tx_rate;
520 };
521
522 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info);
523
524 struct virtchnl_tc_info {
525         u32     num_tc;
526         u32     pad;
527         struct  virtchnl_channel_info list[1];
528 };
529
530 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info);
531
532 /* VIRTCHNL_ADD_CLOUD_FILTER
533  * VIRTCHNL_DEL_CLOUD_FILTER
534  * VF sends these messages to add or delete a cloud filter based on the
535  * user specified match and action filters. These structures encompass
536  * all the information that the PF needs from the VF to add/delete a
537  * cloud filter.
538  */
539
540 struct virtchnl_l4_spec {
541         u8      src_mac[ETH_ALEN];
542         u8      dst_mac[ETH_ALEN];
543         __be16  vlan_id;
544         __be16  pad; /* reserved for future use */
545         __be32  src_ip[4];
546         __be32  dst_ip[4];
547         __be16  src_port;
548         __be16  dst_port;
549 };
550
551 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec);
552
553 union virtchnl_flow_spec {
554         struct  virtchnl_l4_spec tcp_spec;
555         u8      buffer[128]; /* reserved for future use */
556 };
557
558 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec);
559
560 enum virtchnl_action {
561         /* action types */
562         VIRTCHNL_ACTION_DROP = 0,
563         VIRTCHNL_ACTION_TC_REDIRECT,
564 };
565
566 enum virtchnl_flow_type {
567         /* flow types */
568         VIRTCHNL_TCP_V4_FLOW = 0,
569         VIRTCHNL_TCP_V6_FLOW,
570 };
571
572 struct virtchnl_filter {
573         union   virtchnl_flow_spec data;
574         union   virtchnl_flow_spec mask;
575         enum    virtchnl_flow_type flow_type;
576         enum    virtchnl_action action;
577         u32     action_meta;
578         u8      field_flags;
579 };
580
581 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter);
582
583 /* VIRTCHNL_OP_EVENT
584  * PF sends this message to inform the VF driver of events that may affect it.
585  * No direct response is expected from the VF, though it may generate other
586  * messages in response to this one.
587  */
588 enum virtchnl_event_codes {
589         VIRTCHNL_EVENT_UNKNOWN = 0,
590         VIRTCHNL_EVENT_LINK_CHANGE,
591         VIRTCHNL_EVENT_RESET_IMPENDING,
592         VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
593 };
594
595 #define PF_EVENT_SEVERITY_INFO          0
596 #define PF_EVENT_SEVERITY_CERTAIN_DOOM  255
597
598 struct virtchnl_pf_event {
599         enum virtchnl_event_codes event;
600         union {
601                 /* If the PF driver does not support the new speed reporting
602                  * capabilities then use link_event else use link_event_adv to
603                  * get the speed and link information. The ability to understand
604                  * new speeds is indicated by setting the capability flag
605                  * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter
606                  * in virtchnl_vf_resource struct and can be used to determine
607                  * which link event struct to use below.
608                  */
609                 struct {
610                         enum virtchnl_link_speed link_speed;
611                         bool link_status;
612                 } link_event;
613                 struct {
614                         /* link_speed provided in Mbps */
615                         u32 link_speed;
616                         u8 link_status;
617                 } link_event_adv;
618         } event_data;
619
620         int severity;
621 };
622
623 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event);
624
625 /* VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP
626  * VF uses this message to request PF to map IWARP vectors to IWARP queues.
627  * The request for this originates from the VF IWARP driver through
628  * a client interface between VF LAN and VF IWARP driver.
629  * A vector could have an AEQ and CEQ attached to it although
630  * there is a single AEQ per VF IWARP instance in which case
631  * most vectors will have an INVALID_IDX for aeq and valid idx for ceq.
632  * There will never be a case where there will be multiple CEQs attached
633  * to a single vector.
634  * PF configures interrupt mapping and returns status.
635  */
636
637 struct virtchnl_iwarp_qv_info {
638         u32 v_idx; /* msix_vector */
639         u16 ceq_idx;
640         u16 aeq_idx;
641         u8 itr_idx;
642 };
643
644 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_iwarp_qv_info);
645
646 struct virtchnl_iwarp_qvlist_info {
647         u32 num_vectors;
648         struct virtchnl_iwarp_qv_info qv_info[1];
649 };
650
651 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_iwarp_qvlist_info);
652
653 /* VF reset states - these are written into the RSTAT register:
654  * VFGEN_RSTAT on the VF
655  * When the PF initiates a reset, it writes 0
656  * When the reset is complete, it writes 1
657  * When the PF detects that the VF has recovered, it writes 2
658  * VF checks this register periodically to determine if a reset has occurred,
659  * then polls it to know when the reset is complete.
660  * If either the PF or VF reads the register while the hardware
661  * is in a reset state, it will return DEADBEEF, which, when masked
662  * will result in 3.
663  */
664 enum virtchnl_vfr_states {
665         VIRTCHNL_VFR_INPROGRESS = 0,
666         VIRTCHNL_VFR_COMPLETED,
667         VIRTCHNL_VFR_VFACTIVE,
668 };
669
670 /**
671  * virtchnl_vc_validate_vf_msg
672  * @ver: Virtchnl version info
673  * @v_opcode: Opcode for the message
674  * @msg: pointer to the msg buffer
675  * @msglen: msg length
676  *
677  * validate msg format against struct for each opcode
678  */
679 static inline int
680 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode,
681                             u8 *msg, u16 msglen)
682 {
683         bool err_msg_format = false;
684         int valid_len = 0;
685
686         /* Validate message length. */
687         switch (v_opcode) {
688         case VIRTCHNL_OP_VERSION:
689                 valid_len = sizeof(struct virtchnl_version_info);
690                 break;
691         case VIRTCHNL_OP_RESET_VF:
692                 break;
693         case VIRTCHNL_OP_GET_VF_RESOURCES:
694                 if (VF_IS_V11(ver))
695                         valid_len = sizeof(u32);
696                 break;
697         case VIRTCHNL_OP_CONFIG_TX_QUEUE:
698                 valid_len = sizeof(struct virtchnl_txq_info);
699                 break;
700         case VIRTCHNL_OP_CONFIG_RX_QUEUE:
701                 valid_len = sizeof(struct virtchnl_rxq_info);
702                 break;
703         case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
704                 valid_len = sizeof(struct virtchnl_vsi_queue_config_info);
705                 if (msglen >= valid_len) {
706                         struct virtchnl_vsi_queue_config_info *vqc =
707                             (struct virtchnl_vsi_queue_config_info *)msg;
708                         valid_len += (vqc->num_queue_pairs *
709                                       sizeof(struct
710                                              virtchnl_queue_pair_info));
711                         if (vqc->num_queue_pairs == 0)
712                                 err_msg_format = true;
713                 }
714                 break;
715         case VIRTCHNL_OP_CONFIG_IRQ_MAP:
716                 valid_len = sizeof(struct virtchnl_irq_map_info);
717                 if (msglen >= valid_len) {
718                         struct virtchnl_irq_map_info *vimi =
719                             (struct virtchnl_irq_map_info *)msg;
720                         valid_len += (vimi->num_vectors *
721                                       sizeof(struct virtchnl_vector_map));
722                         if (vimi->num_vectors == 0)
723                                 err_msg_format = true;
724                 }
725                 break;
726         case VIRTCHNL_OP_ENABLE_QUEUES:
727         case VIRTCHNL_OP_DISABLE_QUEUES:
728                 valid_len = sizeof(struct virtchnl_queue_select);
729                 break;
730         case VIRTCHNL_OP_ADD_ETH_ADDR:
731         case VIRTCHNL_OP_DEL_ETH_ADDR:
732                 valid_len = sizeof(struct virtchnl_ether_addr_list);
733                 if (msglen >= valid_len) {
734                         struct virtchnl_ether_addr_list *veal =
735                             (struct virtchnl_ether_addr_list *)msg;
736                         valid_len += veal->num_elements *
737                             sizeof(struct virtchnl_ether_addr);
738                         if (veal->num_elements == 0)
739                                 err_msg_format = true;
740                 }
741                 break;
742         case VIRTCHNL_OP_ADD_VLAN:
743         case VIRTCHNL_OP_DEL_VLAN:
744                 valid_len = sizeof(struct virtchnl_vlan_filter_list);
745                 if (msglen >= valid_len) {
746                         struct virtchnl_vlan_filter_list *vfl =
747                             (struct virtchnl_vlan_filter_list *)msg;
748                         valid_len += vfl->num_elements * sizeof(u16);
749                         if (vfl->num_elements == 0)
750                                 err_msg_format = true;
751                 }
752                 break;
753         case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
754                 valid_len = sizeof(struct virtchnl_promisc_info);
755                 break;
756         case VIRTCHNL_OP_GET_STATS:
757                 valid_len = sizeof(struct virtchnl_queue_select);
758                 break;
759         case VIRTCHNL_OP_IWARP:
760                 /* These messages are opaque to us and will be validated in
761                  * the RDMA client code. We just need to check for nonzero
762                  * length. The firmware will enforce max length restrictions.
763                  */
764                 if (msglen)
765                         valid_len = msglen;
766                 else
767                         err_msg_format = true;
768                 break;
769         case VIRTCHNL_OP_RELEASE_IWARP_IRQ_MAP:
770                 break;
771         case VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP:
772                 valid_len = sizeof(struct virtchnl_iwarp_qvlist_info);
773                 if (msglen >= valid_len) {
774                         struct virtchnl_iwarp_qvlist_info *qv =
775                                 (struct virtchnl_iwarp_qvlist_info *)msg;
776                         if (qv->num_vectors == 0) {
777                                 err_msg_format = true;
778                                 break;
779                         }
780                         valid_len += ((qv->num_vectors - 1) *
781                                 sizeof(struct virtchnl_iwarp_qv_info));
782                 }
783                 break;
784         case VIRTCHNL_OP_CONFIG_RSS_KEY:
785                 valid_len = sizeof(struct virtchnl_rss_key);
786                 if (msglen >= valid_len) {
787                         struct virtchnl_rss_key *vrk =
788                                 (struct virtchnl_rss_key *)msg;
789                         valid_len += vrk->key_len - 1;
790                 }
791                 break;
792         case VIRTCHNL_OP_CONFIG_RSS_LUT:
793                 valid_len = sizeof(struct virtchnl_rss_lut);
794                 if (msglen >= valid_len) {
795                         struct virtchnl_rss_lut *vrl =
796                                 (struct virtchnl_rss_lut *)msg;
797                         valid_len += vrl->lut_entries - 1;
798                 }
799                 break;
800         case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
801                 break;
802         case VIRTCHNL_OP_SET_RSS_HENA:
803                 valid_len = sizeof(struct virtchnl_rss_hena);
804                 break;
805         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
806         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
807                 break;
808         case VIRTCHNL_OP_REQUEST_QUEUES:
809                 valid_len = sizeof(struct virtchnl_vf_res_request);
810                 break;
811         case VIRTCHNL_OP_ENABLE_CHANNELS:
812                 valid_len = sizeof(struct virtchnl_tc_info);
813                 if (msglen >= valid_len) {
814                         struct virtchnl_tc_info *vti =
815                                 (struct virtchnl_tc_info *)msg;
816                         valid_len += vti->num_tc *
817                                 sizeof(struct virtchnl_channel_info);
818                         if (vti->num_tc == 0)
819                                 err_msg_format = true;
820                 }
821                 break;
822         case VIRTCHNL_OP_DISABLE_CHANNELS:
823                 break;
824         case VIRTCHNL_OP_ADD_CLOUD_FILTER:
825                 valid_len = sizeof(struct virtchnl_filter);
826                 break;
827         case VIRTCHNL_OP_DEL_CLOUD_FILTER:
828                 valid_len = sizeof(struct virtchnl_filter);
829                 break;
830         /* These are always errors coming from the VF. */
831         case VIRTCHNL_OP_EVENT:
832         case VIRTCHNL_OP_UNKNOWN:
833         default:
834                 return VIRTCHNL_ERR_PARAM;
835         }
836         /* few more checks */
837         if (err_msg_format || valid_len != msglen)
838                 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH;
839
840         return 0;
841 }
842 #endif /* _VIRTCHNL_H_ */