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