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 /* opcode 34 is reserved */ 160 /* opcodes 39, 40, 41, 42 and 43 are reserved */ 161 /* opcode 44 is reserved */ 162 /* opcode 45, 46, 47, 48 and 49 are reserved */ 163 VIRTCHNL_OP_MAX, 164 }; 165 166 /* These macros are used to generate compilation errors if a structure/union 167 * is not exactly the correct length. It gives a divide by zero error if the 168 * structure/union is not of the correct size, otherwise it creates an enum 169 * that is never used. 170 */ 171 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \ 172 { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) } 173 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \ 174 { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) } 175 176 /* Virtual channel message descriptor. This overlays the admin queue 177 * descriptor. All other data is passed in external buffers. 178 */ 179 180 struct virtchnl_msg { 181 u8 pad[8]; /* AQ flags/opcode/len/retval fields */ 182 enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */ 183 enum virtchnl_status_code v_retval; /* ditto for desc->retval */ 184 u32 vfid; /* used by PF when sending to VF */ 185 }; 186 187 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg); 188 189 /* Message descriptions and data structures. */ 190 191 /* VIRTCHNL_OP_VERSION 192 * VF posts its version number to the PF. PF responds with its version number 193 * in the same format, along with a return code. 194 * Reply from PF has its major/minor versions also in param0 and param1. 195 * If there is a major version mismatch, then the VF cannot operate. 196 * If there is a minor version mismatch, then the VF can operate but should 197 * add a warning to the system log. 198 * 199 * This enum element MUST always be specified as == 1, regardless of other 200 * changes in the API. The PF must always respond to this message without 201 * error regardless of version mismatch. 202 */ 203 #define VIRTCHNL_VERSION_MAJOR 1 204 #define VIRTCHNL_VERSION_MINOR 1 205 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0 206 207 struct virtchnl_version_info { 208 u32 major; 209 u32 minor; 210 }; 211 212 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info); 213 214 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0)) 215 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1)) 216 217 /* VIRTCHNL_OP_RESET_VF 218 * VF sends this request to PF with no parameters 219 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register 220 * until reset completion is indicated. The admin queue must be reinitialized 221 * after this operation. 222 * 223 * When reset is complete, PF must ensure that all queues in all VSIs associated 224 * with the VF are stopped, all queue configurations in the HMC are set to 0, 225 * and all MAC and VLAN filters (except the default MAC address) on all VSIs 226 * are cleared. 227 */ 228 229 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV 230 * vsi_type should always be 6 for backward compatibility. Add other fields 231 * as needed. 232 */ 233 enum virtchnl_vsi_type { 234 VIRTCHNL_VSI_TYPE_INVALID = 0, 235 VIRTCHNL_VSI_SRIOV = 6, 236 }; 237 238 /* VIRTCHNL_OP_GET_VF_RESOURCES 239 * Version 1.0 VF sends this request to PF with no parameters 240 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities 241 * PF responds with an indirect message containing 242 * virtchnl_vf_resource and one or more 243 * virtchnl_vsi_resource structures. 244 */ 245 246 struct virtchnl_vsi_resource { 247 u16 vsi_id; 248 u16 num_queue_pairs; 249 enum virtchnl_vsi_type vsi_type; 250 u16 qset_handle; 251 u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS]; 252 }; 253 254 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource); 255 256 /* VF capability flags 257 * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including 258 * TX/RX Checksum offloading and TSO for non-tunnelled packets. 259 */ 260 #define VIRTCHNL_VF_OFFLOAD_L2 0x00000001 261 #define VIRTCHNL_VF_OFFLOAD_IWARP 0x00000002 262 #define VIRTCHNL_VF_OFFLOAD_RSVD 0x00000004 263 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ 0x00000008 264 #define VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010 265 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020 266 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES 0x00000040 267 #define VIRTCHNL_VF_OFFLOAD_CRC 0x00000080 268 #define VIRTCHNL_VF_OFFLOAD_VLAN 0x00010000 269 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING 0x00020000 270 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2 0x00040000 271 #define VIRTCHNL_VF_OFFLOAD_RSS_PF 0X00080000 272 #define VIRTCHNL_VF_OFFLOAD_ENCAP 0X00100000 273 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM 0X00200000 274 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM 0X00400000 275 #define VIRTCHNL_VF_OFFLOAD_ADQ 0X00800000 276 #define VIRTCHNL_VF_OFFLOAD_ADQ_V2 0X01000000 277 #define VIRTCHNL_VF_OFFLOAD_USO 0X02000000 278 /* 0x04000000 is reserved */ 279 /* 0X08000000 and 0X10000000 are reserved */ 280 /* 0X20000000 is reserved */ 281 /* 0X40000000 is reserved */ 282 /* 0X80000000 is reserved */ 283 284 /* Define below the capability flags that are not offloads */ 285 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED 0x00000080 286 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \ 287 VIRTCHNL_VF_OFFLOAD_VLAN | \ 288 VIRTCHNL_VF_OFFLOAD_RSS_PF) 289 290 struct virtchnl_vf_resource { 291 u16 num_vsis; 292 u16 num_queue_pairs; 293 u16 max_vectors; 294 u16 max_mtu; 295 296 u32 vf_cap_flags; 297 u32 rss_key_size; 298 u32 rss_lut_size; 299 300 struct virtchnl_vsi_resource vsi_res[1]; 301 }; 302 303 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource); 304 305 /* VIRTCHNL_OP_CONFIG_TX_QUEUE 306 * VF sends this message to set up parameters for one TX queue. 307 * External data buffer contains one instance of virtchnl_txq_info. 308 * PF configures requested queue and returns a status code. 309 */ 310 311 /* Tx queue config info */ 312 struct virtchnl_txq_info { 313 u16 vsi_id; 314 u16 queue_id; 315 u16 ring_len; /* number of descriptors, multiple of 8 */ 316 u16 headwb_enabled; /* deprecated with AVF 1.0 */ 317 u64 dma_ring_addr; 318 u64 dma_headwb_addr; /* deprecated with AVF 1.0 */ 319 }; 320 321 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info); 322 323 /* VIRTCHNL_OP_CONFIG_RX_QUEUE 324 * VF sends this message to set up parameters for one RX queue. 325 * External data buffer contains one instance of virtchnl_rxq_info. 326 * PF configures requested queue and returns a status code. The 327 * crc_disable flag disables CRC stripping on the VF. Setting 328 * the crc_disable flag to 1 will disable CRC stripping for each 329 * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC 330 * offload must have been set prior to sending this info or the PF 331 * will ignore the request. This flag should be set the same for 332 * all of the queues for a VF. 333 */ 334 335 /* Rx queue config info */ 336 struct virtchnl_rxq_info { 337 u16 vsi_id; 338 u16 queue_id; 339 u32 ring_len; /* number of descriptors, multiple of 32 */ 340 u16 hdr_size; 341 u16 splithdr_enabled; /* deprecated with AVF 1.0 */ 342 u32 databuffer_size; 343 u32 max_pkt_size; 344 u8 crc_disable; 345 u8 pad1[3]; 346 u64 dma_ring_addr; 347 enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */ 348 u32 pad2; 349 }; 350 351 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info); 352 353 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES 354 * VF sends this message to set parameters for active TX and RX queues 355 * associated with the specified VSI. 356 * PF configures queues and returns status. 357 * If the number of queues specified is greater than the number of queues 358 * associated with the VSI, an error is returned and no queues are configured. 359 * NOTE: The VF is not required to configure all queues in a single request. 360 * It may send multiple messages. PF drivers must correctly handle all VF 361 * requests. 362 */ 363 struct virtchnl_queue_pair_info { 364 /* NOTE: vsi_id and queue_id should be identical for both queues. */ 365 struct virtchnl_txq_info txq; 366 struct virtchnl_rxq_info rxq; 367 }; 368 369 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info); 370 371 struct virtchnl_vsi_queue_config_info { 372 u16 vsi_id; 373 u16 num_queue_pairs; 374 u32 pad; 375 struct virtchnl_queue_pair_info qpair[1]; 376 }; 377 378 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info); 379 380 /* VIRTCHNL_OP_REQUEST_QUEUES 381 * VF sends this message to request the PF to allocate additional queues to 382 * this VF. Each VF gets a guaranteed number of queues on init but asking for 383 * additional queues must be negotiated. This is a best effort request as it 384 * is possible the PF does not have enough queues left to support the request. 385 * If the PF cannot support the number requested it will respond with the 386 * maximum number it is able to support. If the request is successful, PF will 387 * then reset the VF to institute required changes. 388 */ 389 390 /* VF resource request */ 391 struct virtchnl_vf_res_request { 392 u16 num_queue_pairs; 393 }; 394 395 /* VIRTCHNL_OP_CONFIG_IRQ_MAP 396 * VF uses this message to map vectors to queues. 397 * The rxq_map and txq_map fields are bitmaps used to indicate which queues 398 * are to be associated with the specified vector. 399 * The "other" causes are always mapped to vector 0. The VF may not request 400 * that vector 0 be used for traffic. 401 * PF configures interrupt mapping and returns status. 402 * NOTE: due to hardware requirements, all active queues (both TX and RX) 403 * should be mapped to interrupts, even if the driver intends to operate 404 * only in polling mode. In this case the interrupt may be disabled, but 405 * the ITR timer will still run to trigger writebacks. 406 */ 407 struct virtchnl_vector_map { 408 u16 vsi_id; 409 u16 vector_id; 410 u16 rxq_map; 411 u16 txq_map; 412 u16 rxitr_idx; 413 u16 txitr_idx; 414 }; 415 416 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map); 417 418 struct virtchnl_irq_map_info { 419 u16 num_vectors; 420 struct virtchnl_vector_map vecmap[1]; 421 }; 422 423 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info); 424 425 /* VIRTCHNL_OP_ENABLE_QUEUES 426 * VIRTCHNL_OP_DISABLE_QUEUES 427 * VF sends these message to enable or disable TX/RX queue pairs. 428 * The queues fields are bitmaps indicating which queues to act upon. 429 * (Currently, we only support 16 queues per VF, but we make the field 430 * u32 to allow for expansion.) 431 * PF performs requested action and returns status. 432 * NOTE: The VF is not required to enable/disable all queues in a single 433 * request. It may send multiple messages. 434 * PF drivers must correctly handle all VF requests. 435 */ 436 struct virtchnl_queue_select { 437 u16 vsi_id; 438 u16 pad; 439 u32 rx_queues; 440 u32 tx_queues; 441 }; 442 443 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select); 444 445 /* VIRTCHNL_OP_ADD_ETH_ADDR 446 * VF sends this message in order to add one or more unicast or multicast 447 * address filters for the specified VSI. 448 * PF adds the filters and returns status. 449 */ 450 451 /* VIRTCHNL_OP_DEL_ETH_ADDR 452 * VF sends this message in order to remove one or more unicast or multicast 453 * filters for the specified VSI. 454 * PF removes the filters and returns status. 455 */ 456 457 /* VIRTCHNL_ETHER_ADDR_LEGACY 458 * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad 459 * bytes. Moving forward all VF drivers should not set type to 460 * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy 461 * behavior. The control plane function (i.e. PF) can use a best effort method 462 * of tracking the primary/device unicast in this case, but there is no 463 * guarantee and functionality depends on the implementation of the PF. 464 */ 465 466 /* VIRTCHNL_ETHER_ADDR_PRIMARY 467 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the 468 * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and 469 * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane 470 * function (i.e. PF) to accurately track and use this MAC address for 471 * displaying on the host and for VM/function reset. 472 */ 473 474 /* VIRTCHNL_ETHER_ADDR_EXTRA 475 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra 476 * unicast and/or multicast filters that are being added/deleted via 477 * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively. 478 */ 479 struct virtchnl_ether_addr { 480 u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS]; 481 u8 type; 482 #define VIRTCHNL_ETHER_ADDR_LEGACY 0 483 #define VIRTCHNL_ETHER_ADDR_PRIMARY 1 484 #define VIRTCHNL_ETHER_ADDR_EXTRA 2 485 #define VIRTCHNL_ETHER_ADDR_TYPE_MASK 3 /* first two bits of type are valid */ 486 u8 pad; 487 }; 488 489 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr); 490 491 struct virtchnl_ether_addr_list { 492 u16 vsi_id; 493 u16 num_elements; 494 struct virtchnl_ether_addr list[1]; 495 }; 496 497 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list); 498 499 /* VIRTCHNL_OP_ADD_VLAN 500 * VF sends this message to add one or more VLAN tag filters for receives. 501 * PF adds the filters and returns status. 502 * If a port VLAN is configured by the PF, this operation will return an 503 * error to the VF. 504 */ 505 506 /* VIRTCHNL_OP_DEL_VLAN 507 * VF sends this message to remove one or more VLAN tag filters for receives. 508 * PF removes the filters and returns status. 509 * If a port VLAN is configured by the PF, this operation will return an 510 * error to the VF. 511 */ 512 513 struct virtchnl_vlan_filter_list { 514 u16 vsi_id; 515 u16 num_elements; 516 u16 vlan_id[1]; 517 }; 518 519 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list); 520 521 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE 522 * VF sends VSI id and flags. 523 * PF returns status code in retval. 524 * Note: we assume that broadcast accept mode is always enabled. 525 */ 526 struct virtchnl_promisc_info { 527 u16 vsi_id; 528 u16 flags; 529 }; 530 531 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info); 532 533 #define FLAG_VF_UNICAST_PROMISC 0x00000001 534 #define FLAG_VF_MULTICAST_PROMISC 0x00000002 535 536 /* VIRTCHNL_OP_GET_STATS 537 * VF sends this message to request stats for the selected VSI. VF uses 538 * the virtchnl_queue_select struct to specify the VSI. The queue_id 539 * field is ignored by the PF. 540 * 541 * PF replies with struct virtchnl_eth_stats in an external buffer. 542 */ 543 544 struct virtchnl_eth_stats { 545 u64 rx_bytes; /* received bytes */ 546 u64 rx_unicast; /* received unicast pkts */ 547 u64 rx_multicast; /* received multicast pkts */ 548 u64 rx_broadcast; /* received broadcast pkts */ 549 u64 rx_discards; 550 u64 rx_unknown_protocol; 551 u64 tx_bytes; /* transmitted bytes */ 552 u64 tx_unicast; /* transmitted unicast pkts */ 553 u64 tx_multicast; /* transmitted multicast pkts */ 554 u64 tx_broadcast; /* transmitted broadcast pkts */ 555 u64 tx_discards; 556 u64 tx_errors; 557 }; 558 559 /* VIRTCHNL_OP_CONFIG_RSS_KEY 560 * VIRTCHNL_OP_CONFIG_RSS_LUT 561 * VF sends these messages to configure RSS. Only supported if both PF 562 * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during 563 * configuration negotiation. If this is the case, then the RSS fields in 564 * the VF resource struct are valid. 565 * Both the key and LUT are initialized to 0 by the PF, meaning that 566 * RSS is effectively disabled until set up by the VF. 567 */ 568 struct virtchnl_rss_key { 569 u16 vsi_id; 570 u16 key_len; 571 u8 key[1]; /* RSS hash key, packed bytes */ 572 }; 573 574 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key); 575 576 struct virtchnl_rss_lut { 577 u16 vsi_id; 578 u16 lut_entries; 579 u8 lut[1]; /* RSS lookup table */ 580 }; 581 582 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut); 583 584 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS 585 * VIRTCHNL_OP_SET_RSS_HENA 586 * VF sends these messages to get and set the hash filter enable bits for RSS. 587 * By default, the PF sets these to all possible traffic types that the 588 * hardware supports. The VF can query this value if it wants to change the 589 * traffic types that are hashed by the hardware. 590 */ 591 struct virtchnl_rss_hena { 592 u64 hena; 593 }; 594 595 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena); 596 597 /* This is used by PF driver to enforce how many channels can be supported. 598 * When ADQ_V2 capability is negotiated, it will allow 16 channels otherwise 599 * PF driver will allow only max 4 channels 600 */ 601 #define VIRTCHNL_MAX_ADQ_CHANNELS 4 602 #define VIRTCHNL_MAX_ADQ_V2_CHANNELS 16 603 604 /* VIRTCHNL_OP_ENABLE_CHANNELS 605 * VIRTCHNL_OP_DISABLE_CHANNELS 606 * VF sends these messages to enable or disable channels based on 607 * the user specified queue count and queue offset for each traffic class. 608 * This struct encompasses all the information that the PF needs from 609 * VF to create a channel. 610 */ 611 struct virtchnl_channel_info { 612 u16 count; /* number of queues in a channel */ 613 u16 offset; /* queues in a channel start from 'offset' */ 614 u32 pad; 615 u64 max_tx_rate; 616 }; 617 618 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info); 619 620 struct virtchnl_tc_info { 621 u32 num_tc; 622 u32 pad; 623 struct virtchnl_channel_info list[1]; 624 }; 625 626 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info); 627 628 /* VIRTCHNL_ADD_CLOUD_FILTER 629 * VIRTCHNL_DEL_CLOUD_FILTER 630 * VF sends these messages to add or delete a cloud filter based on the 631 * user specified match and action filters. These structures encompass 632 * all the information that the PF needs from the VF to add/delete a 633 * cloud filter. 634 */ 635 636 struct virtchnl_l4_spec { 637 u8 src_mac[ETH_ALEN]; 638 u8 dst_mac[ETH_ALEN]; 639 /* vlan_prio is part of this 16 bit field even from OS perspective 640 * vlan_id:12 is actual vlan_id, then vlanid:bit14..12 is vlan_prio 641 * in future, when decided to offload vlan_prio, pass that information 642 * as part of the "vlan_id" field, Bit14..12 643 */ 644 __be16 vlan_id; 645 __be16 pad; /* reserved for future use */ 646 __be32 src_ip[4]; 647 __be32 dst_ip[4]; 648 __be16 src_port; 649 __be16 dst_port; 650 }; 651 652 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec); 653 654 union virtchnl_flow_spec { 655 struct virtchnl_l4_spec tcp_spec; 656 u8 buffer[128]; /* reserved for future use */ 657 }; 658 659 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec); 660 661 enum virtchnl_action { 662 /* action types */ 663 VIRTCHNL_ACTION_DROP = 0, 664 VIRTCHNL_ACTION_TC_REDIRECT, 665 VIRTCHNL_ACTION_PASSTHRU, 666 VIRTCHNL_ACTION_QUEUE, 667 VIRTCHNL_ACTION_Q_REGION, 668 VIRTCHNL_ACTION_MARK, 669 VIRTCHNL_ACTION_COUNT, 670 }; 671 672 enum virtchnl_flow_type { 673 /* flow types */ 674 VIRTCHNL_TCP_V4_FLOW = 0, 675 VIRTCHNL_TCP_V6_FLOW, 676 VIRTCHNL_UDP_V4_FLOW, 677 VIRTCHNL_UDP_V6_FLOW, 678 }; 679 680 struct virtchnl_filter { 681 union virtchnl_flow_spec data; 682 union virtchnl_flow_spec mask; 683 enum virtchnl_flow_type flow_type; 684 enum virtchnl_action action; 685 u32 action_meta; 686 u8 field_flags; 687 }; 688 689 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter); 690 691 /* VIRTCHNL_OP_EVENT 692 * PF sends this message to inform the VF driver of events that may affect it. 693 * No direct response is expected from the VF, though it may generate other 694 * messages in response to this one. 695 */ 696 enum virtchnl_event_codes { 697 VIRTCHNL_EVENT_UNKNOWN = 0, 698 VIRTCHNL_EVENT_LINK_CHANGE, 699 VIRTCHNL_EVENT_RESET_IMPENDING, 700 VIRTCHNL_EVENT_PF_DRIVER_CLOSE, 701 }; 702 703 #define PF_EVENT_SEVERITY_INFO 0 704 #define PF_EVENT_SEVERITY_ATTENTION 1 705 #define PF_EVENT_SEVERITY_ACTION_REQUIRED 2 706 #define PF_EVENT_SEVERITY_CERTAIN_DOOM 255 707 708 struct virtchnl_pf_event { 709 enum virtchnl_event_codes event; 710 union { 711 /* If the PF driver does not support the new speed reporting 712 * capabilities then use link_event else use link_event_adv to 713 * get the speed and link information. The ability to understand 714 * new speeds is indicated by setting the capability flag 715 * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter 716 * in virtchnl_vf_resource struct and can be used to determine 717 * which link event struct to use below. 718 */ 719 struct { 720 enum virtchnl_link_speed link_speed; 721 u8 link_status; 722 } link_event; 723 struct { 724 /* link_speed provided in Mbps */ 725 u32 link_speed; 726 u8 link_status; 727 } link_event_adv; 728 } event_data; 729 730 int severity; 731 }; 732 733 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event); 734 735 /* Since VF messages are limited by u16 size, precalculate the maximum possible 736 * values of nested elements in virtchnl structures that virtual channel can 737 * possibly handle in a single message. 738 */ 739 enum virtchnl_vector_limits { 740 VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX = 741 ((u16)(~0) - sizeof(struct virtchnl_vsi_queue_config_info)) / 742 sizeof(struct virtchnl_queue_pair_info), 743 744 VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX = 745 ((u16)(~0) - sizeof(struct virtchnl_irq_map_info)) / 746 sizeof(struct virtchnl_vector_map), 747 748 VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX = 749 ((u16)(~0) - sizeof(struct virtchnl_ether_addr_list)) / 750 sizeof(struct virtchnl_ether_addr), 751 752 VIRTCHNL_OP_ADD_DEL_VLAN_MAX = 753 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list)) / 754 sizeof(u16), 755 756 VIRTCHNL_OP_ENABLE_CHANNELS_MAX = 757 ((u16)(~0) - sizeof(struct virtchnl_tc_info)) / 758 sizeof(struct virtchnl_channel_info), 759 }; 760 761 /* VF reset states - these are written into the RSTAT register: 762 * VFGEN_RSTAT on the VF 763 * When the PF initiates a reset, it writes 0 764 * When the reset is complete, it writes 1 765 * When the PF detects that the VF has recovered, it writes 2 766 * VF checks this register periodically to determine if a reset has occurred, 767 * then polls it to know when the reset is complete. 768 * If either the PF or VF reads the register while the hardware 769 * is in a reset state, it will return DEADBEEF, which, when masked 770 * will result in 3. 771 */ 772 enum virtchnl_vfr_states { 773 VIRTCHNL_VFR_INPROGRESS = 0, 774 VIRTCHNL_VFR_COMPLETED, 775 VIRTCHNL_VFR_VFACTIVE, 776 }; 777 778 /** 779 * virtchnl_vc_validate_vf_msg 780 * @ver: Virtchnl version info 781 * @v_opcode: Opcode for the message 782 * @msg: pointer to the msg buffer 783 * @msglen: msg length 784 * 785 * validate msg format against struct for each opcode 786 */ 787 static inline int 788 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode, 789 u8 *msg, u16 msglen) 790 { 791 bool err_msg_format = false; 792 u32 valid_len = 0; 793 794 /* Validate message length. */ 795 switch (v_opcode) { 796 case VIRTCHNL_OP_VERSION: 797 valid_len = sizeof(struct virtchnl_version_info); 798 break; 799 case VIRTCHNL_OP_RESET_VF: 800 break; 801 case VIRTCHNL_OP_GET_VF_RESOURCES: 802 if (VF_IS_V11(ver)) 803 valid_len = sizeof(u32); 804 break; 805 case VIRTCHNL_OP_CONFIG_TX_QUEUE: 806 valid_len = sizeof(struct virtchnl_txq_info); 807 break; 808 case VIRTCHNL_OP_CONFIG_RX_QUEUE: 809 valid_len = sizeof(struct virtchnl_rxq_info); 810 break; 811 case VIRTCHNL_OP_CONFIG_VSI_QUEUES: 812 valid_len = sizeof(struct virtchnl_vsi_queue_config_info); 813 if (msglen >= valid_len) { 814 struct virtchnl_vsi_queue_config_info *vqc = 815 (struct virtchnl_vsi_queue_config_info *)msg; 816 817 if (vqc->num_queue_pairs == 0 || vqc->num_queue_pairs > 818 VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX) { 819 err_msg_format = true; 820 break; 821 } 822 823 valid_len += (vqc->num_queue_pairs * 824 sizeof(struct 825 virtchnl_queue_pair_info)); 826 } 827 break; 828 case VIRTCHNL_OP_CONFIG_IRQ_MAP: 829 valid_len = sizeof(struct virtchnl_irq_map_info); 830 if (msglen >= valid_len) { 831 struct virtchnl_irq_map_info *vimi = 832 (struct virtchnl_irq_map_info *)msg; 833 834 if (vimi->num_vectors == 0 || vimi->num_vectors > 835 VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX) { 836 err_msg_format = true; 837 break; 838 } 839 840 valid_len += (vimi->num_vectors * 841 sizeof(struct virtchnl_vector_map)); 842 } 843 break; 844 case VIRTCHNL_OP_ENABLE_QUEUES: 845 case VIRTCHNL_OP_DISABLE_QUEUES: 846 valid_len = sizeof(struct virtchnl_queue_select); 847 break; 848 case VIRTCHNL_OP_ADD_ETH_ADDR: 849 case VIRTCHNL_OP_DEL_ETH_ADDR: 850 valid_len = sizeof(struct virtchnl_ether_addr_list); 851 if (msglen >= valid_len) { 852 struct virtchnl_ether_addr_list *veal = 853 (struct virtchnl_ether_addr_list *)msg; 854 855 if (veal->num_elements == 0 || veal->num_elements > 856 VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX) { 857 err_msg_format = true; 858 break; 859 } 860 861 valid_len += veal->num_elements * 862 sizeof(struct virtchnl_ether_addr); 863 } 864 break; 865 case VIRTCHNL_OP_ADD_VLAN: 866 case VIRTCHNL_OP_DEL_VLAN: 867 valid_len = sizeof(struct virtchnl_vlan_filter_list); 868 if (msglen >= valid_len) { 869 struct virtchnl_vlan_filter_list *vfl = 870 (struct virtchnl_vlan_filter_list *)msg; 871 872 if (vfl->num_elements == 0 || vfl->num_elements > 873 VIRTCHNL_OP_ADD_DEL_VLAN_MAX) { 874 err_msg_format = true; 875 break; 876 } 877 878 valid_len += vfl->num_elements * sizeof(u16); 879 } 880 break; 881 case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE: 882 valid_len = sizeof(struct virtchnl_promisc_info); 883 break; 884 case VIRTCHNL_OP_GET_STATS: 885 valid_len = sizeof(struct virtchnl_queue_select); 886 break; 887 case VIRTCHNL_OP_CONFIG_RSS_KEY: 888 valid_len = sizeof(struct virtchnl_rss_key); 889 if (msglen >= valid_len) { 890 struct virtchnl_rss_key *vrk = 891 (struct virtchnl_rss_key *)msg; 892 893 if (vrk->key_len == 0) { 894 /* zero length is allowed as input */ 895 break; 896 } 897 898 valid_len += vrk->key_len - 1; 899 } 900 break; 901 case VIRTCHNL_OP_CONFIG_RSS_LUT: 902 valid_len = sizeof(struct virtchnl_rss_lut); 903 if (msglen >= valid_len) { 904 struct virtchnl_rss_lut *vrl = 905 (struct virtchnl_rss_lut *)msg; 906 907 if (vrl->lut_entries == 0) { 908 /* zero entries is allowed as input */ 909 break; 910 } 911 912 valid_len += vrl->lut_entries - 1; 913 } 914 break; 915 case VIRTCHNL_OP_GET_RSS_HENA_CAPS: 916 break; 917 case VIRTCHNL_OP_SET_RSS_HENA: 918 valid_len = sizeof(struct virtchnl_rss_hena); 919 break; 920 case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING: 921 case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING: 922 break; 923 case VIRTCHNL_OP_REQUEST_QUEUES: 924 valid_len = sizeof(struct virtchnl_vf_res_request); 925 break; 926 case VIRTCHNL_OP_ENABLE_CHANNELS: 927 valid_len = sizeof(struct virtchnl_tc_info); 928 if (msglen >= valid_len) { 929 struct virtchnl_tc_info *vti = 930 (struct virtchnl_tc_info *)msg; 931 932 if (vti->num_tc == 0 || vti->num_tc > 933 VIRTCHNL_OP_ENABLE_CHANNELS_MAX) { 934 err_msg_format = true; 935 break; 936 } 937 938 valid_len += (vti->num_tc - 1) * 939 sizeof(struct virtchnl_channel_info); 940 } 941 break; 942 case VIRTCHNL_OP_DISABLE_CHANNELS: 943 break; 944 case VIRTCHNL_OP_ADD_CLOUD_FILTER: 945 case VIRTCHNL_OP_DEL_CLOUD_FILTER: 946 valid_len = sizeof(struct virtchnl_filter); 947 break; 948 /* These are always errors coming from the VF. */ 949 case VIRTCHNL_OP_EVENT: 950 case VIRTCHNL_OP_UNKNOWN: 951 default: 952 return VIRTCHNL_STATUS_ERR_PARAM; 953 } 954 /* few more checks */ 955 if (err_msg_format || valid_len != msglen) 956 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH; 957 958 return 0; 959 } 960 #endif /* _VIRTCHNL_H_ */ 961