drivers/common/iavf/virtchnl.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2021 Intel Corporation
   3  */
   4
   5 #ifndef _VIRTCHNL_H_
   6 #define _VIRTCHNL_H_
   7
   8 /* Description:
   9  * This header file describes the Virtual Function (VF) - Physical Function
  10  * (PF) communication protocol used by the drivers for all devices starting
  11  * from our 40G product line
  12  *
  13  * Admin queue buffer usage:
  14  * desc->opcode is always aqc_opc_send_msg_to_pf
  15  * flags, retval, datalen, and data addr are all used normally.
  16  * The Firmware copies the cookie fields when sending messages between the
  17  * PF and VF, but uses all other fields internally. Due to this limitation,
  18  * we must send all messages as "indirect", i.e. using an external buffer.
  19  *
  20  * All the VSI indexes are relative to the VF. Each VF can have maximum of
  21  * three VSIs. All the queue indexes are relative to the VSI.  Each VF can
  22  * have a maximum of sixteen queues for all of its VSIs.
  23  *
  24  * The PF is required to return a status code in v_retval for all messages
  25  * except RESET_VF, which does not require any response. The returned value
  26  * is of virtchnl_status_code type, defined in the shared type.h.
  27  *
  28  * In general, VF driver initialization should roughly follow the order of
  29  * these opcodes. The VF driver must first validate the API version of the
  30  * PF driver, then request a reset, then get resources, then configure
  31  * queues and interrupts. After these operations are complete, the VF
  32  * driver may start its queues, optionally add MAC and VLAN filters, and
  33  * process traffic.
  34  */
  35
  36 /* START GENERIC DEFINES
  37  * Need to ensure the following enums and defines hold the same meaning and
  38  * value in current and future projects
  39  */
  40
  41 /* Error Codes */
  42 enum virtchnl_status_code {
  43         VIRTCHNL_STATUS_SUCCESS                         = 0,
  44         VIRTCHNL_STATUS_ERR_PARAM                       = -5,
  45         VIRTCHNL_STATUS_ERR_NO_MEMORY                   = -18,
  46         VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH             = -38,
  47         VIRTCHNL_STATUS_ERR_CQP_COMPL_ERROR             = -39,
  48         VIRTCHNL_STATUS_ERR_INVALID_VF_ID               = -40,
  49         VIRTCHNL_STATUS_ERR_ADMIN_QUEUE_ERROR           = -53,
  50         VIRTCHNL_STATUS_ERR_NOT_SUPPORTED               = -64,
  51 };
  52
  53 /* Backward compatibility */
  54 #define VIRTCHNL_ERR_PARAM VIRTCHNL_STATUS_ERR_PARAM
  55 #define VIRTCHNL_STATUS_NOT_SUPPORTED VIRTCHNL_STATUS_ERR_NOT_SUPPORTED
  56
  57 #define VIRTCHNL_LINK_SPEED_2_5GB_SHIFT         0x0
  58 #define VIRTCHNL_LINK_SPEED_100MB_SHIFT         0x1
  59 #define VIRTCHNL_LINK_SPEED_1000MB_SHIFT        0x2
  60 #define VIRTCHNL_LINK_SPEED_10GB_SHIFT          0x3
  61 #define VIRTCHNL_LINK_SPEED_40GB_SHIFT          0x4
  62 #define VIRTCHNL_LINK_SPEED_20GB_SHIFT          0x5
  63 #define VIRTCHNL_LINK_SPEED_25GB_SHIFT          0x6
  64 #define VIRTCHNL_LINK_SPEED_5GB_SHIFT           0x7
  65
  66 enum virtchnl_link_speed {
  67         VIRTCHNL_LINK_SPEED_UNKNOWN     = 0,
  68         VIRTCHNL_LINK_SPEED_100MB       = BIT(VIRTCHNL_LINK_SPEED_100MB_SHIFT),
  69         VIRTCHNL_LINK_SPEED_1GB         = BIT(VIRTCHNL_LINK_SPEED_1000MB_SHIFT),
  70         VIRTCHNL_LINK_SPEED_10GB        = BIT(VIRTCHNL_LINK_SPEED_10GB_SHIFT),
  71         VIRTCHNL_LINK_SPEED_40GB        = BIT(VIRTCHNL_LINK_SPEED_40GB_SHIFT),
  72         VIRTCHNL_LINK_SPEED_20GB        = BIT(VIRTCHNL_LINK_SPEED_20GB_SHIFT),
  73         VIRTCHNL_LINK_SPEED_25GB        = BIT(VIRTCHNL_LINK_SPEED_25GB_SHIFT),
  74         VIRTCHNL_LINK_SPEED_2_5GB       = BIT(VIRTCHNL_LINK_SPEED_2_5GB_SHIFT),
  75         VIRTCHNL_LINK_SPEED_5GB         = BIT(VIRTCHNL_LINK_SPEED_5GB_SHIFT),
  76 };
  77
  78 /* for hsplit_0 field of Rx HMC context */
  79 /* deprecated with IAVF 1.0 */
  80 enum virtchnl_rx_hsplit {
  81         VIRTCHNL_RX_HSPLIT_NO_SPLIT      = 0,
  82         VIRTCHNL_RX_HSPLIT_SPLIT_L2      = 1,
  83         VIRTCHNL_RX_HSPLIT_SPLIT_IP      = 2,
  84         VIRTCHNL_RX_HSPLIT_SPLIT_TCP_UDP = 4,
  85         VIRTCHNL_RX_HSPLIT_SPLIT_SCTP    = 8,
  86 };
  87
  88 #define VIRTCHNL_ETH_LENGTH_OF_ADDRESS  6
  89 /* END GENERIC DEFINES */
  90
  91 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
  92  * of the virtchnl_msg structure.
  93  */
  94 enum virtchnl_ops {
  95 /* The PF sends status change events to VFs using
  96  * the VIRTCHNL_OP_EVENT opcode.
  97  * VFs send requests to the PF using the other ops.
  98  * Use of "advanced opcode" features must be negotiated as part of capabilities
  99  * exchange and are not considered part of base mode feature set.
 100  */
 101         VIRTCHNL_OP_UNKNOWN = 0,
 102         VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
 103         VIRTCHNL_OP_RESET_VF = 2,
 104         VIRTCHNL_OP_GET_VF_RESOURCES = 3,
 105         VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
 106         VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
 107         VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
 108         VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
 109         VIRTCHNL_OP_ENABLE_QUEUES = 8,
 110         VIRTCHNL_OP_DISABLE_QUEUES = 9,
 111         VIRTCHNL_OP_ADD_ETH_ADDR = 10,
 112         VIRTCHNL_OP_DEL_ETH_ADDR = 11,
 113         VIRTCHNL_OP_ADD_VLAN = 12,
 114         VIRTCHNL_OP_DEL_VLAN = 13,
 115         VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
 116         VIRTCHNL_OP_GET_STATS = 15,
 117         VIRTCHNL_OP_RSVD = 16,
 118         VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */
 119         /* opcode 19 is reserved */
 120         /* opcodes 20, 21, and 22 are reserved */
 121         VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
 122         VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
 123         VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
 124         VIRTCHNL_OP_SET_RSS_HENA = 26,
 125         VIRTCHNL_OP_ENABLE_VLAN_STRIPPING = 27,
 126         VIRTCHNL_OP_DISABLE_VLAN_STRIPPING = 28,
 127         VIRTCHNL_OP_REQUEST_QUEUES = 29,
 128         VIRTCHNL_OP_ENABLE_CHANNELS = 30,
 129         VIRTCHNL_OP_DISABLE_CHANNELS = 31,
 130         VIRTCHNL_OP_ADD_CLOUD_FILTER = 32,
 131         VIRTCHNL_OP_DEL_CLOUD_FILTER = 33,
 132         /* opcodes 34, 35, 36, and 37 are reserved */
 133         VIRTCHNL_OP_DCF_VLAN_OFFLOAD = 38,
 134         VIRTCHNL_OP_DCF_CMD_DESC = 39,
 135         VIRTCHNL_OP_DCF_CMD_BUFF = 40,
 136         VIRTCHNL_OP_DCF_DISABLE = 41,
 137         VIRTCHNL_OP_DCF_GET_VSI_MAP = 42,
 138         VIRTCHNL_OP_DCF_GET_PKG_INFO = 43,
 139         VIRTCHNL_OP_GET_SUPPORTED_RXDIDS = 44,
 140         VIRTCHNL_OP_ADD_RSS_CFG = 45,
 141         VIRTCHNL_OP_DEL_RSS_CFG = 46,
 142         VIRTCHNL_OP_ADD_FDIR_FILTER = 47,
 143         VIRTCHNL_OP_DEL_FDIR_FILTER = 48,
 144         VIRTCHNL_OP_QUERY_FDIR_FILTER = 49,
 145         VIRTCHNL_OP_GET_MAX_RSS_QREGION = 50,
 146         VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS = 51,
 147         VIRTCHNL_OP_ADD_VLAN_V2 = 52,
 148         VIRTCHNL_OP_DEL_VLAN_V2 = 53,
 149         VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 = 54,
 150         VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 = 55,
 151         VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 = 56,
 152         VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2 = 57,
 153         VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2 = 58,
 154         VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2 = 59,
 155         VIRTCHNL_OP_ENABLE_QUEUES_V2 = 107,
 156         VIRTCHNL_OP_DISABLE_QUEUES_V2 = 108,
 157         VIRTCHNL_OP_MAP_QUEUE_VECTOR = 111,
 158         VIRTCHNL_OP_MAX,
 159 };
 160
 161 static inline const char *virtchnl_op_str(enum virtchnl_ops v_opcode)
 162 {
 163         switch (v_opcode) {
 164         case VIRTCHNL_OP_UNKNOWN:
 165                 return "VIRTCHNL_OP_UNKNOWN";
 166         case VIRTCHNL_OP_VERSION:
 167                 return "VIRTCHNL_OP_VERSION";
 168         case VIRTCHNL_OP_RESET_VF:
 169                 return "VIRTCHNL_OP_RESET_VF";
 170         case VIRTCHNL_OP_GET_VF_RESOURCES:
 171                 return "VIRTCHNL_OP_GET_VF_RESOURCES";
 172         case VIRTCHNL_OP_CONFIG_TX_QUEUE:
 173                 return "VIRTCHNL_OP_CONFIG_TX_QUEUE";
 174         case VIRTCHNL_OP_CONFIG_RX_QUEUE:
 175                 return "VIRTCHNL_OP_CONFIG_RX_QUEUE";
 176         case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
 177                 return "VIRTCHNL_OP_CONFIG_VSI_QUEUES";
 178         case VIRTCHNL_OP_CONFIG_IRQ_MAP:
 179                 return "VIRTCHNL_OP_CONFIG_IRQ_MAP";
 180         case VIRTCHNL_OP_ENABLE_QUEUES:
 181                 return "VIRTCHNL_OP_ENABLE_QUEUES";
 182         case VIRTCHNL_OP_DISABLE_QUEUES:
 183                 return "VIRTCHNL_OP_DISABLE_QUEUES";
 184         case VIRTCHNL_OP_ADD_ETH_ADDR:
 185                 return "VIRTCHNL_OP_ADD_ETH_ADDR";
 186         case VIRTCHNL_OP_DEL_ETH_ADDR:
 187                 return "VIRTCHNL_OP_DEL_ETH_ADDR";
 188         case VIRTCHNL_OP_ADD_VLAN:
 189                 return "VIRTCHNL_OP_ADD_VLAN";
 190         case VIRTCHNL_OP_DEL_VLAN:
 191                 return "VIRTCHNL_OP_DEL_VLAN";
 192         case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
 193                 return "VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE";
 194         case VIRTCHNL_OP_GET_STATS:
 195                 return "VIRTCHNL_OP_GET_STATS";
 196         case VIRTCHNL_OP_RSVD:
 197                 return "VIRTCHNL_OP_RSVD";
 198         case VIRTCHNL_OP_EVENT:
 199                 return "VIRTCHNL_OP_EVENT";
 200         case VIRTCHNL_OP_CONFIG_RSS_KEY:
 201                 return "VIRTCHNL_OP_CONFIG_RSS_KEY";
 202         case VIRTCHNL_OP_CONFIG_RSS_LUT:
 203                 return "VIRTCHNL_OP_CONFIG_RSS_LUT";
 204         case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
 205                 return "VIRTCHNL_OP_GET_RSS_HENA_CAPS";
 206         case VIRTCHNL_OP_SET_RSS_HENA:
 207                 return "VIRTCHNL_OP_SET_RSS_HENA";
 208         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
 209                 return "VIRTCHNL_OP_ENABLE_VLAN_STRIPPING";
 210         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
 211                 return "VIRTCHNL_OP_DISABLE_VLAN_STRIPPING";
 212         case VIRTCHNL_OP_REQUEST_QUEUES:
 213                 return "VIRTCHNL_OP_REQUEST_QUEUES";
 214         case VIRTCHNL_OP_ENABLE_CHANNELS:
 215                 return "VIRTCHNL_OP_ENABLE_CHANNELS";
 216         case VIRTCHNL_OP_DISABLE_CHANNELS:
 217                 return "VIRTCHNL_OP_DISABLE_CHANNELS";
 218         case VIRTCHNL_OP_ADD_CLOUD_FILTER:
 219                 return "VIRTCHNL_OP_ADD_CLOUD_FILTER";
 220         case VIRTCHNL_OP_DEL_CLOUD_FILTER:
 221                 return "VIRTCHNL_OP_DEL_CLOUD_FILTER";
 222         case VIRTCHNL_OP_DCF_CMD_DESC:
 223                 return "VIRTCHNL_OP_DCF_CMD_DESC";
 224         case VIRTCHNL_OP_DCF_CMD_BUFF:
 225                 return "VIRTCHHNL_OP_DCF_CMD_BUFF";
 226         case VIRTCHNL_OP_DCF_DISABLE:
 227                 return "VIRTCHNL_OP_DCF_DISABLE";
 228         case VIRTCHNL_OP_DCF_GET_VSI_MAP:
 229                 return "VIRTCHNL_OP_DCF_GET_VSI_MAP";
 230         case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
 231                 return "VIRTCHNL_OP_GET_SUPPORTED_RXDIDS";
 232         case VIRTCHNL_OP_ADD_RSS_CFG:
 233                 return "VIRTCHNL_OP_ADD_RSS_CFG";
 234         case VIRTCHNL_OP_DEL_RSS_CFG:
 235                 return "VIRTCHNL_OP_DEL_RSS_CFG";
 236         case VIRTCHNL_OP_ADD_FDIR_FILTER:
 237                 return "VIRTCHNL_OP_ADD_FDIR_FILTER";
 238         case VIRTCHNL_OP_DEL_FDIR_FILTER:
 239                 return "VIRTCHNL_OP_DEL_FDIR_FILTER";
 240         case VIRTCHNL_OP_QUERY_FDIR_FILTER:
 241                 return "VIRTCHNL_OP_QUERY_FDIR_FILTER";
 242         case VIRTCHNL_OP_GET_MAX_RSS_QREGION:
 243                 return "VIRTCHNL_OP_GET_MAX_RSS_QREGION";
 244         case VIRTCHNL_OP_ENABLE_QUEUES_V2:
 245                 return "VIRTCHNL_OP_ENABLE_QUEUES_V2";
 246         case VIRTCHNL_OP_DISABLE_QUEUES_V2:
 247                 return "VIRTCHNL_OP_DISABLE_QUEUES_V2";
 248         case VIRTCHNL_OP_MAP_QUEUE_VECTOR:
 249                 return "VIRTCHNL_OP_MAP_QUEUE_VECTOR";
 250         case VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS:
 251                 return "VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS";
 252         case VIRTCHNL_OP_ADD_VLAN_V2:
 253                 return "VIRTCHNL_OP_ADD_VLAN_V2";
 254         case VIRTCHNL_OP_DEL_VLAN_V2:
 255                 return "VIRTCHNL_OP_DEL_VLAN_V2";
 256         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2:
 257                 return "VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2";
 258         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2:
 259                 return "VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2";
 260         case VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2:
 261                 return "VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2";
 262         case VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2:
 263                 return "VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2";
 264         case VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2:
 265                 return "VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2";
 266         case VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2:
 267                 return "VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2";
 268         case VIRTCHNL_OP_MAX:
 269                 return "VIRTCHNL_OP_MAX";
 270         default:
 271                 return "Unsupported (update virtchnl.h)";
 272         }
 273 }
 274
 275 /* These macros are used to generate compilation errors if a structure/union
 276  * is not exactly the correct length. It gives a divide by zero error if the
 277  * structure/union is not of the correct size, otherwise it creates an enum
 278  * that is never used.
 279  */
 280 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \
 281         { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) }
 282 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \
 283         { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) }
 284
 285 /* Virtual channel message descriptor. This overlays the admin queue
 286  * descriptor. All other data is passed in external buffers.
 287  */
 288
 289 struct virtchnl_msg {
 290         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
 291
 292         /* avoid confusion with desc->opcode */
 293         enum virtchnl_ops v_opcode;
 294
 295         /* ditto for desc->retval */
 296         enum virtchnl_status_code v_retval;
 297         u32 vfid;                        /* used by PF when sending to VF */
 298 };
 299
 300 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg);
 301
 302 /* Message descriptions and data structures. */
 303
 304 /* VIRTCHNL_OP_VERSION
 305  * VF posts its version number to the PF. PF responds with its version number
 306  * in the same format, along with a return code.
 307  * Reply from PF has its major/minor versions also in param0 and param1.
 308  * If there is a major version mismatch, then the VF cannot operate.
 309  * If there is a minor version mismatch, then the VF can operate but should
 310  * add a warning to the system log.
 311  *
 312  * This enum element MUST always be specified as == 1, regardless of other
 313  * changes in the API. The PF must always respond to this message without
 314  * error regardless of version mismatch.
 315  */
 316 #define VIRTCHNL_VERSION_MAJOR          1
 317 #define VIRTCHNL_VERSION_MINOR          1
 318 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS       0
 319
 320 struct virtchnl_version_info {
 321         u32 major;
 322         u32 minor;
 323 };
 324
 325 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info);
 326
 327 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0))
 328 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1))
 329
 330 /* VIRTCHNL_OP_RESET_VF
 331  * VF sends this request to PF with no parameters
 332  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
 333  * until reset completion is indicated. The admin queue must be reinitialized
 334  * after this operation.
 335  *
 336  * When reset is complete, PF must ensure that all queues in all VSIs associated
 337  * with the VF are stopped, all queue configurations in the HMC are set to 0,
 338  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
 339  * are cleared.
 340  */
 341
 342 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV
 343  * vsi_type should always be 6 for backward compatibility. Add other fields
 344  * as needed.
 345  */
 346 enum virtchnl_vsi_type {
 347         VIRTCHNL_VSI_TYPE_INVALID = 0,
 348         VIRTCHNL_VSI_SRIOV = 6,
 349 };
 350
 351 /* VIRTCHNL_OP_GET_VF_RESOURCES
 352  * Version 1.0 VF sends this request to PF with no parameters
 353  * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
 354  * PF responds with an indirect message containing
 355  * virtchnl_vf_resource and one or more
 356  * virtchnl_vsi_resource structures.
 357  */
 358
 359 struct virtchnl_vsi_resource {
 360         u16 vsi_id;
 361         u16 num_queue_pairs;
 362
 363         /* see enum virtchnl_vsi_type */
 364         s32 vsi_type;
 365         u16 qset_handle;
 366         u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
 367 };
 368
 369 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource);
 370
 371 /* VF capability flags
 372  * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including
 373  * TX/RX Checksum offloading and TSO for non-tunnelled packets.
 374  */
 375 #define VIRTCHNL_VF_OFFLOAD_L2                  BIT(0)
 376 #define VIRTCHNL_VF_OFFLOAD_IWARP               BIT(1)
 377 #define VIRTCHNL_VF_OFFLOAD_RSVD                BIT(2)
 378 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ              BIT(3)
 379 #define VIRTCHNL_VF_OFFLOAD_RSS_REG             BIT(4)
 380 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR           BIT(5)
 381 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES          BIT(6)
 382 /* used to negotiate communicating link speeds in Mbps */
 383 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED          BIT(7)
 384         /* BIT(8) is reserved */
 385 #define VIRTCHNL_VF_LARGE_NUM_QPAIRS            BIT(9)
 386 #define VIRTCHNL_VF_OFFLOAD_CRC                 BIT(10)
 387 #define VIRTCHNL_VF_OFFLOAD_VLAN_V2             BIT(15)
 388 #define VIRTCHNL_VF_OFFLOAD_VLAN                BIT(16)
 389 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING          BIT(17)
 390 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2       BIT(18)
 391 #define VIRTCHNL_VF_OFFLOAD_RSS_PF              BIT(19)
 392 #define VIRTCHNL_VF_OFFLOAD_ENCAP               BIT(20)
 393 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM          BIT(21)
 394 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM       BIT(22)
 395 #define VIRTCHNL_VF_OFFLOAD_ADQ                 BIT(23)
 396 #define VIRTCHNL_VF_OFFLOAD_ADQ_V2              BIT(24)
 397 #define VIRTCHNL_VF_OFFLOAD_USO                 BIT(25)
 398 #define VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC        BIT(26)
 399 #define VIRTCHNL_VF_OFFLOAD_ADV_RSS_PF          BIT(27)
 400 #define VIRTCHNL_VF_OFFLOAD_FDIR_PF             BIT(28)
 401 #define VIRTCHNL_VF_CAP_DCF                     BIT(30)
 402         /* BIT(31) is reserved */
 403
 404 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \
 405                                VIRTCHNL_VF_OFFLOAD_VLAN | \
 406                                VIRTCHNL_VF_OFFLOAD_RSS_PF)
 407
 408 struct virtchnl_vf_resource {
 409         u16 num_vsis;
 410         u16 num_queue_pairs;
 411         u16 max_vectors;
 412         u16 max_mtu;
 413
 414         u32 vf_cap_flags;
 415         u32 rss_key_size;
 416         u32 rss_lut_size;
 417
 418         struct virtchnl_vsi_resource vsi_res[1];
 419 };
 420
 421 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource);
 422
 423 /* VIRTCHNL_OP_CONFIG_TX_QUEUE
 424  * VF sends this message to set up parameters for one TX queue.
 425  * External data buffer contains one instance of virtchnl_txq_info.
 426  * PF configures requested queue and returns a status code.
 427  */
 428
 429 /* Tx queue config info */
 430 struct virtchnl_txq_info {
 431         u16 vsi_id;
 432         u16 queue_id;
 433         u16 ring_len;           /* number of descriptors, multiple of 8 */
 434         u16 headwb_enabled; /* deprecated with AVF 1.0 */
 435         u64 dma_ring_addr;
 436         u64 dma_headwb_addr; /* deprecated with AVF 1.0 */
 437 };
 438
 439 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info);
 440
 441 /* RX descriptor IDs (range from 0 to 63) */
 442 enum virtchnl_rx_desc_ids {
 443         VIRTCHNL_RXDID_0_16B_BASE               = 0,
 444         /* 32B_BASE and FLEX_SPLITQ share desc ids as default descriptors
 445          * because they can be differentiated based on queue model; e.g. single
 446          * queue model can only use 32B_BASE and split queue model can only use
 447          * FLEX_SPLITQ.  Having these as 1 allows them to be used as default
 448          * descriptors without negotiation.
 449          */
 450         VIRTCHNL_RXDID_1_32B_BASE               = 1,
 451         VIRTCHNL_RXDID_1_FLEX_SPLITQ            = 1,
 452         VIRTCHNL_RXDID_2_FLEX_SQ_NIC            = 2,
 453         VIRTCHNL_RXDID_3_FLEX_SQ_SW             = 3,
 454         VIRTCHNL_RXDID_4_FLEX_SQ_NIC_VEB        = 4,
 455         VIRTCHNL_RXDID_5_FLEX_SQ_NIC_ACL        = 5,
 456         VIRTCHNL_RXDID_6_FLEX_SQ_NIC_2          = 6,
 457         VIRTCHNL_RXDID_7_HW_RSVD                = 7,
 458         /* 9 through 15 are reserved */
 459         VIRTCHNL_RXDID_16_COMMS_GENERIC         = 16,
 460         VIRTCHNL_RXDID_17_COMMS_AUX_VLAN        = 17,
 461         VIRTCHNL_RXDID_18_COMMS_AUX_IPV4        = 18,
 462         VIRTCHNL_RXDID_19_COMMS_AUX_IPV6        = 19,
 463         VIRTCHNL_RXDID_20_COMMS_AUX_FLOW        = 20,
 464         VIRTCHNL_RXDID_21_COMMS_AUX_TCP         = 21,
 465         /* 22 through 63 are reserved */
 466 };
 467
 468 /* RX descriptor ID bitmasks */
 469 enum virtchnl_rx_desc_id_bitmasks {
 470         VIRTCHNL_RXDID_0_16B_BASE_M             = BIT(VIRTCHNL_RXDID_0_16B_BASE),
 471         VIRTCHNL_RXDID_1_32B_BASE_M             = BIT(VIRTCHNL_RXDID_1_32B_BASE),
 472         VIRTCHNL_RXDID_1_FLEX_SPLITQ_M          = BIT(VIRTCHNL_RXDID_1_FLEX_SPLITQ),
 473         VIRTCHNL_RXDID_2_FLEX_SQ_NIC_M          = BIT(VIRTCHNL_RXDID_2_FLEX_SQ_NIC),
 474         VIRTCHNL_RXDID_3_FLEX_SQ_SW_M           = BIT(VIRTCHNL_RXDID_3_FLEX_SQ_SW),
 475         VIRTCHNL_RXDID_4_FLEX_SQ_NIC_VEB_M      = BIT(VIRTCHNL_RXDID_4_FLEX_SQ_NIC_VEB),
 476         VIRTCHNL_RXDID_5_FLEX_SQ_NIC_ACL_M      = BIT(VIRTCHNL_RXDID_5_FLEX_SQ_NIC_ACL),
 477         VIRTCHNL_RXDID_6_FLEX_SQ_NIC_2_M        = BIT(VIRTCHNL_RXDID_6_FLEX_SQ_NIC_2),
 478         VIRTCHNL_RXDID_7_HW_RSVD_M              = BIT(VIRTCHNL_RXDID_7_HW_RSVD),
 479         /* 9 through 15 are reserved */
 480         VIRTCHNL_RXDID_16_COMMS_GENERIC_M       = BIT(VIRTCHNL_RXDID_16_COMMS_GENERIC),
 481         VIRTCHNL_RXDID_17_COMMS_AUX_VLAN_M      = BIT(VIRTCHNL_RXDID_17_COMMS_AUX_VLAN),
 482         VIRTCHNL_RXDID_18_COMMS_AUX_IPV4_M      = BIT(VIRTCHNL_RXDID_18_COMMS_AUX_IPV4),
 483         VIRTCHNL_RXDID_19_COMMS_AUX_IPV6_M      = BIT(VIRTCHNL_RXDID_19_COMMS_AUX_IPV6),
 484         VIRTCHNL_RXDID_20_COMMS_AUX_FLOW_M      = BIT(VIRTCHNL_RXDID_20_COMMS_AUX_FLOW),
 485         VIRTCHNL_RXDID_21_COMMS_AUX_TCP_M       = BIT(VIRTCHNL_RXDID_21_COMMS_AUX_TCP),
 486         /* 22 through 63 are reserved */
 487 };
 488
 489 /* VIRTCHNL_OP_CONFIG_RX_QUEUE
 490  * VF sends this message to set up parameters for one RX queue.
 491  * External data buffer contains one instance of virtchnl_rxq_info.
 492  * PF configures requested queue and returns a status code. The
 493  * crc_disable flag disables CRC stripping on the VF. Setting
 494  * the crc_disable flag to 1 will disable CRC stripping for each
 495  * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC
 496  * offload must have been set prior to sending this info or the PF
 497  * will ignore the request. This flag should be set the same for
 498  * all of the queues for a VF.
 499  */
 500
 501 /* Rx queue config info */
 502 struct virtchnl_rxq_info {
 503         u16 vsi_id;
 504         u16 queue_id;
 505         u32 ring_len;           /* number of descriptors, multiple of 32 */
 506         u16 hdr_size;
 507         u16 splithdr_enabled; /* deprecated with AVF 1.0 */
 508         u32 databuffer_size;
 509         u32 max_pkt_size;
 510         u8 crc_disable;
 511         /* see enum virtchnl_rx_desc_ids;
 512          * only used when VIRTCHNL_VF_OFFLOAD_RX_FLEX_DESC is supported. Note
 513          * that when the offload is not supported, the descriptor format aligns
 514          * with VIRTCHNL_RXDID_1_32B_BASE.
 515          */
 516         u8 rxdid;
 517         u8 pad1[2];
 518         u64 dma_ring_addr;
 519
 520         /* see enum virtchnl_rx_hsplit; deprecated with AVF 1.0 */
 521         s32 rx_split_pos;
 522         u32 pad2;
 523 };
 524
 525 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info);
 526
 527 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES
 528  * VF sends this message to set parameters for active TX and RX queues
 529  * associated with the specified VSI.
 530  * PF configures queues and returns status.
 531  * If the number of queues specified is greater than the number of queues
 532  * associated with the VSI, an error is returned and no queues are configured.
 533  * NOTE: The VF is not required to configure all queues in a single request.
 534  * It may send multiple messages. PF drivers must correctly handle all VF
 535  * requests.
 536  */
 537 struct virtchnl_queue_pair_info {
 538         /* NOTE: vsi_id and queue_id should be identical for both queues. */
 539         struct virtchnl_txq_info txq;
 540         struct virtchnl_rxq_info rxq;
 541 };
 542
 543 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info);
 544
 545 struct virtchnl_vsi_queue_config_info {
 546         u16 vsi_id;
 547         u16 num_queue_pairs;
 548         u32 pad;
 549         struct virtchnl_queue_pair_info qpair[1];
 550 };
 551
 552 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info);
 553
 554 /* VIRTCHNL_OP_REQUEST_QUEUES
 555  * VF sends this message to request the PF to allocate additional queues to
 556  * this VF.  Each VF gets a guaranteed number of queues on init but asking for
 557  * additional queues must be negotiated.  This is a best effort request as it
 558  * is possible the PF does not have enough queues left to support the request.
 559  * If the PF cannot support the number requested it will respond with the
 560  * maximum number it is able to support.  If the request is successful, PF will
 561  * then reset the VF to institute required changes.
 562  */
 563
 564 /* VF resource request */
 565 struct virtchnl_vf_res_request {
 566         u16 num_queue_pairs;
 567 };
 568
 569 /* VIRTCHNL_OP_CONFIG_IRQ_MAP
 570  * VF uses this message to map vectors to queues.
 571  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
 572  * are to be associated with the specified vector.
 573  * The "other" causes are always mapped to vector 0. The VF may not request
 574  * that vector 0 be used for traffic.
 575  * PF configures interrupt mapping and returns status.
 576  * NOTE: due to hardware requirements, all active queues (both TX and RX)
 577  * should be mapped to interrupts, even if the driver intends to operate
 578  * only in polling mode. In this case the interrupt may be disabled, but
 579  * the ITR timer will still run to trigger writebacks.
 580  */
 581 struct virtchnl_vector_map {
 582         u16 vsi_id;
 583         u16 vector_id;
 584         u16 rxq_map;
 585         u16 txq_map;
 586         u16 rxitr_idx;
 587         u16 txitr_idx;
 588 };
 589
 590 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map);
 591
 592 struct virtchnl_irq_map_info {
 593         u16 num_vectors;
 594         struct virtchnl_vector_map vecmap[1];
 595 };
 596
 597 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info);
 598
 599 /* VIRTCHNL_OP_ENABLE_QUEUES
 600  * VIRTCHNL_OP_DISABLE_QUEUES
 601  * VF sends these message to enable or disable TX/RX queue pairs.
 602  * The queues fields are bitmaps indicating which queues to act upon.
 603  * (Currently, we only support 16 queues per VF, but we make the field
 604  * u32 to allow for expansion.)
 605  * PF performs requested action and returns status.
 606  * NOTE: The VF is not required to enable/disable all queues in a single
 607  * request. It may send multiple messages.
 608  * PF drivers must correctly handle all VF requests.
 609  */
 610 struct virtchnl_queue_select {
 611         u16 vsi_id;
 612         u16 pad;
 613         u32 rx_queues;
 614         u32 tx_queues;
 615 };
 616
 617 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select);
 618
 619 /* VIRTCHNL_OP_GET_MAX_RSS_QREGION
 620  *
 621  * if VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
 622  * then this op must be supported.
 623  *
 624  * VF sends this message in order to query the max RSS queue region
 625  * size supported by PF, when VIRTCHNL_VF_LARGE_NUM_QPAIRS is enabled.
 626  * This information should be used when configuring the RSS LUT and/or
 627  * configuring queue region based filters.
 628  *
 629  * The maximum RSS queue region is 2^qregion_width. So, a qregion_width
 630  * of 6 would inform the VF that the PF supports a maximum RSS queue region
 631  * of 64.
 632  *
 633  * A queue region represents a range of queues that can be used to configure
 634  * a RSS LUT. For example, if a VF is given 64 queues, but only a max queue
 635  * region size of 16 (i.e. 2^qregion_width = 16) then it will only be able
 636  * to configure the RSS LUT with queue indices from 0 to 15. However, other
 637  * filters can be used to direct packets to queues >15 via specifying a queue
 638  * base/offset and queue region width.
 639  */
 640 struct virtchnl_max_rss_qregion {
 641         u16 vport_id;
 642         u16 qregion_width;
 643         u8 pad[4];
 644 };
 645
 646 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_max_rss_qregion);
 647
 648 /* VIRTCHNL_OP_ADD_ETH_ADDR
 649  * VF sends this message in order to add one or more unicast or multicast
 650  * address filters for the specified VSI.
 651  * PF adds the filters and returns status.
 652  */
 653
 654 /* VIRTCHNL_OP_DEL_ETH_ADDR
 655  * VF sends this message in order to remove one or more unicast or multicast
 656  * filters for the specified VSI.
 657  * PF removes the filters and returns status.
 658  */
 659
 660 /* VIRTCHNL_ETHER_ADDR_LEGACY
 661  * Prior to adding the @type member to virtchnl_ether_addr, there were 2 pad
 662  * bytes. Moving forward all VF drivers should not set type to
 663  * VIRTCHNL_ETHER_ADDR_LEGACY. This is only here to not break previous/legacy
 664  * behavior. The control plane function (i.e. PF) can use a best effort method
 665  * of tracking the primary/device unicast in this case, but there is no
 666  * guarantee and functionality depends on the implementation of the PF.
 667  */
 668
 669 /* VIRTCHNL_ETHER_ADDR_PRIMARY
 670  * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_PRIMARY for the
 671  * primary/device unicast MAC address filter for VIRTCHNL_OP_ADD_ETH_ADDR and
 672  * VIRTCHNL_OP_DEL_ETH_ADDR. This allows for the underlying control plane
 673  * function (i.e. PF) to accurately track and use this MAC address for
 674  * displaying on the host and for VM/function reset.
 675  */
 676
 677 /* VIRTCHNL_ETHER_ADDR_EXTRA
 678  * All VF drivers should set @type to VIRTCHNL_ETHER_ADDR_EXTRA for any extra
 679  * unicast and/or multicast filters that are being added/deleted via
 680  * VIRTCHNL_OP_DEL_ETH_ADDR/VIRTCHNL_OP_ADD_ETH_ADDR respectively.
 681  */
 682 struct virtchnl_ether_addr {
 683         u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
 684         u8 type;
 685 #define VIRTCHNL_ETHER_ADDR_LEGACY      0
 686 #define VIRTCHNL_ETHER_ADDR_PRIMARY     1
 687 #define VIRTCHNL_ETHER_ADDR_EXTRA       2
 688 #define VIRTCHNL_ETHER_ADDR_TYPE_MASK   3 /* first two bits of type are valid */
 689         u8 pad;
 690 };
 691
 692 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr);
 693
 694 struct virtchnl_ether_addr_list {
 695         u16 vsi_id;
 696         u16 num_elements;
 697         struct virtchnl_ether_addr list[1];
 698 };
 699
 700 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list);
 701
 702 /* VIRTCHNL_OP_ADD_VLAN
 703  * VF sends this message to add one or more VLAN tag filters for receives.
 704  * PF adds the filters and returns status.
 705  * If a port VLAN is configured by the PF, this operation will return an
 706  * error to the VF.
 707  */
 708
 709 /* VIRTCHNL_OP_DEL_VLAN
 710  * VF sends this message to remove one or more VLAN tag filters for receives.
 711  * PF removes the filters and returns status.
 712  * If a port VLAN is configured by the PF, this operation will return an
 713  * error to the VF.
 714  */
 715
 716 struct virtchnl_vlan_filter_list {
 717         u16 vsi_id;
 718         u16 num_elements;
 719         u16 vlan_id[1];
 720 };
 721
 722 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list);
 723
 724 /* This enum is used for all of the VIRTCHNL_VF_OFFLOAD_VLAN_V2_CAPS related
 725  * structures and opcodes.
 726  *
 727  * VIRTCHNL_VLAN_UNSUPPORTED - This field is not supported and if a VF driver
 728  * populates it the PF should return VIRTCHNL_STATUS_ERR_NOT_SUPPORTED.
 729  *
 730  * VIRTCHNL_VLAN_ETHERTYPE_8100 - This field supports 0x8100 ethertype.
 731  * VIRTCHNL_VLAN_ETHERTYPE_88A8 - This field supports 0x88A8 ethertype.
 732  * VIRTCHNL_VLAN_ETHERTYPE_9100 - This field supports 0x9100 ethertype.
 733  *
 734  * VIRTCHNL_VLAN_ETHERTYPE_AND - Used when multiple ethertypes can be supported
 735  * by the PF concurrently. For example, if the PF can support
 736  * VIRTCHNL_VLAN_ETHERTYPE_8100 AND VIRTCHNL_VLAN_ETHERTYPE_88A8 filters it
 737  * would OR the following bits:
 738  *
 739  *      VIRTHCNL_VLAN_ETHERTYPE_8100 |
 740  *      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
 741  *      VIRTCHNL_VLAN_ETHERTYPE_AND;
 742  *
 743  * The VF would interpret this as VLAN filtering can be supported on both 0x8100
 744  * and 0x88A8 VLAN ethertypes.
 745  *
 746  * VIRTCHNL_ETHERTYPE_XOR - Used when only a single ethertype can be supported
 747  * by the PF concurrently. For example if the PF can support
 748  * VIRTCHNL_VLAN_ETHERTYPE_8100 XOR VIRTCHNL_VLAN_ETHERTYPE_88A8 stripping
 749  * offload it would OR the following bits:
 750  *
 751  *      VIRTCHNL_VLAN_ETHERTYPE_8100 |
 752  *      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
 753  *      VIRTCHNL_VLAN_ETHERTYPE_XOR;
 754  *
 755  * The VF would interpret this as VLAN stripping can be supported on either
 756  * 0x8100 or 0x88a8 VLAN ethertypes. So when requesting VLAN stripping via
 757  * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 the specified ethertype will override
 758  * the previously set value.
 759  *
 760  * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG1 - Used to tell the VF to insert and/or
 761  * strip the VLAN tag using the L2TAG1 field of the Tx/Rx descriptors.
 762  *
 763  * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to insert hardware
 764  * offloaded VLAN tags using the L2TAG2 field of the Tx descriptor.
 765  *
 766  * VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 - Used to tell the VF to strip hardware
 767  * offloaded VLAN tags using the L2TAG2_2 field of the Rx descriptor.
 768  *
 769  * VIRTCHNL_VLAN_PRIO - This field supports VLAN priority bits. This is used for
 770  * VLAN filtering if the underlying PF supports it.
 771  *
 772  * VIRTCHNL_VLAN_TOGGLE_ALLOWED - This field is used to say whether a
 773  * certain VLAN capability can be toggled. For example if the underlying PF/CP
 774  * allows the VF to toggle VLAN filtering, stripping, and/or insertion it should
 775  * set this bit along with the supported ethertypes.
 776  */
 777 enum virtchnl_vlan_support {
 778         VIRTCHNL_VLAN_UNSUPPORTED =             0,
 779         VIRTCHNL_VLAN_ETHERTYPE_8100 =          0x00000001,
 780         VIRTCHNL_VLAN_ETHERTYPE_88A8 =          0x00000002,
 781         VIRTCHNL_VLAN_ETHERTYPE_9100 =          0x00000004,
 782         VIRTCHNL_VLAN_TAG_LOCATION_L2TAG1 =     0x00000100,
 783         VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2 =     0x00000200,
 784         VIRTCHNL_VLAN_TAG_LOCATION_L2TAG2_2 =   0x00000400,
 785         VIRTCHNL_VLAN_PRIO =                    0x01000000,
 786         VIRTCHNL_VLAN_FILTER_MASK =             0x10000000,
 787         VIRTCHNL_VLAN_ETHERTYPE_AND =           0x20000000,
 788         VIRTCHNL_VLAN_ETHERTYPE_XOR =           0x40000000,
 789         VIRTCHNL_VLAN_TOGGLE =                  0x80000000
 790 };
 791
 792 /* This structure is used as part of the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS
 793  * for filtering, insertion, and stripping capabilities.
 794  *
 795  * If only outer capabilities are supported (for filtering, insertion, and/or
 796  * stripping) then this refers to the outer most or single VLAN from the VF's
 797  * perspective.
 798  *
 799  * If only inner capabilities are supported (for filtering, insertion, and/or
 800  * stripping) then this refers to the outer most or single VLAN from the VF's
 801  * perspective. Functionally this is the same as if only outer capabilities are
 802  * supported. The VF driver is just forced to use the inner fields when
 803  * adding/deleting filters and enabling/disabling offloads (if supported).
 804  *
 805  * If both outer and inner capabilities are supported (for filtering, insertion,
 806  * and/or stripping) then outer refers to the outer most or single VLAN and
 807  * inner refers to the second VLAN, if it exists, in the packet.
 808  *
 809  * There is no support for tunneled VLAN offloads, so outer or inner are never
 810  * referring to a tunneled packet from the VF's perspective.
 811  */
 812 struct virtchnl_vlan_supported_caps {
 813         u32 outer;
 814         u32 inner;
 815 };
 816
 817 /* The PF populates these fields based on the supported VLAN filtering. If a
 818  * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will
 819  * reject any VIRTCHNL_OP_ADD_VLAN_V2 or VIRTCHNL_OP_DEL_VLAN_V2 messages using
 820  * the unsupported fields.
 821  *
 822  * Also, a VF is only allowed to toggle its VLAN filtering setting if the
 823  * VIRTCHNL_VLAN_TOGGLE bit is set.
 824  *
 825  * The ethertype(s) specified in the ethertype_init field are the ethertypes
 826  * enabled for VLAN filtering. VLAN filtering in this case refers to the outer
 827  * most VLAN from the VF's perspective. If both inner and outer filtering are
 828  * allowed then ethertype_init only refers to the outer most VLAN as only
 829  * VLAN ethertype supported for inner VLAN filtering is
 830  * VIRTCHNL_VLAN_ETHERTYPE_8100. By default, inner VLAN filtering is disabled
 831  * when both inner and outer filtering are allowed.
 832  *
 833  * The max_filters field tells the VF how many VLAN filters it's allowed to have
 834  * at any one time. If it exceeds this amount and tries to add another filter,
 835  * then the request will be rejected by the PF. To prevent failures, the VF
 836  * should keep track of how many VLAN filters it has added and not attempt to
 837  * add more than max_filters.
 838  */
 839 struct virtchnl_vlan_filtering_caps {
 840         struct virtchnl_vlan_supported_caps filtering_support;
 841         u32 ethertype_init;
 842         u16 max_filters;
 843         u8 pad[2];
 844 };
 845
 846 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vlan_filtering_caps);
 847
 848 /* This enum is used for the virtchnl_vlan_offload_caps structure to specify
 849  * if the PF supports a different ethertype for stripping and insertion.
 850  *
 851  * VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION - The ethertype(s) specified
 852  * for stripping affect the ethertype(s) specified for insertion and visa versa
 853  * as well. If the VF tries to configure VLAN stripping via
 854  * VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 with VIRTCHNL_VLAN_ETHERTYPE_8100 then
 855  * that will be the ethertype for both stripping and insertion.
 856  *
 857  * VIRTCHNL_ETHERTYPE_MATCH_NOT_REQUIRED - The ethertype(s) specified for
 858  * stripping do not affect the ethertype(s) specified for insertion and visa
 859  * versa.
 860  */
 861 enum virtchnl_vlan_ethertype_match {
 862         VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION = 0,
 863         VIRTCHNL_ETHERTYPE_MATCH_NOT_REQUIRED = 1,
 864 };
 865
 866 /* The PF populates these fields based on the supported VLAN offloads. If a
 867  * field is VIRTCHNL_VLAN_UNSUPPORTED then it's not supported and the PF will
 868  * reject any VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 or
 869  * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2 messages using the unsupported fields.
 870  *
 871  * Also, a VF is only allowed to toggle its VLAN offload setting if the
 872  * VIRTCHNL_VLAN_TOGGLE_ALLOWED bit is set.
 873  *
 874  * The VF driver needs to be aware of how the tags are stripped by hardware and
 875  * inserted by the VF driver based on the level of offload support. The PF will
 876  * populate these fields based on where the VLAN tags are expected to be
 877  * offloaded via the VIRTHCNL_VLAN_TAG_LOCATION_* bits. The VF will need to
 878  * interpret these fields. See the definition of the
 879  * VIRTCHNL_VLAN_TAG_LOCATION_* bits above the virtchnl_vlan_support
 880  * enumeration.
 881  */
 882 struct virtchnl_vlan_offload_caps {
 883         struct virtchnl_vlan_supported_caps stripping_support;
 884         struct virtchnl_vlan_supported_caps insertion_support;
 885         u32 ethertype_init;
 886         u8 ethertype_match;
 887         u8 pad[3];
 888 };
 889
 890 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_vlan_offload_caps);
 891
 892 /* VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS
 893  * VF sends this message to determine its VLAN capabilities.
 894  *
 895  * PF will mark which capabilities it supports based on hardware support and
 896  * current configuration. For example, if a port VLAN is configured the PF will
 897  * not allow outer VLAN filtering, stripping, or insertion to be configured so
 898  * it will block these features from the VF.
 899  *
 900  * The VF will need to cross reference its capabilities with the PFs
 901  * capabilities in the response message from the PF to determine the VLAN
 902  * support.
 903  */
 904 struct virtchnl_vlan_caps {
 905         struct virtchnl_vlan_filtering_caps filtering;
 906         struct virtchnl_vlan_offload_caps offloads;
 907 };
 908
 909 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_vlan_caps);
 910
 911 struct virtchnl_vlan {
 912         u16 tci;        /* tci[15:13] = PCP and tci[11:0] = VID */
 913         u16 tci_mask;   /* only valid if VIRTCHNL_VLAN_FILTER_MASK set in
 914                          * filtering caps
 915                          */
 916         u16 tpid;       /* 0x8100, 0x88a8, etc. and only type(s) set in
 917                          * filtering caps. Note that tpid here does not refer to
 918                          * VIRTCHNL_VLAN_ETHERTYPE_*, but it refers to the
 919                          * actual 2-byte VLAN TPID
 920                          */
 921         u8 pad[2];
 922 };
 923
 924 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_vlan);
 925
 926 struct virtchnl_vlan_filter {
 927         struct virtchnl_vlan inner;
 928         struct virtchnl_vlan outer;
 929         u8 pad[16];
 930 };
 931
 932 VIRTCHNL_CHECK_STRUCT_LEN(32, virtchnl_vlan_filter);
 933
 934 /* VIRTCHNL_OP_ADD_VLAN_V2
 935  * VIRTCHNL_OP_DEL_VLAN_V2
 936  *
 937  * VF sends these messages to add/del one or more VLAN tag filters for Rx
 938  * traffic.
 939  *
 940  * The PF attempts to add the filters and returns status.
 941  *
 942  * The VF should only ever attempt to add/del virtchnl_vlan_filter(s) using the
 943  * supported fields negotiated via VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS.
 944  */
 945 struct virtchnl_vlan_filter_list_v2 {
 946         u16 vport_id;
 947         u16 num_elements;
 948         u8 pad[4];
 949         struct virtchnl_vlan_filter filters[1];
 950 };
 951
 952 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_vlan_filter_list_v2);
 953
 954 /* VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2
 955  * VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2
 956  * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2
 957  * VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2
 958  *
 959  * VF sends this message to enable or disable VLAN stripping or insertion. It
 960  * also needs to specify an ethertype. The VF knows which VLAN ethertypes are
 961  * allowed and whether or not it's allowed to enable/disable the specific
 962  * offload via the VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS message. The VF needs to
 963  * parse the virtchnl_vlan_caps.offloads fields to determine which offload
 964  * messages are allowed.
 965  *
 966  * For example, if the PF populates the virtchnl_vlan_caps.offloads in the
 967  * following manner the VF will be allowed to enable and/or disable 0x8100 inner
 968  * VLAN insertion and/or stripping via the opcodes listed above. Inner in this
 969  * case means the outer most or single VLAN from the VF's perspective. This is
 970  * because no outer offloads are supported. See the comments above the
 971  * virtchnl_vlan_supported_caps structure for more details.
 972  *
 973  * virtchnl_vlan_caps.offloads.stripping_support.inner =
 974  *                      VIRTCHNL_VLAN_TOGGLE |
 975  *                      VIRTCHNL_VLAN_ETHERTYPE_8100;
 976  *
 977  * virtchnl_vlan_caps.offloads.insertion_support.inner =
 978  *                      VIRTCHNL_VLAN_TOGGLE |
 979  *                      VIRTCHNL_VLAN_ETHERTYPE_8100;
 980  *
 981  * In order to enable inner (again note that in this case inner is the outer
 982  * most or single VLAN from the VF's perspective) VLAN stripping for 0x8100
 983  * VLANs, the VF would populate the virtchnl_vlan_setting structure in the
 984  * following manner and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message.
 985  *
 986  * virtchnl_vlan_setting.inner_ethertype_setting =
 987  *                      VIRTCHNL_VLAN_ETHERTYPE_8100;
 988  *
 989  * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
 990  * initialization.
 991  *
 992  * The reason that VLAN TPID(s) are not being used for the
 993  * outer_ethertype_setting and inner_ethertype_setting fields is because it's
 994  * possible a device could support VLAN insertion and/or stripping offload on
 995  * multiple ethertypes concurrently, so this method allows a VF to request
 996  * multiple ethertypes in one message using the virtchnl_vlan_support
 997  * enumeration.
 998  *
 999  * For example, if the PF populates the virtchnl_vlan_caps.offloads in the
1000  * following manner the VF will be allowed to enable 0x8100 and 0x88a8 outer
1001  * VLAN insertion and stripping simultaneously. The
1002  * virtchnl_vlan_caps.offloads.ethertype_match field will also have to be
1003  * populated based on what the PF can support.
1004  *
1005  * virtchnl_vlan_caps.offloads.stripping_support.outer =
1006  *                      VIRTCHNL_VLAN_TOGGLE |
1007  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1008  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1009  *                      VIRTCHNL_VLAN_ETHERTYPE_AND;
1010  *
1011  * virtchnl_vlan_caps.offloads.insertion_support.outer =
1012  *                      VIRTCHNL_VLAN_TOGGLE |
1013  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1014  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1015  *                      VIRTCHNL_VLAN_ETHERTYPE_AND;
1016  *
1017  * In order to enable outer VLAN stripping for 0x8100 and 0x88a8 VLANs, the VF
1018  * would populate the virthcnl_vlan_offload_structure in the following manner
1019  * and send the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2 message.
1020  *
1021  * virtchnl_vlan_setting.outer_ethertype_setting =
1022  *                      VIRTHCNL_VLAN_ETHERTYPE_8100 |
1023  *                      VIRTHCNL_VLAN_ETHERTYPE_88A8;
1024  *
1025  * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
1026  * initialization.
1027  *
1028  * There is also the case where a PF and the underlying hardware can support
1029  * VLAN offloads on multiple ethertypes, but not concurrently. For example, if
1030  * the PF populates the virtchnl_vlan_caps.offloads in the following manner the
1031  * VF will be allowed to enable and/or disable 0x8100 XOR 0x88a8 outer VLAN
1032  * offloads. The ethertypes must match for stripping and insertion.
1033  *
1034  * virtchnl_vlan_caps.offloads.stripping_support.outer =
1035  *                      VIRTCHNL_VLAN_TOGGLE |
1036  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1037  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1038  *                      VIRTCHNL_VLAN_ETHERTYPE_XOR;
1039  *
1040  * virtchnl_vlan_caps.offloads.insertion_support.outer =
1041  *                      VIRTCHNL_VLAN_TOGGLE |
1042  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1043  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8 |
1044  *                      VIRTCHNL_VLAN_ETHERTYPE_XOR;
1045  *
1046  * virtchnl_vlan_caps.offloads.ethertype_match =
1047  *                      VIRTCHNL_ETHERTYPE_STRIPPING_MATCHES_INSERTION;
1048  *
1049  * In order to enable outer VLAN stripping for 0x88a8 VLANs, the VF would
1050  * populate the virtchnl_vlan_setting structure in the following manner and send
1051  * the VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2. Also, this will change the
1052  * ethertype for VLAN insertion if it's enabled. So, for completeness, a
1053  * VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2 with the same ethertype should be sent.
1054  *
1055  * virtchnl_vlan_setting.outer_ethertype_setting = VIRTHCNL_VLAN_ETHERTYPE_88A8;
1056  *
1057  * virtchnl_vlan_setting.vport_id = vport_id or vsi_id assigned to the VF on
1058  * initialization.
1059  *
1060  * VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2
1061  * VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2
1062  *
1063  * VF sends this message to enable or disable VLAN filtering. It also needs to
1064  * specify an ethertype. The VF knows which VLAN ethertypes are allowed and
1065  * whether or not it's allowed to enable/disable filtering via the
1066  * VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS message. The VF needs to
1067  * parse the virtchnl_vlan_caps.filtering fields to determine which, if any,
1068  * filtering messages are allowed.
1069  *
1070  * For example, if the PF populates the virtchnl_vlan_caps.filtering in the
1071  * following manner the VF will be allowed to enable/disable 0x8100 and 0x88a8
1072  * outer VLAN filtering together. Note, that the VIRTCHNL_VLAN_ETHERTYPE_AND
1073  * means that all filtering ethertypes will to be enabled and disabled together
1074  * regardless of the request from the VF. This means that the underlying
1075  * hardware only supports VLAN filtering for all VLAN the specified ethertypes
1076  * or none of them.
1077  *
1078  * virtchnl_vlan_caps.filtering.filtering_support.outer =
1079  *                      VIRTCHNL_VLAN_TOGGLE |
1080  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1081  *                      VIRTHCNL_VLAN_ETHERTYPE_88A8 |
1082  *                      VIRTCHNL_VLAN_ETHERTYPE_9100 |
1083  *                      VIRTCHNL_VLAN_ETHERTYPE_AND;
1084  *
1085  * In order to enable outer VLAN filtering for 0x88a8 and 0x8100 VLANs (0x9100
1086  * VLANs aren't supported by the VF driver), the VF would populate the
1087  * virtchnl_vlan_setting structure in the following manner and send the
1088  * VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2. The same message format would be used
1089  * to disable outer VLAN filtering for 0x88a8 and 0x8100 VLANs, but the
1090  * VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2 opcode is used.
1091  *
1092  * virtchnl_vlan_setting.outer_ethertype_setting =
1093  *                      VIRTCHNL_VLAN_ETHERTYPE_8100 |
1094  *                      VIRTCHNL_VLAN_ETHERTYPE_88A8;
1095  *
1096  */
1097 struct virtchnl_vlan_setting {
1098         u32 outer_ethertype_setting;
1099         u32 inner_ethertype_setting;
1100         u16 vport_id;
1101         u8 pad[6];
1102 };
1103
1104 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vlan_setting);
1105
1106 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
1107  * VF sends VSI id and flags.
1108  * PF returns status code in retval.
1109  * Note: we assume that broadcast accept mode is always enabled.
1110  */
1111 struct virtchnl_promisc_info {
1112         u16 vsi_id;
1113         u16 flags;
1114 };
1115
1116 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info);
1117
1118 #define FLAG_VF_UNICAST_PROMISC 0x00000001
1119 #define FLAG_VF_MULTICAST_PROMISC       0x00000002
1120
1121 /* VIRTCHNL_OP_GET_STATS
1122  * VF sends this message to request stats for the selected VSI. VF uses
1123  * the virtchnl_queue_select struct to specify the VSI. The queue_id
1124  * field is ignored by the PF.
1125  *
1126  * PF replies with struct virtchnl_eth_stats in an external buffer.
1127  */
1128
1129 struct virtchnl_eth_stats {
1130         u64 rx_bytes;                   /* received bytes */
1131         u64 rx_unicast;                 /* received unicast pkts */
1132         u64 rx_multicast;               /* received multicast pkts */
1133         u64 rx_broadcast;               /* received broadcast pkts */
1134         u64 rx_discards;
1135         u64 rx_unknown_protocol;
1136         u64 tx_bytes;                   /* transmitted bytes */
1137         u64 tx_unicast;                 /* transmitted unicast pkts */
1138         u64 tx_multicast;               /* transmitted multicast pkts */
1139         u64 tx_broadcast;               /* transmitted broadcast pkts */
1140         u64 tx_discards;
1141         u64 tx_errors;
1142 };
1143
1144 /* VIRTCHNL_OP_CONFIG_RSS_KEY
1145  * VIRTCHNL_OP_CONFIG_RSS_LUT
1146  * VF sends these messages to configure RSS. Only supported if both PF
1147  * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
1148  * configuration negotiation. If this is the case, then the RSS fields in
1149  * the VF resource struct are valid.
1150  * Both the key and LUT are initialized to 0 by the PF, meaning that
1151  * RSS is effectively disabled until set up by the VF.
1152  */
1153 struct virtchnl_rss_key {
1154         u16 vsi_id;
1155         u16 key_len;
1156         u8 key[1];         /* RSS hash key, packed bytes */
1157 };
1158
1159 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key);
1160
1161 struct virtchnl_rss_lut {
1162         u16 vsi_id;
1163         u16 lut_entries;
1164         u8 lut[1];        /* RSS lookup table */
1165 };
1166
1167 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut);
1168
1169 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS
1170  * VIRTCHNL_OP_SET_RSS_HENA
1171  * VF sends these messages to get and set the hash filter enable bits for RSS.
1172  * By default, the PF sets these to all possible traffic types that the
1173  * hardware supports. The VF can query this value if it wants to change the
1174  * traffic types that are hashed by the hardware.
1175  */
1176 struct virtchnl_rss_hena {
1177         u64 hena;
1178 };
1179
1180 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena);
1181
1182 /* Type of RSS algorithm */
1183 enum virtchnl_rss_algorithm {
1184         VIRTCHNL_RSS_ALG_TOEPLITZ_ASYMMETRIC    = 0,
1185         VIRTCHNL_RSS_ALG_XOR_ASYMMETRIC         = 1,
1186         VIRTCHNL_RSS_ALG_TOEPLITZ_SYMMETRIC     = 2,
1187         VIRTCHNL_RSS_ALG_XOR_SYMMETRIC          = 3,
1188 };
1189
1190 /* This is used by PF driver to enforce how many channels can be supported.
1191  * When ADQ_V2 capability is negotiated, it will allow 16 channels otherwise
1192  * PF driver will allow only max 4 channels
1193  */
1194 #define VIRTCHNL_MAX_ADQ_CHANNELS 4
1195 #define VIRTCHNL_MAX_ADQ_V2_CHANNELS 16
1196
1197 /* VIRTCHNL_OP_ENABLE_CHANNELS
1198  * VIRTCHNL_OP_DISABLE_CHANNELS
1199  * VF sends these messages to enable or disable channels based on
1200  * the user specified queue count and queue offset for each traffic class.
1201  * This struct encompasses all the information that the PF needs from
1202  * VF to create a channel.
1203  */
1204 struct virtchnl_channel_info {
1205         u16 count; /* number of queues in a channel */
1206         u16 offset; /* queues in a channel start from 'offset' */
1207         u32 pad;
1208         u64 max_tx_rate;
1209 };
1210
1211 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info);
1212
1213 struct virtchnl_tc_info {
1214         u32     num_tc;
1215         u32     pad;
1216         struct  virtchnl_channel_info list[1];
1217 };
1218
1219 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info);
1220
1221 /* VIRTCHNL_ADD_CLOUD_FILTER
1222  * VIRTCHNL_DEL_CLOUD_FILTER
1223  * VF sends these messages to add or delete a cloud filter based on the
1224  * user specified match and action filters. These structures encompass
1225  * all the information that the PF needs from the VF to add/delete a
1226  * cloud filter.
1227  */
1228
1229 struct virtchnl_l4_spec {
1230         u8      src_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
1231         u8      dst_mac[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
1232         /* vlan_prio is part of this 16 bit field even from OS perspective
1233          * vlan_id:12 is actual vlan_id, then vlanid:bit14..12 is vlan_prio
1234          * in future, when decided to offload vlan_prio, pass that information
1235          * as part of the "vlan_id" field, Bit14..12
1236          */
1237         __be16  vlan_id;
1238         __be16  pad; /* reserved for future use */
1239         __be32  src_ip[4];
1240         __be32  dst_ip[4];
1241         __be16  src_port;
1242         __be16  dst_port;
1243 };
1244
1245 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec);
1246
1247 union virtchnl_flow_spec {
1248         struct  virtchnl_l4_spec tcp_spec;
1249         u8      buffer[128]; /* reserved for future use */
1250 };
1251
1252 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec);
1253
1254 enum virtchnl_action {
1255         /* action types */
1256         VIRTCHNL_ACTION_DROP = 0,
1257         VIRTCHNL_ACTION_TC_REDIRECT,
1258         VIRTCHNL_ACTION_PASSTHRU,
1259         VIRTCHNL_ACTION_QUEUE,
1260         VIRTCHNL_ACTION_Q_REGION,
1261         VIRTCHNL_ACTION_MARK,
1262         VIRTCHNL_ACTION_COUNT,
1263 };
1264
1265 enum virtchnl_flow_type {
1266         /* flow types */
1267         VIRTCHNL_TCP_V4_FLOW = 0,
1268         VIRTCHNL_TCP_V6_FLOW,
1269         VIRTCHNL_UDP_V4_FLOW,
1270         VIRTCHNL_UDP_V6_FLOW,
1271 };
1272
1273 struct virtchnl_filter {
1274         union   virtchnl_flow_spec data;
1275         union   virtchnl_flow_spec mask;
1276
1277         /* see enum virtchnl_flow_type */
1278         s32     flow_type;
1279
1280         /* see enum virtchnl_action */
1281         s32     action;
1282         u32     action_meta;
1283         u8      field_flags;
1284 };
1285
1286 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter);
1287
1288 /* VIRTCHNL_OP_DCF_GET_VSI_MAP
1289  * VF sends this message to get VSI mapping table.
1290  * PF responds with an indirect message containing VF's
1291  * HW VSI IDs.
1292  * The index of vf_vsi array is the logical VF ID, the
1293  * value of vf_vsi array is the VF's HW VSI ID with its
1294  * valid configuration.
1295  */
1296 struct virtchnl_dcf_vsi_map {
1297         u16 pf_vsi;     /* PF's HW VSI ID */
1298         u16 num_vfs;    /* The actual number of VFs allocated */
1299 #define VIRTCHNL_DCF_VF_VSI_ID_S        0
1300 #define VIRTCHNL_DCF_VF_VSI_ID_M        (0xFFF << VIRTCHNL_DCF_VF_VSI_ID_S)
1301 #define VIRTCHNL_DCF_VF_VSI_VALID       BIT(15)
1302         u16 vf_vsi[1];
1303 };
1304
1305 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_dcf_vsi_map);
1306
1307 #define PKG_NAME_SIZE   32
1308 #define DSN_SIZE        8
1309
1310 struct pkg_version {
1311         u8 major;
1312         u8 minor;
1313         u8 update;
1314         u8 draft;
1315 };
1316
1317 VIRTCHNL_CHECK_STRUCT_LEN(4, pkg_version);
1318
1319 struct virtchnl_pkg_info {
1320         struct pkg_version pkg_ver;
1321         u32 track_id;
1322         char pkg_name[PKG_NAME_SIZE];
1323         u8 dsn[DSN_SIZE];
1324 };
1325
1326 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_pkg_info);
1327
1328 /* VIRTCHNL_OP_DCF_VLAN_OFFLOAD
1329  * DCF negotiates the VIRTCHNL_VF_OFFLOAD_VLAN_V2 capability firstly to get
1330  * the double VLAN configuration, then DCF sends this message to configure the
1331  * outer or inner VLAN offloads (insertion and strip) for the target VF.
1332  */
1333 struct virtchnl_dcf_vlan_offload {
1334         u16 vf_id;
1335         u16 tpid;
1336         u16 vlan_flags;
1337 #define VIRTCHNL_DCF_VLAN_TYPE_S                0
1338 #define VIRTCHNL_DCF_VLAN_TYPE_M                \
1339                         (0x1 << VIRTCHNL_DCF_VLAN_TYPE_S)
1340 #define VIRTCHNL_DCF_VLAN_TYPE_INNER            0x0
1341 #define VIRTCHNL_DCF_VLAN_TYPE_OUTER            0x1
1342 #define VIRTCHNL_DCF_VLAN_INSERT_MODE_S         1
1343 #define VIRTCHNL_DCF_VLAN_INSERT_MODE_M \
1344                         (0x7 << VIRTCHNL_DCF_VLAN_INSERT_MODE_S)
1345 #define VIRTCHNL_DCF_VLAN_INSERT_DISABLE        0x1
1346 #define VIRTCHNL_DCF_VLAN_INSERT_PORT_BASED     0x2
1347 #define VIRTCHNL_DCF_VLAN_INSERT_VIA_TX_DESC    0x3
1348 #define VIRTCHNL_DCF_VLAN_STRIP_MODE_S          4
1349 #define VIRTCHNL_DCF_VLAN_STRIP_MODE_M          \
1350                         (0x7 << VIRTCHNL_DCF_VLAN_STRIP_MODE_S)
1351 #define VIRTCHNL_DCF_VLAN_STRIP_DISABLE         0x1
1352 #define VIRTCHNL_DCF_VLAN_STRIP_ONLY            0x2
1353 #define VIRTCHNL_DCF_VLAN_STRIP_INTO_RX_DESC    0x3
1354         u16 vlan_id;
1355         u16 pad[4];
1356 };
1357
1358 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_dcf_vlan_offload);
1359
1360 struct virtchnl_supported_rxdids {
1361         /* see enum virtchnl_rx_desc_id_bitmasks */
1362         u64 supported_rxdids;
1363 };
1364
1365 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_supported_rxdids);
1366
1367 /* VIRTCHNL_OP_EVENT
1368  * PF sends this message to inform the VF driver of events that may affect it.
1369  * No direct response is expected from the VF, though it may generate other
1370  * messages in response to this one.
1371  */
1372 enum virtchnl_event_codes {
1373         VIRTCHNL_EVENT_UNKNOWN = 0,
1374         VIRTCHNL_EVENT_LINK_CHANGE,
1375         VIRTCHNL_EVENT_RESET_IMPENDING,
1376         VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
1377         VIRTCHNL_EVENT_DCF_VSI_MAP_UPDATE,
1378 };
1379
1380 #define PF_EVENT_SEVERITY_INFO          0
1381 #define PF_EVENT_SEVERITY_ATTENTION     1
1382 #define PF_EVENT_SEVERITY_ACTION_REQUIRED       2
1383 #define PF_EVENT_SEVERITY_CERTAIN_DOOM  255
1384
1385 struct virtchnl_pf_event {
1386         /* see enum virtchnl_event_codes */
1387         s32 event;
1388         union {
1389                 /* If the PF driver does not support the new speed reporting
1390                  * capabilities then use link_event else use link_event_adv to
1391                  * get the speed and link information. The ability to understand
1392                  * new speeds is indicated by setting the capability flag
1393                  * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter
1394                  * in virtchnl_vf_resource struct and can be used to determine
1395                  * which link event struct to use below.
1396                  */
1397                 struct {
1398                         enum virtchnl_link_speed link_speed;
1399                         u8 link_status;
1400                 } link_event;
1401                 struct {
1402                         /* link_speed provided in Mbps */
1403                         u32 link_speed;
1404                         u8 link_status;
1405                 } link_event_adv;
1406                 struct {
1407                         u16 vf_id;
1408                         u16 vsi_id;
1409                 } vf_vsi_map;
1410         } event_data;
1411
1412         int severity;
1413 };
1414
1415 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event);
1416
1417
1418 /* VF reset states - these are written into the RSTAT register:
1419  * VFGEN_RSTAT on the VF
1420  * When the PF initiates a reset, it writes 0
1421  * When the reset is complete, it writes 1
1422  * When the PF detects that the VF has recovered, it writes 2
1423  * VF checks this register periodically to determine if a reset has occurred,
1424  * then polls it to know when the reset is complete.
1425  * If either the PF or VF reads the register while the hardware
1426  * is in a reset state, it will return DEADBEEF, which, when masked
1427  * will result in 3.
1428  */
1429 enum virtchnl_vfr_states {
1430         VIRTCHNL_VFR_INPROGRESS = 0,
1431         VIRTCHNL_VFR_COMPLETED,
1432         VIRTCHNL_VFR_VFACTIVE,
1433 };
1434
1435 #define VIRTCHNL_MAX_NUM_PROTO_HDRS     32
1436 #define PROTO_HDR_SHIFT                 5
1437 #define PROTO_HDR_FIELD_START(proto_hdr_type) \
1438                                         (proto_hdr_type << PROTO_HDR_SHIFT)
1439 #define PROTO_HDR_FIELD_MASK ((1UL << PROTO_HDR_SHIFT) - 1)
1440
1441 /* VF use these macros to configure each protocol header.
1442  * Specify which protocol headers and protocol header fields base on
1443  * virtchnl_proto_hdr_type and virtchnl_proto_hdr_field.
1444  * @param hdr: a struct of virtchnl_proto_hdr
1445  * @param hdr_type: ETH/IPV4/TCP, etc
1446  * @param field: SRC/DST/TEID/SPI, etc
1447  */
1448 #define VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, field) \
1449         ((hdr)->field_selector |= BIT((field) & PROTO_HDR_FIELD_MASK))
1450 #define VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, field) \
1451         ((hdr)->field_selector &= ~BIT((field) & PROTO_HDR_FIELD_MASK))
1452 #define VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val) \
1453         ((hdr)->field_selector & BIT((val) & PROTO_HDR_FIELD_MASK))
1454 #define VIRTCHNL_GET_PROTO_HDR_FIELD(hdr)       ((hdr)->field_selector)
1455
1456 #define VIRTCHNL_ADD_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
1457         (VIRTCHNL_ADD_PROTO_HDR_FIELD(hdr, \
1458                 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
1459 #define VIRTCHNL_DEL_PROTO_HDR_FIELD_BIT(hdr, hdr_type, field) \
1460         (VIRTCHNL_DEL_PROTO_HDR_FIELD(hdr, \
1461                 VIRTCHNL_PROTO_HDR_ ## hdr_type ## _ ## field))
1462
1463 #define VIRTCHNL_SET_PROTO_HDR_TYPE(hdr, hdr_type) \
1464         ((hdr)->type = VIRTCHNL_PROTO_HDR_ ## hdr_type)
1465 #define VIRTCHNL_GET_PROTO_HDR_TYPE(hdr) \
1466         (((hdr)->type) >> PROTO_HDR_SHIFT)
1467 #define VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) \
1468         ((hdr)->type == ((val) >> PROTO_HDR_SHIFT))
1469 #define VIRTCHNL_TEST_PROTO_HDR(hdr, val) \
1470         (VIRTCHNL_TEST_PROTO_HDR_TYPE(hdr, val) && \
1471          VIRTCHNL_TEST_PROTO_HDR_FIELD(hdr, val))
1472
1473 /* Protocol header type within a packet segment. A segment consists of one or
1474  * more protocol headers that make up a logical group of protocol headers. Each
1475  * logical group of protocol headers encapsulates or is encapsulated using/by
1476  * tunneling or encapsulation protocols for network virtualization.
1477  */
1478 enum virtchnl_proto_hdr_type {
1479         VIRTCHNL_PROTO_HDR_NONE,
1480         VIRTCHNL_PROTO_HDR_ETH,
1481         VIRTCHNL_PROTO_HDR_S_VLAN,
1482         VIRTCHNL_PROTO_HDR_C_VLAN,
1483         VIRTCHNL_PROTO_HDR_IPV4,
1484         VIRTCHNL_PROTO_HDR_IPV6,
1485         VIRTCHNL_PROTO_HDR_TCP,
1486         VIRTCHNL_PROTO_HDR_UDP,
1487         VIRTCHNL_PROTO_HDR_SCTP,
1488         VIRTCHNL_PROTO_HDR_GTPU_IP,
1489         VIRTCHNL_PROTO_HDR_GTPU_EH,
1490         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_DWN,
1491         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU_UP,
1492         VIRTCHNL_PROTO_HDR_PPPOE,
1493         VIRTCHNL_PROTO_HDR_L2TPV3,
1494         VIRTCHNL_PROTO_HDR_ESP,
1495         VIRTCHNL_PROTO_HDR_AH,
1496         VIRTCHNL_PROTO_HDR_PFCP,
1497         VIRTCHNL_PROTO_HDR_GTPC,
1498         VIRTCHNL_PROTO_HDR_ECPRI,
1499         VIRTCHNL_PROTO_HDR_L2TPV2,
1500         VIRTCHNL_PROTO_HDR_PPP,
1501         /* IPv4 and IPv6 Fragment header types are only associated to
1502          * VIRTCHNL_PROTO_HDR_IPV4 and VIRTCHNL_PROTO_HDR_IPV6 respectively,
1503          * cannot be used independently.
1504          */
1505         VIRTCHNL_PROTO_HDR_IPV4_FRAG,
1506         VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG,
1507 };
1508
1509 /* Protocol header field within a protocol header. */
1510 enum virtchnl_proto_hdr_field {
1511         /* ETHER */
1512         VIRTCHNL_PROTO_HDR_ETH_SRC =
1513                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ETH),
1514         VIRTCHNL_PROTO_HDR_ETH_DST,
1515         VIRTCHNL_PROTO_HDR_ETH_ETHERTYPE,
1516         /* S-VLAN */
1517         VIRTCHNL_PROTO_HDR_S_VLAN_ID =
1518                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_S_VLAN),
1519         /* C-VLAN */
1520         VIRTCHNL_PROTO_HDR_C_VLAN_ID =
1521                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_C_VLAN),
1522         /* IPV4 */
1523         VIRTCHNL_PROTO_HDR_IPV4_SRC =
1524                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4),
1525         VIRTCHNL_PROTO_HDR_IPV4_DST,
1526         VIRTCHNL_PROTO_HDR_IPV4_DSCP,
1527         VIRTCHNL_PROTO_HDR_IPV4_TTL,
1528         VIRTCHNL_PROTO_HDR_IPV4_PROT,
1529         /* IPV6 */
1530         VIRTCHNL_PROTO_HDR_IPV6_SRC =
1531                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6),
1532         VIRTCHNL_PROTO_HDR_IPV6_DST,
1533         VIRTCHNL_PROTO_HDR_IPV6_TC,
1534         VIRTCHNL_PROTO_HDR_IPV6_HOP_LIMIT,
1535         VIRTCHNL_PROTO_HDR_IPV6_PROT,
1536         /* IPV6 Prefix */
1537         VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_SRC,
1538         VIRTCHNL_PROTO_HDR_IPV6_PREFIX32_DST,
1539         VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_SRC,
1540         VIRTCHNL_PROTO_HDR_IPV6_PREFIX40_DST,
1541         VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_SRC,
1542         VIRTCHNL_PROTO_HDR_IPV6_PREFIX48_DST,
1543         VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_SRC,
1544         VIRTCHNL_PROTO_HDR_IPV6_PREFIX56_DST,
1545         VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_SRC,
1546         VIRTCHNL_PROTO_HDR_IPV6_PREFIX64_DST,
1547         VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_SRC,
1548         VIRTCHNL_PROTO_HDR_IPV6_PREFIX96_DST,
1549         /* TCP */
1550         VIRTCHNL_PROTO_HDR_TCP_SRC_PORT =
1551                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_TCP),
1552         VIRTCHNL_PROTO_HDR_TCP_DST_PORT,
1553         /* UDP */
1554         VIRTCHNL_PROTO_HDR_UDP_SRC_PORT =
1555                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_UDP),
1556         VIRTCHNL_PROTO_HDR_UDP_DST_PORT,
1557         /* SCTP */
1558         VIRTCHNL_PROTO_HDR_SCTP_SRC_PORT =
1559                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_SCTP),
1560         VIRTCHNL_PROTO_HDR_SCTP_DST_PORT,
1561         /* GTPU_IP */
1562         VIRTCHNL_PROTO_HDR_GTPU_IP_TEID =
1563                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_IP),
1564         /* GTPU_EH */
1565         VIRTCHNL_PROTO_HDR_GTPU_EH_PDU =
1566                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPU_EH),
1567         VIRTCHNL_PROTO_HDR_GTPU_EH_QFI,
1568         /* PPPOE */
1569         VIRTCHNL_PROTO_HDR_PPPOE_SESS_ID =
1570                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PPPOE),
1571         /* L2TPV3 */
1572         VIRTCHNL_PROTO_HDR_L2TPV3_SESS_ID =
1573                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_L2TPV3),
1574         /* ESP */
1575         VIRTCHNL_PROTO_HDR_ESP_SPI =
1576                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ESP),
1577         /* AH */
1578         VIRTCHNL_PROTO_HDR_AH_SPI =
1579                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_AH),
1580         /* PFCP */
1581         VIRTCHNL_PROTO_HDR_PFCP_S_FIELD =
1582                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_PFCP),
1583         VIRTCHNL_PROTO_HDR_PFCP_SEID,
1584         /* GTPC */
1585         VIRTCHNL_PROTO_HDR_GTPC_TEID =
1586                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_GTPC),
1587         /* ECPRI */
1588         VIRTCHNL_PROTO_HDR_ECPRI_MSG_TYPE =
1589                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_ECPRI),
1590         VIRTCHNL_PROTO_HDR_ECPRI_PC_RTC_ID,
1591         /* IPv4 Dummy Fragment */
1592         VIRTCHNL_PROTO_HDR_IPV4_FRAG_PKID =
1593                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV4_FRAG),
1594         /* IPv6 Extension Fragment */
1595         VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG_PKID =
1596                 PROTO_HDR_FIELD_START(VIRTCHNL_PROTO_HDR_IPV6_EH_FRAG),
1597 };
1598
1599 struct virtchnl_proto_hdr {
1600         /* see enum virtchnl_proto_hdr_type */
1601         s32 type;
1602         u32 field_selector; /* a bit mask to select field for header type */
1603         u8 buffer[64];
1604         /**
1605          * binary buffer in network order for specific header type.
1606          * For example, if type = VIRTCHNL_PROTO_HDR_IPV4, a IPv4
1607          * header is expected to be copied into the buffer.
1608          */
1609 };
1610
1611 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_proto_hdr);
1612
1613 struct virtchnl_proto_hdrs {
1614         u8 tunnel_level;
1615         /**
1616          * specify where protocol header start from.
1617          * 0 - from the outer layer
1618          * 1 - from the first inner layer
1619          * 2 - from the second inner layer
1620          * ....
1621          **/
1622         int count; /* the proto layers must < VIRTCHNL_MAX_NUM_PROTO_HDRS */
1623         struct virtchnl_proto_hdr proto_hdr[VIRTCHNL_MAX_NUM_PROTO_HDRS];
1624 };
1625
1626 VIRTCHNL_CHECK_STRUCT_LEN(2312, virtchnl_proto_hdrs);
1627
1628 struct virtchnl_rss_cfg {
1629         struct virtchnl_proto_hdrs proto_hdrs;     /* protocol headers */
1630
1631         /* see enum virtchnl_rss_algorithm; rss algorithm type */
1632         s32 rss_algorithm;
1633         u8 reserved[128];                          /* reserve for future */
1634 };
1635
1636 VIRTCHNL_CHECK_STRUCT_LEN(2444, virtchnl_rss_cfg);
1637
1638 /* action configuration for FDIR */
1639 struct virtchnl_filter_action {
1640         /* see enum virtchnl_action type */
1641         s32 type;
1642         union {
1643                 /* used for queue and qgroup action */
1644                 struct {
1645                         u16 index;
1646                         u8 region;
1647                 } queue;
1648                 /* used for count action */
1649                 struct {
1650                         /* share counter ID with other flow rules */
1651                         u8 shared;
1652                         u32 id; /* counter ID */
1653                 } count;
1654                 /* used for mark action */
1655                 u32 mark_id;
1656                 u8 reserve[32];
1657         } act_conf;
1658 };
1659
1660 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_filter_action);
1661
1662 #define VIRTCHNL_MAX_NUM_ACTIONS  8
1663
1664 struct virtchnl_filter_action_set {
1665         /* action number must be less then VIRTCHNL_MAX_NUM_ACTIONS */
1666         int count;
1667         struct virtchnl_filter_action actions[VIRTCHNL_MAX_NUM_ACTIONS];
1668 };
1669
1670 VIRTCHNL_CHECK_STRUCT_LEN(292, virtchnl_filter_action_set);
1671
1672 /* pattern and action for FDIR rule */
1673 struct virtchnl_fdir_rule {
1674         struct virtchnl_proto_hdrs proto_hdrs;
1675         struct virtchnl_filter_action_set action_set;
1676 };
1677
1678 VIRTCHNL_CHECK_STRUCT_LEN(2604, virtchnl_fdir_rule);
1679
1680 /* query information to retrieve fdir rule counters.
1681  * PF will fill out this structure to reset counter.
1682  */
1683 struct virtchnl_fdir_query_info {
1684         u32 match_packets_valid:1;
1685         u32 match_bytes_valid:1;
1686         u32 reserved:30;  /* Reserved, must be zero. */
1687         u32 pad;
1688         u64 matched_packets; /* Number of packets for this rule. */
1689         u64 matched_bytes;   /* Number of bytes through this rule. */
1690 };
1691
1692 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_fdir_query_info);
1693
1694 /* Status returned to VF after VF requests FDIR commands
1695  * VIRTCHNL_FDIR_SUCCESS
1696  * VF FDIR related request is successfully done by PF
1697  * The request can be OP_ADD/DEL/QUERY_FDIR_FILTER.
1698  *
1699  * VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE
1700  * OP_ADD_FDIR_FILTER request is failed due to no Hardware resource.
1701  *
1702  * VIRTCHNL_FDIR_FAILURE_RULE_EXIST
1703  * OP_ADD_FDIR_FILTER request is failed due to the rule is already existed.
1704  *
1705  * VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT
1706  * OP_ADD_FDIR_FILTER request is failed due to conflict with existing rule.
1707  *
1708  * VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST
1709  * OP_DEL_FDIR_FILTER request is failed due to this rule doesn't exist.
1710  *
1711  * VIRTCHNL_FDIR_FAILURE_RULE_INVALID
1712  * OP_ADD_FDIR_FILTER request is failed due to parameters validation
1713  * or HW doesn't support.
1714  *
1715  * VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT
1716  * OP_ADD/DEL_FDIR_FILTER request is failed due to timing out
1717  * for programming.
1718  *
1719  * VIRTCHNL_FDIR_FAILURE_QUERY_INVALID
1720  * OP_QUERY_FDIR_FILTER request is failed due to parameters validation,
1721  * for example, VF query counter of a rule who has no counter action.
1722  */
1723 enum virtchnl_fdir_prgm_status {
1724         VIRTCHNL_FDIR_SUCCESS = 0,
1725         VIRTCHNL_FDIR_FAILURE_RULE_NORESOURCE,
1726         VIRTCHNL_FDIR_FAILURE_RULE_EXIST,
1727         VIRTCHNL_FDIR_FAILURE_RULE_CONFLICT,
1728         VIRTCHNL_FDIR_FAILURE_RULE_NONEXIST,
1729         VIRTCHNL_FDIR_FAILURE_RULE_INVALID,
1730         VIRTCHNL_FDIR_FAILURE_RULE_TIMEOUT,
1731         VIRTCHNL_FDIR_FAILURE_QUERY_INVALID,
1732 };
1733
1734 /* VIRTCHNL_OP_ADD_FDIR_FILTER
1735  * VF sends this request to PF by filling out vsi_id,
1736  * validate_only and rule_cfg. PF will return flow_id
1737  * if the request is successfully done and return add_status to VF.
1738  */
1739 struct virtchnl_fdir_add {
1740         u16 vsi_id;  /* INPUT */
1741         /*
1742          * 1 for validating a fdir rule, 0 for creating a fdir rule.
1743          * Validate and create share one ops: VIRTCHNL_OP_ADD_FDIR_FILTER.
1744          */
1745         u16 validate_only; /* INPUT */
1746         u32 flow_id;       /* OUTPUT */
1747         struct virtchnl_fdir_rule rule_cfg; /* INPUT */
1748
1749         /* see enum virtchnl_fdir_prgm_status; OUTPUT */
1750         s32 status;
1751 };
1752
1753 VIRTCHNL_CHECK_STRUCT_LEN(2616, virtchnl_fdir_add);
1754
1755 /* VIRTCHNL_OP_DEL_FDIR_FILTER
1756  * VF sends this request to PF by filling out vsi_id
1757  * and flow_id. PF will return del_status to VF.
1758  */
1759 struct virtchnl_fdir_del {
1760         u16 vsi_id;  /* INPUT */
1761         u16 pad;
1762         u32 flow_id; /* INPUT */
1763
1764         /* see enum virtchnl_fdir_prgm_status; OUTPUT */
1765         s32 status;
1766 };
1767
1768 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_fdir_del);
1769
1770 /* VIRTCHNL_OP_QUERY_FDIR_FILTER
1771  * VF sends this request to PF by filling out vsi_id,
1772  * flow_id and reset_counter. PF will return query_info
1773  * and query_status to VF.
1774  */
1775 struct virtchnl_fdir_query {
1776         u16 vsi_id;   /* INPUT */
1777         u16 pad1[3];
1778         u32 flow_id;  /* INPUT */
1779         u32 reset_counter:1; /* INPUT */
1780         struct virtchnl_fdir_query_info query_info; /* OUTPUT */
1781
1782         /* see enum virtchnl_fdir_prgm_status; OUTPUT */
1783         s32 status;
1784         u32 pad2;
1785 };
1786
1787 VIRTCHNL_CHECK_STRUCT_LEN(48, virtchnl_fdir_query);
1788
1789 /* TX and RX queue types are valid in legacy as well as split queue models.
1790  * With Split Queue model, 2 additional types are introduced - TX_COMPLETION
1791  * and RX_BUFFER. In split queue model, RX corresponds to the queue where HW
1792  * posts completions.
1793  */
1794 enum virtchnl_queue_type {
1795         VIRTCHNL_QUEUE_TYPE_TX                  = 0,
1796         VIRTCHNL_QUEUE_TYPE_RX                  = 1,
1797         VIRTCHNL_QUEUE_TYPE_TX_COMPLETION       = 2,
1798         VIRTCHNL_QUEUE_TYPE_RX_BUFFER           = 3,
1799         VIRTCHNL_QUEUE_TYPE_CONFIG_TX           = 4,
1800         VIRTCHNL_QUEUE_TYPE_CONFIG_RX           = 5
1801 };
1802
1803
1804 /* structure to specify a chunk of contiguous queues */
1805 struct virtchnl_queue_chunk {
1806         /* see enum virtchnl_queue_type */
1807         s32 type;
1808         u16 start_queue_id;
1809         u16 num_queues;
1810 };
1811
1812 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_queue_chunk);
1813
1814 /* structure to specify several chunks of contiguous queues */
1815 struct virtchnl_queue_chunks {
1816         u16 num_chunks;
1817         u16 rsvd;
1818         struct virtchnl_queue_chunk chunks[1];
1819 };
1820
1821 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_chunks);
1822
1823
1824 /* VIRTCHNL_OP_ENABLE_QUEUES_V2
1825  * VIRTCHNL_OP_DISABLE_QUEUES_V2
1826  * VIRTCHNL_OP_DEL_QUEUES
1827  *
1828  * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1829  * then all of these ops are available.
1830  *
1831  * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1832  * then VIRTCHNL_OP_ENABLE_QUEUES_V2 and VIRTCHNL_OP_DISABLE_QUEUES_V2 are
1833  * available.
1834  *
1835  * PF sends these messages to enable, disable or delete queues specified in
1836  * chunks. PF sends virtchnl_del_ena_dis_queues struct to specify the queues
1837  * to be enabled/disabled/deleted. Also applicable to single queue RX or
1838  * TX. CP performs requested action and returns status.
1839  */
1840 struct virtchnl_del_ena_dis_queues {
1841         u16 vport_id;
1842         u16 pad;
1843         struct virtchnl_queue_chunks chunks;
1844 };
1845
1846 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_del_ena_dis_queues);
1847
1848 /* Virtchannel interrupt throttling rate index */
1849 enum virtchnl_itr_idx {
1850         VIRTCHNL_ITR_IDX_0      = 0,
1851         VIRTCHNL_ITR_IDX_1      = 1,
1852         VIRTCHNL_ITR_IDX_NO_ITR = 3,
1853 };
1854
1855 /* Queue to vector mapping */
1856 struct virtchnl_queue_vector {
1857         u16 queue_id;
1858         u16 vector_id;
1859         u8 pad[4];
1860
1861         /* see enum virtchnl_itr_idx */
1862         s32 itr_idx;
1863
1864         /* see enum virtchnl_queue_type */
1865         s32 queue_type;
1866 };
1867
1868 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_queue_vector);
1869
1870 /* VIRTCHNL_OP_MAP_QUEUE_VECTOR
1871  * VIRTCHNL_OP_UNMAP_QUEUE_VECTOR
1872  *
1873  * If VIRTCHNL_CAP_EXT_FEATURES was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1874  * then all of these ops are available.
1875  *
1876  * If VIRTCHNL_VF_LARGE_NUM_QPAIRS was negotiated in VIRTCHNL_OP_GET_VF_RESOURCES
1877  * then only VIRTCHNL_OP_MAP_QUEUE_VECTOR is available.
1878  *
1879  * PF sends this message to map or unmap queues to vectors and ITR index
1880  * registers. External data buffer contains virtchnl_queue_vector_maps structure
1881  * that contains num_qv_maps of virtchnl_queue_vector structures.
1882  * CP maps the requested queue vector maps after validating the queue and vector
1883  * ids and returns a status code.
1884  */
1885 struct virtchnl_queue_vector_maps {
1886         u16 vport_id;
1887         u16 num_qv_maps;
1888         u8 pad[4];
1889         struct virtchnl_queue_vector qv_maps[1];
1890 };
1891
1892 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_queue_vector_maps);
1893
1894
1895 /* Since VF messages are limited by u16 size, precalculate the maximum possible
1896  * values of nested elements in virtchnl structures that virtual channel can
1897  * possibly handle in a single message.
1898  */
1899 enum virtchnl_vector_limits {
1900         VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX       =
1901                 ((u16)(~0) - sizeof(struct virtchnl_vsi_queue_config_info)) /
1902                 sizeof(struct virtchnl_queue_pair_info),
1903
1904         VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX          =
1905                 ((u16)(~0) - sizeof(struct virtchnl_irq_map_info)) /
1906                 sizeof(struct virtchnl_vector_map),
1907
1908         VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX        =
1909                 ((u16)(~0) - sizeof(struct virtchnl_ether_addr_list)) /
1910                 sizeof(struct virtchnl_ether_addr),
1911
1912         VIRTCHNL_OP_ADD_DEL_VLAN_MAX            =
1913                 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list)) /
1914                 sizeof(u16),
1915
1916
1917         VIRTCHNL_OP_ENABLE_CHANNELS_MAX         =
1918                 ((u16)(~0) - sizeof(struct virtchnl_tc_info)) /
1919                 sizeof(struct virtchnl_channel_info),
1920
1921         VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX    =
1922                 ((u16)(~0) - sizeof(struct virtchnl_del_ena_dis_queues)) /
1923                 sizeof(struct virtchnl_queue_chunk),
1924
1925         VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX  =
1926                 ((u16)(~0) - sizeof(struct virtchnl_queue_vector_maps)) /
1927                 sizeof(struct virtchnl_queue_vector),
1928
1929         VIRTCHNL_OP_ADD_DEL_VLAN_V2_MAX         =
1930                 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list_v2)) /
1931                 sizeof(struct virtchnl_vlan_filter),
1932 };
1933
1934 /**
1935  * virtchnl_vc_validate_vf_msg
1936  * @ver: Virtchnl version info
1937  * @v_opcode: Opcode for the message
1938  * @msg: pointer to the msg buffer
1939  * @msglen: msg length
1940  *
1941  * validate msg format against struct for each opcode
1942  */
1943 static inline int
1944 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode,
1945                             u8 *msg, u16 msglen)
1946 {
1947         bool err_msg_format = false;
1948         u32 valid_len = 0;
1949
1950         /* Validate message length. */
1951         switch (v_opcode) {
1952         case VIRTCHNL_OP_VERSION:
1953                 valid_len = sizeof(struct virtchnl_version_info);
1954                 break;
1955         case VIRTCHNL_OP_RESET_VF:
1956                 break;
1957         case VIRTCHNL_OP_GET_VF_RESOURCES:
1958                 if (VF_IS_V11(ver))
1959                         valid_len = sizeof(u32);
1960                 break;
1961         case VIRTCHNL_OP_CONFIG_TX_QUEUE:
1962                 valid_len = sizeof(struct virtchnl_txq_info);
1963                 break;
1964         case VIRTCHNL_OP_CONFIG_RX_QUEUE:
1965                 valid_len = sizeof(struct virtchnl_rxq_info);
1966                 break;
1967         case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
1968                 valid_len = sizeof(struct virtchnl_vsi_queue_config_info);
1969                 if (msglen >= valid_len) {
1970                         struct virtchnl_vsi_queue_config_info *vqc =
1971                             (struct virtchnl_vsi_queue_config_info *)msg;
1972
1973                         if (vqc->num_queue_pairs == 0 || vqc->num_queue_pairs >
1974                             VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX) {
1975                                 err_msg_format = true;
1976                                 break;
1977                         }
1978
1979                         valid_len += (vqc->num_queue_pairs *
1980                                       sizeof(struct
1981                                              virtchnl_queue_pair_info));
1982                 }
1983                 break;
1984         case VIRTCHNL_OP_CONFIG_IRQ_MAP:
1985                 valid_len = sizeof(struct virtchnl_irq_map_info);
1986                 if (msglen >= valid_len) {
1987                         struct virtchnl_irq_map_info *vimi =
1988                             (struct virtchnl_irq_map_info *)msg;
1989
1990                         if (vimi->num_vectors == 0 || vimi->num_vectors >
1991                             VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX) {
1992                                 err_msg_format = true;
1993                                 break;
1994                         }
1995
1996                         valid_len += (vimi->num_vectors *
1997                                       sizeof(struct virtchnl_vector_map));
1998                 }
1999                 break;
2000         case VIRTCHNL_OP_ENABLE_QUEUES:
2001         case VIRTCHNL_OP_DISABLE_QUEUES:
2002                 valid_len = sizeof(struct virtchnl_queue_select);
2003                 break;
2004         case VIRTCHNL_OP_GET_MAX_RSS_QREGION:
2005                 break;
2006         case VIRTCHNL_OP_ADD_ETH_ADDR:
2007         case VIRTCHNL_OP_DEL_ETH_ADDR:
2008                 valid_len = sizeof(struct virtchnl_ether_addr_list);
2009                 if (msglen >= valid_len) {
2010                         struct virtchnl_ether_addr_list *veal =
2011                             (struct virtchnl_ether_addr_list *)msg;
2012
2013                         if (veal->num_elements == 0 || veal->num_elements >
2014                             VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX) {
2015                                 err_msg_format = true;
2016                                 break;
2017                         }
2018
2019                         valid_len += veal->num_elements *
2020                             sizeof(struct virtchnl_ether_addr);
2021                 }
2022                 break;
2023         case VIRTCHNL_OP_ADD_VLAN:
2024         case VIRTCHNL_OP_DEL_VLAN:
2025                 valid_len = sizeof(struct virtchnl_vlan_filter_list);
2026                 if (msglen >= valid_len) {
2027                         struct virtchnl_vlan_filter_list *vfl =
2028                             (struct virtchnl_vlan_filter_list *)msg;
2029
2030                         if (vfl->num_elements == 0 || vfl->num_elements >
2031                             VIRTCHNL_OP_ADD_DEL_VLAN_MAX) {
2032                                 err_msg_format = true;
2033                                 break;
2034                         }
2035
2036                         valid_len += vfl->num_elements * sizeof(u16);
2037                 }
2038                 break;
2039         case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
2040                 valid_len = sizeof(struct virtchnl_promisc_info);
2041                 break;
2042         case VIRTCHNL_OP_GET_STATS:
2043                 valid_len = sizeof(struct virtchnl_queue_select);
2044                 break;
2045         case VIRTCHNL_OP_CONFIG_RSS_KEY:
2046                 valid_len = sizeof(struct virtchnl_rss_key);
2047                 if (msglen >= valid_len) {
2048                         struct virtchnl_rss_key *vrk =
2049                                 (struct virtchnl_rss_key *)msg;
2050
2051                         if (vrk->key_len == 0) {
2052                                 /* zero length is allowed as input */
2053                                 break;
2054                         }
2055
2056                         valid_len += vrk->key_len - 1;
2057                 }
2058                 break;
2059         case VIRTCHNL_OP_CONFIG_RSS_LUT:
2060                 valid_len = sizeof(struct virtchnl_rss_lut);
2061                 if (msglen >= valid_len) {
2062                         struct virtchnl_rss_lut *vrl =
2063                                 (struct virtchnl_rss_lut *)msg;
2064
2065                         if (vrl->lut_entries == 0) {
2066                                 /* zero entries is allowed as input */
2067                                 break;
2068                         }
2069
2070                         valid_len += vrl->lut_entries - 1;
2071                 }
2072                 break;
2073         case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
2074                 break;
2075         case VIRTCHNL_OP_SET_RSS_HENA:
2076                 valid_len = sizeof(struct virtchnl_rss_hena);
2077                 break;
2078         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
2079         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
2080                 break;
2081         case VIRTCHNL_OP_REQUEST_QUEUES:
2082                 valid_len = sizeof(struct virtchnl_vf_res_request);
2083                 break;
2084         case VIRTCHNL_OP_ENABLE_CHANNELS:
2085                 valid_len = sizeof(struct virtchnl_tc_info);
2086                 if (msglen >= valid_len) {
2087                         struct virtchnl_tc_info *vti =
2088                                 (struct virtchnl_tc_info *)msg;
2089
2090                         if (vti->num_tc == 0 || vti->num_tc >
2091                             VIRTCHNL_OP_ENABLE_CHANNELS_MAX) {
2092                                 err_msg_format = true;
2093                                 break;
2094                         }
2095
2096                         valid_len += (vti->num_tc - 1) *
2097                                      sizeof(struct virtchnl_channel_info);
2098                 }
2099                 break;
2100         case VIRTCHNL_OP_DISABLE_CHANNELS:
2101                 break;
2102         case VIRTCHNL_OP_ADD_CLOUD_FILTER:
2103         case VIRTCHNL_OP_DEL_CLOUD_FILTER:
2104                 valid_len = sizeof(struct virtchnl_filter);
2105                 break;
2106         case VIRTCHNL_OP_DCF_VLAN_OFFLOAD:
2107                 valid_len = sizeof(struct virtchnl_dcf_vlan_offload);
2108                 break;
2109         case VIRTCHNL_OP_DCF_CMD_DESC:
2110         case VIRTCHNL_OP_DCF_CMD_BUFF:
2111                 /* These two opcodes are specific to handle the AdminQ command,
2112                  * so the validation needs to be done in PF's context.
2113                  */
2114                 valid_len = msglen;
2115                 break;
2116         case VIRTCHNL_OP_DCF_DISABLE:
2117         case VIRTCHNL_OP_DCF_GET_VSI_MAP:
2118         case VIRTCHNL_OP_DCF_GET_PKG_INFO:
2119                 break;
2120         case VIRTCHNL_OP_GET_SUPPORTED_RXDIDS:
2121                 break;
2122         case VIRTCHNL_OP_ADD_RSS_CFG:
2123         case VIRTCHNL_OP_DEL_RSS_CFG:
2124                 valid_len = sizeof(struct virtchnl_rss_cfg);
2125                 break;
2126         case VIRTCHNL_OP_ADD_FDIR_FILTER:
2127                 valid_len = sizeof(struct virtchnl_fdir_add);
2128                 break;
2129         case VIRTCHNL_OP_DEL_FDIR_FILTER:
2130                 valid_len = sizeof(struct virtchnl_fdir_del);
2131                 break;
2132         case VIRTCHNL_OP_QUERY_FDIR_FILTER:
2133                 valid_len = sizeof(struct virtchnl_fdir_query);
2134                 break;
2135         case VIRTCHNL_OP_GET_OFFLOAD_VLAN_V2_CAPS:
2136                 break;
2137         case VIRTCHNL_OP_ADD_VLAN_V2:
2138         case VIRTCHNL_OP_DEL_VLAN_V2:
2139                 valid_len = sizeof(struct virtchnl_vlan_filter_list_v2);
2140                 if (msglen >= valid_len) {
2141                         struct virtchnl_vlan_filter_list_v2 *vfl =
2142                             (struct virtchnl_vlan_filter_list_v2 *)msg;
2143
2144                         if (vfl->num_elements == 0 || vfl->num_elements >
2145                             VIRTCHNL_OP_ADD_DEL_VLAN_V2_MAX) {
2146                                 err_msg_format = true;
2147                                 break;
2148                         }
2149
2150                         valid_len += (vfl->num_elements - 1) *
2151                                 sizeof(struct virtchnl_vlan_filter);
2152                 }
2153                 break;
2154         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING_V2:
2155         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING_V2:
2156         case VIRTCHNL_OP_ENABLE_VLAN_INSERTION_V2:
2157         case VIRTCHNL_OP_DISABLE_VLAN_INSERTION_V2:
2158         case VIRTCHNL_OP_ENABLE_VLAN_FILTERING_V2:
2159         case VIRTCHNL_OP_DISABLE_VLAN_FILTERING_V2:
2160                 valid_len = sizeof(struct virtchnl_vlan_setting);
2161                 break;
2162         case VIRTCHNL_OP_ENABLE_QUEUES_V2:
2163         case VIRTCHNL_OP_DISABLE_QUEUES_V2:
2164                 valid_len = sizeof(struct virtchnl_del_ena_dis_queues);
2165                 if (msglen >= valid_len) {
2166                         struct virtchnl_del_ena_dis_queues *qs =
2167                                 (struct virtchnl_del_ena_dis_queues *)msg;
2168                         if (qs->chunks.num_chunks == 0 ||
2169                             qs->chunks.num_chunks > VIRTCHNL_OP_ENABLE_DISABLE_DEL_QUEUES_V2_MAX) {
2170                                 err_msg_format = true;
2171                                 break;
2172                         }
2173                         valid_len += (qs->chunks.num_chunks - 1) *
2174                                       sizeof(struct virtchnl_queue_chunk);
2175                 }
2176                 break;
2177         case VIRTCHNL_OP_MAP_QUEUE_VECTOR:
2178                 valid_len = sizeof(struct virtchnl_queue_vector_maps);
2179                 if (msglen >= valid_len) {
2180                         struct virtchnl_queue_vector_maps *v_qp =
2181                                 (struct virtchnl_queue_vector_maps *)msg;
2182                         if (v_qp->num_qv_maps == 0 ||
2183                             v_qp->num_qv_maps > VIRTCHNL_OP_MAP_UNMAP_QUEUE_VECTOR_MAX) {
2184                                 err_msg_format = true;
2185                                 break;
2186                         }
2187                         valid_len += (v_qp->num_qv_maps - 1) *
2188                                       sizeof(struct virtchnl_queue_vector);
2189                 }
2190                 break;
2191         /* These are always errors coming from the VF. */
2192         case VIRTCHNL_OP_EVENT:
2193         case VIRTCHNL_OP_UNKNOWN:
2194         default:
2195                 return VIRTCHNL_STATUS_ERR_PARAM;
2196         }
2197         /* few more checks */
2198         if (err_msg_format || valid_len != msglen)
2199                 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH;
2200
2201         return 0;
2202 }
2203 #endif /* _VIRTCHNL_H_ */