drivers/net/i40e/base/i40e_virtchnl.h

   1 /*******************************************************************************
   2
   3 Copyright (c) 2013 - 2015, Intel Corporation
   4 All rights reserved.
   5
   6 Redistribution and use in source and binary forms, with or without
   7 modification, are permitted provided that the following conditions are met:
   8
   9  1. Redistributions of source code must retain the above copyright notice,
  10     this list of conditions and the following disclaimer.
  11
  12  2. Redistributions in binary form must reproduce the above copyright
  13     notice, this list of conditions and the following disclaimer in the
  14     documentation and/or other materials provided with the distribution.
  15
  16  3. Neither the name of the Intel Corporation nor the names of its
  17     contributors may be used to endorse or promote products derived from
  18     this software without specific prior written permission.
  19
  20 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  24 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27 INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28 CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29 ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  30 POSSIBILITY OF SUCH DAMAGE.
  31
  32 ***************************************************************************/
  33
  34 #ifndef _I40E_VIRTCHNL_H_
  35 #define _I40E_VIRTCHNL_H_
  36
  37 #include "i40e_type.h"
  38
  39 /* Description:
  40  * This header file describes the VF-PF communication protocol used
  41  * by the various i40e drivers.
  42  *
  43  * Admin queue buffer usage:
  44  * desc->opcode is always i40e_aqc_opc_send_msg_to_pf
  45  * flags, retval, datalen, and data addr are all used normally.
  46  * Firmware copies the cookie fields when sending messages between the PF and
  47  * VF, but uses all other fields internally. Due to this limitation, we
  48  * must send all messages as "indirect", i.e. using an external buffer.
  49  *
  50  * All the vsi indexes are relative to the VF. Each VF can have maximum of
  51  * three VSIs. All the queue indexes are relative to the VSI.  Each VF can
  52  * have a maximum of sixteen queues for all of its VSIs.
  53  *
  54  * The PF is required to return a status code in v_retval for all messages
  55  * except RESET_VF, which does not require any response. The return value is of
  56  * i40e_status_code type, defined in the i40e_type.h.
  57  *
  58  * In general, VF driver initialization should roughly follow the order of these
  59  * opcodes. The VF driver must first validate the API version of the PF driver,
  60  * then request a reset, then get resources, then configure queues and
  61  * interrupts. After these operations are complete, the VF driver may start
  62  * its queues, optionally add MAC and VLAN filters, and process traffic.
  63  */
  64
  65 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
  66  * of the virtchnl_msg structure.
  67  */
  68 enum i40e_virtchnl_ops {
  69 /* The PF sends status change events to VFs using
  70  * the I40E_VIRTCHNL_OP_EVENT opcode.
  71  * VFs send requests to the PF using the other ops.
  72  */
  73         I40E_VIRTCHNL_OP_UNKNOWN = 0,
  74         I40E_VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
  75         I40E_VIRTCHNL_OP_RESET_VF = 2,
  76         I40E_VIRTCHNL_OP_GET_VF_RESOURCES = 3,
  77         I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
  78         I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
  79         I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
  80         I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
  81         I40E_VIRTCHNL_OP_ENABLE_QUEUES = 8,
  82         I40E_VIRTCHNL_OP_DISABLE_QUEUES = 9,
  83         I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS = 10,
  84         I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS = 11,
  85         I40E_VIRTCHNL_OP_ADD_VLAN = 12,
  86         I40E_VIRTCHNL_OP_DEL_VLAN = 13,
  87         I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
  88         I40E_VIRTCHNL_OP_GET_STATS = 15,
  89         I40E_VIRTCHNL_OP_FCOE = 16,
  90         I40E_VIRTCHNL_OP_EVENT = 17, /* must ALWAYS be 17 */
  91 #ifdef I40E_SOL_VF_SUPPORT
  92         I40E_VIRTCHNL_OP_GET_ADDNL_SOL_CONFIG = 19,
  93 #endif
  94         I40E_VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
  95         I40E_VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
  96         I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
  97         I40E_VIRTCHNL_OP_SET_RSS_HENA = 26,
  98
  99 };
 100
 101 /* Virtual channel message descriptor. This overlays the admin queue
 102  * descriptor. All other data is passed in external buffers.
 103  */
 104
 105 struct i40e_virtchnl_msg {
 106         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
 107         enum i40e_virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
 108         enum i40e_status_code v_retval;  /* ditto for desc->retval */
 109         u32 vfid;                        /* used by PF when sending to VF */
 110 };
 111
 112 /* Message descriptions and data structures.*/
 113
 114 /* I40E_VIRTCHNL_OP_VERSION
 115  * VF posts its version number to the PF. PF responds with its version number
 116  * in the same format, along with a return code.
 117  * Reply from PF has its major/minor versions also in param0 and param1.
 118  * If there is a major version mismatch, then the VF cannot operate.
 119  * If there is a minor version mismatch, then the VF can operate but should
 120  * add a warning to the system log.
 121  *
 122  * This enum element MUST always be specified as == 1, regardless of other
 123  * changes in the API. The PF must always respond to this message without
 124  * error regardless of version mismatch.
 125  */
 126 #define I40E_VIRTCHNL_VERSION_MAJOR             1
 127 #define I40E_VIRTCHNL_VERSION_MINOR             1
 128 #define I40E_VIRTCHNL_VERSION_MINOR_NO_VF_CAPS  0
 129
 130 struct i40e_virtchnl_version_info {
 131         u32 major;
 132         u32 minor;
 133 };
 134
 135 /* I40E_VIRTCHNL_OP_RESET_VF
 136  * VF sends this request to PF with no parameters
 137  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
 138  * until reset completion is indicated. The admin queue must be reinitialized
 139  * after this operation.
 140  *
 141  * When reset is complete, PF must ensure that all queues in all VSIs associated
 142  * with the VF are stopped, all queue configurations in the HMC are set to 0,
 143  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
 144  * are cleared.
 145  */
 146
 147 /* I40E_VIRTCHNL_OP_GET_VF_RESOURCES
 148  * Version 1.0 VF sends this request to PF with no parameters
 149  * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
 150  * PF responds with an indirect message containing
 151  * i40e_virtchnl_vf_resource and one or more
 152  * i40e_virtchnl_vsi_resource structures.
 153  */
 154
 155 struct i40e_virtchnl_vsi_resource {
 156         u16 vsi_id;
 157         u16 num_queue_pairs;
 158         enum i40e_vsi_type vsi_type;
 159         u16 qset_handle;
 160         u8 default_mac_addr[I40E_ETH_LENGTH_OF_ADDRESS];
 161 };
 162 /* VF offload flags */
 163 #define I40E_VIRTCHNL_VF_OFFLOAD_L2             0x00000001
 164 #define I40E_VIRTCHNL_VF_OFFLOAD_IWARP          0x00000002
 165 #define I40E_VIRTCHNL_VF_OFFLOAD_FCOE           0x00000004
 166 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ         0x00000008
 167 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_REG        0x00000010
 168 #define I40E_VIRTCHNL_VF_OFFLOAD_WB_ON_ITR      0x00000020
 169 #define I40E_VIRTCHNL_VF_OFFLOAD_VLAN           0x00010000
 170 #define I40E_VIRTCHNL_VF_OFFLOAD_RX_POLLING     0x00020000
 171 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2  0x00040000
 172 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF         0X00080000
 173
 174 struct i40e_virtchnl_vf_resource {
 175         u16 num_vsis;
 176         u16 num_queue_pairs;
 177         u16 max_vectors;
 178         u16 max_mtu;
 179
 180         u32 vf_offload_flags;
 181         u32 rss_key_size;
 182         u32 rss_lut_size;
 183
 184         struct i40e_virtchnl_vsi_resource vsi_res[1];
 185 };
 186
 187 /* I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE
 188  * VF sends this message to set up parameters for one TX queue.
 189  * External data buffer contains one instance of i40e_virtchnl_txq_info.
 190  * PF configures requested queue and returns a status code.
 191  */
 192
 193 /* Tx queue config info */
 194 struct i40e_virtchnl_txq_info {
 195         u16 vsi_id;
 196         u16 queue_id;
 197         u16 ring_len;           /* number of descriptors, multiple of 8 */
 198         u16 headwb_enabled;
 199         u64 dma_ring_addr;
 200         u64 dma_headwb_addr;
 201 };
 202
 203 /* I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE
 204  * VF sends this message to set up parameters for one RX queue.
 205  * External data buffer contains one instance of i40e_virtchnl_rxq_info.
 206  * PF configures requested queue and returns a status code.
 207  */
 208
 209 /* Rx queue config info */
 210 struct i40e_virtchnl_rxq_info {
 211         u16 vsi_id;
 212         u16 queue_id;
 213         u32 ring_len;           /* number of descriptors, multiple of 32 */
 214         u16 hdr_size;
 215         u16 splithdr_enabled;
 216         u32 databuffer_size;
 217         u32 max_pkt_size;
 218         u64 dma_ring_addr;
 219         enum i40e_hmc_obj_rx_hsplit_0 rx_split_pos;
 220 };
 221
 222 /* I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES
 223  * VF sends this message to set parameters for all active TX and RX queues
 224  * associated with the specified VSI.
 225  * PF configures queues and returns status.
 226  * If the number of queues specified is greater than the number of queues
 227  * associated with the VSI, an error is returned and no queues are configured.
 228  */
 229 struct i40e_virtchnl_queue_pair_info {
 230         /* NOTE: vsi_id and queue_id should be identical for both queues. */
 231         struct i40e_virtchnl_txq_info txq;
 232         struct i40e_virtchnl_rxq_info rxq;
 233 };
 234
 235 struct i40e_virtchnl_vsi_queue_config_info {
 236         u16 vsi_id;
 237         u16 num_queue_pairs;
 238         struct i40e_virtchnl_queue_pair_info qpair[1];
 239 };
 240
 241 /* I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP
 242  * VF uses this message to map vectors to queues.
 243  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
 244  * are to be associated with the specified vector.
 245  * The "other" causes are always mapped to vector 0.
 246  * PF configures interrupt mapping and returns status.
 247  */
 248 struct i40e_virtchnl_vector_map {
 249         u16 vsi_id;
 250         u16 vector_id;
 251         u16 rxq_map;
 252         u16 txq_map;
 253         u16 rxitr_idx;
 254         u16 txitr_idx;
 255 };
 256
 257 struct i40e_virtchnl_irq_map_info {
 258         u16 num_vectors;
 259         struct i40e_virtchnl_vector_map vecmap[1];
 260 };
 261
 262 /* I40E_VIRTCHNL_OP_ENABLE_QUEUES
 263  * I40E_VIRTCHNL_OP_DISABLE_QUEUES
 264  * VF sends these message to enable or disable TX/RX queue pairs.
 265  * The queues fields are bitmaps indicating which queues to act upon.
 266  * (Currently, we only support 16 queues per VF, but we make the field
 267  * u32 to allow for expansion.)
 268  * PF performs requested action and returns status.
 269  */
 270 struct i40e_virtchnl_queue_select {
 271         u16 vsi_id;
 272         u16 pad;
 273         u32 rx_queues;
 274         u32 tx_queues;
 275 };
 276
 277 /* I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS
 278  * VF sends this message in order to add one or more unicast or multicast
 279  * address filters for the specified VSI.
 280  * PF adds the filters and returns status.
 281  */
 282
 283 /* I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS
 284  * VF sends this message in order to remove one or more unicast or multicast
 285  * filters for the specified VSI.
 286  * PF removes the filters and returns status.
 287  */
 288
 289 struct i40e_virtchnl_ether_addr {
 290         u8 addr[I40E_ETH_LENGTH_OF_ADDRESS];
 291         u8 pad[2];
 292 };
 293
 294 struct i40e_virtchnl_ether_addr_list {
 295         u16 vsi_id;
 296         u16 num_elements;
 297         struct i40e_virtchnl_ether_addr list[1];
 298 };
 299
 300 #ifdef I40E_SOL_VF_SUPPORT
 301 /* I40E_VIRTCHNL_OP_GET_ADDNL_SOL_CONFIG
 302  * VF sends this message to get the default MTU and list of additional ethernet
 303  * addresses it is allowed to use.
 304  * PF responds with an indirect message containing
 305  * i40e_virtchnl_addnl_solaris_config with zero or more
 306  * i40e_virtchnl_ether_addr structures.
 307  *
 308  * It is expected that this operation will only ever be needed for Solaris VFs
 309  * running under a Solaris PF.
 310  */
 311 struct i40e_virtchnl_addnl_solaris_config {
 312         u16 default_mtu;
 313         struct i40e_virtchnl_ether_addr_list al;
 314 };
 315
 316 #endif
 317 /* I40E_VIRTCHNL_OP_ADD_VLAN
 318  * VF sends this message to add one or more VLAN tag filters for receives.
 319  * PF adds the filters and returns status.
 320  * If a port VLAN is configured by the PF, this operation will return an
 321  * error to the VF.
 322  */
 323
 324 /* I40E_VIRTCHNL_OP_DEL_VLAN
 325  * VF sends this message to remove one or more VLAN tag filters for receives.
 326  * PF removes the filters and returns status.
 327  * If a port VLAN is configured by the PF, this operation will return an
 328  * error to the VF.
 329  */
 330
 331 struct i40e_virtchnl_vlan_filter_list {
 332         u16 vsi_id;
 333         u16 num_elements;
 334         u16 vlan_id[1];
 335 };
 336
 337 /* I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
 338  * VF sends VSI id and flags.
 339  * PF returns status code in retval.
 340  * Note: we assume that broadcast accept mode is always enabled.
 341  */
 342 struct i40e_virtchnl_promisc_info {
 343         u16 vsi_id;
 344         u16 flags;
 345 };
 346
 347 #define I40E_FLAG_VF_UNICAST_PROMISC    0x00000001
 348 #define I40E_FLAG_VF_MULTICAST_PROMISC  0x00000002
 349
 350 /* I40E_VIRTCHNL_OP_GET_STATS
 351  * VF sends this message to request stats for the selected VSI. VF uses
 352  * the i40e_virtchnl_queue_select struct to specify the VSI. The queue_id
 353  * field is ignored by the PF.
 354  *
 355  * PF replies with struct i40e_eth_stats in an external buffer.
 356  */
 357
 358 /* I40E_VIRTCHNL_OP_CONFIG_RSS_KEY
 359  * I40E_VIRTCHNL_OP_CONFIG_RSS_LUT
 360  * VF sends these messages to configure RSS. Only supported if both PF
 361  * and VF drivers set the I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
 362  * configuration negotiation. If this is the case, then the rss fields in
 363  * the vf resource struct are valid.
 364  * Both the key and LUT are initialized to 0 by the PF, meaning that
 365  * RSS is effectively disabled until set up by the VF.
 366  */
 367 struct i40e_virtchnl_rss_key {
 368         u16 vsi_id;
 369         u16 key_len;
 370         u8 key[1];         /* RSS hash key, packed bytes */
 371 };
 372
 373 struct i40e_virtchnl_rss_lut {
 374         u16 vsi_id;
 375         u16 lut_entries;
 376         u8 lut[1];        /* RSS lookup table*/
 377 };
 378
 379 /* I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS
 380  * I40E_VIRTCHNL_OP_SET_RSS_HENA
 381  * VF sends these messages to get and set the hash filter enable bits for RSS.
 382  * By default, the PF sets these to all possible traffic types that the
 383  * hardware supports. The VF can query this value if it wants to change the
 384  * traffic types that are hashed by the hardware.
 385  * Traffic types are defined in the i40e_filter_pctype enum in i40e_type.h
 386  */
 387 struct i40e_virtchnl_rss_hena {
 388         u64 hena;
 389 };
 390
 391 /* I40E_VIRTCHNL_OP_EVENT
 392  * PF sends this message to inform the VF driver of events that may affect it.
 393  * No direct response is expected from the VF, though it may generate other
 394  * messages in response to this one.
 395  */
 396 enum i40e_virtchnl_event_codes {
 397         I40E_VIRTCHNL_EVENT_UNKNOWN = 0,
 398         I40E_VIRTCHNL_EVENT_LINK_CHANGE,
 399         I40E_VIRTCHNL_EVENT_RESET_IMPENDING,
 400         I40E_VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
 401 };
 402 #define I40E_PF_EVENT_SEVERITY_INFO             0
 403 #define I40E_PF_EVENT_SEVERITY_ATTENTION        1
 404 #define I40E_PF_EVENT_SEVERITY_ACTION_REQUIRED  2
 405 #define I40E_PF_EVENT_SEVERITY_CERTAIN_DOOM     255
 406
 407 struct i40e_virtchnl_pf_event {
 408         enum i40e_virtchnl_event_codes event;
 409         union {
 410                 struct {
 411                         enum i40e_aq_link_speed link_speed;
 412                         bool link_status;
 413                 } link_event;
 414         } event_data;
 415
 416         int severity;
 417 };
 418
 419 /* VF reset states - these are written into the RSTAT register:
 420  * I40E_VFGEN_RSTAT1 on the PF
 421  * I40E_VFGEN_RSTAT on the VF
 422  * When the PF initiates a reset, it writes 0
 423  * When the reset is complete, it writes 1
 424  * When the PF detects that the VF has recovered, it writes 2
 425  * VF checks this register periodically to determine if a reset has occurred,
 426  * then polls it to know when the reset is complete.
 427  * If either the PF or VF reads the register while the hardware
 428  * is in a reset state, it will return DEADBEEF, which, when masked
 429  * will result in 3.
 430  */
 431 enum i40e_vfr_states {
 432         I40E_VFR_INPROGRESS = 0,
 433         I40E_VFR_COMPLETED,
 434         I40E_VFR_VFACTIVE,
 435         I40E_VFR_UNKNOWN,
 436 };
 437
 438 #endif /* _I40E_VIRTCHNL_H_ */