Loading...
Note: File does not exist in v6.13.7.
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 */
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_CONFIG_RSS_KEY = 23,
85 I40E_VIRTCHNL_OP_CONFIG_RSS_LUT = 24,
86 I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS = 25,
87 I40E_VIRTCHNL_OP_SET_RSS_HENA = 26,
88
89};
90
91/* Virtual channel message descriptor. This overlays the admin queue
92 * descriptor. All other data is passed in external buffers.
93 */
94
95struct i40e_virtchnl_msg {
96 u8 pad[8]; /* AQ flags/opcode/len/retval fields */
97 enum i40e_virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
98 i40e_status v_retval; /* ditto for desc->retval */
99 u32 vfid; /* used by PF when sending to VF */
100};
101
102/* Message descriptions and data structures.*/
103
104/* I40E_VIRTCHNL_OP_VERSION
105 * VF posts its version number to the PF. PF responds with its version number
106 * in the same format, along with a return code.
107 * Reply from PF has its major/minor versions also in param0 and param1.
108 * If there is a major version mismatch, then the VF cannot operate.
109 * If there is a minor version mismatch, then the VF can operate but should
110 * add a warning to the system log.
111 *
112 * This enum element MUST always be specified as == 1, regardless of other
113 * changes in the API. The PF must always respond to this message without
114 * error regardless of version mismatch.
115 */
116#define I40E_VIRTCHNL_VERSION_MAJOR 1
117#define I40E_VIRTCHNL_VERSION_MINOR 1
118#define I40E_VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0
119
120struct i40e_virtchnl_version_info {
121 u32 major;
122 u32 minor;
123};
124
125/* I40E_VIRTCHNL_OP_RESET_VF
126 * VF sends this request to PF with no parameters
127 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
128 * until reset completion is indicated. The admin queue must be reinitialized
129 * after this operation.
130 *
131 * When reset is complete, PF must ensure that all queues in all VSIs associated
132 * with the VF are stopped, all queue configurations in the HMC are set to 0,
133 * and all MAC and VLAN filters (except the default MAC address) on all VSIs
134 * are cleared.
135 */
136
137/* I40E_VIRTCHNL_OP_GET_VF_RESOURCES
138 * Version 1.0 VF sends this request to PF with no parameters
139 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
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
145struct 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[ETH_ALEN];
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_RSS_AQ 0x00000008
157#define I40E_VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010
158#define I40E_VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020
159#define I40E_VIRTCHNL_VF_OFFLOAD_VLAN 0x00010000
160#define I40E_VIRTCHNL_VF_OFFLOAD_RX_POLLING 0x00020000
161#define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PCTYPE_V2 0x00040000
162#define I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF 0X00080000
163#define I40E_VIRTCHNL_VF_OFFLOAD_ENCAP_CSUM 0X00100000
164
165#define I40E_VF_BASE_MODE_OFFLOADS (I40E_VIRTCHNL_VF_OFFLOAD_L2 | \
166 I40E_VIRTCHNL_VF_OFFLOAD_VLAN | \
167 I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF)
168
169struct i40e_virtchnl_vf_resource {
170 u16 num_vsis;
171 u16 num_queue_pairs;
172 u16 max_vectors;
173 u16 max_mtu;
174
175 u32 vf_offload_flags;
176 u32 rss_key_size;
177 u32 rss_lut_size;
178
179 struct i40e_virtchnl_vsi_resource vsi_res[1];
180};
181
182/* I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE
183 * VF sends this message to set up parameters for one TX queue.
184 * External data buffer contains one instance of i40e_virtchnl_txq_info.
185 * PF configures requested queue and returns a status code.
186 */
187
188/* Tx queue config info */
189struct i40e_virtchnl_txq_info {
190 u16 vsi_id;
191 u16 queue_id;
192 u16 ring_len; /* number of descriptors, multiple of 8 */
193 u16 headwb_enabled;
194 u64 dma_ring_addr;
195 u64 dma_headwb_addr;
196};
197
198/* I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE
199 * VF sends this message to set up parameters for one RX queue.
200 * External data buffer contains one instance of i40e_virtchnl_rxq_info.
201 * PF configures requested queue and returns a status code.
202 */
203
204/* Rx queue config info */
205struct i40e_virtchnl_rxq_info {
206 u16 vsi_id;
207 u16 queue_id;
208 u32 ring_len; /* number of descriptors, multiple of 32 */
209 u16 hdr_size;
210 u16 splithdr_enabled;
211 u32 databuffer_size;
212 u32 max_pkt_size;
213 u64 dma_ring_addr;
214 enum i40e_hmc_obj_rx_hsplit_0 rx_split_pos;
215};
216
217/* I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES
218 * VF sends this message to set parameters for all active TX and RX queues
219 * associated with the specified VSI.
220 * PF configures queues and returns status.
221 * If the number of queues specified is greater than the number of queues
222 * associated with the VSI, an error is returned and no queues are configured.
223 */
224struct i40e_virtchnl_queue_pair_info {
225 /* NOTE: vsi_id and queue_id should be identical for both queues. */
226 struct i40e_virtchnl_txq_info txq;
227 struct i40e_virtchnl_rxq_info rxq;
228};
229
230struct i40e_virtchnl_vsi_queue_config_info {
231 u16 vsi_id;
232 u16 num_queue_pairs;
233 struct i40e_virtchnl_queue_pair_info qpair[1];
234};
235
236/* I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP
237 * VF uses this message to map vectors to queues.
238 * The rxq_map and txq_map fields are bitmaps used to indicate which queues
239 * are to be associated with the specified vector.
240 * The "other" causes are always mapped to vector 0.
241 * PF configures interrupt mapping and returns status.
242 */
243struct i40e_virtchnl_vector_map {
244 u16 vsi_id;
245 u16 vector_id;
246 u16 rxq_map;
247 u16 txq_map;
248 u16 rxitr_idx;
249 u16 txitr_idx;
250};
251
252struct i40e_virtchnl_irq_map_info {
253 u16 num_vectors;
254 struct i40e_virtchnl_vector_map vecmap[1];
255};
256
257/* I40E_VIRTCHNL_OP_ENABLE_QUEUES
258 * I40E_VIRTCHNL_OP_DISABLE_QUEUES
259 * VF sends these message to enable or disable TX/RX queue pairs.
260 * The queues fields are bitmaps indicating which queues to act upon.
261 * (Currently, we only support 16 queues per VF, but we make the field
262 * u32 to allow for expansion.)
263 * PF performs requested action and returns status.
264 */
265struct i40e_virtchnl_queue_select {
266 u16 vsi_id;
267 u16 pad;
268 u32 rx_queues;
269 u32 tx_queues;
270};
271
272/* I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS
273 * VF sends this message in order to add one or more unicast or multicast
274 * address filters for the specified VSI.
275 * PF adds the filters and returns status.
276 */
277
278/* I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS
279 * VF sends this message in order to remove one or more unicast or multicast
280 * filters for the specified VSI.
281 * PF removes the filters and returns status.
282 */
283
284struct i40e_virtchnl_ether_addr {
285 u8 addr[ETH_ALEN];
286 u8 pad[2];
287};
288
289struct i40e_virtchnl_ether_addr_list {
290 u16 vsi_id;
291 u16 num_elements;
292 struct i40e_virtchnl_ether_addr list[1];
293};
294
295/* I40E_VIRTCHNL_OP_ADD_VLAN
296 * VF sends this message to add one or more VLAN tag filters for receives.
297 * PF adds the filters and returns status.
298 * If a port VLAN is configured by the PF, this operation will return an
299 * error to the VF.
300 */
301
302/* I40E_VIRTCHNL_OP_DEL_VLAN
303 * VF sends this message to remove one or more VLAN tag filters for receives.
304 * PF removes the filters and returns status.
305 * If a port VLAN is configured by the PF, this operation will return an
306 * error to the VF.
307 */
308
309struct i40e_virtchnl_vlan_filter_list {
310 u16 vsi_id;
311 u16 num_elements;
312 u16 vlan_id[1];
313};
314
315/* I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
316 * VF sends VSI id and flags.
317 * PF returns status code in retval.
318 * Note: we assume that broadcast accept mode is always enabled.
319 */
320struct i40e_virtchnl_promisc_info {
321 u16 vsi_id;
322 u16 flags;
323};
324
325#define I40E_FLAG_VF_UNICAST_PROMISC 0x00000001
326#define I40E_FLAG_VF_MULTICAST_PROMISC 0x00000002
327
328/* I40E_VIRTCHNL_OP_GET_STATS
329 * VF sends this message to request stats for the selected VSI. VF uses
330 * the i40e_virtchnl_queue_select struct to specify the VSI. The queue_id
331 * field is ignored by the PF.
332 *
333 * PF replies with struct i40e_eth_stats in an external buffer.
334 */
335
336/* I40E_VIRTCHNL_OP_CONFIG_RSS_KEY
337 * I40E_VIRTCHNL_OP_CONFIG_RSS_LUT
338 * VF sends these messages to configure RSS. Only supported if both PF
339 * and VF drivers set the I40E_VIRTCHNL_VF_OFFLOAD_RSS_PF bit during
340 * configuration negotiation. If this is the case, then the RSS fields in
341 * the VF resource struct are valid.
342 * Both the key and LUT are initialized to 0 by the PF, meaning that
343 * RSS is effectively disabled until set up by the VF.
344 */
345struct i40e_virtchnl_rss_key {
346 u16 vsi_id;
347 u16 key_len;
348 u8 key[1]; /* RSS hash key, packed bytes */
349};
350
351struct i40e_virtchnl_rss_lut {
352 u16 vsi_id;
353 u16 lut_entries;
354 u8 lut[1]; /* RSS lookup table*/
355};
356
357/* I40E_VIRTCHNL_OP_GET_RSS_HENA_CAPS
358 * I40E_VIRTCHNL_OP_SET_RSS_HENA
359 * VF sends these messages to get and set the hash filter enable bits for RSS.
360 * By default, the PF sets these to all possible traffic types that the
361 * hardware supports. The VF can query this value if it wants to change the
362 * traffic types that are hashed by the hardware.
363 * Traffic types are defined in the i40e_filter_pctype enum in i40e_type.h
364 */
365struct i40e_virtchnl_rss_hena {
366 u64 hena;
367};
368
369/* I40E_VIRTCHNL_OP_EVENT
370 * PF sends this message to inform the VF driver of events that may affect it.
371 * No direct response is expected from the VF, though it may generate other
372 * messages in response to this one.
373 */
374enum i40e_virtchnl_event_codes {
375 I40E_VIRTCHNL_EVENT_UNKNOWN = 0,
376 I40E_VIRTCHNL_EVENT_LINK_CHANGE,
377 I40E_VIRTCHNL_EVENT_RESET_IMPENDING,
378 I40E_VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
379};
380#define I40E_PF_EVENT_SEVERITY_INFO 0
381#define I40E_PF_EVENT_SEVERITY_CERTAIN_DOOM 255
382
383struct i40e_virtchnl_pf_event {
384 enum i40e_virtchnl_event_codes event;
385 union {
386 struct {
387 enum i40e_aq_link_speed link_speed;
388 bool link_status;
389 } link_event;
390 } event_data;
391
392 int severity;
393};
394
395/* VF reset states - these are written into the RSTAT register:
396 * I40E_VFGEN_RSTAT1 on the PF
397 * I40E_VFGEN_RSTAT on the VF
398 * When the PF initiates a reset, it writes 0
399 * When the reset is complete, it writes 1
400 * When the PF detects that the VF has recovered, it writes 2
401 * VF checks this register periodically to determine if a reset has occurred,
402 * then polls it to know when the reset is complete.
403 * If either the PF or VF reads the register while the hardware
404 * is in a reset state, it will return DEADBEEF, which, when masked
405 * will result in 3.
406 */
407enum i40e_vfr_states {
408 I40E_VFR_INPROGRESS = 0,
409 I40E_VFR_COMPLETED,
410 I40E_VFR_VFACTIVE,
411 I40E_VFR_UNKNOWN,
412};
413
414#endif /* _I40E_VIRTCHNL_H_ */