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.
7 * Copyright(c) 2012 Intel Corporation. All rights reserved.
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.
15 * Copyright(c) 2012 Intel Corporation. All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
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
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.
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.
43 * Intel PCIe NTB Linux driver
45 * Contact Information:
46 * Jon Mason <jon.mason@intel.com>
48 #include <linux/ntb.h>
50 #define PCI_DEVICE_ID_INTEL_NTB_B2B_JSF 0x3725
51 #define PCI_DEVICE_ID_INTEL_NTB_PS_JSF 0x3726
52 #define PCI_DEVICE_ID_INTEL_NTB_SS_JSF 0x3727
53 #define PCI_DEVICE_ID_INTEL_NTB_B2B_SNB 0x3C0D
54 #define PCI_DEVICE_ID_INTEL_NTB_PS_SNB 0x3C0E
55 #define PCI_DEVICE_ID_INTEL_NTB_SS_SNB 0x3C0F
56 #define PCI_DEVICE_ID_INTEL_NTB_B2B_IVT 0x0E0D
57 #define PCI_DEVICE_ID_INTEL_NTB_PS_IVT 0x0E0E
58 #define PCI_DEVICE_ID_INTEL_NTB_SS_IVT 0x0E0F
59 #define PCI_DEVICE_ID_INTEL_NTB_B2B_HSX 0x2F0D
60 #define PCI_DEVICE_ID_INTEL_NTB_PS_HSX 0x2F0E
61 #define PCI_DEVICE_ID_INTEL_NTB_SS_HSX 0x2F0F
62 #define PCI_DEVICE_ID_INTEL_NTB_B2B_BWD 0x0C4E
64 #define msix_table_size(control) ((control & PCI_MSIX_FLAGS_QSIZE)+1)
67 static inline u64 readq(void __iomem *addr)
69 return readl(addr) | (((u64) readl(addr + 4)) << 32LL);
74 static inline void writeq(u64 val, void __iomem *addr)
76 writel(val & 0xffffffff, addr);
77 writel(val >> 32, addr + 4);
81 #define NTB_BAR_MMIO 0
84 #define NTB_BAR_MASK ((1 << NTB_BAR_MMIO) | (1 << NTB_BAR_23) |\
87 #define NTB_HB_TIMEOUT msecs_to_jiffies(1000)
89 #define NTB_MAX_NUM_MW 2
92 NTB_EVENT_SW_EVENT0 = 0,
97 NTB_EVENT_HW_LINK_DOWN,
101 dma_addr_t phys_addr;
103 resource_size_t bar_sz;
107 int (*callback)(void *data, int db_num);
110 struct ntb_device *ndev;
111 struct tasklet_struct irq_work;
115 struct pci_dev *pdev;
116 struct msix_entry *msix_entries;
117 void __iomem *reg_base;
118 struct ntb_mw mw[NTB_MAX_NUM_MW];
120 unsigned char max_mw;
121 unsigned char max_spads;
122 unsigned char max_db_bits;
123 unsigned char msix_cnt;
127 void __iomem *ldb_mask;
129 void __iomem *bar2_xlat;
130 void __iomem *bar4_xlat;
131 void __iomem *spad_write;
132 void __iomem *spad_read;
133 void __iomem *lnk_cntl;
134 void __iomem *lnk_stat;
135 void __iomem *spci_cmd;
137 struct ntb_transport *ntb_transport;
138 void (*event_cb)(void *handle, enum ntb_hw_event event);
140 struct ntb_db_cb *db_cb;
141 unsigned char hw_type;
142 unsigned char conn_type;
143 unsigned char dev_type;
144 unsigned char num_msix;
145 unsigned char bits_per_vector;
146 unsigned char max_cbs;
147 unsigned char link_width;
148 unsigned char link_speed;
149 unsigned char link_status;
151 struct delayed_work hb_timer;
152 unsigned long last_ts;
154 struct delayed_work lr_timer;
156 struct dentry *debugfs_dir;
160 * ntb_max_cbs() - return the max callbacks
161 * @ndev: pointer to ntb_device instance
163 * Given the ntb pointer, return the maximum number of callbacks
165 * RETURNS: the maximum number of callbacks
167 static inline unsigned char ntb_max_cbs(struct ntb_device *ndev)
169 return ndev->max_cbs;
173 * ntb_max_mw() - return the max number of memory windows
174 * @ndev: pointer to ntb_device instance
176 * Given the ntb pointer, return the maximum number of memory windows
178 * RETURNS: the maximum number of memory windows
180 static inline unsigned char ntb_max_mw(struct ntb_device *ndev)
182 return ndev->limits.max_mw;
186 * ntb_hw_link_status() - return the hardware link status
187 * @ndev: pointer to ntb_device instance
189 * Returns true if the hardware is connected to the remote system
191 * RETURNS: true or false based on the hardware link state
193 static inline bool ntb_hw_link_status(struct ntb_device *ndev)
195 return ndev->link_status == NTB_LINK_UP;
199 * ntb_query_pdev() - return the pci_dev pointer
200 * @ndev: pointer to ntb_device instance
202 * Given the ntb pointer, return the pci_dev pointer for the NTB hardware device
204 * RETURNS: a pointer to the ntb pci_dev
206 static inline struct pci_dev *ntb_query_pdev(struct ntb_device *ndev)
212 * ntb_query_debugfs() - return the debugfs pointer
213 * @ndev: pointer to ntb_device instance
215 * Given the ntb pointer, return the debugfs directory pointer for the NTB
218 * RETURNS: a pointer to the debugfs directory
220 static inline struct dentry *ntb_query_debugfs(struct ntb_device *ndev)
222 return ndev->debugfs_dir;
225 struct ntb_device *ntb_register_transport(struct pci_dev *pdev,
227 void ntb_unregister_transport(struct ntb_device *ndev);
228 void ntb_set_mw_addr(struct ntb_device *ndev, unsigned int mw, u64 addr);
229 int ntb_register_db_callback(struct ntb_device *ndev, unsigned int idx,
230 void *data, int (*db_cb_func)(void *data,
232 void ntb_unregister_db_callback(struct ntb_device *ndev, unsigned int idx);
233 int ntb_register_event_callback(struct ntb_device *ndev,
234 void (*event_cb_func)(void *handle,
235 enum ntb_hw_event event));
236 void ntb_unregister_event_callback(struct ntb_device *ndev);
237 int ntb_get_max_spads(struct ntb_device *ndev);
238 int ntb_write_local_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
239 int ntb_read_local_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
240 int ntb_write_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
241 int ntb_read_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
242 resource_size_t ntb_get_mw_base(struct ntb_device *ndev, unsigned int mw);
243 void __iomem *ntb_get_mw_vbase(struct ntb_device *ndev, unsigned int mw);
244 u64 ntb_get_mw_size(struct ntb_device *ndev, unsigned int mw);
245 void ntb_ring_doorbell(struct ntb_device *ndev, unsigned int idx);
246 void *ntb_find_transport(struct pci_dev *pdev);
248 int ntb_transport_init(struct pci_dev *pdev);
249 void ntb_transport_free(void *transport);