1 /******************************************************************************* 2 * 3 * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver 4 * Copyright(c) 2013 - 2014 Intel Corporation. 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms and conditions of the GNU General Public License, 8 * version 2, as published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 13 * more details. 14 * 15 * You should have received a copy of the GNU General Public License along 16 * with this program. If not, see <http://www.gnu.org/licenses/>. 17 * 18 * The full GNU General Public License is included in this distribution in 19 * the file called "COPYING". 20 * 21 * Contact Information: 22 * e1000-devel Mailing List <[email protected]> 23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 24 * 25 ******************************************************************************/ 26 27 #ifndef _VIRTCHNL_H_ 28 #define _VIRTCHNL_H_ 29 30 /* Description: 31 * This header file describes the VF-PF communication protocol used 32 * by the drivers for all devices starting from our 40G product line 33 * 34 * Admin queue buffer usage: 35 * desc->opcode is always aqc_opc_send_msg_to_pf 36 * flags, retval, datalen, and data addr are all used normally. 37 * The Firmware copies the cookie fields when sending messages between the 38 * PF and VF, but uses all other fields internally. Due to this limitation, 39 * we must send all messages as "indirect", i.e. using an external buffer. 40 * 41 * All the VSI indexes are relative to the VF. Each VF can have maximum of 42 * three VSIs. All the queue indexes are relative to the VSI. Each VF can 43 * have a maximum of sixteen queues for all of its VSIs. 44 * 45 * The PF is required to return a status code in v_retval for all messages 46 * except RESET_VF, which does not require any response. The return value 47 * is of status_code type, defined in the shared type.h. 48 * 49 * In general, VF driver initialization should roughly follow the order of 50 * these opcodes. The VF driver must first validate the API version of the 51 * PF driver, then request a reset, then get resources, then configure 52 * queues and interrupts. After these operations are complete, the VF 53 * driver may start its queues, optionally add MAC and VLAN filters, and 54 * process traffic. 55 */ 56 57 /* START GENERIC DEFINES 58 * Need to ensure the following enums and defines hold the same meaning and 59 * value in current and future projects 60 */ 61 62 /* Error Codes */ 63 enum virtchnl_status_code { 64 VIRTCHNL_STATUS_SUCCESS = 0, 65 VIRTCHNL_ERR_PARAM = -5, 66 VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH = -38, 67 VIRTCHNL_STATUS_ERR_CQP_COMPL_ERROR = -39, 68 VIRTCHNL_STATUS_ERR_INVALID_VF_ID = -40, 69 VIRTCHNL_STATUS_NOT_SUPPORTED = -64, 70 }; 71 72 #define VIRTCHNL_LINK_SPEED_100MB_SHIFT 0x1 73 #define VIRTCHNL_LINK_SPEED_1000MB_SHIFT 0x2 74 #define VIRTCHNL_LINK_SPEED_10GB_SHIFT 0x3 75 #define VIRTCHNL_LINK_SPEED_40GB_SHIFT 0x4 76 #define VIRTCHNL_LINK_SPEED_20GB_SHIFT 0x5 77 #define VIRTCHNL_LINK_SPEED_25GB_SHIFT 0x6 78 79 enum virtchnl_link_speed { 80 VIRTCHNL_LINK_SPEED_UNKNOWN = 0, 81 VIRTCHNL_LINK_SPEED_100MB = BIT(VIRTCHNL_LINK_SPEED_100MB_SHIFT), 82 VIRTCHNL_LINK_SPEED_1GB = BIT(VIRTCHNL_LINK_SPEED_1000MB_SHIFT), 83 VIRTCHNL_LINK_SPEED_10GB = BIT(VIRTCHNL_LINK_SPEED_10GB_SHIFT), 84 VIRTCHNL_LINK_SPEED_40GB = BIT(VIRTCHNL_LINK_SPEED_40GB_SHIFT), 85 VIRTCHNL_LINK_SPEED_20GB = BIT(VIRTCHNL_LINK_SPEED_20GB_SHIFT), 86 VIRTCHNL_LINK_SPEED_25GB = BIT(VIRTCHNL_LINK_SPEED_25GB_SHIFT), 87 }; 88 89 /* for hsplit_0 field of Rx HMC context */ 90 /* deprecated with AVF 1.0 */ 91 enum virtchnl_rx_hsplit { 92 VIRTCHNL_RX_HSPLIT_NO_SPLIT = 0, 93 VIRTCHNL_RX_HSPLIT_SPLIT_L2 = 1, 94 VIRTCHNL_RX_HSPLIT_SPLIT_IP = 2, 95 VIRTCHNL_RX_HSPLIT_SPLIT_TCP_UDP = 4, 96 VIRTCHNL_RX_HSPLIT_SPLIT_SCTP = 8, 97 }; 98 99 /* END GENERIC DEFINES */ 100 101 /* Opcodes for VF-PF communication. These are placed in the v_opcode field 102 * of the virtchnl_msg structure. 103 */ 104 enum virtchnl_ops { 105 /* The PF sends status change events to VFs using 106 * the VIRTCHNL_OP_EVENT opcode. 107 * VFs send requests to the PF using the other ops. 108 * Use of "advanced opcode" features must be negotiated as part of capabilities 109 * exchange and are not considered part of base mode feature set. 110 */ 111 VIRTCHNL_OP_UNKNOWN = 0, 112 VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */ 113 VIRTCHNL_OP_RESET_VF = 2, 114 VIRTCHNL_OP_GET_VF_RESOURCES = 3, 115 VIRTCHNL_OP_CONFIG_TX_QUEUE = 4, 116 VIRTCHNL_OP_CONFIG_RX_QUEUE = 5, 117 VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6, 118 VIRTCHNL_OP_CONFIG_IRQ_MAP = 7, 119 VIRTCHNL_OP_ENABLE_QUEUES = 8, 120 VIRTCHNL_OP_DISABLE_QUEUES = 9, 121 VIRTCHNL_OP_ADD_ETH_ADDR = 10, 122 VIRTCHNL_OP_DEL_ETH_ADDR = 11, 123 VIRTCHNL_OP_ADD_VLAN = 12, 124 VIRTCHNL_OP_DEL_VLAN = 13, 125 VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14, 126 VIRTCHNL_OP_GET_STATS = 15, 127 VIRTCHNL_OP_RSVD = 16, 128 VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */ 129 VIRTCHNL_OP_IWARP = 20, /* advanced opcode */ 130 VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP = 21, /* advanced opcode */ 131 VIRTCHNL_OP_RELEASE_IWARP_IRQ_MAP = 22, /* advanced opcode */ 132 VIRTCHNL_OP_CONFIG_RSS_KEY = 23, 133 VIRTCHNL_OP_CONFIG_RSS_LUT = 24, 134 VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25, 135 VIRTCHNL_OP_SET_RSS_HENA = 26, 136 }; 137 138 /* This macro is used to generate a compilation error if a structure 139 * is not exactly the correct length. It gives a divide by zero error if the 140 * structure is not of the correct size, otherwise it creates an enum that is 141 * never used. 142 */ 143 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \ 144 { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) } 145 146 /* Virtual channel message descriptor. This overlays the admin queue 147 * descriptor. All other data is passed in external buffers. 148 */ 149 150 struct virtchnl_msg { 151 u8 pad[8]; /* AQ flags/opcode/len/retval fields */ 152 enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */ 153 enum virtchnl_status_code v_retval; /* ditto for desc->retval */ 154 u32 vfid; /* used by PF when sending to VF */ 155 }; 156 157 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg); 158 159 /* Message descriptions and data structures.*/ 160 161 /* VIRTCHNL_OP_VERSION 162 * VF posts its version number to the PF. PF responds with its version number 163 * in the same format, along with a return code. 164 * Reply from PF has its major/minor versions also in param0 and param1. 165 * If there is a major version mismatch, then the VF cannot operate. 166 * If there is a minor version mismatch, then the VF can operate but should 167 * add a warning to the system log. 168 * 169 * This enum element MUST always be specified as == 1, regardless of other 170 * changes in the API. The PF must always respond to this message without 171 * error regardless of version mismatch. 172 */ 173 #define VIRTCHNL_VERSION_MAJOR 1 174 #define VIRTCHNL_VERSION_MINOR 1 175 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0 176 177 struct virtchnl_version_info { 178 u32 major; 179 u32 minor; 180 }; 181 182 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info); 183 184 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0)) 185 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1)) 186 187 /* VIRTCHNL_OP_RESET_VF 188 * VF sends this request to PF with no parameters 189 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register 190 * until reset completion is indicated. The admin queue must be reinitialized 191 * after this operation. 192 * 193 * When reset is complete, PF must ensure that all queues in all VSIs associated 194 * with the VF are stopped, all queue configurations in the HMC are set to 0, 195 * and all MAC and VLAN filters (except the default MAC address) on all VSIs 196 * are cleared. 197 */ 198 199 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV 200 * vsi_type should always be 6 for backward compatibility. Add other fields 201 * as needed. 202 */ 203 enum virtchnl_vsi_type { 204 VIRTCHNL_VSI_TYPE_INVALID = 0, 205 VIRTCHNL_VSI_SRIOV = 6, 206 }; 207 208 /* VIRTCHNL_OP_GET_VF_RESOURCES 209 * Version 1.0 VF sends this request to PF with no parameters 210 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities 211 * PF responds with an indirect message containing 212 * virtchnl_vf_resource and one or more 213 * virtchnl_vsi_resource structures. 214 */ 215 216 struct virtchnl_vsi_resource { 217 u16 vsi_id; 218 u16 num_queue_pairs; 219 enum virtchnl_vsi_type vsi_type; 220 u16 qset_handle; 221 u8 default_mac_addr[ETH_ALEN]; 222 }; 223 224 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource); 225 226 /* VF offload flags 227 * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including 228 * TX/RX Checksum offloading and TSO for non-tunnelled packets. 229 */ 230 #define VIRTCHNL_VF_OFFLOAD_L2 0x00000001 231 #define VIRTCHNL_VF_OFFLOAD_IWARP 0x00000002 232 #define VIRTCHNL_VF_OFFLOAD_RSVD 0x00000004 233 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ 0x00000008 234 #define VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010 235 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020 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 244 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \ 245 VIRTCHNL_VF_OFFLOAD_VLAN | \ 246 VIRTCHNL_VF_OFFLOAD_RSS_PF) 247 248 struct virtchnl_vf_resource { 249 u16 num_vsis; 250 u16 num_queue_pairs; 251 u16 max_vectors; 252 u16 max_mtu; 253 254 u32 vf_offload_flags; 255 u32 rss_key_size; 256 u32 rss_lut_size; 257 258 struct virtchnl_vsi_resource vsi_res[1]; 259 }; 260 261 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource); 262 263 /* VIRTCHNL_OP_CONFIG_TX_QUEUE 264 * VF sends this message to set up parameters for one TX queue. 265 * External data buffer contains one instance of virtchnl_txq_info. 266 * PF configures requested queue and returns a status code. 267 */ 268 269 /* Tx queue config info */ 270 struct virtchnl_txq_info { 271 u16 vsi_id; 272 u16 queue_id; 273 u16 ring_len; /* number of descriptors, multiple of 8 */ 274 u16 headwb_enabled; /* deprecated with AVF 1.0 */ 275 u64 dma_ring_addr; 276 u64 dma_headwb_addr; /* deprecated with AVF 1.0 */ 277 }; 278 279 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info); 280 281 /* VIRTCHNL_OP_CONFIG_RX_QUEUE 282 * VF sends this message to set up parameters for one RX queue. 283 * External data buffer contains one instance of virtchnl_rxq_info. 284 * PF configures requested queue and returns a status code. 285 */ 286 287 /* Rx queue config info */ 288 struct virtchnl_rxq_info { 289 u16 vsi_id; 290 u16 queue_id; 291 u32 ring_len; /* number of descriptors, multiple of 32 */ 292 u16 hdr_size; 293 u16 splithdr_enabled; /* deprecated with AVF 1.0 */ 294 u32 databuffer_size; 295 u32 max_pkt_size; 296 u32 pad1; 297 u64 dma_ring_addr; 298 enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */ 299 u32 pad2; 300 }; 301 302 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info); 303 304 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES 305 * VF sends this message to set parameters for all active TX and RX queues 306 * associated with the specified VSI. 307 * PF configures queues and returns status. 308 * If the number of queues specified is greater than the number of queues 309 * associated with the VSI, an error is returned and no queues are configured. 310 */ 311 struct virtchnl_queue_pair_info { 312 /* NOTE: vsi_id and queue_id should be identical for both queues. */ 313 struct virtchnl_txq_info txq; 314 struct virtchnl_rxq_info rxq; 315 }; 316 317 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info); 318 319 struct virtchnl_vsi_queue_config_info { 320 u16 vsi_id; 321 u16 num_queue_pairs; 322 u32 pad; 323 struct virtchnl_queue_pair_info qpair[1]; 324 }; 325 326 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info); 327 328 /* VIRTCHNL_OP_CONFIG_IRQ_MAP 329 * VF uses this message to map vectors to queues. 330 * The rxq_map and txq_map fields are bitmaps used to indicate which queues 331 * are to be associated with the specified vector. 332 * The "other" causes are always mapped to vector 0. 333 * PF configures interrupt mapping and returns status. 334 */ 335 struct virtchnl_vector_map { 336 u16 vsi_id; 337 u16 vector_id; 338 u16 rxq_map; 339 u16 txq_map; 340 u16 rxitr_idx; 341 u16 txitr_idx; 342 }; 343 344 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map); 345 346 struct virtchnl_irq_map_info { 347 u16 num_vectors; 348 struct virtchnl_vector_map vecmap[1]; 349 }; 350 351 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info); 352 353 /* VIRTCHNL_OP_ENABLE_QUEUES 354 * VIRTCHNL_OP_DISABLE_QUEUES 355 * VF sends these message to enable or disable TX/RX queue pairs. 356 * The queues fields are bitmaps indicating which queues to act upon. 357 * (Currently, we only support 16 queues per VF, but we make the field 358 * u32 to allow for expansion.) 359 * PF performs requested action and returns status. 360 */ 361 struct virtchnl_queue_select { 362 u16 vsi_id; 363 u16 pad; 364 u32 rx_queues; 365 u32 tx_queues; 366 }; 367 368 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select); 369 370 /* VIRTCHNL_OP_ADD_ETH_ADDR 371 * VF sends this message in order to add one or more unicast or multicast 372 * address filters for the specified VSI. 373 * PF adds the filters and returns status. 374 */ 375 376 /* VIRTCHNL_OP_DEL_ETH_ADDR 377 * VF sends this message in order to remove one or more unicast or multicast 378 * filters for the specified VSI. 379 * PF removes the filters and returns status. 380 */ 381 382 struct virtchnl_ether_addr { 383 u8 addr[ETH_ALEN]; 384 u8 pad[2]; 385 }; 386 387 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr); 388 389 struct virtchnl_ether_addr_list { 390 u16 vsi_id; 391 u16 num_elements; 392 struct virtchnl_ether_addr list[1]; 393 }; 394 395 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list); 396 397 /* VIRTCHNL_OP_ADD_VLAN 398 * VF sends this message to add one or more VLAN tag filters for receives. 399 * PF adds the filters and returns status. 400 * If a port VLAN is configured by the PF, this operation will return an 401 * error to the VF. 402 */ 403 404 /* VIRTCHNL_OP_DEL_VLAN 405 * VF sends this message to remove one or more VLAN tag filters for receives. 406 * PF removes the filters and returns status. 407 * If a port VLAN is configured by the PF, this operation will return an 408 * error to the VF. 409 */ 410 411 struct virtchnl_vlan_filter_list { 412 u16 vsi_id; 413 u16 num_elements; 414 u16 vlan_id[1]; 415 }; 416 417 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list); 418 419 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE 420 * VF sends VSI id and flags. 421 * PF returns status code in retval. 422 * Note: we assume that broadcast accept mode is always enabled. 423 */ 424 struct virtchnl_promisc_info { 425 u16 vsi_id; 426 u16 flags; 427 }; 428 429 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info); 430 431 #define FLAG_VF_UNICAST_PROMISC 0x00000001 432 #define FLAG_VF_MULTICAST_PROMISC 0x00000002 433 434 /* VIRTCHNL_OP_GET_STATS 435 * VF sends this message to request stats for the selected VSI. VF uses 436 * the virtchnl_queue_select struct to specify the VSI. The queue_id 437 * field is ignored by the PF. 438 * 439 * PF replies with struct eth_stats in an external buffer. 440 */ 441 442 /* VIRTCHNL_OP_CONFIG_RSS_KEY 443 * VIRTCHNL_OP_CONFIG_RSS_LUT 444 * VF sends these messages to configure RSS. Only supported if both PF 445 * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during 446 * configuration negotiation. If this is the case, then the RSS fields in 447 * the VF resource struct are valid. 448 * Both the key and LUT are initialized to 0 by the PF, meaning that 449 * RSS is effectively disabled until set up by the VF. 450 */ 451 struct virtchnl_rss_key { 452 u16 vsi_id; 453 u16 key_len; 454 u8 key[1]; /* RSS hash key, packed bytes */ 455 }; 456 457 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key); 458 459 struct virtchnl_rss_lut { 460 u16 vsi_id; 461 u16 lut_entries; 462 u8 lut[1]; /* RSS lookup table*/ 463 }; 464 465 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut); 466 467 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS 468 * VIRTCHNL_OP_SET_RSS_HENA 469 * VF sends these messages to get and set the hash filter enable bits for RSS. 470 * By default, the PF sets these to all possible traffic types that the 471 * hardware supports. The VF can query this value if it wants to change the 472 * traffic types that are hashed by the hardware. 473 */ 474 struct virtchnl_rss_hena { 475 u64 hena; 476 }; 477 478 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena); 479 480 /* VIRTCHNL_OP_EVENT 481 * PF sends this message to inform the VF driver of events that may affect it. 482 * No direct response is expected from the VF, though it may generate other 483 * messages in response to this one. 484 */ 485 enum virtchnl_event_codes { 486 VIRTCHNL_EVENT_UNKNOWN = 0, 487 VIRTCHNL_EVENT_LINK_CHANGE, 488 VIRTCHNL_EVENT_RESET_IMPENDING, 489 VIRTCHNL_EVENT_PF_DRIVER_CLOSE, 490 }; 491 492 #define PF_EVENT_SEVERITY_INFO 0 493 #define PF_EVENT_SEVERITY_CERTAIN_DOOM 255 494 495 struct virtchnl_pf_event { 496 enum virtchnl_event_codes event; 497 union { 498 struct { 499 enum virtchnl_link_speed link_speed; 500 bool link_status; 501 } link_event; 502 } event_data; 503 504 int severity; 505 }; 506 507 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event); 508 509 /* VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP 510 * VF uses this message to request PF to map IWARP vectors to IWARP queues. 511 * The request for this originates from the VF IWARP driver through 512 * a client interface between VF LAN and VF IWARP driver. 513 * A vector could have an AEQ and CEQ attached to it although 514 * there is a single AEQ per VF IWARP instance in which case 515 * most vectors will have an INVALID_IDX for aeq and valid idx for ceq. 516 * There will never be a case where there will be multiple CEQs attached 517 * to a single vector. 518 * PF configures interrupt mapping and returns status. 519 */ 520 521 struct virtchnl_iwarp_qv_info { 522 u32 v_idx; /* msix_vector */ 523 u16 ceq_idx; 524 u16 aeq_idx; 525 u8 itr_idx; 526 }; 527 528 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_iwarp_qv_info); 529 530 struct virtchnl_iwarp_qvlist_info { 531 u32 num_vectors; 532 struct virtchnl_iwarp_qv_info qv_info[1]; 533 }; 534 535 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_iwarp_qvlist_info); 536 537 /* VF reset states - these are written into the RSTAT register: 538 * VFGEN_RSTAT on the VF 539 * When the PF initiates a reset, it writes 0 540 * When the reset is complete, it writes 1 541 * When the PF detects that the VF has recovered, it writes 2 542 * VF checks this register periodically to determine if a reset has occurred, 543 * then polls it to know when the reset is complete. 544 * If either the PF or VF reads the register while the hardware 545 * is in a reset state, it will return DEADBEEF, which, when masked 546 * will result in 3. 547 */ 548 enum virtchnl_vfr_states { 549 VIRTCHNL_VFR_INPROGRESS = 0, 550 VIRTCHNL_VFR_COMPLETED, 551 VIRTCHNL_VFR_VFACTIVE, 552 }; 553 554 /** 555 * virtchnl_vc_validate_vf_msg 556 * @ver: Virtchnl version info 557 * @v_opcode: Opcode for the message 558 * @msg: pointer to the msg buffer 559 * @msglen: msg length 560 * 561 * validate msg format against struct for each opcode 562 */ 563 static inline int 564 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode, 565 u8 *msg, u16 msglen) 566 { 567 bool err_msg_format = false; 568 int valid_len = 0; 569 570 /* Validate message length. */ 571 switch (v_opcode) { 572 case VIRTCHNL_OP_VERSION: 573 valid_len = sizeof(struct virtchnl_version_info); 574 break; 575 case VIRTCHNL_OP_RESET_VF: 576 break; 577 case VIRTCHNL_OP_GET_VF_RESOURCES: 578 if (VF_IS_V11(ver)) 579 valid_len = sizeof(u32); 580 break; 581 case VIRTCHNL_OP_CONFIG_TX_QUEUE: 582 valid_len = sizeof(struct virtchnl_txq_info); 583 break; 584 case VIRTCHNL_OP_CONFIG_RX_QUEUE: 585 valid_len = sizeof(struct virtchnl_rxq_info); 586 break; 587 case VIRTCHNL_OP_CONFIG_VSI_QUEUES: 588 valid_len = sizeof(struct virtchnl_vsi_queue_config_info); 589 if (msglen >= valid_len) { 590 struct virtchnl_vsi_queue_config_info *vqc = 591 (struct virtchnl_vsi_queue_config_info *)msg; 592 valid_len += (vqc->num_queue_pairs * 593 sizeof(struct 594 virtchnl_queue_pair_info)); 595 if (vqc->num_queue_pairs == 0) 596 err_msg_format = true; 597 } 598 break; 599 case VIRTCHNL_OP_CONFIG_IRQ_MAP: 600 valid_len = sizeof(struct virtchnl_irq_map_info); 601 if (msglen >= valid_len) { 602 struct virtchnl_irq_map_info *vimi = 603 (struct virtchnl_irq_map_info *)msg; 604 valid_len += (vimi->num_vectors * 605 sizeof(struct virtchnl_vector_map)); 606 if (vimi->num_vectors == 0) 607 err_msg_format = true; 608 } 609 break; 610 case VIRTCHNL_OP_ENABLE_QUEUES: 611 case VIRTCHNL_OP_DISABLE_QUEUES: 612 valid_len = sizeof(struct virtchnl_queue_select); 613 break; 614 case VIRTCHNL_OP_ADD_ETH_ADDR: 615 case VIRTCHNL_OP_DEL_ETH_ADDR: 616 valid_len = sizeof(struct virtchnl_ether_addr_list); 617 if (msglen >= valid_len) { 618 struct virtchnl_ether_addr_list *veal = 619 (struct virtchnl_ether_addr_list *)msg; 620 valid_len += veal->num_elements * 621 sizeof(struct virtchnl_ether_addr); 622 if (veal->num_elements == 0) 623 err_msg_format = true; 624 } 625 break; 626 case VIRTCHNL_OP_ADD_VLAN: 627 case VIRTCHNL_OP_DEL_VLAN: 628 valid_len = sizeof(struct virtchnl_vlan_filter_list); 629 if (msglen >= valid_len) { 630 struct virtchnl_vlan_filter_list *vfl = 631 (struct virtchnl_vlan_filter_list *)msg; 632 valid_len += vfl->num_elements * sizeof(u16); 633 if (vfl->num_elements == 0) 634 err_msg_format = true; 635 } 636 break; 637 case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE: 638 valid_len = sizeof(struct virtchnl_promisc_info); 639 break; 640 case VIRTCHNL_OP_GET_STATS: 641 valid_len = sizeof(struct virtchnl_queue_select); 642 break; 643 case VIRTCHNL_OP_IWARP: 644 /* These messages are opaque to us and will be validated in 645 * the RDMA client code. We just need to check for nonzero 646 * length. The firmware will enforce max length restrictions. 647 */ 648 if (msglen) 649 valid_len = msglen; 650 else 651 err_msg_format = true; 652 break; 653 case VIRTCHNL_OP_RELEASE_IWARP_IRQ_MAP: 654 break; 655 case VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP: 656 valid_len = sizeof(struct virtchnl_iwarp_qvlist_info); 657 if (msglen >= valid_len) { 658 struct virtchnl_iwarp_qvlist_info *qv = 659 (struct virtchnl_iwarp_qvlist_info *)msg; 660 if (qv->num_vectors == 0) { 661 err_msg_format = true; 662 break; 663 } 664 valid_len += ((qv->num_vectors - 1) * 665 sizeof(struct virtchnl_iwarp_qv_info)); 666 } 667 break; 668 case VIRTCHNL_OP_CONFIG_RSS_KEY: 669 valid_len = sizeof(struct virtchnl_rss_key); 670 if (msglen >= valid_len) { 671 struct virtchnl_rss_key *vrk = 672 (struct virtchnl_rss_key *)msg; 673 valid_len += vrk->key_len - 1; 674 } 675 break; 676 case VIRTCHNL_OP_CONFIG_RSS_LUT: 677 valid_len = sizeof(struct virtchnl_rss_lut); 678 if (msglen >= valid_len) { 679 struct virtchnl_rss_lut *vrl = 680 (struct virtchnl_rss_lut *)msg; 681 valid_len += vrl->lut_entries - 1; 682 } 683 break; 684 case VIRTCHNL_OP_GET_RSS_HENA_CAPS: 685 break; 686 case VIRTCHNL_OP_SET_RSS_HENA: 687 valid_len = sizeof(struct virtchnl_rss_hena); 688 break; 689 /* These are always errors coming from the VF. */ 690 case VIRTCHNL_OP_EVENT: 691 case VIRTCHNL_OP_UNKNOWN: 692 default: 693 return VIRTCHNL_ERR_PARAM; 694 } 695 /* few more checks */ 696 if ((valid_len != msglen) || (err_msg_format)) 697 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH; 698 699 return 0; 700 } 701 #endif /* _VIRTCHNL_H_ */ 702