[deliverable/linux.git] / drivers / ntb / ntb_hw.h

/*
 * 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.
 *
 *   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.
 *
 *   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>
 */

#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

#define msix_table_size(control)	((control & PCI_MSIX_FLAGS_QSIZE)+1)

#ifndef readq
static inline u64 readq(void __iomem *addr)
{
	return readl(addr) | (((u64) readl(addr + 4)) << 32LL);
}
#endif

#ifndef writeq
static inline void writeq(u64 val, void __iomem *addr)
{
	writel(val & 0xffffffff, addr);
	writel(val >> 32, addr + 4);
}
#endif

#define NTB_BAR_MMIO		0
#define NTB_BAR_23		2
#define NTB_BAR_45		4
#define NTB_BAR_MASK		((1 << NTB_BAR_MMIO) | (1 << NTB_BAR_23) |\
				 (1 << NTB_BAR_45))

#define NTB_LINK_DOWN		0
#define NTB_LINK_UP		1

#define NTB_HB_TIMEOUT		msecs_to_jiffies(1000)

#define NTB_MAX_NUM_MW		2

enum ntb_hw_event {
	NTB_EVENT_SW_EVENT0 = 0,
	NTB_EVENT_SW_EVENT1,
	NTB_EVENT_SW_EVENT2,
	NTB_EVENT_HW_ERROR,
	NTB_EVENT_HW_LINK_UP,
	NTB_EVENT_HW_LINK_DOWN,
};

struct ntb_mw {
	dma_addr_t phys_addr;
	void __iomem *vbase;
	resource_size_t bar_sz;
};

struct ntb_db_cb {
	int (*callback)(void *data, int db_num);
	unsigned int db_num;
	void *data;
	struct ntb_device *ndev;
	struct tasklet_struct irq_work;
};

struct ntb_device {
	struct pci_dev *pdev;
	struct msix_entry *msix_entries;
	void __iomem *reg_base;
	struct ntb_mw mw[NTB_MAX_NUM_MW];
	struct {
		unsigned char max_mw;
		unsigned char max_spads;
		unsigned char max_db_bits;
		unsigned char msix_cnt;
	} limits;
	struct {
		void __iomem *ldb;
		void __iomem *ldb_mask;
		void __iomem *rdb;
		void __iomem *bar2_xlat;
		void __iomem *bar4_xlat;
		void __iomem *spad_write;
		void __iomem *spad_read;
		void __iomem *lnk_cntl;
		void __iomem *lnk_stat;
		void __iomem *spci_cmd;
	} reg_ofs;
	struct ntb_transport *ntb_transport;
	void (*event_cb)(void *handle, enum ntb_hw_event event);

	struct ntb_db_cb *db_cb;
	unsigned char hw_type;
	unsigned char conn_type;
	unsigned char dev_type;
	unsigned char num_msix;
	unsigned char bits_per_vector;
	unsigned char max_cbs;
	unsigned char link_width;
	unsigned char link_speed;
	unsigned char link_status;

	struct delayed_work hb_timer;
	unsigned long last_ts;

	struct delayed_work lr_timer;

	struct dentry *debugfs_dir;
};

/**
 * ntb_max_cbs() - return the max callbacks
 * @ndev: pointer to ntb_device instance
 *
 * Given the ntb pointer, return the maximum number of callbacks
 *
 * RETURNS: the maximum number of callbacks
 */
static inline unsigned char ntb_max_cbs(struct ntb_device *ndev)
{
	return ndev->max_cbs;
}

/**
 * ntb_max_mw() - return the max number of memory windows
 * @ndev: pointer to ntb_device instance
 *
 * Given the ntb pointer, return the maximum number of memory windows
 *
 * RETURNS: the maximum number of memory windows
 */
static inline unsigned char ntb_max_mw(struct ntb_device *ndev)
{
	return ndev->limits.max_mw;
}

/**
 * ntb_hw_link_status() - return the hardware link status
 * @ndev: pointer to ntb_device instance
 *
 * Returns true if the hardware is connected to the remote system
 *
 * RETURNS: true or false based on the hardware link state
 */
static inline bool ntb_hw_link_status(struct ntb_device *ndev)
{
	return ndev->link_status == NTB_LINK_UP;
}

/**
 * ntb_query_pdev() - return the pci_dev pointer
 * @ndev: pointer to ntb_device instance
 *
 * Given the ntb pointer, return the pci_dev pointer for the NTB hardware device
 *
 * RETURNS: a pointer to the ntb pci_dev
 */
static inline struct pci_dev *ntb_query_pdev(struct ntb_device *ndev)
{
	return ndev->pdev;
}

/**
 * ntb_query_debugfs() - return the debugfs pointer
 * @ndev: pointer to ntb_device instance
 *
 * Given the ntb pointer, return the debugfs directory pointer for the NTB
 * hardware device
 *
 * RETURNS: a pointer to the debugfs directory
 */
static inline struct dentry *ntb_query_debugfs(struct ntb_device *ndev)
{
	return ndev->debugfs_dir;
}

struct ntb_device *ntb_register_transport(struct pci_dev *pdev,
					  void *transport);
void ntb_unregister_transport(struct ntb_device *ndev);
void ntb_set_mw_addr(struct ntb_device *ndev, unsigned int mw, u64 addr);
int ntb_register_db_callback(struct ntb_device *ndev, unsigned int idx,
			     void *data, int (*db_cb_func)(void *data,
							   int db_num));
void ntb_unregister_db_callback(struct ntb_device *ndev, unsigned int idx);
int ntb_register_event_callback(struct ntb_device *ndev,
				void (*event_cb_func) (void *handle,
						      enum ntb_hw_event event));
void ntb_unregister_event_callback(struct ntb_device *ndev);
int ntb_get_max_spads(struct ntb_device *ndev);
int ntb_write_local_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
int ntb_read_local_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
int ntb_write_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
int ntb_read_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 *val);
resource_size_t ntb_get_mw_base(struct ntb_device *ndev, unsigned int mw);
void __iomem *ntb_get_mw_vbase(struct ntb_device *ndev, unsigned int mw);
u64 ntb_get_mw_size(struct ntb_device *ndev, unsigned int mw);
void ntb_ring_doorbell(struct ntb_device *ndev, unsigned int idx);
void *ntb_find_transport(struct pci_dev *pdev);

int ntb_transport_init(struct pci_dev *pdev);
void ntb_transport_free(void *transport);
Commit	Line	Data
fce8a7bb JM	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
be4dac0f JM	50	#define PCI_DEVICE_ID_INTEL_NTB_PS_JSF 0x3726
be4dac0f JM	51	#define PCI_DEVICE_ID_INTEL_NTB_SS_JSF 0x3727
fce8a7bb	52	#define PCI_DEVICE_ID_INTEL_NTB_B2B_SNB 0x3C0D
be4dac0f JM	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
fce8a7bb JM	61	#define PCI_DEVICE_ID_INTEL_NTB_B2B_BWD 0x0C4E
	62
	63	#define msix_table_size(control) ((control & PCI_MSIX_FLAGS_QSIZE)+1)
	64
ac477afb JM	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
fce8a7bb JM	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
948d3a65	91	#define NTB_MAX_NUM_MW 2
fce8a7bb JM	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 {
e8aeb60c	109	int (callback)(void data, int db_num);
fce8a7bb JM	110	unsigned int db_num;
	111	void *data;
	112	struct ntb_device *ndev;
e8aeb60c	113	struct tasklet_struct irq_work;
fce8a7bb JM	114	};
	115
	116	struct ntb_device {
	117	struct pci_dev *pdev;
	118	struct msix_entry *msix_entries;
	119	void __iomem *reg_base;
948d3a65	120	struct ntb_mw mw[NTB_MAX_NUM_MW];
fce8a7bb	121	struct {
948d3a65 JM	122	unsigned char max_mw;
	123	unsigned char max_spads;
	124	unsigned char max_db_bits;
	125	unsigned char msix_cnt;
fce8a7bb JM	126	} limits;
fce8a7bb JM	127	struct {
49793889 JM	128	void __iomem *ldb;
	129	void __iomem *ldb_mask;
	130	void __iomem *rdb;
	131	void __iomem *bar2_xlat;
	132	void __iomem *bar4_xlat;
fce8a7bb JM	133	void __iomem *spad_write;
	134	void __iomem *spad_read;
	135	void __iomem *lnk_cntl;
	136	void __iomem *lnk_stat;
	137	void __iomem *spci_cmd;
	138	} reg_ofs;
	139	struct ntb_transport *ntb_transport;
	140	void (event_cb)(void handle, enum ntb_hw_event event);
	141
	142	struct ntb_db_cb *db_cb;
	143	unsigned char hw_type;
	144	unsigned char conn_type;
	145	unsigned char dev_type;
	146	unsigned char num_msix;
	147	unsigned char bits_per_vector;
	148	unsigned char max_cbs;
113bf1c9 JM	149	unsigned char link_width;
113bf1c9 JM	150	unsigned char link_speed;
fce8a7bb	151	unsigned char link_status;
113bf1c9	152
fce8a7bb JM	153	struct delayed_work hb_timer;
fce8a7bb JM	154	unsigned long last_ts;
1517a3f2	155
113bf1c9 JM	156	struct delayed_work lr_timer;
113bf1c9 JM	157
1517a3f2	158	struct dentry *debugfs_dir;
fce8a7bb JM	159	};
fce8a7bb JM	160
948d3a65 JM	161	/**
	162	* ntb_max_cbs() - return the max callbacks
	163	* @ndev: pointer to ntb_device instance
	164	*
	165	* Given the ntb pointer, return the maximum number of callbacks
	166	*
	167	* RETURNS: the maximum number of callbacks
	168	*/
	169	static inline unsigned char ntb_max_cbs(struct ntb_device *ndev)
	170	{
	171	return ndev->max_cbs;
	172	}
	173
	174	/**
	175	* ntb_max_mw() - return the max number of memory windows
	176	* @ndev: pointer to ntb_device instance
	177	*
	178	* Given the ntb pointer, return the maximum number of memory windows
	179	*
	180	* RETURNS: the maximum number of memory windows
	181	*/
	182	static inline unsigned char ntb_max_mw(struct ntb_device *ndev)
	183	{
	184	return ndev->limits.max_mw;
	185	}
	186
fce8a7bb JM	187	/**
	188	* ntb_hw_link_status() - return the hardware link status
	189	* @ndev: pointer to ntb_device instance
	190	*
	191	* Returns true if the hardware is connected to the remote system
	192	*
	193	* RETURNS: true or false based on the hardware link state
	194	*/
	195	static inline bool ntb_hw_link_status(struct ntb_device *ndev)
	196	{
	197	return ndev->link_status == NTB_LINK_UP;
	198	}
	199
	200	/**
	201	* ntb_query_pdev() - return the pci_dev pointer
	202	* @ndev: pointer to ntb_device instance
	203	*
948d3a65	204	* Given the ntb pointer, return the pci_dev pointer for the NTB hardware device
fce8a7bb JM	205	*
	206	* RETURNS: a pointer to the ntb pci_dev
	207	*/
	208	static inline struct pci_dev ntb_query_pdev(struct ntb_device ndev)
	209	{
	210	return ndev->pdev;
	211	}
	212
1517a3f2 JM	213	/**
	214	* ntb_query_debugfs() - return the debugfs pointer
	215	* @ndev: pointer to ntb_device instance
	216	*
	217	* Given the ntb pointer, return the debugfs directory pointer for the NTB
	218	* hardware device
	219	*
	220	* RETURNS: a pointer to the debugfs directory
	221	*/
	222	static inline struct dentry ntb_query_debugfs(struct ntb_device ndev)
	223	{
	224	return ndev->debugfs_dir;
	225	}
	226
fce8a7bb JM	227	struct ntb_device ntb_register_transport(struct pci_dev pdev,
	228	void *transport);
	229	void ntb_unregister_transport(struct ntb_device *ndev);
	230	void ntb_set_mw_addr(struct ntb_device *ndev, unsigned int mw, u64 addr);
	231	int ntb_register_db_callback(struct ntb_device *ndev, unsigned int idx,
e8aeb60c JM	232	void data, int (db_cb_func)(void *data,
e8aeb60c JM	233	int db_num));
fce8a7bb JM	234	void ntb_unregister_db_callback(struct ntb_device *ndev, unsigned int idx);
	235	int ntb_register_event_callback(struct ntb_device *ndev,
	236	void (event_cb_func) (void handle,
74465645	237	enum ntb_hw_event event));
fce8a7bb JM	238	void ntb_unregister_event_callback(struct ntb_device *ndev);
	239	int ntb_get_max_spads(struct ntb_device *ndev);
	240	int ntb_write_local_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
	241	int ntb_read_local_spad(struct ntb_device ndev, unsigned int idx, u32 val);
	242	int ntb_write_remote_spad(struct ntb_device *ndev, unsigned int idx, u32 val);
	243	int ntb_read_remote_spad(struct ntb_device ndev, unsigned int idx, u32 val);
282a2fee	244	resource_size_t ntb_get_mw_base(struct ntb_device *ndev, unsigned int mw);
74465645	245	void __iomem ntb_get_mw_vbase(struct ntb_device ndev, unsigned int mw);
ac477afb	246	u64 ntb_get_mw_size(struct ntb_device *ndev, unsigned int mw);
49793889	247	void ntb_ring_doorbell(struct ntb_device *ndev, unsigned int idx);
fce8a7bb JM	248	void ntb_find_transport(struct pci_dev pdev);
	249
	250	int ntb_transport_init(struct pci_dev *pdev);
	251	void ntb_transport_free(void *transport);