1 /*******************************************************************************
3 Copyright (c) 2013 - 2015, Intel Corporation
6 Redistribution and use in source and binary forms, with or without
7 modification, are permitted provided that the following conditions are met:
9 1. Redistributions of source code must retain the above copyright notice,
10 this list of conditions and the following disclaimer.
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.
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.
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.
32 ***************************************************************************/
34 #ifndef _I40E_VIRTCHNL_H_
35 #define _I40E_VIRTCHNL_H_
37 #include "i40e_type.h"
40 * This header file describes the VF-PF communication protocol used
41 * by the various i40e drivers.
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.
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.
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.
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.
65 /* Opcodes for VF-PF communication. These are placed in the v_opcode field
66 * of the virtchnl_msg structure.
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.
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 #ifdef I40E_SOL_VF_SUPPORT
92 I40E_VIRTCHNL_OP_GET_ADDNL_SOL_CONFIG = 19,
96 /* Virtual channel message descriptor. This overlays the admin queue
97 * descriptor. All other data is passed in external buffers.
100 struct i40e_virtchnl_msg {
101 u8 pad[8]; /* AQ flags/opcode/len/retval fields */
102 enum i40e_virtchnl_ops v_opcode; /* avoid confusion with desc->opcode */
103 enum i40e_status_code v_retval; /* ditto for desc->retval */
104 u32 vfid; /* used by PF when sending to VF */
107 /* Message descriptions and data structures.*/
109 /* I40E_VIRTCHNL_OP_VERSION
110 * VF posts its version number to the PF. PF responds with its version number
111 * in the same format, along with a return code.
112 * Reply from PF has its major/minor versions also in param0 and param1.
113 * If there is a major version mismatch, then the VF cannot operate.
114 * If there is a minor version mismatch, then the VF can operate but should
115 * add a warning to the system log.
117 * This enum element MUST always be specified as == 1, regardless of other
118 * changes in the API. The PF must always respond to this message without
119 * error regardless of version mismatch.
121 #define I40E_VIRTCHNL_VERSION_MAJOR 1
122 #define I40E_VIRTCHNL_VERSION_MINOR 1
123 #define I40E_VIRTCHNL_VERSION_MINOR_NO_VF_CAPS 0
125 struct i40e_virtchnl_version_info {
130 /* I40E_VIRTCHNL_OP_RESET_VF
131 * VF sends this request to PF with no parameters
132 * PF does NOT respond! VF driver must delay then poll VFGEN_RSTAT register
133 * until reset completion is indicated. The admin queue must be reinitialized
134 * after this operation.
136 * When reset is complete, PF must ensure that all queues in all VSIs associated
137 * with the VF are stopped, all queue configurations in the HMC are set to 0,
138 * and all MAC and VLAN filters (except the default MAC address) on all VSIs
142 /* I40E_VIRTCHNL_OP_GET_VF_RESOURCES
143 * Version 1.0 VF sends this request to PF with no parameters
144 * Version 1.1 VF sends this request to PF with u32 bitmap of its capabilities
145 * PF responds with an indirect message containing
146 * i40e_virtchnl_vf_resource and one or more
147 * i40e_virtchnl_vsi_resource structures.
150 struct i40e_virtchnl_vsi_resource {
153 enum i40e_vsi_type vsi_type;
155 u8 default_mac_addr[I40E_ETH_LENGTH_OF_ADDRESS];
157 /* VF offload flags */
158 #define I40E_VIRTCHNL_VF_OFFLOAD_L2 0x00000001
159 #define I40E_VIRTCHNL_VF_OFFLOAD_IWARP 0x00000002
160 #define I40E_VIRTCHNL_VF_OFFLOAD_FCOE 0x00000004
161 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_AQ 0x00000008
162 #define I40E_VIRTCHNL_VF_OFFLOAD_RSS_REG 0x00000010
163 #define I40E_VIRTCHNL_VF_OFFLOAD_WB_ON_ITR 0x00000020
164 #define I40E_VIRTCHNL_VF_OFFLOAD_VLAN 0x00010000
165 #define I40E_VIRTCHNL_VF_OFFLOAD_RX_POLLING 0x00020000
167 struct i40e_virtchnl_vf_resource {
173 u32 vf_offload_flags;
174 u32 max_fcoe_contexts;
175 u32 max_fcoe_filters;
177 struct i40e_virtchnl_vsi_resource vsi_res[1];
180 /* I40E_VIRTCHNL_OP_CONFIG_TX_QUEUE
181 * VF sends this message to set up parameters for one TX queue.
182 * External data buffer contains one instance of i40e_virtchnl_txq_info.
183 * PF configures requested queue and returns a status code.
186 /* Tx queue config info */
187 struct i40e_virtchnl_txq_info {
190 u16 ring_len; /* number of descriptors, multiple of 8 */
196 /* I40E_VIRTCHNL_OP_CONFIG_RX_QUEUE
197 * VF sends this message to set up parameters for one RX queue.
198 * External data buffer contains one instance of i40e_virtchnl_rxq_info.
199 * PF configures requested queue and returns a status code.
202 /* Rx queue config info */
203 struct i40e_virtchnl_rxq_info {
206 u32 ring_len; /* number of descriptors, multiple of 32 */
208 u16 splithdr_enabled;
212 enum i40e_hmc_obj_rx_hsplit_0 rx_split_pos;
215 /* I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES
216 * VF sends this message to set parameters for all active TX and RX queues
217 * associated with the specified VSI.
218 * PF configures queues and returns status.
219 * If the number of queues specified is greater than the number of queues
220 * associated with the VSI, an error is returned and no queues are configured.
222 struct i40e_virtchnl_queue_pair_info {
223 /* NOTE: vsi_id and queue_id should be identical for both queues. */
224 struct i40e_virtchnl_txq_info txq;
225 struct i40e_virtchnl_rxq_info rxq;
228 struct i40e_virtchnl_vsi_queue_config_info {
231 struct i40e_virtchnl_queue_pair_info qpair[1];
234 /* I40E_VIRTCHNL_OP_CONFIG_IRQ_MAP
235 * VF uses this message to map vectors to queues.
236 * The rxq_map and txq_map fields are bitmaps used to indicate which queues
237 * are to be associated with the specified vector.
238 * The "other" causes are always mapped to vector 0.
239 * PF configures interrupt mapping and returns status.
241 struct i40e_virtchnl_vector_map {
250 struct i40e_virtchnl_irq_map_info {
252 struct i40e_virtchnl_vector_map vecmap[1];
255 /* I40E_VIRTCHNL_OP_ENABLE_QUEUES
256 * I40E_VIRTCHNL_OP_DISABLE_QUEUES
257 * VF sends these message to enable or disable TX/RX queue pairs.
258 * The queues fields are bitmaps indicating which queues to act upon.
259 * (Currently, we only support 16 queues per VF, but we make the field
260 * u32 to allow for expansion.)
261 * PF performs requested action and returns status.
263 struct i40e_virtchnl_queue_select {
270 /* I40E_VIRTCHNL_OP_ADD_ETHER_ADDRESS
271 * VF sends this message in order to add one or more unicast or multicast
272 * address filters for the specified VSI.
273 * PF adds the filters and returns status.
276 /* I40E_VIRTCHNL_OP_DEL_ETHER_ADDRESS
277 * VF sends this message in order to remove one or more unicast or multicast
278 * filters for the specified VSI.
279 * PF removes the filters and returns status.
282 struct i40e_virtchnl_ether_addr {
283 u8 addr[I40E_ETH_LENGTH_OF_ADDRESS];
287 struct i40e_virtchnl_ether_addr_list {
290 struct i40e_virtchnl_ether_addr list[1];
293 #ifdef I40E_SOL_VF_SUPPORT
294 /* I40E_VIRTCHNL_OP_GET_ADDNL_SOL_CONFIG
295 * VF sends this message to get the default MTU and list of additional ethernet
296 * addresses it is allowed to use.
297 * PF responds with an indirect message containing
298 * i40e_virtchnl_addnl_solaris_config with zero or more
299 * i40e_virtchnl_ether_addr structures.
301 * It is expected that this operation will only ever be needed for Solaris VFs
302 * running under a Solaris PF.
304 struct i40e_virtchnl_addnl_solaris_config {
306 struct i40e_virtchnl_ether_addr_list al;
310 /* I40E_VIRTCHNL_OP_ADD_VLAN
311 * VF sends this message to add one or more VLAN tag filters for receives.
312 * PF adds the filters and returns status.
313 * If a port VLAN is configured by the PF, this operation will return an
317 /* I40E_VIRTCHNL_OP_DEL_VLAN
318 * VF sends this message to remove one or more VLAN tag filters for receives.
319 * PF removes the filters and returns status.
320 * If a port VLAN is configured by the PF, this operation will return an
324 struct i40e_virtchnl_vlan_filter_list {
330 /* I40E_VIRTCHNL_OP_CONFIG_PROMISCUOUS_MODE
331 * VF sends VSI id and flags.
332 * PF returns status code in retval.
333 * Note: we assume that broadcast accept mode is always enabled.
335 struct i40e_virtchnl_promisc_info {
340 #define I40E_FLAG_VF_UNICAST_PROMISC 0x00000001
341 #define I40E_FLAG_VF_MULTICAST_PROMISC 0x00000002
343 /* I40E_VIRTCHNL_OP_GET_STATS
344 * VF sends this message to request stats for the selected VSI. VF uses
345 * the i40e_virtchnl_queue_select struct to specify the VSI. The queue_id
346 * field is ignored by the PF.
348 * PF replies with struct i40e_eth_stats in an external buffer.
351 /* I40E_VIRTCHNL_OP_EVENT
352 * PF sends this message to inform the VF driver of events that may affect it.
353 * No direct response is expected from the VF, though it may generate other
354 * messages in response to this one.
356 enum i40e_virtchnl_event_codes {
357 I40E_VIRTCHNL_EVENT_UNKNOWN = 0,
358 I40E_VIRTCHNL_EVENT_LINK_CHANGE,
359 I40E_VIRTCHNL_EVENT_RESET_IMPENDING,
360 I40E_VIRTCHNL_EVENT_PF_DRIVER_CLOSE,
362 #define I40E_PF_EVENT_SEVERITY_INFO 0
363 #define I40E_PF_EVENT_SEVERITY_ATTENTION 1
364 #define I40E_PF_EVENT_SEVERITY_ACTION_REQUIRED 2
365 #define I40E_PF_EVENT_SEVERITY_CERTAIN_DOOM 255
367 struct i40e_virtchnl_pf_event {
368 enum i40e_virtchnl_event_codes event;
371 enum i40e_aq_link_speed link_speed;
379 /* VF reset states - these are written into the RSTAT register:
380 * I40E_VFGEN_RSTAT1 on the PF
381 * I40E_VFGEN_RSTAT on the VF
382 * When the PF initiates a reset, it writes 0
383 * When the reset is complete, it writes 1
384 * When the PF detects that the VF has recovered, it writes 2
385 * VF checks this register periodically to determine if a reset has occurred,
386 * then polls it to know when the reset is complete.
387 * If either the PF or VF reads the register while the hardware
388 * is in a reset state, it will return DEADBEEF, which, when masked
391 enum i40e_vfr_states {
392 I40E_VFR_INPROGRESS = 0,
398 #endif /* _I40E_VIRTCHNL_H_ */