Imported Upstream version 16.07.2
[deb_dpdk.git] / drivers / net / i40e / i40e_pf.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2015 Intel Corporation. All rights reserved.
5  *   All rights reserved.
6  *
7  *   Redistribution and use in source and binary forms, with or without
8  *   modification, are permitted provided that the following conditions
9  *   are met:
10  *
11  *     * Redistributions of source code must retain the above copyright
12  *       notice, this list of conditions and the following disclaimer.
13  *     * Redistributions in binary form must reproduce the above copyright
14  *       notice, this list of conditions and the following disclaimer in
15  *       the documentation and/or other materials provided with the
16  *       distribution.
17  *     * Neither the name of Intel Corporation nor the names of its
18  *       contributors may be used to endorse or promote products derived
19  *       from this software without specific prior written permission.
20  *
21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  */
33
34 #ifndef _I40E_PF_H_
35 #define _I40E_PF_H_
36
37 /* VERSION info to exchange between VF and PF host. In case VF works with
38  *  ND kernel driver, it reads I40E_VIRTCHNL_VERSION_MAJOR/MINOR. In
39  *  case works with DPDK host, it reads version below. Then VF realize who it
40  *  is talking to and use proper language to communicate.
41  * */
42 #define I40E_DPDK_SIGNATURE     ('D' << 24 | 'P' << 16 | 'D' << 8 | 'K')
43 #define I40E_DPDK_VERSION_MAJOR I40E_DPDK_SIGNATURE
44 #define I40E_DPDK_VERSION_MINOR 0
45
46 /* Default setting on number of VSIs that VF can contain */
47 #define I40E_DEFAULT_VF_VSI_NUM 1
48
49 #define I40E_DPDK_OFFSET  0x100
50
51 enum i40e_pf_vfr_state {
52         I40E_PF_VFR_INPROGRESS = 0,
53         I40E_PF_VFR_COMPLETED = 1,
54 };
55
56 /* DPDK pf driver specific command to VF */
57 enum i40e_virtchnl_ops_dpdk {
58         /*
59          * Keep some gap between Linux PF commands and
60          * DPDK PF extended commands.
61          */
62         I40E_VIRTCHNL_OP_CFG_VLAN_OFFLOAD = I40E_VIRTCHNL_OP_VERSION +
63                                                 I40E_DPDK_OFFSET,
64         I40E_VIRTCHNL_OP_CFG_VLAN_PVID,
65         I40E_VIRTCHNL_OP_CONFIG_VSI_QUEUES_EXT,
66 };
67
68 /* A structure to support extended info of a receive queue. */
69 struct i40e_virtchnl_rxq_ext_info {
70         uint8_t crcstrip;
71 };
72
73 /*
74  * A structure to support extended info of queue pairs, an additional field
75  * is added, comparing to original 'struct i40e_virtchnl_queue_pair_info'.
76  */
77 struct i40e_virtchnl_queue_pair_ext_info {
78         /* vsi_id and queue_id should be identical for both rx and tx queues.*/
79         struct i40e_virtchnl_txq_info txq;
80         struct i40e_virtchnl_rxq_info rxq;
81         struct i40e_virtchnl_rxq_ext_info rxq_ext;
82 };
83
84 /*
85  * A structure to support extended info of VSI queue pairs,
86  * 'struct i40e_virtchnl_queue_pair_ext_info' is used, see its original
87  * of 'struct i40e_virtchnl_queue_pair_info'.
88  */
89 struct i40e_virtchnl_vsi_queue_config_ext_info {
90         uint16_t vsi_id;
91         uint16_t num_queue_pairs;
92         struct i40e_virtchnl_queue_pair_ext_info qpair[0];
93 };
94
95 struct i40e_virtchnl_vlan_offload_info {
96         uint16_t vsi_id;
97         uint8_t enable_vlan_strip;
98         uint8_t reserved;
99 };
100
101 /*
102  * Macro to calculate the memory size for configuring VSI queues
103  * via virtual channel.
104  */
105 #define I40E_VIRTCHNL_CONFIG_VSI_QUEUES_SIZE(x, n) \
106         (sizeof(*(x)) + sizeof((x)->qpair[0]) * (n))
107
108 /*
109  * I40E_VIRTCHNL_OP_CFG_VLAN_PVID
110  * VF sends this message to enable/disable pvid. If it's
111  * enable op, needs to specify the pvid. PF returns status
112  * code in retval.
113  */
114 struct i40e_virtchnl_pvid_info {
115         uint16_t vsi_id;
116         struct i40e_vsi_vlan_pvid_info info;
117 };
118
119 int i40e_pf_host_vf_reset(struct i40e_pf_vf *vf, bool do_hw_reset);
120 void i40e_pf_host_handle_vf_msg(struct rte_eth_dev *dev,
121                                 uint16_t abs_vf_id, uint32_t opcode,
122                                 __rte_unused uint32_t retval,
123                                 uint8_t *msg, uint16_t msglen);
124 int i40e_pf_host_init(struct rte_eth_dev *dev);
125 int i40e_pf_host_uninit(struct rte_eth_dev *dev);
126
127 #endif /* _I40E_PF_H_ */