drivers/common/iavf/virtchnl.h

   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 IAVF 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         /* opcode 19 is reserved */
 119         /* opcodes 20, 21, and 22 are reserved */
 120         VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
 121         VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
 122         VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
 123         VIRTCHNL_OP_SET_RSS_HENA = 26,
 124         VIRTCHNL_OP_ENABLE_VLAN_STRIPPING = 27,
 125         VIRTCHNL_OP_DISABLE_VLAN_STRIPPING = 28,
 126         VIRTCHNL_OP_REQUEST_QUEUES = 29,
 127         VIRTCHNL_OP_ENABLE_CHANNELS = 30,
 128         VIRTCHNL_OP_DISABLE_CHANNELS = 31,
 129         VIRTCHNL_OP_ADD_CLOUD_FILTER = 32,
 130         VIRTCHNL_OP_DEL_CLOUD_FILTER = 33,
 131         /* opcodes 34, 35, 36, 37 and 38 are reserved */
 132         VIRTCHNL_OP_DCF_CMD_DESC = 39,
 133         VIRTCHNL_OP_DCF_CMD_BUFF = 40,
 134         VIRTCHNL_OP_DCF_DISABLE = 41,
 135         VIRTCHNL_OP_DCF_GET_VSI_MAP = 42,
 136         VIRTCHNL_OP_DCF_GET_PKG_INFO = 43,
 137         VIRTCHNL_OP_GET_SUPPORTED_RXDIDS = 44,
 138         VIRTCHNL_OP_ADD_RSS_CFG = 45,
 139         VIRTCHNL_OP_DEL_RSS_CFG = 46,
 140         VIRTCHNL_OP_ADD_FDIR_FILTER = 47,
 141         VIRTCHNL_OP_DEL_FDIR_FILTER = 48,
 142         VIRTCHNL_OP_QUERY_FDIR_FILTER = 49,
 143 };
 144
 145 /* These macros are used to generate compilation errors if a structure/union
 146  * is not exactly the correct length. It gives a divide by zero error if the
 147  * structure/union is not of the correct size, otherwise it creates an enum
 148  * that is never used.
 149  */
 150 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \
 151         { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) }
 152 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \
 153         { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) }
 154
 155 /* Virtual channel message descriptor. This overlays the admin queue
 156  * descriptor. All other data is passed in external buffers.
 157  */
 158
 159 struct virtchnl_msg {
 160         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
 161         enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
 162         enum virtchnl_status_code v_retval;  /* ditto for desc->retval */
 163         u32 vfid;                        /* used by PF when sending to VF */
 164 };
 165
 166 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg);
 167
 168 /* Message descriptions and data structures. */
 169
 170 /* VIRTCHNL_OP_VERSION
 171  * VF posts its version number to the PF. PF responds with its version number
 172  * in the same format, along with a return code.
 173  * Reply from PF has its major/minor versions also in param0 and param1.
 174  * If there is a major version mismatch, then the VF cannot operate.
 175  * If there is a minor version mismatch, then the VF can operate but should
 176  * add a warning to the system log.
 177  *
 178  * This enum element MUST always be specified as == 1, regardless of other
 179  * changes in the API. The PF must always respond to this message without
 180  * error regardless of version mismatch.
 181  */
 182 #define VIRTCHNL_VERSION_MAJOR          1
 183 #define VIRTCHNL_VERSION_MINOR          1
 184 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS       0
 185
 186 struct virtchnl_version_info {
 187         u32 major;
 188         u32 minor;
 189 };
 190
 191 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info);
 192
 193 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0))
 194 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1))
 195
 196 /* VIRTCHNL_OP_RESET_VF
 197  * VF sends this request to PF with no parameters
 198  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
 199  * until reset completion is indicated. The admin queue must be reinitialized
 200  * after this operation.
 201  *
 202  * When reset is complete, PF must ensure that all queues in all VSIs associated
 203  * with the VF are stopped, all queue configurations in the HMC are set to 0,
 204  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
 205  * are cleared.
 206  */
 207
 208 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV
 209  * vsi_type should always be 6 for backward compatibility. Add other fields
 210  * as needed.
 211  */
 212 enum virtchnl_vsi_type {
 213         VIRTCHNL_VSI_TYPE_INVALID = 0,
 214         VIRTCHNL_VSI_SRIOV = 6,
 215 };
 216
 217 /* VIRTCHNL_OP_GET_VF_RESOURCES
 218  * Version 1.0 VF sends this request to PF with no parameters
 219  * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
 220  * PF responds with an indirect message containing
 221  * virtchnl_vf_resource and one or more
 222  * virtchnl_vsi_resource structures.
 223  */
 224
 225 struct virtchnl_vsi_resource {
 226         u16 vsi_id;
 227         u16 num_queue_pairs;
 228         enum virtchnl_vsi_type vsi_type;
 229         u16 qset_handle;
 230         u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
 231 };
 232
 233 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource);
 234
 235 /* VF capability flags
 236  * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including
 237  * TX/RX Checksum offloading and TSO for non-tunnelled packets.
 238  */
 239 #define VIRTCHNL_VF_OFFLOAD_L2                  0x00000001
 240 #define VIRTCHNL_VF_OFFLOAD_IWARP               0x00000002
 241 #define VIRTCHNL_VF_OFFLOAD_RSVD                0x00000004
 242 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ              0x00000008
 243 #define VIRTCHNL_VF_OFFLOAD_RSS_REG             0x00000010
 244 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR           0x00000020
 245 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES          0x00000040
 246 #define VIRTCHNL_VF_OFFLOAD_CRC                 0x00000080
 247 #define VIRTCHNL_VF_OFFLOAD_VLAN                0x00010000
 248 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING          0x00020000
 249 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2       0x00040000
 250 #define VIRTCHNL_VF_OFFLOAD_RSS_PF              0X00080000
 251 #define VIRTCHNL_VF_OFFLOAD_ENCAP               0X00100000
 252 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM          0X00200000
 253 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM       0X00400000
 254 #define VIRTCHNL_VF_OFFLOAD_ADQ                 0X00800000
 255 #define VIRTCHNL_VF_OFFLOAD_ADQ_V2              0X01000000
 256 #define VIRTCHNL_VF_OFFLOAD_USO                 0X02000000
 257 #define VIRTCHNL_VF_CAP_DCF                     0X40000000
 258 #define VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC        0X04000000
 259 #define VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF          0X08000000
 260 #define VIRTCHNL_VF_OFFLOAD_FDIR_PF             0X10000000
 261         /* 0X80000000 is reserved */
 262
 263 /* Define below the capability flags that are not offloads */
 264 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED          0x00000080
 265 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \
 266                                VIRTCHNL_VF_OFFLOAD_VLAN | \
 267                                VIRTCHNL_VF_OFFLOAD_RSS_PF)
 268
 269 struct virtchnl_vf_resource {
 270         u16 num_vsis;
 271         u16 num_queue_pairs;
 272         u16 max_vectors;
 273         u16 max_mtu;
 274
 275         u32 vf_cap_flags;
 276         u32 rss_key_size;
 277         u32 rss_lut_size;
 278
 279         struct virtchnl_vsi_resource vsi_res[1];
 280 };
 281
 282 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource);
 283
 284 /* VIRTCHNL_OP_CONFIG_TX_QUEUE
 285  * VF sends this message to set up parameters for one TX queue.
 286  * External data buffer contains one instance of virtchnl_txq_info.
 287  * PF configures requested queue and returns a status code.
 288  */
 289
 290 /* Tx queue config info */
 291 struct virtchnl_txq_info {
 292         u16 vsi_id;
 293         u16 queue_id;
 294         u16 ring_len;           /* number of descriptors, multiple of 8 */
 295         u16 headwb_enabled; /* deprecated with AVF 1.0 */
 296         u64 dma_ring_addr;
 297         u64 dma_headwb_addr; /* deprecated with AVF 1.0 */
 298 };
 299
 300 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info);
 301
 302 /* VIRTCHNL_OP_CONFIG_RX_QUEUE
 303  * VF sends this message to set up parameters for one RX queue.
 304  * External data buffer contains one instance of virtchnl_rxq_info.
 305  * PF configures requested queue and returns a status code. The
 306  * crc_disable flag disables CRC stripping on the VF. Setting
 307  * the crc_disable flag to 1 will disable CRC stripping for each
 308  * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC
 309  * offload must have been set prior to sending this info or the PF
 310  * will ignore the request. This flag should be set the same for
 311  * all of the queues for a VF.
 312  */
 313
 314 /* Rx queue config info */
 315 struct virtchnl_rxq_info {
 316         u16 vsi_id;
 317         u16 queue_id;
 318         u32 ring_len;           /* number of descriptors, multiple of 32 */
 319         u16 hdr_size;
 320         u16 splithdr_enabled; /* deprecated with AVF 1.0 */
 321         u32 databuffer_size;
 322         u32 max_pkt_size;
 323         u8 crc_disable;
 324         /* only used when VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC is supported */
 325         u8 rxdid;
 326         u8 pad1[2];
 327         u64 dma_ring_addr;
 328         enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */
 329         u32 pad2;
 330 };
 331
 332 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info);
 333
 334 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES
 335  * VF sends this message to set parameters for active TX and RX queues
 336  * associated with the specified VSI.
 337  * PF configures queues and returns status.
 338  * If the number of queues specified is greater than the number of queues
 339  * associated with the VSI, an error is returned and no queues are configured.
 340  * NOTE: The VF is not required to configure all queues in a single request.
 341  * It may send multiple messages. PF drivers must correctly handle all VF
 342  * requests.
 343  */
 344 struct virtchnl_queue_pair_info {
 345         /* NOTE: vsi_id and queue_id should be identical for both queues. */
 346         struct virtchnl_txq_info txq;
 347         struct virtchnl_rxq_info rxq;
 348 };
 349
 350 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info);
 351
 352 struct virtchnl_vsi_queue_config_info {
 353         u16 vsi_id;
 354         u16 num_queue_pairs;
 355         u32 pad;
 356         struct virtchnl_queue_pair_info qpair[1];
 357 };
 358
 359 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info);
 360
 361 /* VIRTCHNL_OP_REQUEST_QUEUES
 362  * VF sends this message to request the PF to allocate additional queues to
 363  * this VF.  Each VF gets a guaranteed number of queues on init but asking for
 364  * additional queues must be negotiated.  This is a best effort request as it
 365  * is possible the PF does not have enough queues left to support the request.
 366  * If the PF cannot support the number requested it will respond with the
 367  * maximum number it is able to support.  If the request is successful, PF will
 368  * then reset the VF to institute required changes.
 369  */
 370
 371 /* VF resource request */
 372 struct virtchnl_vf_res_request {
 373         u16 num_queue_pairs;
 374 };
 375
 376 /* VIRTCHNL_OP_CONFIG_IRQ_MAP
 377  * VF uses this message to map vectors to queues.
 378  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
 379  * are to be associated with the specified vector.
 380  * The "other" causes are always mapped to vector 0. The VF may not request
 381  * that vector 0 be used for traffic.
 382  * PF configures interrupt mapping and returns status.
 383  * NOTE: due to hardware requirements, all active queues (both TX and RX)
 384  * should be mapped to interrupts, even if the driver intends to operate
 385  * only in polling mode. In this case the interrupt may be disabled, but
 386  * the ITR timer will still run to trigger writebacks.
 387  */
 388 struct virtchnl_vector_map {
 389         u16 vsi_id;
 390         u16 vector_id;
 391         u16 rxq_map;
 392         u16 txq_map;
 393         u16 rxitr_idx;
 394         u16 txitr_idx;
 395 };
 396
 397 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map);
 398
 399 struct virtchnl_irq_map_info {
 400         u16 num_vectors;
 401         struct virtchnl_vector_map vecmap[1];
 402 };
 403
 404 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info);
 405
 406 /* VIRTCHNL_OP_ENABLE_QUEUES
 407  * VIRTCHNL_OP_DISABLE_QUEUES
 408  * VF sends these message to enable or disable TX/RX queue pairs.
 409  * The queues fields are bitmaps indicating which queues to act upon.
 410  * (Currently, we only support 16 queues per VF, but we make the field
 411  * u32 to allow for expansion.)
 412  * PF performs requested action and returns status.
 413  * NOTE: The VF is not required to enable/disable all queues in a single
 414  * request. It may send multiple messages.
 415  * PF drivers must correctly handle all VF requests.
 416  */
 417 struct virtchnl_queue_select {
 418         u16 vsi_id;
 419         u16 pad;
 420         u32 rx_queues;
 421         u32 tx_queues;
 422 };
 423
 424 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select);
 425
 426 /* VIRTCHNL_OP_ADD_ETH_ADDR
 427  * VF sends this message in order to add one or more unicast or multicast
 428  * address filters for the specified VSI.
 429  * PF adds the filters and returns status.
 430  */
 431
 432 /* VIRTCHNL_OP_DEL_ETH_ADDR
 433  * VF sends this message in order to remove one or more unicast or multicast
 434  * filters for the specified VSI.
 435  * PF removes the filters and returns status.
 436  */
 437
 438 /* VIRTCHNL_ETHER_ADDR_LEGACY
 439  * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad
 440  * bytes. Moving forward all VF drivers should not set type to
 441  * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy
 442  * behavior. The control plane function (i.e. PF) can use a best effort method
 443  * of tracking the primary/device unicast in this case, but there is no
 444  * guarantee and functionality depends on the implementation of the PF.
 445  */
 446
 447 /* VIRTCHNL_ETHER_ADDR_PRIMARY
 448  * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the
 449  * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and
 450  * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane
 451  * function (i.e. PF) to accurately track and use this MAC address for
 452  * displaying on the host and for VM/function reset.
 453  */
 454
 455 /* VIRTCHNL_ETHER_ADDR_EXTRA
 456  * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra
 457  * unicast and/or multicast filters that are being added/deleted via
 458  * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively.
 459  */
 460 struct virtchnl_ether_addr {
 461         u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
 462         u8 type;
 463 #define VIRTCHNL_ETHER_ADDR_LEGACY      0
 464 #define VIRTCHNL_ETHER_ADDR_PRIMARY     1
 465 #define VIRTCHNL_ETHER_ADDR_EXTRA       2
 466 #define VIRTCHNL_ETHER_ADDR_TYPE_MASK   3 /* first two bits of type are valid */
 467         u8 pad;
 468 };
 469
 470 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr);
 471
 472 struct virtchnl_ether_addr_list {
 473         u16 vsi_id;
 474         u16 num_elements;
 475         struct virtchnl_ether_addr list[1];
 476 };
 477
 478 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list);
 479
 480 /* VIRTCHNL_OP_ADD_VLAN
 481  * VF sends this message to add one or more VLAN tag filters for receives.
 482  * PF adds the filters and returns status.
 483  * If a port VLAN is configured by the PF, this operation will return an
 484  * error to the VF.
 485  */
 486
 487 /* VIRTCHNL_OP_DEL_VLAN
 488  * VF sends this message to remove one or more VLAN tag filters for receives.
 489  * PF removes the filters and returns status.
 490  * If a port VLAN is configured by the PF, this operation will return an
 491  * error to the VF.
 492  */
 493
 494 struct virtchnl_vlan_filter_list {
 495         u16 vsi_id;
 496         u16 num_elements;
 497         u16 vlan_id[1];
 498 };
 499
 500 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list);
 501
 502 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
 503  * VF sends VSI id and flags.
 504  * PF returns status code in retval.
 505  * Note: we assume that broadcast accept mode is always enabled.
 506  */
 507 struct virtchnl_promisc_info {
 508         u16 vsi_id;
 509         u16 flags;
 510 };
 511
 512 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info);
 513
 514 #define FLAG_VF_UNICAST_PROMISC 0x00000001
 515 #define FLAG_VF_MULTICAST_PROMISC       0x00000002
 516
 517 /* VIRTCHNL_OP_GET_STATS
 518  * VF sends this message to request stats for the selected VSI. VF uses
 519  * the virtchnl_queue_select struct to specify the VSI. The queue_id
 520  * field is ignored by the PF.
 521  *
 522  * PF replies with struct virtchnl_eth_stats in an external buffer.
 523  */
 524
 525 struct virtchnl_eth_stats {
 526         u64 rx_bytes;                   /* received bytes */
 527         u64 rx_unicast;                 /* received unicast pkts */
 528         u64 rx_multicast;               /* received multicast pkts */
 529         u64 rx_broadcast;               /* received broadcast pkts */
 530         u64 rx_discards;
 531         u64 rx_unknown_protocol;
 532         u64 tx_bytes;                   /* transmitted bytes */
 533         u64 tx_unicast;                 /* transmitted unicast pkts */
 534         u64 tx_multicast;               /* transmitted multicast pkts */
 535         u64 tx_broadcast;               /* transmitted broadcast pkts */
 536         u64 tx_discards;
 537         u64 tx_errors;
 538 };
 539
 540 /* VIRTCHNL_OP_CONFIG_RSS_KEY
 541  * VIRTCHNL_OP_CONFIG_RSS_LUT
 542  * VF sends these messages to configure RSS. Only supported if both PF
 543  * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
 544  * configuration negotiation. If this is the case, then the RSS fields in
 545  * the VF resource struct are valid.
 546  * Both the key and LUT are initialized to 0 by the PF, meaning that
 547  * RSS is effectively disabled until set up by the VF.
 548  */
 549 struct virtchnl_rss_key {
 550         u16 vsi_id;
 551         u16 key_len;
 552         u8 key[1];         /* RSS hash key, packed bytes */
 553 };
 554
 555 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key);
 556
 557 struct virtchnl_rss_lut {
 558         u16 vsi_id;
 559         u16 lut_entries;
 560         u8 lut[1];        /* RSS lookup table */
 561 };
 562
 563 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut);
 564
 565 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS
 566  * VIRTCHNL_OP_SET_RSS_HENA
 567  * VF sends these messages to get and set the hash filter enable bits for RSS.
 568  * By default, the PF sets these to all possible traffic types that the
 569  * hardware supports. The VF can query this value if it wants to change the
 570  * traffic types that are hashed by the hardware.
 571  */
 572 struct virtchnl_rss_hena {
 573         u64 hena;
 574 };
 575
 576 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena);
 577
 578 /* Type of RSS algorithm */
 579 enum virtchnl_rss_algorithm {
 580         VIRTCHNL_RSS_ALG_TOEPLITZ_ASYMMETRIC    = 0,
 581         VIRTCHNL_RSS_ALG_XOR_ASYMMETRIC         = 1,
 582         VIRTCHNL_RSS_ALG_TOEPLITZ_SYMMETRIC     = 2,
 583         VIRTCHNL_RSS_ALG_XOR_SYMMETRIC          = 3,
 584 };
 585
 586 /* This is used by PF driver to enforce how many channels can be supported.
 587  * When ADQ_V2 capability is negotiated, it will allow 16 channels otherwise
 588  * PF driver will allow only max 4 channels
 589  */
 590 #define VIRTCHNL_MAX_ADQ_CHANNELS 4
 591 #define VIRTCHNL_MAX_ADQ_V2_CHANNELS 16
 592
 593 /* VIRTCHNL_OP_ENABLE_CHANNELS
 594  * VIRTCHNL_OP_DISABLE_CHANNELS
 595  * VF sends these messages to enable or disable channels based on
 596  * the user specified queue count and queue offset for each traffic class.
 597  * This struct encompasses all the information that the PF needs from
 598  * VF to create a channel.
 599  */
 600 struct virtchnl_channel_info {
 601         u16 count; /* number of queues in a channel */
 602         u16 offset; /* queues in a channel start from 'offset' */
 603         u32 pad;
 604         u64 max_tx_rate;
 605 };
 606
 607 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info);
 608
 609 struct virtchnl_tc_info {
 610         u32     num_tc;
 611         u32     pad;
 612         struct  virtchnl_channel_info list[1];
 613 };
 614
 615 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info);
 616
 617 /* VIRTCHNL_ADD_CLOUD_FILTER
 618  * VIRTCHNL_DEL_CLOUD_FILTER
 619  * VF sends these messages to add or delete a cloud filter based on the
 620  * user specified match and action filters. These structures encompass
 621  * all the information that the PF needs from the VF to add/delete a
 622  * cloud filter.
 623  */
 624
 625 struct virtchnl_l4_spec {
 626         u8      src_mac[ETH_ALEN];
 627         u8      dst_mac[ETH_ALEN];
 628         /* vlan_prio is part of this 16 bit field even from OS perspective
 629          * vlan_id:12 is actual vlan_id, then vlanid:bit14..12 is vlan_prio
 630          * in future, when decided to offload vlan_prio, pass that information
 631          * as part of the "vlan_id" field, Bit14..12
 632          */
 633         __be16  vlan_id;
 634         __be16  pad; /* reserved for future use */
 635         __be32  src_ip[4];
 636         __be32  dst_ip[4];
 637         __be16  src_port;
 638         __be16  dst_port;
 639 };
 640
 641 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec);
 642
 643 union virtchnl_flow_spec {
 644         struct  virtchnl_l4_spec tcp_spec;
 645         u8      buffer[128]; /* reserved for future use */
 646 };
 647
 648 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec);
 649
 650 enum virtchnl_action {
 651         /* action types */
 652         VIRTCHNL_ACTION_DROP = 0,
 653         VIRTCHNL_ACTION_TC_REDIRECT,
 654         VIRTCHNL_ACTION_PASSTHRU,
 655         VIRTCHNL_ACTION_QUEUE,
 656         VIRTCHNL_ACTION_Q_REGION,
 657         VIRTCHNL_ACTION_MARK,
 658         VIRTCHNL_ACTION_COUNT,
 659 };
 660
 661 enum virtchnl_flow_type {
 662         /* flow types */
 663         VIRTCHNL_TCP_V4_FLOW = 0,
 664         VIRTCHNL_TCP_V6_FLOW,
 665         VIRTCHNL_UDP_V4_FLOW,
 666         VIRTCHNL_UDP_V6_FLOW,
 667 };
 668
 669 struct virtchnl_filter {
 670         union   virtchnl_flow_spec data;
 671         union   virtchnl_flow_spec mask;
 672         enum    virtchnl_flow_type flow_type;
 673         enum    virtchnl_action action;
 674         u32     action_meta;
 675         u8      field_flags;
 676 };
 677
 678 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter);
 679
 680 /* VIRTCHNL_OP_DCF_GET_VSI_MAP
 681  * VF sends this message to get VSI mapping table.
 682  * PF responds with an indirect message containing VF's
 683  * HW VSI IDs.
 684  * The index of vf_vsi array is the logical VF ID, the
 685  * value of vf_vsi array is the VF's HW VSI ID with its
 686  * valid configuration.
 687  */
 688 struct virtchnl_dcf_vsi_map {
 689         u16 pf_vsi;     /* PF's HW VSI ID */
 690         u16 num_vfs;    /* The actual number of VFs allocated */
 691 #define VIRTCHNL_DCF_VF_VSI_ID_S        0
 692 #define VIRTCHNL_DCF_VF_VSI_ID_M        (0xFFF << VIRTCHNL_DCF_VF_VSI_ID_S)
 693 #define VIRTCHNL_DCF_VF_VSI_VALID       (1 << 15)
 694         u16 vf_vsi[1];
 695 };
 696
 697 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_dcf_vsi_map);
 698
 699 #define PKG_NAME_SIZE   32
 700 #define DSN_SIZE        8
 701
 702 struct pkg_version {
 703         u8 major;
 704         u8 minor;
 705         u8 update;
 706         u8 draft;
 707 };
 708
 709 VIRTCHNL_CHECK_STRUCT_LEN(4, pkg_version);
 710
 711 struct virtchnl_pkg_info {
 712         struct pkg_version pkg_ver;
 713         u32 track_id;
 714         char pkg_name[PKG_NAME_SIZE];
 715         u8 dsn[DSN_SIZE];
 716 };
 717
 718 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_pkg_info);
 719
 720 struct virtchnl_supported_rxdids {
 721         u64 supported_rxdids;
 722 };
 723
 724 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_supported_rxdids);
 725
 726 /* VIRTCHNL_OP_EVENT
 727  * PF sends this message to inform the VF driver of events that may affect it.
 728  * No direct response is expected from the VF, though it may generate other
 729  * messages in response to this one.
 730  */
 731 enum virtchnl_event_codes {
 732         VIRTCHNL_EVENT_UNKNOWN = 0,
 733         VIRTCHNL_EVENT_LINK_CHANGE,
 734         VIRTCHNL_EVENT_RESET_IMPENDING,
 735         VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
 736         VIRTCHNL_EVENT_DCF_VSI_MAP_UPDATE,
 737 };
 738
 739 #define PF_EVENT_SEVERITY_INFO          0
 740 #define PF_EVENT_SEVERITY_ATTENTION     1
 741 #define PF_EVENT_SEVERITY_ACTION_REQUIRED       2
 742 #define PF_EVENT_SEVERITY_CERTAIN_DOOM  255
 743
 744 struct virtchnl_pf_event {
 745         enum virtchnl_event_codes event;
 746         union {
 747                 /* If the PF driver does not support the new speed reporting
 748                  * capabilities then use link_event else use link_event_adv to
 749                  * get the speed and link information. The ability to understand
 750                  * new speeds is indicated by setting the capability flag
 751                  * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter
 752                  * in virtchnl_vf_resource struct and can be used to determine
 753                  * which link event struct to use below.
 754                  */
 755                 struct {
 756                         enum virtchnl_link_speed link_speed;
 757                         u8 link_status;
 758                 } link_event;
 759                 struct {
 760                         /* link_speed provided in Mbps */
 761                         u32 link_speed;
 762                         u8 link_status;
 763                 } link_event_adv;
 764                 struct {
 765                         u16 vf_id;
 766                         u16 vsi_id;
 767                 } vf_vsi_map;
 768         } event_data;
 769
 770         int severity;
 771 };
 772
 773 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event);
 774
 775
 776 /* Since VF messages are limited by u16 size, precalculate the maximum possible
 777  * values of nested elements in virtchnl structures that virtual channel can
 778  * possibly handle in a single message.
 779  */
 780 enum virtchnl_vector_limits {
 781         VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX       =
 782                 ((u16)(~0) - sizeof(struct virtchnl_vsi_queue_config_info)) /
 783                 sizeof(struct virtchnl_queue_pair_info),
 784
 785         VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX          =
 786                 ((u16)(~0) - sizeof(struct virtchnl_irq_map_info)) /
 787                 sizeof(struct virtchnl_vector_map),
 788
 789         VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX        =
 790                 ((u16)(~0) - sizeof(struct virtchnl_ether_addr_list)) /
 791                 sizeof(struct virtchnl_ether_addr),
 792
 793         VIRTCHNL_OP_ADD_DEL_VLAN_MAX            =
 794                 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list)) /
 795                 sizeof(u16),
 796
 797
 798         VIRTCHNL_OP_ENABLE_CHANNELS_MAX         =
 799                 ((u16)(~0) - sizeof(struct virtchnl_tc_info)) /
 800                 sizeof(struct virtchnl_channel_info),
 801 };
 802
 803 /* VF reset states - these are written into the RSTAT register:
 804  * VFGEN_RSTAT on the VF
 805  * When the PF initiates a reset, it writes 0
 806  * When the reset is complete, it writes 1
 807  * When the PF detects that the VF has recovered, it writes 2
 808  * VF checks this register periodically to determine if a reset has occurred,
 809  * then polls it to know when the reset is complete.
 810  * If either the PF or VF reads the register while the hardware
 811  * is in a reset state, it will return DEADBEEF, which, when masked
 812  * will result in 3.
 813  */
 814 enum virtchnl_vfr_states {
 815         VIRTCHNL_VFR_INPROGRESS = 0,
 816         VIRTCHNL_VFR_COMPLETED,
 817         VIRTCHNL_VFR_VFACTIVE,
 818 };
 819
 820 #define VIRTCHNL_MAX_NUM_PROTO_HDRS     32
 821 #define PROTO_HDR_SHIFT                 5
 822 #define PROTO_HDR_FIELD_START(proto_hdr_type) \
 823                                         (proto_hdr_type << PROTO_HDR_SHIFT)
 824 #define PROTO_HDR_FIELD_MASK ((1UL << PROTO_HDR_SHIFT) - 1)
 825
 826 /* VF use these macros to configure each protocol header.
 827  * Specify which protocol headers and protocol header fields base on
 828  * virtchnl_proto_hdr_type and virtchnl_proto_hdr_field.
 829  * @param hdr: a struct of virtchnl_proto_hdr
 830  * @param hdr_type: ETH/IPV4/TCP, etc
 831  * @param field: SRC/DST/TEID/SPI, etc
 832  */
 833 #define VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, field) \
 834         ((hdr)->field_selector |= BIT((field) & PROTO_HDR_FIELD_MASK))
 835 #define VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, field) \
 836         ((hdr)->field_selector &= ~BIT((field) & PROTO_HDR_FIELD_MASK))
 837 #define VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val) \
 838         ((hdr)->field_selector & BIT((val) & PROTO_HDR_FIELD_MASK))
 839 #define VIRTCHNL_GET_PROTO_HDR_FIELD(hdr)       ((hdr)->field_selector)
 840
 841 #define VIRTCHNL_ADD_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
 842         (VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, \
 843                 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
 844 #define VIRTCHNL_DEL_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
 845         (VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, \
 846                 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
 847
 848 #define VIRTCHNL_SET_PROTO_HDR_TYPE(hdr, hdr_type) \
 849         ((hdr)->type = VIRTCHNL_PROTO_HDR_ ## hdr_type)
 850 #define VIRTCHNL_GET_PROTO_HDR_TYPE(hdr) \
 851         (((hdr)->type) >> PROTO_HDR_SHIFT)
 852 #define VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) \
 853         ((hdr)->type == ((val) >> PROTO_HDR_SHIFT))
 854 #define VIRTCHNL_TEST_PROTO_HDR(hdr, val) \
 855         (VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) && \
 856          VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val))
 857
 858 /* Protocol header type within a packet segment. A segment consists of one or
 859  * more protocol headers that make up a logical group of protocol headers. Each
 860  * logical group of protocol headers encapsulates or is encapsulated using/by
 861  * tunneling or encapsulation protocols for network virtualization.
 862  */
 863 enum virtchnl_proto_hdr_type {
 864         VIRTCHNL_PROTO_HDR_NONE,
 865         VIRTCHNL_PROTO_HDR_ETH,
 866         VIRTCHNL_PROTO_HDR_S_VLAN,
 867         VIRTCHNL_PROTO_HDR_C_VLAN,
 868         VIRTCHNL_PROTO_HDR_IPV4,
 869         VIRTCHNL_PROTO_HDR_IPV6,
 870         VIRTCHNL_PROTO_HDR_TCP,
 871         VIRTCHNL_PROTO_HDR_UDP,
 872         VIRTCHNL_PROTO_HDR_SCTP,
 873         VIRTCHNL_PROTO_HDR_GTPU_IP,
 874         VIRTCHNL_PROTO_HDR_GTPU_EH,
 875         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_DWN,
 876         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_UP,
 877         VIRTCHNL_PROTO_HDR_PPPOE,
 878         VIRTCHNL_PROTO_HDR_L2TPV3,
 879         VIRTCHNL_PROTO_HDR_ESP,
 880         VIRTCHNL_PROTO_HDR_AH,
 881         VIRTCHNL_PROTO_HDR_PFCP,
 882 };
 883
 884 /* Protocol header field within a protocol header. */
 885 enum virtchnl_proto_hdr_field {
 886         /* ETHER */
 887         VIRTCHNL_PROTO_HDR_ETH_SRC =
 888                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ETH),
 889         VIRTCHNL_PROTO_HDR_ETH_DST,
 890         VIRTCHNL_PROTO_HDR_ETH_ETHERTYPE,
 891         /* S-VLAN */
 892         VIRTCHNL_PROTO_HDR_S_VLAN_ID =
 893                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_S_VLAN),
 894         /* C-VLAN */
 895         VIRTCHNL_PROTO_HDR_C_VLAN_ID =
 896                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_C_VLAN),
 897         /* IPV4 */
 898         VIRTCHNL_PROTO_HDR_IPV4_SRC =
 899                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4),
 900         VIRTCHNL_PROTO_HDR_IPV4_DST,
 901         VIRTCHNL_PROTO_HDR_IPV4_DSCP,
 902         VIRTCHNL_PROTO_HDR_IPV4_TTL,
 903         VIRTCHNL_PROTO_HDR_IPV4_PROT,
 904         /* IPV6 */
 905         VIRTCHNL_PROTO_HDR_IPV6_SRC =
 906                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6),
 907         VIRTCHNL_PROTO_HDR_IPV6_DST,
 908         VIRTCHNL_PROTO_HDR_IPV6_TC,
 909         VIRTCHNL_PROTO_HDR_IPV6_HOP_LIMIT,
 910         VIRTCHNL_PROTO_HDR_IPV6_PROT,
 911         /* TCP */
 912         VIRTCHNL_PROTO_HDR_TCP_SRC_PORT =
 913                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_TCP),
 914         VIRTCHNL_PROTO_HDR_TCP_DST_PORT,
 915         /* UDP */
 916         VIRTCHNL_PROTO_HDR_UDP_SRC_PORT =
 917                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_UDP),
 918         VIRTCHNL_PROTO_HDR_UDP_DST_PORT,
 919         /* SCTP */
 920         VIRTCHNL_PROTO_HDR_SCTP_SRC_PORT =
 921                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_SCTP),
 922         VIRTCHNL_PROTO_HDR_SCTP_DST_PORT,
 923         /* GTPU_IP */
 924         VIRTCHNL_PROTO_HDR_GTPU_IP_TEID =
 925                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_IP),
 926         /* GTPU_EH */
 927         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU =
 928                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_EH),
 929         VIRTCHNL_PROTO_HDR_GTPU_EH_QFI,
 930         /* PPPOE */
 931         VIRTCHNL_PROTO_HDR_PPPOE_SESS_ID =
 932                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PPPOE),
 933         /* L2TPV3 */
 934         VIRTCHNL_PROTO_HDR_L2TPV3_SESS_ID =
 935                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_L2TPV3),
 936         /* ESP */
 937         VIRTCHNL_PROTO_HDR_ESP_SPI =
 938                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ESP),
 939         /* AH */
 940         VIRTCHNL_PROTO_HDR_AH_SPI =
 941                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_AH),
 942         /* PFCP */
 943         VIRTCHNL_PROTO_HDR_PFCP_S_FIELD =
 944                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PFCP),
 945         VIRTCHNL_PROTO_HDR_PFCP_SEID,
 946 };
 947
 948 struct virtchnl_proto_hdr {
 949         enum virtchnl_proto_hdr_type type;
 950         u32 field_selector; /* a bit mask to select field for header type */
 951         u8 buffer[64];
 952         /**
 953          * binary buffer in network order for specific header type.
 954          * For example, if type = VIRTCHNL_PROTO_HDR_IPV4, a IPv4
 955          * header is expected to be copied into the buffer.
 956          */
 957 };
 958
 959 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_proto_hdr);
 960
 961 struct virtchnl_proto_hdrs {
 962         u8 tunnel_level;
 963         /**
 964          * specify where protocol header start from.
 965          * 0 - from the outer layer
 966          * 1 - from the first inner layer
 967          * 2 - from the second inner layer
 968          * ....
 969          **/
 970         int count; /* the proto layers must < VIRTCHNL_MAX_NUM_PROTO_HDRS */
 971         struct virtchnl_proto_hdr proto_hdr[VIRTCHNL_MAX_NUM_PROTO_HDRS];
 972 };
 973
 974 VIRTCHNL_CHECK_STRUCT_LEN(2312, virtchnl_proto_hdrs);
 975
 976 struct virtchnl_rss_cfg {
 977         struct virtchnl_proto_hdrs proto_hdrs;     /* protocol headers */
 978         enum virtchnl_rss_algorithm rss_algorithm; /* rss algorithm type */
 979         u8 reserved[128];                          /* reserve for future */
 980 };
 981
 982 VIRTCHNL_CHECK_STRUCT_LEN(2444, virtchnl_rss_cfg);
 983
 984 /* action configuration for FDIR */
 985 struct virtchnl_filter_action {
 986         enum virtchnl_action type;
 987         union {
 988                 /* used for queue and qgroup action */
 989                 struct {
 990                         u16 index;
 991                         u8 region;
 992                 } queue;
 993                 /* used for count action */
 994                 struct {
 995                         /* share counter ID with other flow rules */
 996                         u8 shared;
 997                         u32 id; /* counter ID */
 998                 } count;
 999                 /* used for mark action */
1000                 u32 mark_id;
1001                 u8 reserve[32];
1002         } act_conf;
1003 };
1004
1005 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_filter_action);
1006
1007 #define VIRTCHNL_MAX_NUM_ACTIONS  8
1008
1009 struct virtchnl_filter_action_set {
1010         /* action number must be less then VIRTCHNL_MAX_NUM_ACTIONS */
1011         int count;
1012         struct virtchnl_filter_action actions[VIRTCHNL_MAX_NUM_ACTIONS];
1013 };
1014
1015 VIRTCHNL_CHECK_STRUCT_LEN(292, virtchnl_filter_action_set);
1016
1017 /* pattern and action for FDIR rule */
1018 struct virtchnl_fdir_rule {
1019         struct virtchnl_proto_hdrs proto_hdrs;
1020         struct virtchnl_filter_action_set action_set;
1021 };
1022
1023 VIRTCHNL_CHECK_STRUCT_LEN(2604, virtchnl_fdir_rule);
1024
1025 /* query information to retrieve fdir rule counters.
1026  * PF will fill out this structure to reset counter.
1027  */
1028 struct virtchnl_fdir_query_info {
1029         u32 match_packets_valid:1;
1030         u32 match_bytes_valid:1;
1031         u32 reserved:30;  /* Reserved, must be zero. */
1032         u32 pad;
1033         u64 matched_packets; /* Number of packets for this rule. */
1034         u64 matched_bytes;   /* Number of bytes through this rule. */
1035 };
1036
1037 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_fdir_query_info);
1038
1039 /* Status returned to VF after VF requests FDIR commands
1040  * VIRTCHNL_FDIR_SUCCESS
1041  * VF FDIR related request is successfully done by PF
1042  * The request can be OP_ADD/DEL/QUERY_FDIR_FILTER.
1043  *
1044  * VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE
1045  * OP_ADD_FDIR_FILTER request is failed due to no Hardware resource.
1046  *
1047  * VIRTCHNL_FDIR_FAILURE_RULE_EXIST
1048  * OP_ADD_FDIR_FILTER request is failed due to the rule is already existed.
1049  *
1050  * VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT
1051  * OP_ADD_FDIR_FILTER request is failed due to conflict with existing rule.
1052  *
1053  * VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST
1054  * OP_DEL_FDIR_FILTER request is failed due to this rule doesn't exist.
1055  *
1056  * VIRTCHNL_FDIR_FAILURE_RULE_INVALID
1057  * OP_ADD_FDIR_FILTER request is failed due to parameters validation
1058  * or HW doesn't support.
1059  *
1060  * VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT
1061  * OP_ADD/DEL_FDIR_FILTER request is failed due to timing out
1062  * for programming.
1063  *
1064  * VIRTCHNL_FDIR_FAILURE_QUERY_INVALID
1065  * OP_QUERY_FDIR_FILTER request is failed due to parameters validation,
1066  * for example, VF query counter of a rule who has no counter action.
1067  */
1068 enum virtchnl_fdir_prgm_status {
1069         VIRTCHNL_FDIR_SUCCESS = 0,
1070         VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE,
1071         VIRTCHNL_FDIR_FAILURE_RULE_EXIST,
1072         VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT,
1073         VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST,
1074         VIRTCHNL_FDIR_FAILURE_RULE_INVALID,
1075         VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT,
1076         VIRTCHNL_FDIR_FAILURE_QUERY_INVALID,
1077 };
1078
1079 /* VIRTCHNL_OP_ADD_FDIR_FILTER
1080  * VF sends this request to PF by filling out vsi_id,
1081  * validate_only and rule_cfg. PF will return flow_id
1082  * if the request is successfully done and return add_status to VF.
1083  */
1084 struct virtchnl_fdir_add {
1085         u16 vsi_id;  /* INPUT */
1086         /*
1087          * 1 for validating a fdir rule, 0 for creating a fdir rule.
1088          * Validate and create share one ops: VIRTCHNL_OP_ADD_FDIR_FILTER.
1089          */
1090         u16 validate_only; /* INPUT */
1091         u32 flow_id;       /* OUTPUT */
1092         struct virtchnl_fdir_rule rule_cfg; /* INPUT */
1093         enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1094 };
1095
1096 VIRTCHNL_CHECK_STRUCT_LEN(2616, virtchnl_fdir_add);
1097
1098 /* VIRTCHNL_OP_DEL_FDIR_FILTER
1099  * VF sends this request to PF by filling out vsi_id
1100  * and flow_id. PF will return del_status to VF.
1101  */
1102 struct virtchnl_fdir_del {
1103         u16 vsi_id;  /* INPUT */
1104         u16 pad;
1105         u32 flow_id; /* INPUT */
1106         enum virtchnl_fdir_prgm_status status; /* OUTPUT */
1107 };
1108
1109 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_fdir_del);
1110
1111 /* VIRTCHNL_OP_QUERY_FDIR_FILTER
1112  * VF sends this request to PF by filling out vsi_id,
1113  * flow_id and reset_counter. PF will return query_info
1114  * and query_status to VF.
1115  */
1116 struct virtchnl_fdir_query {
1117         u16 vsi_id;   /* INPUT */
1118         u16 pad1[3];
1119         u32 flow_id;  /* INPUT */
1120         u32 reset_counter:1; /* INPUT */
1121         struct virtchnl_fdir_query_info query_info; /* OUTPUT */
1122         enum virtchnl_fdir_prgm_status status;  /* OUTPUT */
1123         u32 pad2;
1124 };
1125
1126 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_fdir_query);
1127 /**
1128  * virtchnl_vc_validate_vf_msg
1129  * @ver: Virtchnl version info
1130  * @v_opcode: Opcode for the message
1131  * @msg: pointer to the msg buffer
1132  * @msglen: msg length
1133  *
1134  * validate msg format against struct for each opcode
1135  */
1136 static inline int
1137 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode,
1138                             u8 *msg, u16 msglen)
1139 {
1140         bool err_msg_format = false;
1141         u32 valid_len = 0;
1142
1143         /* Validate message length. */
1144         switch (v_opcode) {
1145         case VIRTCHNL_OP_VERSION:
1146                 valid_len = sizeof(struct virtchnl_version_info);
1147                 break;
1148         case VIRTCHNL_OP_RESET_VF:
1149                 break;
1150         case VIRTCHNL_OP_GET_VF_RESOURCES:
1151                 if (VF_IS_V11(ver))
1152                         valid_len = sizeof(u32);
1153                 break;
1154         case VIRTCHNL_OP_CONFIG_TX_QUEUE:
1155                 valid_len = sizeof(struct virtchnl_txq_info);
1156                 break;
1157         case VIRTCHNL_OP_CONFIG_RX_QUEUE:
1158                 valid_len = sizeof(struct virtchnl_rxq_info);
1159                 break;
1160         case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
1161                 valid_len = sizeof(struct virtchnl_vsi_queue_config_info);
1162                 if (msglen >= valid_len) {
1163                         struct virtchnl_vsi_queue_config_info *vqc =
1164                             (struct virtchnl_vsi_queue_config_info *)msg;
1165
1166                         if (vqc->num_queue_pairs == 0 || vqc->num_queue_pairs >
1167                             VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX) {
1168                                 err_msg_format = true;
1169                                 break;
1170                         }
1171
1172                         valid_len += (vqc->num_queue_pairs *
1173                                       sizeof(struct
1174                                              virtchnl_queue_pair_info));
1175                 }
1176                 break;
1177         case VIRTCHNL_OP_CONFIG_IRQ_MAP:
1178                 valid_len = sizeof(struct virtchnl_irq_map_info);
1179                 if (msglen >= valid_len) {
1180                         struct virtchnl_irq_map_info *vimi =
1181                             (struct virtchnl_irq_map_info *)msg;
1182
1183                         if (vimi->num_vectors == 0 || vimi->num_vectors >
1184                             VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX) {
1185                                 err_msg_format = true;
1186                                 break;
1187                         }
1188
1189                         valid_len += (vimi->num_vectors *
1190                                       sizeof(struct virtchnl_vector_map));
1191                 }
1192                 break;
1193         case VIRTCHNL_OP_ENABLE_QUEUES:
1194         case VIRTCHNL_OP_DISABLE_QUEUES:
1195                 valid_len = sizeof(struct virtchnl_queue_select);
1196                 break;
1197         case VIRTCHNL_OP_ADD_ETH_ADDR:
1198         case VIRTCHNL_OP_DEL_ETH_ADDR:
1199                 valid_len = sizeof(struct virtchnl_ether_addr_list);
1200                 if (msglen >= valid_len) {
1201                         struct virtchnl_ether_addr_list *veal =
1202                             (struct virtchnl_ether_addr_list *)msg;
1203
1204                         if (veal->num_elements == 0 || veal->num_elements >
1205                             VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX) {
1206                                 err_msg_format = true;
1207                                 break;
1208                         }
1209
1210                         valid_len += veal->num_elements *
1211                             sizeof(struct virtchnl_ether_addr);
1212                 }
1213                 break;
1214         case VIRTCHNL_OP_ADD_VLAN:
1215         case VIRTCHNL_OP_DEL_VLAN:
1216                 valid_len = sizeof(struct virtchnl_vlan_filter_list);
1217                 if (msglen >= valid_len) {
1218                         struct virtchnl_vlan_filter_list *vfl =
1219                             (struct virtchnl_vlan_filter_list *)msg;
1220
1221                         if (vfl->num_elements == 0 || vfl->num_elements >
1222                             VIRTCHNL_OP_ADD_DEL_VLAN_MAX) {
1223                                 err_msg_format = true;
1224                                 break;
1225                         }
1226
1227                         valid_len += vfl->num_elements * sizeof(u16);
1228                 }
1229                 break;
1230         case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
1231                 valid_len = sizeof(struct virtchnl_promisc_info);
1232                 break;
1233         case VIRTCHNL_OP_GET_STATS:
1234                 valid_len = sizeof(struct virtchnl_queue_select);
1235                 break;
1236         case VIRTCHNL_OP_CONFIG_RSS_KEY:
1237                 valid_len = sizeof(struct virtchnl_rss_key);
1238                 if (msglen >= valid_len) {
1239                         struct virtchnl_rss_key *vrk =
1240                                 (struct virtchnl_rss_key *)msg;
1241
1242                         if (vrk->key_len == 0) {
1243                                 /* zero length is allowed as input */
1244                                 break;
1245                         }
1246
1247                         valid_len += vrk->key_len - 1;
1248                 }
1249                 break;
1250         case VIRTCHNL_OP_CONFIG_RSS_LUT:
1251                 valid_len = sizeof(struct virtchnl_rss_lut);
1252                 if (msglen >= valid_len) {
1253                         struct virtchnl_rss_lut *vrl =
1254                                 (struct virtchnl_rss_lut *)msg;
1255
1256                         if (vrl->lut_entries == 0) {
1257                                 /* zero entries is allowed as input */
1258                                 break;
1259                         }
1260
1261                         valid_len += vrl->lut_entries - 1;
1262                 }
1263                 break;
1264         case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
1265                 break;
1266         case VIRTCHNL_OP_SET_RSS_HENA:
1267                 valid_len = sizeof(struct virtchnl_rss_hena);
1268                 break;
1269         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
1270         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
1271                 break;
1272         case VIRTCHNL_OP_REQUEST_QUEUES:
1273                 valid_len = sizeof(struct virtchnl_vf_res_request);
1274                 break;
1275         case VIRTCHNL_OP_ENABLE_CHANNELS:
1276                 valid_len = sizeof(struct virtchnl_tc_info);
1277                 if (msglen >= valid_len) {
1278                         struct virtchnl_tc_info *vti =
1279                                 (struct virtchnl_tc_info *)msg;
1280
1281                         if (vti->num_tc == 0 || vti->num_tc >
1282                             VIRTCHNL_OP_ENABLE_CHANNELS_MAX) {
1283                                 err_msg_format = true;
1284                                 break;
1285                         }
1286
1287                         valid_len += (vti->num_tc - 1) *
1288                                      sizeof(struct virtchnl_channel_info);
1289                 }
1290                 break;
1291         case VIRTCHNL_OP_DISABLE_CHANNELS:
1292                 break;
1293         case VIRTCHNL_OP_ADD_CLOUD_FILTER:
1294         case VIRTCHNL_OP_DEL_CLOUD_FILTER:
1295                 valid_len = sizeof(struct virtchnl_filter);
1296                 break;
1297         case VIRTCHNL_OP_DCF_CMD_DESC:
1298         case VIRTCHNL_OP_DCF_CMD_BUFF:
1299                 /* These two opcodes are specific to handle the AdminQ command,
1300                  * so the validation needs to be done in PF's context.
1301                  */
1302                 return 0;
1303         case VIRTCHNL_OP_DCF_DISABLE:
1304         case VIRTCHNL_OP_DCF_GET_VSI_MAP:
1305                 /* The two opcodes are required by DCF without message buffer,
1306                  * so the valid length keeps the default value 0.
1307                  */
1308                 break;
1309         case VIRTCHNL_OP_DCF_GET_PKG_INFO:
1310                 break;
1311         case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
1312                 break;
1313         case VIRTCHNL_OP_ADD_RSS_CFG:
1314         case VIRTCHNL_OP_DEL_RSS_CFG:
1315                 valid_len = sizeof(struct virtchnl_rss_cfg);
1316                 break;
1317         case VIRTCHNL_OP_ADD_FDIR_FILTER:
1318                 valid_len = sizeof(struct virtchnl_fdir_add);
1319                 break;
1320         case VIRTCHNL_OP_DEL_FDIR_FILTER:
1321                 valid_len = sizeof(struct virtchnl_fdir_del);
1322                 break;
1323         case VIRTCHNL_OP_QUERY_FDIR_FILTER:
1324                 valid_len = sizeof(struct virtchnl_fdir_query);
1325                 break;
1326         /* These are always errors coming from the VF. */
1327         case VIRTCHNL_OP_EVENT:
1328         case VIRTCHNL_OP_UNKNOWN:
1329         default:
1330                 return VIRTCHNL_STATUS_ERR_PARAM;
1331         }
1332         /* few more checks */
1333         if (err_msg_format || valid_len != msglen)
1334                 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH;
1335
1336         return 0;
1337 }
1338 #endif /* _VIRTCHNL_H_ */