ce5a97844bebe015bcc3b86c9400e55348f580c5
[dpdk.git] / lib / librte_pmd_i40e / i40e_pf.h
1 /*-
2  *   BSD LICENSE
3  *
4  *   Copyright(c) 2010-2014 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_GET_LINK_STAT = I40E_VIRTCHNL_OP_VERSION +
63                                                 I40E_DPDK_OFFSET,
64         I40E_VIRTCHNL_OP_CFG_VLAN_OFFLOAD,
65         I40E_VIRTCHNL_OP_CFG_VLAN_PVID,
66 };
67
68 struct i40e_virtchnl_vlan_offload_info {
69         uint16_t vsi_id;
70         uint8_t enable_vlan_strip;
71         uint8_t reserved;
72 };
73
74 /*
75  * Macro to calculate the memory size for configuring VSI queues
76  * via virtual channel.
77  */
78 #define I40E_VIRTCHNL_CONFIG_VSI_QUEUES_SIZE(x, n) \
79         (sizeof(*(x)) + sizeof((x)->qpair[0]) * (n))
80
81 /*
82  * I40E_VIRTCHNL_OP_CFG_VLAN_PVID
83  * VF sends this message to enable/disable pvid. If it's
84  * enable op, needs to specify the pvid. PF returns status
85  * code in retval.
86  */
87 struct i40e_virtchnl_pvid_info {
88         uint16_t vsi_id;
89         struct i40e_vsi_vlan_pvid_info info;
90 };
91
92 int i40e_pf_host_vf_reset(struct i40e_pf_vf *vf, bool do_hw_reset);
93 void i40e_pf_host_handle_vf_msg(struct rte_eth_dev *dev,
94                                 uint16_t abs_vf_id, uint32_t opcode,
95                                 __rte_unused uint32_t retval,
96                                 uint8_t *msg, uint16_t msglen);
97 int i40e_pf_host_init(struct rte_eth_dev *dev);
98
99 #endif /* _I40E_PF_H_ */