drivers/net/ethernet/intel/i40evf/i40e_virtchnl.h

   1 /*******************************************************************************
   2  *
   3  * Intel Ethernet Controller XL710 Family Linux Virtual Function Driver
   4  * Copyright(c) 2013 - 2014 Intel Corporation.
   5  *
   6  * This program is free software; you can redistribute it and/or modify it
   7  * under the terms and conditions of the GNU General Public License,
   8  * version 2, as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope it will be useful, but WITHOUT
  11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13  * more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  * The full GNU General Public License is included in this distribution in
  19  * the file called "COPYING".
  20  *
  21  * Contact Information:
  22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  24  *
  25  ******************************************************************************/
  26
  27 #ifndef _I40E_VIRTCHNL_H_
  28 #define _I40E_VIRTCHNL_H_
  29
  30 #include "i40e_type.h"
  31
  32 /* Description:
  33  * This header file describes the VF-PF communication protocol used
  34  * by the various i40e drivers.
  35  *
  36  * Admin queue buffer usage:
  37  * desc->opcode is always i40e_aqc_opc_send_msg_to_pf
  38  * flags, retval, datalen, and data addr are all used normally.
  39  * Firmware copies the cookie fields when sending messages between the PF and
  40  * VF, but uses all other fields internally. Due to this limitation, we
  41  * must send all messages as "indirect", i.e. using an external buffer.
  42  *
  43  * All the vsi indexes are relative to the VF. Each VF can have maximum of
  44  * three VSIs. All the queue indexes are relative to the VSI.  Each VF can
  45  * have a maximum of sixteen queues for all of its VSIs.
  46  *
  47  * The PF is required to return a status code in v_retval for all messages
  48  * except RESET_VF, which does not require any response. The return value is of
  49  * i40e_status_code type, defined in the i40e_type.h.
  50  *
  51  * In general, VF driver initialization should roughly follow the order of these
  52  * opcodes. The VF driver must first validate the API version of the PF driver,
  53  * then request a reset, then get resources, then configure queues and
  54  * interrupts. After these operations are complete, the VF driver may start
  55  * its queues, optionally add MAC and VLAN filters, and process traffic.
  56  */
  57
  58 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
  59  * of the virtchnl_msg structure.
  60  */
  61 enum i40e_virtchnl_ops {
  62 /* The PF sends status change events to VFs using
  63  * the I40E_VIRTCHNL_OP_EVENT opcode.
  64  * VFs send requests to the PF using the other ops.
  65  */
  66         I40E_VIRTCHNL_OP_UNKNOWN = 0,
  67         I40E_VIRTCHNL_OP_VERSION = 1, /* must ALWAYS be 1 */
  68         I40E_VIRTCHNL_OP_RESET_VF = 2,
  69         I40E_VIRTCHNL_OP_GET_VF_RESOURCES = 3,
  70         I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE = 4,
  71         I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE = 5,
  72         I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES = 6,
  73         I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP = 7,
  74         I40E_VIRTCHNL_OP_ENABLE_QUEUES = 8,
  75         I40E_VIRTCHNL_OP_DISABLE_QUEUES = 9,
  76         I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS = 10,
  77         I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS = 11,
  78         I40E_VIRTCHNL_OP_ADD_VLAN = 12,
  79         I40E_VIRTCHNL_OP_DEL_VLAN = 13,
  80         I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE = 14,
  81         I40E_VIRTCHNL_OP_GET_STATS = 15,
  82         I40E_VIRTCHNL_OP_FCOE = 16,
  83         I40E_VIRTCHNL_OP_EVENT = 17,
  84 };
  85
  86 /* Virtual channel message descriptor. This overlays the admin queue
  87  * descriptor. All other data is passed in external buffers.
  88  */
  89
  90 struct i40e_virtchnl_msg {
  91         u8 pad[8];                       /* AQ flags/opcode/len/retval fields */
  92         enum i40e_virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
  93         i40e_status v_retval;  /* ditto for desc->retval */
  94         u32 vfid;                        /* used by PF when sending to VF */
  95 };
  96
  97 /* Message descriptions and data structures.*/
  98
  99 /* I40E_VIRTCHNL_OP_VERSION
 100  * VF posts its version number to the PF. PF responds with its version number
 101  * in the same format, along with a return code.
 102  * Reply from PF has its major/minor versions also in param0 and param1.
 103  * If there is a major version mismatch, then the VF cannot operate.
 104  * If there is a minor version mismatch, then the VF can operate but should
 105  * add a warning to the system log.
 106  *
 107  * This enum element MUST always be specified as == 1, regardless of other
 108  * changes in the API. The PF must always respond to this message without
 109  * error regardless of version mismatch.
 110  */
 111 #define I40E_VIRTCHNL_VERSION_MAJOR             1
 112 #define I40E_VIRTCHNL_VERSION_MINOR             1
 113 #define I40E_VIRTCHNL_VERSION_MINOR_NO_VF_CAPS  0
 114
 115 struct i40e_virtchnl_version_info {
 116         u32 major;
 117         u32 minor;
 118 };
 119
 120 /* I40E_VIRTCHNL_OP_RESET_VF
 121  * VF sends this request to PF with no parameters
 122  * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
 123  * until reset completion is indicated. The admin queue must be reinitialized
 124  * after this operation.
 125  *
 126  * When reset is complete, PF must ensure that all queues in all VSIs associated
 127  * with the VF are stopped, all queue configurations in the HMC are set to 0,
 128  * and all MAC and VLAN filters (except the default MAC address) on all VSIs
 129  * are cleared.
 130  */
 131
 132 /* I40E_VIRTCHNL_OP_GET_VF_RESOURCES
 133  * Version 1.0 VF sends this request to PF with no parameters
 134  * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
 135  * PF responds with an indirect message containing
 136  * i40e_virtchnl_vf_resource and one or more
 137  * i40e_virtchnl_vsi_resource structures.
 138  */
 139
 140 struct i40e_virtchnl_vsi_resource {
 141         u16 vsi_id;
 142         u16 num_queue_pairs;
 143         enum i40e_vsi_type vsi_type;
 144         u16 qset_handle;
 145         u8 default_mac_addr[ETH_ALEN];
 146 };
 147 /* VF offload flags */
 148 #define I40E_VIRTCHNL_VF_OFFLOAD_L2             0x00000001
 149 #define I40E_VIRTCHNL_VF_OFFLOAD_IWARP          0x00000002
 150 #define I40E_VIRTCHNL_VF_OFFLOAD_FCOE           0x00000004
 151 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ         0x00000008
 152 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_REG        0x00000010
 153 #define I40E_VIRTCHNL_VF_OFFLOAD_WB_ON_ITR      0x00000020
 154 #define I40E_VIRTCHNL_VF_OFFLOAD_VLAN           0x00010000
 155 #define I40E_VIRTCHNL_VF_OFFLOAD_RX_POLLING     0x00020000
 156
 157 struct i40e_virtchnl_vf_resource {
 158         u16 num_vsis;
 159         u16 num_queue_pairs;
 160         u16 max_vectors;
 161         u16 max_mtu;
 162
 163         u32 vf_offload_flags;
 164         u32 max_fcoe_contexts;
 165         u32 max_fcoe_filters;
 166
 167         struct i40e_virtchnl_vsi_resource vsi_res[1];
 168 };
 169
 170 /* I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE
 171  * VF sends this message to set up parameters for one TX queue.
 172  * External data buffer contains one instance of i40e_virtchnl_txq_info.
 173  * PF configures requested queue and returns a status code.
 174  */
 175
 176 /* Tx queue config info */
 177 struct i40e_virtchnl_txq_info {
 178         u16 vsi_id;
 179         u16 queue_id;
 180         u16 ring_len;           /* number of descriptors, multiple of 8 */
 181         u16 headwb_enabled;
 182         u64 dma_ring_addr;
 183         u64 dma_headwb_addr;
 184 };
 185
 186 /* I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE
 187  * VF sends this message to set up parameters for one RX queue.
 188  * External data buffer contains one instance of i40e_virtchnl_rxq_info.
 189  * PF configures requested queue and returns a status code.
 190  */
 191
 192 /* Rx queue config info */
 193 struct i40e_virtchnl_rxq_info {
 194         u16 vsi_id;
 195         u16 queue_id;
 196         u32 ring_len;           /* number of descriptors, multiple of 32 */
 197         u16 hdr_size;
 198         u16 splithdr_enabled;
 199         u32 databuffer_size;
 200         u32 max_pkt_size;
 201         u64 dma_ring_addr;
 202         enum i40e_hmc_obj_rx_hsplit_0 rx_split_pos;
 203 };
 204
 205 /* I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES
 206  * VF sends this message to set parameters for all active TX and RX queues
 207  * associated with the specified VSI.
 208  * PF configures queues and returns status.
 209  * If the number of queues specified is greater than the number of queues
 210  * associated with the VSI, an error is returned and no queues are configured.
 211  */
 212 struct i40e_virtchnl_queue_pair_info {
 213         /* NOTE: vsi_id and queue_id should be identical for both queues. */
 214         struct i40e_virtchnl_txq_info txq;
 215         struct i40e_virtchnl_rxq_info rxq;
 216 };
 217
 218 struct i40e_virtchnl_vsi_queue_config_info {
 219         u16 vsi_id;
 220         u16 num_queue_pairs;
 221         struct i40e_virtchnl_queue_pair_info qpair[1];
 222 };
 223
 224 /* I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP
 225  * VF uses this message to map vectors to queues.
 226  * The rxq_map and txq_map fields are bitmaps used to indicate which queues
 227  * are to be associated with the specified vector.
 228  * The "other" causes are always mapped to vector 0.
 229  * PF configures interrupt mapping and returns status.
 230  */
 231 struct i40e_virtchnl_vector_map {
 232         u16 vsi_id;
 233         u16 vector_id;
 234         u16 rxq_map;
 235         u16 txq_map;
 236         u16 rxitr_idx;
 237         u16 txitr_idx;
 238 };
 239
 240 struct i40e_virtchnl_irq_map_info {
 241         u16 num_vectors;
 242         struct i40e_virtchnl_vector_map vecmap[1];
 243 };
 244
 245 /* I40E_VIRTCHNL_OP_ENABLE_QUEUES
 246  * I40E_VIRTCHNL_OP_DISABLE_QUEUES
 247  * VF sends these message to enable or disable TX/RX queue pairs.
 248  * The queues fields are bitmaps indicating which queues to act upon.
 249  * (Currently, we only support 16 queues per VF, but we make the field
 250  * u32 to allow for expansion.)
 251  * PF performs requested action and returns status.
 252  */
 253 struct i40e_virtchnl_queue_select {
 254         u16 vsi_id;
 255         u16 pad;
 256         u32 rx_queues;
 257         u32 tx_queues;
 258 };
 259
 260 /* I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS
 261  * VF sends this message in order to add one or more unicast or multicast
 262  * address filters for the specified VSI.
 263  * PF adds the filters and returns status.
 264  */
 265
 266 /* I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS
 267  * VF sends this message in order to remove one or more unicast or multicast
 268  * filters for the specified VSI.
 269  * PF removes the filters and returns status.
 270  */
 271
 272 struct i40e_virtchnl_ether_addr {
 273         u8 addr[ETH_ALEN];
 274         u8 pad[2];
 275 };
 276
 277 struct i40e_virtchnl_ether_addr_list {
 278         u16 vsi_id;
 279         u16 num_elements;
 280         struct i40e_virtchnl_ether_addr list[1];
 281 };
 282
 283 /* I40E_VIRTCHNL_OP_ADD_VLAN
 284  * VF sends this message to add one or more VLAN tag filters for receives.
 285  * PF adds the filters and returns status.
 286  * If a port VLAN is configured by the PF, this operation will return an
 287  * error to the VF.
 288  */
 289
 290 /* I40E_VIRTCHNL_OP_DEL_VLAN
 291  * VF sends this message to remove one or more VLAN tag filters for receives.
 292  * PF removes the filters and returns status.
 293  * If a port VLAN is configured by the PF, this operation will return an
 294  * error to the VF.
 295  */
 296
 297 struct i40e_virtchnl_vlan_filter_list {
 298         u16 vsi_id;
 299         u16 num_elements;
 300         u16 vlan_id[1];
 301 };
 302
 303 /* I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
 304  * VF sends VSI id and flags.
 305  * PF returns status code in retval.
 306  * Note: we assume that broadcast accept mode is always enabled.
 307  */
 308 struct i40e_virtchnl_promisc_info {
 309         u16 vsi_id;
 310         u16 flags;
 311 };
 312
 313 #define I40E_FLAG_VF_UNICAST_PROMISC    0x00000001
 314 #define I40E_FLAG_VF_MULTICAST_PROMISC  0x00000002
 315
 316 /* I40E_VIRTCHNL_OP_GET_STATS
 317  * VF sends this message to request stats for the selected VSI. VF uses
 318  * the i40e_virtchnl_queue_select struct to specify the VSI. The queue_id
 319  * field is ignored by the PF.
 320  *
 321  * PF replies with struct i40e_eth_stats in an external buffer.
 322  */
 323
 324 /* I40E_VIRTCHNL_OP_EVENT
 325  * PF sends this message to inform the VF driver of events that may affect it.
 326  * No direct response is expected from the VF, though it may generate other
 327  * messages in response to this one.
 328  */
 329 enum i40e_virtchnl_event_codes {
 330         I40E_VIRTCHNL_EVENT_UNKNOWN = 0,
 331         I40E_VIRTCHNL_EVENT_LINK_CHANGE,
 332         I40E_VIRTCHNL_EVENT_RESET_IMPENDING,
 333         I40E_VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
 334 };
 335 #define I40E_PF_EVENT_SEVERITY_INFO             0
 336 #define I40E_PF_EVENT_SEVERITY_CERTAIN_DOOM     255
 337
 338 struct i40e_virtchnl_pf_event {
 339         enum i40e_virtchnl_event_codes event;
 340         union {
 341                 struct {
 342                         enum i40e_aq_link_speed link_speed;
 343                         bool link_status;
 344                 } link_event;
 345         } event_data;
 346
 347         int severity;
 348 };
 349
 350 /* VF reset states - these are written into the RSTAT register:
 351  * I40E_VFGEN_RSTAT1 on the PF
 352  * I40E_VFGEN_RSTAT on the VF
 353  * When the PF initiates a reset, it writes 0
 354  * When the reset is complete, it writes 1
 355  * When the PF detects that the VF has recovered, it writes 2
 356  * VF checks this register periodically to determine if a reset has occurred,
 357  * then polls it to know when the reset is complete.
 358  * If either the PF or VF reads the register while the hardware
 359  * is in a reset state, it will return DEADBEEF, which, when masked
 360  * will result in 3.
 361  */
 362 enum i40e_vfr_states {
 363         I40E_VFR_INPROGRESS = 0,
 364         I40E_VFR_COMPLETED,
 365         I40E_VFR_VFACTIVE,
 366         I40E_VFR_UNKNOWN,
 367 };
 368
 369 #endif /* _I40E_VIRTCHNL_H_ */