blob: d1960ffb4bbc95d0ee02e13432470c9ddfc07707 [file] [log] [blame]
Jon Masonfce8a7b2012-11-16 19:27:12 -07001/*
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 */
Jon Mason403c63c2013-07-29 16:31:18 -070048#include <linux/ntb.h>
Jon Masonfce8a7b2012-11-16 19:27:12 -070049
50#define PCI_DEVICE_ID_INTEL_NTB_B2B_JSF 0x3725
Jon Masonbe4dac02012-09-28 11:38:48 -070051#define PCI_DEVICE_ID_INTEL_NTB_PS_JSF 0x3726
52#define PCI_DEVICE_ID_INTEL_NTB_SS_JSF 0x3727
Jon Masonfce8a7b2012-11-16 19:27:12 -070053#define PCI_DEVICE_ID_INTEL_NTB_B2B_SNB 0x3C0D
Jon Masonbe4dac02012-09-28 11:38:48 -070054#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
Jon Masonfce8a7b2012-11-16 19:27:12 -070062#define PCI_DEVICE_ID_INTEL_NTB_B2B_BWD 0x0C4E
63
64#define msix_table_size(control) ((control & PCI_MSIX_FLAGS_QSIZE)+1)
65
Jon Masonac477af2013-01-21 16:40:39 -070066#ifndef readq
67static inline u64 readq(void __iomem *addr)
68{
69 return readl(addr) | (((u64) readl(addr + 4)) << 32LL);
70}
71#endif
72
73#ifndef writeq
74static inline void writeq(u64 val, void __iomem *addr)
75{
76 writel(val & 0xffffffff, addr);
77 writel(val >> 32, addr + 4);
78}
79#endif
80
Jon Masonfce8a7b2012-11-16 19:27:12 -070081#define NTB_BAR_MMIO 0
82#define NTB_BAR_23 2
83#define NTB_BAR_45 4
84#define NTB_BAR_MASK ((1 << NTB_BAR_MMIO) | (1 << NTB_BAR_23) |\
85 (1 << NTB_BAR_45))
86
Jon Masonfce8a7b2012-11-16 19:27:12 -070087#define NTB_HB_TIMEOUT msecs_to_jiffies(1000)
88
Jon Mason948d3a62013-04-18 17:07:36 -070089#define NTB_MAX_NUM_MW 2
Jon Masonfce8a7b2012-11-16 19:27:12 -070090
91enum ntb_hw_event {
92 NTB_EVENT_SW_EVENT0 = 0,
93 NTB_EVENT_SW_EVENT1,
94 NTB_EVENT_SW_EVENT2,
95 NTB_EVENT_HW_ERROR,
96 NTB_EVENT_HW_LINK_UP,
97 NTB_EVENT_HW_LINK_DOWN,
98};
99
100struct ntb_mw {
101 dma_addr_t phys_addr;
102 void __iomem *vbase;
103 resource_size_t bar_sz;
104};
105
106struct ntb_db_cb {
Jon Masone8aeb602013-04-18 17:59:44 -0700107 int (*callback)(void *data, int db_num);
Jon Masonfce8a7b2012-11-16 19:27:12 -0700108 unsigned int db_num;
109 void *data;
110 struct ntb_device *ndev;
Jon Masone8aeb602013-04-18 17:59:44 -0700111 struct tasklet_struct irq_work;
Jon Masonfce8a7b2012-11-16 19:27:12 -0700112};
113
114struct ntb_device {
115 struct pci_dev *pdev;
116 struct msix_entry *msix_entries;
117 void __iomem *reg_base;
Jon Mason948d3a62013-04-18 17:07:36 -0700118 struct ntb_mw mw[NTB_MAX_NUM_MW];
Jon Masonfce8a7b2012-11-16 19:27:12 -0700119 struct {
Jon Mason948d3a62013-04-18 17:07:36 -0700120 unsigned char max_mw;
121 unsigned char max_spads;
122 unsigned char max_db_bits;
123 unsigned char msix_cnt;
Jon Masonfce8a7b2012-11-16 19:27:12 -0700124 } limits;
125 struct {
Jon Mason49793882013-07-15 15:53:54 -0700126 void __iomem *ldb;
127 void __iomem *ldb_mask;
128 void __iomem *rdb;
129 void __iomem *bar2_xlat;
130 void __iomem *bar4_xlat;
Jon Masonfce8a7b2012-11-16 19:27:12 -0700131 void __iomem *spad_write;
132 void __iomem *spad_read;
133 void __iomem *lnk_cntl;
134 void __iomem *lnk_stat;
135 void __iomem *spci_cmd;
136 } reg_ofs;
137 struct ntb_transport *ntb_transport;
138 void (*event_cb)(void *handle, enum ntb_hw_event event);
139
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;
Jon Mason113bf1c2012-11-16 18:52:57 -0700147 unsigned char link_width;
148 unsigned char link_speed;
Jon Masonfce8a7b2012-11-16 19:27:12 -0700149 unsigned char link_status;
Jon Mason113bf1c2012-11-16 18:52:57 -0700150
Jon Masonfce8a7b2012-11-16 19:27:12 -0700151 struct delayed_work hb_timer;
152 unsigned long last_ts;
Jon Mason1517a3f2013-07-30 15:58:49 -0700153
Jon Mason113bf1c2012-11-16 18:52:57 -0700154 struct delayed_work lr_timer;
155
Jon Mason1517a3f2013-07-30 15:58:49 -0700156 struct dentry *debugfs_dir;
Jon Masonfce8a7b2012-11-16 19:27:12 -0700157};
158
159/**
Jon Mason948d3a62013-04-18 17:07:36 -0700160 * ntb_max_cbs() - return the max callbacks
161 * @ndev: pointer to ntb_device instance
162 *
163 * Given the ntb pointer, return the maximum number of callbacks
164 *
165 * RETURNS: the maximum number of callbacks
166 */
167static inline unsigned char ntb_max_cbs(struct ntb_device *ndev)
168{
169 return ndev->max_cbs;
170}
171
172/**
173 * ntb_max_mw() - return the max number of memory windows
174 * @ndev: pointer to ntb_device instance
175 *
176 * Given the ntb pointer, return the maximum number of memory windows
177 *
178 * RETURNS: the maximum number of memory windows
179 */
180static inline unsigned char ntb_max_mw(struct ntb_device *ndev)
181{
182 return ndev->limits.max_mw;
183}
184
185/**
Jon Masonfce8a7b2012-11-16 19:27:12 -0700186 * ntb_hw_link_status() - return the hardware link status
187 * @ndev: pointer to ntb_device instance
188 *
189 * Returns true if the hardware is connected to the remote system
190 *
191 * RETURNS: true or false based on the hardware link state
192 */
193static inline bool ntb_hw_link_status(struct ntb_device *ndev)
194{
195 return ndev->link_status == NTB_LINK_UP;
196}
197
198/**
199 * ntb_query_pdev() - return the pci_dev pointer
200 * @ndev: pointer to ntb_device instance
201 *
Jon Mason948d3a62013-04-18 17:07:36 -0700202 * Given the ntb pointer, return the pci_dev pointer for the NTB hardware device
Jon Masonfce8a7b2012-11-16 19:27:12 -0700203 *
204 * RETURNS: a pointer to the ntb pci_dev
205 */
206static inline struct pci_dev *ntb_query_pdev(struct ntb_device *ndev)
207{
208 return ndev->pdev;
209}
210
Jon Mason1517a3f2013-07-30 15:58:49 -0700211/**
212 * ntb_query_debugfs() - return the debugfs pointer
213 * @ndev: pointer to ntb_device instance
214 *
215 * Given the ntb pointer, return the debugfs directory pointer for the NTB
216 * hardware device
217 *
218 * RETURNS: a pointer to the debugfs directory
219 */
220static inline struct dentry *ntb_query_debugfs(struct ntb_device *ndev)
221{
222 return ndev->debugfs_dir;
223}
224
Jon Masonfce8a7b2012-11-16 19:27:12 -0700225struct ntb_device *ntb_register_transport(struct pci_dev *pdev,
226 void *transport);
227void ntb_unregister_transport(struct ntb_device *ndev);
228void ntb_set_mw_addr(struct ntb_device *ndev, unsigned int mw, u64 addr);
229int ntb_register_db_callback(struct ntb_device *ndev, unsigned int idx,
Jon Masone8aeb602013-04-18 17:59:44 -0700230 void *data, int (*db_cb_func)(void *data,
231 int db_num));
Jon Masonfce8a7b2012-11-16 19:27:12 -0700232void ntb_unregister_db_callback(struct ntb_device *ndev, unsigned int idx);
233int ntb_register_event_callback(struct ntb_device *ndev,
234 void (*event_cb_func) (void *handle,
Jon Mason74465642013-01-21 15:28:52 -0700235 enum ntb_hw_event event));
Jon Masonfce8a7b2012-11-16 19:27:12 -0700236void ntb_unregister_event_callback(struct ntb_device *ndev);
237int ntb_get_max_spads(struct ntb_device *ndev);
238int ntb_write_local_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
239int ntb_read_local_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
240int ntb_write_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
241int ntb_read_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
Jon Mason282a2fe2013-02-12 09:52:50 -0700242resource_size_t ntb_get_mw_base(struct ntb_device *ndev, unsigned int mw);
Jon Mason74465642013-01-21 15:28:52 -0700243void __iomem *ntb_get_mw_vbase(struct ntb_device *ndev, unsigned int mw);
Jon Masonac477af2013-01-21 16:40:39 -0700244u64 ntb_get_mw_size(struct ntb_device *ndev, unsigned int mw);
Jon Mason49793882013-07-15 15:53:54 -0700245void ntb_ring_doorbell(struct ntb_device *ndev, unsigned int idx);
Jon Masonfce8a7b2012-11-16 19:27:12 -0700246void *ntb_find_transport(struct pci_dev *pdev);
247
248int ntb_transport_init(struct pci_dev *pdev);
249void ntb_transport_free(void *transport);