1 /*******************************************************************************
3 Copyright (c) 2013 - 2014, 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_LAN_HMC_H_
35 #define _I40E_LAN_HMC_H_
37 /* forward-declare the HW struct for the compiler */
39 enum i40e_status_code;
41 /* HMC element context information */
43 /* Rx queue context data
45 * The sizes of the variables may be larger than needed due to crossing byte
46 * boundaries. If we do not have the width of the variable set to the correct
47 * size then we could end up shifting bits off the top of the variable when the
48 * variable is at the top of a byte and crosses over into the next byte.
50 struct i40e_hmc_obj_rxq {
52 u16 cpuid; /* bigger than needed, see above for reason */
55 #define I40E_RXQ_CTX_DBUFF_SHIFT 7
56 u16 dbuff; /* bigger than needed, see above for reason */
57 #define I40E_RXQ_CTX_HBUFF_SHIFT 6
58 u16 hbuff; /* bigger than needed, see above for reason */
67 u32 rxmax; /* bigger than needed, see above for reason */
72 u16 lrxqthresh; /* bigger than needed, see above for reason */
73 u8 prefena; /* NOTE: normally must be set to 1 at init */
76 /* Tx queue context data
78 * The sizes of the variables may be larger than needed due to crossing byte
79 * boundaries. If we do not have the width of the variable set to the correct
80 * size then we could end up shifting bits off the top of the variable when the
81 * variable is at the top of a byte and crosses over into the next byte.
83 struct i40e_hmc_obj_txq {
104 /* for hsplit_0 field of Rx HMC context */
105 enum i40e_hmc_obj_rx_hsplit_0 {
106 I40E_HMC_OBJ_RX_HSPLIT_0_NO_SPLIT = 0,
107 I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_L2 = 1,
108 I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_IP = 2,
109 I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_TCP_UDP = 4,
110 I40E_HMC_OBJ_RX_HSPLIT_0_SPLIT_SCTP = 8,
113 /* fcoe_cntx and fcoe_filt are for debugging purpose only */
114 struct i40e_hmc_obj_fcoe_cntx {
118 struct i40e_hmc_obj_fcoe_filt {
122 /* Context sizes for LAN objects */
123 enum i40e_hmc_lan_object_size {
124 I40E_HMC_LAN_OBJ_SZ_8 = 0x3,
125 I40E_HMC_LAN_OBJ_SZ_16 = 0x4,
126 I40E_HMC_LAN_OBJ_SZ_32 = 0x5,
127 I40E_HMC_LAN_OBJ_SZ_64 = 0x6,
128 I40E_HMC_LAN_OBJ_SZ_128 = 0x7,
129 I40E_HMC_LAN_OBJ_SZ_256 = 0x8,
130 I40E_HMC_LAN_OBJ_SZ_512 = 0x9,
133 #define I40E_HMC_L2OBJ_BASE_ALIGNMENT 512
134 #define I40E_HMC_OBJ_SIZE_TXQ 128
135 #define I40E_HMC_OBJ_SIZE_RXQ 32
136 #define I40E_HMC_OBJ_SIZE_FCOE_CNTX 64
137 #define I40E_HMC_OBJ_SIZE_FCOE_FILT 64
139 enum i40e_hmc_lan_rsrc_type {
140 I40E_HMC_LAN_FULL = 0,
143 I40E_HMC_FCOE_CTX = 3,
144 I40E_HMC_FCOE_FILT = 4,
148 enum i40e_hmc_model {
149 I40E_HMC_MODEL_DIRECT_PREFERRED = 0,
150 I40E_HMC_MODEL_DIRECT_ONLY = 1,
151 I40E_HMC_MODEL_PAGED_ONLY = 2,
152 I40E_HMC_MODEL_UNKNOWN,
155 struct i40e_hmc_lan_create_obj_info {
156 struct i40e_hmc_info *hmc_info;
160 enum i40e_sd_entry_type entry_type;
164 struct i40e_hmc_lan_delete_obj_info {
165 struct i40e_hmc_info *hmc_info;
171 enum i40e_status_code i40e_init_lan_hmc(struct i40e_hw *hw, u32 txq_num,
172 u32 rxq_num, u32 fcoe_cntx_num,
174 enum i40e_status_code i40e_configure_lan_hmc(struct i40e_hw *hw,
175 enum i40e_hmc_model model);
176 enum i40e_status_code i40e_shutdown_lan_hmc(struct i40e_hw *hw);
178 u64 i40e_calculate_l2fpm_size(u32 txq_num, u32 rxq_num,
179 u32 fcoe_cntx_num, u32 fcoe_filt_num);
180 enum i40e_status_code i40e_get_lan_tx_queue_context(struct i40e_hw *hw,
182 struct i40e_hmc_obj_txq *s);
183 enum i40e_status_code i40e_clear_lan_tx_queue_context(struct i40e_hw *hw,
185 enum i40e_status_code i40e_set_lan_tx_queue_context(struct i40e_hw *hw,
187 struct i40e_hmc_obj_txq *s);
188 enum i40e_status_code i40e_get_lan_rx_queue_context(struct i40e_hw *hw,
190 struct i40e_hmc_obj_rxq *s);
191 enum i40e_status_code i40e_clear_lan_rx_queue_context(struct i40e_hw *hw,
193 enum i40e_status_code i40e_set_lan_rx_queue_context(struct i40e_hw *hw,
195 struct i40e_hmc_obj_rxq *s);
196 enum i40e_status_code i40e_create_lan_hmc_object(struct i40e_hw *hw,
197 struct i40e_hmc_lan_create_obj_info *info);
198 enum i40e_status_code i40e_delete_lan_hmc_object(struct i40e_hw *hw,
199 struct i40e_hmc_lan_delete_obj_info *info);
201 #endif /* _I40E_LAN_HMC_H_ */