1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2001-2020 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, 37 and 38 are reserved */
132 VIRTCHNL_OP_DCF_CMD_DESC = 39,
133 VIRTCHNL_OP_DCF_CMD_BUFF = 40,
134 VIRTCHNL_OP_DCF_DISABLE = 41,
135 VIRTCHNL_OP_DCF_GET_VSI_MAP = 42,
136 VIRTCHNL_OP_DCF_GET_PKG_INFO = 43,
137 VIRTCHNL_OP_GET_SUPPORTED_RXDIDS = 44,
138 VIRTCHNL_OP_ADD_RSS_CFG = 45,
139 VIRTCHNL_OP_DEL_RSS_CFG = 46,
140 VIRTCHNL_OP_ADD_FDIR_FILTER = 47,
141 VIRTCHNL_OP_DEL_FDIR_FILTER = 48,
142 VIRTCHNL_OP_QUERY_FDIR_FILTER = 49,
143 VIRTCHNL_OP_GET_MAX_RSS_QREGION = 50,
144 VIRTCHNL_OP_ENABLE_QUEUES_V2 = 107,
145 VIRTCHNL_OP_DISABLE_QUEUES_V2 = 108,
146 VIRTCHNL_OP_MAP_QUEUE_VECTOR = 111,
150 /* These macros are used to generate compilation errors if a structure/union
151 * is not exactly the correct length. It gives a divide by zero error if the
152 * structure/union is not of the correct size, otherwise it creates an enum
153 * that is never used.
155 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \
156 { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) }
157 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \
158 { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) }
160 /* Virtual channel message descriptor. This overlays the admin queue
161 * descriptor. All other data is passed in external buffers.
164 struct virtchnl_msg {
165 u8 pad[8]; /* AQ flags/opcode/len/retval fields */
166 enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
167 enum virtchnl_status_code v_retval; /* ditto for desc->retval */
168 u32 vfid; /* used by PF when sending to VF */
171 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg);
173 /* Message descriptions and data structures. */
175 /* VIRTCHNL_OP_VERSION
176 * VF posts its version number to the PF. PF responds with its version number
177 * in the same format, along with a return code.
178 * Reply from PF has its major/minor versions also in param0 and param1.
179 * If there is a major version mismatch, then the VF cannot operate.
180 * If there is a minor version mismatch, then the VF can operate but should
181 * add a warning to the system log.
183 * This enum element MUST always be specified as == 1, regardless of other
184 * changes in the API. The PF must always respond to this message without
185 * error regardless of version mismatch.
187 #define VIRTCHNL_VERSION_MAJOR 1
188 #define VIRTCHNL_VERSION_MINOR 1
189 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0
191 struct virtchnl_version_info {
196 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info);
198 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0))
199 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1))
201 /* VIRTCHNL_OP_RESET_VF
202 * VF sends this request to PF with no parameters
203 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
204 * until reset completion is indicated. The admin queue must be reinitialized
205 * after this operation.
207 * When reset is complete, PF must ensure that all queues in all VSIs associated
208 * with the VF are stopped, all queue configurations in the HMC are set to 0,
209 * and all MAC and VLAN filters (except the default MAC address) on all VSIs
213 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV
214 * vsi_type should always be 6 for backward compatibility. Add other fields
217 enum virtchnl_vsi_type {
218 VIRTCHNL_VSI_TYPE_INVALID = 0,
219 VIRTCHNL_VSI_SRIOV = 6,
222 /* VIRTCHNL_OP_GET_VF_RESOURCES
223 * Version 1.0 VF sends this request to PF with no parameters
224 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
225 * PF responds with an indirect message containing
226 * virtchnl_vf_resource and one or more
227 * virtchnl_vsi_resource structures.
230 struct virtchnl_vsi_resource {
233 enum virtchnl_vsi_type vsi_type;
235 u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
238 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource);
240 /* VF capability flags
241 * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including
242 * TX/RX Checksum offloading and TSO for non-tunnelled packets.
244 #define VIRTCHNL_VF_OFFLOAD_L2 0x00000001
245 #define VIRTCHNL_VF_OFFLOAD_IWARP 0x00000002
246 #define VIRTCHNL_VF_OFFLOAD_RSVD 0x00000004
247 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ 0x00000008
248 #define VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010
249 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020
250 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES 0x00000040
251 #define VIRTCHNL_VF_OFFLOAD_CRC 0x00000080
252 /* 0X00000100 is reserved */
253 #define VIRTCHNL_VF_LARGE_NUM_QPAIRS 0x00000200
254 #define VIRTCHNL_VF_OFFLOAD_VLAN 0x00010000
255 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING 0x00020000
256 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2 0x00040000
257 #define VIRTCHNL_VF_OFFLOAD_RSS_PF 0X00080000
258 #define VIRTCHNL_VF_OFFLOAD_ENCAP 0X00100000
259 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM 0X00200000
260 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM 0X00400000
261 #define VIRTCHNL_VF_OFFLOAD_ADQ 0X00800000
262 #define VIRTCHNL_VF_OFFLOAD_ADQ_V2 0X01000000
263 #define VIRTCHNL_VF_OFFLOAD_USO 0X02000000
264 #define VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC 0X04000000
265 #define VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF 0X08000000
266 #define VIRTCHNL_VF_OFFLOAD_FDIR_PF 0X10000000
267 /* 0X20000000 is reserved */
268 #define VIRTCHNL_VF_CAP_DCF 0X40000000
269 /* 0X80000000 is reserved */
271 /* Define below the capability flags that are not offloads */
272 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED 0x00000080
273 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \
274 VIRTCHNL_VF_OFFLOAD_VLAN | \
275 VIRTCHNL_VF_OFFLOAD_RSS_PF)
277 struct virtchnl_vf_resource {
287 struct virtchnl_vsi_resource vsi_res[1];
290 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource);
292 /* VIRTCHNL_OP_CONFIG_TX_QUEUE
293 * VF sends this message to set up parameters for one TX queue.
294 * External data buffer contains one instance of virtchnl_txq_info.
295 * PF configures requested queue and returns a status code.
298 /* Tx queue config info */
299 struct virtchnl_txq_info {
302 u16 ring_len; /* number of descriptors, multiple of 8 */
303 u16 headwb_enabled; /* deprecated with AVF 1.0 */
305 u64 dma_headwb_addr; /* deprecated with AVF 1.0 */
308 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info);
310 /* VIRTCHNL_OP_CONFIG_RX_QUEUE
311 * VF sends this message to set up parameters for one RX queue.
312 * External data buffer contains one instance of virtchnl_rxq_info.
313 * PF configures requested queue and returns a status code. The
314 * crc_disable flag disables CRC stripping on the VF. Setting
315 * the crc_disable flag to 1 will disable CRC stripping for each
316 * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC
317 * offload must have been set prior to sending this info or the PF
318 * will ignore the request. This flag should be set the same for
319 * all of the queues for a VF.
322 /* Rx queue config info */
323 struct virtchnl_rxq_info {
326 u32 ring_len; /* number of descriptors, multiple of 32 */
328 u16 splithdr_enabled; /* deprecated with AVF 1.0 */
332 /* only used when VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC is supported */
336 enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */
340 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info);
342 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES
343 * VF sends this message to set parameters for active TX and RX queues
344 * associated with the specified VSI.
345 * PF configures queues and returns status.
346 * If the number of queues specified is greater than the number of queues
347 * associated with the VSI, an error is returned and no queues are configured.
348 * NOTE: The VF is not required to configure all queues in a single request.
349 * It may send multiple messages. PF drivers must correctly handle all VF
352 struct virtchnl_queue_pair_info {
353 /* NOTE: vsi_id and queue_id should be identical for both queues. */
354 struct virtchnl_txq_info txq;
355 struct virtchnl_rxq_info rxq;
358 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info);
360 struct virtchnl_vsi_queue_config_info {
364 struct virtchnl_queue_pair_info qpair[1];
367 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info);
369 /* VIRTCHNL_OP_REQUEST_QUEUES
370 * VF sends this message to request the PF to allocate additional queues to
371 * this VF. Each VF gets a guaranteed number of queues on init but asking for
372 * additional queues must be negotiated. This is a best effort request as it
373 * is possible the PF does not have enough queues left to support the request.
374 * If the PF cannot support the number requested it will respond with the
375 * maximum number it is able to support. If the request is successful, PF will
376 * then reset the VF to institute required changes.
379 /* VF resource request */
380 struct virtchnl_vf_res_request {
384 /* VIRTCHNL_OP_CONFIG_IRQ_MAP
385 * VF uses this message to map vectors to queues.
386 * The rxq_map and txq_map fields are bitmaps used to indicate which queues
387 * are to be associated with the specified vector.
388 * The "other" causes are always mapped to vector 0. The VF may not request
389 * that vector 0 be used for traffic.
390 * PF configures interrupt mapping and returns status.
391 * NOTE: due to hardware requirements, all active queues (both TX and RX)
392 * should be mapped to interrupts, even if the driver intends to operate
393 * only in polling mode. In this case the interrupt may be disabled, but
394 * the ITR timer will still run to trigger writebacks.
396 struct virtchnl_vector_map {
405 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map);
407 struct virtchnl_irq_map_info {
409 struct virtchnl_vector_map vecmap[1];
412 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info);
414 /* VIRTCHNL_OP_ENABLE_QUEUES
415 * VIRTCHNL_OP_DISABLE_QUEUES
416 * VF sends these message to enable or disable TX/RX queue pairs.
417 * The queues fields are bitmaps indicating which queues to act upon.
418 * (Currently, we only support 16 queues per VF, but we make the field
419 * u32 to allow for expansion.)
420 * PF performs requested action and returns status.
421 * NOTE: The VF is not required to enable/disable all queues in a single
422 * request. It may send multiple messages.
423 * PF drivers must correctly handle all VF requests.
425 struct virtchnl_queue_select {
432 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select);
434 /* VIRTCHNL_OP_GET_MAX_RSS_QREGION
436 * if VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
437 * then this op must be supported.
439 * VF sends this message in order to query the max RSS queue region
440 * size supported by PF, when VIRTCHNL_VF_LARGE_NUM_QPAIRS is enabled.
441 * This information should be used when configuring the RSS LUT and/or
442 * configuring queue region based filters.
444 * The maximum RSS queue region is 2^qregion_width. So, a qregion_width
445 * of 6 would inform the VF that the PF supports a maximum RSS queue region
448 * A queue region represents a range of queues that can be used to configure
449 * a RSS LUT. For example, if a VF is given 64 queues, but only a max queue
450 * region size of 16 (i.e. 2^qregion_width = 16) then it will only be able
451 * to configure the RSS LUT with queue indices from 0 to 15. However, other
452 * filters can be used to direct packets to queues >15 via specifying a queue
453 * base/offset and queue region width.
455 struct virtchnl_max_rss_qregion {
461 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_max_rss_qregion);
463 /* VIRTCHNL_OP_ADD_ETH_ADDR
464 * VF sends this message in order to add one or more unicast or multicast
465 * address filters for the specified VSI.
466 * PF adds the filters and returns status.
469 /* VIRTCHNL_OP_DEL_ETH_ADDR
470 * VF sends this message in order to remove one or more unicast or multicast
471 * filters for the specified VSI.
472 * PF removes the filters and returns status.
475 /* VIRTCHNL_ETHER_ADDR_LEGACY
476 * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad
477 * bytes. Moving forward all VF drivers should not set type to
478 * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy
479 * behavior. The control plane function (i.e. PF) can use a best effort method
480 * of tracking the primary/device unicast in this case, but there is no
481 * guarantee and functionality depends on the implementation of the PF.
484 /* VIRTCHNL_ETHER_ADDR_PRIMARY
485 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the
486 * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and
487 * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane
488 * function (i.e. PF) to accurately track and use this MAC address for
489 * displaying on the host and for VM/function reset.
492 /* VIRTCHNL_ETHER_ADDR_EXTRA
493 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra
494 * unicast and/or multicast filters that are being added/deleted via
495 * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively.
497 struct virtchnl_ether_addr {
498 u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
500 #define VIRTCHNL_ETHER_ADDR_LEGACY 0
501 #define VIRTCHNL_ETHER_ADDR_PRIMARY 1
502 #define VIRTCHNL_ETHER_ADDR_EXTRA 2
503 #define VIRTCHNL_ETHER_ADDR_TYPE_MASK 3 /* first two bits of type are valid */
507 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr);
509 struct virtchnl_ether_addr_list {
512 struct virtchnl_ether_addr list[1];
515 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list);
517 /* VIRTCHNL_OP_ADD_VLAN
518 * VF sends this message to add one or more VLAN tag filters for receives.
519 * PF adds the filters and returns status.
520 * If a port VLAN is configured by the PF, this operation will return an
524 /* VIRTCHNL_OP_DEL_VLAN
525 * VF sends this message to remove one or more VLAN tag filters for receives.
526 * PF removes the filters and returns status.
527 * If a port VLAN is configured by the PF, this operation will return an
531 struct virtchnl_vlan_filter_list {
537 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list);
539 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
540 * VF sends VSI id and flags.
541 * PF returns status code in retval.
542 * Note: we assume that broadcast accept mode is always enabled.
544 struct virtchnl_promisc_info {
549 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info);
551 #define FLAG_VF_UNICAST_PROMISC 0x00000001
552 #define FLAG_VF_MULTICAST_PROMISC 0x00000002
554 /* VIRTCHNL_OP_GET_STATS
555 * VF sends this message to request stats for the selected VSI. VF uses
556 * the virtchnl_queue_select struct to specify the VSI. The queue_id
557 * field is ignored by the PF.
559 * PF replies with struct virtchnl_eth_stats in an external buffer.
562 struct virtchnl_eth_stats {
563 u64 rx_bytes; /* received bytes */
564 u64 rx_unicast; /* received unicast pkts */
565 u64 rx_multicast; /* received multicast pkts */
566 u64 rx_broadcast; /* received broadcast pkts */
568 u64 rx_unknown_protocol;
569 u64 tx_bytes; /* transmitted bytes */
570 u64 tx_unicast; /* transmitted unicast pkts */
571 u64 tx_multicast; /* transmitted multicast pkts */
572 u64 tx_broadcast; /* transmitted broadcast pkts */
577 /* VIRTCHNL_OP_CONFIG_RSS_KEY
578 * VIRTCHNL_OP_CONFIG_RSS_LUT
579 * VF sends these messages to configure RSS. Only supported if both PF
580 * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
581 * configuration negotiation. If this is the case, then the RSS fields in
582 * the VF resource struct are valid.
583 * Both the key and LUT are initialized to 0 by the PF, meaning that
584 * RSS is effectively disabled until set up by the VF.
586 struct virtchnl_rss_key {
589 u8 key[1]; /* RSS hash key, packed bytes */
592 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key);
594 struct virtchnl_rss_lut {
597 u8 lut[1]; /* RSS lookup table */
600 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut);
602 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS
603 * VIRTCHNL_OP_SET_RSS_HENA
604 * VF sends these messages to get and set the hash filter enable bits for RSS.
605 * By default, the PF sets these to all possible traffic types that the
606 * hardware supports. The VF can query this value if it wants to change the
607 * traffic types that are hashed by the hardware.
609 struct virtchnl_rss_hena {
613 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena);
615 /* Type of RSS algorithm */
616 enum virtchnl_rss_algorithm {
617 VIRTCHNL_RSS_ALG_TOEPLITZ_ASYMMETRIC = 0,
618 VIRTCHNL_RSS_ALG_XOR_ASYMMETRIC = 1,
619 VIRTCHNL_RSS_ALG_TOEPLITZ_SYMMETRIC = 2,
620 VIRTCHNL_RSS_ALG_XOR_SYMMETRIC = 3,
623 /* This is used by PF driver to enforce how many channels can be supported.
624 * When ADQ_V2 capability is negotiated, it will allow 16 channels otherwise
625 * PF driver will allow only max 4 channels
627 #define VIRTCHNL_MAX_ADQ_CHANNELS 4
628 #define VIRTCHNL_MAX_ADQ_V2_CHANNELS 16
630 /* VIRTCHNL_OP_ENABLE_CHANNELS
631 * VIRTCHNL_OP_DISABLE_CHANNELS
632 * VF sends these messages to enable or disable channels based on
633 * the user specified queue count and queue offset for each traffic class.
634 * This struct encompasses all the information that the PF needs from
635 * VF to create a channel.
637 struct virtchnl_channel_info {
638 u16 count; /* number of queues in a channel */
639 u16 offset; /* queues in a channel start from 'offset' */
644 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info);
646 struct virtchnl_tc_info {
649 struct virtchnl_channel_info list[1];
652 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info);
654 /* VIRTCHNL_ADD_CLOUD_FILTER
655 * VIRTCHNL_DEL_CLOUD_FILTER
656 * VF sends these messages to add or delete a cloud filter based on the
657 * user specified match and action filters. These structures encompass
658 * all the information that the PF needs from the VF to add/delete a
662 struct virtchnl_l4_spec {
663 u8 src_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
664 u8 dst_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
665 /* vlan_prio is part of this 16 bit field even from OS perspective
666 * vlan_id:12 is actual vlan_id, then vlanid:bit14..12 is vlan_prio
667 * in future, when decided to offload vlan_prio, pass that information
668 * as part of the "vlan_id" field, Bit14..12
671 __be16 pad; /* reserved for future use */
678 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec);
680 union virtchnl_flow_spec {
681 struct virtchnl_l4_spec tcp_spec;
682 u8 buffer[128]; /* reserved for future use */
685 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec);
687 enum virtchnl_action {
689 VIRTCHNL_ACTION_DROP = 0,
690 VIRTCHNL_ACTION_TC_REDIRECT,
691 VIRTCHNL_ACTION_PASSTHRU,
692 VIRTCHNL_ACTION_QUEUE,
693 VIRTCHNL_ACTION_Q_REGION,
694 VIRTCHNL_ACTION_MARK,
695 VIRTCHNL_ACTION_COUNT,
698 enum virtchnl_flow_type {
700 VIRTCHNL_TCP_V4_FLOW = 0,
701 VIRTCHNL_TCP_V6_FLOW,
702 VIRTCHNL_UDP_V4_FLOW,
703 VIRTCHNL_UDP_V6_FLOW,
706 struct virtchnl_filter {
707 union virtchnl_flow_spec data;
708 union virtchnl_flow_spec mask;
709 enum virtchnl_flow_type flow_type;
710 enum virtchnl_action action;
715 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter);
717 /* VIRTCHNL_OP_DCF_GET_VSI_MAP
718 * VF sends this message to get VSI mapping table.
719 * PF responds with an indirect message containing VF's
721 * The index of vf_vsi array is the logical VF ID, the
722 * value of vf_vsi array is the VF's HW VSI ID with its
723 * valid configuration.
725 struct virtchnl_dcf_vsi_map {
726 u16 pf_vsi; /* PF's HW VSI ID */
727 u16 num_vfs; /* The actual number of VFs allocated */
728 #define VIRTCHNL_DCF_VF_VSI_ID_S 0
729 #define VIRTCHNL_DCF_VF_VSI_ID_M (0xFFF << VIRTCHNL_DCF_VF_VSI_ID_S)
730 #define VIRTCHNL_DCF_VF_VSI_VALID BIT(15)
734 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_dcf_vsi_map);
736 #define PKG_NAME_SIZE 32
746 VIRTCHNL_CHECK_STRUCT_LEN(4, pkg_version);
748 struct virtchnl_pkg_info {
749 struct pkg_version pkg_ver;
751 char pkg_name[PKG_NAME_SIZE];
755 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_pkg_info);
757 struct virtchnl_supported_rxdids {
758 u64 supported_rxdids;
761 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_supported_rxdids);
764 * PF sends this message to inform the VF driver of events that may affect it.
765 * No direct response is expected from the VF, though it may generate other
766 * messages in response to this one.
768 enum virtchnl_event_codes {
769 VIRTCHNL_EVENT_UNKNOWN = 0,
770 VIRTCHNL_EVENT_LINK_CHANGE,
771 VIRTCHNL_EVENT_RESET_IMPENDING,
772 VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
773 VIRTCHNL_EVENT_DCF_VSI_MAP_UPDATE,
776 #define PF_EVENT_SEVERITY_INFO 0
777 #define PF_EVENT_SEVERITY_ATTENTION 1
778 #define PF_EVENT_SEVERITY_ACTION_REQUIRED 2
779 #define PF_EVENT_SEVERITY_CERTAIN_DOOM 255
781 struct virtchnl_pf_event {
782 enum virtchnl_event_codes event;
784 /* If the PF driver does not support the new speed reporting
785 * capabilities then use link_event else use link_event_adv to
786 * get the speed and link information. The ability to understand
787 * new speeds is indicated by setting the capability flag
788 * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter
789 * in virtchnl_vf_resource struct and can be used to determine
790 * which link event struct to use below.
793 enum virtchnl_link_speed link_speed;
797 /* link_speed provided in Mbps */
810 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event);
813 /* VF reset states - these are written into the RSTAT register:
814 * VFGEN_RSTAT on the VF
815 * When the PF initiates a reset, it writes 0
816 * When the reset is complete, it writes 1
817 * When the PF detects that the VF has recovered, it writes 2
818 * VF checks this register periodically to determine if a reset has occurred,
819 * then polls it to know when the reset is complete.
820 * If either the PF or VF reads the register while the hardware
821 * is in a reset state, it will return DEADBEEF, which, when masked
824 enum virtchnl_vfr_states {
825 VIRTCHNL_VFR_INPROGRESS = 0,
826 VIRTCHNL_VFR_COMPLETED,
827 VIRTCHNL_VFR_VFACTIVE,
830 #define VIRTCHNL_MAX_NUM_PROTO_HDRS 32
831 #define PROTO_HDR_SHIFT 5
832 #define PROTO_HDR_FIELD_START(proto_hdr_type) \
833 (proto_hdr_type << PROTO_HDR_SHIFT)
834 #define PROTO_HDR_FIELD_MASK ((1UL << PROTO_HDR_SHIFT) - 1)
836 /* VF use these macros to configure each protocol header.
837 * Specify which protocol headers and protocol header fields base on
838 * virtchnl_proto_hdr_type and virtchnl_proto_hdr_field.
839 * @param hdr: a struct of virtchnl_proto_hdr
840 * @param hdr_type: ETH/IPV4/TCP, etc
841 * @param field: SRC/DST/TEID/SPI, etc
843 #define VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, field) \
844 ((hdr)->field_selector |= BIT((field) & PROTO_HDR_FIELD_MASK))
845 #define VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, field) \
846 ((hdr)->field_selector &= ~BIT((field) & PROTO_HDR_FIELD_MASK))
847 #define VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val) \
848 ((hdr)->field_selector & BIT((val) & PROTO_HDR_FIELD_MASK))
849 #define VIRTCHNL_GET_PROTO_HDR_FIELD(hdr) ((hdr)->field_selector)
851 #define VIRTCHNL_ADD_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
852 (VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, \
853 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
854 #define VIRTCHNL_DEL_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
855 (VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, \
856 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
858 #define VIRTCHNL_SET_PROTO_HDR_TYPE(hdr, hdr_type) \
859 ((hdr)->type = VIRTCHNL_PROTO_HDR_ ## hdr_type)
860 #define VIRTCHNL_GET_PROTO_HDR_TYPE(hdr) \
861 (((hdr)->type) >> PROTO_HDR_SHIFT)
862 #define VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) \
863 ((hdr)->type == ((val) >> PROTO_HDR_SHIFT))
864 #define VIRTCHNL_TEST_PROTO_HDR(hdr, val) \
865 (VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) && \
866 VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val))
868 /* Protocol header type within a packet segment. A segment consists of one or
869 * more protocol headers that make up a logical group of protocol headers. Each
870 * logical group of protocol headers encapsulates or is encapsulated using/by
871 * tunneling or encapsulation protocols for network virtualization.
873 enum virtchnl_proto_hdr_type {
874 VIRTCHNL_PROTO_HDR_NONE,
875 VIRTCHNL_PROTO_HDR_ETH,
876 VIRTCHNL_PROTO_HDR_S_VLAN,
877 VIRTCHNL_PROTO_HDR_C_VLAN,
878 VIRTCHNL_PROTO_HDR_IPV4,
879 VIRTCHNL_PROTO_HDR_IPV6,
880 VIRTCHNL_PROTO_HDR_TCP,
881 VIRTCHNL_PROTO_HDR_UDP,
882 VIRTCHNL_PROTO_HDR_SCTP,
883 VIRTCHNL_PROTO_HDR_GTPU_IP,
884 VIRTCHNL_PROTO_HDR_GTPU_EH,
885 VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_DWN,
886 VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_UP,
887 VIRTCHNL_PROTO_HDR_PPPOE,
888 VIRTCHNL_PROTO_HDR_L2TPV3,
889 VIRTCHNL_PROTO_HDR_ESP,
890 VIRTCHNL_PROTO_HDR_AH,
891 VIRTCHNL_PROTO_HDR_PFCP,
892 VIRTCHNL_PROTO_HDR_GTPC,
893 VIRTCHNL_PROTO_HDR_ECPRI,
896 /* Protocol header field within a protocol header. */
897 enum virtchnl_proto_hdr_field {
899 VIRTCHNL_PROTO_HDR_ETH_SRC =
900 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ETH),
901 VIRTCHNL_PROTO_HDR_ETH_DST,
902 VIRTCHNL_PROTO_HDR_ETH_ETHERTYPE,
904 VIRTCHNL_PROTO_HDR_S_VLAN_ID =
905 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_S_VLAN),
907 VIRTCHNL_PROTO_HDR_C_VLAN_ID =
908 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_C_VLAN),
910 VIRTCHNL_PROTO_HDR_IPV4_SRC =
911 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4),
912 VIRTCHNL_PROTO_HDR_IPV4_DST,
913 VIRTCHNL_PROTO_HDR_IPV4_DSCP,
914 VIRTCHNL_PROTO_HDR_IPV4_TTL,
915 VIRTCHNL_PROTO_HDR_IPV4_PROT,
917 VIRTCHNL_PROTO_HDR_IPV6_SRC =
918 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6),
919 VIRTCHNL_PROTO_HDR_IPV6_DST,
920 VIRTCHNL_PROTO_HDR_IPV6_TC,
921 VIRTCHNL_PROTO_HDR_IPV6_HOP_LIMIT,
922 VIRTCHNL_PROTO_HDR_IPV6_PROT,
924 VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_SRC,
925 VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_DST,
926 VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_SRC,
927 VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_DST,
928 VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_SRC,
929 VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_DST,
930 VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_SRC,
931 VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_DST,
932 VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_SRC,
933 VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_DST,
934 VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_SRC,
935 VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_DST,
937 VIRTCHNL_PROTO_HDR_TCP_SRC_PORT =
938 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_TCP),
939 VIRTCHNL_PROTO_HDR_TCP_DST_PORT,
941 VIRTCHNL_PROTO_HDR_UDP_SRC_PORT =
942 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_UDP),
943 VIRTCHNL_PROTO_HDR_UDP_DST_PORT,
945 VIRTCHNL_PROTO_HDR_SCTP_SRC_PORT =
946 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_SCTP),
947 VIRTCHNL_PROTO_HDR_SCTP_DST_PORT,
949 VIRTCHNL_PROTO_HDR_GTPU_IP_TEID =
950 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_IP),
952 VIRTCHNL_PROTO_HDR_GTPU_EH_PDU =
953 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_EH),
954 VIRTCHNL_PROTO_HDR_GTPU_EH_QFI,
956 VIRTCHNL_PROTO_HDR_PPPOE_SESS_ID =
957 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PPPOE),
959 VIRTCHNL_PROTO_HDR_L2TPV3_SESS_ID =
960 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_L2TPV3),
962 VIRTCHNL_PROTO_HDR_ESP_SPI =
963 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ESP),
965 VIRTCHNL_PROTO_HDR_AH_SPI =
966 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_AH),
968 VIRTCHNL_PROTO_HDR_PFCP_S_FIELD =
969 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PFCP),
970 VIRTCHNL_PROTO_HDR_PFCP_SEID,
972 VIRTCHNL_PROTO_HDR_GTPC_TEID =
973 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPC),
975 VIRTCHNL_PROTO_HDR_ECPRI_MSG_TYPE =
976 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ECPRI),
977 VIRTCHNL_PROTO_HDR_ECPRI_PC_RTC_ID,
980 struct virtchnl_proto_hdr {
981 enum virtchnl_proto_hdr_type type;
982 u32 field_selector; /* a bit mask to select field for header type */
985 * binary buffer in network order for specific header type.
986 * For example, if type = VIRTCHNL_PROTO_HDR_IPV4, a IPv4
987 * header is expected to be copied into the buffer.
991 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_proto_hdr);
993 struct virtchnl_proto_hdrs {
996 * specify where protocol header start from.
997 * 0 - from the outer layer
998 * 1 - from the first inner layer
999 * 2 - from the second inner layer
1002 int count; /* the proto layers must < VIRTCHNL_MAX_NUM_PROTO_HDRS */
1003 struct virtchnl_proto_hdr proto_hdr[VIRTCHNL_MAX_NUM_PROTO_HDRS];
1006 VIRTCHNL_CHECK_STRUCT_LEN(2312, virtchnl_proto_hdrs);
1008 struct virtchnl_rss_cfg {
1009 struct virtchnl_proto_hdrs proto_hdrs; /* protocol headers */
1010 enum virtchnl_rss_algorithm rss_algorithm; /* rss algorithm type */
1011 u8 reserved[128]; /* reserve for future */
1014 VIRTCHNL_CHECK_STRUCT_LEN(2444, virtchnl_rss_cfg);
1016 /* action configuration for FDIR */
1017 struct virtchnl_filter_action {
1018 enum virtchnl_action type;
1020 /* used for queue and qgroup action */
1025 /* used for count action */
1027 /* share counter ID with other flow rules */
1029 u32 id; /* counter ID */
1031 /* used for mark action */
1037 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_filter_action);
1039 #define VIRTCHNL_MAX_NUM_ACTIONS 8
1041 struct virtchnl_filter_action_set {
1042 /* action number must be less then VIRTCHNL_MAX_NUM_ACTIONS */
1044 struct virtchnl_filter_action actions[VIRTCHNL_MAX_NUM_ACTIONS];
1047 VIRTCHNL_CHECK_STRUCT_LEN(292, virtchnl_filter_action_set);
1049 /* pattern and action for FDIR rule */
1050 struct virtchnl_fdir_rule {
1051 struct virtchnl_proto_hdrs proto_hdrs;
1052 struct virtchnl_filter_action_set action_set;
1055 VIRTCHNL_CHECK_STRUCT_LEN(2604, virtchnl_fdir_rule);
1057 /* query information to retrieve fdir rule counters.
1058 * PF will fill out this structure to reset counter.
1060 struct virtchnl_fdir_query_info {
1061 u32 match_packets_valid:1;
1062 u32 match_bytes_valid:1;
1063 u32 reserved:30; /* Reserved, must be zero. */
1065 u64 matched_packets; /* Number of packets for this rule. */
1066 u64 matched_bytes; /* Number of bytes through this rule. */
1069 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_fdir_query_info);
1071 /* Status returned to VF after VF requests FDIR commands
1072 * VIRTCHNL_FDIR_SUCCESS
1073 * VF FDIR related request is successfully done by PF
1074 * The request can be OP_ADD/DEL/QUERY_FDIR_FILTER.
1076 * VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE
1077 * OP_ADD_FDIR_FILTER request is failed due to no Hardware resource.
1079 * VIRTCHNL_FDIR_FAILURE_RULE_EXIST
1080 * OP_ADD_FDIR_FILTER request is failed due to the rule is already existed.
1082 * VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT
1083 * OP_ADD_FDIR_FILTER request is failed due to conflict with existing rule.
1085 * VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST
1086 * OP_DEL_FDIR_FILTER request is failed due to this rule doesn't exist.
1088 * VIRTCHNL_FDIR_FAILURE_RULE_INVALID
1089 * OP_ADD_FDIR_FILTER request is failed due to parameters validation
1090 * or HW doesn't support.
1092 * VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT
1093 * OP_ADD/DEL_FDIR_FILTER request is failed due to timing out
1096 * VIRTCHNL_FDIR_FAILURE_QUERY_INVALID
1097 * OP_QUERY_FDIR_FILTER request is failed due to parameters validation,
1098 * for example, VF query counter of a rule who has no counter action.
1100 enum virtchnl_fdir_prgm_status {
1101 VIRTCHNL_FDIR_SUCCESS = 0,
1102 VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE,
1103 VIRTCHNL_FDIR_FAILURE_RULE_EXIST,
1104 VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT,
1105 VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST,
1106 VIRTCHNL_FDIR_FAILURE_RULE_INVALID,
1107 VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT,
1108 VIRTCHNL_FDIR_FAILURE_QUERY_INVALID,
1111 /* VIRTCHNL_OP_ADD_FDIR_FILTER
1112 * VF sends this request to PF by filling out vsi_id,
1113 * validate_only and rule_cfg. PF will return flow_id
1114 * if the request is successfully done and return add_status to VF.
1116 struct virtchnl_fdir_add {
1117 u16 vsi_id; /* INPUT */
1119 * 1 for validating a fdir rule, 0 for creating a fdir rule.
1120 * Validate and create share one ops: VIRTCHNL_OP_ADD_FDIR_FILTER.
1122 u16 validate_only; /* INPUT */
1123 u32 flow_id; /* OUTPUT */
1124 struct virtchnl_fdir_rule rule_cfg; /* INPUT */
1125 enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1128 VIRTCHNL_CHECK_STRUCT_LEN(2616, virtchnl_fdir_add);
1130 /* VIRTCHNL_OP_DEL_FDIR_FILTER
1131 * VF sends this request to PF by filling out vsi_id
1132 * and flow_id. PF will return del_status to VF.
1134 struct virtchnl_fdir_del {
1135 u16 vsi_id; /* INPUT */
1137 u32 flow_id; /* INPUT */
1138 enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1141 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_fdir_del);
1143 /* VIRTCHNL_OP_QUERY_FDIR_FILTER
1144 * VF sends this request to PF by filling out vsi_id,
1145 * flow_id and reset_counter. PF will return query_info
1146 * and query_status to VF.
1148 struct virtchnl_fdir_query {
1149 u16 vsi_id; /* INPUT */
1151 u32 flow_id; /* INPUT */
1152 u32 reset_counter:1; /* INPUT */
1153 struct virtchnl_fdir_query_info query_info; /* OUTPUT */
1154 enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1158 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_fdir_query);
1160 /* TX and RX queue types are valid in legacy as well as split queue models.
1161 * With Split Queue model, 2 additional types are introduced - TX_COMPLETION
1162 * and RX_BUFFER. In split queue model, RX corresponds to the queue where HW
1163 * posts completions.
1165 enum virtchnl_queue_type {
1166 VIRTCHNL_QUEUE_TYPE_TX = 0,
1167 VIRTCHNL_QUEUE_TYPE_RX = 1,
1168 VIRTCHNL_QUEUE_TYPE_TX_COMPLETION = 2,
1169 VIRTCHNL_QUEUE_TYPE_RX_BUFFER = 3,
1170 VIRTCHNL_QUEUE_TYPE_CONFIG_TX = 4,
1171 VIRTCHNL_QUEUE_TYPE_CONFIG_RX = 5
1175 /* structure to specify a chunk of contiguous queues */
1176 struct virtchnl_queue_chunk {
1177 enum virtchnl_queue_type type;
1182 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_queue_chunk);
1184 /* structure to specify several chunks of contiguous queues */
1185 struct virtchnl_queue_chunks {
1188 struct virtchnl_queue_chunk chunks[1];
1191 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_chunks);
1194 /* VIRTCHNL_OP_ENABLE_QUEUES_V2
1195 * VIRTCHNL_OP_DISABLE_QUEUES_V2
1196 * VIRTCHNL_OP_DEL_QUEUES
1198 * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1199 * then all of these ops are available.
1201 * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1202 * then VIRTCHNL_OP_ENABLE_QUEUES_V2 and VIRTCHNL_OP_DISABLE_QUEUES_V2 are
1205 * PF sends these messages to enable, disable or delete queues specified in
1206 * chunks. PF sends virtchnl_del_ena_dis_queues struct to specify the queues
1207 * to be enabled/disabled/deleted. Also applicable to single queue RX or
1208 * TX. CP performs requested action and returns status.
1210 struct virtchnl_del_ena_dis_queues {
1213 struct virtchnl_queue_chunks chunks;
1216 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_del_ena_dis_queues);
1218 /* Virtchannel interrupt throttling rate index */
1219 enum virtchnl_itr_idx {
1220 VIRTCHNL_ITR_IDX_0 = 0,
1221 VIRTCHNL_ITR_IDX_1 = 1,
1222 VIRTCHNL_ITR_IDX_NO_ITR = 3,
1225 /* Queue to vector mapping */
1226 struct virtchnl_queue_vector {
1230 enum virtchnl_itr_idx itr_idx;
1231 enum virtchnl_queue_type queue_type;
1234 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_queue_vector);
1236 /* VIRTCHNL_OP_MAP_QUEUE_VECTOR
1237 * VIRTCHNL_OP_UNMAP_QUEUE_VECTOR
1239 * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1240 * then all of these ops are available.
1242 * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1243 * then only VIRTCHNL_OP_MAP_QUEUE_VECTOR is available.
1245 * PF sends this message to map or unmap queues to vectors and ITR index
1246 * registers. External data buffer contains virtchnl_queue_vector_maps structure
1247 * that contains num_qv_maps of virtchnl_queue_vector structures.
1248 * CP maps the requested queue vector maps after validating the queue and vector
1249 * ids and returns a status code.
1251 struct virtchnl_queue_vector_maps {
1255 struct virtchnl_queue_vector qv_maps[1];
1258 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_queue_vector_maps);
1261 /* Since VF messages are limited by u16 size, precalculate the maximum possible
1262 * values of nested elements in virtchnl structures that virtual channel can
1263 * possibly handle in a single message.
1265 enum virtchnl_vector_limits {
1266 VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX =
1267 ((u16)(~0) - sizeof(struct virtchnl_vsi_queue_config_info)) /
1268 sizeof(struct virtchnl_queue_pair_info),
1270 VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX =
1271 ((u16)(~0) - sizeof(struct virtchnl_irq_map_info)) /
1272 sizeof(struct virtchnl_vector_map),
1274 VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX =
1275 ((u16)(~0) - sizeof(struct virtchnl_ether_addr_list)) /
1276 sizeof(struct virtchnl_ether_addr),
1278 VIRTCHNL_OP_ADD_DEL_VLAN_MAX =
1279 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list)) /
1283 VIRTCHNL_OP_ENABLE_CHANNELS_MAX =
1284 ((u16)(~0) - sizeof(struct virtchnl_tc_info)) /
1285 sizeof(struct virtchnl_channel_info),
1287 VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX =
1288 ((u16)(~0) - sizeof(struct virtchnl_del_ena_dis_queues)) /
1289 sizeof(struct virtchnl_queue_chunk),
1291 VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX =
1292 ((u16)(~0) - sizeof(struct virtchnl_queue_vector_maps)) /
1293 sizeof(struct virtchnl_queue_vector),
1297 * virtchnl_vc_validate_vf_msg
1298 * @ver: Virtchnl version info
1299 * @v_opcode: Opcode for the message
1300 * @msg: pointer to the msg buffer
1301 * @msglen: msg length
1303 * validate msg format against struct for each opcode
1306 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode,
1307 u8 *msg, u16 msglen)
1309 bool err_msg_format = false;
1312 /* Validate message length. */
1314 case VIRTCHNL_OP_VERSION:
1315 valid_len = sizeof(struct virtchnl_version_info);
1317 case VIRTCHNL_OP_RESET_VF:
1319 case VIRTCHNL_OP_GET_VF_RESOURCES:
1321 valid_len = sizeof(u32);
1323 case VIRTCHNL_OP_CONFIG_TX_QUEUE:
1324 valid_len = sizeof(struct virtchnl_txq_info);
1326 case VIRTCHNL_OP_CONFIG_RX_QUEUE:
1327 valid_len = sizeof(struct virtchnl_rxq_info);
1329 case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
1330 valid_len = sizeof(struct virtchnl_vsi_queue_config_info);
1331 if (msglen >= valid_len) {
1332 struct virtchnl_vsi_queue_config_info *vqc =
1333 (struct virtchnl_vsi_queue_config_info *)msg;
1335 if (vqc->num_queue_pairs == 0 || vqc->num_queue_pairs >
1336 VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX) {
1337 err_msg_format = true;
1341 valid_len += (vqc->num_queue_pairs *
1343 virtchnl_queue_pair_info));
1346 case VIRTCHNL_OP_CONFIG_IRQ_MAP:
1347 valid_len = sizeof(struct virtchnl_irq_map_info);
1348 if (msglen >= valid_len) {
1349 struct virtchnl_irq_map_info *vimi =
1350 (struct virtchnl_irq_map_info *)msg;
1352 if (vimi->num_vectors == 0 || vimi->num_vectors >
1353 VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX) {
1354 err_msg_format = true;
1358 valid_len += (vimi->num_vectors *
1359 sizeof(struct virtchnl_vector_map));
1362 case VIRTCHNL_OP_ENABLE_QUEUES:
1363 case VIRTCHNL_OP_DISABLE_QUEUES:
1364 valid_len = sizeof(struct virtchnl_queue_select);
1366 case VIRTCHNL_OP_GET_MAX_RSS_QREGION:
1368 case VIRTCHNL_OP_ADD_ETH_ADDR:
1369 case VIRTCHNL_OP_DEL_ETH_ADDR:
1370 valid_len = sizeof(struct virtchnl_ether_addr_list);
1371 if (msglen >= valid_len) {
1372 struct virtchnl_ether_addr_list *veal =
1373 (struct virtchnl_ether_addr_list *)msg;
1375 if (veal->num_elements == 0 || veal->num_elements >
1376 VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX) {
1377 err_msg_format = true;
1381 valid_len += veal->num_elements *
1382 sizeof(struct virtchnl_ether_addr);
1385 case VIRTCHNL_OP_ADD_VLAN:
1386 case VIRTCHNL_OP_DEL_VLAN:
1387 valid_len = sizeof(struct virtchnl_vlan_filter_list);
1388 if (msglen >= valid_len) {
1389 struct virtchnl_vlan_filter_list *vfl =
1390 (struct virtchnl_vlan_filter_list *)msg;
1392 if (vfl->num_elements == 0 || vfl->num_elements >
1393 VIRTCHNL_OP_ADD_DEL_VLAN_MAX) {
1394 err_msg_format = true;
1398 valid_len += vfl->num_elements * sizeof(u16);
1401 case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
1402 valid_len = sizeof(struct virtchnl_promisc_info);
1404 case VIRTCHNL_OP_GET_STATS:
1405 valid_len = sizeof(struct virtchnl_queue_select);
1407 case VIRTCHNL_OP_CONFIG_RSS_KEY:
1408 valid_len = sizeof(struct virtchnl_rss_key);
1409 if (msglen >= valid_len) {
1410 struct virtchnl_rss_key *vrk =
1411 (struct virtchnl_rss_key *)msg;
1413 if (vrk->key_len == 0) {
1414 /* zero length is allowed as input */
1418 valid_len += vrk->key_len - 1;
1421 case VIRTCHNL_OP_CONFIG_RSS_LUT:
1422 valid_len = sizeof(struct virtchnl_rss_lut);
1423 if (msglen >= valid_len) {
1424 struct virtchnl_rss_lut *vrl =
1425 (struct virtchnl_rss_lut *)msg;
1427 if (vrl->lut_entries == 0) {
1428 /* zero entries is allowed as input */
1432 valid_len += vrl->lut_entries - 1;
1435 case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
1437 case VIRTCHNL_OP_SET_RSS_HENA:
1438 valid_len = sizeof(struct virtchnl_rss_hena);
1440 case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
1441 case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
1443 case VIRTCHNL_OP_REQUEST_QUEUES:
1444 valid_len = sizeof(struct virtchnl_vf_res_request);
1446 case VIRTCHNL_OP_ENABLE_CHANNELS:
1447 valid_len = sizeof(struct virtchnl_tc_info);
1448 if (msglen >= valid_len) {
1449 struct virtchnl_tc_info *vti =
1450 (struct virtchnl_tc_info *)msg;
1452 if (vti->num_tc == 0 || vti->num_tc >
1453 VIRTCHNL_OP_ENABLE_CHANNELS_MAX) {
1454 err_msg_format = true;
1458 valid_len += (vti->num_tc - 1) *
1459 sizeof(struct virtchnl_channel_info);
1462 case VIRTCHNL_OP_DISABLE_CHANNELS:
1464 case VIRTCHNL_OP_ADD_CLOUD_FILTER:
1465 case VIRTCHNL_OP_DEL_CLOUD_FILTER:
1466 valid_len = sizeof(struct virtchnl_filter);
1468 case VIRTCHNL_OP_DCF_CMD_DESC:
1469 case VIRTCHNL_OP_DCF_CMD_BUFF:
1470 /* These two opcodes are specific to handle the AdminQ command,
1471 * so the validation needs to be done in PF's context.
1475 case VIRTCHNL_OP_DCF_DISABLE:
1476 case VIRTCHNL_OP_DCF_GET_VSI_MAP:
1477 case VIRTCHNL_OP_DCF_GET_PKG_INFO:
1479 case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
1481 case VIRTCHNL_OP_ADD_RSS_CFG:
1482 case VIRTCHNL_OP_DEL_RSS_CFG:
1483 valid_len = sizeof(struct virtchnl_rss_cfg);
1485 case VIRTCHNL_OP_ADD_FDIR_FILTER:
1486 valid_len = sizeof(struct virtchnl_fdir_add);
1488 case VIRTCHNL_OP_DEL_FDIR_FILTER:
1489 valid_len = sizeof(struct virtchnl_fdir_del);
1491 case VIRTCHNL_OP_QUERY_FDIR_FILTER:
1492 valid_len = sizeof(struct virtchnl_fdir_query);
1494 case VIRTCHNL_OP_ENABLE_QUEUES_V2:
1495 case VIRTCHNL_OP_DISABLE_QUEUES_V2:
1496 valid_len = sizeof(struct virtchnl_del_ena_dis_queues);
1497 if (msglen >= valid_len) {
1498 struct virtchnl_del_ena_dis_queues *qs =
1499 (struct virtchnl_del_ena_dis_queues *)msg;
1500 if (qs->chunks.num_chunks == 0 ||
1501 qs->chunks.num_chunks > VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX) {
1502 err_msg_format = true;
1505 valid_len += (qs->chunks.num_chunks - 1) *
1506 sizeof(struct virtchnl_queue_chunk);
1509 case VIRTCHNL_OP_MAP_QUEUE_VECTOR:
1510 valid_len = sizeof(struct virtchnl_queue_vector_maps);
1511 if (msglen >= valid_len) {
1512 struct virtchnl_queue_vector_maps *v_qp =
1513 (struct virtchnl_queue_vector_maps *)msg;
1514 if (v_qp->num_qv_maps == 0 ||
1515 v_qp->num_qv_maps > VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX) {
1516 err_msg_format = true;
1519 valid_len += (v_qp->num_qv_maps - 1) *
1520 sizeof(struct virtchnl_queue_vector);
1523 /* These are always errors coming from the VF. */
1524 case VIRTCHNL_OP_EVENT:
1525 case VIRTCHNL_OP_UNKNOWN:
1527 return VIRTCHNL_STATUS_ERR_PARAM;
1529 /* few more checks */
1530 if (err_msg_format || valid_len != msglen)
1531 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH;
1535 #endif /* _VIRTCHNL_H_ */