lib/librte_pmd_i40e/i40e/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,
  91         I40E_VIRTCHNL_OP_CONFIG_RSS = 18,
  92 };
  93
  94 /* Virtual channel message descriptor. This overlays the admin queue
  95  * descriptor. All other data is passed in external buffers.
  96  */
  97
  98 struct i40e_virtchnl_msg {
  99         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
 100         enum i40e_virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
 101         enum i40e_status_code v_retval;  /* ditto for desc->retval */
 102         u32 vfid;                        /* used by PF when sending to VF */
 103 };
 104
 105 /* Message descriptions and data structures.*/
 106
 107 /* I40E_VIRTCHNL_OP_VERSION
 108  * VF posts its version number to the PF. PF responds with its version number
 109  * in the same format, along with a return code.
 110  * Reply from PF has its major/minor versions also in param0 and param1.
 111  * If there is a major version mismatch, then the VF cannot operate.
 112  * If there is a minor version mismatch, then the VF can operate but should
 113  * add a warning to the system log.
 114  *
 115  * This enum element MUST always be specified as == 1, regardless of other
 116  * changes in the API. The PF must always respond to this message without
 117  * error regardless of version mismatch.
 118  */
 119 #define I40E_VIRTCHNL_VERSION_MAJOR             1
 120 #define I40E_VIRTCHNL_VERSION_MINOR             0
 121 struct i40e_virtchnl_version_info {
 122         u32 major;
 123         u32 minor;
 124 };
 125
 126 /* I40E_VIRTCHNL_OP_RESET_VF
 127  * VF sends this request to PF with no parameters
 128  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
 129  * until reset completion is indicated. The admin queue must be reinitialized
 130  * after this operation.
 131  *
 132  * When reset is complete, PF must ensure that all queues in all VSIs associated
 133  * with the VF are stopped, all queue configurations in the HMC are set to 0,
 134  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
 135  * are cleared.
 136  */
 137
 138 /* I40E_VIRTCHNL_OP_GET_VF_RESOURCES
 139  * VF sends this request to PF with no parameters
 140  * PF responds with an indirect message containing
 141  * i40e_virtchnl_vf_resource and one or more
 142  * i40e_virtchnl_vsi_resource structures.
 143  */
 144
 145 struct i40e_virtchnl_vsi_resource {
 146         u16 vsi_id;
 147         u16 num_queue_pairs;
 148         enum i40e_vsi_type vsi_type;
 149         u16 qset_handle;
 150         u8 default_mac_addr[I40E_ETH_LENGTH_OF_ADDRESS];
 151 };
 152 /* VF offload flags */
 153 #define I40E_VIRTCHNL_VF_OFFLOAD_L2     0x00000001
 154 #define I40E_VIRTCHNL_VF_OFFLOAD_IWARP  0x00000002
 155 #define I40E_VIRTCHNL_VF_OFFLOAD_FCOE   0x00000004
 156 #define I40E_VIRTCHNL_VF_OFFLOAD_VLAN   0x00010000
 157
 158 struct i40e_virtchnl_vf_resource {
 159         u16 num_vsis;
 160         u16 num_queue_pairs;
 161         u16 max_vectors;
 162         u16 max_mtu;
 163
 164         u32 vf_offload_flags;
 165         u32 max_fcoe_contexts;
 166         u32 max_fcoe_filters;
 167
 168         struct i40e_virtchnl_vsi_resource vsi_res[1];
 169 };
 170
 171 /* I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE
 172  * VF sends this message to set up parameters for one TX queue.
 173  * External data buffer contains one instance of i40e_virtchnl_txq_info.
 174  * PF configures requested queue and returns a status code.
 175  */
 176
 177 /* Tx queue config info */
 178 struct i40e_virtchnl_txq_info {
 179         u16 vsi_id;
 180         u16 queue_id;
 181         u16 ring_len;           /* number of descriptors, multiple of 8 */
 182         u16 headwb_enabled;
 183         u64 dma_ring_addr;
 184         u64 dma_headwb_addr;
 185 };
 186
 187 /* I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE
 188  * VF sends this message to set up parameters for one RX queue.
 189  * External data buffer contains one instance of i40e_virtchnl_rxq_info.
 190  * PF configures requested queue and returns a status code.
 191  */
 192
 193 /* Rx queue config info */
 194 struct i40e_virtchnl_rxq_info {
 195         u16 vsi_id;
 196         u16 queue_id;
 197         u32 ring_len;           /* number of descriptors, multiple of 32 */
 198         u16 hdr_size;
 199         u16 splithdr_enabled;
 200         u32 databuffer_size;
 201         u32 max_pkt_size;
 202         u64 dma_ring_addr;
 203         enum i40e_hmc_obj_rx_hsplit_0 rx_split_pos;
 204 };
 205
 206 /* I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES
 207  * VF sends this message to set parameters for all active TX and RX queues
 208  * associated with the specified VSI.
 209  * PF configures queues and returns status.
 210  * If the number of queues specified is greater than the number of queues
 211  * associated with the VSI, an error is returned and no queues are configured.
 212  */
 213 struct i40e_virtchnl_queue_pair_info {
 214         /* NOTE: vsi_id and queue_id should be identical for both queues. */
 215         struct i40e_virtchnl_txq_info txq;
 216         struct i40e_virtchnl_rxq_info rxq;
 217 };
 218
 219 struct i40e_virtchnl_vsi_queue_config_info {
 220         u16 vsi_id;
 221         u16 num_queue_pairs;
 222         struct i40e_virtchnl_queue_pair_info qpair[1];
 223 };
 224
 225 /* I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP
 226  * VF uses this message to map vectors to queues.
 227  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
 228  * are to be associated with the specified vector.
 229  * The "other" causes are always mapped to vector 0.
 230  * PF configures interrupt mapping and returns status.
 231  */
 232 struct i40e_virtchnl_vector_map {
 233         u16 vsi_id;
 234         u16 vector_id;
 235         u16 rxq_map;
 236         u16 txq_map;
 237         u16 rxitr_idx;
 238         u16 txitr_idx;
 239 };
 240
 241 struct i40e_virtchnl_irq_map_info {
 242         u16 num_vectors;
 243         struct i40e_virtchnl_vector_map vecmap[1];
 244 };
 245
 246 /* I40E_VIRTCHNL_OP_ENABLE_QUEUES
 247  * I40E_VIRTCHNL_OP_DISABLE_QUEUES
 248  * VF sends these message to enable or disable TX/RX queue pairs.
 249  * The queues fields are bitmaps indicating which queues to act upon.
 250  * (Currently, we only support 16 queues per VF, but we make the field
 251  * u32 to allow for expansion.)
 252  * PF performs requested action and returns status.
 253  */
 254 struct i40e_virtchnl_queue_select {
 255         u16 vsi_id;
 256         u16 pad;
 257         u32 rx_queues;
 258         u32 tx_queues;
 259 };
 260
 261 /* I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS
 262  * VF sends this message in order to add one or more unicast or multicast
 263  * address filters for the specified VSI.
 264  * PF adds the filters and returns status.
 265  */
 266
 267 /* I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS
 268  * VF sends this message in order to remove one or more unicast or multicast
 269  * filters for the specified VSI.
 270  * PF removes the filters and returns status.
 271  */
 272
 273 struct i40e_virtchnl_ether_addr {
 274         u8 addr[I40E_ETH_LENGTH_OF_ADDRESS];
 275         u8 pad[2];
 276 };
 277
 278 struct i40e_virtchnl_ether_addr_list {
 279         u16 vsi_id;
 280         u16 num_elements;
 281         struct i40e_virtchnl_ether_addr list[1];
 282 };
 283
 284 /* I40E_VIRTCHNL_OP_ADD_VLAN
 285  * VF sends this message to add one or more VLAN tag filters for receives.
 286  * PF adds the filters and returns status.
 287  * If a port VLAN is configured by the PF, this operation will return an
 288  * error to the VF.
 289  */
 290
 291 /* I40E_VIRTCHNL_OP_DEL_VLAN
 292  * VF sends this message to remove one or more VLAN tag filters for receives.
 293  * PF removes the filters and returns status.
 294  * If a port VLAN is configured by the PF, this operation will return an
 295  * error to the VF.
 296  */
 297
 298 struct i40e_virtchnl_vlan_filter_list {
 299         u16 vsi_id;
 300         u16 num_elements;
 301         u16 vlan_id[1];
 302 };
 303
 304 /* I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
 305  * VF sends VSI id and flags.
 306  * PF returns status code in retval.
 307  * Note: we assume that broadcast accept mode is always enabled.
 308  */
 309 struct i40e_virtchnl_promisc_info {
 310         u16 vsi_id;
 311         u16 flags;
 312 };
 313
 314 #define I40E_FLAG_VF_UNICAST_PROMISC    0x00000001
 315 #define I40E_FLAG_VF_MULTICAST_PROMISC  0x00000002
 316
 317 /* I40E_VIRTCHNL_OP_GET_STATS
 318  * VF sends this message to request stats for the selected VSI. VF uses
 319  * the i40e_virtchnl_queue_select struct to specify the VSI. The queue_id
 320  * field is ignored by the PF.
 321  *
 322  * PF replies with struct i40e_eth_stats in an external buffer.
 323  */
 324
 325 /* I40E_VIRTCHNL_OP_EVENT
 326  * PF sends this message to inform the VF driver of events that may affect it.
 327  * No direct response is expected from the VF, though it may generate other
 328  * messages in response to this one.
 329  */
 330 enum i40e_virtchnl_event_codes {
 331         I40E_VIRTCHNL_EVENT_UNKNOWN = 0,
 332         I40E_VIRTCHNL_EVENT_LINK_CHANGE,
 333         I40E_VIRTCHNL_EVENT_RESET_IMPENDING,
 334         I40E_VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
 335 };
 336 #define I40E_PF_EVENT_SEVERITY_INFO             0
 337 #define I40E_PF_EVENT_SEVERITY_ATTENTION        1
 338 #define I40E_PF_EVENT_SEVERITY_ACTION_REQUIRED  2
 339 #define I40E_PF_EVENT_SEVERITY_CERTAIN_DOOM     255
 340
 341 struct i40e_virtchnl_pf_event {
 342         enum i40e_virtchnl_event_codes event;
 343         union {
 344                 struct {
 345                         enum i40e_aq_link_speed link_speed;
 346                         bool link_status;
 347                 } link_event;
 348         } event_data;
 349
 350         int severity;
 351 };
 352
 353 /* VF reset states - these are written into the RSTAT register:
 354  * I40E_VFGEN_RSTAT1 on the PF
 355  * I40E_VFGEN_RSTAT on the VF
 356  * When the PF initiates a reset, it writes 0
 357  * When the reset is complete, it writes 1
 358  * When the PF detects that the VF has recovered, it writes 2
 359  * VF checks this register periodically to determine if a reset has occurred,
 360  * then polls it to know when the reset is complete.
 361  * If either the PF or VF reads the register while the hardware
 362  * is in a reset state, it will return DEADBEEF, which, when masked
 363  * will result in 3.
 364  */
 365 enum i40e_vfr_states {
 366         I40E_VFR_INPROGRESS = 0,
 367         I40E_VFR_COMPLETED,
 368         I40E_VFR_VFACTIVE,
 369         I40E_VFR_UNKNOWN,
 370 };
 371
 372 #endif /* _I40E_VIRTCHNL_H_ */