1/*******************************************************************************
  2 *
  3 * Intel Ethernet Controller XL710 Family Linux 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 */
 61enum 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, /* must ALWAYS be 17 */
 84	I40E_VIRTCHNL_OP_IWARP = 20,
 85	I40E_VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP = 21,
 86	I40E_VIRTCHNL_OP_RELEASE_IWARP_IRQ_MAP = 22,
 87	I40E_VIRTCHNL_OP_CONFIG_RSS_KEY = 23,
 88	I40E_VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
 89	I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
 90	I40E_VIRTCHNL_OP_SET_RSS_HENA = 26,
 91
 92};
 93
 94/* Virtual channel message descriptor. This overlays the admin queue
 95 * descriptor. All other data is passed in external buffers.
 96 */
 97
 98struct 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	i40e_status 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		1
121#define I40E_VIRTCHNL_VERSION_MINOR_NO_VF_CAPS	0
122
123struct i40e_virtchnl_version_info {
124	u32 major;
125	u32 minor;
126};
127
128/* I40E_VIRTCHNL_OP_RESET_VF
129 * VF sends this request to PF with no parameters
130 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
131 * until reset completion is indicated. The admin queue must be reinitialized
132 * after this operation.
133 *
134 * When reset is complete, PF must ensure that all queues in all VSIs associated
135 * with the VF are stopped, all queue configurations in the HMC are set to 0,
136 * and all MAC and VLAN filters (except the default MAC address) on all VSIs
137 * are cleared.
138 */
139
140/* I40E_VIRTCHNL_OP_GET_VF_RESOURCES
141 * Version 1.0 VF sends this request to PF with no parameters
142 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
143 * PF responds with an indirect message containing
144 * i40e_virtchnl_vf_resource and one or more
145 * i40e_virtchnl_vsi_resource structures.
146 */
147
148struct i40e_virtchnl_vsi_resource {
149	u16 vsi_id;
150	u16 num_queue_pairs;
151	enum i40e_vsi_type vsi_type;
152	u16 qset_handle;
153	u8 default_mac_addr[ETH_ALEN];
154};
155/* VF offload flags */
156#define I40E_VIRTCHNL_VF_OFFLOAD_L2		0x00000001
157#define I40E_VIRTCHNL_VF_OFFLOAD_IWARP		0x00000002
158#define I40E_VIRTCHNL_VF_OFFLOAD_FCOE		0x00000004
159#define I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ		0x00000008
160#define I40E_VIRTCHNL_VF_OFFLOAD_RSS_REG	0x00000010
161#define I40E_VIRTCHNL_VF_OFFLOAD_WB_ON_ITR	0x00000020
162#define I40E_VIRTCHNL_VF_OFFLOAD_VLAN		0x00010000
163#define I40E_VIRTCHNL_VF_OFFLOAD_RX_POLLING	0x00020000
164#define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2	0x00040000
165#define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF		0X00080000
166#define I40E_VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM	0X00100000
167
168#define I40E_VF_BASE_MODE_OFFLOADS (I40E_VIRTCHNL_VF_OFFLOAD_L2 | \
169				    I40E_VIRTCHNL_VF_OFFLOAD_VLAN | \
170				    I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF)
171
172struct i40e_virtchnl_vf_resource {
173	u16 num_vsis;
174	u16 num_queue_pairs;
175	u16 max_vectors;
176	u16 max_mtu;
177
178	u32 vf_offload_flags;
179	u32 rss_key_size;
180	u32 rss_lut_size;
181
182	struct i40e_virtchnl_vsi_resource vsi_res[1];
183};
184
185/* I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE
186 * VF sends this message to set up parameters for one TX queue.
187 * External data buffer contains one instance of i40e_virtchnl_txq_info.
188 * PF configures requested queue and returns a status code.
189 */
190
191/* Tx queue config info */
192struct i40e_virtchnl_txq_info {
193	u16 vsi_id;
194	u16 queue_id;
195	u16 ring_len;		/* number of descriptors, multiple of 8 */
196	u16 headwb_enabled;
197	u64 dma_ring_addr;
198	u64 dma_headwb_addr;
199};
200
201/* I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE
202 * VF sends this message to set up parameters for one RX queue.
203 * External data buffer contains one instance of i40e_virtchnl_rxq_info.
204 * PF configures requested queue and returns a status code.
205 */
206
207/* Rx queue config info */
208struct i40e_virtchnl_rxq_info {
209	u16 vsi_id;
210	u16 queue_id;
211	u32 ring_len;		/* number of descriptors, multiple of 32 */
212	u16 hdr_size;
213	u16 splithdr_enabled;
214	u32 databuffer_size;
215	u32 max_pkt_size;
216	u64 dma_ring_addr;
217	enum i40e_hmc_obj_rx_hsplit_0 rx_split_pos;
218};
219
220/* I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES
221 * VF sends this message to set parameters for all active TX and RX queues
222 * associated with the specified VSI.
223 * PF configures queues and returns status.
224 * If the number of queues specified is greater than the number of queues
225 * associated with the VSI, an error is returned and no queues are configured.
226 */
227struct i40e_virtchnl_queue_pair_info {
228	/* NOTE: vsi_id and queue_id should be identical for both queues. */
229	struct i40e_virtchnl_txq_info txq;
230	struct i40e_virtchnl_rxq_info rxq;
231};
232
233struct i40e_virtchnl_vsi_queue_config_info {
234	u16 vsi_id;
235	u16 num_queue_pairs;
236	struct i40e_virtchnl_queue_pair_info qpair[1];
237};
238
239/* I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP
240 * VF uses this message to map vectors to queues.
241 * The rxq_map and txq_map fields are bitmaps used to indicate which queues
242 * are to be associated with the specified vector.
243 * The "other" causes are always mapped to vector 0.
244 * PF configures interrupt mapping and returns status.
245 */
246struct i40e_virtchnl_vector_map {
247	u16 vsi_id;
248	u16 vector_id;
249	u16 rxq_map;
250	u16 txq_map;
251	u16 rxitr_idx;
252	u16 txitr_idx;
253};
254
255struct i40e_virtchnl_irq_map_info {
256	u16 num_vectors;
257	struct i40e_virtchnl_vector_map vecmap[1];
258};
259
260/* I40E_VIRTCHNL_OP_ENABLE_QUEUES
261 * I40E_VIRTCHNL_OP_DISABLE_QUEUES
262 * VF sends these message to enable or disable TX/RX queue pairs.
263 * The queues fields are bitmaps indicating which queues to act upon.
264 * (Currently, we only support 16 queues per VF, but we make the field
265 * u32 to allow for expansion.)
266 * PF performs requested action and returns status.
267 */
268struct i40e_virtchnl_queue_select {
269	u16 vsi_id;
270	u16 pad;
271	u32 rx_queues;
272	u32 tx_queues;
273};
274
275/* I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS
276 * VF sends this message in order to add one or more unicast or multicast
277 * address filters for the specified VSI.
278 * PF adds the filters and returns status.
279 */
280
281/* I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS
282 * VF sends this message in order to remove one or more unicast or multicast
283 * filters for the specified VSI.
284 * PF removes the filters and returns status.
285 */
286
287struct i40e_virtchnl_ether_addr {
288	u8 addr[ETH_ALEN];
289	u8 pad[2];
290};
291
292struct i40e_virtchnl_ether_addr_list {
293	u16 vsi_id;
294	u16 num_elements;
295	struct i40e_virtchnl_ether_addr list[1];
296};
297
298/* I40E_VIRTCHNL_OP_ADD_VLAN
299 * VF sends this message to add one or more VLAN tag filters for receives.
300 * PF adds the filters and returns status.
301 * If a port VLAN is configured by the PF, this operation will return an
302 * error to the VF.
303 */
304
305/* I40E_VIRTCHNL_OP_DEL_VLAN
306 * VF sends this message to remove one or more VLAN tag filters for receives.
307 * PF removes the filters and returns status.
308 * If a port VLAN is configured by the PF, this operation will return an
309 * error to the VF.
310 */
311
312struct i40e_virtchnl_vlan_filter_list {
313	u16 vsi_id;
314	u16 num_elements;
315	u16 vlan_id[1];
316};
317
318/* I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
319 * VF sends VSI id and flags.
320 * PF returns status code in retval.
321 * Note: we assume that broadcast accept mode is always enabled.
322 */
323struct i40e_virtchnl_promisc_info {
324	u16 vsi_id;
325	u16 flags;
326};
327
328#define I40E_FLAG_VF_UNICAST_PROMISC	0x00000001
329#define I40E_FLAG_VF_MULTICAST_PROMISC	0x00000002
330
331/* I40E_VIRTCHNL_OP_GET_STATS
332 * VF sends this message to request stats for the selected VSI. VF uses
333 * the i40e_virtchnl_queue_select struct to specify the VSI. The queue_id
334 * field is ignored by the PF.
335 *
336 * PF replies with struct i40e_eth_stats in an external buffer.
337 */
338
339/* I40E_VIRTCHNL_OP_CONFIG_RSS_KEY
340 * I40E_VIRTCHNL_OP_CONFIG_RSS_LUT
341 * VF sends these messages to configure RSS. Only supported if both PF
342 * and VF drivers set the I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
343 * configuration negotiation. If this is the case, then the RSS fields in
344 * the VF resource struct are valid.
345 * Both the key and LUT are initialized to 0 by the PF, meaning that
346 * RSS is effectively disabled until set up by the VF.
347 */
348struct i40e_virtchnl_rss_key {
349	u16 vsi_id;
350	u16 key_len;
351	u8 key[1];         /* RSS hash key, packed bytes */
352};
353
354struct i40e_virtchnl_rss_lut {
355	u16 vsi_id;
356	u16 lut_entries;
357	u8 lut[1];        /* RSS lookup table*/
358};
359
360/* I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS
361 * I40E_VIRTCHNL_OP_SET_RSS_HENA
362 * VF sends these messages to get and set the hash filter enable bits for RSS.
363 * By default, the PF sets these to all possible traffic types that the
364 * hardware supports. The VF can query this value if it wants to change the
365 * traffic types that are hashed by the hardware.
366 * Traffic types are defined in the i40e_filter_pctype enum in i40e_type.h
367 */
368struct i40e_virtchnl_rss_hena {
369	u64 hena;
370};
371
372/* I40E_VIRTCHNL_OP_EVENT
373 * PF sends this message to inform the VF driver of events that may affect it.
374 * No direct response is expected from the VF, though it may generate other
375 * messages in response to this one.
376 */
377enum i40e_virtchnl_event_codes {
378	I40E_VIRTCHNL_EVENT_UNKNOWN = 0,
379	I40E_VIRTCHNL_EVENT_LINK_CHANGE,
380	I40E_VIRTCHNL_EVENT_RESET_IMPENDING,
381	I40E_VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
382};
383#define I40E_PF_EVENT_SEVERITY_INFO		0
384#define I40E_PF_EVENT_SEVERITY_CERTAIN_DOOM	255
385
386struct i40e_virtchnl_pf_event {
387	enum i40e_virtchnl_event_codes event;
388	union {
389		struct {
390			enum i40e_aq_link_speed link_speed;
391			bool link_status;
392		} link_event;
393	} event_data;
394
395	int severity;
396};
397
398/* I40E_VIRTCHNL_OP_CONFIG_IWARP_IRQ_MAP
399 * VF uses this message to request PF to map IWARP vectors to IWARP queues.
400 * The request for this originates from the VF IWARP driver through
401 * a client interface between VF LAN and VF IWARP driver.
402 * A vector could have an AEQ and CEQ attached to it although
403 * there is a single AEQ per VF IWARP instance in which case
404 * most vectors will have an INVALID_IDX for aeq and valid idx for ceq.
405 * There will never be a case where there will be multiple CEQs attached
406 * to a single vector.
407 * PF configures interrupt mapping and returns status.
408 */
409
410/* HW does not define a type value for AEQ; only for RX/TX and CEQ.
411 * In order for us to keep the interface simple, SW will define a
412 * unique type value for AEQ.
413*/
414#define I40E_QUEUE_TYPE_PE_AEQ  0x80
415#define I40E_QUEUE_INVALID_IDX  0xFFFF
416
417struct i40e_virtchnl_iwarp_qv_info {
418	u32 v_idx; /* msix_vector */
419	u16 ceq_idx;
420	u16 aeq_idx;
421	u8 itr_idx;
422};
423
424struct i40e_virtchnl_iwarp_qvlist_info {
425	u32 num_vectors;
426	struct i40e_virtchnl_iwarp_qv_info qv_info[1];
427};
428
429/* VF reset states - these are written into the RSTAT register:
430 * I40E_VFGEN_RSTAT1 on the PF
431 * I40E_VFGEN_RSTAT on the VF
432 * When the PF initiates a reset, it writes 0
433 * When the reset is complete, it writes 1
434 * When the PF detects that the VF has recovered, it writes 2
435 * VF checks this register periodically to determine if a reset has occurred,
436 * then polls it to know when the reset is complete.
437 * If either the PF or VF reads the register while the hardware
438 * is in a reset state, it will return DEADBEEF, which, when masked
439 * will result in 3.
440 */
441enum i40e_vfr_states {
442	I40E_VFR_INPROGRESS = 0,
443	I40E_VFR_COMPLETED,
444	I40E_VFR_VFACTIVE,
445	I40E_VFR_UNKNOWN,
446};
447
448#endif /* _I40E_VIRTCHNL_H_ */