drivers/ntb/ntb_hw.h

   1 /*
   2  * This file is provided under a dual BSD/GPLv2 license.  When using or
   3  *   redistributing this file, you may do so under either license.
   4  *
   5  *   GPL LICENSE SUMMARY
   6  *
   7  *   Copyright(c) 2012 Intel Corporation. All rights reserved.
   8  *
   9  *   This program is free software; you can redistribute it and/or modify
  10  *   it under the terms of version 2 of the GNU General Public License as
  11  *   published by the Free Software Foundation.
  12  *
  13  *   BSD LICENSE
  14  *
  15  *   Copyright(c) 2012 Intel Corporation. All rights reserved.
  16  *
  17  *   Redistribution and use in source and binary forms, with or without
  18  *   modification, are permitted provided that the following conditions
  19  *   are met:
  20  *
  21  *     * Redistributions of source code must retain the above copyright
  22  *       notice, this list of conditions and the following disclaimer.
  23  *     * Redistributions in binary form must reproduce the above copy
  24  *       notice, this list of conditions and the following disclaimer in
  25  *       the documentation and/or other materials provided with the
  26  *       distribution.
  27  *     * Neither the name of Intel Corporation nor the names of its
  28  *       contributors may be used to endorse or promote products derived
  29  *       from this software without specific prior written permission.
  30  *
  31  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  34  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  36  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  37  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  38  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  39  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  40  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  41  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  42  *
  43  * Intel PCIe NTB Linux driver
  44  *
  45  * Contact Information:
  46  * Jon Mason <jon.mason@intel.com>
  47  */
  48
  49 #define PCI_DEVICE_ID_INTEL_NTB_B2B_JSF         0x3725
  50 #define PCI_DEVICE_ID_INTEL_NTB_PS_JSF          0x3726
  51 #define PCI_DEVICE_ID_INTEL_NTB_SS_JSF          0x3727
  52 #define PCI_DEVICE_ID_INTEL_NTB_B2B_SNB         0x3C0D
  53 #define PCI_DEVICE_ID_INTEL_NTB_PS_SNB          0x3C0E
  54 #define PCI_DEVICE_ID_INTEL_NTB_SS_SNB          0x3C0F
  55 #define PCI_DEVICE_ID_INTEL_NTB_B2B_IVT         0x0E0D
  56 #define PCI_DEVICE_ID_INTEL_NTB_PS_IVT          0x0E0E
  57 #define PCI_DEVICE_ID_INTEL_NTB_SS_IVT          0x0E0F
  58 #define PCI_DEVICE_ID_INTEL_NTB_B2B_HSX         0x2F0D
  59 #define PCI_DEVICE_ID_INTEL_NTB_PS_HSX          0x2F0E
  60 #define PCI_DEVICE_ID_INTEL_NTB_SS_HSX          0x2F0F
  61 #define PCI_DEVICE_ID_INTEL_NTB_B2B_BWD         0x0C4E
  62
  63 #define msix_table_size(control)        ((control & PCI_MSIX_FLAGS_QSIZE)+1)
  64
  65 #ifndef readq
  66 static inline u64 readq(void __iomem *addr)
  67 {
  68         return readl(addr) | (((u64) readl(addr + 4)) << 32LL);
  69 }
  70 #endif
  71
  72 #ifndef writeq
  73 static inline void writeq(u64 val, void __iomem *addr)
  74 {
  75         writel(val & 0xffffffff, addr);
  76         writel(val >> 32, addr + 4);
  77 }
  78 #endif
  79
  80 #define NTB_BAR_MMIO            0
  81 #define NTB_BAR_23              2
  82 #define NTB_BAR_45              4
  83 #define NTB_BAR_MASK            ((1 << NTB_BAR_MMIO) | (1 << NTB_BAR_23) |\
  84                                  (1 << NTB_BAR_45))
  85
  86 #define NTB_LINK_DOWN           0
  87 #define NTB_LINK_UP             1
  88
  89 #define NTB_HB_TIMEOUT          msecs_to_jiffies(1000)
  90
  91 #define NTB_MAX_NUM_MW          2
  92
  93 enum ntb_hw_event {
  94         NTB_EVENT_SW_EVENT0 = 0,
  95         NTB_EVENT_SW_EVENT1,
  96         NTB_EVENT_SW_EVENT2,
  97         NTB_EVENT_HW_ERROR,
  98         NTB_EVENT_HW_LINK_UP,
  99         NTB_EVENT_HW_LINK_DOWN,
 100 };
 101
 102 struct ntb_mw {
 103         dma_addr_t phys_addr;
 104         void __iomem *vbase;
 105         resource_size_t bar_sz;
 106 };
 107
 108 struct ntb_db_cb {
 109         void (*callback) (void *data, int db_num);
 110         unsigned int db_num;
 111         void *data;
 112         struct ntb_device *ndev;
 113 };
 114
 115 struct ntb_device {
 116         struct pci_dev *pdev;
 117         struct msix_entry *msix_entries;
 118         void __iomem *reg_base;
 119         struct ntb_mw mw[NTB_MAX_NUM_MW];
 120         struct {
 121                 unsigned char max_mw;
 122                 unsigned char max_spads;
 123                 unsigned char max_db_bits;
 124                 unsigned char msix_cnt;
 125         } limits;
 126         struct {
 127                 void __iomem *ldb;
 128                 void __iomem *ldb_mask;
 129                 void __iomem *rdb;
 130                 void __iomem *bar2_xlat;
 131                 void __iomem *bar4_xlat;
 132                 void __iomem *spad_write;
 133                 void __iomem *spad_read;
 134                 void __iomem *lnk_cntl;
 135                 void __iomem *lnk_stat;
 136                 void __iomem *spci_cmd;
 137         } reg_ofs;
 138         struct ntb_transport *ntb_transport;
 139         void (*event_cb)(void *handle, enum ntb_hw_event event);
 140
 141         struct ntb_db_cb *db_cb;
 142         unsigned char hw_type;
 143         unsigned char conn_type;
 144         unsigned char dev_type;
 145         unsigned char num_msix;
 146         unsigned char bits_per_vector;
 147         unsigned char max_cbs;
 148         unsigned char link_width;
 149         unsigned char link_speed;
 150         unsigned char link_status;
 151
 152         struct delayed_work hb_timer;
 153         unsigned long last_ts;
 154
 155         struct delayed_work lr_timer;
 156
 157         struct dentry *debugfs_dir;
 158 };
 159
 160 /**
 161  * ntb_max_cbs() - return the max callbacks
 162  * @ndev: pointer to ntb_device instance
 163  *
 164  * Given the ntb pointer, return the maximum number of callbacks
 165  *
 166  * RETURNS: the maximum number of callbacks
 167  */
 168 static inline unsigned char ntb_max_cbs(struct ntb_device *ndev)
 169 {
 170         return ndev->max_cbs;
 171 }
 172
 173 /**
 174  * ntb_max_mw() - return the max number of memory windows
 175  * @ndev: pointer to ntb_device instance
 176  *
 177  * Given the ntb pointer, return the maximum number of memory windows
 178  *
 179  * RETURNS: the maximum number of memory windows
 180  */
 181 static inline unsigned char ntb_max_mw(struct ntb_device *ndev)
 182 {
 183         return ndev->limits.max_mw;
 184 }
 185
 186 /**
 187  * ntb_hw_link_status() - return the hardware link status
 188  * @ndev: pointer to ntb_device instance
 189  *
 190  * Returns true if the hardware is connected to the remote system
 191  *
 192  * RETURNS: true or false based on the hardware link state
 193  */
 194 static inline bool ntb_hw_link_status(struct ntb_device *ndev)
 195 {
 196         return ndev->link_status == NTB_LINK_UP;
 197 }
 198
 199 /**
 200  * ntb_query_pdev() - return the pci_dev pointer
 201  * @ndev: pointer to ntb_device instance
 202  *
 203  * Given the ntb pointer, return the pci_dev pointer for the NTB hardware device
 204  *
 205  * RETURNS: a pointer to the ntb pci_dev
 206  */
 207 static inline struct pci_dev *ntb_query_pdev(struct ntb_device *ndev)
 208 {
 209         return ndev->pdev;
 210 }
 211
 212 /**
 213  * ntb_query_debugfs() - return the debugfs pointer
 214  * @ndev: pointer to ntb_device instance
 215  *
 216  * Given the ntb pointer, return the debugfs directory pointer for the NTB
 217  * hardware device
 218  *
 219  * RETURNS: a pointer to the debugfs directory
 220  */
 221 static inline struct dentry *ntb_query_debugfs(struct ntb_device *ndev)
 222 {
 223         return ndev->debugfs_dir;
 224 }
 225
 226 struct ntb_device *ntb_register_transport(struct pci_dev *pdev,
 227                                           void *transport);
 228 void ntb_unregister_transport(struct ntb_device *ndev);
 229 void ntb_set_mw_addr(struct ntb_device *ndev, unsigned int mw, u64 addr);
 230 int ntb_register_db_callback(struct ntb_device *ndev, unsigned int idx,
 231                              void *data, void (*db_cb_func) (void *data,
 232                                                              int db_num));
 233 void ntb_unregister_db_callback(struct ntb_device *ndev, unsigned int idx);
 234 int ntb_register_event_callback(struct ntb_device *ndev,
 235                                 void (*event_cb_func) (void *handle,
 236                                                       enum ntb_hw_event event));
 237 void ntb_unregister_event_callback(struct ntb_device *ndev);
 238 int ntb_get_max_spads(struct ntb_device *ndev);
 239 int ntb_write_local_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
 240 int ntb_read_local_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
 241 int ntb_write_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
 242 int ntb_read_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
 243 resource_size_t ntb_get_mw_base(struct ntb_device *ndev, unsigned int mw);
 244 void __iomem *ntb_get_mw_vbase(struct ntb_device *ndev, unsigned int mw);
 245 u64 ntb_get_mw_size(struct ntb_device *ndev, unsigned int mw);
 246 void ntb_ring_doorbell(struct ntb_device *ndev, unsigned int idx);
 247 void *ntb_find_transport(struct pci_dev *pdev);
 248
 249 int ntb_transport_init(struct pci_dev *pdev);
 250 void ntb_transport_free(void *transport);