1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2021 Intel Corporation
9 * This header file describes the VF-PF communication protocol used
10 * by the drivers for all devices starting from our 40G product line
12 * Admin queue buffer usage:
13 * desc->opcode is always aqc_opc_send_msg_to_pf
14 * flags, retval, datalen, and data addr are all used normally.
15 * The Firmware copies the cookie fields when sending messages between the
16 * PF and VF, but uses all other fields internally. Due to this limitation,
17 * we must send all messages as "indirect", i.e. using an external buffer.
19 * All the VSI indexes are relative to the VF. Each VF can have maximum of
20 * three VSIs. All the queue indexes are relative to the VSI. Each VF can
21 * have a maximum of sixteen queues for all of its VSIs.
23 * The PF is required to return a status code in v_retval for all messages
24 * except RESET_VF, which does not require any response. The return value
25 * is of status_code type, defined in the shared type.h.
27 * In general, VF driver initialization should roughly follow the order of
28 * these opcodes. The VF driver must first validate the API version of the
29 * PF driver, then request a reset, then get resources, then configure
30 * queues and interrupts. After these operations are complete, the VF
31 * driver may start its queues, optionally add MAC and VLAN filters, and
35 /* START GENERIC DEFINES
36 * Need to ensure the following enums and defines hold the same meaning and
37 * value in current and future projects
41 enum virtchnl_status_code {
42 VIRTCHNL_STATUS_SUCCESS = 0,
43 VIRTCHNL_STATUS_ERR_PARAM = -5,
44 VIRTCHNL_STATUS_ERR_NO_MEMORY = -18,
45 VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH = -38,
46 VIRTCHNL_STATUS_ERR_CQP_COMPL_ERROR = -39,
47 VIRTCHNL_STATUS_ERR_INVALID_VF_ID = -40,
48 VIRTCHNL_STATUS_ERR_ADMIN_QUEUE_ERROR = -53,
49 VIRTCHNL_STATUS_ERR_NOT_SUPPORTED = -64,
52 /* Backward compatibility */
53 #define VIRTCHNL_ERR_PARAM VIRTCHNL_STATUS_ERR_PARAM
54 #define VIRTCHNL_STATUS_NOT_SUPPORTED VIRTCHNL_STATUS_ERR_NOT_SUPPORTED
56 #define VIRTCHNL_LINK_SPEED_2_5GB_SHIFT 0x0
57 #define VIRTCHNL_LINK_SPEED_100MB_SHIFT 0x1
58 #define VIRTCHNL_LINK_SPEED_1000MB_SHIFT 0x2
59 #define VIRTCHNL_LINK_SPEED_10GB_SHIFT 0x3
60 #define VIRTCHNL_LINK_SPEED_40GB_SHIFT 0x4
61 #define VIRTCHNL_LINK_SPEED_20GB_SHIFT 0x5
62 #define VIRTCHNL_LINK_SPEED_25GB_SHIFT 0x6
63 #define VIRTCHNL_LINK_SPEED_5GB_SHIFT 0x7
65 enum virtchnl_link_speed {
66 VIRTCHNL_LINK_SPEED_UNKNOWN = 0,
67 VIRTCHNL_LINK_SPEED_100MB = BIT(VIRTCHNL_LINK_SPEED_100MB_SHIFT),
68 VIRTCHNL_LINK_SPEED_1GB = BIT(VIRTCHNL_LINK_SPEED_1000MB_SHIFT),
69 VIRTCHNL_LINK_SPEED_10GB = BIT(VIRTCHNL_LINK_SPEED_10GB_SHIFT),
70 VIRTCHNL_LINK_SPEED_40GB = BIT(VIRTCHNL_LINK_SPEED_40GB_SHIFT),
71 VIRTCHNL_LINK_SPEED_20GB = BIT(VIRTCHNL_LINK_SPEED_20GB_SHIFT),
72 VIRTCHNL_LINK_SPEED_25GB = BIT(VIRTCHNL_LINK_SPEED_25GB_SHIFT),
73 VIRTCHNL_LINK_SPEED_2_5GB = BIT(VIRTCHNL_LINK_SPEED_2_5GB_SHIFT),
74 VIRTCHNL_LINK_SPEED_5GB = BIT(VIRTCHNL_LINK_SPEED_5GB_SHIFT),
77 /* for hsplit_0 field of Rx HMC context */
78 /* deprecated with IAVF 1.0 */
79 enum virtchnl_rx_hsplit {
80 VIRTCHNL_RX_HSPLIT_NO_SPLIT = 0,
81 VIRTCHNL_RX_HSPLIT_SPLIT_L2 = 1,
82 VIRTCHNL_RX_HSPLIT_SPLIT_IP = 2,
83 VIRTCHNL_RX_HSPLIT_SPLIT_TCP_UDP = 4,
84 VIRTCHNL_RX_HSPLIT_SPLIT_SCTP = 8,
87 #define VIRTCHNL_ETH_LENGTH_OF_ADDRESS 6
88 /* END GENERIC DEFINES */
90 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
91 * of the virtchnl_msg structure.
94 /* The PF sends status change events to VFs using
95 * the VIRTCHNL_OP_EVENT opcode.
96 * VFs send requests to the PF using the other ops.
97 * Use of "advanced opcode" features must be negotiated as part of capabilities
98 * exchange and are not considered part of base mode feature set.
100 VIRTCHNL_OP_UNKNOWN = 0,
101 VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
102 VIRTCHNL_OP_RESET_VF = 2,
103 VIRTCHNL_OP_GET_VF_RESOURCES = 3,
104 VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
105 VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
106 VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
107 VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
108 VIRTCHNL_OP_ENABLE_QUEUES = 8,
109 VIRTCHNL_OP_DISABLE_QUEUES = 9,
110 VIRTCHNL_OP_ADD_ETH_ADDR = 10,
111 VIRTCHNL_OP_DEL_ETH_ADDR = 11,
112 VIRTCHNL_OP_ADD_VLAN = 12,
113 VIRTCHNL_OP_DEL_VLAN = 13,
114 VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
115 VIRTCHNL_OP_GET_STATS = 15,
116 VIRTCHNL_OP_RSVD = 16,
117 VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */
118 /* opcode 19 is reserved */
119 /* opcodes 20, 21, and 22 are reserved */
120 VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
121 VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
122 VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
123 VIRTCHNL_OP_SET_RSS_HENA = 26,
124 VIRTCHNL_OP_ENABLE_VLAN_STRIPPING = 27,
125 VIRTCHNL_OP_DISABLE_VLAN_STRIPPING = 28,
126 VIRTCHNL_OP_REQUEST_QUEUES = 29,
127 VIRTCHNL_OP_ENABLE_CHANNELS = 30,
128 VIRTCHNL_OP_DISABLE_CHANNELS = 31,
129 VIRTCHNL_OP_ADD_CLOUD_FILTER = 32,
130 VIRTCHNL_OP_DEL_CLOUD_FILTER = 33,
131 /* opcodes 34, 35, 36, and 37 are reserved */
132 VIRTCHNL_OP_DCF_VLAN_OFFLOAD = 38,
133 VIRTCHNL_OP_DCF_CMD_DESC = 39,
134 VIRTCHNL_OP_DCF_CMD_BUFF = 40,
135 VIRTCHNL_OP_DCF_DISABLE = 41,
136 VIRTCHNL_OP_DCF_GET_VSI_MAP = 42,
137 VIRTCHNL_OP_DCF_GET_PKG_INFO = 43,
138 VIRTCHNL_OP_GET_SUPPORTED_RXDIDS = 44,
139 VIRTCHNL_OP_ADD_RSS_CFG = 45,
140 VIRTCHNL_OP_DEL_RSS_CFG = 46,
141 VIRTCHNL_OP_ADD_FDIR_FILTER = 47,
142 VIRTCHNL_OP_DEL_FDIR_FILTER = 48,
143 VIRTCHNL_OP_QUERY_FDIR_FILTER = 49,
144 VIRTCHNL_OP_GET_MAX_RSS_QREGION = 50,
145 VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS = 51,
146 VIRTCHNL_OP_ADD_VLAN_V2 = 52,
147 VIRTCHNL_OP_DEL_VLAN_V2 = 53,
148 VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 = 54,
149 VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 = 55,
150 VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 = 56,
151 VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2 = 57,
152 VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2 = 58,
153 VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2 = 59,
154 VIRTCHNL_OP_ENABLE_QUEUES_V2 = 107,
155 VIRTCHNL_OP_DISABLE_QUEUES_V2 = 108,
156 VIRTCHNL_OP_MAP_QUEUE_VECTOR = 111,
160 static inline const char *virtchnl_op_str(enum virtchnl_ops v_opcode)
163 case VIRTCHNL_OP_UNKNOWN:
164 return "VIRTCHNL_OP_UNKNOWN";
165 case VIRTCHNL_OP_VERSION:
166 return "VIRTCHNL_OP_VERSION";
167 case VIRTCHNL_OP_RESET_VF:
168 return "VIRTCHNL_OP_RESET_VF";
169 case VIRTCHNL_OP_GET_VF_RESOURCES:
170 return "VIRTCHNL_OP_GET_VF_RESOURCES";
171 case VIRTCHNL_OP_CONFIG_TX_QUEUE:
172 return "VIRTCHNL_OP_CONFIG_TX_QUEUE";
173 case VIRTCHNL_OP_CONFIG_RX_QUEUE:
174 return "VIRTCHNL_OP_CONFIG_RX_QUEUE";
175 case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
176 return "VIRTCHNL_OP_CONFIG_VSI_QUEUES";
177 case VIRTCHNL_OP_CONFIG_IRQ_MAP:
178 return "VIRTCHNL_OP_CONFIG_IRQ_MAP";
179 case VIRTCHNL_OP_ENABLE_QUEUES:
180 return "VIRTCHNL_OP_ENABLE_QUEUES";
181 case VIRTCHNL_OP_DISABLE_QUEUES:
182 return "VIRTCHNL_OP_DISABLE_QUEUES";
183 case VIRTCHNL_OP_ADD_ETH_ADDR:
184 return "VIRTCHNL_OP_ADD_ETH_ADDR";
185 case VIRTCHNL_OP_DEL_ETH_ADDR:
186 return "VIRTCHNL_OP_DEL_ETH_ADDR";
187 case VIRTCHNL_OP_ADD_VLAN:
188 return "VIRTCHNL_OP_ADD_VLAN";
189 case VIRTCHNL_OP_DEL_VLAN:
190 return "VIRTCHNL_OP_DEL_VLAN";
191 case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
192 return "VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE";
193 case VIRTCHNL_OP_GET_STATS:
194 return "VIRTCHNL_OP_GET_STATS";
195 case VIRTCHNL_OP_RSVD:
196 return "VIRTCHNL_OP_RSVD";
197 case VIRTCHNL_OP_EVENT:
198 return "VIRTCHNL_OP_EVENT";
199 case VIRTCHNL_OP_CONFIG_RSS_KEY:
200 return "VIRTCHNL_OP_CONFIG_RSS_KEY";
201 case VIRTCHNL_OP_CONFIG_RSS_LUT:
202 return "VIRTCHNL_OP_CONFIG_RSS_LUT";
203 case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
204 return "VIRTCHNL_OP_GET_RSS_HENA_CAPS";
205 case VIRTCHNL_OP_SET_RSS_HENA:
206 return "VIRTCHNL_OP_SET_RSS_HENA";
207 case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
208 return "VIRTCHNL_OP_ENABLE_VLAN_STRIPPING";
209 case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
210 return "VIRTCHNL_OP_DISABLE_VLAN_STRIPPING";
211 case VIRTCHNL_OP_REQUEST_QUEUES:
212 return "VIRTCHNL_OP_REQUEST_QUEUES";
213 case VIRTCHNL_OP_ENABLE_CHANNELS:
214 return "VIRTCHNL_OP_ENABLE_CHANNELS";
215 case VIRTCHNL_OP_DISABLE_CHANNELS:
216 return "VIRTCHNL_OP_DISABLE_CHANNELS";
217 case VIRTCHNL_OP_ADD_CLOUD_FILTER:
218 return "VIRTCHNL_OP_ADD_CLOUD_FILTER";
219 case VIRTCHNL_OP_DEL_CLOUD_FILTER:
220 return "VIRTCHNL_OP_DEL_CLOUD_FILTER";
221 case VIRTCHNL_OP_DCF_CMD_DESC:
222 return "VIRTCHNL_OP_DCF_CMD_DESC";
223 case VIRTCHNL_OP_DCF_CMD_BUFF:
224 return "VIRTCHHNL_OP_DCF_CMD_BUFF";
225 case VIRTCHNL_OP_DCF_DISABLE:
226 return "VIRTCHNL_OP_DCF_DISABLE";
227 case VIRTCHNL_OP_DCF_GET_VSI_MAP:
228 return "VIRTCHNL_OP_DCF_GET_VSI_MAP";
229 case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
230 return "VIRTCHNL_OP_GET_SUPPORTED_RXDIDS";
231 case VIRTCHNL_OP_ADD_RSS_CFG:
232 return "VIRTCHNL_OP_ADD_RSS_CFG";
233 case VIRTCHNL_OP_DEL_RSS_CFG:
234 return "VIRTCHNL_OP_DEL_RSS_CFG";
235 case VIRTCHNL_OP_ADD_FDIR_FILTER:
236 return "VIRTCHNL_OP_ADD_FDIR_FILTER";
237 case VIRTCHNL_OP_DEL_FDIR_FILTER:
238 return "VIRTCHNL_OP_DEL_FDIR_FILTER";
239 case VIRTCHNL_OP_QUERY_FDIR_FILTER:
240 return "VIRTCHNL_OP_QUERY_FDIR_FILTER";
241 case VIRTCHNL_OP_GET_MAX_RSS_QREGION:
242 return "VIRTCHNL_OP_GET_MAX_RSS_QREGION";
243 case VIRTCHNL_OP_ENABLE_QUEUES_V2:
244 return "VIRTCHNL_OP_ENABLE_QUEUES_V2";
245 case VIRTCHNL_OP_DISABLE_QUEUES_V2:
246 return "VIRTCHNL_OP_DISABLE_QUEUES_V2";
247 case VIRTCHNL_OP_MAP_QUEUE_VECTOR:
248 return "VIRTCHNL_OP_MAP_QUEUE_VECTOR";
249 case VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS:
250 return "VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS";
251 case VIRTCHNL_OP_ADD_VLAN_V2:
252 return "VIRTCHNL_OP_ADD_VLAN_V2";
253 case VIRTCHNL_OP_DEL_VLAN_V2:
254 return "VIRTCHNL_OP_DEL_VLAN_V2";
255 case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2:
256 return "VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2";
257 case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2:
258 return "VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2";
259 case VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2:
260 return "VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2";
261 case VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2:
262 return "VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2";
263 case VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2:
264 return "VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2";
265 case VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2:
266 return "VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2";
267 case VIRTCHNL_OP_MAX:
268 return "VIRTCHNL_OP_MAX";
270 return "Unsupported (update virtchnl.h)";
274 /* These macros are used to generate compilation errors if a structure/union
275 * is not exactly the correct length. It gives a divide by zero error if the
276 * structure/union is not of the correct size, otherwise it creates an enum
277 * that is never used.
279 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \
280 { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) }
281 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \
282 { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) }
284 /* Virtual channel message descriptor. This overlays the admin queue
285 * descriptor. All other data is passed in external buffers.
288 struct virtchnl_msg {
289 u8 pad[8]; /* AQ flags/opcode/len/retval fields */
290 enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
291 enum virtchnl_status_code v_retval; /* ditto for desc->retval */
292 u32 vfid; /* used by PF when sending to VF */
295 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg);
297 /* Message descriptions and data structures. */
299 /* VIRTCHNL_OP_VERSION
300 * VF posts its version number to the PF. PF responds with its version number
301 * in the same format, along with a return code.
302 * Reply from PF has its major/minor versions also in param0 and param1.
303 * If there is a major version mismatch, then the VF cannot operate.
304 * If there is a minor version mismatch, then the VF can operate but should
305 * add a warning to the system log.
307 * This enum element MUST always be specified as == 1, regardless of other
308 * changes in the API. The PF must always respond to this message without
309 * error regardless of version mismatch.
311 #define VIRTCHNL_VERSION_MAJOR 1
312 #define VIRTCHNL_VERSION_MINOR 1
313 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0
315 struct virtchnl_version_info {
320 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info);
322 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0))
323 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1))
325 /* VIRTCHNL_OP_RESET_VF
326 * VF sends this request to PF with no parameters
327 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
328 * until reset completion is indicated. The admin queue must be reinitialized
329 * after this operation.
331 * When reset is complete, PF must ensure that all queues in all VSIs associated
332 * with the VF are stopped, all queue configurations in the HMC are set to 0,
333 * and all MAC and VLAN filters (except the default MAC address) on all VSIs
337 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV
338 * vsi_type should always be 6 for backward compatibility. Add other fields
341 enum virtchnl_vsi_type {
342 VIRTCHNL_VSI_TYPE_INVALID = 0,
343 VIRTCHNL_VSI_SRIOV = 6,
346 /* VIRTCHNL_OP_GET_VF_RESOURCES
347 * Version 1.0 VF sends this request to PF with no parameters
348 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
349 * PF responds with an indirect message containing
350 * virtchnl_vf_resource and one or more
351 * virtchnl_vsi_resource structures.
354 struct virtchnl_vsi_resource {
357 enum virtchnl_vsi_type vsi_type;
359 u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
362 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource);
364 /* VF capability flags
365 * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including
366 * TX/RX Checksum offloading and TSO for non-tunnelled packets.
368 #define VIRTCHNL_VF_OFFLOAD_L2 0x00000001
369 #define VIRTCHNL_VF_OFFLOAD_IWARP 0x00000002
370 #define VIRTCHNL_VF_OFFLOAD_RSVD 0x00000004
371 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ 0x00000008
372 #define VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010
373 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020
374 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES 0x00000040
375 #define VIRTCHNL_VF_OFFLOAD_CRC 0x00000080
376 /* 0X00000100 is reserved */
377 #define VIRTCHNL_VF_LARGE_NUM_QPAIRS 0x00000200
378 #define VIRTCHNL_VF_OFFLOAD_VLAN_V2 0x00008000
379 #define VIRTCHNL_VF_OFFLOAD_VLAN 0x00010000
380 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING 0x00020000
381 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2 0x00040000
382 #define VIRTCHNL_VF_OFFLOAD_RSS_PF 0X00080000
383 #define VIRTCHNL_VF_OFFLOAD_ENCAP 0X00100000
384 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM 0X00200000
385 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM 0X00400000
386 #define VIRTCHNL_VF_OFFLOAD_ADQ 0X00800000
387 #define VIRTCHNL_VF_OFFLOAD_ADQ_V2 0X01000000
388 #define VIRTCHNL_VF_OFFLOAD_USO 0X02000000
389 #define VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC 0X04000000
390 #define VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF 0X08000000
391 #define VIRTCHNL_VF_OFFLOAD_FDIR_PF 0X10000000
392 /* 0X20000000 is reserved */
393 #define VIRTCHNL_VF_CAP_DCF 0X40000000
394 /* 0X80000000 is reserved */
396 /* Define below the capability flags that are not offloads */
397 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED 0x00000080
398 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \
399 VIRTCHNL_VF_OFFLOAD_VLAN | \
400 VIRTCHNL_VF_OFFLOAD_RSS_PF)
402 struct virtchnl_vf_resource {
412 struct virtchnl_vsi_resource vsi_res[1];
415 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource);
417 /* VIRTCHNL_OP_CONFIG_TX_QUEUE
418 * VF sends this message to set up parameters for one TX queue.
419 * External data buffer contains one instance of virtchnl_txq_info.
420 * PF configures requested queue and returns a status code.
423 /* Tx queue config info */
424 struct virtchnl_txq_info {
427 u16 ring_len; /* number of descriptors, multiple of 8 */
428 u16 headwb_enabled; /* deprecated with AVF 1.0 */
430 u64 dma_headwb_addr; /* deprecated with AVF 1.0 */
433 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info);
435 /* VIRTCHNL_OP_CONFIG_RX_QUEUE
436 * VF sends this message to set up parameters for one RX queue.
437 * External data buffer contains one instance of virtchnl_rxq_info.
438 * PF configures requested queue and returns a status code. The
439 * crc_disable flag disables CRC stripping on the VF. Setting
440 * the crc_disable flag to 1 will disable CRC stripping for each
441 * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC
442 * offload must have been set prior to sending this info or the PF
443 * will ignore the request. This flag should be set the same for
444 * all of the queues for a VF.
447 /* Rx queue config info */
448 struct virtchnl_rxq_info {
451 u32 ring_len; /* number of descriptors, multiple of 32 */
453 u16 splithdr_enabled; /* deprecated with AVF 1.0 */
457 /* only used when VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC is supported */
461 enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */
465 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info);
467 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES
468 * VF sends this message to set parameters for active TX and RX queues
469 * associated with the specified VSI.
470 * PF configures queues and returns status.
471 * If the number of queues specified is greater than the number of queues
472 * associated with the VSI, an error is returned and no queues are configured.
473 * NOTE: The VF is not required to configure all queues in a single request.
474 * It may send multiple messages. PF drivers must correctly handle all VF
477 struct virtchnl_queue_pair_info {
478 /* NOTE: vsi_id and queue_id should be identical for both queues. */
479 struct virtchnl_txq_info txq;
480 struct virtchnl_rxq_info rxq;
483 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info);
485 struct virtchnl_vsi_queue_config_info {
489 struct virtchnl_queue_pair_info qpair[1];
492 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info);
494 /* VIRTCHNL_OP_REQUEST_QUEUES
495 * VF sends this message to request the PF to allocate additional queues to
496 * this VF. Each VF gets a guaranteed number of queues on init but asking for
497 * additional queues must be negotiated. This is a best effort request as it
498 * is possible the PF does not have enough queues left to support the request.
499 * If the PF cannot support the number requested it will respond with the
500 * maximum number it is able to support. If the request is successful, PF will
501 * then reset the VF to institute required changes.
504 /* VF resource request */
505 struct virtchnl_vf_res_request {
509 /* VIRTCHNL_OP_CONFIG_IRQ_MAP
510 * VF uses this message to map vectors to queues.
511 * The rxq_map and txq_map fields are bitmaps used to indicate which queues
512 * are to be associated with the specified vector.
513 * The "other" causes are always mapped to vector 0. The VF may not request
514 * that vector 0 be used for traffic.
515 * PF configures interrupt mapping and returns status.
516 * NOTE: due to hardware requirements, all active queues (both TX and RX)
517 * should be mapped to interrupts, even if the driver intends to operate
518 * only in polling mode. In this case the interrupt may be disabled, but
519 * the ITR timer will still run to trigger writebacks.
521 struct virtchnl_vector_map {
530 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map);
532 struct virtchnl_irq_map_info {
534 struct virtchnl_vector_map vecmap[1];
537 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info);
539 /* VIRTCHNL_OP_ENABLE_QUEUES
540 * VIRTCHNL_OP_DISABLE_QUEUES
541 * VF sends these message to enable or disable TX/RX queue pairs.
542 * The queues fields are bitmaps indicating which queues to act upon.
543 * (Currently, we only support 16 queues per VF, but we make the field
544 * u32 to allow for expansion.)
545 * PF performs requested action and returns status.
546 * NOTE: The VF is not required to enable/disable all queues in a single
547 * request. It may send multiple messages.
548 * PF drivers must correctly handle all VF requests.
550 struct virtchnl_queue_select {
557 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select);
559 /* VIRTCHNL_OP_GET_MAX_RSS_QREGION
561 * if VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
562 * then this op must be supported.
564 * VF sends this message in order to query the max RSS queue region
565 * size supported by PF, when VIRTCHNL_VF_LARGE_NUM_QPAIRS is enabled.
566 * This information should be used when configuring the RSS LUT and/or
567 * configuring queue region based filters.
569 * The maximum RSS queue region is 2^qregion_width. So, a qregion_width
570 * of 6 would inform the VF that the PF supports a maximum RSS queue region
573 * A queue region represents a range of queues that can be used to configure
574 * a RSS LUT. For example, if a VF is given 64 queues, but only a max queue
575 * region size of 16 (i.e. 2^qregion_width = 16) then it will only be able
576 * to configure the RSS LUT with queue indices from 0 to 15. However, other
577 * filters can be used to direct packets to queues >15 via specifying a queue
578 * base/offset and queue region width.
580 struct virtchnl_max_rss_qregion {
586 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_max_rss_qregion);
588 /* VIRTCHNL_OP_ADD_ETH_ADDR
589 * VF sends this message in order to add one or more unicast or multicast
590 * address filters for the specified VSI.
591 * PF adds the filters and returns status.
594 /* VIRTCHNL_OP_DEL_ETH_ADDR
595 * VF sends this message in order to remove one or more unicast or multicast
596 * filters for the specified VSI.
597 * PF removes the filters and returns status.
600 /* VIRTCHNL_ETHER_ADDR_LEGACY
601 * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad
602 * bytes. Moving forward all VF drivers should not set type to
603 * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy
604 * behavior. The control plane function (i.e. PF) can use a best effort method
605 * of tracking the primary/device unicast in this case, but there is no
606 * guarantee and functionality depends on the implementation of the PF.
609 /* VIRTCHNL_ETHER_ADDR_PRIMARY
610 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the
611 * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and
612 * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane
613 * function (i.e. PF) to accurately track and use this MAC address for
614 * displaying on the host and for VM/function reset.
617 /* VIRTCHNL_ETHER_ADDR_EXTRA
618 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra
619 * unicast and/or multicast filters that are being added/deleted via
620 * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively.
622 struct virtchnl_ether_addr {
623 u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
625 #define VIRTCHNL_ETHER_ADDR_LEGACY 0
626 #define VIRTCHNL_ETHER_ADDR_PRIMARY 1
627 #define VIRTCHNL_ETHER_ADDR_EXTRA 2
628 #define VIRTCHNL_ETHER_ADDR_TYPE_MASK 3 /* first two bits of type are valid */
632 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr);
634 struct virtchnl_ether_addr_list {
637 struct virtchnl_ether_addr list[1];
640 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list);
642 /* VIRTCHNL_OP_ADD_VLAN
643 * VF sends this message to add one or more VLAN tag filters for receives.
644 * PF adds the filters and returns status.
645 * If a port VLAN is configured by the PF, this operation will return an
649 /* VIRTCHNL_OP_DEL_VLAN
650 * VF sends this message to remove one or more VLAN tag filters for receives.
651 * PF removes the filters and returns status.
652 * If a port VLAN is configured by the PF, this operation will return an
656 struct virtchnl_vlan_filter_list {
662 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list);
664 /* This enum is used for all of the VIRTCHNL_VF_OFFLOAD_VLAN_V2_CAPS related
665 * structures and opcodes.
667 * VIRTCHNL_VLAN_UNSUPPORTED - This field is not supported and if a VF driver
668 * populates it the PF should return VIRTCHNL_STATUS_ERR_NOT_SUPPORTED.
670 * VIRTCHNL_VLAN_ETHERTYPE_8100 - This field supports 0x8100 ethertype.
671 * VIRTCHNL_VLAN_ETHERTYPE_88A8 - This field supports 0x88A8 ethertype.
672 * VIRTCHNL_VLAN_ETHERTYPE_9100 - This field supports 0x9100 ethertype.
674 * VIRTCHNL_VLAN_ETHERTYPE_AND - Used when multiple ethertypes can be supported
675 * by the PF concurrently. For example, if the PF can support
676 * VIRTCHNL_VLAN_ETHERTYPE_8100 AND VIRTCHNL_VLAN_ETHERTYPE_88A8 filters it
677 * would OR the following bits:
679 * VIRTHCNL_VLAN_ETHERTYPE_8100 |
680 * VIRTCHNL_VLAN_ETHERTYPE_88A8 |
681 * VIRTCHNL_VLAN_ETHERTYPE_AND;
683 * The VF would interpret this as VLAN filtering can be supported on both 0x8100
684 * and 0x88A8 VLAN ethertypes.
686 * VIRTCHNL_ETHERTYPE_XOR - Used when only a single ethertype can be supported
687 * by the PF concurrently. For example if the PF can support
688 * VIRTCHNL_VLAN_ETHERTYPE_8100 XOR VIRTCHNL_VLAN_ETHERTYPE_88A8 stripping
689 * offload it would OR the following bits:
691 * VIRTCHNL_VLAN_ETHERTYPE_8100 |
692 * VIRTCHNL_VLAN_ETHERTYPE_88A8 |
693 * VIRTCHNL_VLAN_ETHERTYPE_XOR;
695 * The VF would interpret this as VLAN stripping can be supported on either
696 * 0x8100 or 0x88a8 VLAN ethertypes. So when requesting VLAN stripping via
697 * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 the specified ethertype will override
698 * the previously set value.
700 * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG1 - Used to tell the VF to insert and/or
701 * strip the VLAN tag using the L2TAG1 field of the Tx/Rx descriptors.
703 * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to insert hardware
704 * offloaded VLAN tags using the L2TAG2 field of the Tx descriptor.
706 * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to strip hardware
707 * offloaded VLAN tags using the L2TAG2_2 field of the Rx descriptor.
709 * VIRTCHNL_VLAN_PRIO - This field supports VLAN priority bits. This is used for
710 * VLAN filtering if the underlying PF supports it.
712 * VIRTCHNL_VLAN_TOGGLE_ALLOWED - This field is used to say whether a
713 * certain VLAN capability can be toggled. For example if the underlying PF/CP
714 * allows the VF to toggle VLAN filtering, stripping, and/or insertion it should
715 * set this bit along with the supported ethertypes.
717 enum virtchnl_vlan_support {
718 VIRTCHNL_VLAN_UNSUPPORTED = 0,
719 VIRTCHNL_VLAN_ETHERTYPE_8100 = 0x00000001,
720 VIRTCHNL_VLAN_ETHERTYPE_88A8 = 0x00000002,
721 VIRTCHNL_VLAN_ETHERTYPE_9100 = 0x00000004,
722 VIRTCHNL_VLAN_TAG_LOCATION_L2TAG1 = 0x00000100,
723 VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 = 0x00000200,
724 VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2_2 = 0x00000400,
725 VIRTCHNL_VLAN_PRIO = 0x01000000,
726 VIRTCHNL_VLAN_FILTER_MASK = 0x10000000,
727 VIRTCHNL_VLAN_ETHERTYPE_AND = 0x20000000,
728 VIRTCHNL_VLAN_ETHERTYPE_XOR = 0x40000000,
729 VIRTCHNL_VLAN_TOGGLE = 0x80000000
732 /* This structure is used as part of the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS
733 * for filtering, insertion, and stripping capabilities.
735 * If only outer capabilities are supported (for filtering, insertion, and/or
736 * stripping) then this refers to the outer most or single VLAN from the VF's
739 * If only inner capabilities are supported (for filtering, insertion, and/or
740 * stripping) then this refers to the outer most or single VLAN from the VF's
741 * perspective. Functionally this is the same as if only outer capabilities are
742 * supported. The VF driver is just forced to use the inner fields when
743 * adding/deleting filters and enabling/disabling offloads (if supported).
745 * If both outer and inner capabilities are supported (for filtering, insertion,
746 * and/or stripping) then outer refers to the outer most or single VLAN and
747 * inner refers to the second VLAN, if it exists, in the packet.
749 * There is no support for tunneled VLAN offloads, so outer or inner are never
750 * referring to a tunneled packet from the VF's perspective.
752 struct virtchnl_vlan_supported_caps {
757 /* The PF populates these fields based on the supported VLAN filtering. If a
758 * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will
759 * reject any VIRTCHNL_OP_ADD_VLAN_V2 or VIRTCHNL_OP_DEL_VLAN_V2 messages using
760 * the unsupported fields.
762 * Also, a VF is only allowed to toggle its VLAN filtering setting if the
763 * VIRTCHNL_VLAN_TOGGLE bit is set.
765 * The ethertype(s) specified in the ethertype_init field are the ethertypes
766 * enabled for VLAN filtering. VLAN filtering in this case refers to the outer
767 * most VLAN from the VF's perspective. If both inner and outer filtering are
768 * allowed then ethertype_init only refers to the outer most VLAN as only
769 * VLAN ethertype supported for inner VLAN filtering is
770 * VIRTCHNL_VLAN_ETHERTYPE_8100. By default, inner VLAN filtering is disabled
771 * when both inner and outer filtering are allowed.
773 * The max_filters field tells the VF how many VLAN filters it's allowed to have
774 * at any one time. If it exceeds this amount and tries to add another filter,
775 * then the request will be rejected by the PF. To prevent failures, the VF
776 * should keep track of how many VLAN filters it has added and not attempt to
777 * add more than max_filters.
779 struct virtchnl_vlan_filtering_caps {
780 struct virtchnl_vlan_supported_caps filtering_support;
786 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vlan_filtering_caps);
788 /* This enum is used for the virtchnl_vlan_offload_caps structure to specify
789 * if the PF supports a different ethertype for stripping and insertion.
791 * VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION - The ethertype(s) specified
792 * for stripping affect the ethertype(s) specified for insertion and visa versa
793 * as well. If the VF tries to configure VLAN stripping via
794 * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 with VIRTCHNL_VLAN_ETHERTYPE_8100 then
795 * that will be the ethertype for both stripping and insertion.
797 * VIRTCHNL_ETHERTYPE_MATCH_NOT_REQUIRED - The ethertype(s) specified for
798 * stripping do not affect the ethertype(s) specified for insertion and visa
801 enum virtchnl_vlan_ethertype_match {
802 VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION = 0,
803 VIRTCHNL_ETHERTYPE_MATCH_NOT_REQUIRED = 1,
806 /* The PF populates these fields based on the supported VLAN offloads. If a
807 * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will
808 * reject any VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 or
809 * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 messages using the unsupported fields.
811 * Also, a VF is only allowed to toggle its VLAN offload setting if the
812 * VIRTCHNL_VLAN_TOGGLE_ALLOWED bit is set.
814 * The VF driver needs to be aware of how the tags are stripped by hardware and
815 * inserted by the VF driver based on the level of offload support. The PF will
816 * populate these fields based on where the VLAN tags are expected to be
817 * offloaded via the VIRTHCNL_VLAN_TAG_LOCATION_* bits. The VF will need to
818 * interpret these fields. See the definition of the
819 * VIRTCHNL_VLAN_TAG_LOCATION_* bits above the virtchnl_vlan_support
822 struct virtchnl_vlan_offload_caps {
823 struct virtchnl_vlan_supported_caps stripping_support;
824 struct virtchnl_vlan_supported_caps insertion_support;
830 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_vlan_offload_caps);
832 /* VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS
833 * VF sends this message to determine its VLAN capabilities.
835 * PF will mark which capabilities it supports based on hardware support and
836 * current configuration. For example, if a port VLAN is configured the PF will
837 * not allow outer VLAN filtering, stripping, or insertion to be configured so
838 * it will block these features from the VF.
840 * The VF will need to cross reference its capabilities with the PFs
841 * capabilities in the response message from the PF to determine the VLAN
844 struct virtchnl_vlan_caps {
845 struct virtchnl_vlan_filtering_caps filtering;
846 struct virtchnl_vlan_offload_caps offloads;
849 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_vlan_caps);
851 struct virtchnl_vlan {
852 u16 tci; /* tci[15:13] = PCP and tci[11:0] = VID */
853 u16 tci_mask; /* only valid if VIRTCHNL_VLAN_FILTER_MASK set in
856 u16 tpid; /* 0x8100, 0x88a8, etc. and only type(s) set in
857 * filtering caps. Note that tpid here does not refer to
858 * VIRTCHNL_VLAN_ETHERTYPE_*, but it refers to the
859 * actual 2-byte VLAN TPID
864 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_vlan);
866 struct virtchnl_vlan_filter {
867 struct virtchnl_vlan inner;
868 struct virtchnl_vlan outer;
872 VIRTCHNL_CHECK_STRUCT_LEN(32, virtchnl_vlan_filter);
874 /* VIRTCHNL_OP_ADD_VLAN_V2
875 * VIRTCHNL_OP_DEL_VLAN_V2
877 * VF sends these messages to add/del one or more VLAN tag filters for Rx
880 * The PF attempts to add the filters and returns status.
882 * The VF should only ever attempt to add/del virtchnl_vlan_filter(s) using the
883 * supported fields negotiated via VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS.
885 struct virtchnl_vlan_filter_list_v2 {
889 struct virtchnl_vlan_filter filters[1];
892 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_vlan_filter_list_v2);
894 /* VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2
895 * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2
896 * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2
897 * VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2
899 * VF sends this message to enable or disable VLAN stripping or insertion. It
900 * also needs to specify an ethertype. The VF knows which VLAN ethertypes are
901 * allowed and whether or not it's allowed to enable/disable the specific
902 * offload via the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS message. The VF needs to
903 * parse the virtchnl_vlan_caps.offloads fields to determine which offload
904 * messages are allowed.
906 * For example, if the PF populates the virtchnl_vlan_caps.offloads in the
907 * following manner the VF will be allowed to enable and/or disable 0x8100 inner
908 * VLAN insertion and/or stripping via the opcodes listed above. Inner in this
909 * case means the outer most or single VLAN from the VF's perspective. This is
910 * because no outer offloads are supported. See the comments above the
911 * virtchnl_vlan_supported_caps structure for more details.
913 * virtchnl_vlan_caps.offloads.stripping_support.inner =
914 * VIRTCHNL_VLAN_TOGGLE |
915 * VIRTCHNL_VLAN_ETHERTYPE_8100;
917 * virtchnl_vlan_caps.offloads.insertion_support.inner =
918 * VIRTCHNL_VLAN_TOGGLE |
919 * VIRTCHNL_VLAN_ETHERTYPE_8100;
921 * In order to enable inner (again note that in this case inner is the outer
922 * most or single VLAN from the VF's perspective) VLAN stripping for 0x8100
923 * VLANs, the VF would populate the virtchnl_vlan_setting structure in the
924 * following manner and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message.
926 * virtchnl_vlan_setting.inner_ethertype_setting =
927 * VIRTCHNL_VLAN_ETHERTYPE_8100;
929 * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
932 * The reason that VLAN TPID(s) are not being used for the
933 * outer_ethertype_setting and inner_ethertype_setting fields is because it's
934 * possible a device could support VLAN insertion and/or stripping offload on
935 * multiple ethertypes concurrently, so this method allows a VF to request
936 * multiple ethertypes in one message using the virtchnl_vlan_support
939 * For example, if the PF populates the virtchnl_vlan_caps.offloads in the
940 * following manner the VF will be allowed to enable 0x8100 and 0x88a8 outer
941 * VLAN insertion and stripping simultaneously. The
942 * virtchnl_vlan_caps.offloads.ethertype_match field will also have to be
943 * populated based on what the PF can support.
945 * virtchnl_vlan_caps.offloads.stripping_support.outer =
946 * VIRTCHNL_VLAN_TOGGLE |
947 * VIRTCHNL_VLAN_ETHERTYPE_8100 |
948 * VIRTCHNL_VLAN_ETHERTYPE_88A8 |
949 * VIRTCHNL_VLAN_ETHERTYPE_AND;
951 * virtchnl_vlan_caps.offloads.insertion_support.outer =
952 * VIRTCHNL_VLAN_TOGGLE |
953 * VIRTCHNL_VLAN_ETHERTYPE_8100 |
954 * VIRTCHNL_VLAN_ETHERTYPE_88A8 |
955 * VIRTCHNL_VLAN_ETHERTYPE_AND;
957 * In order to enable outer VLAN stripping for 0x8100 and 0x88a8 VLANs, the VF
958 * would populate the virthcnl_vlan_offload_structure in the following manner
959 * and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message.
961 * virtchnl_vlan_setting.outer_ethertype_setting =
962 * VIRTHCNL_VLAN_ETHERTYPE_8100 |
963 * VIRTHCNL_VLAN_ETHERTYPE_88A8;
965 * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
968 * There is also the case where a PF and the underlying hardware can support
969 * VLAN offloads on multiple ethertypes, but not concurrently. For example, if
970 * the PF populates the virtchnl_vlan_caps.offloads in the following manner the
971 * VF will be allowed to enable and/or disable 0x8100 XOR 0x88a8 outer VLAN
972 * offloads. The ethertypes must match for stripping and insertion.
974 * virtchnl_vlan_caps.offloads.stripping_support.outer =
975 * VIRTCHNL_VLAN_TOGGLE |
976 * VIRTCHNL_VLAN_ETHERTYPE_8100 |
977 * VIRTCHNL_VLAN_ETHERTYPE_88A8 |
978 * VIRTCHNL_VLAN_ETHERTYPE_XOR;
980 * virtchnl_vlan_caps.offloads.insertion_support.outer =
981 * VIRTCHNL_VLAN_TOGGLE |
982 * VIRTCHNL_VLAN_ETHERTYPE_8100 |
983 * VIRTCHNL_VLAN_ETHERTYPE_88A8 |
984 * VIRTCHNL_VLAN_ETHERTYPE_XOR;
986 * virtchnl_vlan_caps.offloads.ethertype_match =
987 * VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION;
989 * In order to enable outer VLAN stripping for 0x88a8 VLANs, the VF would
990 * populate the virtchnl_vlan_setting structure in the following manner and send
991 * the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2. Also, this will change the
992 * ethertype for VLAN insertion if it's enabled. So, for completeness, a
993 * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 with the same ethertype should be sent.
995 * virtchnl_vlan_setting.outer_ethertype_setting = VIRTHCNL_VLAN_ETHERTYPE_88A8;
997 * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
1000 * VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2
1001 * VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2
1003 * VF sends this message to enable or disable VLAN filtering. It also needs to
1004 * specify an ethertype. The VF knows which VLAN ethertypes are allowed and
1005 * whether or not it's allowed to enable/disable filtering via the
1006 * VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS message. The VF needs to
1007 * parse the virtchnl_vlan_caps.filtering fields to determine which, if any,
1008 * filtering messages are allowed.
1010 * For example, if the PF populates the virtchnl_vlan_caps.filtering in the
1011 * following manner the VF will be allowed to enable/disable 0x8100 and 0x88a8
1012 * outer VLAN filtering together. Note, that the VIRTCHNL_VLAN_ETHERTYPE_AND
1013 * means that all filtering ethertypes will to be enabled and disabled together
1014 * regardless of the request from the VF. This means that the underlying
1015 * hardware only supports VLAN filtering for all VLAN the specified ethertypes
1018 * virtchnl_vlan_caps.filtering.filtering_support.outer =
1019 * VIRTCHNL_VLAN_TOGGLE |
1020 * VIRTCHNL_VLAN_ETHERTYPE_8100 |
1021 * VIRTHCNL_VLAN_ETHERTYPE_88A8 |
1022 * VIRTCHNL_VLAN_ETHERTYPE_9100 |
1023 * VIRTCHNL_VLAN_ETHERTYPE_AND;
1025 * In order to enable outer VLAN filtering for 0x88a8 and 0x8100 VLANs (0x9100
1026 * VLANs aren't supported by the VF driver), the VF would populate the
1027 * virtchnl_vlan_setting structure in the following manner and send the
1028 * VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2. The same message format would be used
1029 * to disable outer VLAN filtering for 0x88a8 and 0x8100 VLANs, but the
1030 * VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2 opcode is used.
1032 * virtchnl_vlan_setting.outer_ethertype_setting =
1033 * VIRTCHNL_VLAN_ETHERTYPE_8100 |
1034 * VIRTCHNL_VLAN_ETHERTYPE_88A8;
1037 struct virtchnl_vlan_setting {
1038 u32 outer_ethertype_setting;
1039 u32 inner_ethertype_setting;
1044 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vlan_setting);
1046 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
1047 * VF sends VSI id and flags.
1048 * PF returns status code in retval.
1049 * Note: we assume that broadcast accept mode is always enabled.
1051 struct virtchnl_promisc_info {
1056 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info);
1058 #define FLAG_VF_UNICAST_PROMISC 0x00000001
1059 #define FLAG_VF_MULTICAST_PROMISC 0x00000002
1061 /* VIRTCHNL_OP_GET_STATS
1062 * VF sends this message to request stats for the selected VSI. VF uses
1063 * the virtchnl_queue_select struct to specify the VSI. The queue_id
1064 * field is ignored by the PF.
1066 * PF replies with struct virtchnl_eth_stats in an external buffer.
1069 struct virtchnl_eth_stats {
1070 u64 rx_bytes; /* received bytes */
1071 u64 rx_unicast; /* received unicast pkts */
1072 u64 rx_multicast; /* received multicast pkts */
1073 u64 rx_broadcast; /* received broadcast pkts */
1075 u64 rx_unknown_protocol;
1076 u64 tx_bytes; /* transmitted bytes */
1077 u64 tx_unicast; /* transmitted unicast pkts */
1078 u64 tx_multicast; /* transmitted multicast pkts */
1079 u64 tx_broadcast; /* transmitted broadcast pkts */
1084 /* VIRTCHNL_OP_CONFIG_RSS_KEY
1085 * VIRTCHNL_OP_CONFIG_RSS_LUT
1086 * VF sends these messages to configure RSS. Only supported if both PF
1087 * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
1088 * configuration negotiation. If this is the case, then the RSS fields in
1089 * the VF resource struct are valid.
1090 * Both the key and LUT are initialized to 0 by the PF, meaning that
1091 * RSS is effectively disabled until set up by the VF.
1093 struct virtchnl_rss_key {
1096 u8 key[1]; /* RSS hash key, packed bytes */
1099 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key);
1101 struct virtchnl_rss_lut {
1104 u8 lut[1]; /* RSS lookup table */
1107 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut);
1109 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS
1110 * VIRTCHNL_OP_SET_RSS_HENA
1111 * VF sends these messages to get and set the hash filter enable bits for RSS.
1112 * By default, the PF sets these to all possible traffic types that the
1113 * hardware supports. The VF can query this value if it wants to change the
1114 * traffic types that are hashed by the hardware.
1116 struct virtchnl_rss_hena {
1120 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena);
1122 /* Type of RSS algorithm */
1123 enum virtchnl_rss_algorithm {
1124 VIRTCHNL_RSS_ALG_TOEPLITZ_ASYMMETRIC = 0,
1125 VIRTCHNL_RSS_ALG_XOR_ASYMMETRIC = 1,
1126 VIRTCHNL_RSS_ALG_TOEPLITZ_SYMMETRIC = 2,
1127 VIRTCHNL_RSS_ALG_XOR_SYMMETRIC = 3,
1130 /* This is used by PF driver to enforce how many channels can be supported.
1131 * When ADQ_V2 capability is negotiated, it will allow 16 channels otherwise
1132 * PF driver will allow only max 4 channels
1134 #define VIRTCHNL_MAX_ADQ_CHANNELS 4
1135 #define VIRTCHNL_MAX_ADQ_V2_CHANNELS 16
1137 /* VIRTCHNL_OP_ENABLE_CHANNELS
1138 * VIRTCHNL_OP_DISABLE_CHANNELS
1139 * VF sends these messages to enable or disable channels based on
1140 * the user specified queue count and queue offset for each traffic class.
1141 * This struct encompasses all the information that the PF needs from
1142 * VF to create a channel.
1144 struct virtchnl_channel_info {
1145 u16 count; /* number of queues in a channel */
1146 u16 offset; /* queues in a channel start from 'offset' */
1151 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info);
1153 struct virtchnl_tc_info {
1156 struct virtchnl_channel_info list[1];
1159 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info);
1161 /* VIRTCHNL_ADD_CLOUD_FILTER
1162 * VIRTCHNL_DEL_CLOUD_FILTER
1163 * VF sends these messages to add or delete a cloud filter based on the
1164 * user specified match and action filters. These structures encompass
1165 * all the information that the PF needs from the VF to add/delete a
1169 struct virtchnl_l4_spec {
1170 u8 src_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
1171 u8 dst_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
1172 /* vlan_prio is part of this 16 bit field even from OS perspective
1173 * vlan_id:12 is actual vlan_id, then vlanid:bit14..12 is vlan_prio
1174 * in future, when decided to offload vlan_prio, pass that information
1175 * as part of the "vlan_id" field, Bit14..12
1178 __be16 pad; /* reserved for future use */
1185 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec);
1187 union virtchnl_flow_spec {
1188 struct virtchnl_l4_spec tcp_spec;
1189 u8 buffer[128]; /* reserved for future use */
1192 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec);
1194 enum virtchnl_action {
1196 VIRTCHNL_ACTION_DROP = 0,
1197 VIRTCHNL_ACTION_TC_REDIRECT,
1198 VIRTCHNL_ACTION_PASSTHRU,
1199 VIRTCHNL_ACTION_QUEUE,
1200 VIRTCHNL_ACTION_Q_REGION,
1201 VIRTCHNL_ACTION_MARK,
1202 VIRTCHNL_ACTION_COUNT,
1205 enum virtchnl_flow_type {
1207 VIRTCHNL_TCP_V4_FLOW = 0,
1208 VIRTCHNL_TCP_V6_FLOW,
1209 VIRTCHNL_UDP_V4_FLOW,
1210 VIRTCHNL_UDP_V6_FLOW,
1213 struct virtchnl_filter {
1214 union virtchnl_flow_spec data;
1215 union virtchnl_flow_spec mask;
1216 enum virtchnl_flow_type flow_type;
1217 enum virtchnl_action action;
1222 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter);
1224 /* VIRTCHNL_OP_DCF_GET_VSI_MAP
1225 * VF sends this message to get VSI mapping table.
1226 * PF responds with an indirect message containing VF's
1228 * The index of vf_vsi array is the logical VF ID, the
1229 * value of vf_vsi array is the VF's HW VSI ID with its
1230 * valid configuration.
1232 struct virtchnl_dcf_vsi_map {
1233 u16 pf_vsi; /* PF's HW VSI ID */
1234 u16 num_vfs; /* The actual number of VFs allocated */
1235 #define VIRTCHNL_DCF_VF_VSI_ID_S 0
1236 #define VIRTCHNL_DCF_VF_VSI_ID_M (0xFFF << VIRTCHNL_DCF_VF_VSI_ID_S)
1237 #define VIRTCHNL_DCF_VF_VSI_VALID BIT(15)
1241 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_dcf_vsi_map);
1243 #define PKG_NAME_SIZE 32
1246 struct pkg_version {
1253 VIRTCHNL_CHECK_STRUCT_LEN(4, pkg_version);
1255 struct virtchnl_pkg_info {
1256 struct pkg_version pkg_ver;
1258 char pkg_name[PKG_NAME_SIZE];
1262 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_pkg_info);
1264 /* VIRTCHNL_OP_DCF_VLAN_OFFLOAD
1265 * DCF negotiates the VIRTCHNL_VF_OFFLOAD_VLAN_V2 capability firstly to get
1266 * the double VLAN configuration, then DCF sends this message to configure the
1267 * outer or inner VLAN offloads (insertion and strip) for the target VF.
1269 struct virtchnl_dcf_vlan_offload {
1273 #define VIRTCHNL_DCF_VLAN_TYPE_S 0
1274 #define VIRTCHNL_DCF_VLAN_TYPE_M \
1275 (0x1 << VIRTCHNL_DCF_VLAN_TYPE_S)
1276 #define VIRTCHNL_DCF_VLAN_TYPE_INNER 0x0
1277 #define VIRTCHNL_DCF_VLAN_TYPE_OUTER 0x1
1278 #define VIRTCHNL_DCF_VLAN_INSERT_MODE_S 1
1279 #define VIRTCHNL_DCF_VLAN_INSERT_MODE_M \
1280 (0x7 << VIRTCHNL_DCF_VLAN_INSERT_MODE_S)
1281 #define VIRTCHNL_DCF_VLAN_INSERT_DISABLE 0x1
1282 #define VIRTCHNL_DCF_VLAN_INSERT_PORT_BASED 0x2
1283 #define VIRTCHNL_DCF_VLAN_INSERT_VIA_TX_DESC 0x3
1284 #define VIRTCHNL_DCF_VLAN_STRIP_MODE_S 4
1285 #define VIRTCHNL_DCF_VLAN_STRIP_MODE_M \
1286 (0x7 << VIRTCHNL_DCF_VLAN_STRIP_MODE_S)
1287 #define VIRTCHNL_DCF_VLAN_STRIP_DISABLE 0x1
1288 #define VIRTCHNL_DCF_VLAN_STRIP_ONLY 0x2
1289 #define VIRTCHNL_DCF_VLAN_STRIP_INTO_RX_DESC 0x3
1294 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_dcf_vlan_offload);
1296 struct virtchnl_supported_rxdids {
1297 u64 supported_rxdids;
1300 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_supported_rxdids);
1302 /* VIRTCHNL_OP_EVENT
1303 * PF sends this message to inform the VF driver of events that may affect it.
1304 * No direct response is expected from the VF, though it may generate other
1305 * messages in response to this one.
1307 enum virtchnl_event_codes {
1308 VIRTCHNL_EVENT_UNKNOWN = 0,
1309 VIRTCHNL_EVENT_LINK_CHANGE,
1310 VIRTCHNL_EVENT_RESET_IMPENDING,
1311 VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
1312 VIRTCHNL_EVENT_DCF_VSI_MAP_UPDATE,
1315 #define PF_EVENT_SEVERITY_INFO 0
1316 #define PF_EVENT_SEVERITY_ATTENTION 1
1317 #define PF_EVENT_SEVERITY_ACTION_REQUIRED 2
1318 #define PF_EVENT_SEVERITY_CERTAIN_DOOM 255
1320 struct virtchnl_pf_event {
1321 enum virtchnl_event_codes event;
1323 /* If the PF driver does not support the new speed reporting
1324 * capabilities then use link_event else use link_event_adv to
1325 * get the speed and link information. The ability to understand
1326 * new speeds is indicated by setting the capability flag
1327 * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter
1328 * in virtchnl_vf_resource struct and can be used to determine
1329 * which link event struct to use below.
1332 enum virtchnl_link_speed link_speed;
1336 /* link_speed provided in Mbps */
1349 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event);
1352 /* VF reset states - these are written into the RSTAT register:
1353 * VFGEN_RSTAT on the VF
1354 * When the PF initiates a reset, it writes 0
1355 * When the reset is complete, it writes 1
1356 * When the PF detects that the VF has recovered, it writes 2
1357 * VF checks this register periodically to determine if a reset has occurred,
1358 * then polls it to know when the reset is complete.
1359 * If either the PF or VF reads the register while the hardware
1360 * is in a reset state, it will return DEADBEEF, which, when masked
1363 enum virtchnl_vfr_states {
1364 VIRTCHNL_VFR_INPROGRESS = 0,
1365 VIRTCHNL_VFR_COMPLETED,
1366 VIRTCHNL_VFR_VFACTIVE,
1369 #define VIRTCHNL_MAX_NUM_PROTO_HDRS 32
1370 #define PROTO_HDR_SHIFT 5
1371 #define PROTO_HDR_FIELD_START(proto_hdr_type) \
1372 (proto_hdr_type << PROTO_HDR_SHIFT)
1373 #define PROTO_HDR_FIELD_MASK ((1UL << PROTO_HDR_SHIFT) - 1)
1375 /* VF use these macros to configure each protocol header.
1376 * Specify which protocol headers and protocol header fields base on
1377 * virtchnl_proto_hdr_type and virtchnl_proto_hdr_field.
1378 * @param hdr: a struct of virtchnl_proto_hdr
1379 * @param hdr_type: ETH/IPV4/TCP, etc
1380 * @param field: SRC/DST/TEID/SPI, etc
1382 #define VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, field) \
1383 ((hdr)->field_selector |= BIT((field) & PROTO_HDR_FIELD_MASK))
1384 #define VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, field) \
1385 ((hdr)->field_selector &= ~BIT((field) & PROTO_HDR_FIELD_MASK))
1386 #define VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val) \
1387 ((hdr)->field_selector & BIT((val) & PROTO_HDR_FIELD_MASK))
1388 #define VIRTCHNL_GET_PROTO_HDR_FIELD(hdr) ((hdr)->field_selector)
1390 #define VIRTCHNL_ADD_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
1391 (VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, \
1392 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
1393 #define VIRTCHNL_DEL_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
1394 (VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, \
1395 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
1397 #define VIRTCHNL_SET_PROTO_HDR_TYPE(hdr, hdr_type) \
1398 ((hdr)->type = VIRTCHNL_PROTO_HDR_ ## hdr_type)
1399 #define VIRTCHNL_GET_PROTO_HDR_TYPE(hdr) \
1400 (((hdr)->type) >> PROTO_HDR_SHIFT)
1401 #define VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) \
1402 ((hdr)->type == ((val) >> PROTO_HDR_SHIFT))
1403 #define VIRTCHNL_TEST_PROTO_HDR(hdr, val) \
1404 (VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) && \
1405 VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val))
1407 /* Protocol header type within a packet segment. A segment consists of one or
1408 * more protocol headers that make up a logical group of protocol headers. Each
1409 * logical group of protocol headers encapsulates or is encapsulated using/by
1410 * tunneling or encapsulation protocols for network virtualization.
1412 enum virtchnl_proto_hdr_type {
1413 VIRTCHNL_PROTO_HDR_NONE,
1414 VIRTCHNL_PROTO_HDR_ETH,
1415 VIRTCHNL_PROTO_HDR_S_VLAN,
1416 VIRTCHNL_PROTO_HDR_C_VLAN,
1417 VIRTCHNL_PROTO_HDR_IPV4,
1418 VIRTCHNL_PROTO_HDR_IPV4_FRAG,
1419 VIRTCHNL_PROTO_HDR_IPV6,
1420 VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG,
1421 VIRTCHNL_PROTO_HDR_TCP,
1422 VIRTCHNL_PROTO_HDR_UDP,
1423 VIRTCHNL_PROTO_HDR_SCTP,
1424 VIRTCHNL_PROTO_HDR_GTPU_IP,
1425 VIRTCHNL_PROTO_HDR_GTPU_EH,
1426 VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_DWN,
1427 VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_UP,
1428 VIRTCHNL_PROTO_HDR_PPPOE,
1429 VIRTCHNL_PROTO_HDR_L2TPV3,
1430 VIRTCHNL_PROTO_HDR_ESP,
1431 VIRTCHNL_PROTO_HDR_AH,
1432 VIRTCHNL_PROTO_HDR_PFCP,
1433 VIRTCHNL_PROTO_HDR_GTPC,
1434 VIRTCHNL_PROTO_HDR_ECPRI,
1437 /* Protocol header field within a protocol header. */
1438 enum virtchnl_proto_hdr_field {
1440 VIRTCHNL_PROTO_HDR_ETH_SRC =
1441 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ETH),
1442 VIRTCHNL_PROTO_HDR_ETH_DST,
1443 VIRTCHNL_PROTO_HDR_ETH_ETHERTYPE,
1445 VIRTCHNL_PROTO_HDR_S_VLAN_ID =
1446 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_S_VLAN),
1448 VIRTCHNL_PROTO_HDR_C_VLAN_ID =
1449 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_C_VLAN),
1451 VIRTCHNL_PROTO_HDR_IPV4_SRC =
1452 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4),
1453 VIRTCHNL_PROTO_HDR_IPV4_DST,
1454 VIRTCHNL_PROTO_HDR_IPV4_DSCP,
1455 VIRTCHNL_PROTO_HDR_IPV4_TTL,
1456 VIRTCHNL_PROTO_HDR_IPV4_PROT,
1457 VIRTCHNL_PROTO_HDR_IPV4_FRAG_PKID =
1458 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4_FRAG),
1460 VIRTCHNL_PROTO_HDR_IPV6_SRC =
1461 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6),
1462 VIRTCHNL_PROTO_HDR_IPV6_DST,
1463 VIRTCHNL_PROTO_HDR_IPV6_TC,
1464 VIRTCHNL_PROTO_HDR_IPV6_HOP_LIMIT,
1465 VIRTCHNL_PROTO_HDR_IPV6_PROT,
1467 VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_SRC,
1468 VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_DST,
1469 VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_SRC,
1470 VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_DST,
1471 VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_SRC,
1472 VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_DST,
1473 VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_SRC,
1474 VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_DST,
1475 VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_SRC,
1476 VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_DST,
1477 VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_SRC,
1478 VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_DST,
1479 /* IPv6 Extension Header Fragment */
1480 VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG_PKID =
1481 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG),
1483 VIRTCHNL_PROTO_HDR_TCP_SRC_PORT =
1484 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_TCP),
1485 VIRTCHNL_PROTO_HDR_TCP_DST_PORT,
1487 VIRTCHNL_PROTO_HDR_UDP_SRC_PORT =
1488 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_UDP),
1489 VIRTCHNL_PROTO_HDR_UDP_DST_PORT,
1491 VIRTCHNL_PROTO_HDR_SCTP_SRC_PORT =
1492 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_SCTP),
1493 VIRTCHNL_PROTO_HDR_SCTP_DST_PORT,
1495 VIRTCHNL_PROTO_HDR_GTPU_IP_TEID =
1496 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_IP),
1498 VIRTCHNL_PROTO_HDR_GTPU_EH_PDU =
1499 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_EH),
1500 VIRTCHNL_PROTO_HDR_GTPU_EH_QFI,
1502 VIRTCHNL_PROTO_HDR_PPPOE_SESS_ID =
1503 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PPPOE),
1505 VIRTCHNL_PROTO_HDR_L2TPV3_SESS_ID =
1506 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_L2TPV3),
1508 VIRTCHNL_PROTO_HDR_ESP_SPI =
1509 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ESP),
1511 VIRTCHNL_PROTO_HDR_AH_SPI =
1512 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_AH),
1514 VIRTCHNL_PROTO_HDR_PFCP_S_FIELD =
1515 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PFCP),
1516 VIRTCHNL_PROTO_HDR_PFCP_SEID,
1518 VIRTCHNL_PROTO_HDR_GTPC_TEID =
1519 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPC),
1521 VIRTCHNL_PROTO_HDR_ECPRI_MSG_TYPE =
1522 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ECPRI),
1523 VIRTCHNL_PROTO_HDR_ECPRI_PC_RTC_ID,
1526 struct virtchnl_proto_hdr {
1527 enum virtchnl_proto_hdr_type type;
1528 u32 field_selector; /* a bit mask to select field for header type */
1531 * binary buffer in network order for specific header type.
1532 * For example, if type = VIRTCHNL_PROTO_HDR_IPV4, a IPv4
1533 * header is expected to be copied into the buffer.
1537 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_proto_hdr);
1539 struct virtchnl_proto_hdrs {
1542 * specify where protocol header start from.
1543 * 0 - from the outer layer
1544 * 1 - from the first inner layer
1545 * 2 - from the second inner layer
1548 int count; /* the proto layers must < VIRTCHNL_MAX_NUM_PROTO_HDRS */
1549 struct virtchnl_proto_hdr proto_hdr[VIRTCHNL_MAX_NUM_PROTO_HDRS];
1552 VIRTCHNL_CHECK_STRUCT_LEN(2312, virtchnl_proto_hdrs);
1554 struct virtchnl_rss_cfg {
1555 struct virtchnl_proto_hdrs proto_hdrs; /* protocol headers */
1556 enum virtchnl_rss_algorithm rss_algorithm; /* rss algorithm type */
1557 u8 reserved[128]; /* reserve for future */
1560 VIRTCHNL_CHECK_STRUCT_LEN(2444, virtchnl_rss_cfg);
1562 /* action configuration for FDIR */
1563 struct virtchnl_filter_action {
1564 enum virtchnl_action type;
1566 /* used for queue and qgroup action */
1571 /* used for count action */
1573 /* share counter ID with other flow rules */
1575 u32 id; /* counter ID */
1577 /* used for mark action */
1583 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_filter_action);
1585 #define VIRTCHNL_MAX_NUM_ACTIONS 8
1587 struct virtchnl_filter_action_set {
1588 /* action number must be less then VIRTCHNL_MAX_NUM_ACTIONS */
1590 struct virtchnl_filter_action actions[VIRTCHNL_MAX_NUM_ACTIONS];
1593 VIRTCHNL_CHECK_STRUCT_LEN(292, virtchnl_filter_action_set);
1595 /* pattern and action for FDIR rule */
1596 struct virtchnl_fdir_rule {
1597 struct virtchnl_proto_hdrs proto_hdrs;
1598 struct virtchnl_filter_action_set action_set;
1601 VIRTCHNL_CHECK_STRUCT_LEN(2604, virtchnl_fdir_rule);
1603 /* query information to retrieve fdir rule counters.
1604 * PF will fill out this structure to reset counter.
1606 struct virtchnl_fdir_query_info {
1607 u32 match_packets_valid:1;
1608 u32 match_bytes_valid:1;
1609 u32 reserved:30; /* Reserved, must be zero. */
1611 u64 matched_packets; /* Number of packets for this rule. */
1612 u64 matched_bytes; /* Number of bytes through this rule. */
1615 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_fdir_query_info);
1617 /* Status returned to VF after VF requests FDIR commands
1618 * VIRTCHNL_FDIR_SUCCESS
1619 * VF FDIR related request is successfully done by PF
1620 * The request can be OP_ADD/DEL/QUERY_FDIR_FILTER.
1622 * VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE
1623 * OP_ADD_FDIR_FILTER request is failed due to no Hardware resource.
1625 * VIRTCHNL_FDIR_FAILURE_RULE_EXIST
1626 * OP_ADD_FDIR_FILTER request is failed due to the rule is already existed.
1628 * VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT
1629 * OP_ADD_FDIR_FILTER request is failed due to conflict with existing rule.
1631 * VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST
1632 * OP_DEL_FDIR_FILTER request is failed due to this rule doesn't exist.
1634 * VIRTCHNL_FDIR_FAILURE_RULE_INVALID
1635 * OP_ADD_FDIR_FILTER request is failed due to parameters validation
1636 * or HW doesn't support.
1638 * VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT
1639 * OP_ADD/DEL_FDIR_FILTER request is failed due to timing out
1642 * VIRTCHNL_FDIR_FAILURE_QUERY_INVALID
1643 * OP_QUERY_FDIR_FILTER request is failed due to parameters validation,
1644 * for example, VF query counter of a rule who has no counter action.
1646 enum virtchnl_fdir_prgm_status {
1647 VIRTCHNL_FDIR_SUCCESS = 0,
1648 VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE,
1649 VIRTCHNL_FDIR_FAILURE_RULE_EXIST,
1650 VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT,
1651 VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST,
1652 VIRTCHNL_FDIR_FAILURE_RULE_INVALID,
1653 VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT,
1654 VIRTCHNL_FDIR_FAILURE_QUERY_INVALID,
1657 /* VIRTCHNL_OP_ADD_FDIR_FILTER
1658 * VF sends this request to PF by filling out vsi_id,
1659 * validate_only and rule_cfg. PF will return flow_id
1660 * if the request is successfully done and return add_status to VF.
1662 struct virtchnl_fdir_add {
1663 u16 vsi_id; /* INPUT */
1665 * 1 for validating a fdir rule, 0 for creating a fdir rule.
1666 * Validate and create share one ops: VIRTCHNL_OP_ADD_FDIR_FILTER.
1668 u16 validate_only; /* INPUT */
1669 u32 flow_id; /* OUTPUT */
1670 struct virtchnl_fdir_rule rule_cfg; /* INPUT */
1671 enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1674 VIRTCHNL_CHECK_STRUCT_LEN(2616, virtchnl_fdir_add);
1676 /* VIRTCHNL_OP_DEL_FDIR_FILTER
1677 * VF sends this request to PF by filling out vsi_id
1678 * and flow_id. PF will return del_status to VF.
1680 struct virtchnl_fdir_del {
1681 u16 vsi_id; /* INPUT */
1683 u32 flow_id; /* INPUT */
1684 enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1687 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_fdir_del);
1689 /* VIRTCHNL_OP_QUERY_FDIR_FILTER
1690 * VF sends this request to PF by filling out vsi_id,
1691 * flow_id and reset_counter. PF will return query_info
1692 * and query_status to VF.
1694 struct virtchnl_fdir_query {
1695 u16 vsi_id; /* INPUT */
1697 u32 flow_id; /* INPUT */
1698 u32 reset_counter:1; /* INPUT */
1699 struct virtchnl_fdir_query_info query_info; /* OUTPUT */
1700 enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1704 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_fdir_query);
1706 /* TX and RX queue types are valid in legacy as well as split queue models.
1707 * With Split Queue model, 2 additional types are introduced - TX_COMPLETION
1708 * and RX_BUFFER. In split queue model, RX corresponds to the queue where HW
1709 * posts completions.
1711 enum virtchnl_queue_type {
1712 VIRTCHNL_QUEUE_TYPE_TX = 0,
1713 VIRTCHNL_QUEUE_TYPE_RX = 1,
1714 VIRTCHNL_QUEUE_TYPE_TX_COMPLETION = 2,
1715 VIRTCHNL_QUEUE_TYPE_RX_BUFFER = 3,
1716 VIRTCHNL_QUEUE_TYPE_CONFIG_TX = 4,
1717 VIRTCHNL_QUEUE_TYPE_CONFIG_RX = 5
1721 /* structure to specify a chunk of contiguous queues */
1722 struct virtchnl_queue_chunk {
1723 enum virtchnl_queue_type type;
1728 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_queue_chunk);
1730 /* structure to specify several chunks of contiguous queues */
1731 struct virtchnl_queue_chunks {
1734 struct virtchnl_queue_chunk chunks[1];
1737 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_chunks);
1740 /* VIRTCHNL_OP_ENABLE_QUEUES_V2
1741 * VIRTCHNL_OP_DISABLE_QUEUES_V2
1742 * VIRTCHNL_OP_DEL_QUEUES
1744 * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1745 * then all of these ops are available.
1747 * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1748 * then VIRTCHNL_OP_ENABLE_QUEUES_V2 and VIRTCHNL_OP_DISABLE_QUEUES_V2 are
1751 * PF sends these messages to enable, disable or delete queues specified in
1752 * chunks. PF sends virtchnl_del_ena_dis_queues struct to specify the queues
1753 * to be enabled/disabled/deleted. Also applicable to single queue RX or
1754 * TX. CP performs requested action and returns status.
1756 struct virtchnl_del_ena_dis_queues {
1759 struct virtchnl_queue_chunks chunks;
1762 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_del_ena_dis_queues);
1764 /* Virtchannel interrupt throttling rate index */
1765 enum virtchnl_itr_idx {
1766 VIRTCHNL_ITR_IDX_0 = 0,
1767 VIRTCHNL_ITR_IDX_1 = 1,
1768 VIRTCHNL_ITR_IDX_NO_ITR = 3,
1771 /* Queue to vector mapping */
1772 struct virtchnl_queue_vector {
1776 enum virtchnl_itr_idx itr_idx;
1777 enum virtchnl_queue_type queue_type;
1780 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_queue_vector);
1782 /* VIRTCHNL_OP_MAP_QUEUE_VECTOR
1783 * VIRTCHNL_OP_UNMAP_QUEUE_VECTOR
1785 * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1786 * then all of these ops are available.
1788 * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1789 * then only VIRTCHNL_OP_MAP_QUEUE_VECTOR is available.
1791 * PF sends this message to map or unmap queues to vectors and ITR index
1792 * registers. External data buffer contains virtchnl_queue_vector_maps structure
1793 * that contains num_qv_maps of virtchnl_queue_vector structures.
1794 * CP maps the requested queue vector maps after validating the queue and vector
1795 * ids and returns a status code.
1797 struct virtchnl_queue_vector_maps {
1801 struct virtchnl_queue_vector qv_maps[1];
1804 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_queue_vector_maps);
1807 /* Since VF messages are limited by u16 size, precalculate the maximum possible
1808 * values of nested elements in virtchnl structures that virtual channel can
1809 * possibly handle in a single message.
1811 enum virtchnl_vector_limits {
1812 VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX =
1813 ((u16)(~0) - sizeof(struct virtchnl_vsi_queue_config_info)) /
1814 sizeof(struct virtchnl_queue_pair_info),
1816 VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX =
1817 ((u16)(~0) - sizeof(struct virtchnl_irq_map_info)) /
1818 sizeof(struct virtchnl_vector_map),
1820 VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX =
1821 ((u16)(~0) - sizeof(struct virtchnl_ether_addr_list)) /
1822 sizeof(struct virtchnl_ether_addr),
1824 VIRTCHNL_OP_ADD_DEL_VLAN_MAX =
1825 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list)) /
1829 VIRTCHNL_OP_ENABLE_CHANNELS_MAX =
1830 ((u16)(~0) - sizeof(struct virtchnl_tc_info)) /
1831 sizeof(struct virtchnl_channel_info),
1833 VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX =
1834 ((u16)(~0) - sizeof(struct virtchnl_del_ena_dis_queues)) /
1835 sizeof(struct virtchnl_queue_chunk),
1837 VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX =
1838 ((u16)(~0) - sizeof(struct virtchnl_queue_vector_maps)) /
1839 sizeof(struct virtchnl_queue_vector),
1841 VIRTCHNL_OP_ADD_DEL_VLAN_V2_MAX =
1842 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list_v2)) /
1843 sizeof(struct virtchnl_vlan_filter),
1847 * virtchnl_vc_validate_vf_msg
1848 * @ver: Virtchnl version info
1849 * @v_opcode: Opcode for the message
1850 * @msg: pointer to the msg buffer
1851 * @msglen: msg length
1853 * validate msg format against struct for each opcode
1856 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode,
1857 u8 *msg, u16 msglen)
1859 bool err_msg_format = false;
1862 /* Validate message length. */
1864 case VIRTCHNL_OP_VERSION:
1865 valid_len = sizeof(struct virtchnl_version_info);
1867 case VIRTCHNL_OP_RESET_VF:
1869 case VIRTCHNL_OP_GET_VF_RESOURCES:
1871 valid_len = sizeof(u32);
1873 case VIRTCHNL_OP_CONFIG_TX_QUEUE:
1874 valid_len = sizeof(struct virtchnl_txq_info);
1876 case VIRTCHNL_OP_CONFIG_RX_QUEUE:
1877 valid_len = sizeof(struct virtchnl_rxq_info);
1879 case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
1880 valid_len = sizeof(struct virtchnl_vsi_queue_config_info);
1881 if (msglen >= valid_len) {
1882 struct virtchnl_vsi_queue_config_info *vqc =
1883 (struct virtchnl_vsi_queue_config_info *)msg;
1885 if (vqc->num_queue_pairs == 0 || vqc->num_queue_pairs >
1886 VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX) {
1887 err_msg_format = true;
1891 valid_len += (vqc->num_queue_pairs *
1893 virtchnl_queue_pair_info));
1896 case VIRTCHNL_OP_CONFIG_IRQ_MAP:
1897 valid_len = sizeof(struct virtchnl_irq_map_info);
1898 if (msglen >= valid_len) {
1899 struct virtchnl_irq_map_info *vimi =
1900 (struct virtchnl_irq_map_info *)msg;
1902 if (vimi->num_vectors == 0 || vimi->num_vectors >
1903 VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX) {
1904 err_msg_format = true;
1908 valid_len += (vimi->num_vectors *
1909 sizeof(struct virtchnl_vector_map));
1912 case VIRTCHNL_OP_ENABLE_QUEUES:
1913 case VIRTCHNL_OP_DISABLE_QUEUES:
1914 valid_len = sizeof(struct virtchnl_queue_select);
1916 case VIRTCHNL_OP_GET_MAX_RSS_QREGION:
1918 case VIRTCHNL_OP_ADD_ETH_ADDR:
1919 case VIRTCHNL_OP_DEL_ETH_ADDR:
1920 valid_len = sizeof(struct virtchnl_ether_addr_list);
1921 if (msglen >= valid_len) {
1922 struct virtchnl_ether_addr_list *veal =
1923 (struct virtchnl_ether_addr_list *)msg;
1925 if (veal->num_elements == 0 || veal->num_elements >
1926 VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX) {
1927 err_msg_format = true;
1931 valid_len += veal->num_elements *
1932 sizeof(struct virtchnl_ether_addr);
1935 case VIRTCHNL_OP_ADD_VLAN:
1936 case VIRTCHNL_OP_DEL_VLAN:
1937 valid_len = sizeof(struct virtchnl_vlan_filter_list);
1938 if (msglen >= valid_len) {
1939 struct virtchnl_vlan_filter_list *vfl =
1940 (struct virtchnl_vlan_filter_list *)msg;
1942 if (vfl->num_elements == 0 || vfl->num_elements >
1943 VIRTCHNL_OP_ADD_DEL_VLAN_MAX) {
1944 err_msg_format = true;
1948 valid_len += vfl->num_elements * sizeof(u16);
1951 case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
1952 valid_len = sizeof(struct virtchnl_promisc_info);
1954 case VIRTCHNL_OP_GET_STATS:
1955 valid_len = sizeof(struct virtchnl_queue_select);
1957 case VIRTCHNL_OP_CONFIG_RSS_KEY:
1958 valid_len = sizeof(struct virtchnl_rss_key);
1959 if (msglen >= valid_len) {
1960 struct virtchnl_rss_key *vrk =
1961 (struct virtchnl_rss_key *)msg;
1963 if (vrk->key_len == 0) {
1964 /* zero length is allowed as input */
1968 valid_len += vrk->key_len - 1;
1971 case VIRTCHNL_OP_CONFIG_RSS_LUT:
1972 valid_len = sizeof(struct virtchnl_rss_lut);
1973 if (msglen >= valid_len) {
1974 struct virtchnl_rss_lut *vrl =
1975 (struct virtchnl_rss_lut *)msg;
1977 if (vrl->lut_entries == 0) {
1978 /* zero entries is allowed as input */
1982 valid_len += vrl->lut_entries - 1;
1985 case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
1987 case VIRTCHNL_OP_SET_RSS_HENA:
1988 valid_len = sizeof(struct virtchnl_rss_hena);
1990 case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
1991 case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
1993 case VIRTCHNL_OP_REQUEST_QUEUES:
1994 valid_len = sizeof(struct virtchnl_vf_res_request);
1996 case VIRTCHNL_OP_ENABLE_CHANNELS:
1997 valid_len = sizeof(struct virtchnl_tc_info);
1998 if (msglen >= valid_len) {
1999 struct virtchnl_tc_info *vti =
2000 (struct virtchnl_tc_info *)msg;
2002 if (vti->num_tc == 0 || vti->num_tc >
2003 VIRTCHNL_OP_ENABLE_CHANNELS_MAX) {
2004 err_msg_format = true;
2008 valid_len += (vti->num_tc - 1) *
2009 sizeof(struct virtchnl_channel_info);
2012 case VIRTCHNL_OP_DISABLE_CHANNELS:
2014 case VIRTCHNL_OP_ADD_CLOUD_FILTER:
2015 case VIRTCHNL_OP_DEL_CLOUD_FILTER:
2016 valid_len = sizeof(struct virtchnl_filter);
2018 case VIRTCHNL_OP_DCF_VLAN_OFFLOAD:
2019 valid_len = sizeof(struct virtchnl_dcf_vlan_offload);
2021 case VIRTCHNL_OP_DCF_CMD_DESC:
2022 case VIRTCHNL_OP_DCF_CMD_BUFF:
2023 /* These two opcodes are specific to handle the AdminQ command,
2024 * so the validation needs to be done in PF's context.
2028 case VIRTCHNL_OP_DCF_DISABLE:
2029 case VIRTCHNL_OP_DCF_GET_VSI_MAP:
2030 case VIRTCHNL_OP_DCF_GET_PKG_INFO:
2032 case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
2034 case VIRTCHNL_OP_ADD_RSS_CFG:
2035 case VIRTCHNL_OP_DEL_RSS_CFG:
2036 valid_len = sizeof(struct virtchnl_rss_cfg);
2038 case VIRTCHNL_OP_ADD_FDIR_FILTER:
2039 valid_len = sizeof(struct virtchnl_fdir_add);
2041 case VIRTCHNL_OP_DEL_FDIR_FILTER:
2042 valid_len = sizeof(struct virtchnl_fdir_del);
2044 case VIRTCHNL_OP_QUERY_FDIR_FILTER:
2045 valid_len = sizeof(struct virtchnl_fdir_query);
2047 case VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS:
2049 case VIRTCHNL_OP_ADD_VLAN_V2:
2050 case VIRTCHNL_OP_DEL_VLAN_V2:
2051 valid_len = sizeof(struct virtchnl_vlan_filter_list_v2);
2052 if (msglen >= valid_len) {
2053 struct virtchnl_vlan_filter_list_v2 *vfl =
2054 (struct virtchnl_vlan_filter_list_v2 *)msg;
2056 if (vfl->num_elements == 0 || vfl->num_elements >
2057 VIRTCHNL_OP_ADD_DEL_VLAN_V2_MAX) {
2058 err_msg_format = true;
2062 valid_len += (vfl->num_elements - 1) *
2063 sizeof(struct virtchnl_vlan_filter);
2066 case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2:
2067 case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2:
2068 case VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2:
2069 case VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2:
2070 case VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2:
2071 case VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2:
2072 valid_len = sizeof(struct virtchnl_vlan_setting);
2074 case VIRTCHNL_OP_ENABLE_QUEUES_V2:
2075 case VIRTCHNL_OP_DISABLE_QUEUES_V2:
2076 valid_len = sizeof(struct virtchnl_del_ena_dis_queues);
2077 if (msglen >= valid_len) {
2078 struct virtchnl_del_ena_dis_queues *qs =
2079 (struct virtchnl_del_ena_dis_queues *)msg;
2080 if (qs->chunks.num_chunks == 0 ||
2081 qs->chunks.num_chunks > VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX) {
2082 err_msg_format = true;
2085 valid_len += (qs->chunks.num_chunks - 1) *
2086 sizeof(struct virtchnl_queue_chunk);
2089 case VIRTCHNL_OP_MAP_QUEUE_VECTOR:
2090 valid_len = sizeof(struct virtchnl_queue_vector_maps);
2091 if (msglen >= valid_len) {
2092 struct virtchnl_queue_vector_maps *v_qp =
2093 (struct virtchnl_queue_vector_maps *)msg;
2094 if (v_qp->num_qv_maps == 0 ||
2095 v_qp->num_qv_maps > VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX) {
2096 err_msg_format = true;
2099 valid_len += (v_qp->num_qv_maps - 1) *
2100 sizeof(struct virtchnl_queue_vector);
2103 /* These are always errors coming from the VF. */
2104 case VIRTCHNL_OP_EVENT:
2105 case VIRTCHNL_OP_UNKNOWN:
2107 return VIRTCHNL_STATUS_ERR_PARAM;
2109 /* few more checks */
2110 if (err_msg_format || valid_len != msglen)
2111 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH;
2115 #endif /* _VIRTCHNL_H_ */