net/iavf: support quanta size configuration
[dpdk.git] / drivers / common / iavf / virtchnl.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2001-2021 Intel Corporation
3  */
4
5 #ifndef _VIRTCHNL_H_
6 #define _VIRTCHNL_H_
7
8 /* Description:
9  * This header file describes the Virtual Function (VF) - Physical Function
10  * (PF) communication protocol used by the drivers for all devices starting
11  * from our 40G product line
12  *
13  * Admin queue buffer usage:
14  * desc->opcode is always aqc_opc_send_msg_to_pf
15  * flags, retval, datalen, and data addr are all used normally.
16  * The Firmware copies the cookie fields when sending messages between the
17  * PF and VF, but uses all other fields internally. Due to this limitation,
18  * we must send all messages as "indirect", i.e. using an external buffer.
19  *
20  * All the VSI indexes are relative to the VF. Each VF can have maximum of
21  * three VSIs. All the queue indexes are relative to the VSI.  Each VF can
22  * have a maximum of sixteen queues for all of its VSIs.
23  *
24  * The PF is required to return a status code in v_retval for all messages
25  * except RESET_VF, which does not require any response. The returned value
26  * is of virtchnl_status_code type, defined in the shared type.h.
27  *
28  * In general, VF driver initialization should roughly follow the order of
29  * these opcodes. The VF driver must first validate the API version of the
30  * PF driver, then request a reset, then get resources, then configure
31  * queues and interrupts. After these operations are complete, the VF
32  * driver may start its queues, optionally add MAC and VLAN filters, and
33  * process traffic.
34  */
35
36 /* START GENERIC DEFINES
37  * Need to ensure the following enums and defines hold the same meaning and
38  * value in current and future projects
39  */
40
41 #include "virtchnl_inline_ipsec.h"
42
43 /* Error Codes */
44 enum virtchnl_status_code {
45         VIRTCHNL_STATUS_SUCCESS                         = 0,
46         VIRTCHNL_STATUS_ERR_PARAM                       = -5,
47         VIRTCHNL_STATUS_ERR_NO_MEMORY                   = -18,
48         VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH             = -38,
49         VIRTCHNL_STATUS_ERR_CQP_COMPL_ERROR             = -39,
50         VIRTCHNL_STATUS_ERR_INVALID_VF_ID               = -40,
51         VIRTCHNL_STATUS_ERR_ADMIN_QUEUE_ERROR           = -53,
52         VIRTCHNL_STATUS_ERR_NOT_SUPPORTED               = -64,
53 };
54
55 /* Backward compatibility */
56 #define VIRTCHNL_ERR_PARAM VIRTCHNL_STATUS_ERR_PARAM
57 #define VIRTCHNL_STATUS_NOT_SUPPORTED VIRTCHNL_STATUS_ERR_NOT_SUPPORTED
58
59 #define VIRTCHNL_LINK_SPEED_2_5GB_SHIFT         0x0
60 #define VIRTCHNL_LINK_SPEED_100MB_SHIFT         0x1
61 #define VIRTCHNL_LINK_SPEED_1000MB_SHIFT        0x2
62 #define VIRTCHNL_LINK_SPEED_10GB_SHIFT          0x3
63 #define VIRTCHNL_LINK_SPEED_40GB_SHIFT          0x4
64 #define VIRTCHNL_LINK_SPEED_20GB_SHIFT          0x5
65 #define VIRTCHNL_LINK_SPEED_25GB_SHIFT          0x6
66 #define VIRTCHNL_LINK_SPEED_5GB_SHIFT           0x7
67
68 enum virtchnl_link_speed {
69         VIRTCHNL_LINK_SPEED_UNKNOWN     = 0,
70         VIRTCHNL_LINK_SPEED_100MB       = BIT(VIRTCHNL_LINK_SPEED_100MB_SHIFT),
71         VIRTCHNL_LINK_SPEED_1GB         = BIT(VIRTCHNL_LINK_SPEED_1000MB_SHIFT),
72         VIRTCHNL_LINK_SPEED_10GB        = BIT(VIRTCHNL_LINK_SPEED_10GB_SHIFT),
73         VIRTCHNL_LINK_SPEED_40GB        = BIT(VIRTCHNL_LINK_SPEED_40GB_SHIFT),
74         VIRTCHNL_LINK_SPEED_20GB        = BIT(VIRTCHNL_LINK_SPEED_20GB_SHIFT),
75         VIRTCHNL_LINK_SPEED_25GB        = BIT(VIRTCHNL_LINK_SPEED_25GB_SHIFT),
76         VIRTCHNL_LINK_SPEED_2_5GB       = BIT(VIRTCHNL_LINK_SPEED_2_5GB_SHIFT),
77         VIRTCHNL_LINK_SPEED_5GB         = BIT(VIRTCHNL_LINK_SPEED_5GB_SHIFT),
78 };
79
80 /* for hsplit_0 field of Rx HMC context */
81 /* deprecated with IAVF 1.0 */
82 enum virtchnl_rx_hsplit {
83         VIRTCHNL_RX_HSPLIT_NO_SPLIT      = 0,
84         VIRTCHNL_RX_HSPLIT_SPLIT_L2      = 1,
85         VIRTCHNL_RX_HSPLIT_SPLIT_IP      = 2,
86         VIRTCHNL_RX_HSPLIT_SPLIT_TCP_UDP = 4,
87         VIRTCHNL_RX_HSPLIT_SPLIT_SCTP    = 8,
88 };
89
90 enum virtchnl_bw_limit_type {
91         VIRTCHNL_BW_SHAPER = 0,
92 };
93
94 #define VIRTCHNL_ETH_LENGTH_OF_ADDRESS  6
95 /* END GENERIC DEFINES */
96
97 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
98  * of the virtchnl_msg structure.
99  */
100 enum virtchnl_ops {
101 /* The PF sends status change events to VFs using
102  * the VIRTCHNL_OP_EVENT opcode.
103  * VFs send requests to the PF using the other ops.
104  * Use of "advanced opcode" features must be negotiated as part of capabilities
105  * exchange and are not considered part of base mode feature set.
106  */
107         VIRTCHNL_OP_UNKNOWN = 0,
108         VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
109         VIRTCHNL_OP_RESET_VF = 2,
110         VIRTCHNL_OP_GET_VF_RESOURCES = 3,
111         VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
112         VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
113         VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
114         VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
115         VIRTCHNL_OP_ENABLE_QUEUES = 8,
116         VIRTCHNL_OP_DISABLE_QUEUES = 9,
117         VIRTCHNL_OP_ADD_ETH_ADDR = 10,
118         VIRTCHNL_OP_DEL_ETH_ADDR = 11,
119         VIRTCHNL_OP_ADD_VLAN = 12,
120         VIRTCHNL_OP_DEL_VLAN = 13,
121         VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
122         VIRTCHNL_OP_GET_STATS = 15,
123         VIRTCHNL_OP_RSVD = 16,
124         VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */
125         /* opcode 19 is reserved */
126         /* opcodes 20, 21, and 22 are reserved */
127         VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
128         VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
129         VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
130         VIRTCHNL_OP_SET_RSS_HENA = 26,
131         VIRTCHNL_OP_ENABLE_VLAN_STRIPPING = 27,
132         VIRTCHNL_OP_DISABLE_VLAN_STRIPPING = 28,
133         VIRTCHNL_OP_REQUEST_QUEUES = 29,
134         VIRTCHNL_OP_ENABLE_CHANNELS = 30,
135         VIRTCHNL_OP_DISABLE_CHANNELS = 31,
136         VIRTCHNL_OP_ADD_CLOUD_FILTER = 32,
137         VIRTCHNL_OP_DEL_CLOUD_FILTER = 33,
138         VIRTCHNL_OP_INLINE_IPSEC_CRYPTO = 34,
139         /* opcodes 35 and 36 are reserved */
140         VIRTCHNL_OP_DCF_CONFIG_BW = 37,
141         VIRTCHNL_OP_DCF_VLAN_OFFLOAD = 38,
142         VIRTCHNL_OP_DCF_CMD_DESC = 39,
143         VIRTCHNL_OP_DCF_CMD_BUFF = 40,
144         VIRTCHNL_OP_DCF_DISABLE = 41,
145         VIRTCHNL_OP_DCF_GET_VSI_MAP = 42,
146         VIRTCHNL_OP_DCF_GET_PKG_INFO = 43,
147         VIRTCHNL_OP_GET_SUPPORTED_RXDIDS = 44,
148         VIRTCHNL_OP_ADD_RSS_CFG = 45,
149         VIRTCHNL_OP_DEL_RSS_CFG = 46,
150         VIRTCHNL_OP_ADD_FDIR_FILTER = 47,
151         VIRTCHNL_OP_DEL_FDIR_FILTER = 48,
152         VIRTCHNL_OP_GET_MAX_RSS_QREGION = 50,
153         VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS = 51,
154         VIRTCHNL_OP_ADD_VLAN_V2 = 52,
155         VIRTCHNL_OP_DEL_VLAN_V2 = 53,
156         VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 = 54,
157         VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 = 55,
158         VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 = 56,
159         VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2 = 57,
160         VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2 = 58,
161         VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2 = 59,
162         VIRTCHNL_OP_GET_QOS_CAPS = 66,
163         VIRTCHNL_OP_CONFIG_QUEUE_TC_MAP = 67,
164         VIRTCHNL_OP_ENABLE_QUEUES_V2 = 107,
165         VIRTCHNL_OP_DISABLE_QUEUES_V2 = 108,
166         VIRTCHNL_OP_MAP_QUEUE_VECTOR = 111,
167         VIRTCHNL_OP_CONFIG_QUEUE_BW = 112,
168         VIRTCHNL_OP_CONFIG_QUANTA = 113,
169         VIRTCHNL_OP_MAX,
170 };
171
172 static inline const char *virtchnl_op_str(enum virtchnl_ops v_opcode)
173 {
174         switch (v_opcode) {
175         case VIRTCHNL_OP_UNKNOWN:
176                 return "VIRTCHNL_OP_UNKNOWN";
177         case VIRTCHNL_OP_VERSION:
178                 return "VIRTCHNL_OP_VERSION";
179         case VIRTCHNL_OP_RESET_VF:
180                 return "VIRTCHNL_OP_RESET_VF";
181         case VIRTCHNL_OP_GET_VF_RESOURCES:
182                 return "VIRTCHNL_OP_GET_VF_RESOURCES";
183         case VIRTCHNL_OP_CONFIG_TX_QUEUE:
184                 return "VIRTCHNL_OP_CONFIG_TX_QUEUE";
185         case VIRTCHNL_OP_CONFIG_RX_QUEUE:
186                 return "VIRTCHNL_OP_CONFIG_RX_QUEUE";
187         case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
188                 return "VIRTCHNL_OP_CONFIG_VSI_QUEUES";
189         case VIRTCHNL_OP_CONFIG_IRQ_MAP:
190                 return "VIRTCHNL_OP_CONFIG_IRQ_MAP";
191         case VIRTCHNL_OP_ENABLE_QUEUES:
192                 return "VIRTCHNL_OP_ENABLE_QUEUES";
193         case VIRTCHNL_OP_DISABLE_QUEUES:
194                 return "VIRTCHNL_OP_DISABLE_QUEUES";
195         case VIRTCHNL_OP_ADD_ETH_ADDR:
196                 return "VIRTCHNL_OP_ADD_ETH_ADDR";
197         case VIRTCHNL_OP_DEL_ETH_ADDR:
198                 return "VIRTCHNL_OP_DEL_ETH_ADDR";
199         case VIRTCHNL_OP_ADD_VLAN:
200                 return "VIRTCHNL_OP_ADD_VLAN";
201         case VIRTCHNL_OP_DEL_VLAN:
202                 return "VIRTCHNL_OP_DEL_VLAN";
203         case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
204                 return "VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE";
205         case VIRTCHNL_OP_GET_STATS:
206                 return "VIRTCHNL_OP_GET_STATS";
207         case VIRTCHNL_OP_RSVD:
208                 return "VIRTCHNL_OP_RSVD";
209         case VIRTCHNL_OP_EVENT:
210                 return "VIRTCHNL_OP_EVENT";
211         case VIRTCHNL_OP_CONFIG_RSS_KEY:
212                 return "VIRTCHNL_OP_CONFIG_RSS_KEY";
213         case VIRTCHNL_OP_CONFIG_RSS_LUT:
214                 return "VIRTCHNL_OP_CONFIG_RSS_LUT";
215         case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
216                 return "VIRTCHNL_OP_GET_RSS_HENA_CAPS";
217         case VIRTCHNL_OP_SET_RSS_HENA:
218                 return "VIRTCHNL_OP_SET_RSS_HENA";
219         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
220                 return "VIRTCHNL_OP_ENABLE_VLAN_STRIPPING";
221         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
222                 return "VIRTCHNL_OP_DISABLE_VLAN_STRIPPING";
223         case VIRTCHNL_OP_REQUEST_QUEUES:
224                 return "VIRTCHNL_OP_REQUEST_QUEUES";
225         case VIRTCHNL_OP_ENABLE_CHANNELS:
226                 return "VIRTCHNL_OP_ENABLE_CHANNELS";
227         case VIRTCHNL_OP_DISABLE_CHANNELS:
228                 return "VIRTCHNL_OP_DISABLE_CHANNELS";
229         case VIRTCHNL_OP_ADD_CLOUD_FILTER:
230                 return "VIRTCHNL_OP_ADD_CLOUD_FILTER";
231         case VIRTCHNL_OP_DEL_CLOUD_FILTER:
232                 return "VIRTCHNL_OP_DEL_CLOUD_FILTER";
233         case VIRTCHNL_OP_INLINE_IPSEC_CRYPTO:
234                 return "VIRTCHNL_OP_INLINE_IPSEC_CRYPTO";
235         case VIRTCHNL_OP_DCF_CMD_DESC:
236                 return "VIRTCHNL_OP_DCF_CMD_DESC";
237         case VIRTCHNL_OP_DCF_CMD_BUFF:
238                 return "VIRTCHNL_OP_DCF_CMD_BUFF";
239         case VIRTCHNL_OP_DCF_DISABLE:
240                 return "VIRTCHNL_OP_DCF_DISABLE";
241         case VIRTCHNL_OP_DCF_GET_VSI_MAP:
242                 return "VIRTCHNL_OP_DCF_GET_VSI_MAP";
243         case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
244                 return "VIRTCHNL_OP_GET_SUPPORTED_RXDIDS";
245         case VIRTCHNL_OP_ADD_RSS_CFG:
246                 return "VIRTCHNL_OP_ADD_RSS_CFG";
247         case VIRTCHNL_OP_DEL_RSS_CFG:
248                 return "VIRTCHNL_OP_DEL_RSS_CFG";
249         case VIRTCHNL_OP_ADD_FDIR_FILTER:
250                 return "VIRTCHNL_OP_ADD_FDIR_FILTER";
251         case VIRTCHNL_OP_DEL_FDIR_FILTER:
252                 return "VIRTCHNL_OP_DEL_FDIR_FILTER";
253         case VIRTCHNL_OP_GET_MAX_RSS_QREGION:
254                 return "VIRTCHNL_OP_GET_MAX_RSS_QREGION";
255         case VIRTCHNL_OP_ENABLE_QUEUES_V2:
256                 return "VIRTCHNL_OP_ENABLE_QUEUES_V2";
257         case VIRTCHNL_OP_DISABLE_QUEUES_V2:
258                 return "VIRTCHNL_OP_DISABLE_QUEUES_V2";
259         case VIRTCHNL_OP_MAP_QUEUE_VECTOR:
260                 return "VIRTCHNL_OP_MAP_QUEUE_VECTOR";
261         case VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS:
262                 return "VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS";
263         case VIRTCHNL_OP_ADD_VLAN_V2:
264                 return "VIRTCHNL_OP_ADD_VLAN_V2";
265         case VIRTCHNL_OP_DEL_VLAN_V2:
266                 return "VIRTCHNL_OP_DEL_VLAN_V2";
267         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2:
268                 return "VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2";
269         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2:
270                 return "VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2";
271         case VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2:
272                 return "VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2";
273         case VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2:
274                 return "VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2";
275         case VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2:
276                 return "VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2";
277         case VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2:
278                 return "VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2";
279         case VIRTCHNL_OP_MAX:
280                 return "VIRTCHNL_OP_MAX";
281         default:
282                 return "Unsupported (update virtchnl.h)";
283         }
284 }
285
286 /* These macros are used to generate compilation errors if a structure/union
287  * is not exactly the correct length. It gives a divide by zero error if the
288  * structure/union is not of the correct size, otherwise it creates an enum
289  * that is never used.
290  */
291 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \
292         { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) }
293 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \
294         { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) }
295
296 /* Virtual channel message descriptor. This overlays the admin queue
297  * descriptor. All other data is passed in external buffers.
298  */
299
300 struct virtchnl_msg {
301         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
302
303         /* avoid confusion with desc->opcode */
304         enum virtchnl_ops v_opcode;
305
306         /* ditto for desc->retval */
307         enum virtchnl_status_code v_retval;
308         u32 vfid;                        /* used by PF when sending to VF */
309 };
310
311 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg);
312
313 /* Message descriptions and data structures. */
314
315 /* VIRTCHNL_OP_VERSION
316  * VF posts its version number to the PF. PF responds with its version number
317  * in the same format, along with a return code.
318  * Reply from PF has its major/minor versions also in param0 and param1.
319  * If there is a major version mismatch, then the VF cannot operate.
320  * If there is a minor version mismatch, then the VF can operate but should
321  * add a warning to the system log.
322  *
323  * This enum element MUST always be specified as == 1, regardless of other
324  * changes in the API. The PF must always respond to this message without
325  * error regardless of version mismatch.
326  */
327 #define VIRTCHNL_VERSION_MAJOR          1
328 #define VIRTCHNL_VERSION_MINOR          1
329 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS       0
330
331 struct virtchnl_version_info {
332         u32 major;
333         u32 minor;
334 };
335
336 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info);
337
338 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0))
339 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1))
340
341 /* VIRTCHNL_OP_RESET_VF
342  * VF sends this request to PF with no parameters
343  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
344  * until reset completion is indicated. The admin queue must be reinitialized
345  * after this operation.
346  *
347  * When reset is complete, PF must ensure that all queues in all VSIs associated
348  * with the VF are stopped, all queue configurations in the HMC are set to 0,
349  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
350  * are cleared.
351  */
352
353 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV
354  * vsi_type should always be 6 for backward compatibility. Add other fields
355  * as needed.
356  */
357 enum virtchnl_vsi_type {
358         VIRTCHNL_VSI_TYPE_INVALID = 0,
359         VIRTCHNL_VSI_SRIOV = 6,
360 };
361
362 /* VIRTCHNL_OP_GET_VF_RESOURCES
363  * Version 1.0 VF sends this request to PF with no parameters
364  * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
365  * PF responds with an indirect message containing
366  * virtchnl_vf_resource and one or more
367  * virtchnl_vsi_resource structures.
368  */
369
370 struct virtchnl_vsi_resource {
371         u16 vsi_id;
372         u16 num_queue_pairs;
373
374         /* see enum virtchnl_vsi_type */
375         s32 vsi_type;
376         u16 qset_handle;
377         u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
378 };
379
380 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource);
381
382 /* VF capability flags
383  * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including
384  * TX/RX Checksum offloading and TSO for non-tunnelled packets.
385  */
386 #define VIRTCHNL_VF_OFFLOAD_L2                  BIT(0)
387 #define VIRTCHNL_VF_OFFLOAD_IWARP               BIT(1)
388 #define VIRTCHNL_VF_OFFLOAD_RSVD                BIT(2)
389 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ              BIT(3)
390 #define VIRTCHNL_VF_OFFLOAD_RSS_REG             BIT(4)
391 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR           BIT(5)
392 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES          BIT(6)
393 /* used to negotiate communicating link speeds in Mbps */
394 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED          BIT(7)
395 #define VIRTCHNL_VF_OFFLOAD_INLINE_IPSEC_CRYPTO BIT(8)
396 #define VIRTCHNL_VF_LARGE_NUM_QPAIRS            BIT(9)
397 #define VIRTCHNL_VF_OFFLOAD_CRC                 BIT(10)
398 #define VIRTCHNL_VF_OFFLOAD_VLAN_V2             BIT(15)
399 #define VIRTCHNL_VF_OFFLOAD_VLAN                BIT(16)
400 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING          BIT(17)
401 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2       BIT(18)
402 #define VIRTCHNL_VF_OFFLOAD_RSS_PF              BIT(19)
403 #define VIRTCHNL_VF_OFFLOAD_ENCAP               BIT(20)
404 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM          BIT(21)
405 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM       BIT(22)
406 #define VIRTCHNL_VF_OFFLOAD_ADQ                 BIT(23)
407 #define VIRTCHNL_VF_OFFLOAD_ADQ_V2              BIT(24)
408 #define VIRTCHNL_VF_OFFLOAD_USO                 BIT(25)
409 #define VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC        BIT(26)
410 #define VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF          BIT(27)
411 #define VIRTCHNL_VF_OFFLOAD_FDIR_PF             BIT(28)
412 #define VIRTCHNL_VF_OFFLOAD_QOS         BIT(29)
413 #define VIRTCHNL_VF_CAP_DCF                     BIT(30)
414         /* BIT(31) is reserved */
415
416 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \
417                                VIRTCHNL_VF_OFFLOAD_VLAN | \
418                                VIRTCHNL_VF_OFFLOAD_RSS_PF)
419
420 struct virtchnl_vf_resource {
421         u16 num_vsis;
422         u16 num_queue_pairs;
423         u16 max_vectors;
424         u16 max_mtu;
425
426         u32 vf_cap_flags;
427         u32 rss_key_size;
428         u32 rss_lut_size;
429
430         struct virtchnl_vsi_resource vsi_res[1];
431 };
432
433 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource);
434
435 /* VIRTCHNL_OP_CONFIG_TX_QUEUE
436  * VF sends this message to set up parameters for one TX queue.
437  * External data buffer contains one instance of virtchnl_txq_info.
438  * PF configures requested queue and returns a status code.
439  */
440
441 /* Tx queue config info */
442 struct virtchnl_txq_info {
443         u16 vsi_id;
444         u16 queue_id;
445         u16 ring_len;           /* number of descriptors, multiple of 8 */
446         u16 headwb_enabled; /* deprecated with AVF 1.0 */
447         u64 dma_ring_addr;
448         u64 dma_headwb_addr; /* deprecated with AVF 1.0 */
449 };
450
451 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info);
452
453 /* RX descriptor IDs (range from 0 to 63) */
454 enum virtchnl_rx_desc_ids {
455         VIRTCHNL_RXDID_0_16B_BASE               = 0,
456         /* 32B_BASE and FLEX_SPLITQ share desc ids as default descriptors
457          * because they can be differentiated based on queue model; e.g. single
458          * queue model can only use 32B_BASE and split queue model can only use
459          * FLEX_SPLITQ.  Having these as 1 allows them to be used as default
460          * descriptors without negotiation.
461          */
462         VIRTCHNL_RXDID_1_32B_BASE               = 1,
463         VIRTCHNL_RXDID_1_FLEX_SPLITQ            = 1,
464         VIRTCHNL_RXDID_2_FLEX_SQ_NIC            = 2,
465         VIRTCHNL_RXDID_3_FLEX_SQ_SW             = 3,
466         VIRTCHNL_RXDID_4_FLEX_SQ_NIC_VEB        = 4,
467         VIRTCHNL_RXDID_5_FLEX_SQ_NIC_ACL        = 5,
468         VIRTCHNL_RXDID_6_FLEX_SQ_NIC_2          = 6,
469         VIRTCHNL_RXDID_7_HW_RSVD                = 7,
470         /* 9 through 15 are reserved */
471         VIRTCHNL_RXDID_16_COMMS_GENERIC         = 16,
472         VIRTCHNL_RXDID_17_COMMS_AUX_VLAN        = 17,
473         VIRTCHNL_RXDID_18_COMMS_AUX_IPV4        = 18,
474         VIRTCHNL_RXDID_19_COMMS_AUX_IPV6        = 19,
475         VIRTCHNL_RXDID_20_COMMS_AUX_FLOW        = 20,
476         VIRTCHNL_RXDID_21_COMMS_AUX_TCP         = 21,
477         /* 22 through 63 are reserved */
478 };
479
480 /* RX descriptor ID bitmasks */
481 enum virtchnl_rx_desc_id_bitmasks {
482         VIRTCHNL_RXDID_0_16B_BASE_M             = BIT(VIRTCHNL_RXDID_0_16B_BASE),
483         VIRTCHNL_RXDID_1_32B_BASE_M             = BIT(VIRTCHNL_RXDID_1_32B_BASE),
484         VIRTCHNL_RXDID_1_FLEX_SPLITQ_M          = BIT(VIRTCHNL_RXDID_1_FLEX_SPLITQ),
485         VIRTCHNL_RXDID_2_FLEX_SQ_NIC_M          = BIT(VIRTCHNL_RXDID_2_FLEX_SQ_NIC),
486         VIRTCHNL_RXDID_3_FLEX_SQ_SW_M           = BIT(VIRTCHNL_RXDID_3_FLEX_SQ_SW),
487         VIRTCHNL_RXDID_4_FLEX_SQ_NIC_VEB_M      = BIT(VIRTCHNL_RXDID_4_FLEX_SQ_NIC_VEB),
488         VIRTCHNL_RXDID_5_FLEX_SQ_NIC_ACL_M      = BIT(VIRTCHNL_RXDID_5_FLEX_SQ_NIC_ACL),
489         VIRTCHNL_RXDID_6_FLEX_SQ_NIC_2_M        = BIT(VIRTCHNL_RXDID_6_FLEX_SQ_NIC_2),
490         VIRTCHNL_RXDID_7_HW_RSVD_M              = BIT(VIRTCHNL_RXDID_7_HW_RSVD),
491         /* 9 through 15 are reserved */
492         VIRTCHNL_RXDID_16_COMMS_GENERIC_M       = BIT(VIRTCHNL_RXDID_16_COMMS_GENERIC),
493         VIRTCHNL_RXDID_17_COMMS_AUX_VLAN_M      = BIT(VIRTCHNL_RXDID_17_COMMS_AUX_VLAN),
494         VIRTCHNL_RXDID_18_COMMS_AUX_IPV4_M      = BIT(VIRTCHNL_RXDID_18_COMMS_AUX_IPV4),
495         VIRTCHNL_RXDID_19_COMMS_AUX_IPV6_M      = BIT(VIRTCHNL_RXDID_19_COMMS_AUX_IPV6),
496         VIRTCHNL_RXDID_20_COMMS_AUX_FLOW_M      = BIT(VIRTCHNL_RXDID_20_COMMS_AUX_FLOW),
497         VIRTCHNL_RXDID_21_COMMS_AUX_TCP_M       = BIT(VIRTCHNL_RXDID_21_COMMS_AUX_TCP),
498         /* 22 through 63 are reserved */
499 };
500
501 /* VIRTCHNL_OP_CONFIG_RX_QUEUE
502  * VF sends this message to set up parameters for one RX queue.
503  * External data buffer contains one instance of virtchnl_rxq_info.
504  * PF configures requested queue and returns a status code. The
505  * crc_disable flag disables CRC stripping on the VF. Setting
506  * the crc_disable flag to 1 will disable CRC stripping for each
507  * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC
508  * offload must have been set prior to sending this info or the PF
509  * will ignore the request. This flag should be set the same for
510  * all of the queues for a VF.
511  */
512
513 /* Rx queue config info */
514 struct virtchnl_rxq_info {
515         u16 vsi_id;
516         u16 queue_id;
517         u32 ring_len;           /* number of descriptors, multiple of 32 */
518         u16 hdr_size;
519         u16 splithdr_enabled; /* deprecated with AVF 1.0 */
520         u32 databuffer_size;
521         u32 max_pkt_size;
522         u8 crc_disable;
523         /* see enum virtchnl_rx_desc_ids;
524          * only used when VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC is supported. Note
525          * that when the offload is not supported, the descriptor format aligns
526          * with VIRTCHNL_RXDID_1_32B_BASE.
527          */
528         u8 rxdid;
529         u8 pad1[2];
530         u64 dma_ring_addr;
531
532         /* see enum virtchnl_rx_hsplit; deprecated with AVF 1.0 */
533         s32 rx_split_pos;
534         u32 pad2;
535 };
536
537 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info);
538
539 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES
540  * VF sends this message to set parameters for active TX and RX queues
541  * associated with the specified VSI.
542  * PF configures queues and returns status.
543  * If the number of queues specified is greater than the number of queues
544  * associated with the VSI, an error is returned and no queues are configured.
545  * NOTE: The VF is not required to configure all queues in a single request.
546  * It may send multiple messages. PF drivers must correctly handle all VF
547  * requests.
548  */
549 struct virtchnl_queue_pair_info {
550         /* NOTE: vsi_id and queue_id should be identical for both queues. */
551         struct virtchnl_txq_info txq;
552         struct virtchnl_rxq_info rxq;
553 };
554
555 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info);
556
557 struct virtchnl_vsi_queue_config_info {
558         u16 vsi_id;
559         u16 num_queue_pairs;
560         u32 pad;
561         struct virtchnl_queue_pair_info qpair[1];
562 };
563
564 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info);
565
566 /* VIRTCHNL_OP_REQUEST_QUEUES
567  * VF sends this message to request the PF to allocate additional queues to
568  * this VF.  Each VF gets a guaranteed number of queues on init but asking for
569  * additional queues must be negotiated.  This is a best effort request as it
570  * is possible the PF does not have enough queues left to support the request.
571  * If the PF cannot support the number requested it will respond with the
572  * maximum number it is able to support.  If the request is successful, PF will
573  * then reset the VF to institute required changes.
574  */
575
576 /* VF resource request */
577 struct virtchnl_vf_res_request {
578         u16 num_queue_pairs;
579 };
580
581 /* VIRTCHNL_OP_CONFIG_IRQ_MAP
582  * VF uses this message to map vectors to queues.
583  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
584  * are to be associated with the specified vector.
585  * The "other" causes are always mapped to vector 0. The VF may not request
586  * that vector 0 be used for traffic.
587  * PF configures interrupt mapping and returns status.
588  * NOTE: due to hardware requirements, all active queues (both TX and RX)
589  * should be mapped to interrupts, even if the driver intends to operate
590  * only in polling mode. In this case the interrupt may be disabled, but
591  * the ITR timer will still run to trigger writebacks.
592  */
593 struct virtchnl_vector_map {
594         u16 vsi_id;
595         u16 vector_id;
596         u16 rxq_map;
597         u16 txq_map;
598         u16 rxitr_idx;
599         u16 txitr_idx;
600 };
601
602 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map);
603
604 struct virtchnl_irq_map_info {
605         u16 num_vectors;
606         struct virtchnl_vector_map vecmap[1];
607 };
608
609 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info);
610
611 /* VIRTCHNL_OP_ENABLE_QUEUES
612  * VIRTCHNL_OP_DISABLE_QUEUES
613  * VF sends these message to enable or disable TX/RX queue pairs.
614  * The queues fields are bitmaps indicating which queues to act upon.
615  * (Currently, we only support 16 queues per VF, but we make the field
616  * u32 to allow for expansion.)
617  * PF performs requested action and returns status.
618  * NOTE: The VF is not required to enable/disable all queues in a single
619  * request. It may send multiple messages.
620  * PF drivers must correctly handle all VF requests.
621  */
622 struct virtchnl_queue_select {
623         u16 vsi_id;
624         u16 pad;
625         u32 rx_queues;
626         u32 tx_queues;
627 };
628
629 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select);
630
631 /* VIRTCHNL_OP_GET_MAX_RSS_QREGION
632  *
633  * if VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
634  * then this op must be supported.
635  *
636  * VF sends this message in order to query the max RSS queue region
637  * size supported by PF, when VIRTCHNL_VF_LARGE_NUM_QPAIRS is enabled.
638  * This information should be used when configuring the RSS LUT and/or
639  * configuring queue region based filters.
640  *
641  * The maximum RSS queue region is 2^qregion_width. So, a qregion_width
642  * of 6 would inform the VF that the PF supports a maximum RSS queue region
643  * of 64.
644  *
645  * A queue region represents a range of queues that can be used to configure
646  * a RSS LUT. For example, if a VF is given 64 queues, but only a max queue
647  * region size of 16 (i.e. 2^qregion_width = 16) then it will only be able
648  * to configure the RSS LUT with queue indices from 0 to 15. However, other
649  * filters can be used to direct packets to queues >15 via specifying a queue
650  * base/offset and queue region width.
651  */
652 struct virtchnl_max_rss_qregion {
653         u16 vport_id;
654         u16 qregion_width;
655         u8 pad[4];
656 };
657
658 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_max_rss_qregion);
659
660 /* VIRTCHNL_OP_ADD_ETH_ADDR
661  * VF sends this message in order to add one or more unicast or multicast
662  * address filters for the specified VSI.
663  * PF adds the filters and returns status.
664  */
665
666 /* VIRTCHNL_OP_DEL_ETH_ADDR
667  * VF sends this message in order to remove one or more unicast or multicast
668  * filters for the specified VSI.
669  * PF removes the filters and returns status.
670  */
671
672 /* VIRTCHNL_ETHER_ADDR_LEGACY
673  * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad
674  * bytes. Moving forward all VF drivers should not set type to
675  * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy
676  * behavior. The control plane function (i.e. PF) can use a best effort method
677  * of tracking the primary/device unicast in this case, but there is no
678  * guarantee and functionality depends on the implementation of the PF.
679  */
680
681 /* VIRTCHNL_ETHER_ADDR_PRIMARY
682  * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the
683  * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and
684  * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane
685  * function (i.e. PF) to accurately track and use this MAC address for
686  * displaying on the host and for VM/function reset.
687  */
688
689 /* VIRTCHNL_ETHER_ADDR_EXTRA
690  * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra
691  * unicast and/or multicast filters that are being added/deleted via
692  * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively.
693  */
694 struct virtchnl_ether_addr {
695         u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
696         u8 type;
697 #define VIRTCHNL_ETHER_ADDR_LEGACY      0
698 #define VIRTCHNL_ETHER_ADDR_PRIMARY     1
699 #define VIRTCHNL_ETHER_ADDR_EXTRA       2
700 #define VIRTCHNL_ETHER_ADDR_TYPE_MASK   3 /* first two bits of type are valid */
701         u8 pad;
702 };
703
704 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr);
705
706 struct virtchnl_ether_addr_list {
707         u16 vsi_id;
708         u16 num_elements;
709         struct virtchnl_ether_addr list[1];
710 };
711
712 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list);
713
714 /* VIRTCHNL_OP_ADD_VLAN
715  * VF sends this message to add one or more VLAN tag filters for receives.
716  * PF adds the filters and returns status.
717  * If a port VLAN is configured by the PF, this operation will return an
718  * error to the VF.
719  */
720
721 /* VIRTCHNL_OP_DEL_VLAN
722  * VF sends this message to remove one or more VLAN tag filters for receives.
723  * PF removes the filters and returns status.
724  * If a port VLAN is configured by the PF, this operation will return an
725  * error to the VF.
726  */
727
728 struct virtchnl_vlan_filter_list {
729         u16 vsi_id;
730         u16 num_elements;
731         u16 vlan_id[1];
732 };
733
734 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list);
735
736 /* This enum is used for all of the VIRTCHNL_VF_OFFLOAD_VLAN_V2_CAPS related
737  * structures and opcodes.
738  *
739  * VIRTCHNL_VLAN_UNSUPPORTED - This field is not supported and if a VF driver
740  * populates it the PF should return VIRTCHNL_STATUS_ERR_NOT_SUPPORTED.
741  *
742  * VIRTCHNL_VLAN_ETHERTYPE_8100 - This field supports 0x8100 ethertype.
743  * VIRTCHNL_VLAN_ETHERTYPE_88A8 - This field supports 0x88A8 ethertype.
744  * VIRTCHNL_VLAN_ETHERTYPE_9100 - This field supports 0x9100 ethertype.
745  *
746  * VIRTCHNL_VLAN_ETHERTYPE_AND - Used when multiple ethertypes can be supported
747  * by the PF concurrently. For example, if the PF can support
748  * VIRTCHNL_VLAN_ETHERTYPE_8100 AND VIRTCHNL_VLAN_ETHERTYPE_88A8 filters it
749  * would OR the following bits:
750  *
751  *      VIRTHCNL_VLAN_ETHERTYPE_8100 |
752  *      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
753  *      VIRTCHNL_VLAN_ETHERTYPE_AND;
754  *
755  * The VF would interpret this as VLAN filtering can be supported on both 0x8100
756  * and 0x88A8 VLAN ethertypes.
757  *
758  * VIRTCHNL_ETHERTYPE_XOR - Used when only a single ethertype can be supported
759  * by the PF concurrently. For example if the PF can support
760  * VIRTCHNL_VLAN_ETHERTYPE_8100 XOR VIRTCHNL_VLAN_ETHERTYPE_88A8 stripping
761  * offload it would OR the following bits:
762  *
763  *      VIRTCHNL_VLAN_ETHERTYPE_8100 |
764  *      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
765  *      VIRTCHNL_VLAN_ETHERTYPE_XOR;
766  *
767  * The VF would interpret this as VLAN stripping can be supported on either
768  * 0x8100 or 0x88a8 VLAN ethertypes. So when requesting VLAN stripping via
769  * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 the specified ethertype will override
770  * the previously set value.
771  *
772  * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG1 - Used to tell the VF to insert and/or
773  * strip the VLAN tag using the L2TAG1 field of the Tx/Rx descriptors.
774  *
775  * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to insert hardware
776  * offloaded VLAN tags using the L2TAG2 field of the Tx descriptor.
777  *
778  * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to strip hardware
779  * offloaded VLAN tags using the L2TAG2_2 field of the Rx descriptor.
780  *
781  * VIRTCHNL_VLAN_PRIO - This field supports VLAN priority bits. This is used for
782  * VLAN filtering if the underlying PF supports it.
783  *
784  * VIRTCHNL_VLAN_TOGGLE_ALLOWED - This field is used to say whether a
785  * certain VLAN capability can be toggled. For example if the underlying PF/CP
786  * allows the VF to toggle VLAN filtering, stripping, and/or insertion it should
787  * set this bit along with the supported ethertypes.
788  */
789 enum virtchnl_vlan_support {
790         VIRTCHNL_VLAN_UNSUPPORTED =             0,
791         VIRTCHNL_VLAN_ETHERTYPE_8100 =          0x00000001,
792         VIRTCHNL_VLAN_ETHERTYPE_88A8 =          0x00000002,
793         VIRTCHNL_VLAN_ETHERTYPE_9100 =          0x00000004,
794         VIRTCHNL_VLAN_TAG_LOCATION_L2TAG1 =     0x00000100,
795         VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 =     0x00000200,
796         VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2_2 =   0x00000400,
797         VIRTCHNL_VLAN_PRIO =                    0x01000000,
798         VIRTCHNL_VLAN_FILTER_MASK =             0x10000000,
799         VIRTCHNL_VLAN_ETHERTYPE_AND =           0x20000000,
800         VIRTCHNL_VLAN_ETHERTYPE_XOR =           0x40000000,
801         VIRTCHNL_VLAN_TOGGLE =                  0x80000000
802 };
803
804 /* This structure is used as part of the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS
805  * for filtering, insertion, and stripping capabilities.
806  *
807  * If only outer capabilities are supported (for filtering, insertion, and/or
808  * stripping) then this refers to the outer most or single VLAN from the VF's
809  * perspective.
810  *
811  * If only inner capabilities are supported (for filtering, insertion, and/or
812  * stripping) then this refers to the outer most or single VLAN from the VF's
813  * perspective. Functionally this is the same as if only outer capabilities are
814  * supported. The VF driver is just forced to use the inner fields when
815  * adding/deleting filters and enabling/disabling offloads (if supported).
816  *
817  * If both outer and inner capabilities are supported (for filtering, insertion,
818  * and/or stripping) then outer refers to the outer most or single VLAN and
819  * inner refers to the second VLAN, if it exists, in the packet.
820  *
821  * There is no support for tunneled VLAN offloads, so outer or inner are never
822  * referring to a tunneled packet from the VF's perspective.
823  */
824 struct virtchnl_vlan_supported_caps {
825         u32 outer;
826         u32 inner;
827 };
828
829 /* The PF populates these fields based on the supported VLAN filtering. If a
830  * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will
831  * reject any VIRTCHNL_OP_ADD_VLAN_V2 or VIRTCHNL_OP_DEL_VLAN_V2 messages using
832  * the unsupported fields.
833  *
834  * Also, a VF is only allowed to toggle its VLAN filtering setting if the
835  * VIRTCHNL_VLAN_TOGGLE bit is set.
836  *
837  * The ethertype(s) specified in the ethertype_init field are the ethertypes
838  * enabled for VLAN filtering. VLAN filtering in this case refers to the outer
839  * most VLAN from the VF's perspective. If both inner and outer filtering are
840  * allowed then ethertype_init only refers to the outer most VLAN as only
841  * VLAN ethertype supported for inner VLAN filtering is
842  * VIRTCHNL_VLAN_ETHERTYPE_8100. By default, inner VLAN filtering is disabled
843  * when both inner and outer filtering are allowed.
844  *
845  * The max_filters field tells the VF how many VLAN filters it's allowed to have
846  * at any one time. If it exceeds this amount and tries to add another filter,
847  * then the request will be rejected by the PF. To prevent failures, the VF
848  * should keep track of how many VLAN filters it has added and not attempt to
849  * add more than max_filters.
850  */
851 struct virtchnl_vlan_filtering_caps {
852         struct virtchnl_vlan_supported_caps filtering_support;
853         u32 ethertype_init;
854         u16 max_filters;
855         u8 pad[2];
856 };
857
858 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vlan_filtering_caps);
859
860 /* This enum is used for the virtchnl_vlan_offload_caps structure to specify
861  * if the PF supports a different ethertype for stripping and insertion.
862  *
863  * VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION - The ethertype(s) specified
864  * for stripping affect the ethertype(s) specified for insertion and visa versa
865  * as well. If the VF tries to configure VLAN stripping via
866  * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 with VIRTCHNL_VLAN_ETHERTYPE_8100 then
867  * that will be the ethertype for both stripping and insertion.
868  *
869  * VIRTCHNL_ETHERTYPE_MATCH_NOT_REQUIRED - The ethertype(s) specified for
870  * stripping do not affect the ethertype(s) specified for insertion and visa
871  * versa.
872  */
873 enum virtchnl_vlan_ethertype_match {
874         VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION = 0,
875         VIRTCHNL_ETHERTYPE_MATCH_NOT_REQUIRED = 1,
876 };
877
878 /* The PF populates these fields based on the supported VLAN offloads. If a
879  * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will
880  * reject any VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 or
881  * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 messages using the unsupported fields.
882  *
883  * Also, a VF is only allowed to toggle its VLAN offload setting if the
884  * VIRTCHNL_VLAN_TOGGLE_ALLOWED bit is set.
885  *
886  * The VF driver needs to be aware of how the tags are stripped by hardware and
887  * inserted by the VF driver based on the level of offload support. The PF will
888  * populate these fields based on where the VLAN tags are expected to be
889  * offloaded via the VIRTHCNL_VLAN_TAG_LOCATION_* bits. The VF will need to
890  * interpret these fields. See the definition of the
891  * VIRTCHNL_VLAN_TAG_LOCATION_* bits above the virtchnl_vlan_support
892  * enumeration.
893  */
894 struct virtchnl_vlan_offload_caps {
895         struct virtchnl_vlan_supported_caps stripping_support;
896         struct virtchnl_vlan_supported_caps insertion_support;
897         u32 ethertype_init;
898         u8 ethertype_match;
899         u8 pad[3];
900 };
901
902 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_vlan_offload_caps);
903
904 /* VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS
905  * VF sends this message to determine its VLAN capabilities.
906  *
907  * PF will mark which capabilities it supports based on hardware support and
908  * current configuration. For example, if a port VLAN is configured the PF will
909  * not allow outer VLAN filtering, stripping, or insertion to be configured so
910  * it will block these features from the VF.
911  *
912  * The VF will need to cross reference its capabilities with the PFs
913  * capabilities in the response message from the PF to determine the VLAN
914  * support.
915  */
916 struct virtchnl_vlan_caps {
917         struct virtchnl_vlan_filtering_caps filtering;
918         struct virtchnl_vlan_offload_caps offloads;
919 };
920
921 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_vlan_caps);
922
923 struct virtchnl_vlan {
924         u16 tci;        /* tci[15:13] = PCP and tci[11:0] = VID */
925         u16 tci_mask;   /* only valid if VIRTCHNL_VLAN_FILTER_MASK set in
926                          * filtering caps
927                          */
928         u16 tpid;       /* 0x8100, 0x88a8, etc. and only type(s) set in
929                          * filtering caps. Note that tpid here does not refer to
930                          * VIRTCHNL_VLAN_ETHERTYPE_*, but it refers to the
931                          * actual 2-byte VLAN TPID
932                          */
933         u8 pad[2];
934 };
935
936 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_vlan);
937
938 struct virtchnl_vlan_filter {
939         struct virtchnl_vlan inner;
940         struct virtchnl_vlan outer;
941         u8 pad[16];
942 };
943
944 VIRTCHNL_CHECK_STRUCT_LEN(32, virtchnl_vlan_filter);
945
946 /* VIRTCHNL_OP_ADD_VLAN_V2
947  * VIRTCHNL_OP_DEL_VLAN_V2
948  *
949  * VF sends these messages to add/del one or more VLAN tag filters for Rx
950  * traffic.
951  *
952  * The PF attempts to add the filters and returns status.
953  *
954  * The VF should only ever attempt to add/del virtchnl_vlan_filter(s) using the
955  * supported fields negotiated via VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS.
956  */
957 struct virtchnl_vlan_filter_list_v2 {
958         u16 vport_id;
959         u16 num_elements;
960         u8 pad[4];
961         struct virtchnl_vlan_filter filters[1];
962 };
963
964 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_vlan_filter_list_v2);
965
966 /* VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2
967  * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2
968  * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2
969  * VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2
970  *
971  * VF sends this message to enable or disable VLAN stripping or insertion. It
972  * also needs to specify an ethertype. The VF knows which VLAN ethertypes are
973  * allowed and whether or not it's allowed to enable/disable the specific
974  * offload via the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS message. The VF needs to
975  * parse the virtchnl_vlan_caps.offloads fields to determine which offload
976  * messages are allowed.
977  *
978  * For example, if the PF populates the virtchnl_vlan_caps.offloads in the
979  * following manner the VF will be allowed to enable and/or disable 0x8100 inner
980  * VLAN insertion and/or stripping via the opcodes listed above. Inner in this
981  * case means the outer most or single VLAN from the VF's perspective. This is
982  * because no outer offloads are supported. See the comments above the
983  * virtchnl_vlan_supported_caps structure for more details.
984  *
985  * virtchnl_vlan_caps.offloads.stripping_support.inner =
986  *                      VIRTCHNL_VLAN_TOGGLE |
987  *                      VIRTCHNL_VLAN_ETHERTYPE_8100;
988  *
989  * virtchnl_vlan_caps.offloads.insertion_support.inner =
990  *                      VIRTCHNL_VLAN_TOGGLE |
991  *                      VIRTCHNL_VLAN_ETHERTYPE_8100;
992  *
993  * In order to enable inner (again note that in this case inner is the outer
994  * most or single VLAN from the VF's perspective) VLAN stripping for 0x8100
995  * VLANs, the VF would populate the virtchnl_vlan_setting structure in the
996  * following manner and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message.
997  *
998  * virtchnl_vlan_setting.inner_ethertype_setting =
999  *                      VIRTCHNL_VLAN_ETHERTYPE_8100;
1000  *
1001  * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
1002  * initialization.
1003  *
1004  * The reason that VLAN TPID(s) are not being used for the
1005  * outer_ethertype_setting and inner_ethertype_setting fields is because it's
1006  * possible a device could support VLAN insertion and/or stripping offload on
1007  * multiple ethertypes concurrently, so this method allows a VF to request
1008  * multiple ethertypes in one message using the virtchnl_vlan_support
1009  * enumeration.
1010  *
1011  * For example, if the PF populates the virtchnl_vlan_caps.offloads in the
1012  * following manner the VF will be allowed to enable 0x8100 and 0x88a8 outer
1013  * VLAN insertion and stripping simultaneously. The
1014  * virtchnl_vlan_caps.offloads.ethertype_match field will also have to be
1015  * populated based on what the PF can support.
1016  *
1017  * virtchnl_vlan_caps.offloads.stripping_support.outer =
1018  *                      VIRTCHNL_VLAN_TOGGLE |
1019  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1020  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1021  *                      VIRTCHNL_VLAN_ETHERTYPE_AND;
1022  *
1023  * virtchnl_vlan_caps.offloads.insertion_support.outer =
1024  *                      VIRTCHNL_VLAN_TOGGLE |
1025  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1026  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1027  *                      VIRTCHNL_VLAN_ETHERTYPE_AND;
1028  *
1029  * In order to enable outer VLAN stripping for 0x8100 and 0x88a8 VLANs, the VF
1030  * would populate the virthcnl_vlan_offload_structure in the following manner
1031  * and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message.
1032  *
1033  * virtchnl_vlan_setting.outer_ethertype_setting =
1034  *                      VIRTHCNL_VLAN_ETHERTYPE_8100 |
1035  *                      VIRTHCNL_VLAN_ETHERTYPE_88A8;
1036  *
1037  * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
1038  * initialization.
1039  *
1040  * There is also the case where a PF and the underlying hardware can support
1041  * VLAN offloads on multiple ethertypes, but not concurrently. For example, if
1042  * the PF populates the virtchnl_vlan_caps.offloads in the following manner the
1043  * VF will be allowed to enable and/or disable 0x8100 XOR 0x88a8 outer VLAN
1044  * offloads. The ethertypes must match for stripping and insertion.
1045  *
1046  * virtchnl_vlan_caps.offloads.stripping_support.outer =
1047  *                      VIRTCHNL_VLAN_TOGGLE |
1048  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1049  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1050  *                      VIRTCHNL_VLAN_ETHERTYPE_XOR;
1051  *
1052  * virtchnl_vlan_caps.offloads.insertion_support.outer =
1053  *                      VIRTCHNL_VLAN_TOGGLE |
1054  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1055  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1056  *                      VIRTCHNL_VLAN_ETHERTYPE_XOR;
1057  *
1058  * virtchnl_vlan_caps.offloads.ethertype_match =
1059  *                      VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION;
1060  *
1061  * In order to enable outer VLAN stripping for 0x88a8 VLANs, the VF would
1062  * populate the virtchnl_vlan_setting structure in the following manner and send
1063  * the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2. Also, this will change the
1064  * ethertype for VLAN insertion if it's enabled. So, for completeness, a
1065  * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 with the same ethertype should be sent.
1066  *
1067  * virtchnl_vlan_setting.outer_ethertype_setting = VIRTHCNL_VLAN_ETHERTYPE_88A8;
1068  *
1069  * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
1070  * initialization.
1071  *
1072  * VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2
1073  * VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2
1074  *
1075  * VF sends this message to enable or disable VLAN filtering. It also needs to
1076  * specify an ethertype. The VF knows which VLAN ethertypes are allowed and
1077  * whether or not it's allowed to enable/disable filtering via the
1078  * VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS message. The VF needs to
1079  * parse the virtchnl_vlan_caps.filtering fields to determine which, if any,
1080  * filtering messages are allowed.
1081  *
1082  * For example, if the PF populates the virtchnl_vlan_caps.filtering in the
1083  * following manner the VF will be allowed to enable/disable 0x8100 and 0x88a8
1084  * outer VLAN filtering together. Note, that the VIRTCHNL_VLAN_ETHERTYPE_AND
1085  * means that all filtering ethertypes will to be enabled and disabled together
1086  * regardless of the request from the VF. This means that the underlying
1087  * hardware only supports VLAN filtering for all VLAN the specified ethertypes
1088  * or none of them.
1089  *
1090  * virtchnl_vlan_caps.filtering.filtering_support.outer =
1091  *                      VIRTCHNL_VLAN_TOGGLE |
1092  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1093  *                      VIRTHCNL_VLAN_ETHERTYPE_88A8 |
1094  *                      VIRTCHNL_VLAN_ETHERTYPE_9100 |
1095  *                      VIRTCHNL_VLAN_ETHERTYPE_AND;
1096  *
1097  * In order to enable outer VLAN filtering for 0x88a8 and 0x8100 VLANs (0x9100
1098  * VLANs aren't supported by the VF driver), the VF would populate the
1099  * virtchnl_vlan_setting structure in the following manner and send the
1100  * VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2. The same message format would be used
1101  * to disable outer VLAN filtering for 0x88a8 and 0x8100 VLANs, but the
1102  * VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2 opcode is used.
1103  *
1104  * virtchnl_vlan_setting.outer_ethertype_setting =
1105  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1106  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8;
1107  *
1108  */
1109 struct virtchnl_vlan_setting {
1110         u32 outer_ethertype_setting;
1111         u32 inner_ethertype_setting;
1112         u16 vport_id;
1113         u8 pad[6];
1114 };
1115
1116 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vlan_setting);
1117
1118 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
1119  * VF sends VSI id and flags.
1120  * PF returns status code in retval.
1121  * Note: we assume that broadcast accept mode is always enabled.
1122  */
1123 struct virtchnl_promisc_info {
1124         u16 vsi_id;
1125         u16 flags;
1126 };
1127
1128 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info);
1129
1130 #define FLAG_VF_UNICAST_PROMISC 0x00000001
1131 #define FLAG_VF_MULTICAST_PROMISC       0x00000002
1132
1133 /* VIRTCHNL_OP_GET_STATS
1134  * VF sends this message to request stats for the selected VSI. VF uses
1135  * the virtchnl_queue_select struct to specify the VSI. The queue_id
1136  * field is ignored by the PF.
1137  *
1138  * PF replies with struct virtchnl_eth_stats in an external buffer.
1139  */
1140
1141 struct virtchnl_eth_stats {
1142         u64 rx_bytes;                   /* received bytes */
1143         u64 rx_unicast;                 /* received unicast pkts */
1144         u64 rx_multicast;               /* received multicast pkts */
1145         u64 rx_broadcast;               /* received broadcast pkts */
1146         u64 rx_discards;
1147         u64 rx_unknown_protocol;
1148         u64 tx_bytes;                   /* transmitted bytes */
1149         u64 tx_unicast;                 /* transmitted unicast pkts */
1150         u64 tx_multicast;               /* transmitted multicast pkts */
1151         u64 tx_broadcast;               /* transmitted broadcast pkts */
1152         u64 tx_discards;
1153         u64 tx_errors;
1154 };
1155
1156 /* VIRTCHNL_OP_CONFIG_RSS_KEY
1157  * VIRTCHNL_OP_CONFIG_RSS_LUT
1158  * VF sends these messages to configure RSS. Only supported if both PF
1159  * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
1160  * configuration negotiation. If this is the case, then the RSS fields in
1161  * the VF resource struct are valid.
1162  * Both the key and LUT are initialized to 0 by the PF, meaning that
1163  * RSS is effectively disabled until set up by the VF.
1164  */
1165 struct virtchnl_rss_key {
1166         u16 vsi_id;
1167         u16 key_len;
1168         u8 key[1];         /* RSS hash key, packed bytes */
1169 };
1170
1171 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key);
1172
1173 struct virtchnl_rss_lut {
1174         u16 vsi_id;
1175         u16 lut_entries;
1176         u8 lut[1];        /* RSS lookup table */
1177 };
1178
1179 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut);
1180
1181 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS
1182  * VIRTCHNL_OP_SET_RSS_HENA
1183  * VF sends these messages to get and set the hash filter enable bits for RSS.
1184  * By default, the PF sets these to all possible traffic types that the
1185  * hardware supports. The VF can query this value if it wants to change the
1186  * traffic types that are hashed by the hardware.
1187  */
1188 struct virtchnl_rss_hena {
1189         u64 hena;
1190 };
1191
1192 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena);
1193
1194 /* Type of RSS algorithm */
1195 enum virtchnl_rss_algorithm {
1196         VIRTCHNL_RSS_ALG_TOEPLITZ_ASYMMETRIC    = 0,
1197         VIRTCHNL_RSS_ALG_XOR_ASYMMETRIC         = 1,
1198         VIRTCHNL_RSS_ALG_TOEPLITZ_SYMMETRIC     = 2,
1199         VIRTCHNL_RSS_ALG_XOR_SYMMETRIC          = 3,
1200 };
1201
1202 /* This is used by PF driver to enforce how many channels can be supported.
1203  * When ADQ_V2 capability is negotiated, it will allow 16 channels otherwise
1204  * PF driver will allow only max 4 channels
1205  */
1206 #define VIRTCHNL_MAX_ADQ_CHANNELS 4
1207 #define VIRTCHNL_MAX_ADQ_V2_CHANNELS 16
1208
1209 /* VIRTCHNL_OP_ENABLE_CHANNELS
1210  * VIRTCHNL_OP_DISABLE_CHANNELS
1211  * VF sends these messages to enable or disable channels based on
1212  * the user specified queue count and queue offset for each traffic class.
1213  * This struct encompasses all the information that the PF needs from
1214  * VF to create a channel.
1215  */
1216 struct virtchnl_channel_info {
1217         u16 count; /* number of queues in a channel */
1218         u16 offset; /* queues in a channel start from 'offset' */
1219         u32 pad;
1220         u64 max_tx_rate;
1221 };
1222
1223 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info);
1224
1225 struct virtchnl_tc_info {
1226         u32     num_tc;
1227         u32     pad;
1228         struct  virtchnl_channel_info list[1];
1229 };
1230
1231 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info);
1232
1233 /* VIRTCHNL_ADD_CLOUD_FILTER
1234  * VIRTCHNL_DEL_CLOUD_FILTER
1235  * VF sends these messages to add or delete a cloud filter based on the
1236  * user specified match and action filters. These structures encompass
1237  * all the information that the PF needs from the VF to add/delete a
1238  * cloud filter.
1239  */
1240
1241 struct virtchnl_l4_spec {
1242         u8      src_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
1243         u8      dst_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
1244         /* vlan_prio is part of this 16 bit field even from OS perspective
1245          * vlan_id:12 is actual vlan_id, then vlanid:bit14..12 is vlan_prio
1246          * in future, when decided to offload vlan_prio, pass that information
1247          * as part of the "vlan_id" field, Bit14..12
1248          */
1249         __be16  vlan_id;
1250         __be16  pad; /* reserved for future use */
1251         __be32  src_ip[4];
1252         __be32  dst_ip[4];
1253         __be16  src_port;
1254         __be16  dst_port;
1255 };
1256
1257 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec);
1258
1259 union virtchnl_flow_spec {
1260         struct  virtchnl_l4_spec tcp_spec;
1261         u8      buffer[128]; /* reserved for future use */
1262 };
1263
1264 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec);
1265
1266 enum virtchnl_action {
1267         /* action types */
1268         VIRTCHNL_ACTION_DROP = 0,
1269         VIRTCHNL_ACTION_TC_REDIRECT,
1270         VIRTCHNL_ACTION_PASSTHRU,
1271         VIRTCHNL_ACTION_QUEUE,
1272         VIRTCHNL_ACTION_Q_REGION,
1273         VIRTCHNL_ACTION_MARK,
1274         VIRTCHNL_ACTION_COUNT,
1275 };
1276
1277 enum virtchnl_flow_type {
1278         /* flow types */
1279         VIRTCHNL_TCP_V4_FLOW = 0,
1280         VIRTCHNL_TCP_V6_FLOW,
1281         VIRTCHNL_UDP_V4_FLOW,
1282         VIRTCHNL_UDP_V6_FLOW,
1283 };
1284
1285 struct virtchnl_filter {
1286         union   virtchnl_flow_spec data;
1287         union   virtchnl_flow_spec mask;
1288
1289         /* see enum virtchnl_flow_type */
1290         s32     flow_type;
1291
1292         /* see enum virtchnl_action */
1293         s32     action;
1294         u32     action_meta;
1295         u8      field_flags;
1296 };
1297
1298 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter);
1299
1300 struct virtchnl_shaper_bw {
1301         /* Unit is Kbps */
1302         u32 committed;
1303         u32 peak;
1304 };
1305
1306 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_shaper_bw);
1307
1308 /* VIRTCHNL_OP_DCF_GET_VSI_MAP
1309  * VF sends this message to get VSI mapping table.
1310  * PF responds with an indirect message containing VF's
1311  * HW VSI IDs.
1312  * The index of vf_vsi array is the logical VF ID, the
1313  * value of vf_vsi array is the VF's HW VSI ID with its
1314  * valid configuration.
1315  */
1316 struct virtchnl_dcf_vsi_map {
1317         u16 pf_vsi;     /* PF's HW VSI ID */
1318         u16 num_vfs;    /* The actual number of VFs allocated */
1319 #define VIRTCHNL_DCF_VF_VSI_ID_S        0
1320 #define VIRTCHNL_DCF_VF_VSI_ID_M        (0xFFF << VIRTCHNL_DCF_VF_VSI_ID_S)
1321 #define VIRTCHNL_DCF_VF_VSI_VALID       BIT(15)
1322         u16 vf_vsi[1];
1323 };
1324
1325 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_dcf_vsi_map);
1326
1327 #define PKG_NAME_SIZE   32
1328 #define DSN_SIZE        8
1329
1330 struct pkg_version {
1331         u8 major;
1332         u8 minor;
1333         u8 update;
1334         u8 draft;
1335 };
1336
1337 VIRTCHNL_CHECK_STRUCT_LEN(4, pkg_version);
1338
1339 struct virtchnl_pkg_info {
1340         struct pkg_version pkg_ver;
1341         u32 track_id;
1342         char pkg_name[PKG_NAME_SIZE];
1343         u8 dsn[DSN_SIZE];
1344 };
1345
1346 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_pkg_info);
1347
1348 /* VIRTCHNL_OP_DCF_VLAN_OFFLOAD
1349  * DCF negotiates the VIRTCHNL_VF_OFFLOAD_VLAN_V2 capability firstly to get
1350  * the double VLAN configuration, then DCF sends this message to configure the
1351  * outer or inner VLAN offloads (insertion and strip) for the target VF.
1352  */
1353 struct virtchnl_dcf_vlan_offload {
1354         u16 vf_id;
1355         u16 tpid;
1356         u16 vlan_flags;
1357 #define VIRTCHNL_DCF_VLAN_TYPE_S                0
1358 #define VIRTCHNL_DCF_VLAN_TYPE_M                \
1359                         (0x1 << VIRTCHNL_DCF_VLAN_TYPE_S)
1360 #define VIRTCHNL_DCF_VLAN_TYPE_INNER            0x0
1361 #define VIRTCHNL_DCF_VLAN_TYPE_OUTER            0x1
1362 #define VIRTCHNL_DCF_VLAN_INSERT_MODE_S         1
1363 #define VIRTCHNL_DCF_VLAN_INSERT_MODE_M \
1364                         (0x7 << VIRTCHNL_DCF_VLAN_INSERT_MODE_S)
1365 #define VIRTCHNL_DCF_VLAN_INSERT_DISABLE        0x1
1366 #define VIRTCHNL_DCF_VLAN_INSERT_PORT_BASED     0x2
1367 #define VIRTCHNL_DCF_VLAN_INSERT_VIA_TX_DESC    0x3
1368 #define VIRTCHNL_DCF_VLAN_STRIP_MODE_S          4
1369 #define VIRTCHNL_DCF_VLAN_STRIP_MODE_M          \
1370                         (0x7 << VIRTCHNL_DCF_VLAN_STRIP_MODE_S)
1371 #define VIRTCHNL_DCF_VLAN_STRIP_DISABLE         0x1
1372 #define VIRTCHNL_DCF_VLAN_STRIP_ONLY            0x2
1373 #define VIRTCHNL_DCF_VLAN_STRIP_INTO_RX_DESC    0x3
1374         u16 vlan_id;
1375         u16 pad[4];
1376 };
1377
1378 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_dcf_vlan_offload);
1379
1380 struct virtchnl_dcf_bw_cfg {
1381         u8 tc_num;
1382 #define VIRTCHNL_DCF_BW_CIR             BIT(0)
1383 #define VIRTCHNL_DCF_BW_PIR             BIT(1)
1384         u8 bw_type;
1385         u8 pad[2];
1386         enum virtchnl_bw_limit_type type;
1387         union {
1388                 struct virtchnl_shaper_bw shaper;
1389                 u8 pad2[32];
1390         };
1391 };
1392
1393 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_dcf_bw_cfg);
1394
1395 /* VIRTCHNL_OP_DCF_CONFIG_BW
1396  * VF send this message to set the bandwidth configuration of each
1397  * TC with a specific vf id. The flag node_type is to indicate that
1398  * this message is to configure VSI node or TC node bandwidth.
1399  */
1400 struct virtchnl_dcf_bw_cfg_list {
1401         u16 vf_id;
1402         u8 num_elem;
1403 #define VIRTCHNL_DCF_TARGET_TC_BW       0
1404 #define VIRTCHNL_DCF_TARGET_VF_BW       1
1405         u8 node_type;
1406         struct virtchnl_dcf_bw_cfg cfg[1];
1407 };
1408
1409 VIRTCHNL_CHECK_STRUCT_LEN(44, virtchnl_dcf_bw_cfg_list);
1410
1411 struct virtchnl_supported_rxdids {
1412         /* see enum virtchnl_rx_desc_id_bitmasks */
1413         u64 supported_rxdids;
1414 };
1415
1416 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_supported_rxdids);
1417
1418 /* VIRTCHNL_OP_EVENT
1419  * PF sends this message to inform the VF driver of events that may affect it.
1420  * No direct response is expected from the VF, though it may generate other
1421  * messages in response to this one.
1422  */
1423 enum virtchnl_event_codes {
1424         VIRTCHNL_EVENT_UNKNOWN = 0,
1425         VIRTCHNL_EVENT_LINK_CHANGE,
1426         VIRTCHNL_EVENT_RESET_IMPENDING,
1427         VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
1428         VIRTCHNL_EVENT_DCF_VSI_MAP_UPDATE,
1429 };
1430
1431 #define PF_EVENT_SEVERITY_INFO          0
1432 #define PF_EVENT_SEVERITY_ATTENTION     1
1433 #define PF_EVENT_SEVERITY_ACTION_REQUIRED       2
1434 #define PF_EVENT_SEVERITY_CERTAIN_DOOM  255
1435
1436 struct virtchnl_pf_event {
1437         /* see enum virtchnl_event_codes */
1438         s32 event;
1439         union {
1440                 /* If the PF driver does not support the new speed reporting
1441                  * capabilities then use link_event else use link_event_adv to
1442                  * get the speed and link information. The ability to understand
1443                  * new speeds is indicated by setting the capability flag
1444                  * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter
1445                  * in virtchnl_vf_resource struct and can be used to determine
1446                  * which link event struct to use below.
1447                  */
1448                 struct {
1449                         enum virtchnl_link_speed link_speed;
1450                         u8 link_status;
1451                 } link_event;
1452                 struct {
1453                         /* link_speed provided in Mbps */
1454                         u32 link_speed;
1455                         u8 link_status;
1456                 } link_event_adv;
1457                 struct {
1458                         u16 vf_id;
1459                         u16 vsi_id;
1460                 } vf_vsi_map;
1461         } event_data;
1462
1463         int severity;
1464 };
1465
1466 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event);
1467
1468
1469 /* VF reset states - these are written into the RSTAT register:
1470  * VFGEN_RSTAT on the VF
1471  * When the PF initiates a reset, it writes 0
1472  * When the reset is complete, it writes 1
1473  * When the PF detects that the VF has recovered, it writes 2
1474  * VF checks this register periodically to determine if a reset has occurred,
1475  * then polls it to know when the reset is complete.
1476  * If either the PF or VF reads the register while the hardware
1477  * is in a reset state, it will return DEADBEEF, which, when masked
1478  * will result in 3.
1479  */
1480 enum virtchnl_vfr_states {
1481         VIRTCHNL_VFR_INPROGRESS = 0,
1482         VIRTCHNL_VFR_COMPLETED,
1483         VIRTCHNL_VFR_VFACTIVE,
1484 };
1485
1486 #define VIRTCHNL_MAX_NUM_PROTO_HDRS     32
1487 #define PROTO_HDR_SHIFT                 5
1488 #define PROTO_HDR_FIELD_START(proto_hdr_type) \
1489                                         (proto_hdr_type << PROTO_HDR_SHIFT)
1490 #define PROTO_HDR_FIELD_MASK ((1UL << PROTO_HDR_SHIFT) - 1)
1491
1492 /* VF use these macros to configure each protocol header.
1493  * Specify which protocol headers and protocol header fields base on
1494  * virtchnl_proto_hdr_type and virtchnl_proto_hdr_field.
1495  * @param hdr: a struct of virtchnl_proto_hdr
1496  * @param hdr_type: ETH/IPV4/TCP, etc
1497  * @param field: SRC/DST/TEID/SPI, etc
1498  */
1499 #define VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, field) \
1500         ((hdr)->field_selector |= BIT((field) & PROTO_HDR_FIELD_MASK))
1501 #define VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, field) \
1502         ((hdr)->field_selector &= ~BIT((field) & PROTO_HDR_FIELD_MASK))
1503 #define VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val) \
1504         ((hdr)->field_selector & BIT((val) & PROTO_HDR_FIELD_MASK))
1505 #define VIRTCHNL_GET_PROTO_HDR_FIELD(hdr)       ((hdr)->field_selector)
1506
1507 #define VIRTCHNL_ADD_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
1508         (VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, \
1509                 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
1510 #define VIRTCHNL_DEL_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
1511         (VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, \
1512                 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
1513
1514 #define VIRTCHNL_SET_PROTO_HDR_TYPE(hdr, hdr_type) \
1515         ((hdr)->type = VIRTCHNL_PROTO_HDR_ ## hdr_type)
1516 #define VIRTCHNL_GET_PROTO_HDR_TYPE(hdr) \
1517         (((hdr)->type) >> PROTO_HDR_SHIFT)
1518 #define VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) \
1519         ((hdr)->type == ((val) >> PROTO_HDR_SHIFT))
1520 #define VIRTCHNL_TEST_PROTO_HDR(hdr, val) \
1521         (VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) && \
1522          VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val))
1523
1524 /* Protocol header type within a packet segment. A segment consists of one or
1525  * more protocol headers that make up a logical group of protocol headers. Each
1526  * logical group of protocol headers encapsulates or is encapsulated using/by
1527  * tunneling or encapsulation protocols for network virtualization.
1528  */
1529 enum virtchnl_proto_hdr_type {
1530         VIRTCHNL_PROTO_HDR_NONE,
1531         VIRTCHNL_PROTO_HDR_ETH,
1532         VIRTCHNL_PROTO_HDR_S_VLAN,
1533         VIRTCHNL_PROTO_HDR_C_VLAN,
1534         VIRTCHNL_PROTO_HDR_IPV4,
1535         VIRTCHNL_PROTO_HDR_IPV6,
1536         VIRTCHNL_PROTO_HDR_TCP,
1537         VIRTCHNL_PROTO_HDR_UDP,
1538         VIRTCHNL_PROTO_HDR_SCTP,
1539         VIRTCHNL_PROTO_HDR_GTPU_IP,
1540         VIRTCHNL_PROTO_HDR_GTPU_EH,
1541         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_DWN,
1542         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_UP,
1543         VIRTCHNL_PROTO_HDR_PPPOE,
1544         VIRTCHNL_PROTO_HDR_L2TPV3,
1545         VIRTCHNL_PROTO_HDR_ESP,
1546         VIRTCHNL_PROTO_HDR_AH,
1547         VIRTCHNL_PROTO_HDR_PFCP,
1548         VIRTCHNL_PROTO_HDR_GTPC,
1549         VIRTCHNL_PROTO_HDR_ECPRI,
1550         VIRTCHNL_PROTO_HDR_L2TPV2,
1551         VIRTCHNL_PROTO_HDR_PPP,
1552         /* IPv4 and IPv6 Fragment header types are only associated to
1553          * VIRTCHNL_PROTO_HDR_IPV4 and VIRTCHNL_PROTO_HDR_IPV6 respectively,
1554          * cannot be used independently.
1555          */
1556         VIRTCHNL_PROTO_HDR_IPV4_FRAG,
1557         VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG,
1558         VIRTCHNL_PROTO_HDR_GRE,
1559 };
1560
1561 /* Protocol header field within a protocol header. */
1562 enum virtchnl_proto_hdr_field {
1563         /* ETHER */
1564         VIRTCHNL_PROTO_HDR_ETH_SRC =
1565                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ETH),
1566         VIRTCHNL_PROTO_HDR_ETH_DST,
1567         VIRTCHNL_PROTO_HDR_ETH_ETHERTYPE,
1568         /* S-VLAN */
1569         VIRTCHNL_PROTO_HDR_S_VLAN_ID =
1570                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_S_VLAN),
1571         /* C-VLAN */
1572         VIRTCHNL_PROTO_HDR_C_VLAN_ID =
1573                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_C_VLAN),
1574         /* IPV4 */
1575         VIRTCHNL_PROTO_HDR_IPV4_SRC =
1576                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4),
1577         VIRTCHNL_PROTO_HDR_IPV4_DST,
1578         VIRTCHNL_PROTO_HDR_IPV4_DSCP,
1579         VIRTCHNL_PROTO_HDR_IPV4_TTL,
1580         VIRTCHNL_PROTO_HDR_IPV4_PROT,
1581         VIRTCHNL_PROTO_HDR_IPV4_CHKSUM,
1582         /* IPV6 */
1583         VIRTCHNL_PROTO_HDR_IPV6_SRC =
1584                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6),
1585         VIRTCHNL_PROTO_HDR_IPV6_DST,
1586         VIRTCHNL_PROTO_HDR_IPV6_TC,
1587         VIRTCHNL_PROTO_HDR_IPV6_HOP_LIMIT,
1588         VIRTCHNL_PROTO_HDR_IPV6_PROT,
1589         /* IPV6 Prefix */
1590         VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_SRC,
1591         VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_DST,
1592         VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_SRC,
1593         VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_DST,
1594         VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_SRC,
1595         VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_DST,
1596         VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_SRC,
1597         VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_DST,
1598         VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_SRC,
1599         VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_DST,
1600         VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_SRC,
1601         VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_DST,
1602         /* TCP */
1603         VIRTCHNL_PROTO_HDR_TCP_SRC_PORT =
1604                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_TCP),
1605         VIRTCHNL_PROTO_HDR_TCP_DST_PORT,
1606         VIRTCHNL_PROTO_HDR_TCP_CHKSUM,
1607         /* UDP */
1608         VIRTCHNL_PROTO_HDR_UDP_SRC_PORT =
1609                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_UDP),
1610         VIRTCHNL_PROTO_HDR_UDP_DST_PORT,
1611         VIRTCHNL_PROTO_HDR_UDP_CHKSUM,
1612         /* SCTP */
1613         VIRTCHNL_PROTO_HDR_SCTP_SRC_PORT =
1614                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_SCTP),
1615         VIRTCHNL_PROTO_HDR_SCTP_DST_PORT,
1616         VIRTCHNL_PROTO_HDR_SCTP_CHKSUM,
1617         /* GTPU_IP */
1618         VIRTCHNL_PROTO_HDR_GTPU_IP_TEID =
1619                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_IP),
1620         /* GTPU_EH */
1621         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU =
1622                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_EH),
1623         VIRTCHNL_PROTO_HDR_GTPU_EH_QFI,
1624         /* PPPOE */
1625         VIRTCHNL_PROTO_HDR_PPPOE_SESS_ID =
1626                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PPPOE),
1627         /* L2TPV3 */
1628         VIRTCHNL_PROTO_HDR_L2TPV3_SESS_ID =
1629                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_L2TPV3),
1630         /* ESP */
1631         VIRTCHNL_PROTO_HDR_ESP_SPI =
1632                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ESP),
1633         /* AH */
1634         VIRTCHNL_PROTO_HDR_AH_SPI =
1635                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_AH),
1636         /* PFCP */
1637         VIRTCHNL_PROTO_HDR_PFCP_S_FIELD =
1638                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PFCP),
1639         VIRTCHNL_PROTO_HDR_PFCP_SEID,
1640         /* GTPC */
1641         VIRTCHNL_PROTO_HDR_GTPC_TEID =
1642                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPC),
1643         /* ECPRI */
1644         VIRTCHNL_PROTO_HDR_ECPRI_MSG_TYPE =
1645                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ECPRI),
1646         VIRTCHNL_PROTO_HDR_ECPRI_PC_RTC_ID,
1647         /* IPv4 Dummy Fragment */
1648         VIRTCHNL_PROTO_HDR_IPV4_FRAG_PKID =
1649                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4_FRAG),
1650         /* IPv6 Extension Fragment */
1651         VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG_PKID =
1652                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG),
1653         /* GTPU_DWN/UP */
1654         VIRTCHNL_PROTO_HDR_GTPU_DWN_QFI =
1655                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_DWN),
1656         VIRTCHNL_PROTO_HDR_GTPU_UP_QFI =
1657                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_UP),
1658         /* L2TPv2 */
1659         VIRTCHNL_PROTO_HDR_L2TPV2_SESS_ID =
1660                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_L2TPV2),
1661         VIRTCHNL_PROTO_HDR_L2TPV2_LEN_SESS_ID,
1662 };
1663
1664 struct virtchnl_proto_hdr {
1665         /* see enum virtchnl_proto_hdr_type */
1666         s32 type;
1667         u32 field_selector; /* a bit mask to select field for header type */
1668         u8 buffer[64];
1669         /**
1670          * binary buffer in network order for specific header type.
1671          * For example, if type = VIRTCHNL_PROTO_HDR_IPV4, a IPv4
1672          * header is expected to be copied into the buffer.
1673          */
1674 };
1675
1676 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_proto_hdr);
1677
1678 struct virtchnl_proto_hdrs {
1679         u8 tunnel_level;
1680         /**
1681          * specify where protocol header start from.
1682          * 0 - from the outer layer
1683          * 1 - from the first inner layer
1684          * 2 - from the second inner layer
1685          * ....
1686          **/
1687         int count; /* the proto layers must < VIRTCHNL_MAX_NUM_PROTO_HDRS */
1688         struct virtchnl_proto_hdr proto_hdr[VIRTCHNL_MAX_NUM_PROTO_HDRS];
1689 };
1690
1691 VIRTCHNL_CHECK_STRUCT_LEN(2312, virtchnl_proto_hdrs);
1692
1693 struct virtchnl_rss_cfg {
1694         struct virtchnl_proto_hdrs proto_hdrs;     /* protocol headers */
1695
1696         /* see enum virtchnl_rss_algorithm; rss algorithm type */
1697         s32 rss_algorithm;
1698         u8 reserved[128];                          /* reserve for future */
1699 };
1700
1701 VIRTCHNL_CHECK_STRUCT_LEN(2444, virtchnl_rss_cfg);
1702
1703 /* action configuration for FDIR */
1704 struct virtchnl_filter_action {
1705         /* see enum virtchnl_action type */
1706         s32 type;
1707         union {
1708                 /* used for queue and qgroup action */
1709                 struct {
1710                         u16 index;
1711                         u8 region;
1712                 } queue;
1713                 /* used for count action */
1714                 struct {
1715                         /* share counter ID with other flow rules */
1716                         u8 shared;
1717                         u32 id; /* counter ID */
1718                 } count;
1719                 /* used for mark action */
1720                 u32 mark_id;
1721                 u8 reserve[32];
1722         } act_conf;
1723 };
1724
1725 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_filter_action);
1726
1727 #define VIRTCHNL_MAX_NUM_ACTIONS  8
1728
1729 struct virtchnl_filter_action_set {
1730         /* action number must be less then VIRTCHNL_MAX_NUM_ACTIONS */
1731         int count;
1732         struct virtchnl_filter_action actions[VIRTCHNL_MAX_NUM_ACTIONS];
1733 };
1734
1735 VIRTCHNL_CHECK_STRUCT_LEN(292, virtchnl_filter_action_set);
1736
1737 /* pattern and action for FDIR rule */
1738 struct virtchnl_fdir_rule {
1739         struct virtchnl_proto_hdrs proto_hdrs;
1740         struct virtchnl_filter_action_set action_set;
1741 };
1742
1743 VIRTCHNL_CHECK_STRUCT_LEN(2604, virtchnl_fdir_rule);
1744
1745 /* Status returned to VF after VF requests FDIR commands
1746  * VIRTCHNL_FDIR_SUCCESS
1747  * VF FDIR related request is successfully done by PF
1748  * The request can be OP_ADD/DEL/QUERY_FDIR_FILTER.
1749  *
1750  * VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE
1751  * OP_ADD_FDIR_FILTER request is failed due to no Hardware resource.
1752  *
1753  * VIRTCHNL_FDIR_FAILURE_RULE_EXIST
1754  * OP_ADD_FDIR_FILTER request is failed due to the rule is already existed.
1755  *
1756  * VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT
1757  * OP_ADD_FDIR_FILTER request is failed due to conflict with existing rule.
1758  *
1759  * VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST
1760  * OP_DEL_FDIR_FILTER request is failed due to this rule doesn't exist.
1761  *
1762  * VIRTCHNL_FDIR_FAILURE_RULE_INVALID
1763  * OP_ADD_FDIR_FILTER request is failed due to parameters validation
1764  * or HW doesn't support.
1765  *
1766  * VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT
1767  * OP_ADD/DEL_FDIR_FILTER request is failed due to timing out
1768  * for programming.
1769  *
1770  * VIRTCHNL_FDIR_FAILURE_QUERY_INVALID
1771  * OP_QUERY_FDIR_FILTER request is failed due to parameters validation,
1772  * for example, VF query counter of a rule who has no counter action.
1773  */
1774 enum virtchnl_fdir_prgm_status {
1775         VIRTCHNL_FDIR_SUCCESS = 0,
1776         VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE,
1777         VIRTCHNL_FDIR_FAILURE_RULE_EXIST,
1778         VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT,
1779         VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST,
1780         VIRTCHNL_FDIR_FAILURE_RULE_INVALID,
1781         VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT,
1782         VIRTCHNL_FDIR_FAILURE_QUERY_INVALID,
1783 };
1784
1785 /* VIRTCHNL_OP_ADD_FDIR_FILTER
1786  * VF sends this request to PF by filling out vsi_id,
1787  * validate_only and rule_cfg. PF will return flow_id
1788  * if the request is successfully done and return add_status to VF.
1789  */
1790 struct virtchnl_fdir_add {
1791         u16 vsi_id;  /* INPUT */
1792         /*
1793          * 1 for validating a fdir rule, 0 for creating a fdir rule.
1794          * Validate and create share one ops: VIRTCHNL_OP_ADD_FDIR_FILTER.
1795          */
1796         u16 validate_only; /* INPUT */
1797         u32 flow_id;       /* OUTPUT */
1798         struct virtchnl_fdir_rule rule_cfg; /* INPUT */
1799
1800         /* see enum virtchnl_fdir_prgm_status; OUTPUT */
1801         s32 status;
1802 };
1803
1804 VIRTCHNL_CHECK_STRUCT_LEN(2616, virtchnl_fdir_add);
1805
1806 /* VIRTCHNL_OP_DEL_FDIR_FILTER
1807  * VF sends this request to PF by filling out vsi_id
1808  * and flow_id. PF will return del_status to VF.
1809  */
1810 struct virtchnl_fdir_del {
1811         u16 vsi_id;  /* INPUT */
1812         u16 pad;
1813         u32 flow_id; /* INPUT */
1814
1815         /* see enum virtchnl_fdir_prgm_status; OUTPUT */
1816         s32 status;
1817 };
1818
1819 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_fdir_del);
1820
1821 /* VIRTCHNL_OP_GET_QOS_CAPS
1822  * VF sends this message to get its QoS Caps, such as
1823  * TC number, Arbiter and Bandwidth.
1824  */
1825 struct virtchnl_qos_cap_elem {
1826         u8 tc_num;
1827         u8 tc_prio;
1828 #define VIRTCHNL_ABITER_STRICT      0
1829 #define VIRTCHNL_ABITER_ETS         2
1830         u8 arbiter;
1831 #define VIRTCHNL_STRICT_WEIGHT      1
1832         u8 weight;
1833         enum virtchnl_bw_limit_type type;
1834         union {
1835                 struct virtchnl_shaper_bw shaper;
1836                 u8 pad2[32];
1837         };
1838 };
1839
1840 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_qos_cap_elem);
1841
1842 struct virtchnl_qos_cap_list {
1843         u16 vsi_id;
1844         u16 num_elem;
1845         struct virtchnl_qos_cap_elem cap[1];
1846 };
1847
1848 VIRTCHNL_CHECK_STRUCT_LEN(44, virtchnl_qos_cap_list);
1849
1850 /* VIRTCHNL_OP_CONFIG_QUEUE_TC_MAP
1851  * VF sends message virtchnl_queue_tc_mapping to set queue to tc
1852  * mapping for all the Tx and Rx queues with a specified VSI, and
1853  * would get response about bitmap of valid user priorities
1854  * associated with queues.
1855  */
1856 struct virtchnl_queue_tc_mapping {
1857         u16 vsi_id;
1858         u16 num_tc;
1859         u16 num_queue_pairs;
1860         u8 pad[2];
1861         union {
1862                 struct {
1863                         u16 start_queue_id;
1864                         u16 queue_count;
1865                 } req;
1866                 struct {
1867 #define VIRTCHNL_USER_PRIO_TYPE_UP      0
1868 #define VIRTCHNL_USER_PRIO_TYPE_DSCP    1
1869                         u16 prio_type;
1870                         u16 valid_prio_bitmap;
1871                 } resp;
1872         } tc[1];
1873 };
1874
1875 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_tc_mapping);
1876
1877 /* VIRTCHNL_OP_CONFIG_QUEUE_BW */
1878 struct virtchnl_queue_bw {
1879         u16 queue_id;
1880         u8 tc;
1881         u8 pad;
1882         struct virtchnl_shaper_bw shaper;
1883 };
1884
1885 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_bw);
1886
1887 struct virtchnl_queues_bw_cfg {
1888         u16 vsi_id;
1889         u16 num_queues;
1890         struct virtchnl_queue_bw cfg[1];
1891 };
1892
1893 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_queues_bw_cfg);
1894
1895 /* TX and RX queue types are valid in legacy as well as split queue models.
1896  * With Split Queue model, 2 additional types are introduced - TX_COMPLETION
1897  * and RX_BUFFER. In split queue model, RX corresponds to the queue where HW
1898  * posts completions.
1899  */
1900 enum virtchnl_queue_type {
1901         VIRTCHNL_QUEUE_TYPE_TX                  = 0,
1902         VIRTCHNL_QUEUE_TYPE_RX                  = 1,
1903         VIRTCHNL_QUEUE_TYPE_TX_COMPLETION       = 2,
1904         VIRTCHNL_QUEUE_TYPE_RX_BUFFER           = 3,
1905         VIRTCHNL_QUEUE_TYPE_CONFIG_TX           = 4,
1906         VIRTCHNL_QUEUE_TYPE_CONFIG_RX           = 5
1907 };
1908
1909
1910 /* structure to specify a chunk of contiguous queues */
1911 struct virtchnl_queue_chunk {
1912         /* see enum virtchnl_queue_type */
1913         s32 type;
1914         u16 start_queue_id;
1915         u16 num_queues;
1916 };
1917
1918 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_queue_chunk);
1919
1920 /* structure to specify several chunks of contiguous queues */
1921 struct virtchnl_queue_chunks {
1922         u16 num_chunks;
1923         u16 rsvd;
1924         struct virtchnl_queue_chunk chunks[1];
1925 };
1926
1927 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_chunks);
1928
1929
1930 /* VIRTCHNL_OP_ENABLE_QUEUES_V2
1931  * VIRTCHNL_OP_DISABLE_QUEUES_V2
1932  * VIRTCHNL_OP_DEL_QUEUES
1933  *
1934  * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1935  * then all of these ops are available.
1936  *
1937  * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1938  * then VIRTCHNL_OP_ENABLE_QUEUES_V2 and VIRTCHNL_OP_DISABLE_QUEUES_V2 are
1939  * available.
1940  *
1941  * PF sends these messages to enable, disable or delete queues specified in
1942  * chunks. PF sends virtchnl_del_ena_dis_queues struct to specify the queues
1943  * to be enabled/disabled/deleted. Also applicable to single queue RX or
1944  * TX. CP performs requested action and returns status.
1945  */
1946 struct virtchnl_del_ena_dis_queues {
1947         u16 vport_id;
1948         u16 pad;
1949         struct virtchnl_queue_chunks chunks;
1950 };
1951
1952 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_del_ena_dis_queues);
1953
1954 /* Virtchannel interrupt throttling rate index */
1955 enum virtchnl_itr_idx {
1956         VIRTCHNL_ITR_IDX_0      = 0,
1957         VIRTCHNL_ITR_IDX_1      = 1,
1958         VIRTCHNL_ITR_IDX_NO_ITR = 3,
1959 };
1960
1961 /* Queue to vector mapping */
1962 struct virtchnl_queue_vector {
1963         u16 queue_id;
1964         u16 vector_id;
1965         u8 pad[4];
1966
1967         /* see enum virtchnl_itr_idx */
1968         s32 itr_idx;
1969
1970         /* see enum virtchnl_queue_type */
1971         s32 queue_type;
1972 };
1973
1974 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_queue_vector);
1975
1976 /* VIRTCHNL_OP_MAP_QUEUE_VECTOR
1977  * VIRTCHNL_OP_UNMAP_QUEUE_VECTOR
1978  *
1979  * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1980  * then all of these ops are available.
1981  *
1982  * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1983  * then only VIRTCHNL_OP_MAP_QUEUE_VECTOR is available.
1984  *
1985  * PF sends this message to map or unmap queues to vectors and ITR index
1986  * registers. External data buffer contains virtchnl_queue_vector_maps structure
1987  * that contains num_qv_maps of virtchnl_queue_vector structures.
1988  * CP maps the requested queue vector maps after validating the queue and vector
1989  * ids and returns a status code.
1990  */
1991 struct virtchnl_queue_vector_maps {
1992         u16 vport_id;
1993         u16 num_qv_maps;
1994         u8 pad[4];
1995         struct virtchnl_queue_vector qv_maps[1];
1996 };
1997
1998 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_queue_vector_maps);
1999
2000 struct virtchnl_quanta_cfg {
2001         u16 quanta_size;
2002         struct virtchnl_queue_chunk queue_select;
2003 };
2004
2005 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_quanta_cfg);
2006
2007 /* Since VF messages are limited by u16 size, precalculate the maximum possible
2008  * values of nested elements in virtchnl structures that virtual channel can
2009  * possibly handle in a single message.
2010  */
2011 enum virtchnl_vector_limits {
2012         VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX       =
2013                 ((u16)(~0) - sizeof(struct virtchnl_vsi_queue_config_info)) /
2014                 sizeof(struct virtchnl_queue_pair_info),
2015
2016         VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX          =
2017                 ((u16)(~0) - sizeof(struct virtchnl_irq_map_info)) /
2018                 sizeof(struct virtchnl_vector_map),
2019
2020         VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX        =
2021                 ((u16)(~0) - sizeof(struct virtchnl_ether_addr_list)) /
2022                 sizeof(struct virtchnl_ether_addr),
2023
2024         VIRTCHNL_OP_ADD_DEL_VLAN_MAX            =
2025                 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list)) /
2026                 sizeof(u16),
2027
2028
2029         VIRTCHNL_OP_ENABLE_CHANNELS_MAX         =
2030                 ((u16)(~0) - sizeof(struct virtchnl_tc_info)) /
2031                 sizeof(struct virtchnl_channel_info),
2032
2033         VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX    =
2034                 ((u16)(~0) - sizeof(struct virtchnl_del_ena_dis_queues)) /
2035                 sizeof(struct virtchnl_queue_chunk),
2036
2037         VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX  =
2038                 ((u16)(~0) - sizeof(struct virtchnl_queue_vector_maps)) /
2039                 sizeof(struct virtchnl_queue_vector),
2040
2041         VIRTCHNL_OP_ADD_DEL_VLAN_V2_MAX         =
2042                 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list_v2)) /
2043                 sizeof(struct virtchnl_vlan_filter),
2044 };
2045
2046 /**
2047  * virtchnl_vc_validate_vf_msg
2048  * @ver: Virtchnl version info
2049  * @v_opcode: Opcode for the message
2050  * @msg: pointer to the msg buffer
2051  * @msglen: msg length
2052  *
2053  * validate msg format against struct for each opcode
2054  */
2055 static inline int
2056 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode,
2057                             u8 *msg, u16 msglen)
2058 {
2059         bool err_msg_format = false;
2060         u32 valid_len = 0;
2061
2062         /* Validate message length. */
2063         switch (v_opcode) {
2064         case VIRTCHNL_OP_VERSION:
2065                 valid_len = sizeof(struct virtchnl_version_info);
2066                 break;
2067         case VIRTCHNL_OP_RESET_VF:
2068                 break;
2069         case VIRTCHNL_OP_GET_VF_RESOURCES:
2070                 if (VF_IS_V11(ver))
2071                         valid_len = sizeof(u32);
2072                 break;
2073         case VIRTCHNL_OP_CONFIG_TX_QUEUE:
2074                 valid_len = sizeof(struct virtchnl_txq_info);
2075                 break;
2076         case VIRTCHNL_OP_CONFIG_RX_QUEUE:
2077                 valid_len = sizeof(struct virtchnl_rxq_info);
2078                 break;
2079         case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
2080                 valid_len = sizeof(struct virtchnl_vsi_queue_config_info);
2081                 if (msglen >= valid_len) {
2082                         struct virtchnl_vsi_queue_config_info *vqc =
2083                             (struct virtchnl_vsi_queue_config_info *)msg;
2084
2085                         if (vqc->num_queue_pairs == 0 || vqc->num_queue_pairs >
2086                             VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX) {
2087                                 err_msg_format = true;
2088                                 break;
2089                         }
2090
2091                         valid_len += (vqc->num_queue_pairs *
2092                                       sizeof(struct
2093                                              virtchnl_queue_pair_info));
2094                 }
2095                 break;
2096         case VIRTCHNL_OP_CONFIG_IRQ_MAP:
2097                 valid_len = sizeof(struct virtchnl_irq_map_info);
2098                 if (msglen >= valid_len) {
2099                         struct virtchnl_irq_map_info *vimi =
2100                             (struct virtchnl_irq_map_info *)msg;
2101
2102                         if (vimi->num_vectors == 0 || vimi->num_vectors >
2103                             VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX) {
2104                                 err_msg_format = true;
2105                                 break;
2106                         }
2107
2108                         valid_len += (vimi->num_vectors *
2109                                       sizeof(struct virtchnl_vector_map));
2110                 }
2111                 break;
2112         case VIRTCHNL_OP_ENABLE_QUEUES:
2113         case VIRTCHNL_OP_DISABLE_QUEUES:
2114                 valid_len = sizeof(struct virtchnl_queue_select);
2115                 break;
2116         case VIRTCHNL_OP_GET_MAX_RSS_QREGION:
2117                 break;
2118         case VIRTCHNL_OP_ADD_ETH_ADDR:
2119         case VIRTCHNL_OP_DEL_ETH_ADDR:
2120                 valid_len = sizeof(struct virtchnl_ether_addr_list);
2121                 if (msglen >= valid_len) {
2122                         struct virtchnl_ether_addr_list *veal =
2123                             (struct virtchnl_ether_addr_list *)msg;
2124
2125                         if (veal->num_elements == 0 || veal->num_elements >
2126                             VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX) {
2127                                 err_msg_format = true;
2128                                 break;
2129                         }
2130
2131                         valid_len += veal->num_elements *
2132                             sizeof(struct virtchnl_ether_addr);
2133                 }
2134                 break;
2135         case VIRTCHNL_OP_ADD_VLAN:
2136         case VIRTCHNL_OP_DEL_VLAN:
2137                 valid_len = sizeof(struct virtchnl_vlan_filter_list);
2138                 if (msglen >= valid_len) {
2139                         struct virtchnl_vlan_filter_list *vfl =
2140                             (struct virtchnl_vlan_filter_list *)msg;
2141
2142                         if (vfl->num_elements == 0 || vfl->num_elements >
2143                             VIRTCHNL_OP_ADD_DEL_VLAN_MAX) {
2144                                 err_msg_format = true;
2145                                 break;
2146                         }
2147
2148                         valid_len += vfl->num_elements * sizeof(u16);
2149                 }
2150                 break;
2151         case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
2152                 valid_len = sizeof(struct virtchnl_promisc_info);
2153                 break;
2154         case VIRTCHNL_OP_GET_STATS:
2155                 valid_len = sizeof(struct virtchnl_queue_select);
2156                 break;
2157         case VIRTCHNL_OP_CONFIG_RSS_KEY:
2158                 valid_len = sizeof(struct virtchnl_rss_key);
2159                 if (msglen >= valid_len) {
2160                         struct virtchnl_rss_key *vrk =
2161                                 (struct virtchnl_rss_key *)msg;
2162
2163                         if (vrk->key_len == 0) {
2164                                 /* zero length is allowed as input */
2165                                 break;
2166                         }
2167
2168                         valid_len += vrk->key_len - 1;
2169                 }
2170                 break;
2171         case VIRTCHNL_OP_CONFIG_RSS_LUT:
2172                 valid_len = sizeof(struct virtchnl_rss_lut);
2173                 if (msglen >= valid_len) {
2174                         struct virtchnl_rss_lut *vrl =
2175                                 (struct virtchnl_rss_lut *)msg;
2176
2177                         if (vrl->lut_entries == 0) {
2178                                 /* zero entries is allowed as input */
2179                                 break;
2180                         }
2181
2182                         valid_len += vrl->lut_entries - 1;
2183                 }
2184                 break;
2185         case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
2186                 break;
2187         case VIRTCHNL_OP_SET_RSS_HENA:
2188                 valid_len = sizeof(struct virtchnl_rss_hena);
2189                 break;
2190         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
2191         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
2192                 break;
2193         case VIRTCHNL_OP_REQUEST_QUEUES:
2194                 valid_len = sizeof(struct virtchnl_vf_res_request);
2195                 break;
2196         case VIRTCHNL_OP_ENABLE_CHANNELS:
2197                 valid_len = sizeof(struct virtchnl_tc_info);
2198                 if (msglen >= valid_len) {
2199                         struct virtchnl_tc_info *vti =
2200                                 (struct virtchnl_tc_info *)msg;
2201
2202                         if (vti->num_tc == 0 || vti->num_tc >
2203                             VIRTCHNL_OP_ENABLE_CHANNELS_MAX) {
2204                                 err_msg_format = true;
2205                                 break;
2206                         }
2207
2208                         valid_len += (vti->num_tc - 1) *
2209                                      sizeof(struct virtchnl_channel_info);
2210                 }
2211                 break;
2212         case VIRTCHNL_OP_DISABLE_CHANNELS:
2213                 break;
2214         case VIRTCHNL_OP_ADD_CLOUD_FILTER:
2215         case VIRTCHNL_OP_DEL_CLOUD_FILTER:
2216                 valid_len = sizeof(struct virtchnl_filter);
2217                 break;
2218         case VIRTCHNL_OP_DCF_VLAN_OFFLOAD:
2219                 valid_len = sizeof(struct virtchnl_dcf_vlan_offload);
2220                 break;
2221         case VIRTCHNL_OP_DCF_CMD_DESC:
2222         case VIRTCHNL_OP_DCF_CMD_BUFF:
2223                 /* These two opcodes are specific to handle the AdminQ command,
2224                  * so the validation needs to be done in PF's context.
2225                  */
2226                 valid_len = msglen;
2227                 break;
2228         case VIRTCHNL_OP_DCF_DISABLE:
2229         case VIRTCHNL_OP_DCF_GET_VSI_MAP:
2230         case VIRTCHNL_OP_DCF_GET_PKG_INFO:
2231                 break;
2232         case VIRTCHNL_OP_DCF_CONFIG_BW:
2233                 valid_len = sizeof(struct virtchnl_dcf_bw_cfg_list);
2234                 if (msglen >= valid_len) {
2235                         struct virtchnl_dcf_bw_cfg_list *cfg_list =
2236                                 (struct virtchnl_dcf_bw_cfg_list *)msg;
2237                         if (cfg_list->num_elem == 0) {
2238                                 err_msg_format = true;
2239                                 break;
2240                         }
2241                         valid_len += (cfg_list->num_elem - 1) *
2242                                          sizeof(struct virtchnl_dcf_bw_cfg);
2243                 }
2244                 break;
2245         case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
2246                 break;
2247         case VIRTCHNL_OP_ADD_RSS_CFG:
2248         case VIRTCHNL_OP_DEL_RSS_CFG:
2249                 valid_len = sizeof(struct virtchnl_rss_cfg);
2250                 break;
2251         case VIRTCHNL_OP_ADD_FDIR_FILTER:
2252                 valid_len = sizeof(struct virtchnl_fdir_add);
2253                 break;
2254         case VIRTCHNL_OP_DEL_FDIR_FILTER:
2255                 valid_len = sizeof(struct virtchnl_fdir_del);
2256                 break;
2257         case VIRTCHNL_OP_GET_QOS_CAPS:
2258                 break;
2259         case VIRTCHNL_OP_CONFIG_QUEUE_TC_MAP:
2260                 valid_len = sizeof(struct virtchnl_queue_tc_mapping);
2261                 if (msglen >= valid_len) {
2262                         struct virtchnl_queue_tc_mapping *q_tc =
2263                                 (struct virtchnl_queue_tc_mapping *)msg;
2264                         if (q_tc->num_tc == 0) {
2265                                 err_msg_format = true;
2266                                 break;
2267                         }
2268                         valid_len += (q_tc->num_tc - 1) *
2269                                          sizeof(q_tc->tc[0]);
2270                 }
2271                 break;
2272         case VIRTCHNL_OP_CONFIG_QUEUE_BW:
2273                 valid_len = sizeof(struct virtchnl_queues_bw_cfg);
2274                 if (msglen >= valid_len) {
2275                         struct virtchnl_queues_bw_cfg *q_bw =
2276                                 (struct virtchnl_queues_bw_cfg *)msg;
2277                         if (q_bw->num_queues == 0) {
2278                                 err_msg_format = true;
2279                                 break;
2280                         }
2281                         valid_len += (q_bw->num_queues - 1) *
2282                                          sizeof(q_bw->cfg[0]);
2283                 }
2284                 break;
2285         case VIRTCHNL_OP_CONFIG_QUANTA:
2286                 valid_len = sizeof(struct virtchnl_quanta_cfg);
2287                 if (msglen >= valid_len) {
2288                         struct virtchnl_quanta_cfg *q_quanta =
2289                                 (struct virtchnl_quanta_cfg *)msg;
2290                         if (q_quanta->quanta_size == 0 ||
2291                             q_quanta->queue_select.num_queues == 0) {
2292                                 err_msg_format = true;
2293                                 break;
2294                         }
2295                 }
2296                 break;
2297         case VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS:
2298                 break;
2299         case VIRTCHNL_OP_ADD_VLAN_V2:
2300         case VIRTCHNL_OP_DEL_VLAN_V2:
2301                 valid_len = sizeof(struct virtchnl_vlan_filter_list_v2);
2302                 if (msglen >= valid_len) {
2303                         struct virtchnl_vlan_filter_list_v2 *vfl =
2304                             (struct virtchnl_vlan_filter_list_v2 *)msg;
2305
2306                         if (vfl->num_elements == 0 || vfl->num_elements >
2307                             VIRTCHNL_OP_ADD_DEL_VLAN_V2_MAX) {
2308                                 err_msg_format = true;
2309                                 break;
2310                         }
2311
2312                         valid_len += (vfl->num_elements - 1) *
2313                                 sizeof(struct virtchnl_vlan_filter);
2314                 }
2315                 break;
2316         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2:
2317         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2:
2318         case VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2:
2319         case VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2:
2320         case VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2:
2321         case VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2:
2322                 valid_len = sizeof(struct virtchnl_vlan_setting);
2323                 break;
2324         case VIRTCHNL_OP_ENABLE_QUEUES_V2:
2325         case VIRTCHNL_OP_DISABLE_QUEUES_V2:
2326                 valid_len = sizeof(struct virtchnl_del_ena_dis_queues);
2327                 if (msglen >= valid_len) {
2328                         struct virtchnl_del_ena_dis_queues *qs =
2329                                 (struct virtchnl_del_ena_dis_queues *)msg;
2330                         if (qs->chunks.num_chunks == 0 ||
2331                             qs->chunks.num_chunks > VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX) {
2332                                 err_msg_format = true;
2333                                 break;
2334                         }
2335                         valid_len += (qs->chunks.num_chunks - 1) *
2336                                       sizeof(struct virtchnl_queue_chunk);
2337                 }
2338                 break;
2339         case VIRTCHNL_OP_MAP_QUEUE_VECTOR:
2340                 valid_len = sizeof(struct virtchnl_queue_vector_maps);
2341                 if (msglen >= valid_len) {
2342                         struct virtchnl_queue_vector_maps *v_qp =
2343                                 (struct virtchnl_queue_vector_maps *)msg;
2344                         if (v_qp->num_qv_maps == 0 ||
2345                             v_qp->num_qv_maps > VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX) {
2346                                 err_msg_format = true;
2347                                 break;
2348                         }
2349                         valid_len += (v_qp->num_qv_maps - 1) *
2350                                       sizeof(struct virtchnl_queue_vector);
2351                 }
2352                 break;
2353
2354         case VIRTCHNL_OP_INLINE_IPSEC_CRYPTO:
2355         {
2356                 struct inline_ipsec_msg *iim = (struct inline_ipsec_msg *)msg;
2357                 valid_len =
2358                         virtchnl_inline_ipsec_val_msg_len(iim->ipsec_opcode);
2359                 break;
2360         }
2361         /* These are always errors coming from the VF. */
2362         case VIRTCHNL_OP_EVENT:
2363         case VIRTCHNL_OP_UNKNOWN:
2364         default:
2365                 return VIRTCHNL_STATUS_ERR_PARAM;
2366         }
2367         /* few more checks */
2368         if (err_msg_format || valid_len != msglen)
2369                 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH;
2370
2371         return 0;
2372 }
2373 #endif /* _VIRTCHNL_H_ */