| /* |
| * This file is provided under a dual BSD/GPLv2 license. When using or |
| * redistributing this file, you may do so under either license. |
| * |
| * GPL LICENSE SUMMARY |
| * |
| * Copyright(c) 2012 Intel Corporation. All rights reserved. |
| * Copyright (C) 2015 EMC Corporation. All Rights Reserved. |
| * |
| * This program is free software; you can redistribute it and/or modify |
| * it under the terms of version 2 of the GNU General Public License as |
| * published by the Free Software Foundation. |
| * |
| * BSD LICENSE |
| * |
| * Copyright(c) 2012 Intel Corporation. All rights reserved. |
| * Copyright (C) 2015 EMC Corporation. All Rights Reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above copy |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * * Neither the name of Intel Corporation nor the names of its |
| * contributors may be used to endorse or promote products derived |
| * from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| * |
| * Intel PCIe NTB Linux driver |
| * |
| * Contact Information: |
| * Jon Mason <jon.mason@intel.com> |
| */ |
| |
| #ifndef NTB_HW_INTEL_H |
| #define NTB_HW_INTEL_H |
| |
| #include <linux/ntb.h> |
| #include <linux/pci.h> |
| |
| #define PCI_DEVICE_ID_INTEL_NTB_B2B_JSF 0x3725 |
| #define PCI_DEVICE_ID_INTEL_NTB_PS_JSF 0x3726 |
| #define PCI_DEVICE_ID_INTEL_NTB_SS_JSF 0x3727 |
| #define PCI_DEVICE_ID_INTEL_NTB_B2B_SNB 0x3C0D |
| #define PCI_DEVICE_ID_INTEL_NTB_PS_SNB 0x3C0E |
| #define PCI_DEVICE_ID_INTEL_NTB_SS_SNB 0x3C0F |
| #define PCI_DEVICE_ID_INTEL_NTB_B2B_IVT 0x0E0D |
| #define PCI_DEVICE_ID_INTEL_NTB_PS_IVT 0x0E0E |
| #define PCI_DEVICE_ID_INTEL_NTB_SS_IVT 0x0E0F |
| #define PCI_DEVICE_ID_INTEL_NTB_B2B_HSX 0x2F0D |
| #define PCI_DEVICE_ID_INTEL_NTB_PS_HSX 0x2F0E |
| #define PCI_DEVICE_ID_INTEL_NTB_SS_HSX 0x2F0F |
| #define PCI_DEVICE_ID_INTEL_NTB_B2B_BWD 0x0C4E |
| |
| /* SNB hardware (and JSF, IVT, HSX) */ |
| |
| #define SNB_PBAR23LMT_OFFSET 0x0000 |
| #define SNB_PBAR45LMT_OFFSET 0x0008 |
| #define SNB_PBAR4LMT_OFFSET 0x0008 |
| #define SNB_PBAR5LMT_OFFSET 0x000c |
| #define SNB_PBAR23XLAT_OFFSET 0x0010 |
| #define SNB_PBAR45XLAT_OFFSET 0x0018 |
| #define SNB_PBAR4XLAT_OFFSET 0x0018 |
| #define SNB_PBAR5XLAT_OFFSET 0x001c |
| #define SNB_SBAR23LMT_OFFSET 0x0020 |
| #define SNB_SBAR45LMT_OFFSET 0x0028 |
| #define SNB_SBAR4LMT_OFFSET 0x0028 |
| #define SNB_SBAR5LMT_OFFSET 0x002c |
| #define SNB_SBAR23XLAT_OFFSET 0x0030 |
| #define SNB_SBAR45XLAT_OFFSET 0x0038 |
| #define SNB_SBAR4XLAT_OFFSET 0x0038 |
| #define SNB_SBAR5XLAT_OFFSET 0x003c |
| #define SNB_SBAR0BASE_OFFSET 0x0040 |
| #define SNB_SBAR23BASE_OFFSET 0x0048 |
| #define SNB_SBAR45BASE_OFFSET 0x0050 |
| #define SNB_SBAR4BASE_OFFSET 0x0050 |
| #define SNB_SBAR5BASE_OFFSET 0x0054 |
| #define SNB_SBDF_OFFSET 0x005c |
| #define SNB_NTBCNTL_OFFSET 0x0058 |
| #define SNB_PDOORBELL_OFFSET 0x0060 |
| #define SNB_PDBMSK_OFFSET 0x0062 |
| #define SNB_SDOORBELL_OFFSET 0x0064 |
| #define SNB_SDBMSK_OFFSET 0x0066 |
| #define SNB_USMEMMISS_OFFSET 0x0070 |
| #define SNB_SPAD_OFFSET 0x0080 |
| #define SNB_PBAR23SZ_OFFSET 0x00d0 |
| #define SNB_PBAR45SZ_OFFSET 0x00d1 |
| #define SNB_PBAR4SZ_OFFSET 0x00d1 |
| #define SNB_SBAR23SZ_OFFSET 0x00d2 |
| #define SNB_SBAR45SZ_OFFSET 0x00d3 |
| #define SNB_SBAR4SZ_OFFSET 0x00d3 |
| #define SNB_PPD_OFFSET 0x00d4 |
| #define SNB_PBAR5SZ_OFFSET 0x00d5 |
| #define SNB_SBAR5SZ_OFFSET 0x00d6 |
| #define SNB_WCCNTRL_OFFSET 0x00e0 |
| #define SNB_UNCERRSTS_OFFSET 0x014c |
| #define SNB_CORERRSTS_OFFSET 0x0158 |
| #define SNB_LINK_STATUS_OFFSET 0x01a2 |
| #define SNB_SPCICMD_OFFSET 0x0504 |
| #define SNB_DEVCTRL_OFFSET 0x0598 |
| #define SNB_DEVSTS_OFFSET 0x059a |
| #define SNB_SLINK_STATUS_OFFSET 0x05a2 |
| #define SNB_B2B_SPAD_OFFSET 0x0100 |
| #define SNB_B2B_DOORBELL_OFFSET 0x0140 |
| #define SNB_B2B_XLAT_OFFSETL 0x0144 |
| #define SNB_B2B_XLAT_OFFSETU 0x0148 |
| #define SNB_PPD_CONN_MASK 0x03 |
| #define SNB_PPD_CONN_TRANSPARENT 0x00 |
| #define SNB_PPD_CONN_B2B 0x01 |
| #define SNB_PPD_CONN_RP 0x02 |
| #define SNB_PPD_DEV_MASK 0x10 |
| #define SNB_PPD_DEV_USD 0x00 |
| #define SNB_PPD_DEV_DSD 0x10 |
| #define SNB_PPD_SPLIT_BAR_MASK 0x40 |
| |
| #define SNB_PPD_TOPO_MASK (SNB_PPD_CONN_MASK | SNB_PPD_DEV_MASK) |
| #define SNB_PPD_TOPO_PRI_USD (SNB_PPD_CONN_RP | SNB_PPD_DEV_USD) |
| #define SNB_PPD_TOPO_PRI_DSD (SNB_PPD_CONN_RP | SNB_PPD_DEV_DSD) |
| #define SNB_PPD_TOPO_SEC_USD (SNB_PPD_CONN_TRANSPARENT | SNB_PPD_DEV_USD) |
| #define SNB_PPD_TOPO_SEC_DSD (SNB_PPD_CONN_TRANSPARENT | SNB_PPD_DEV_DSD) |
| #define SNB_PPD_TOPO_B2B_USD (SNB_PPD_CONN_B2B | SNB_PPD_DEV_USD) |
| #define SNB_PPD_TOPO_B2B_DSD (SNB_PPD_CONN_B2B | SNB_PPD_DEV_DSD) |
| |
| #define SNB_MW_COUNT 2 |
| #define HSX_SPLIT_BAR_MW_COUNT 3 |
| #define SNB_DB_COUNT 15 |
| #define SNB_DB_LINK 15 |
| #define SNB_DB_LINK_BIT BIT_ULL(SNB_DB_LINK) |
| #define SNB_DB_MSIX_VECTOR_COUNT 4 |
| #define SNB_DB_MSIX_VECTOR_SHIFT 5 |
| #define SNB_DB_TOTAL_SHIFT 16 |
| #define SNB_SPAD_COUNT 16 |
| |
| /* BWD hardware */ |
| |
| #define BWD_SBAR2XLAT_OFFSET 0x0008 |
| #define BWD_PDOORBELL_OFFSET 0x0020 |
| #define BWD_PDBMSK_OFFSET 0x0028 |
| #define BWD_NTBCNTL_OFFSET 0x0060 |
| #define BWD_SPAD_OFFSET 0x0080 |
| #define BWD_PPD_OFFSET 0x00d4 |
| #define BWD_PBAR2XLAT_OFFSET 0x8008 |
| #define BWD_B2B_DOORBELL_OFFSET 0x8020 |
| #define BWD_B2B_SPAD_OFFSET 0x8080 |
| #define BWD_SPCICMD_OFFSET 0xb004 |
| #define BWD_LINK_STATUS_OFFSET 0xb052 |
| #define BWD_ERRCORSTS_OFFSET 0xb110 |
| #define BWD_IP_BASE 0xc000 |
| #define BWD_DESKEWSTS_OFFSET (BWD_IP_BASE + 0x3024) |
| #define BWD_LTSSMERRSTS0_OFFSET (BWD_IP_BASE + 0x3180) |
| #define BWD_LTSSMSTATEJMP_OFFSET (BWD_IP_BASE + 0x3040) |
| #define BWD_IBSTERRRCRVSTS0_OFFSET (BWD_IP_BASE + 0x3324) |
| #define BWD_MODPHY_PCSREG4 0x1c004 |
| #define BWD_MODPHY_PCSREG6 0x1c006 |
| |
| #define BWD_PPD_INIT_LINK 0x0008 |
| #define BWD_PPD_CONN_MASK 0x0300 |
| #define BWD_PPD_CONN_TRANSPARENT 0x0000 |
| #define BWD_PPD_CONN_B2B 0x0100 |
| #define BWD_PPD_CONN_RP 0x0200 |
| #define BWD_PPD_DEV_MASK 0x1000 |
| #define BWD_PPD_DEV_USD 0x0000 |
| #define BWD_PPD_DEV_DSD 0x1000 |
| #define BWD_PPD_TOPO_MASK (BWD_PPD_CONN_MASK | BWD_PPD_DEV_MASK) |
| #define BWD_PPD_TOPO_PRI_USD (BWD_PPD_CONN_TRANSPARENT | BWD_PPD_DEV_USD) |
| #define BWD_PPD_TOPO_PRI_DSD (BWD_PPD_CONN_TRANSPARENT | BWD_PPD_DEV_DSD) |
| #define BWD_PPD_TOPO_SEC_USD (BWD_PPD_CONN_RP | BWD_PPD_DEV_USD) |
| #define BWD_PPD_TOPO_SEC_DSD (BWD_PPD_CONN_RP | BWD_PPD_DEV_DSD) |
| #define BWD_PPD_TOPO_B2B_USD (BWD_PPD_CONN_B2B | BWD_PPD_DEV_USD) |
| #define BWD_PPD_TOPO_B2B_DSD (BWD_PPD_CONN_B2B | BWD_PPD_DEV_DSD) |
| |
| #define BWD_MW_COUNT 2 |
| #define BWD_DB_COUNT 34 |
| #define BWD_DB_VALID_MASK (BIT_ULL(BWD_DB_COUNT) - 1) |
| #define BWD_DB_MSIX_VECTOR_COUNT 34 |
| #define BWD_DB_MSIX_VECTOR_SHIFT 1 |
| #define BWD_DB_TOTAL_SHIFT 34 |
| #define BWD_SPAD_COUNT 16 |
| |
| #define BWD_NTB_CTL_DOWN_BIT BIT(16) |
| #define BWD_NTB_CTL_ACTIVE(x) !(x & BWD_NTB_CTL_DOWN_BIT) |
| |
| #define BWD_DESKEWSTS_DBERR BIT(15) |
| #define BWD_LTSSMERRSTS0_UNEXPECTEDEI BIT(20) |
| #define BWD_LTSSMSTATEJMP_FORCEDETECT BIT(2) |
| #define BWD_IBIST_ERR_OFLOW 0x7FFF7FFF |
| |
| #define BWD_LINK_HB_TIMEOUT msecs_to_jiffies(1000) |
| #define BWD_LINK_RECOVERY_TIME msecs_to_jiffies(500) |
| |
| /* Ntb control and link status */ |
| |
| #define NTB_CTL_CFG_LOCK BIT(0) |
| #define NTB_CTL_DISABLE BIT(1) |
| #define NTB_CTL_S2P_BAR2_SNOOP BIT(2) |
| #define NTB_CTL_P2S_BAR2_SNOOP BIT(4) |
| #define NTB_CTL_S2P_BAR4_SNOOP BIT(6) |
| #define NTB_CTL_P2S_BAR4_SNOOP BIT(8) |
| #define NTB_CTL_S2P_BAR5_SNOOP BIT(12) |
| #define NTB_CTL_P2S_BAR5_SNOOP BIT(14) |
| |
| #define NTB_LNK_STA_ACTIVE_BIT 0x2000 |
| #define NTB_LNK_STA_SPEED_MASK 0x000f |
| #define NTB_LNK_STA_WIDTH_MASK 0x03f0 |
| #define NTB_LNK_STA_ACTIVE(x) (!!((x) & NTB_LNK_STA_ACTIVE_BIT)) |
| #define NTB_LNK_STA_SPEED(x) ((x) & NTB_LNK_STA_SPEED_MASK) |
| #define NTB_LNK_STA_WIDTH(x) (((x) & NTB_LNK_STA_WIDTH_MASK) >> 4) |
| |
| /* Use the following addresses for translation between b2b ntb devices in case |
| * the hardware default values are not reliable. */ |
| #define SNB_B2B_BAR0_USD_ADDR 0x1000000000000000ull |
| #define SNB_B2B_BAR2_USD_ADDR64 0x2000000000000000ull |
| #define SNB_B2B_BAR4_USD_ADDR64 0x4000000000000000ull |
| #define SNB_B2B_BAR4_USD_ADDR32 0x20000000u |
| #define SNB_B2B_BAR5_USD_ADDR32 0x40000000u |
| #define SNB_B2B_BAR0_DSD_ADDR 0x9000000000000000ull |
| #define SNB_B2B_BAR2_DSD_ADDR64 0xa000000000000000ull |
| #define SNB_B2B_BAR4_DSD_ADDR64 0xc000000000000000ull |
| #define SNB_B2B_BAR4_DSD_ADDR32 0xa0000000u |
| #define SNB_B2B_BAR5_DSD_ADDR32 0xc0000000u |
| |
| /* The peer ntb secondary config space is 32KB fixed size */ |
| #define SNB_B2B_MIN_SIZE 0x8000 |
| |
| /* flags to indicate hardware errata */ |
| #define NTB_HWERR_SDOORBELL_LOCKUP BIT_ULL(0) |
| #define NTB_HWERR_SB01BASE_LOCKUP BIT_ULL(1) |
| #define NTB_HWERR_B2BDOORBELL_BIT14 BIT_ULL(2) |
| |
| /* flags to indicate unsafe api */ |
| #define NTB_UNSAFE_DB BIT_ULL(0) |
| #define NTB_UNSAFE_SPAD BIT_ULL(1) |
| |
| struct intel_ntb_dev; |
| |
| struct intel_ntb_reg { |
| int (*poll_link)(struct intel_ntb_dev *ndev); |
| int (*link_is_up)(struct intel_ntb_dev *ndev); |
| u64 (*db_ioread)(void __iomem *mmio); |
| void (*db_iowrite)(u64 db_bits, void __iomem *mmio); |
| unsigned long ntb_ctl; |
| resource_size_t db_size; |
| int mw_bar[]; |
| }; |
| |
| struct intel_ntb_alt_reg { |
| unsigned long db_bell; |
| unsigned long db_mask; |
| unsigned long spad; |
| }; |
| |
| struct intel_ntb_xlat_reg { |
| unsigned long bar0_base; |
| unsigned long bar2_xlat; |
| unsigned long bar2_limit; |
| }; |
| |
| struct intel_b2b_addr { |
| phys_addr_t bar0_addr; |
| phys_addr_t bar2_addr64; |
| phys_addr_t bar4_addr64; |
| phys_addr_t bar4_addr32; |
| phys_addr_t bar5_addr32; |
| }; |
| |
| struct intel_ntb_vec { |
| struct intel_ntb_dev *ndev; |
| int num; |
| }; |
| |
| struct intel_ntb_dev { |
| struct ntb_dev ntb; |
| |
| /* offset of peer bar0 in b2b bar */ |
| unsigned long b2b_off; |
| /* mw idx used to access peer bar0 */ |
| unsigned int b2b_idx; |
| |
| /* BAR45 is split into BAR4 and BAR5 */ |
| bool bar4_split; |
| |
| u32 ntb_ctl; |
| u32 lnk_sta; |
| |
| unsigned char mw_count; |
| unsigned char spad_count; |
| unsigned char db_count; |
| unsigned char db_vec_count; |
| unsigned char db_vec_shift; |
| |
| u64 db_valid_mask; |
| u64 db_link_mask; |
| u64 db_mask; |
| |
| /* synchronize rmw access of db_mask and hw reg */ |
| spinlock_t db_mask_lock; |
| |
| struct msix_entry *msix; |
| struct intel_ntb_vec *vec; |
| |
| const struct intel_ntb_reg *reg; |
| const struct intel_ntb_alt_reg *self_reg; |
| const struct intel_ntb_alt_reg *peer_reg; |
| const struct intel_ntb_xlat_reg *xlat_reg; |
| void __iomem *self_mmio; |
| void __iomem *peer_mmio; |
| phys_addr_t peer_addr; |
| |
| unsigned long last_ts; |
| struct delayed_work hb_timer; |
| |
| unsigned long hwerr_flags; |
| unsigned long unsafe_flags; |
| unsigned long unsafe_flags_ignore; |
| |
| struct dentry *debugfs_dir; |
| struct dentry *debugfs_info; |
| }; |
| |
| #define ndev_pdev(ndev) ((ndev)->ntb.pdev) |
| #define ndev_name(ndev) pci_name(ndev_pdev(ndev)) |
| #define ndev_dev(ndev) (&ndev_pdev(ndev)->dev) |
| #define ntb_ndev(ntb) container_of(ntb, struct intel_ntb_dev, ntb) |
| #define hb_ndev(work) container_of(work, struct intel_ntb_dev, hb_timer.work) |
| |
| #endif |
