1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright(c) 2001-2020 Intel Corporation 3 */ 4 5 #ifndef _VIRTCHNL_H_ 6 #define _VIRTCHNL_H_ 7 8 /* Description: 9 * This header file describes the VF-PF communication protocol used 10 * by the drivers for all devices starting from our 40G product line 11 * 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. 18 * 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. 22 * 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. 26 * 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 32 * process traffic. 33 */ 34 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 38 */ 39 40 /* Error Codes */ 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, 50 }; 51 52 /* Backward compatibility */ 53 #define VIRTCHNL_ERR_PARAM VIRTCHNL_STATUS_ERR_PARAM 54 #define VIRTCHNL_STATUS_NOT_SUPPORTED VIRTCHNL_STATUS_ERR_NOT_SUPPORTED 55 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 64 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), 75 }; 76 77 /* for hsplit_0 field of Rx HMC context */ 78 /* deprecated with AVF 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, 85 }; 86 87 #define VIRTCHNL_ETH_LENGTH_OF_ADDRESS 6 88 /* END GENERIC DEFINES */ 89 90 /* Opcodes for VF-PF communication. These are placed in the v_opcode field 91 * of the virtchnl_msg structure. 92 */ 93 enum virtchnl_ops { 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. 99 */ 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 #ifdef VIRTCHNL_SOL_VF_SUPPORT 119 VIRTCHNL_OP_GET_ADDNL_SOL_CONFIG = 19, 120 #endif 121 #ifdef VIRTCHNL_IWARP 122 VIRTCHNL_OP_IWARP = 20, /* advanced opcode */ 123 VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP = 21, /* advanced opcode */ 124 VIRTCHNL_OP_RELEASE_IWARP_IRQ_MAP = 22, /* advanced opcode */ 125 #endif 126 VIRTCHNL_OP_CONFIG_RSS_KEY = 23, 127 VIRTCHNL_OP_CONFIG_RSS_LUT = 24, 128 VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25, 129 VIRTCHNL_OP_SET_RSS_HENA = 26, 130 VIRTCHNL_OP_ENABLE_VLAN_STRIPPING = 27, 131 VIRTCHNL_OP_DISABLE_VLAN_STRIPPING = 28, 132 VIRTCHNL_OP_REQUEST_QUEUES = 29, 133 134 }; 135 136 /* These macros are used to generate compilation errors if a structure/union 137 * is not exactly the correct length. It gives a divide by zero error if the 138 * structure is not of the correct size, otherwise it creates an enum that is 139 * never used. 140 */ 141 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \ 142 { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) } 143 144 /* Virtual channel message descriptor. This overlays the admin queue 145 * descriptor. All other data is passed in external buffers. 146 */ 147 148 struct virtchnl_msg { 149 u8 pad[8]; /* AQ flags/opcode/len/retval fields */ 150 enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */ 151 enum virtchnl_status_code v_retval; /* ditto for desc->retval */ 152 u32 vfid; /* used by PF when sending to VF */ 153 }; 154 155 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg); 156 157 /* Message descriptions and data structures.*/ 158 159 /* VIRTCHNL_OP_VERSION 160 * VF posts its version number to the PF. PF responds with its version number 161 * in the same format, along with a return code. 162 * Reply from PF has its major/minor versions also in param0 and param1. 163 * If there is a major version mismatch, then the VF cannot operate. 164 * If there is a minor version mismatch, then the VF can operate but should 165 * add a warning to the system log. 166 * 167 * This enum element MUST always be specified as == 1, regardless of other 168 * changes in the API. The PF must always respond to this message without 169 * error regardless of version mismatch. 170 */ 171 #define VIRTCHNL_VERSION_MAJOR 1 172 #define VIRTCHNL_VERSION_MINOR 1 173 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0 174 175 struct virtchnl_version_info { 176 u32 major; 177 u32 minor; 178 }; 179 180 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info); 181 182 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0)) 183 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1)) 184 185 /* VIRTCHNL_OP_RESET_VF 186 * VF sends this request to PF with no parameters 187 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register 188 * until reset completion is indicated. The admin queue must be reinitialized 189 * after this operation. 190 * 191 * When reset is complete, PF must ensure that all queues in all VSIs associated 192 * with the VF are stopped, all queue configurations in the HMC are set to 0, 193 * and all MAC and VLAN filters (except the default MAC address) on all VSIs 194 * are cleared. 195 */ 196 197 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV 198 * vsi_type should always be 6 for backward compatibility. Add other fields 199 * as needed. 200 */ 201 enum virtchnl_vsi_type { 202 VIRTCHNL_VSI_TYPE_INVALID = 0, 203 VIRTCHNL_VSI_SRIOV = 6, 204 }; 205 206 /* VIRTCHNL_OP_GET_VF_RESOURCES 207 * Version 1.0 VF sends this request to PF with no parameters 208 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities 209 * PF responds with an indirect message containing 210 * virtchnl_vf_resource and one or more 211 * virtchnl_vsi_resource structures. 212 */ 213 214 struct virtchnl_vsi_resource { 215 u16 vsi_id; 216 u16 num_queue_pairs; 217 enum virtchnl_vsi_type vsi_type; 218 u16 qset_handle; 219 u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS]; 220 }; 221 222 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource); 223 224 /* VF capability flags 225 * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including 226 * TX/RX Checksum offloading and TSO for non-tunnelled packets. 227 */ 228 #define VIRTCHNL_VF_OFFLOAD_L2 0x00000001 229 #define VIRTCHNL_VF_OFFLOAD_IWARP 0x00000002 230 #define VIRTCHNL_VF_OFFLOAD_RSVD 0x00000004 231 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ 0x00000008 232 #define VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010 233 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020 234 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES 0x00000040 235 #define VIRTCHNL_VF_OFFLOAD_CRC 0x00000080 236 #define VIRTCHNL_VF_OFFLOAD_VLAN 0x00010000 237 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING 0x00020000 238 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2 0x00040000 239 #define VIRTCHNL_VF_OFFLOAD_RSS_PF 0X00080000 240 #define VIRTCHNL_VF_OFFLOAD_ENCAP 0X00100000 241 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM 0X00200000 242 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM 0X00400000 243 /* Define below the capability flags that are not offloads */ 244 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED 0x00000080 245 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \ 246 VIRTCHNL_VF_OFFLOAD_VLAN | \ 247 VIRTCHNL_VF_OFFLOAD_RSS_PF) 248 249 struct virtchnl_vf_resource { 250 u16 num_vsis; 251 u16 num_queue_pairs; 252 u16 max_vectors; 253 u16 max_mtu; 254 255 u32 vf_cap_flags; 256 u32 rss_key_size; 257 u32 rss_lut_size; 258 259 struct virtchnl_vsi_resource vsi_res[1]; 260 }; 261 262 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource); 263 264 /* VIRTCHNL_OP_CONFIG_TX_QUEUE 265 * VF sends this message to set up parameters for one TX queue. 266 * External data buffer contains one instance of virtchnl_txq_info. 267 * PF configures requested queue and returns a status code. 268 */ 269 270 /* Tx queue config info */ 271 struct virtchnl_txq_info { 272 u16 vsi_id; 273 u16 queue_id; 274 u16 ring_len; /* number of descriptors, multiple of 8 */ 275 u16 headwb_enabled; /* deprecated with AVF 1.0 */ 276 u64 dma_ring_addr; 277 u64 dma_headwb_addr; /* deprecated with AVF 1.0 */ 278 }; 279 280 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info); 281 282 /* VIRTCHNL_OP_CONFIG_RX_QUEUE 283 * VF sends this message to set up parameters for one RX queue. 284 * External data buffer contains one instance of virtchnl_rxq_info. 285 * PF configures requested queue and returns a status code. The 286 * crc_disable flag disables CRC stripping on the VF. Setting 287 * the crc_disable flag to 1 will disable CRC stripping for each 288 * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC 289 * offload must have been set prior to sending this info or the PF 290 * will ignore the request. This flag should be set the same for 291 * all of the queues for a VF. 292 */ 293 294 /* Rx queue config info */ 295 struct virtchnl_rxq_info { 296 u16 vsi_id; 297 u16 queue_id; 298 u32 ring_len; /* number of descriptors, multiple of 32 */ 299 u16 hdr_size; 300 u16 splithdr_enabled; /* deprecated with AVF 1.0 */ 301 u32 databuffer_size; 302 u32 max_pkt_size; 303 u8 crc_disable; 304 u8 pad1[3]; 305 u64 dma_ring_addr; 306 enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */ 307 u32 pad2; 308 }; 309 310 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info); 311 312 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES 313 * VF sends this message to set parameters for all active TX and RX queues 314 * associated with the specified VSI. 315 * PF configures queues and returns status. 316 * If the number of queues specified is greater than the number of queues 317 * associated with the VSI, an error is returned and no queues are configured. 318 */ 319 struct virtchnl_queue_pair_info { 320 /* NOTE: vsi_id and queue_id should be identical for both queues. */ 321 struct virtchnl_txq_info txq; 322 struct virtchnl_rxq_info rxq; 323 }; 324 325 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info); 326 327 struct virtchnl_vsi_queue_config_info { 328 u16 vsi_id; 329 u16 num_queue_pairs; 330 u32 pad; 331 struct virtchnl_queue_pair_info qpair[1]; 332 }; 333 334 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info); 335 336 /* VIRTCHNL_OP_REQUEST_QUEUES 337 * VF sends this message to request the PF to allocate additional queues to 338 * this VF. Each VF gets a guaranteed number of queues on init but asking for 339 * additional queues must be negotiated. This is a best effort request as it 340 * is possible the PF does not have enough queues left to support the request. 341 * If the PF cannot support the number requested it will respond with the 342 * maximum number it is able to support. If the request is successful, PF will 343 * then reset the VF to institute required changes. 344 */ 345 346 /* VF resource request */ 347 struct virtchnl_vf_res_request { 348 u16 num_queue_pairs; 349 }; 350 351 /* VIRTCHNL_OP_CONFIG_IRQ_MAP 352 * VF uses this message to map vectors to queues. 353 * The rxq_map and txq_map fields are bitmaps used to indicate which queues 354 * are to be associated with the specified vector. 355 * The "other" causes are always mapped to vector 0. 356 * PF configures interrupt mapping and returns status. 357 */ 358 struct virtchnl_vector_map { 359 u16 vsi_id; 360 u16 vector_id; 361 u16 rxq_map; 362 u16 txq_map; 363 u16 rxitr_idx; 364 u16 txitr_idx; 365 }; 366 367 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map); 368 369 struct virtchnl_irq_map_info { 370 u16 num_vectors; 371 struct virtchnl_vector_map vecmap[1]; 372 }; 373 374 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info); 375 376 /* VIRTCHNL_OP_ENABLE_QUEUES 377 * VIRTCHNL_OP_DISABLE_QUEUES 378 * VF sends these message to enable or disable TX/RX queue pairs. 379 * The queues fields are bitmaps indicating which queues to act upon. 380 * (Currently, we only support 16 queues per VF, but we make the field 381 * u32 to allow for expansion.) 382 * PF performs requested action and returns status. 383 */ 384 struct virtchnl_queue_select { 385 u16 vsi_id; 386 u16 pad; 387 u32 rx_queues; 388 u32 tx_queues; 389 }; 390 391 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select); 392 393 /* VIRTCHNL_OP_ADD_ETH_ADDR 394 * VF sends this message in order to add one or more unicast or multicast 395 * address filters for the specified VSI. 396 * PF adds the filters and returns status. 397 */ 398 399 /* VIRTCHNL_OP_DEL_ETH_ADDR 400 * VF sends this message in order to remove one or more unicast or multicast 401 * filters for the specified VSI. 402 * PF removes the filters and returns status. 403 */ 404 405 /* VIRTCHNL_ETHER_ADDR_LEGACY 406 * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad 407 * bytes. Moving forward all VF drivers should not set type to 408 * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy 409 * behavior. The control plane function (i.e. PF) can use a best effort method 410 * of tracking the primary/device unicast in this case, but there is no 411 * guarantee and functionality depends on the implementation of the PF. 412 */ 413 414 /* VIRTCHNL_ETHER_ADDR_PRIMARY 415 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the 416 * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and 417 * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane 418 * function (i.e. PF) to accurately track and use this MAC address for 419 * displaying on the host and for VM/function reset. 420 */ 421 422 /* VIRTCHNL_ETHER_ADDR_EXTRA 423 * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra 424 * unicast and/or multicast filters that are being added/deleted via 425 * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively. 426 */ 427 struct virtchnl_ether_addr { 428 u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS]; 429 u8 type; 430 #define VIRTCHNL_ETHER_ADDR_LEGACY 0 431 #define VIRTCHNL_ETHER_ADDR_PRIMARY 1 432 #define VIRTCHNL_ETHER_ADDR_EXTRA 2 433 #define VIRTCHNL_ETHER_ADDR_TYPE_MASK 3 /* first two bits of type are valid */ 434 u8 pad; 435 }; 436 437 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr); 438 439 struct virtchnl_ether_addr_list { 440 u16 vsi_id; 441 u16 num_elements; 442 struct virtchnl_ether_addr list[1]; 443 }; 444 445 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list); 446 447 #ifdef VIRTCHNL_SOL_VF_SUPPORT 448 /* VIRTCHNL_OP_GET_ADDNL_SOL_CONFIG 449 * VF sends this message to get the default MTU and list of additional ethernet 450 * addresses it is allowed to use. 451 * PF responds with an indirect message containing 452 * virtchnl_addnl_solaris_config with zero or more 453 * virtchnl_ether_addr structures. 454 * 455 * It is expected that this operation will only ever be needed for Solaris VFs 456 * running under a Solaris PF. 457 */ 458 struct virtchnl_addnl_solaris_config { 459 u16 default_mtu; 460 struct virtchnl_ether_addr_list al; 461 }; 462 463 #endif 464 /* VIRTCHNL_OP_ADD_VLAN 465 * VF sends this message to add one or more VLAN tag filters for receives. 466 * PF adds the filters and returns status. 467 * If a port VLAN is configured by the PF, this operation will return an 468 * error to the VF. 469 */ 470 471 /* VIRTCHNL_OP_DEL_VLAN 472 * VF sends this message to remove one or more VLAN tag filters for receives. 473 * PF removes the filters and returns status. 474 * If a port VLAN is configured by the PF, this operation will return an 475 * error to the VF. 476 */ 477 478 struct virtchnl_vlan_filter_list { 479 u16 vsi_id; 480 u16 num_elements; 481 u16 vlan_id[1]; 482 }; 483 484 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list); 485 486 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE 487 * VF sends VSI id and flags. 488 * PF returns status code in retval. 489 * Note: we assume that broadcast accept mode is always enabled. 490 */ 491 struct virtchnl_promisc_info { 492 u16 vsi_id; 493 u16 flags; 494 }; 495 496 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info); 497 498 #define FLAG_VF_UNICAST_PROMISC 0x00000001 499 #define FLAG_VF_MULTICAST_PROMISC 0x00000002 500 501 /* VIRTCHNL_OP_GET_STATS 502 * VF sends this message to request stats for the selected VSI. VF uses 503 * the virtchnl_queue_select struct to specify the VSI. The queue_id 504 * field is ignored by the PF. 505 * 506 * PF replies with struct eth_stats in an external buffer. 507 */ 508 509 /* VIRTCHNL_OP_CONFIG_RSS_KEY 510 * VIRTCHNL_OP_CONFIG_RSS_LUT 511 * VF sends these messages to configure RSS. Only supported if both PF 512 * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during 513 * configuration negotiation. If this is the case, then the RSS fields in 514 * the VF resource struct are valid. 515 * Both the key and LUT are initialized to 0 by the PF, meaning that 516 * RSS is effectively disabled until set up by the VF. 517 */ 518 struct virtchnl_rss_key { 519 u16 vsi_id; 520 u16 key_len; 521 u8 key[1]; /* RSS hash key, packed bytes */ 522 }; 523 524 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key); 525 526 struct virtchnl_rss_lut { 527 u16 vsi_id; 528 u16 lut_entries; 529 u8 lut[1]; /* RSS lookup table */ 530 }; 531 532 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut); 533 534 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS 535 * VIRTCHNL_OP_SET_RSS_HENA 536 * VF sends these messages to get and set the hash filter enable bits for RSS. 537 * By default, the PF sets these to all possible traffic types that the 538 * hardware supports. The VF can query this value if it wants to change the 539 * traffic types that are hashed by the hardware. 540 */ 541 struct virtchnl_rss_hena { 542 u64 hena; 543 }; 544 545 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena); 546 547 /* VIRTCHNL_OP_EVENT 548 * PF sends this message to inform the VF driver of events that may affect it. 549 * No direct response is expected from the VF, though it may generate other 550 * messages in response to this one. 551 */ 552 enum virtchnl_event_codes { 553 VIRTCHNL_EVENT_UNKNOWN = 0, 554 VIRTCHNL_EVENT_LINK_CHANGE, 555 VIRTCHNL_EVENT_RESET_IMPENDING, 556 VIRTCHNL_EVENT_PF_DRIVER_CLOSE, 557 }; 558 559 #define PF_EVENT_SEVERITY_INFO 0 560 #define PF_EVENT_SEVERITY_ATTENTION 1 561 #define PF_EVENT_SEVERITY_ACTION_REQUIRED 2 562 #define PF_EVENT_SEVERITY_CERTAIN_DOOM 255 563 564 struct virtchnl_pf_event { 565 enum virtchnl_event_codes event; 566 union { 567 /* If the PF driver does not support the new speed reporting 568 * capabilities then use link_event else use link_event_adv to 569 * get the speed and link information. The ability to understand 570 * new speeds is indicated by setting the capability flag 571 * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter 572 * in virtchnl_vf_resource struct and can be used to determine 573 * which link event struct to use below. 574 */ 575 struct { 576 enum virtchnl_link_speed link_speed; 577 bool link_status; 578 } link_event; 579 struct { 580 /* link_speed provided in Mbps */ 581 u32 link_speed; 582 u8 link_status; 583 } link_event_adv; 584 } event_data; 585 586 int severity; 587 }; 588 589 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event); 590 591 #ifdef VIRTCHNL_IWARP 592 593 /* VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP 594 * VF uses this message to request PF to map IWARP vectors to IWARP queues. 595 * The request for this originates from the VF IWARP driver through 596 * a client interface between VF LAN and VF IWARP driver. 597 * A vector could have an AEQ and CEQ attached to it although 598 * there is a single AEQ per VF IWARP instance in which case 599 * most vectors will have an INVALID_IDX for aeq and valid idx for ceq. 600 * There will never be a case where there will be multiple CEQs attached 601 * to a single vector. 602 * PF configures interrupt mapping and returns status. 603 */ 604 605 /* HW does not define a type value for AEQ; only for RX/TX and CEQ. 606 * In order for us to keep the interface simple, SW will define a 607 * unique type value for AEQ. 608 */ 609 #define QUEUE_TYPE_PE_AEQ 0x80 610 #define QUEUE_INVALID_IDX 0xFFFF 611 612 struct virtchnl_iwarp_qv_info { 613 u32 v_idx; /* msix_vector */ 614 u16 ceq_idx; 615 u16 aeq_idx; 616 u8 itr_idx; 617 }; 618 619 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_iwarp_qv_info); 620 621 struct virtchnl_iwarp_qvlist_info { 622 u32 num_vectors; 623 struct virtchnl_iwarp_qv_info qv_info[1]; 624 }; 625 626 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_iwarp_qvlist_info); 627 628 #endif 629 630 /* VF reset states - these are written into the RSTAT register: 631 * VFGEN_RSTAT on the VF 632 * When the PF initiates a reset, it writes 0 633 * When the reset is complete, it writes 1 634 * When the PF detects that the VF has recovered, it writes 2 635 * VF checks this register periodically to determine if a reset has occurred, 636 * then polls it to know when the reset is complete. 637 * If either the PF or VF reads the register while the hardware 638 * is in a reset state, it will return DEADBEEF, which, when masked 639 * will result in 3. 640 */ 641 enum virtchnl_vfr_states { 642 VIRTCHNL_VFR_INPROGRESS = 0, 643 VIRTCHNL_VFR_COMPLETED, 644 VIRTCHNL_VFR_VFACTIVE, 645 }; 646 647 /** 648 * virtchnl_vc_validate_vf_msg 649 * @ver: Virtchnl version info 650 * @v_opcode: Opcode for the message 651 * @msg: pointer to the msg buffer 652 * @msglen: msg length 653 * 654 * validate msg format against struct for each opcode 655 */ 656 static inline int 657 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode, 658 u8 *msg, u16 msglen) 659 { 660 bool err_msg_format = false; 661 int valid_len = 0; 662 663 /* Validate message length. */ 664 switch (v_opcode) { 665 case VIRTCHNL_OP_VERSION: 666 valid_len = sizeof(struct virtchnl_version_info); 667 break; 668 case VIRTCHNL_OP_RESET_VF: 669 break; 670 case VIRTCHNL_OP_GET_VF_RESOURCES: 671 if (VF_IS_V11(ver)) 672 valid_len = sizeof(u32); 673 break; 674 case VIRTCHNL_OP_CONFIG_TX_QUEUE: 675 valid_len = sizeof(struct virtchnl_txq_info); 676 break; 677 case VIRTCHNL_OP_CONFIG_RX_QUEUE: 678 valid_len = sizeof(struct virtchnl_rxq_info); 679 break; 680 case VIRTCHNL_OP_CONFIG_VSI_QUEUES: 681 valid_len = sizeof(struct virtchnl_vsi_queue_config_info); 682 if (msglen >= valid_len) { 683 struct virtchnl_vsi_queue_config_info *vqc = 684 (struct virtchnl_vsi_queue_config_info *)msg; 685 valid_len += (vqc->num_queue_pairs * 686 sizeof(struct 687 virtchnl_queue_pair_info)); 688 if (vqc->num_queue_pairs == 0) 689 err_msg_format = true; 690 } 691 break; 692 case VIRTCHNL_OP_CONFIG_IRQ_MAP: 693 valid_len = sizeof(struct virtchnl_irq_map_info); 694 if (msglen >= valid_len) { 695 struct virtchnl_irq_map_info *vimi = 696 (struct virtchnl_irq_map_info *)msg; 697 valid_len += (vimi->num_vectors * 698 sizeof(struct virtchnl_vector_map)); 699 if (vimi->num_vectors == 0) 700 err_msg_format = true; 701 } 702 break; 703 case VIRTCHNL_OP_ENABLE_QUEUES: 704 case VIRTCHNL_OP_DISABLE_QUEUES: 705 valid_len = sizeof(struct virtchnl_queue_select); 706 break; 707 case VIRTCHNL_OP_ADD_ETH_ADDR: 708 case VIRTCHNL_OP_DEL_ETH_ADDR: 709 valid_len = sizeof(struct virtchnl_ether_addr_list); 710 if (msglen >= valid_len) { 711 struct virtchnl_ether_addr_list *veal = 712 (struct virtchnl_ether_addr_list *)msg; 713 valid_len += veal->num_elements * 714 sizeof(struct virtchnl_ether_addr); 715 if (veal->num_elements == 0) 716 err_msg_format = true; 717 } 718 break; 719 case VIRTCHNL_OP_ADD_VLAN: 720 case VIRTCHNL_OP_DEL_VLAN: 721 valid_len = sizeof(struct virtchnl_vlan_filter_list); 722 if (msglen >= valid_len) { 723 struct virtchnl_vlan_filter_list *vfl = 724 (struct virtchnl_vlan_filter_list *)msg; 725 valid_len += vfl->num_elements * sizeof(u16); 726 if (vfl->num_elements == 0) 727 err_msg_format = true; 728 } 729 break; 730 case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE: 731 valid_len = sizeof(struct virtchnl_promisc_info); 732 break; 733 case VIRTCHNL_OP_GET_STATS: 734 valid_len = sizeof(struct virtchnl_queue_select); 735 break; 736 #ifdef VIRTCHNL_IWARP 737 case VIRTCHNL_OP_IWARP: 738 /* These messages are opaque to us and will be validated in 739 * the RDMA client code. We just need to check for nonzero 740 * length. The firmware will enforce max length restrictions. 741 */ 742 if (msglen) 743 valid_len = msglen; 744 else 745 err_msg_format = true; 746 break; 747 case VIRTCHNL_OP_RELEASE_IWARP_IRQ_MAP: 748 break; 749 case VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP: 750 valid_len = sizeof(struct virtchnl_iwarp_qvlist_info); 751 if (msglen >= valid_len) { 752 struct virtchnl_iwarp_qvlist_info *qv = 753 (struct virtchnl_iwarp_qvlist_info *)msg; 754 if (qv->num_vectors == 0) { 755 err_msg_format = true; 756 break; 757 } 758 valid_len += ((qv->num_vectors - 1) * 759 sizeof(struct virtchnl_iwarp_qv_info)); 760 } 761 break; 762 #endif 763 case VIRTCHNL_OP_CONFIG_RSS_KEY: 764 valid_len = sizeof(struct virtchnl_rss_key); 765 if (msglen >= valid_len) { 766 struct virtchnl_rss_key *vrk = 767 (struct virtchnl_rss_key *)msg; 768 valid_len += vrk->key_len - 1; 769 } 770 break; 771 case VIRTCHNL_OP_CONFIG_RSS_LUT: 772 valid_len = sizeof(struct virtchnl_rss_lut); 773 if (msglen >= valid_len) { 774 struct virtchnl_rss_lut *vrl = 775 (struct virtchnl_rss_lut *)msg; 776 valid_len += vrl->lut_entries - 1; 777 } 778 break; 779 case VIRTCHNL_OP_GET_RSS_HENA_CAPS: 780 break; 781 case VIRTCHNL_OP_SET_RSS_HENA: 782 valid_len = sizeof(struct virtchnl_rss_hena); 783 break; 784 case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING: 785 case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING: 786 break; 787 case VIRTCHNL_OP_REQUEST_QUEUES: 788 valid_len = sizeof(struct virtchnl_vf_res_request); 789 break; 790 /* These are always errors coming from the VF. */ 791 case VIRTCHNL_OP_EVENT: 792 case VIRTCHNL_OP_UNKNOWN: 793 default: 794 return VIRTCHNL_STATUS_ERR_PARAM; 795 } 796 /* few more checks */ 797 if (err_msg_format || valid_len != msglen) 798 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH; 799 800 return 0; 801 } 802 #endif /* _VIRTCHNL_H_ */ 803