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_CLASSIC_JSF     0x3726
  51 #define PCI_DEVICE_ID_INTEL_NTB_RP_JSF          0x3727
  52 #define PCI_DEVICE_ID_INTEL_NTB_RP_SNB          0x3C08
  53 #define PCI_DEVICE_ID_INTEL_NTB_B2B_SNB         0x3C0D
  54 #define PCI_DEVICE_ID_INTEL_NTB_CLASSIC_SNB     0x3C0E
  55 #define PCI_DEVICE_ID_INTEL_NTB_2ND_SNB         0x3C0F
  56 #define PCI_DEVICE_ID_INTEL_NTB_B2B_BWD         0x0C4E
  57
  58 #define msix_table_size(control)        ((control & PCI_MSIX_FLAGS_QSIZE)+1)
  59
  60 #define NTB_BAR_MMIO            0
  61 #define NTB_BAR_23              2
  62 #define NTB_BAR_45              4
  63 #define NTB_BAR_MASK            ((1 << NTB_BAR_MMIO) | (1 << NTB_BAR_23) |\
  64                                  (1 << NTB_BAR_45))
  65
  66 #define NTB_LINK_DOWN           0
  67 #define NTB_LINK_UP             1
  68
  69 #define NTB_HB_TIMEOUT          msecs_to_jiffies(1000)
  70
  71 #define NTB_MAX_NUM_MW          2
  72
  73 enum ntb_hw_event {
  74         NTB_EVENT_SW_EVENT0 = 0,
  75         NTB_EVENT_SW_EVENT1,
  76         NTB_EVENT_SW_EVENT2,
  77         NTB_EVENT_HW_ERROR,
  78         NTB_EVENT_HW_LINK_UP,
  79         NTB_EVENT_HW_LINK_DOWN,
  80 };
  81
  82 struct ntb_mw {
  83         dma_addr_t phys_addr;
  84         void __iomem *vbase;
  85         resource_size_t bar_sz;
  86 };
  87
  88 struct ntb_db_cb {
  89         void (*callback) (void *data, int db_num);
  90         unsigned int db_num;
  91         void *data;
  92         struct ntb_device *ndev;
  93 };
  94
  95 struct ntb_device {
  96         struct pci_dev *pdev;
  97         struct msix_entry *msix_entries;
  98         void __iomem *reg_base;
  99         struct ntb_mw mw[NTB_MAX_NUM_MW];
 100         struct {
 101                 unsigned char max_mw;
 102                 unsigned char max_spads;
 103                 unsigned char max_db_bits;
 104                 unsigned char msix_cnt;
 105         } limits;
 106         struct {
 107                 void __iomem *pdb;
 108                 void __iomem *pdb_mask;
 109                 void __iomem *sdb;
 110                 void __iomem *sbar2_xlat;
 111                 void __iomem *sbar4_xlat;
 112                 void __iomem *spad_write;
 113                 void __iomem *spad_read;
 114                 void __iomem *lnk_cntl;
 115                 void __iomem *lnk_stat;
 116                 void __iomem *spci_cmd;
 117         } reg_ofs;
 118         struct ntb_transport *ntb_transport;
 119         void (*event_cb)(void *handle, enum ntb_hw_event event);
 120
 121         struct ntb_db_cb *db_cb;
 122         unsigned char hw_type;
 123         unsigned char conn_type;
 124         unsigned char dev_type;
 125         unsigned char num_msix;
 126         unsigned char bits_per_vector;
 127         unsigned char max_cbs;
 128         unsigned char link_width;
 129         unsigned char link_speed;
 130         unsigned char link_status;
 131
 132         struct delayed_work hb_timer;
 133         unsigned long last_ts;
 134
 135         struct delayed_work lr_timer;
 136
 137         struct dentry *debugfs_dir;
 138 };
 139
 140 /**
 141  * ntb_max_cbs() - return the max callbacks
 142  * @ndev: pointer to ntb_device instance
 143  *
 144  * Given the ntb pointer, return the maximum number of callbacks
 145  *
 146  * RETURNS: the maximum number of callbacks
 147  */
 148 static inline unsigned char ntb_max_cbs(struct ntb_device *ndev)
 149 {
 150         return ndev->max_cbs;
 151 }
 152
 153 /**
 154  * ntb_max_mw() - return the max number of memory windows
 155  * @ndev: pointer to ntb_device instance
 156  *
 157  * Given the ntb pointer, return the maximum number of memory windows
 158  *
 159  * RETURNS: the maximum number of memory windows
 160  */
 161 static inline unsigned char ntb_max_mw(struct ntb_device *ndev)
 162 {
 163         return ndev->limits.max_mw;
 164 }
 165
 166 /**
 167  * ntb_hw_link_status() - return the hardware link status
 168  * @ndev: pointer to ntb_device instance
 169  *
 170  * Returns true if the hardware is connected to the remote system
 171  *
 172  * RETURNS: true or false based on the hardware link state
 173  */
 174 static inline bool ntb_hw_link_status(struct ntb_device *ndev)
 175 {
 176         return ndev->link_status == NTB_LINK_UP;
 177 }
 178
 179 /**
 180  * ntb_query_pdev() - return the pci_dev pointer
 181  * @ndev: pointer to ntb_device instance
 182  *
 183  * Given the ntb pointer, return the pci_dev pointer for the NTB hardware device
 184  *
 185  * RETURNS: a pointer to the ntb pci_dev
 186  */
 187 static inline struct pci_dev *ntb_query_pdev(struct ntb_device *ndev)
 188 {
 189         return ndev->pdev;
 190 }
 191
 192 /**
 193  * ntb_query_debugfs() - return the debugfs pointer
 194  * @ndev: pointer to ntb_device instance
 195  *
 196  * Given the ntb pointer, return the debugfs directory pointer for the NTB
 197  * hardware device
 198  *
 199  * RETURNS: a pointer to the debugfs directory
 200  */
 201 static inline struct dentry *ntb_query_debugfs(struct ntb_device *ndev)
 202 {
 203         return ndev->debugfs_dir;
 204 }
 205
 206 struct ntb_device *ntb_register_transport(struct pci_dev *pdev,
 207                                           void *transport);
 208 void ntb_unregister_transport(struct ntb_device *ndev);
 209 void ntb_set_mw_addr(struct ntb_device *ndev, unsigned int mw, u64 addr);
 210 int ntb_register_db_callback(struct ntb_device *ndev, unsigned int idx,
 211                              void *data, void (*db_cb_func) (void *data,
 212                                                              int db_num));
 213 void ntb_unregister_db_callback(struct ntb_device *ndev, unsigned int idx);
 214 int ntb_register_event_callback(struct ntb_device *ndev,
 215                                 void (*event_cb_func) (void *handle,
 216                                                       enum ntb_hw_event event));
 217 void ntb_unregister_event_callback(struct ntb_device *ndev);
 218 int ntb_get_max_spads(struct ntb_device *ndev);
 219 int ntb_write_local_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
 220 int ntb_read_local_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
 221 int ntb_write_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
 222 int ntb_read_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
 223 void __iomem *ntb_get_mw_vbase(struct ntb_device *ndev, unsigned int mw);
 224 resource_size_t ntb_get_mw_size(struct ntb_device *ndev, unsigned int mw);
 225 void ntb_ring_sdb(struct ntb_device *ndev, unsigned int idx);
 226 void *ntb_find_transport(struct pci_dev *pdev);
 227
 228 int ntb_transport_init(struct pci_dev *pdev);
 229 void ntb_transport_free(void *transport);