drivers/net/i40e/base/virtchnl.h

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