9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi/******************************************************************************
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi Copyright (c) 2013-2015, Intel Corporation
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi All rights reserved.
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi Redistribution and use in source and binary forms, with or without
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi modification, are permitted provided that the following conditions are met:
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi 1. Redistributions of source code must retain the above copyright notice,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi this list of conditions and the following disclaimer.
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi 2. Redistributions in binary form must reproduce the above copyright
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi notice, this list of conditions and the following disclaimer in the
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi documentation and/or other materials provided with the distribution.
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi 3. Neither the name of the Intel Corporation nor the names of its
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi contributors may be used to endorse or promote products derived from
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi this software without specific prior written permission.
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi POSSIBILITY OF SUCH DAMAGE.
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi******************************************************************************/
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi/*$FreeBSD: head/sys/dev/ixl/i40e_hmc.h 284049 2015-06-05 22:52:42Z jfv $*/
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi/* forward-declare the HW struct for the compiler */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_HMC_INFO_SIGNATURE 0x484D5347 /* HMSG */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_HMC_DIRECT_BP_SIZE 0x200000 /* 2M */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi u32 max_cnt; /* max count available for this hmc func */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi u32 cnt; /* count of objects driver actually wants to create */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi u64 size; /* size in bytes of one object */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi struct i40e_dma_mem addr; /* populate to be used by hw */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi struct i40e_dma_mem pd_page_addr; /* populate to be used by hw */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi struct i40e_hmc_pd_entry *pd_entry; /* [512] for sw book keeping */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi struct i40e_virt_mem pd_entry_virt_mem; /* virt mem for pd_entry */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi struct i40e_virt_mem addr; /* used to track sd_entry allocations */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi struct i40e_hmc_sd_entry *sd_entry; /* (sd_cnt*512) entries max */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi /* equals to pci func num for PF and dynamically allocated for VFs */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi u16 first_sd_index; /* index of the first available SD */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi /* hmc objects */
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_INC_SD_REFCNT(sd_table) ((sd_table)->ref_cnt++)
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_INC_PD_REFCNT(pd_table) ((pd_table)->ref_cnt++)
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_INC_BP_REFCNT(bp) ((bp)->ref_cnt++)
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_DEC_SD_REFCNT(sd_table) ((sd_table)->ref_cnt--)
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_DEC_PD_REFCNT(pd_table) ((pd_table)->ref_cnt--)
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_DEC_BP_REFCNT(bp) ((bp)->ref_cnt--)
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * I40E_SET_PF_SD_ENTRY - marks the sd entry as valid in the hardware
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @hw: pointer to our hw struct
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @pa: pointer to physical address
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @sd_index: segment descriptor index
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @type: if sd entry is direct or paged
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_SET_PF_SD_ENTRY(hw, pa, sd_index, type) \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi val2 = (u32)(pa) | (I40E_HMC_MAX_BP_COUNT << \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi I40E_PFHMC_SDDATALOW_PMSDBPCOUNT_SHIFT) | \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi ((((type) == I40E_SD_TYPE_PAGED) ? 0 : 1) << \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi BIT(I40E_PFHMC_SDDATALOW_PMSDVALID_SHIFT); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi val3 = (sd_index) | BIT_ULL(I40E_PFHMC_SDCMD_PMSDWR_SHIFT); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * I40E_CLEAR_PF_SD_ENTRY - marks the sd entry as invalid in the hardware
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @hw: pointer to our hw struct
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @sd_index: segment descriptor index
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @type: if sd entry is direct or paged
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_CLEAR_PF_SD_ENTRY(hw, sd_index, type) \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi I40E_PFHMC_SDDATALOW_PMSDBPCOUNT_SHIFT) | \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi ((((type) == I40E_SD_TYPE_PAGED) ? 0 : 1) << \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi val3 = (sd_index) | BIT_ULL(I40E_PFHMC_SDCMD_PMSDWR_SHIFT); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * I40E_INVALIDATE_PF_HMC_PD - Invalidates the pd cache in the hardware
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @hw: pointer to our hw struct
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @sd_idx: segment descriptor index
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @pd_idx: page descriptor index
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_INVALIDATE_PF_HMC_PD(hw, sd_idx, pd_idx) \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi (((sd_idx) << I40E_PFHMC_PDINV_PMSDIDX_SHIFT) | \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi ((pd_idx) << I40E_PFHMC_PDINV_PMPDIDX_SHIFT)))
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * I40E_FIND_SD_INDEX_LIMIT - finds segment descriptor index limit
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @hmc_info: pointer to the HMC configuration information structure
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @type: type of HMC resources we're searching
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @index: starting index for the object
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @cnt: number of objects we're trying to create
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @sd_idx: pointer to return index of the segment descriptor in question
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @sd_limit: pointer to return the maximum number of segment descriptors
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * This function calculates the segment descriptor index and index limit
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * for the resource defined by i40e_hmc_rsrc_type.
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_FIND_SD_INDEX_LIMIT(hmc_info, type, index, cnt, sd_idx, sd_limit)\
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi fpm_addr = (hmc_info)->hmc_obj[(type)].base + \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi (hmc_info)->hmc_obj[(type)].size * (index); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi fpm_limit = fpm_addr + (hmc_info)->hmc_obj[(type)].size * (cnt);\
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi *(sd_idx) = (u32)(fpm_addr / I40E_HMC_DIRECT_BP_SIZE); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi *(sd_limit) = (u32)((fpm_limit - 1) / I40E_HMC_DIRECT_BP_SIZE); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi /* add one more to the limit to correct our range */ \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * I40E_FIND_PD_INDEX_LIMIT - finds page descriptor index limit
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @hmc_info: pointer to the HMC configuration information struct
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @type: HMC resource type we're examining
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @idx: starting index for the object
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @cnt: number of objects we're trying to create
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @pd_index: pointer to return page descriptor index
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * @pd_limit: pointer to return page descriptor index limit
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * Calculates the page descriptor index and index limit for the resource
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi * defined by i40e_hmc_rsrc_type.
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#define I40E_FIND_PD_INDEX_LIMIT(hmc_info, type, idx, cnt, pd_index, pd_limit)\
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi fpm_adr = (hmc_info)->hmc_obj[(type)].base + \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi (hmc_info)->hmc_obj[(type)].size * (idx); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi fpm_limit = fpm_adr + (hmc_info)->hmc_obj[(type)].size * (cnt); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi *(pd_index) = (u32)(fpm_adr / I40E_HMC_PAGED_BP_SIZE); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi *(pd_limit) = (u32)((fpm_limit - 1) / I40E_HMC_PAGED_BP_SIZE); \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi /* add one more to the limit to correct our range */ \
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchienum i40e_status_code i40e_add_sd_table_entry(struct i40e_hw *hw,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchienum i40e_status_code i40e_add_pd_table_entry(struct i40e_hw *hw,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchienum i40e_status_code i40e_remove_pd_bp(struct i40e_hw *hw,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchienum i40e_status_code i40e_prep_remove_sd_bp(struct i40e_hmc_info *hmc_info,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchienum i40e_status_code i40e_remove_sd_bp_new(struct i40e_hw *hw,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchienum i40e_status_code i40e_prep_remove_pd_page(struct i40e_hmc_info *hmc_info,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchienum i40e_status_code i40e_remove_pd_page_new(struct i40e_hw *hw,
9d26e4fc021e249c93c2861629cc665e4f5bd4d6Robert Mustacchi#endif /* _I40E_HMC_H_ */