[mirror_ubuntu-bionic-kernel.git] / drivers / ntb / test / ntb_pingpong.c

/*
 * 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) 2015 EMC 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.
 *
 *   This program is distributed in the hope that it will be useful, but
 *   WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *   General Public License for more details.
 *
 *   BSD LICENSE
 *
 *   Copyright (C) 2015 EMC 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.
 *
 * PCIe NTB Pingpong Linux driver
 *
 * Contact Information:
 * Allen Hubbe <Allen.Hubbe@emc.com>
 */

/* Note: load this module with option 'dyndbg=+p' */

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/module.h>

#include <linux/dma-mapping.h>
#include <linux/pci.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/debugfs.h>

#include <linux/ntb.h>

#define DRIVER_NAME			"ntb_pingpong"
#define DRIVER_DESCRIPTION		"PCIe NTB Simple Pingpong Client"

#define DRIVER_LICENSE			"Dual BSD/GPL"
#define DRIVER_VERSION			"1.0"
#define DRIVER_RELDATE			"24 March 2015"
#define DRIVER_AUTHOR			"Allen Hubbe <Allen.Hubbe@emc.com>"

MODULE_LICENSE(DRIVER_LICENSE);
MODULE_VERSION(DRIVER_VERSION);
MODULE_AUTHOR(DRIVER_AUTHOR);
MODULE_DESCRIPTION(DRIVER_DESCRIPTION);

static unsigned int unsafe;
module_param(unsafe, uint, 0644);
MODULE_PARM_DESC(unsafe, "Run even though ntb operations may be unsafe");

static unsigned int delay_ms = 1000;
module_param(delay_ms, uint, 0644);
MODULE_PARM_DESC(delay_ms, "Milliseconds to delay the response to peer");

static unsigned long db_init = 0x7;
module_param(db_init, ulong, 0644);
MODULE_PARM_DESC(db_init, "Initial doorbell bits to ring on the peer");

/* Only two-ports NTB devices are supported */
#define PIDX		NTB_DEF_PEER_IDX

struct pp_ctx {
	struct ntb_dev			*ntb;
	u64				db_bits;
	/* synchronize access to db_bits by ping and pong */
	spinlock_t			db_lock;
	struct timer_list		db_timer;
	unsigned long			db_delay;
	struct dentry			*debugfs_node_dir;
	struct dentry			*debugfs_count;
	atomic_t			count;
};

static struct dentry *pp_debugfs_dir;

static void pp_ping(struct timer_list *t)
{
	struct pp_ctx *pp = from_timer(pp, t, db_timer);
	unsigned long irqflags;
	u64 db_bits, db_mask;
	u32 spad_rd, spad_wr;

	spin_lock_irqsave(&pp->db_lock, irqflags);
	{
		db_mask = ntb_db_valid_mask(pp->ntb);
		db_bits = ntb_db_read(pp->ntb);

		if (db_bits) {
			dev_dbg(&pp->ntb->dev,
				"Masked pongs %#llx\n",
				db_bits);
			ntb_db_clear(pp->ntb, db_bits);
		}

		db_bits = ((pp->db_bits | db_bits) << 1) & db_mask;

		if (!db_bits)
			db_bits = db_init;

		spad_rd = ntb_spad_read(pp->ntb, 0);
		spad_wr = spad_rd + 1;

		dev_dbg(&pp->ntb->dev,
			"Ping bits %#llx read %#x write %#x\n",
			db_bits, spad_rd, spad_wr);

		ntb_peer_spad_write(pp->ntb, PIDX, 0, spad_wr);
		ntb_peer_db_set(pp->ntb, db_bits);
		ntb_db_clear_mask(pp->ntb, db_mask);

		pp->db_bits = 0;
	}
	spin_unlock_irqrestore(&pp->db_lock, irqflags);
}

static void pp_link_event(void *ctx)
{
	struct pp_ctx *pp = ctx;

	if (ntb_link_is_up(pp->ntb, NULL, NULL) == 1) {
		dev_dbg(&pp->ntb->dev, "link is up\n");
		pp_ping(&pp->db_timer);
	} else {
		dev_dbg(&pp->ntb->dev, "link is down\n");
		del_timer(&pp->db_timer);
	}
}

static void pp_db_event(void *ctx, int vec)
{
	struct pp_ctx *pp = ctx;
	u64 db_bits, db_mask;
	unsigned long irqflags;

	spin_lock_irqsave(&pp->db_lock, irqflags);
	{
		db_mask = ntb_db_vector_mask(pp->ntb, vec);
		db_bits = db_mask & ntb_db_read(pp->ntb);
		ntb_db_set_mask(pp->ntb, db_mask);
		ntb_db_clear(pp->ntb, db_bits);

		pp->db_bits |= db_bits;

		mod_timer(&pp->db_timer, jiffies + pp->db_delay);

		dev_dbg(&pp->ntb->dev,
			"Pong vec %d bits %#llx\n",
			vec, db_bits);
		atomic_inc(&pp->count);
	}
	spin_unlock_irqrestore(&pp->db_lock, irqflags);
}

static int pp_debugfs_setup(struct pp_ctx *pp)
{
	struct pci_dev *pdev = pp->ntb->pdev;

	if (!pp_debugfs_dir)
		return -ENODEV;

	pp->debugfs_node_dir = debugfs_create_dir(pci_name(pdev),
						  pp_debugfs_dir);
	if (!pp->debugfs_node_dir)
		return -ENODEV;

	pp->debugfs_count = debugfs_create_atomic_t("count", S_IRUSR | S_IWUSR,
						    pp->debugfs_node_dir,
						    &pp->count);
	if (!pp->debugfs_count)
		return -ENODEV;

	return 0;
}

static const struct ntb_ctx_ops pp_ops = {
	.link_event = pp_link_event,
	.db_event = pp_db_event,
};

static int pp_probe(struct ntb_client *client,
		    struct ntb_dev *ntb)
{
	struct pp_ctx *pp;
	int rc;

	if (ntb_db_is_unsafe(ntb)) {
		dev_dbg(&ntb->dev, "doorbell is unsafe\n");
		if (!unsafe) {
			rc = -EINVAL;
			goto err_pp;
		}
	}

	if (ntb_spad_count(ntb) < 1) {
		dev_dbg(&ntb->dev, "no enough scratchpads\n");
		rc = -EINVAL;
		goto err_pp;
	}

	if (ntb_spad_is_unsafe(ntb)) {
		dev_dbg(&ntb->dev, "scratchpad is unsafe\n");
		if (!unsafe) {
			rc = -EINVAL;
			goto err_pp;
		}
	}

	if (ntb_peer_port_count(ntb) != NTB_DEF_PEER_CNT)
		dev_warn(&ntb->dev, "multi-port NTB is unsupported\n");

	pp = kmalloc(sizeof(*pp), GFP_KERNEL);
	if (!pp) {
		rc = -ENOMEM;
		goto err_pp;
	}

	pp->ntb = ntb;
	pp->db_bits = 0;
	atomic_set(&pp->count, 0);
	spin_lock_init(&pp->db_lock);
	timer_setup(&pp->db_timer, pp_ping, 0);
	pp->db_delay = msecs_to_jiffies(delay_ms);

	rc = ntb_set_ctx(ntb, pp, &pp_ops);
	if (rc)
		goto err_ctx;

	rc = pp_debugfs_setup(pp);
	if (rc)
		goto err_ctx;

	ntb_link_enable(ntb, NTB_SPEED_AUTO, NTB_WIDTH_AUTO);
	ntb_link_event(ntb);

	return 0;

err_ctx:
	kfree(pp);
err_pp:
	return rc;
}

static void pp_remove(struct ntb_client *client,
		      struct ntb_dev *ntb)
{
	struct pp_ctx *pp = ntb->ctx;

	debugfs_remove_recursive(pp->debugfs_node_dir);

	ntb_clear_ctx(ntb);
	del_timer_sync(&pp->db_timer);
	ntb_link_disable(ntb);

	kfree(pp);
}

static struct ntb_client pp_client = {
	.ops = {
		.probe = pp_probe,
		.remove = pp_remove,
	},
};

static int __init pp_init(void)
{
	int rc;

	if (debugfs_initialized())
		pp_debugfs_dir = debugfs_create_dir(KBUILD_MODNAME, NULL);

	rc = ntb_register_client(&pp_client);
	if (rc)
		goto err_client;

	return 0;

err_client:
	debugfs_remove_recursive(pp_debugfs_dir);
	return rc;
}
module_init(pp_init);

static void __exit pp_exit(void)
{
	ntb_unregister_client(&pp_client);
	debugfs_remove_recursive(pp_debugfs_dir);
}
module_exit(pp_exit);
Commit	Line	Data
963de473 AH	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) 2015 EMC 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	* This program is distributed in the hope that it will be useful, but
	14	* WITHOUT ANY WARRANTY; without even the implied warranty of
	15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	16	* General Public License for more details.
	17	*
	18	* BSD LICENSE
	19	*
	20	* Copyright (C) 2015 EMC Corporation. All Rights Reserved.
	21	*
	22	* Redistribution and use in source and binary forms, with or without
	23	* modification, are permitted provided that the following conditions
	24	* are met:
	25	*
	26	* * Redistributions of source code must retain the above copyright
	27	* notice, this list of conditions and the following disclaimer.
	28	* * Redistributions in binary form must reproduce the above copy
	29	* notice, this list of conditions and the following disclaimer in
	30	* the documentation and/or other materials provided with the
	31	* distribution.
	32	* * Neither the name of Intel Corporation nor the names of its
	33	* contributors may be used to endorse or promote products derived
	34	* from this software without specific prior written permission.
	35	*
	36	* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
	37	* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
	38	* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
	39	* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
	40	* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
	41	* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
	42	* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
	43	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
	44	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
	45	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
	46	* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	47	*
	48	* PCIe NTB Pingpong Linux driver
	49	*
	50	* Contact Information:
	51	* Allen Hubbe <Allen.Hubbe@emc.com>
	52	*/
	53
	54	/* Note: load this module with option 'dyndbg=+p' */
	55
	56	#include <linux/init.h>
	57	#include <linux/kernel.h>
	58	#include <linux/module.h>
	59
	60	#include <linux/dma-mapping.h>
	61	#include <linux/pci.h>
	62	#include <linux/slab.h>
	63	#include <linux/spinlock.h>
20572ee1	64	#include <linux/debugfs.h>
963de473 AH	65
	66	#include <linux/ntb.h>
	67
	68	#define DRIVER_NAME "ntb_pingpong"
	69	#define DRIVER_DESCRIPTION "PCIe NTB Simple Pingpong Client"
	70
	71	#define DRIVER_LICENSE "Dual BSD/GPL"
	72	#define DRIVER_VERSION "1.0"
	73	#define DRIVER_RELDATE "24 March 2015"
	74	#define DRIVER_AUTHOR "Allen Hubbe <Allen.Hubbe@emc.com>"
	75
	76	MODULE_LICENSE(DRIVER_LICENSE);
	77	MODULE_VERSION(DRIVER_VERSION);
	78	MODULE_AUTHOR(DRIVER_AUTHOR);
	79	MODULE_DESCRIPTION(DRIVER_DESCRIPTION);
	80
	81	static unsigned int unsafe;
	82	module_param(unsafe, uint, 0644);
	83	MODULE_PARM_DESC(unsafe, "Run even though ntb operations may be unsafe");
	84
	85	static unsigned int delay_ms = 1000;
	86	module_param(delay_ms, uint, 0644);
	87	MODULE_PARM_DESC(delay_ms, "Milliseconds to delay the response to peer");
	88
	89	static unsigned long db_init = 0x7;
	90	module_param(db_init, ulong, 0644);
cedecbc5	91	MODULE_PARM_DESC(db_init, "Initial doorbell bits to ring on the peer");
963de473	92
1e530119 SS	93	/* Only two-ports NTB devices are supported */
	94	#define PIDX NTB_DEF_PEER_IDX
	95
963de473 AH	96	struct pp_ctx {
	97	struct ntb_dev *ntb;
	98	u64 db_bits;
	99	/* synchronize access to db_bits by ping and pong */
	100	spinlock_t db_lock;
	101	struct timer_list db_timer;
	102	unsigned long db_delay;
20572ee1 LG	103	struct dentry *debugfs_node_dir;
	104	struct dentry *debugfs_count;
	105	atomic_t count;
963de473 AH	106	};
963de473 AH	107
20572ee1 LG	108	static struct dentry *pp_debugfs_dir;
20572ee1 LG	109
e99e88a9	110	static void pp_ping(struct timer_list *t)
963de473	111	{
e99e88a9	112	struct pp_ctx *pp = from_timer(pp, t, db_timer);
963de473 AH	113	unsigned long irqflags;
	114	u64 db_bits, db_mask;
	115	u32 spad_rd, spad_wr;
	116
	117	spin_lock_irqsave(&pp->db_lock, irqflags);
	118	{
	119	db_mask = ntb_db_valid_mask(pp->ntb);
	120	db_bits = ntb_db_read(pp->ntb);
	121
	122	if (db_bits) {
	123	dev_dbg(&pp->ntb->dev,
	124	"Masked pongs %#llx\n",
	125	db_bits);
	126	ntb_db_clear(pp->ntb, db_bits);
	127	}
	128
	129	db_bits = ((pp->db_bits \| db_bits) << 1) & db_mask;
	130
	131	if (!db_bits)
	132	db_bits = db_init;
	133
	134	spad_rd = ntb_spad_read(pp->ntb, 0);
	135	spad_wr = spad_rd + 1;
	136
	137	dev_dbg(&pp->ntb->dev,
	138	"Ping bits %#llx read %#x write %#x\n",
	139	db_bits, spad_rd, spad_wr);
	140
d67288a3	141	ntb_peer_spad_write(pp->ntb, PIDX, 0, spad_wr);
963de473 AH	142	ntb_peer_db_set(pp->ntb, db_bits);
	143	ntb_db_clear_mask(pp->ntb, db_mask);
	144
	145	pp->db_bits = 0;
	146	}
	147	spin_unlock_irqrestore(&pp->db_lock, irqflags);
	148	}
	149
	150	static void pp_link_event(void *ctx)
	151	{
	152	struct pp_ctx *pp = ctx;
	153
	154	if (ntb_link_is_up(pp->ntb, NULL, NULL) == 1) {
	155	dev_dbg(&pp->ntb->dev, "link is up\n");
e99e88a9	156	pp_ping(&pp->db_timer);
963de473 AH	157	} else {
	158	dev_dbg(&pp->ntb->dev, "link is down\n");
	159	del_timer(&pp->db_timer);
	160	}
	161	}
	162
	163	static void pp_db_event(void *ctx, int vec)
	164	{
	165	struct pp_ctx *pp = ctx;
	166	u64 db_bits, db_mask;
	167	unsigned long irqflags;
	168
	169	spin_lock_irqsave(&pp->db_lock, irqflags);
	170	{
	171	db_mask = ntb_db_vector_mask(pp->ntb, vec);
	172	db_bits = db_mask & ntb_db_read(pp->ntb);
	173	ntb_db_set_mask(pp->ntb, db_mask);
	174	ntb_db_clear(pp->ntb, db_bits);
	175
	176	pp->db_bits \|= db_bits;
	177
	178	mod_timer(&pp->db_timer, jiffies + pp->db_delay);
	179
	180	dev_dbg(&pp->ntb->dev,
	181	"Pong vec %d bits %#llx\n",
	182	vec, db_bits);
20572ee1	183	atomic_inc(&pp->count);
963de473 AH	184	}
	185	spin_unlock_irqrestore(&pp->db_lock, irqflags);
	186	}
	187
20572ee1 LG	188	static int pp_debugfs_setup(struct pp_ctx *pp)
	189	{
	190	struct pci_dev *pdev = pp->ntb->pdev;
	191
	192	if (!pp_debugfs_dir)
	193	return -ENODEV;
	194
	195	pp->debugfs_node_dir = debugfs_create_dir(pci_name(pdev),
	196	pp_debugfs_dir);
	197	if (!pp->debugfs_node_dir)
	198	return -ENODEV;
	199
	200	pp->debugfs_count = debugfs_create_atomic_t("count", S_IRUSR \| S_IWUSR,
	201	pp->debugfs_node_dir,
	202	&pp->count);
	203	if (!pp->debugfs_count)
	204	return -ENODEV;
	205
	206	return 0;
	207	}
	208
963de473 AH	209	static const struct ntb_ctx_ops pp_ops = {
	210	.link_event = pp_link_event,
	211	.db_event = pp_db_event,
	212	};
	213
	214	static int pp_probe(struct ntb_client *client,
	215	struct ntb_dev *ntb)
	216	{
	217	struct pp_ctx *pp;
	218	int rc;
	219
	220	if (ntb_db_is_unsafe(ntb)) {
	221	dev_dbg(&ntb->dev, "doorbell is unsafe\n");
	222	if (!unsafe) {
	223	rc = -EINVAL;
	224	goto err_pp;
	225	}
	226	}
	227
d67288a3 SS	228	if (ntb_spad_count(ntb) < 1) {
	229	dev_dbg(&ntb->dev, "no enough scratchpads\n");
	230	rc = -EINVAL;
	231	goto err_pp;
	232	}
	233
963de473 AH	234	if (ntb_spad_is_unsafe(ntb)) {
	235	dev_dbg(&ntb->dev, "scratchpad is unsafe\n");
	236	if (!unsafe) {
	237	rc = -EINVAL;
	238	goto err_pp;
	239	}
	240	}
	241
1e530119 SS	242	if (ntb_peer_port_count(ntb) != NTB_DEF_PEER_CNT)
	243	dev_warn(&ntb->dev, "multi-port NTB is unsupported\n");
	244
963de473 AH	245	pp = kmalloc(sizeof(*pp), GFP_KERNEL);
	246	if (!pp) {
	247	rc = -ENOMEM;
	248	goto err_pp;
	249	}
	250
	251	pp->ntb = ntb;
	252	pp->db_bits = 0;
20572ee1	253	atomic_set(&pp->count, 0);
963de473	254	spin_lock_init(&pp->db_lock);
e99e88a9	255	timer_setup(&pp->db_timer, pp_ping, 0);
963de473 AH	256	pp->db_delay = msecs_to_jiffies(delay_ms);
	257
	258	rc = ntb_set_ctx(ntb, pp, &pp_ops);
	259	if (rc)
	260	goto err_ctx;
	261
20572ee1 LG	262	rc = pp_debugfs_setup(pp);
	263	if (rc)
	264	goto err_ctx;
	265
963de473 AH	266	ntb_link_enable(ntb, NTB_SPEED_AUTO, NTB_WIDTH_AUTO);
	267	ntb_link_event(ntb);
	268
	269	return 0;
	270
	271	err_ctx:
	272	kfree(pp);
	273	err_pp:
	274	return rc;
	275	}
	276
	277	static void pp_remove(struct ntb_client *client,
	278	struct ntb_dev *ntb)
	279	{
	280	struct pp_ctx *pp = ntb->ctx;
	281
20572ee1 LG	282	debugfs_remove_recursive(pp->debugfs_node_dir);
20572ee1 LG	283
963de473 AH	284	ntb_clear_ctx(ntb);
	285	del_timer_sync(&pp->db_timer);
	286	ntb_link_disable(ntb);
	287
	288	kfree(pp);
	289	}
	290
	291	static struct ntb_client pp_client = {
	292	.ops = {
	293	.probe = pp_probe,
	294	.remove = pp_remove,
	295	},
	296	};
20572ee1 LG	297
	298	static int __init pp_init(void)
	299	{
	300	int rc;
	301
	302	if (debugfs_initialized())
	303	pp_debugfs_dir = debugfs_create_dir(KBUILD_MODNAME, NULL);
	304
	305	rc = ntb_register_client(&pp_client);
	306	if (rc)
	307	goto err_client;
	308
	309	return 0;
	310
	311	err_client:
	312	debugfs_remove_recursive(pp_debugfs_dir);
	313	return rc;
	314	}
	315	module_init(pp_init);
	316
	317	static void __exit pp_exit(void)
	318	{
	319	ntb_unregister_client(&pp_client);
	320	debugfs_remove_recursive(pp_debugfs_dir);
	321	}
	322	module_exit(pp_exit);