1 /******************************************************************************* 2 * 3 * Intel Ethernet Controller XL710 Family Linux Driver 4 * Copyright(c) 2013 - 2014 Intel Corporation. 5 * 6 * This program is free software; you can redistribute it and/or modify it 7 * under the terms and conditions of the GNU General Public License, 8 * version 2, as published by the Free Software Foundation. 9 * 10 * This program is distributed in the hope it will be useful, but WITHOUT 11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 13 * more details. 14 * 15 * You should have received a copy of the GNU General Public License along 16 * with this program. If not, see <http://www.gnu.org/licenses/>. 17 * 18 * The full GNU General Public License is included in this distribution in 19 * the file called "COPYING". 20 * 21 * Contact Information: 22 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net> 23 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497 24 * 25 ******************************************************************************/ 26 27 #ifndef _I40E_HMC_H_ 28 #define _I40E_HMC_H_ 29 30 #define I40E_HMC_MAX_BP_COUNT 512 31 32 /* forward-declare the HW struct for the compiler */ 33 struct i40e_hw; 34 35 #define I40E_HMC_INFO_SIGNATURE 0x484D5347 /* HMSG */ 36 #define I40E_HMC_PD_CNT_IN_SD 512 37 #define I40E_HMC_DIRECT_BP_SIZE 0x200000 /* 2M */ 38 #define I40E_HMC_PAGED_BP_SIZE 4096 39 #define I40E_HMC_PD_BP_BUF_ALIGNMENT 4096 40 #define I40E_FIRST_VF_FPM_ID 16 41 42 struct i40e_hmc_obj_info { 43 u64 base; /* base addr in FPM */ 44 u32 max_cnt; /* max count available for this hmc func */ 45 u32 cnt; /* count of objects driver actually wants to create */ 46 u64 size; /* size in bytes of one object */ 47 }; 48 49 enum i40e_sd_entry_type { 50 I40E_SD_TYPE_INVALID = 0, 51 I40E_SD_TYPE_PAGED = 1, 52 I40E_SD_TYPE_DIRECT = 2 53 }; 54 55 struct i40e_hmc_bp { 56 enum i40e_sd_entry_type entry_type; 57 struct i40e_dma_mem addr; /* populate to be used by hw */ 58 u32 sd_pd_index; 59 u32 ref_cnt; 60 }; 61 62 struct i40e_hmc_pd_entry { 63 struct i40e_hmc_bp bp; 64 u32 sd_index; 65 bool rsrc_pg; 66 bool valid; 67 }; 68 69 struct i40e_hmc_pd_table { 70 struct i40e_dma_mem pd_page_addr; /* populate to be used by hw */ 71 struct i40e_hmc_pd_entry *pd_entry; /* [512] for sw book keeping */ 72 struct i40e_virt_mem pd_entry_virt_mem; /* virt mem for pd_entry */ 73 74 u32 ref_cnt; 75 u32 sd_index; 76 }; 77 78 struct i40e_hmc_sd_entry { 79 enum i40e_sd_entry_type entry_type; 80 bool valid; 81 82 union { 83 struct i40e_hmc_pd_table pd_table; 84 struct i40e_hmc_bp bp; 85 } u; 86 }; 87 88 struct i40e_hmc_sd_table { 89 struct i40e_virt_mem addr; /* used to track sd_entry allocations */ 90 u32 sd_cnt; 91 u32 ref_cnt; 92 struct i40e_hmc_sd_entry *sd_entry; /* (sd_cnt*512) entries max */ 93 }; 94 95 struct i40e_hmc_info { 96 u32 signature; 97 /* equals to pci func num for PF and dynamically allocated for VFs */ 98 u8 hmc_fn_id; 99 u16 first_sd_index; /* index of the first available SD */ 100 101 /* hmc objects */ 102 struct i40e_hmc_obj_info *hmc_obj; 103 struct i40e_virt_mem hmc_obj_virt_mem; 104 struct i40e_hmc_sd_table sd_table; 105 }; 106 107 #define I40E_INC_SD_REFCNT(sd_table) ((sd_table)->ref_cnt++) 108 #define I40E_INC_PD_REFCNT(pd_table) ((pd_table)->ref_cnt++) 109 #define I40E_INC_BP_REFCNT(bp) ((bp)->ref_cnt++) 110 111 #define I40E_DEC_SD_REFCNT(sd_table) ((sd_table)->ref_cnt--) 112 #define I40E_DEC_PD_REFCNT(pd_table) ((pd_table)->ref_cnt--) 113 #define I40E_DEC_BP_REFCNT(bp) ((bp)->ref_cnt--) 114 115 /** 116 * I40E_SET_PF_SD_ENTRY - marks the sd entry as valid in the hardware 117 * @hw: pointer to our hw struct 118 * @pa: pointer to physical address 119 * @sd_index: segment descriptor index 120 * @type: if sd entry is direct or paged 121 **/ 122 #define I40E_SET_PF_SD_ENTRY(hw, pa, sd_index, type) \ 123 { \ 124 u32 val1, val2, val3; \ 125 val1 = (u32)(upper_32_bits(pa)); \ 126 val2 = (u32)(pa) | (I40E_HMC_MAX_BP_COUNT << \ 127 I40E_PFHMC_SDDATALOW_PMSDBPCOUNT_SHIFT) | \ 128 ((((type) == I40E_SD_TYPE_PAGED) ? 0 : 1) << \ 129 I40E_PFHMC_SDDATALOW_PMSDTYPE_SHIFT) | \ 130 BIT(I40E_PFHMC_SDDATALOW_PMSDVALID_SHIFT); \ 131 val3 = (sd_index) | BIT_ULL(I40E_PFHMC_SDCMD_PMSDWR_SHIFT); \ 132 wr32((hw), I40E_PFHMC_SDDATAHIGH, val1); \ 133 wr32((hw), I40E_PFHMC_SDDATALOW, val2); \ 134 wr32((hw), I40E_PFHMC_SDCMD, val3); \ 135 } 136 137 /** 138 * I40E_CLEAR_PF_SD_ENTRY - marks the sd entry as invalid in the hardware 139 * @hw: pointer to our hw struct 140 * @sd_index: segment descriptor index 141 * @type: if sd entry is direct or paged 142 **/ 143 #define I40E_CLEAR_PF_SD_ENTRY(hw, sd_index, type) \ 144 { \ 145 u32 val2, val3; \ 146 val2 = (I40E_HMC_MAX_BP_COUNT << \ 147 I40E_PFHMC_SDDATALOW_PMSDBPCOUNT_SHIFT) | \ 148 ((((type) == I40E_SD_TYPE_PAGED) ? 0 : 1) << \ 149 I40E_PFHMC_SDDATALOW_PMSDTYPE_SHIFT); \ 150 val3 = (sd_index) | BIT_ULL(I40E_PFHMC_SDCMD_PMSDWR_SHIFT); \ 151 wr32((hw), I40E_PFHMC_SDDATAHIGH, 0); \ 152 wr32((hw), I40E_PFHMC_SDDATALOW, val2); \ 153 wr32((hw), I40E_PFHMC_SDCMD, val3); \ 154 } 155 156 /** 157 * I40E_INVALIDATE_PF_HMC_PD - Invalidates the pd cache in the hardware 158 * @hw: pointer to our hw struct 159 * @sd_idx: segment descriptor index 160 * @pd_idx: page descriptor index 161 **/ 162 #define I40E_INVALIDATE_PF_HMC_PD(hw, sd_idx, pd_idx) \ 163 wr32((hw), I40E_PFHMC_PDINV, \ 164 (((sd_idx) << I40E_PFHMC_PDINV_PMSDIDX_SHIFT) | \ 165 ((pd_idx) << I40E_PFHMC_PDINV_PMPDIDX_SHIFT))) 166 167 /** 168 * I40E_FIND_SD_INDEX_LIMIT - finds segment descriptor index limit 169 * @hmc_info: pointer to the HMC configuration information structure 170 * @type: type of HMC resources we're searching 171 * @index: starting index for the object 172 * @cnt: number of objects we're trying to create 173 * @sd_idx: pointer to return index of the segment descriptor in question 174 * @sd_limit: pointer to return the maximum number of segment descriptors 175 * 176 * This function calculates the segment descriptor index and index limit 177 * for the resource defined by i40e_hmc_rsrc_type. 178 **/ 179 #define I40E_FIND_SD_INDEX_LIMIT(hmc_info, type, index, cnt, sd_idx, sd_limit)\ 180 { \ 181 u64 fpm_addr, fpm_limit; \ 182 fpm_addr = (hmc_info)->hmc_obj[(type)].base + \ 183 (hmc_info)->hmc_obj[(type)].size * (index); \ 184 fpm_limit = fpm_addr + (hmc_info)->hmc_obj[(type)].size * (cnt);\ 185 *(sd_idx) = (u32)(fpm_addr / I40E_HMC_DIRECT_BP_SIZE); \ 186 *(sd_limit) = (u32)((fpm_limit - 1) / I40E_HMC_DIRECT_BP_SIZE); \ 187 /* add one more to the limit to correct our range */ \ 188 *(sd_limit) += 1; \ 189 } 190 191 /** 192 * I40E_FIND_PD_INDEX_LIMIT - finds page descriptor index limit 193 * @hmc_info: pointer to the HMC configuration information struct 194 * @type: HMC resource type we're examining 195 * @idx: starting index for the object 196 * @cnt: number of objects we're trying to create 197 * @pd_index: pointer to return page descriptor index 198 * @pd_limit: pointer to return page descriptor index limit 199 * 200 * Calculates the page descriptor index and index limit for the resource 201 * defined by i40e_hmc_rsrc_type. 202 **/ 203 #define I40E_FIND_PD_INDEX_LIMIT(hmc_info, type, idx, cnt, pd_index, pd_limit)\ 204 { \ 205 u64 fpm_adr, fpm_limit; \ 206 fpm_adr = (hmc_info)->hmc_obj[(type)].base + \ 207 (hmc_info)->hmc_obj[(type)].size * (idx); \ 208 fpm_limit = fpm_adr + (hmc_info)->hmc_obj[(type)].size * (cnt); \ 209 *(pd_index) = (u32)(fpm_adr / I40E_HMC_PAGED_BP_SIZE); \ 210 *(pd_limit) = (u32)((fpm_limit - 1) / I40E_HMC_PAGED_BP_SIZE); \ 211 /* add one more to the limit to correct our range */ \ 212 *(pd_limit) += 1; \ 213 } 214 i40e_status i40e_add_sd_table_entry(struct i40e_hw *hw, 215 struct i40e_hmc_info *hmc_info, 216 u32 sd_index, 217 enum i40e_sd_entry_type type, 218 u64 direct_mode_sz); 219 220 i40e_status i40e_add_pd_table_entry(struct i40e_hw *hw, 221 struct i40e_hmc_info *hmc_info, 222 u32 pd_index, 223 struct i40e_dma_mem *rsrc_pg); 224 i40e_status i40e_remove_pd_bp(struct i40e_hw *hw, 225 struct i40e_hmc_info *hmc_info, 226 u32 idx); 227 i40e_status i40e_prep_remove_sd_bp(struct i40e_hmc_info *hmc_info, 228 u32 idx); 229 i40e_status i40e_remove_sd_bp_new(struct i40e_hw *hw, 230 struct i40e_hmc_info *hmc_info, 231 u32 idx, bool is_pf); 232 i40e_status i40e_prep_remove_pd_page(struct i40e_hmc_info *hmc_info, 233 u32 idx); 234 i40e_status i40e_remove_pd_page_new(struct i40e_hw *hw, 235 struct i40e_hmc_info *hmc_info, 236 u32 idx, bool is_pf); 237 238 #endif /* _I40E_HMC_H_ */ 239