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 ***************************************************************************/
37 #define I40E_HMC_MAX_BP_COUNT 512
39 /* forward-declare the HW struct for the compiler */
42 #define I40E_HMC_INFO_SIGNATURE 0x484D5347 /* HMSG */
43 #define I40E_HMC_PD_CNT_IN_SD 512
44 #define I40E_HMC_DIRECT_BP_SIZE 0x200000 /* 2M */
45 #define I40E_HMC_PAGED_BP_SIZE 4096
46 #define I40E_HMC_PD_BP_BUF_ALIGNMENT 4096
47 #define I40E_FIRST_VF_FPM_ID 16
49 struct i40e_hmc_obj_info {
50 u64 base; /* base addr in FPM */
51 u32 max_cnt; /* max count available for this hmc func */
52 u32 cnt; /* count of objects driver actually wants to create */
53 u64 size; /* size in bytes of one object */
56 enum i40e_sd_entry_type {
57 I40E_SD_TYPE_INVALID = 0,
58 I40E_SD_TYPE_PAGED = 1,
59 I40E_SD_TYPE_DIRECT = 2
63 enum i40e_sd_entry_type entry_type;
64 struct i40e_dma_mem addr; /* populate to be used by hw */
69 struct i40e_hmc_pd_entry {
70 struct i40e_hmc_bp bp;
75 struct i40e_hmc_pd_table {
76 struct i40e_dma_mem pd_page_addr; /* populate to be used by hw */
77 struct i40e_hmc_pd_entry *pd_entry; /* [512] for sw book keeping */
78 struct i40e_virt_mem pd_entry_virt_mem; /* virt mem for pd_entry */
84 struct i40e_hmc_sd_entry {
85 enum i40e_sd_entry_type entry_type;
89 struct i40e_hmc_pd_table pd_table;
90 struct i40e_hmc_bp bp;
94 struct i40e_hmc_sd_table {
95 struct i40e_virt_mem addr; /* used to track sd_entry allocations */
98 struct i40e_hmc_sd_entry *sd_entry; /* (sd_cnt*512) entries max */
101 struct i40e_hmc_info {
103 /* equals to pci func num for PF and dynamically allocated for VFs */
105 u16 first_sd_index; /* index of the first available SD */
108 struct i40e_hmc_obj_info *hmc_obj;
109 struct i40e_virt_mem hmc_obj_virt_mem;
110 struct i40e_hmc_sd_table sd_table;
113 #define I40E_INC_SD_REFCNT(sd_table) ((sd_table)->ref_cnt++)
114 #define I40E_INC_PD_REFCNT(pd_table) ((pd_table)->ref_cnt++)
115 #define I40E_INC_BP_REFCNT(bp) ((bp)->ref_cnt++)
117 #define I40E_DEC_SD_REFCNT(sd_table) ((sd_table)->ref_cnt--)
118 #define I40E_DEC_PD_REFCNT(pd_table) ((pd_table)->ref_cnt--)
119 #define I40E_DEC_BP_REFCNT(bp) ((bp)->ref_cnt--)
122 * I40E_SET_PF_SD_ENTRY - marks the sd entry as valid in the hardware
123 * @hw: pointer to our hw struct
124 * @pa: pointer to physical address
125 * @sd_index: segment descriptor index
126 * @type: if sd entry is direct or paged
128 #define I40E_SET_PF_SD_ENTRY(hw, pa, sd_index, type) \
130 u32 val1, val2, val3; \
131 val1 = (u32)(I40E_HI_DWORD(pa)); \
132 val2 = (u32)(pa) | (I40E_HMC_MAX_BP_COUNT << \
133 I40E_PFHMC_SDDATALOW_PMSDBPCOUNT_SHIFT) | \
134 ((((type) == I40E_SD_TYPE_PAGED) ? 0 : 1) << \
135 I40E_PFHMC_SDDATALOW_PMSDTYPE_SHIFT) | \
136 (1 << I40E_PFHMC_SDDATALOW_PMSDVALID_SHIFT); \
137 val3 = (sd_index) | (1u << I40E_PFHMC_SDCMD_PMSDWR_SHIFT); \
138 wr32((hw), I40E_PFHMC_SDDATAHIGH, val1); \
139 wr32((hw), I40E_PFHMC_SDDATALOW, val2); \
140 wr32((hw), I40E_PFHMC_SDCMD, val3); \
144 * I40E_CLEAR_PF_SD_ENTRY - marks the sd entry as invalid in the hardware
145 * @hw: pointer to our hw struct
146 * @sd_index: segment descriptor index
147 * @type: if sd entry is direct or paged
149 #define I40E_CLEAR_PF_SD_ENTRY(hw, sd_index, type) \
152 val2 = (I40E_HMC_MAX_BP_COUNT << \
153 I40E_PFHMC_SDDATALOW_PMSDBPCOUNT_SHIFT) | \
154 ((((type) == I40E_SD_TYPE_PAGED) ? 0 : 1) << \
155 I40E_PFHMC_SDDATALOW_PMSDTYPE_SHIFT); \
156 val3 = (sd_index) | (1u << I40E_PFHMC_SDCMD_PMSDWR_SHIFT); \
157 wr32((hw), I40E_PFHMC_SDDATAHIGH, 0); \
158 wr32((hw), I40E_PFHMC_SDDATALOW, val2); \
159 wr32((hw), I40E_PFHMC_SDCMD, val3); \
163 * I40E_INVALIDATE_PF_HMC_PD - Invalidates the pd cache in the hardware
164 * @hw: pointer to our hw struct
165 * @sd_idx: segment descriptor index
166 * @pd_idx: page descriptor index
168 #define I40E_INVALIDATE_PF_HMC_PD(hw, sd_idx, pd_idx) \
169 wr32((hw), I40E_PFHMC_PDINV, \
170 (((sd_idx) << I40E_PFHMC_PDINV_PMSDIDX_SHIFT) | \
171 ((pd_idx) << I40E_PFHMC_PDINV_PMPDIDX_SHIFT)))
174 * I40E_FIND_SD_INDEX_LIMIT - finds segment descriptor index limit
175 * @hmc_info: pointer to the HMC configuration information structure
176 * @type: type of HMC resources we're searching
177 * @index: starting index for the object
178 * @cnt: number of objects we're trying to create
179 * @sd_idx: pointer to return index of the segment descriptor in question
180 * @sd_limit: pointer to return the maximum number of segment descriptors
182 * This function calculates the segment descriptor index and index limit
183 * for the resource defined by i40e_hmc_rsrc_type.
185 #define I40E_FIND_SD_INDEX_LIMIT(hmc_info, type, index, cnt, sd_idx, sd_limit)\
187 u64 fpm_addr, fpm_limit; \
188 fpm_addr = (hmc_info)->hmc_obj[(type)].base + \
189 (hmc_info)->hmc_obj[(type)].size * (index); \
190 fpm_limit = fpm_addr + (hmc_info)->hmc_obj[(type)].size * (cnt);\
191 *(sd_idx) = (u32)(fpm_addr / I40E_HMC_DIRECT_BP_SIZE); \
192 *(sd_limit) = (u32)((fpm_limit - 1) / I40E_HMC_DIRECT_BP_SIZE); \
193 /* add one more to the limit to correct our range */ \
198 * I40E_FIND_PD_INDEX_LIMIT - finds page descriptor index limit
199 * @hmc_info: pointer to the HMC configuration information struct
200 * @type: HMC resource type we're examining
201 * @idx: starting index for the object
202 * @cnt: number of objects we're trying to create
203 * @pd_index: pointer to return page descriptor index
204 * @pd_limit: pointer to return page descriptor index limit
206 * Calculates the page descriptor index and index limit for the resource
207 * defined by i40e_hmc_rsrc_type.
209 #define I40E_FIND_PD_INDEX_LIMIT(hmc_info, type, idx, cnt, pd_index, pd_limit)\
211 u64 fpm_adr, fpm_limit; \
212 fpm_adr = (hmc_info)->hmc_obj[(type)].base + \
213 (hmc_info)->hmc_obj[(type)].size * (idx); \
214 fpm_limit = fpm_adr + (hmc_info)->hmc_obj[(type)].size * (cnt); \
215 *(pd_index) = (u32)(fpm_adr / I40E_HMC_PAGED_BP_SIZE); \
216 *(pd_limit) = (u32)((fpm_limit - 1) / I40E_HMC_PAGED_BP_SIZE); \
217 /* add one more to the limit to correct our range */ \
220 enum i40e_status_code i40e_add_sd_table_entry(struct i40e_hw *hw,
221 struct i40e_hmc_info *hmc_info,
223 enum i40e_sd_entry_type type,
226 enum i40e_status_code i40e_add_pd_table_entry(struct i40e_hw *hw,
227 struct i40e_hmc_info *hmc_info,
229 enum i40e_status_code i40e_remove_pd_bp(struct i40e_hw *hw,
230 struct i40e_hmc_info *hmc_info,
232 enum i40e_status_code i40e_prep_remove_sd_bp(struct i40e_hmc_info *hmc_info,
234 enum i40e_status_code i40e_remove_sd_bp_new(struct i40e_hw *hw,
235 struct i40e_hmc_info *hmc_info,
236 u32 idx, bool is_pf);
237 enum i40e_status_code i40e_prep_remove_pd_page(struct i40e_hmc_info *hmc_info,
239 enum i40e_status_code i40e_remove_pd_page_new(struct i40e_hw *hw,
240 struct i40e_hmc_info *hmc_info,
241 u32 idx, bool is_pf);
243 #endif /* _I40E_HMC_H_ */