drivers/common/iavf/virtchnl.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright(c) 2001-2020
   3  */
   4
   5 #ifndef _VIRTCHNL_H_
   6 #define _VIRTCHNL_H_
   7
   8 /* Description:
   9  * This header file describes the VF-PF communication protocol used
  10  * by the drivers for all devices starting from our 40G product line
  11  *
  12  * Admin queue buffer usage:
  13  * desc->opcode is always aqc_opc_send_msg_to_pf
  14  * flags, retval, datalen, and data addr are all used normally.
  15  * The Firmware copies the cookie fields when sending messages between the
  16  * PF and VF, but uses all other fields internally. Due to this limitation,
  17  * we must send all messages as "indirect", i.e. using an external buffer.
  18  *
  19  * All the VSI indexes are relative to the VF. Each VF can have maximum of
  20  * three VSIs. All the queue indexes are relative to the VSI.  Each VF can
  21  * have a maximum of sixteen queues for all of its VSIs.
  22  *
  23  * The PF is required to return a status code in v_retval for all messages
  24  * except RESET_VF, which does not require any response. The return value
  25  * is of status_code type, defined in the shared type.h.
  26  *
  27  * In general, VF driver initialization should roughly follow the order of
  28  * these opcodes. The VF driver must first validate the API version of the
  29  * PF driver, then request a reset, then get resources, then configure
  30  * queues and interrupts. After these operations are complete, the VF
  31  * driver may start its queues, optionally add MAC and VLAN filters, and
  32  * process traffic.
  33  */
  34
  35 /* START GENERIC DEFINES
  36  * Need to ensure the following enums and defines hold the same meaning and
  37  * value in current and future projects
  38  */
  39
  40 /* Error Codes */
  41 enum virtchnl_status_code {
  42         VIRTCHNL_STATUS_SUCCESS                         = 0,
  43         VIRTCHNL_STATUS_ERR_PARAM                       = -5,
  44         VIRTCHNL_STATUS_ERR_NO_MEMORY                   = -18,
  45         VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH             = -38,
  46         VIRTCHNL_STATUS_ERR_CQP_COMPL_ERROR             = -39,
  47         VIRTCHNL_STATUS_ERR_INVALID_VF_ID               = -40,
  48         VIRTCHNL_STATUS_ERR_ADMIN_QUEUE_ERROR           = -53,
  49         VIRTCHNL_STATUS_ERR_NOT_SUPPORTED               = -64,
  50 };
  51
  52 /* Backward compatibility */
  53 #define VIRTCHNL_ERR_PARAM VIRTCHNL_STATUS_ERR_PARAM
  54 #define VIRTCHNL_STATUS_NOT_SUPPORTED VIRTCHNL_STATUS_ERR_NOT_SUPPORTED
  55
  56 #define VIRTCHNL_LINK_SPEED_2_5GB_SHIFT         0x0
  57 #define VIRTCHNL_LINK_SPEED_100MB_SHIFT         0x1
  58 #define VIRTCHNL_LINK_SPEED_1000MB_SHIFT        0x2
  59 #define VIRTCHNL_LINK_SPEED_10GB_SHIFT          0x3
  60 #define VIRTCHNL_LINK_SPEED_40GB_SHIFT          0x4
  61 #define VIRTCHNL_LINK_SPEED_20GB_SHIFT          0x5
  62 #define VIRTCHNL_LINK_SPEED_25GB_SHIFT          0x6
  63 #define VIRTCHNL_LINK_SPEED_5GB_SHIFT           0x7
  64
  65 enum virtchnl_link_speed {
  66         VIRTCHNL_LINK_SPEED_UNKNOWN     = 0,
  67         VIRTCHNL_LINK_SPEED_100MB       = BIT(VIRTCHNL_LINK_SPEED_100MB_SHIFT),
  68         VIRTCHNL_LINK_SPEED_1GB         = BIT(VIRTCHNL_LINK_SPEED_1000MB_SHIFT),
  69         VIRTCHNL_LINK_SPEED_10GB        = BIT(VIRTCHNL_LINK_SPEED_10GB_SHIFT),
  70         VIRTCHNL_LINK_SPEED_40GB        = BIT(VIRTCHNL_LINK_SPEED_40GB_SHIFT),
  71         VIRTCHNL_LINK_SPEED_20GB        = BIT(VIRTCHNL_LINK_SPEED_20GB_SHIFT),
  72         VIRTCHNL_LINK_SPEED_25GB        = BIT(VIRTCHNL_LINK_SPEED_25GB_SHIFT),
  73         VIRTCHNL_LINK_SPEED_2_5GB       = BIT(VIRTCHNL_LINK_SPEED_2_5GB_SHIFT),
  74         VIRTCHNL_LINK_SPEED_5GB         = BIT(VIRTCHNL_LINK_SPEED_5GB_SHIFT),
  75 };
  76
  77 /* for hsplit_0 field of Rx HMC context */
  78 /* deprecated with IAVF 1.0 */
  79 enum virtchnl_rx_hsplit {
  80         VIRTCHNL_RX_HSPLIT_NO_SPLIT      = 0,
  81         VIRTCHNL_RX_HSPLIT_SPLIT_L2      = 1,
  82         VIRTCHNL_RX_HSPLIT_SPLIT_IP      = 2,
  83         VIRTCHNL_RX_HSPLIT_SPLIT_TCP_UDP = 4,
  84         VIRTCHNL_RX_HSPLIT_SPLIT_SCTP    = 8,
  85 };
  86
  87 #define VIRTCHNL_ETH_LENGTH_OF_ADDRESS  6
  88 /* END GENERIC DEFINES */
  89
  90 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
  91  * of the virtchnl_msg structure.
  92  */
  93 enum virtchnl_ops {
  94 /* The PF sends status change events to VFs using
  95  * the VIRTCHNL_OP_EVENT opcode.
  96  * VFs send requests to the PF using the other ops.
  97  * Use of "advanced opcode" features must be negotiated as part of capabilities
  98  * exchange and are not considered part of base mode feature set.
  99  */
 100         VIRTCHNL_OP_UNKNOWN = 0,
 101         VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
 102         VIRTCHNL_OP_RESET_VF = 2,
 103         VIRTCHNL_OP_GET_VF_RESOURCES = 3,
 104         VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
 105         VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
 106         VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
 107         VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
 108         VIRTCHNL_OP_ENABLE_QUEUES = 8,
 109         VIRTCHNL_OP_DISABLE_QUEUES = 9,
 110         VIRTCHNL_OP_ADD_ETH_ADDR = 10,
 111         VIRTCHNL_OP_DEL_ETH_ADDR = 11,
 112         VIRTCHNL_OP_ADD_VLAN = 12,
 113         VIRTCHNL_OP_DEL_VLAN = 13,
 114         VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
 115         VIRTCHNL_OP_GET_STATS = 15,
 116         VIRTCHNL_OP_RSVD = 16,
 117         VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */
 118         /* opcode 19 is reserved */
 119         /* opcodes 20, 21, and 22 are reserved */
 120         VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
 121         VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
 122         VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
 123         VIRTCHNL_OP_SET_RSS_HENA = 26,
 124         VIRTCHNL_OP_ENABLE_VLAN_STRIPPING = 27,
 125         VIRTCHNL_OP_DISABLE_VLAN_STRIPPING = 28,
 126         VIRTCHNL_OP_REQUEST_QUEUES = 29,
 127         VIRTCHNL_OP_ENABLE_CHANNELS = 30,
 128         VIRTCHNL_OP_DISABLE_CHANNELS = 31,
 129         VIRTCHNL_OP_ADD_CLOUD_FILTER = 32,
 130         VIRTCHNL_OP_DEL_CLOUD_FILTER = 33,
 131         /* opcodes 34, 35, 36, 37 and 38 are reserved */
 132         VIRTCHNL_OP_DCF_CMD_DESC = 39,
 133         VIRTCHNL_OP_DCF_CMD_BUFF = 40,
 134         VIRTCHNL_OP_DCF_DISABLE = 41,
 135 };
 136
 137 /* These macros are used to generate compilation errors if a structure/union
 138  * is not exactly the correct length. It gives a divide by zero error if the
 139  * structure/union is not of the correct size, otherwise it creates an enum
 140  * that is never used.
 141  */
 142 #define VIRTCHNL_CHECK_STRUCT_LEN(n, X) enum virtchnl_static_assert_enum_##X \
 143         { virtchnl_static_assert_##X = (n)/((sizeof(struct X) == (n)) ? 1 : 0) }
 144 #define VIRTCHNL_CHECK_UNION_LEN(n, X) enum virtchnl_static_asset_enum_##X \
 145         { virtchnl_static_assert_##X = (n)/((sizeof(union X) == (n)) ? 1 : 0) }
 146
 147 /* Virtual channel message descriptor. This overlays the admin queue
 148  * descriptor. All other data is passed in external buffers.
 149  */
 150
 151 struct virtchnl_msg {
 152         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
 153         enum virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
 154         enum virtchnl_status_code v_retval;  /* ditto for desc->retval */
 155         u32 vfid;                        /* used by PF when sending to VF */
 156 };
 157
 158 VIRTCHNL_CHECK_STRUCT_LEN(20, virtchnl_msg);
 159
 160 /* Message descriptions and data structures. */
 161
 162 /* VIRTCHNL_OP_VERSION
 163  * VF posts its version number to the PF. PF responds with its version number
 164  * in the same format, along with a return code.
 165  * Reply from PF has its major/minor versions also in param0 and param1.
 166  * If there is a major version mismatch, then the VF cannot operate.
 167  * If there is a minor version mismatch, then the VF can operate but should
 168  * add a warning to the system log.
 169  *
 170  * This enum element MUST always be specified as == 1, regardless of other
 171  * changes in the API. The PF must always respond to this message without
 172  * error regardless of version mismatch.
 173  */
 174 #define VIRTCHNL_VERSION_MAJOR          1
 175 #define VIRTCHNL_VERSION_MINOR          1
 176 #define VIRTCHNL_VERSION_MINOR_NO_VF_CAPS       0
 177
 178 struct virtchnl_version_info {
 179         u32 major;
 180         u32 minor;
 181 };
 182
 183 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_version_info);
 184
 185 #define VF_IS_V10(_v) (((_v)->major == 1) && ((_v)->minor == 0))
 186 #define VF_IS_V11(_ver) (((_ver)->major == 1) && ((_ver)->minor == 1))
 187
 188 /* VIRTCHNL_OP_RESET_VF
 189  * VF sends this request to PF with no parameters
 190  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
 191  * until reset completion is indicated. The admin queue must be reinitialized
 192  * after this operation.
 193  *
 194  * When reset is complete, PF must ensure that all queues in all VSIs associated
 195  * with the VF are stopped, all queue configurations in the HMC are set to 0,
 196  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
 197  * are cleared.
 198  */
 199
 200 /* VSI types that use VIRTCHNL interface for VF-PF communication. VSI_SRIOV
 201  * vsi_type should always be 6 for backward compatibility. Add other fields
 202  * as needed.
 203  */
 204 enum virtchnl_vsi_type {
 205         VIRTCHNL_VSI_TYPE_INVALID = 0,
 206         VIRTCHNL_VSI_SRIOV = 6,
 207 };
 208
 209 /* VIRTCHNL_OP_GET_VF_RESOURCES
 210  * Version 1.0 VF sends this request to PF with no parameters
 211  * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
 212  * PF responds with an indirect message containing
 213  * virtchnl_vf_resource and one or more
 214  * virtchnl_vsi_resource structures.
 215  */
 216
 217 struct virtchnl_vsi_resource {
 218         u16 vsi_id;
 219         u16 num_queue_pairs;
 220         enum virtchnl_vsi_type vsi_type;
 221         u16 qset_handle;
 222         u8 default_mac_addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
 223 };
 224
 225 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_vsi_resource);
 226
 227 /* VF capability flags
 228  * VIRTCHNL_VF_OFFLOAD_L2 flag is inclusive of base mode L2 offloads including
 229  * TX/RX Checksum offloading and TSO for non-tunnelled packets.
 230  */
 231 #define VIRTCHNL_VF_OFFLOAD_L2                  0x00000001
 232 #define VIRTCHNL_VF_OFFLOAD_IWARP               0x00000002
 233 #define VIRTCHNL_VF_OFFLOAD_RSVD                0x00000004
 234 #define VIRTCHNL_VF_OFFLOAD_RSS_AQ              0x00000008
 235 #define VIRTCHNL_VF_OFFLOAD_RSS_REG             0x00000010
 236 #define VIRTCHNL_VF_OFFLOAD_WB_ON_ITR           0x00000020
 237 #define VIRTCHNL_VF_OFFLOAD_REQ_QUEUES          0x00000040
 238 #define VIRTCHNL_VF_OFFLOAD_CRC                 0x00000080
 239 #define VIRTCHNL_VF_OFFLOAD_VLAN                0x00010000
 240 #define VIRTCHNL_VF_OFFLOAD_RX_POLLING          0x00020000
 241 #define VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2       0x00040000
 242 #define VIRTCHNL_VF_OFFLOAD_RSS_PF              0X00080000
 243 #define VIRTCHNL_VF_OFFLOAD_ENCAP               0X00100000
 244 #define VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM          0X00200000
 245 #define VIRTCHNL_VF_OFFLOAD_RX_ENCAP_CSUM       0X00400000
 246 #define VIRTCHNL_VF_OFFLOAD_ADQ                 0X00800000
 247 #define VIRTCHNL_VF_OFFLOAD_ADQ_V2              0X01000000
 248 #define VIRTCHNL_VF_OFFLOAD_USO                 0X02000000
 249 #define VIRTCHNL_VF_CAP_DCF                     0X40000000
 250         /* 0X80000000 is reserved */
 251
 252 /* Define below the capability flags that are not offloads */
 253 #define VIRTCHNL_VF_CAP_ADV_LINK_SPEED          0x00000080
 254 #define VF_BASE_MODE_OFFLOADS (VIRTCHNL_VF_OFFLOAD_L2 | \
 255                                VIRTCHNL_VF_OFFLOAD_VLAN | \
 256                                VIRTCHNL_VF_OFFLOAD_RSS_PF)
 257
 258 struct virtchnl_vf_resource {
 259         u16 num_vsis;
 260         u16 num_queue_pairs;
 261         u16 max_vectors;
 262         u16 max_mtu;
 263
 264         u32 vf_cap_flags;
 265         u32 rss_key_size;
 266         u32 rss_lut_size;
 267
 268         struct virtchnl_vsi_resource vsi_res[1];
 269 };
 270
 271 VIRTCHNL_CHECK_STRUCT_LEN(36, virtchnl_vf_resource);
 272
 273 /* VIRTCHNL_OP_CONFIG_TX_QUEUE
 274  * VF sends this message to set up parameters for one TX queue.
 275  * External data buffer contains one instance of virtchnl_txq_info.
 276  * PF configures requested queue and returns a status code.
 277  */
 278
 279 /* Tx queue config info */
 280 struct virtchnl_txq_info {
 281         u16 vsi_id;
 282         u16 queue_id;
 283         u16 ring_len;           /* number of descriptors, multiple of 8 */
 284         u16 headwb_enabled; /* deprecated with AVF 1.0 */
 285         u64 dma_ring_addr;
 286         u64 dma_headwb_addr; /* deprecated with AVF 1.0 */
 287 };
 288
 289 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_txq_info);
 290
 291 /* VIRTCHNL_OP_CONFIG_RX_QUEUE
 292  * VF sends this message to set up parameters for one RX queue.
 293  * External data buffer contains one instance of virtchnl_rxq_info.
 294  * PF configures requested queue and returns a status code. The
 295  * crc_disable flag disables CRC stripping on the VF. Setting
 296  * the crc_disable flag to 1 will disable CRC stripping for each
 297  * queue in the VF where the flag is set. The VIRTCHNL_VF_OFFLOAD_CRC
 298  * offload must have been set prior to sending this info or the PF
 299  * will ignore the request. This flag should be set the same for
 300  * all of the queues for a VF.
 301  */
 302
 303 /* Rx queue config info */
 304 struct virtchnl_rxq_info {
 305         u16 vsi_id;
 306         u16 queue_id;
 307         u32 ring_len;           /* number of descriptors, multiple of 32 */
 308         u16 hdr_size;
 309         u16 splithdr_enabled; /* deprecated with AVF 1.0 */
 310         u32 databuffer_size;
 311         u32 max_pkt_size;
 312         u8 crc_disable;
 313         u8 pad1[3];
 314         u64 dma_ring_addr;
 315         enum virtchnl_rx_hsplit rx_split_pos; /* deprecated with AVF 1.0 */
 316         u32 pad2;
 317 };
 318
 319 VIRTCHNL_CHECK_STRUCT_LEN(40, virtchnl_rxq_info);
 320
 321 /* VIRTCHNL_OP_CONFIG_VSI_QUEUES
 322  * VF sends this message to set parameters for active TX and RX queues
 323  * associated with the specified VSI.
 324  * PF configures queues and returns status.
 325  * If the number of queues specified is greater than the number of queues
 326  * associated with the VSI, an error is returned and no queues are configured.
 327  * NOTE: The VF is not required to configure all queues in a single request.
 328  * It may send multiple messages. PF drivers must correctly handle all VF
 329  * requests.
 330  */
 331 struct virtchnl_queue_pair_info {
 332         /* NOTE: vsi_id and queue_id should be identical for both queues. */
 333         struct virtchnl_txq_info txq;
 334         struct virtchnl_rxq_info rxq;
 335 };
 336
 337 VIRTCHNL_CHECK_STRUCT_LEN(64, virtchnl_queue_pair_info);
 338
 339 struct virtchnl_vsi_queue_config_info {
 340         u16 vsi_id;
 341         u16 num_queue_pairs;
 342         u32 pad;
 343         struct virtchnl_queue_pair_info qpair[1];
 344 };
 345
 346 VIRTCHNL_CHECK_STRUCT_LEN(72, virtchnl_vsi_queue_config_info);
 347
 348 /* VIRTCHNL_OP_REQUEST_QUEUES
 349  * VF sends this message to request the PF to allocate additional queues to
 350  * this VF.  Each VF gets a guaranteed number of queues on init but asking for
 351  * additional queues must be negotiated.  This is a best effort request as it
 352  * is possible the PF does not have enough queues left to support the request.
 353  * If the PF cannot support the number requested it will respond with the
 354  * maximum number it is able to support.  If the request is successful, PF will
 355  * then reset the VF to institute required changes.
 356  */
 357
 358 /* VF resource request */
 359 struct virtchnl_vf_res_request {
 360         u16 num_queue_pairs;
 361 };
 362
 363 /* VIRTCHNL_OP_CONFIG_IRQ_MAP
 364  * VF uses this message to map vectors to queues.
 365  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
 366  * are to be associated with the specified vector.
 367  * The "other" causes are always mapped to vector 0. The VF may not request
 368  * that vector 0 be used for traffic.
 369  * PF configures interrupt mapping and returns status.
 370  * NOTE: due to hardware requirements, all active queues (both TX and RX)
 371  * should be mapped to interrupts, even if the driver intends to operate
 372  * only in polling mode. In this case the interrupt may be disabled, but
 373  * the ITR timer will still run to trigger writebacks.
 374  */
 375 struct virtchnl_vector_map {
 376         u16 vsi_id;
 377         u16 vector_id;
 378         u16 rxq_map;
 379         u16 txq_map;
 380         u16 rxitr_idx;
 381         u16 txitr_idx;
 382 };
 383
 384 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_vector_map);
 385
 386 struct virtchnl_irq_map_info {
 387         u16 num_vectors;
 388         struct virtchnl_vector_map vecmap[1];
 389 };
 390
 391 VIRTCHNL_CHECK_STRUCT_LEN(14, virtchnl_irq_map_info);
 392
 393 /* VIRTCHNL_OP_ENABLE_QUEUES
 394  * VIRTCHNL_OP_DISABLE_QUEUES
 395  * VF sends these message to enable or disable TX/RX queue pairs.
 396  * The queues fields are bitmaps indicating which queues to act upon.
 397  * (Currently, we only support 16 queues per VF, but we make the field
 398  * u32 to allow for expansion.)
 399  * PF performs requested action and returns status.
 400  * NOTE: The VF is not required to enable/disable all queues in a single
 401  * request. It may send multiple messages.
 402  * PF drivers must correctly handle all VF requests.
 403  */
 404 struct virtchnl_queue_select {
 405         u16 vsi_id;
 406         u16 pad;
 407         u32 rx_queues;
 408         u32 tx_queues;
 409 };
 410
 411 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_queue_select);
 412
 413 /* VIRTCHNL_OP_ADD_ETH_ADDR
 414  * VF sends this message in order to add one or more unicast or multicast
 415  * address filters for the specified VSI.
 416  * PF adds the filters and returns status.
 417  */
 418
 419 /* VIRTCHNL_OP_DEL_ETH_ADDR
 420  * VF sends this message in order to remove one or more unicast or multicast
 421  * filters for the specified VSI.
 422  * PF removes the filters and returns status.
 423  */
 424
 425 struct virtchnl_ether_addr {
 426         u8 addr[VIRTCHNL_ETH_LENGTH_OF_ADDRESS];
 427         u8 pad[2];
 428 };
 429
 430 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_ether_addr);
 431
 432 struct virtchnl_ether_addr_list {
 433         u16 vsi_id;
 434         u16 num_elements;
 435         struct virtchnl_ether_addr list[1];
 436 };
 437
 438 VIRTCHNL_CHECK_STRUCT_LEN(12, virtchnl_ether_addr_list);
 439
 440 /* VIRTCHNL_OP_ADD_VLAN
 441  * VF sends this message to add one or more VLAN tag filters for receives.
 442  * PF adds the filters and returns status.
 443  * If a port VLAN is configured by the PF, this operation will return an
 444  * error to the VF.
 445  */
 446
 447 /* VIRTCHNL_OP_DEL_VLAN
 448  * VF sends this message to remove one or more VLAN tag filters for receives.
 449  * PF removes the filters and returns status.
 450  * If a port VLAN is configured by the PF, this operation will return an
 451  * error to the VF.
 452  */
 453
 454 struct virtchnl_vlan_filter_list {
 455         u16 vsi_id;
 456         u16 num_elements;
 457         u16 vlan_id[1];
 458 };
 459
 460 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_vlan_filter_list);
 461
 462 /* VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
 463  * VF sends VSI id and flags.
 464  * PF returns status code in retval.
 465  * Note: we assume that broadcast accept mode is always enabled.
 466  */
 467 struct virtchnl_promisc_info {
 468         u16 vsi_id;
 469         u16 flags;
 470 };
 471
 472 VIRTCHNL_CHECK_STRUCT_LEN(4, virtchnl_promisc_info);
 473
 474 #define FLAG_VF_UNICAST_PROMISC 0x00000001
 475 #define FLAG_VF_MULTICAST_PROMISC       0x00000002
 476
 477 /* VIRTCHNL_OP_GET_STATS
 478  * VF sends this message to request stats for the selected VSI. VF uses
 479  * the virtchnl_queue_select struct to specify the VSI. The queue_id
 480  * field is ignored by the PF.
 481  *
 482  * PF replies with struct virtchnl_eth_stats in an external buffer.
 483  */
 484
 485 struct virtchnl_eth_stats {
 486         u64 rx_bytes;                   /* received bytes */
 487         u64 rx_unicast;                 /* received unicast pkts */
 488         u64 rx_multicast;               /* received multicast pkts */
 489         u64 rx_broadcast;               /* received broadcast pkts */
 490         u64 rx_discards;
 491         u64 rx_unknown_protocol;
 492         u64 tx_bytes;                   /* transmitted bytes */
 493         u64 tx_unicast;                 /* transmitted unicast pkts */
 494         u64 tx_multicast;               /* transmitted multicast pkts */
 495         u64 tx_broadcast;               /* transmitted broadcast pkts */
 496         u64 tx_discards;
 497         u64 tx_errors;
 498 };
 499
 500 /* VIRTCHNL_OP_CONFIG_RSS_KEY
 501  * VIRTCHNL_OP_CONFIG_RSS_LUT
 502  * VF sends these messages to configure RSS. Only supported if both PF
 503  * and VF drivers set the VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
 504  * configuration negotiation. If this is the case, then the RSS fields in
 505  * the VF resource struct are valid.
 506  * Both the key and LUT are initialized to 0 by the PF, meaning that
 507  * RSS is effectively disabled until set up by the VF.
 508  */
 509 struct virtchnl_rss_key {
 510         u16 vsi_id;
 511         u16 key_len;
 512         u8 key[1];         /* RSS hash key, packed bytes */
 513 };
 514
 515 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_key);
 516
 517 struct virtchnl_rss_lut {
 518         u16 vsi_id;
 519         u16 lut_entries;
 520         u8 lut[1];        /* RSS lookup table */
 521 };
 522
 523 VIRTCHNL_CHECK_STRUCT_LEN(6, virtchnl_rss_lut);
 524
 525 /* VIRTCHNL_OP_GET_RSS_HENA_CAPS
 526  * VIRTCHNL_OP_SET_RSS_HENA
 527  * VF sends these messages to get and set the hash filter enable bits for RSS.
 528  * By default, the PF sets these to all possible traffic types that the
 529  * hardware supports. The VF can query this value if it wants to change the
 530  * traffic types that are hashed by the hardware.
 531  */
 532 struct virtchnl_rss_hena {
 533         u64 hena;
 534 };
 535
 536 VIRTCHNL_CHECK_STRUCT_LEN(8, virtchnl_rss_hena);
 537
 538 /* This is used by PF driver to enforce how many channels can be supported.
 539  * When ADQ_V2 capability is negotiated, it will allow 16 channels otherwise
 540  * PF driver will allow only max 4 channels
 541  */
 542 #define VIRTCHNL_MAX_ADQ_CHANNELS 4
 543 #define VIRTCHNL_MAX_ADQ_V2_CHANNELS 16
 544
 545 /* VIRTCHNL_OP_ENABLE_CHANNELS
 546  * VIRTCHNL_OP_DISABLE_CHANNELS
 547  * VF sends these messages to enable or disable channels based on
 548  * the user specified queue count and queue offset for each traffic class.
 549  * This struct encompasses all the information that the PF needs from
 550  * VF to create a channel.
 551  */
 552 struct virtchnl_channel_info {
 553         u16 count; /* number of queues in a channel */
 554         u16 offset; /* queues in a channel start from 'offset' */
 555         u32 pad;
 556         u64 max_tx_rate;
 557 };
 558
 559 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_channel_info);
 560
 561 struct virtchnl_tc_info {
 562         u32     num_tc;
 563         u32     pad;
 564         struct  virtchnl_channel_info list[1];
 565 };
 566
 567 VIRTCHNL_CHECK_STRUCT_LEN(24, virtchnl_tc_info);
 568
 569 /* VIRTCHNL_ADD_CLOUD_FILTER
 570  * VIRTCHNL_DEL_CLOUD_FILTER
 571  * VF sends these messages to add or delete a cloud filter based on the
 572  * user specified match and action filters. These structures encompass
 573  * all the information that the PF needs from the VF to add/delete a
 574  * cloud filter.
 575  */
 576
 577 struct virtchnl_l4_spec {
 578         u8      src_mac[ETH_ALEN];
 579         u8      dst_mac[ETH_ALEN];
 580         /* vlan_prio is part of this 16 bit field even from OS perspective
 581          * vlan_id:12 is actual vlan_id, then vlanid:bit14..12 is vlan_prio
 582          * in future, when decided to offload vlan_prio, pass that information
 583          * as part of the "vlan_id" field, Bit14..12
 584          */
 585         __be16  vlan_id;
 586         __be16  pad; /* reserved for future use */
 587         __be32  src_ip[4];
 588         __be32  dst_ip[4];
 589         __be16  src_port;
 590         __be16  dst_port;
 591 };
 592
 593 VIRTCHNL_CHECK_STRUCT_LEN(52, virtchnl_l4_spec);
 594
 595 union virtchnl_flow_spec {
 596         struct  virtchnl_l4_spec tcp_spec;
 597         u8      buffer[128]; /* reserved for future use */
 598 };
 599
 600 VIRTCHNL_CHECK_UNION_LEN(128, virtchnl_flow_spec);
 601
 602 enum virtchnl_action {
 603         /* action types */
 604         VIRTCHNL_ACTION_DROP = 0,
 605         VIRTCHNL_ACTION_TC_REDIRECT,
 606 };
 607
 608 enum virtchnl_flow_type {
 609         /* flow types */
 610         VIRTCHNL_TCP_V4_FLOW = 0,
 611         VIRTCHNL_TCP_V6_FLOW,
 612         VIRTCHNL_UDP_V4_FLOW,
 613         VIRTCHNL_UDP_V6_FLOW,
 614 };
 615
 616 struct virtchnl_filter {
 617         union   virtchnl_flow_spec data;
 618         union   virtchnl_flow_spec mask;
 619         enum    virtchnl_flow_type flow_type;
 620         enum    virtchnl_action action;
 621         u32     action_meta;
 622         u8      field_flags;
 623 };
 624
 625 VIRTCHNL_CHECK_STRUCT_LEN(272, virtchnl_filter);
 626
 627 /* VIRTCHNL_OP_EVENT
 628  * PF sends this message to inform the VF driver of events that may affect it.
 629  * No direct response is expected from the VF, though it may generate other
 630  * messages in response to this one.
 631  */
 632 enum virtchnl_event_codes {
 633         VIRTCHNL_EVENT_UNKNOWN = 0,
 634         VIRTCHNL_EVENT_LINK_CHANGE,
 635         VIRTCHNL_EVENT_RESET_IMPENDING,
 636         VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
 637 };
 638
 639 #define PF_EVENT_SEVERITY_INFO          0
 640 #define PF_EVENT_SEVERITY_ATTENTION     1
 641 #define PF_EVENT_SEVERITY_ACTION_REQUIRED       2
 642 #define PF_EVENT_SEVERITY_CERTAIN_DOOM  255
 643
 644 struct virtchnl_pf_event {
 645         enum virtchnl_event_codes event;
 646         union {
 647                 /* If the PF driver does not support the new speed reporting
 648                  * capabilities then use link_event else use link_event_adv to
 649                  * get the speed and link information. The ability to understand
 650                  * new speeds is indicated by setting the capability flag
 651                  * VIRTCHNL_VF_CAP_ADV_LINK_SPEED in vf_cap_flags parameter
 652                  * in virtchnl_vf_resource struct and can be used to determine
 653                  * which link event struct to use below.
 654                  */
 655                 struct {
 656                         enum virtchnl_link_speed link_speed;
 657                         u8 link_status;
 658                 } link_event;
 659                 struct {
 660                         /* link_speed provided in Mbps */
 661                         u32 link_speed;
 662                         u8 link_status;
 663                 } link_event_adv;
 664         } event_data;
 665
 666         int severity;
 667 };
 668
 669 VIRTCHNL_CHECK_STRUCT_LEN(16, virtchnl_pf_event);
 670
 671
 672 /* Since VF messages are limited by u16 size, precalculate the maximum possible
 673  * values of nested elements in virtchnl structures that virtual channel can
 674  * possibly handle in a single message.
 675  */
 676 enum virtchnl_vector_limits {
 677         VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX       =
 678                 ((u16)(~0) - sizeof(struct virtchnl_vsi_queue_config_info)) /
 679                 sizeof(struct virtchnl_queue_pair_info),
 680
 681         VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX          =
 682                 ((u16)(~0) - sizeof(struct virtchnl_irq_map_info)) /
 683                 sizeof(struct virtchnl_vector_map),
 684
 685         VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX        =
 686                 ((u16)(~0) - sizeof(struct virtchnl_ether_addr_list)) /
 687                 sizeof(struct virtchnl_ether_addr),
 688
 689         VIRTCHNL_OP_ADD_DEL_VLAN_MAX            =
 690                 ((u16)(~0) - sizeof(struct virtchnl_vlan_filter_list)) /
 691                 sizeof(u16),
 692
 693
 694         VIRTCHNL_OP_ENABLE_CHANNELS_MAX         =
 695                 ((u16)(~0) - sizeof(struct virtchnl_tc_info)) /
 696                 sizeof(struct virtchnl_channel_info),
 697 };
 698
 699 /* VF reset states - these are written into the RSTAT register:
 700  * VFGEN_RSTAT on the VF
 701  * When the PF initiates a reset, it writes 0
 702  * When the reset is complete, it writes 1
 703  * When the PF detects that the VF has recovered, it writes 2
 704  * VF checks this register periodically to determine if a reset has occurred,
 705  * then polls it to know when the reset is complete.
 706  * If either the PF or VF reads the register while the hardware
 707  * is in a reset state, it will return DEADBEEF, which, when masked
 708  * will result in 3.
 709  */
 710 enum virtchnl_vfr_states {
 711         VIRTCHNL_VFR_INPROGRESS = 0,
 712         VIRTCHNL_VFR_COMPLETED,
 713         VIRTCHNL_VFR_VFACTIVE,
 714 };
 715
 716 /**
 717  * virtchnl_vc_validate_vf_msg
 718  * @ver: Virtchnl version info
 719  * @v_opcode: Opcode for the message
 720  * @msg: pointer to the msg buffer
 721  * @msglen: msg length
 722  *
 723  * validate msg format against struct for each opcode
 724  */
 725 static inline int
 726 virtchnl_vc_validate_vf_msg(struct virtchnl_version_info *ver, u32 v_opcode,
 727                             u8 *msg, u16 msglen)
 728 {
 729         bool err_msg_format = false;
 730         int valid_len = 0;
 731
 732         /* Validate message length. */
 733         switch (v_opcode) {
 734         case VIRTCHNL_OP_VERSION:
 735                 valid_len = sizeof(struct virtchnl_version_info);
 736                 break;
 737         case VIRTCHNL_OP_RESET_VF:
 738                 break;
 739         case VIRTCHNL_OP_GET_VF_RESOURCES:
 740                 if (VF_IS_V11(ver))
 741                         valid_len = sizeof(u32);
 742                 break;
 743         case VIRTCHNL_OP_CONFIG_TX_QUEUE:
 744                 valid_len = sizeof(struct virtchnl_txq_info);
 745                 break;
 746         case VIRTCHNL_OP_CONFIG_RX_QUEUE:
 747                 valid_len = sizeof(struct virtchnl_rxq_info);
 748                 break;
 749         case VIRTCHNL_OP_CONFIG_VSI_QUEUES:
 750                 valid_len = sizeof(struct virtchnl_vsi_queue_config_info);
 751                 if (msglen >= valid_len) {
 752                         struct virtchnl_vsi_queue_config_info *vqc =
 753                             (struct virtchnl_vsi_queue_config_info *)msg;
 754
 755                         if (vqc->num_queue_pairs == 0 || vqc->num_queue_pairs >
 756                             VIRTCHNL_OP_CONFIG_VSI_QUEUES_MAX) {
 757                                 err_msg_format = true;
 758                                 break;
 759                         }
 760
 761                         valid_len += (vqc->num_queue_pairs *
 762                                       sizeof(struct
 763                                              virtchnl_queue_pair_info));
 764                 }
 765                 break;
 766         case VIRTCHNL_OP_CONFIG_IRQ_MAP:
 767                 valid_len = sizeof(struct virtchnl_irq_map_info);
 768                 if (msglen >= valid_len) {
 769                         struct virtchnl_irq_map_info *vimi =
 770                             (struct virtchnl_irq_map_info *)msg;
 771
 772                         if (vimi->num_vectors == 0 || vimi->num_vectors >
 773                             VIRTCHNL_OP_CONFIG_IRQ_MAP_MAX) {
 774                                 err_msg_format = true;
 775                                 break;
 776                         }
 777
 778                         valid_len += (vimi->num_vectors *
 779                                       sizeof(struct virtchnl_vector_map));
 780                 }
 781                 break;
 782         case VIRTCHNL_OP_ENABLE_QUEUES:
 783         case VIRTCHNL_OP_DISABLE_QUEUES:
 784                 valid_len = sizeof(struct virtchnl_queue_select);
 785                 break;
 786         case VIRTCHNL_OP_ADD_ETH_ADDR:
 787         case VIRTCHNL_OP_DEL_ETH_ADDR:
 788                 valid_len = sizeof(struct virtchnl_ether_addr_list);
 789                 if (msglen >= valid_len) {
 790                         struct virtchnl_ether_addr_list *veal =
 791                             (struct virtchnl_ether_addr_list *)msg;
 792
 793                         if (veal->num_elements == 0 || veal->num_elements >
 794                             VIRTCHNL_OP_ADD_DEL_ETH_ADDR_MAX) {
 795                                 err_msg_format = true;
 796                                 break;
 797                         }
 798
 799                         valid_len += veal->num_elements *
 800                             sizeof(struct virtchnl_ether_addr);
 801                 }
 802                 break;
 803         case VIRTCHNL_OP_ADD_VLAN:
 804         case VIRTCHNL_OP_DEL_VLAN:
 805                 valid_len = sizeof(struct virtchnl_vlan_filter_list);
 806                 if (msglen >= valid_len) {
 807                         struct virtchnl_vlan_filter_list *vfl =
 808                             (struct virtchnl_vlan_filter_list *)msg;
 809
 810                         if (vfl->num_elements == 0 || vfl->num_elements >
 811                             VIRTCHNL_OP_ADD_DEL_VLAN_MAX) {
 812                                 err_msg_format = true;
 813                                 break;
 814                         }
 815
 816                         valid_len += vfl->num_elements * sizeof(u16);
 817                 }
 818                 break;
 819         case VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE:
 820                 valid_len = sizeof(struct virtchnl_promisc_info);
 821                 break;
 822         case VIRTCHNL_OP_GET_STATS:
 823                 valid_len = sizeof(struct virtchnl_queue_select);
 824                 break;
 825         case VIRTCHNL_OP_CONFIG_RSS_KEY:
 826                 valid_len = sizeof(struct virtchnl_rss_key);
 827                 if (msglen >= valid_len) {
 828                         struct virtchnl_rss_key *vrk =
 829                                 (struct virtchnl_rss_key *)msg;
 830
 831                         if (vrk->key_len == 0) {
 832                                 /* zero length is allowed as input */
 833                                 break;
 834                         }
 835
 836                         valid_len += vrk->key_len - 1;
 837                 }
 838                 break;
 839         case VIRTCHNL_OP_CONFIG_RSS_LUT:
 840                 valid_len = sizeof(struct virtchnl_rss_lut);
 841                 if (msglen >= valid_len) {
 842                         struct virtchnl_rss_lut *vrl =
 843                                 (struct virtchnl_rss_lut *)msg;
 844
 845                         if (vrl->lut_entries == 0) {
 846                                 /* zero entries is allowed as input */
 847                                 break;
 848                         }
 849
 850                         valid_len += vrl->lut_entries - 1;
 851                 }
 852                 break;
 853         case VIRTCHNL_OP_GET_RSS_HENA_CAPS:
 854                 break;
 855         case VIRTCHNL_OP_SET_RSS_HENA:
 856                 valid_len = sizeof(struct virtchnl_rss_hena);
 857                 break;
 858         case VIRTCHNL_OP_ENABLE_VLAN_STRIPPING:
 859         case VIRTCHNL_OP_DISABLE_VLAN_STRIPPING:
 860                 break;
 861         case VIRTCHNL_OP_REQUEST_QUEUES:
 862                 valid_len = sizeof(struct virtchnl_vf_res_request);
 863                 break;
 864         case VIRTCHNL_OP_ENABLE_CHANNELS:
 865                 valid_len = sizeof(struct virtchnl_tc_info);
 866                 if (msglen >= valid_len) {
 867                         struct virtchnl_tc_info *vti =
 868                                 (struct virtchnl_tc_info *)msg;
 869
 870                         if (vti->num_tc == 0 || vti->num_tc >
 871                             VIRTCHNL_OP_ENABLE_CHANNELS_MAX) {
 872                                 err_msg_format = true;
 873                                 break;
 874                         }
 875
 876                         valid_len += (vti->num_tc - 1) *
 877                                      sizeof(struct virtchnl_channel_info);
 878                 }
 879                 break;
 880         case VIRTCHNL_OP_DISABLE_CHANNELS:
 881                 break;
 882         case VIRTCHNL_OP_ADD_CLOUD_FILTER:
 883         case VIRTCHNL_OP_DEL_CLOUD_FILTER:
 884                 valid_len = sizeof(struct virtchnl_filter);
 885                 break;
 886         case VIRTCHNL_OP_DCF_CMD_DESC:
 887         case VIRTCHNL_OP_DCF_CMD_BUFF:
 888                 /* These two opcodes are specific to handle the AdminQ command,
 889                  * so the validation needs to be done in PF's context.
 890                  */
 891                 return 0;
 892         case VIRTCHNL_OP_DCF_DISABLE:
 893                 break;
 894         /* These are always errors coming from the VF. */
 895         case VIRTCHNL_OP_EVENT:
 896         case VIRTCHNL_OP_UNKNOWN:
 897         default:
 898                 return VIRTCHNL_STATUS_ERR_PARAM;
 899         }
 900         /* few more checks */
 901         if (err_msg_format || valid_len != msglen)
 902                 return VIRTCHNL_STATUS_ERR_OPCODE_MISMATCH;
 903
 904         return 0;
 905 }
 906 #endif /* _VIRTCHNL_H_ */