[linux-2.6-block.git] / drivers / mailbox / mailbox-test.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 * Copyright (C) 2015 ST Microelectronics
 *
 * Author: Lee Jones <lee.jones@linaro.org>
 */

#include <linux/debugfs.h>
#include <linux/err.h>
#include <linux/fs.h>
#include <linux/io.h>
#include <linux/kernel.h>
#include <linux/mailbox_client.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/poll.h>
#include <linux/slab.h>
#include <linux/uaccess.h>
#include <linux/sched/signal.h>

#define MBOX_MAX_SIG_LEN	8
#define MBOX_MAX_MSG_LEN	128
#define MBOX_BYTES_PER_LINE	16
#define MBOX_HEXDUMP_LINE_LEN	((MBOX_BYTES_PER_LINE * 4) + 2)
#define MBOX_HEXDUMP_MAX_LEN	(MBOX_HEXDUMP_LINE_LEN *		\
				 (MBOX_MAX_MSG_LEN / MBOX_BYTES_PER_LINE))

static bool mbox_data_ready;

struct mbox_test_device {
	struct device		*dev;
	void __iomem		*tx_mmio;
	void __iomem		*rx_mmio;
	struct mbox_chan	*tx_channel;
	struct mbox_chan	*rx_channel;
	char			*rx_buffer;
	char			*signal;
	char			*message;
	spinlock_t		lock;
	wait_queue_head_t	waitq;
	struct fasync_struct	*async_queue;
	struct dentry		*root_debugfs_dir;
};

static ssize_t mbox_test_signal_write(struct file *filp,
				       const char __user *userbuf,
				       size_t count, loff_t *ppos)
{
	struct mbox_test_device *tdev = filp->private_data;

	if (!tdev->tx_channel) {
		dev_err(tdev->dev, "Channel cannot do Tx\n");
		return -EINVAL;
	}

	if (count > MBOX_MAX_SIG_LEN) {
		dev_err(tdev->dev,
			"Signal length %zd greater than max allowed %d\n",
			count, MBOX_MAX_SIG_LEN);
		return -EINVAL;
	}

	/* Only allocate memory if we need to */
	if (!tdev->signal) {
		tdev->signal = kzalloc(MBOX_MAX_SIG_LEN, GFP_KERNEL);
		if (!tdev->signal)
			return -ENOMEM;
	}

	if (copy_from_user(tdev->signal, userbuf, count)) {
		kfree(tdev->signal);
		tdev->signal = NULL;
		return -EFAULT;
	}

	return count;
}

static const struct file_operations mbox_test_signal_ops = {
	.write	= mbox_test_signal_write,
	.open	= simple_open,
	.llseek	= generic_file_llseek,
};

static int mbox_test_message_fasync(int fd, struct file *filp, int on)
{
	struct mbox_test_device *tdev = filp->private_data;

	return fasync_helper(fd, filp, on, &tdev->async_queue);
}

static ssize_t mbox_test_message_write(struct file *filp,
				       const char __user *userbuf,
				       size_t count, loff_t *ppos)
{
	struct mbox_test_device *tdev = filp->private_data;
	void *data;
	int ret;

	if (!tdev->tx_channel) {
		dev_err(tdev->dev, "Channel cannot do Tx\n");
		return -EINVAL;
	}

	if (count > MBOX_MAX_MSG_LEN) {
		dev_err(tdev->dev,
			"Message length %zd greater than max allowed %d\n",
			count, MBOX_MAX_MSG_LEN);
		return -EINVAL;
	}

	tdev->message = kzalloc(MBOX_MAX_MSG_LEN, GFP_KERNEL);
	if (!tdev->message)
		return -ENOMEM;

	ret = copy_from_user(tdev->message, userbuf, count);
	if (ret) {
		ret = -EFAULT;
		goto out;
	}

	/*
	 * A separate signal is only of use if there is
	 * MMIO to subsequently pass the message through
	 */
	if (tdev->tx_mmio && tdev->signal) {
		print_hex_dump_bytes("Client: Sending: Signal: ", DUMP_PREFIX_ADDRESS,
				     tdev->signal, MBOX_MAX_SIG_LEN);

		data = tdev->signal;
	} else
		data = tdev->message;

	print_hex_dump_bytes("Client: Sending: Message: ", DUMP_PREFIX_ADDRESS,
			     tdev->message, MBOX_MAX_MSG_LEN);

	ret = mbox_send_message(tdev->tx_channel, data);
	if (ret < 0)
		dev_err(tdev->dev, "Failed to send message via mailbox\n");

out:
	kfree(tdev->signal);
	kfree(tdev->message);
	tdev->signal = NULL;

	return ret < 0 ? ret : count;
}

static bool mbox_test_message_data_ready(struct mbox_test_device *tdev)
{
	bool data_ready;
	unsigned long flags;

	spin_lock_irqsave(&tdev->lock, flags);
	data_ready = mbox_data_ready;
	spin_unlock_irqrestore(&tdev->lock, flags);

	return data_ready;
}

static ssize_t mbox_test_message_read(struct file *filp, char __user *userbuf,
				      size_t count, loff_t *ppos)
{
	struct mbox_test_device *tdev = filp->private_data;
	unsigned long flags;
	char *touser, *ptr;
	int l = 0;
	int ret;

	DECLARE_WAITQUEUE(wait, current);

	touser = kzalloc(MBOX_HEXDUMP_MAX_LEN + 1, GFP_KERNEL);
	if (!touser)
		return -ENOMEM;

	if (!tdev->rx_channel) {
		ret = snprintf(touser, 20, "<NO RX CAPABILITY>\n");
		ret = simple_read_from_buffer(userbuf, count, ppos,
					      touser, ret);
		goto kfree_err;
	}

	add_wait_queue(&tdev->waitq, &wait);

	do {
		__set_current_state(TASK_INTERRUPTIBLE);

		if (mbox_test_message_data_ready(tdev))
			break;

		if (filp->f_flags & O_NONBLOCK) {
			ret = -EAGAIN;
			goto waitq_err;
		}

		if (signal_pending(current)) {
			ret = -ERESTARTSYS;
			goto waitq_err;
		}
		schedule();

	} while (1);

	spin_lock_irqsave(&tdev->lock, flags);

	ptr = tdev->rx_buffer;
	while (l < MBOX_HEXDUMP_MAX_LEN) {
		hex_dump_to_buffer(ptr,
				   MBOX_BYTES_PER_LINE,
				   MBOX_BYTES_PER_LINE, 1, touser + l,
				   MBOX_HEXDUMP_LINE_LEN, true);

		ptr += MBOX_BYTES_PER_LINE;
		l += MBOX_HEXDUMP_LINE_LEN;
		*(touser + (l - 1)) = '\n';
	}
	*(touser + l) = '\0';

	memset(tdev->rx_buffer, 0, MBOX_MAX_MSG_LEN);
	mbox_data_ready = false;

	spin_unlock_irqrestore(&tdev->lock, flags);

	ret = simple_read_from_buffer(userbuf, count, ppos, touser, MBOX_HEXDUMP_MAX_LEN);
waitq_err:
	__set_current_state(TASK_RUNNING);
	remove_wait_queue(&tdev->waitq, &wait);
kfree_err:
	kfree(touser);
	return ret;
}

static __poll_t
mbox_test_message_poll(struct file *filp, struct poll_table_struct *wait)
{
	struct mbox_test_device *tdev = filp->private_data;

	poll_wait(filp, &tdev->waitq, wait);

	if (mbox_test_message_data_ready(tdev))
		return EPOLLIN | EPOLLRDNORM;
	return 0;
}

static const struct file_operations mbox_test_message_ops = {
	.write	= mbox_test_message_write,
	.read	= mbox_test_message_read,
	.fasync	= mbox_test_message_fasync,
	.poll	= mbox_test_message_poll,
	.open	= simple_open,
	.llseek	= generic_file_llseek,
};

static int mbox_test_add_debugfs(struct platform_device *pdev,
				 struct mbox_test_device *tdev)
{
	if (!debugfs_initialized())
		return 0;

	tdev->root_debugfs_dir = debugfs_create_dir(dev_name(&pdev->dev), NULL);
	if (!tdev->root_debugfs_dir) {
		dev_err(&pdev->dev, "Failed to create Mailbox debugfs\n");
		return -EINVAL;
	}

	debugfs_create_file("message", 0600, tdev->root_debugfs_dir,
			    tdev, &mbox_test_message_ops);

	debugfs_create_file("signal", 0200, tdev->root_debugfs_dir,
			    tdev, &mbox_test_signal_ops);

	return 0;
}

static void mbox_test_receive_message(struct mbox_client *client, void *message)
{
	struct mbox_test_device *tdev = dev_get_drvdata(client->dev);
	unsigned long flags;

	spin_lock_irqsave(&tdev->lock, flags);
	if (tdev->rx_mmio) {
		memcpy_fromio(tdev->rx_buffer, tdev->rx_mmio, MBOX_MAX_MSG_LEN);
		print_hex_dump_bytes("Client: Received [MMIO]: ", DUMP_PREFIX_ADDRESS,
				     tdev->rx_buffer, MBOX_MAX_MSG_LEN);
	} else if (message) {
		print_hex_dump_bytes("Client: Received [API]: ", DUMP_PREFIX_ADDRESS,
				     message, MBOX_MAX_MSG_LEN);
		memcpy(tdev->rx_buffer, message, MBOX_MAX_MSG_LEN);
	}
	mbox_data_ready = true;
	spin_unlock_irqrestore(&tdev->lock, flags);

	wake_up_interruptible(&tdev->waitq);

	kill_fasync(&tdev->async_queue, SIGIO, POLL_IN);
}

static void mbox_test_prepare_message(struct mbox_client *client, void *message)
{
	struct mbox_test_device *tdev = dev_get_drvdata(client->dev);

	if (tdev->tx_mmio) {
		if (tdev->signal)
			memcpy_toio(tdev->tx_mmio, tdev->message, MBOX_MAX_MSG_LEN);
		else
			memcpy_toio(tdev->tx_mmio, message, MBOX_MAX_MSG_LEN);
	}
}

static void mbox_test_message_sent(struct mbox_client *client,
				   void *message, int r)
{
	if (r)
		dev_warn(client->dev,
			 "Client: Message could not be sent: %d\n", r);
	else
		dev_info(client->dev,
			 "Client: Message sent\n");
}

static struct mbox_chan *
mbox_test_request_channel(struct platform_device *pdev, const char *name)
{
	struct mbox_client *client;
	struct mbox_chan *channel;

	client = devm_kzalloc(&pdev->dev, sizeof(*client), GFP_KERNEL);
	if (!client)
		return ERR_PTR(-ENOMEM);

	client->dev		= &pdev->dev;
	client->rx_callback	= mbox_test_receive_message;
	client->tx_prepare	= mbox_test_prepare_message;
	client->tx_done		= mbox_test_message_sent;
	client->tx_block	= true;
	client->knows_txdone	= false;
	client->tx_tout		= 500;

	channel = mbox_request_channel_byname(client, name);
	if (IS_ERR(channel)) {
		dev_warn(&pdev->dev, "Failed to request %s channel\n", name);
		return NULL;
	}

	return channel;
}

static int mbox_test_probe(struct platform_device *pdev)
{
	struct mbox_test_device *tdev;
	struct resource *res;
	resource_size_t size;
	int ret;

	tdev = devm_kzalloc(&pdev->dev, sizeof(*tdev), GFP_KERNEL);
	if (!tdev)
		return -ENOMEM;

	/* It's okay for MMIO to be NULL */
	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
	tdev->tx_mmio = devm_ioremap_resource(&pdev->dev, res);
	if (PTR_ERR(tdev->tx_mmio) == -EBUSY) {
		/* if reserved area in SRAM, try just ioremap */
		size = resource_size(res);
		tdev->tx_mmio = devm_ioremap(&pdev->dev, res->start, size);
	} else if (IS_ERR(tdev->tx_mmio)) {
		tdev->tx_mmio = NULL;
	}

	/* If specified, second reg entry is Rx MMIO */
	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	tdev->rx_mmio = devm_ioremap_resource(&pdev->dev, res);
	if (PTR_ERR(tdev->rx_mmio) == -EBUSY) {
		size = resource_size(res);
		tdev->rx_mmio = devm_ioremap(&pdev->dev, res->start, size);
	} else if (IS_ERR(tdev->rx_mmio)) {
		tdev->rx_mmio = tdev->tx_mmio;
	}

	tdev->tx_channel = mbox_test_request_channel(pdev, "tx");
	tdev->rx_channel = mbox_test_request_channel(pdev, "rx");

	if (!tdev->tx_channel && !tdev->rx_channel)
		return -EPROBE_DEFER;

	/* If Rx is not specified but has Rx MMIO, then Rx = Tx */
	if (!tdev->rx_channel && (tdev->rx_mmio != tdev->tx_mmio))
		tdev->rx_channel = tdev->tx_channel;

	tdev->dev = &pdev->dev;
	platform_set_drvdata(pdev, tdev);

	spin_lock_init(&tdev->lock);

	if (tdev->rx_channel) {
		tdev->rx_buffer = devm_kzalloc(&pdev->dev,
					       MBOX_MAX_MSG_LEN, GFP_KERNEL);
		if (!tdev->rx_buffer)
			return -ENOMEM;
	}

	ret = mbox_test_add_debugfs(pdev, tdev);
	if (ret)
		return ret;

	init_waitqueue_head(&tdev->waitq);
	dev_info(&pdev->dev, "Successfully registered\n");

	return 0;
}

static int mbox_test_remove(struct platform_device *pdev)
{
	struct mbox_test_device *tdev = platform_get_drvdata(pdev);

	debugfs_remove_recursive(tdev->root_debugfs_dir);

	if (tdev->tx_channel)
		mbox_free_channel(tdev->tx_channel);
	if (tdev->rx_channel)
		mbox_free_channel(tdev->rx_channel);

	return 0;
}

static const struct of_device_id mbox_test_match[] = {
	{ .compatible = "mailbox-test" },
	{},
};
MODULE_DEVICE_TABLE(of, mbox_test_match);

static struct platform_driver mbox_test_driver = {
	.driver = {
		.name = "mailbox_test",
		.of_match_table = mbox_test_match,
	},
	.probe  = mbox_test_probe,
	.remove = mbox_test_remove,
};
module_platform_driver(mbox_test_driver);

MODULE_DESCRIPTION("Generic Mailbox Testing Facility");
MODULE_AUTHOR("Lee Jones <lee.jones@linaro.org");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
8ea4484d LJ	2	/*
	3	* Copyright (C) 2015 ST Microelectronics
	4	*
	5	* Author: Lee Jones <lee.jones@linaro.org>
8ea4484d LJ	6	*/
	7
	8	#include <linux/debugfs.h>
	9	#include <linux/err.h>
baef9a35	10	#include <linux/fs.h>
a133f8b6	11	#include <linux/io.h>
8ea4484d LJ	12	#include <linux/kernel.h>
	13	#include <linux/mailbox_client.h>
	14	#include <linux/module.h>
	15	#include <linux/of.h>
	16	#include <linux/platform_device.h>
baef9a35	17	#include <linux/poll.h>
8ea4484d LJ	18	#include <linux/slab.h>
8ea4484d LJ	19	#include <linux/uaccess.h>
174cd4b1	20	#include <linux/sched/signal.h>
8ea4484d LJ	21
	22	#define MBOX_MAX_SIG_LEN 8
	23	#define MBOX_MAX_MSG_LEN 128
	24	#define MBOX_BYTES_PER_LINE 16
6c03663f	25	#define MBOX_HEXDUMP_LINE_LEN ((MBOX_BYTES_PER_LINE * 4) + 2)
8ea4484d LJ	26	#define MBOX_HEXDUMP_MAX_LEN (MBOX_HEXDUMP_LINE_LEN * \
	27	(MBOX_MAX_MSG_LEN / MBOX_BYTES_PER_LINE))
	28
e339c80a	29	static bool mbox_data_ready;
8ea4484d LJ	30
	31	struct mbox_test_device {
	32	struct device *dev;
2d74ffdc SH	33	void __iomem *tx_mmio;
2d74ffdc SH	34	void __iomem *rx_mmio;
8ea4484d LJ	35	struct mbox_chan *tx_channel;
	36	struct mbox_chan *rx_channel;
	37	char *rx_buffer;
	38	char *signal;
	39	char *message;
	40	spinlock_t lock;
baef9a35 SH	41	wait_queue_head_t waitq;
baef9a35 SH	42	struct fasync_struct *async_queue;
10cfc5a9	43	struct dentry *root_debugfs_dir;
8ea4484d LJ	44	};
	45
	46	static ssize_t mbox_test_signal_write(struct file *filp,
	47	const char __user *userbuf,
	48	size_t count, loff_t *ppos)
	49	{
	50	struct mbox_test_device *tdev = filp->private_data;
8ea4484d LJ	51
	52	if (!tdev->tx_channel) {
	53	dev_err(tdev->dev, "Channel cannot do Tx\n");
	54	return -EINVAL;
	55	}
	56
	57	if (count > MBOX_MAX_SIG_LEN) {
	58	dev_err(tdev->dev,
6c03663f	59	"Signal length %zd greater than max allowed %d\n",
8ea4484d LJ	60	count, MBOX_MAX_SIG_LEN);
	61	return -EINVAL;
	62	}
	63
d1c2f87c LJ	64	/* Only allocate memory if we need to */
	65	if (!tdev->signal) {
	66	tdev->signal = kzalloc(MBOX_MAX_SIG_LEN, GFP_KERNEL);
	67	if (!tdev->signal)
	68	return -ENOMEM;
	69	}
8ea4484d	70
17f5f28f	71	if (copy_from_user(tdev->signal, userbuf, count)) {
8ea4484d	72	kfree(tdev->signal);
17f5f28f	73	tdev->signal = NULL;
8ea4484d LJ	74	return -EFAULT;
	75	}
	76
17f5f28f	77	return count;
8ea4484d LJ	78	}
	79
	80	static const struct file_operations mbox_test_signal_ops = {
	81	.write = mbox_test_signal_write,
	82	.open = simple_open,
	83	.llseek = generic_file_llseek,
	84	};
	85
baef9a35 SH	86	static int mbox_test_message_fasync(int fd, struct file *filp, int on)
	87	{
	88	struct mbox_test_device *tdev = filp->private_data;
	89
	90	return fasync_helper(fd, filp, on, &tdev->async_queue);
	91	}
	92
8ea4484d LJ	93	static ssize_t mbox_test_message_write(struct file *filp,
	94	const char __user *userbuf,
	95	size_t count, loff_t *ppos)
	96	{
	97	struct mbox_test_device *tdev = filp->private_data;
	98	void *data;
	99	int ret;
	100
	101	if (!tdev->tx_channel) {
	102	dev_err(tdev->dev, "Channel cannot do Tx\n");
	103	return -EINVAL;
	104	}
	105
	106	if (count > MBOX_MAX_MSG_LEN) {
	107	dev_err(tdev->dev,
6c03663f	108	"Message length %zd greater than max allowed %d\n",
8ea4484d LJ	109	count, MBOX_MAX_MSG_LEN);
	110	return -EINVAL;
	111	}
	112
	113	tdev->message = kzalloc(MBOX_MAX_MSG_LEN, GFP_KERNEL);
	114	if (!tdev->message)
	115	return -ENOMEM;
	116
	117	ret = copy_from_user(tdev->message, userbuf, count);
	118	if (ret) {
	119	ret = -EFAULT;
	120	goto out;
	121	}
	122
	123	/*
	124	* A separate signal is only of use if there is
	125	* MMIO to subsequently pass the message through
	126	*/
2d74ffdc	127	if (tdev->tx_mmio && tdev->signal) {
27fa680f SH	128	print_hex_dump_bytes("Client: Sending: Signal: ", DUMP_PREFIX_ADDRESS,
27fa680f SH	129	tdev->signal, MBOX_MAX_SIG_LEN);
8ea4484d LJ	130
	131	data = tdev->signal;
	132	} else
	133	data = tdev->message;
	134
27fa680f SH	135	print_hex_dump_bytes("Client: Sending: Message: ", DUMP_PREFIX_ADDRESS,
27fa680f SH	136	tdev->message, MBOX_MAX_MSG_LEN);
8ea4484d LJ	137
	138	ret = mbox_send_message(tdev->tx_channel, data);
	139	if (ret < 0)
	140	dev_err(tdev->dev, "Failed to send message via mailbox\n");
	141
	142	out:
	143	kfree(tdev->signal);
	144	kfree(tdev->message);
9ef3c511	145	tdev->signal = NULL;
8ea4484d LJ	146
	147	return ret < 0 ? ret : count;
	148	}
	149
baef9a35 SH	150	static bool mbox_test_message_data_ready(struct mbox_test_device *tdev)
baef9a35 SH	151	{
e339c80a	152	bool data_ready;
baef9a35 SH	153	unsigned long flags;
	154
	155	spin_lock_irqsave(&tdev->lock, flags);
e339c80a	156	data_ready = mbox_data_ready;
baef9a35 SH	157	spin_unlock_irqrestore(&tdev->lock, flags);
baef9a35 SH	158
e339c80a	159	return data_ready;
baef9a35 SH	160	}
baef9a35 SH	161
8ea4484d LJ	162	static ssize_t mbox_test_message_read(struct file filp, char __user userbuf,
	163	size_t count, loff_t *ppos)
	164	{
	165	struct mbox_test_device *tdev = filp->private_data;
	166	unsigned long flags;
	167	char touser, ptr;
	168	int l = 0;
	169	int ret;
	170
baef9a35 SH	171	DECLARE_WAITQUEUE(wait, current);
baef9a35 SH	172
c3ac54a6	173	touser = kzalloc(MBOX_HEXDUMP_MAX_LEN + 1, GFP_KERNEL);
8ea4484d LJ	174	if (!touser)
	175	return -ENOMEM;
	176
	177	if (!tdev->rx_channel) {
	178	ret = snprintf(touser, 20, "<NO RX CAPABILITY>\n");
	179	ret = simple_read_from_buffer(userbuf, count, ppos,
	180	touser, ret);
baef9a35	181	goto kfree_err;
8ea4484d LJ	182	}
8ea4484d LJ	183
baef9a35 SH	184	add_wait_queue(&tdev->waitq, &wait);
	185
	186	do {
	187	__set_current_state(TASK_INTERRUPTIBLE);
	188
	189	if (mbox_test_message_data_ready(tdev))
	190	break;
	191
	192	if (filp->f_flags & O_NONBLOCK) {
	193	ret = -EAGAIN;
	194	goto waitq_err;
	195	}
	196
	197	if (signal_pending(current)) {
	198	ret = -ERESTARTSYS;
	199	goto waitq_err;
	200	}
	201	schedule();
	202
	203	} while (1);
8ea4484d LJ	204
	205	spin_lock_irqsave(&tdev->lock, flags);
	206
	207	ptr = tdev->rx_buffer;
	208	while (l < MBOX_HEXDUMP_MAX_LEN) {
	209	hex_dump_to_buffer(ptr,
	210	MBOX_BYTES_PER_LINE,
	211	MBOX_BYTES_PER_LINE, 1, touser + l,
	212	MBOX_HEXDUMP_LINE_LEN, true);
	213
	214	ptr += MBOX_BYTES_PER_LINE;
	215	l += MBOX_HEXDUMP_LINE_LEN;
	216	*(touser + (l - 1)) = '\n';
	217	}
	218	*(touser + l) = '\0';
	219
	220	memset(tdev->rx_buffer, 0, MBOX_MAX_MSG_LEN);
e339c80a	221	mbox_data_ready = false;
8ea4484d LJ	222
	223	spin_unlock_irqrestore(&tdev->lock, flags);
	224
	225	ret = simple_read_from_buffer(userbuf, count, ppos, touser, MBOX_HEXDUMP_MAX_LEN);
baef9a35 SH	226	waitq_err:
	227	__set_current_state(TASK_RUNNING);
	228	remove_wait_queue(&tdev->waitq, &wait);
	229	kfree_err:
8ea4484d LJ	230	kfree(touser);
	231	return ret;
	232	}
	233
afc9a42b	234	static __poll_t
baef9a35 SH	235	mbox_test_message_poll(struct file filp, struct poll_table_struct wait)
	236	{
	237	struct mbox_test_device *tdev = filp->private_data;
	238
	239	poll_wait(filp, &tdev->waitq, wait);
	240
	241	if (mbox_test_message_data_ready(tdev))
a9a08845	242	return EPOLLIN \| EPOLLRDNORM;
baef9a35 SH	243	return 0;
	244	}
	245
8ea4484d LJ	246	static const struct file_operations mbox_test_message_ops = {
	247	.write = mbox_test_message_write,
	248	.read = mbox_test_message_read,
baef9a35 SH	249	.fasync = mbox_test_message_fasync,
baef9a35 SH	250	.poll = mbox_test_message_poll,
8ea4484d LJ	251	.open = simple_open,
	252	.llseek = generic_file_llseek,
	253	};
	254
	255	static int mbox_test_add_debugfs(struct platform_device *pdev,
	256	struct mbox_test_device *tdev)
	257	{
	258	if (!debugfs_initialized())
	259	return 0;
	260
10cfc5a9 FD	261	tdev->root_debugfs_dir = debugfs_create_dir(dev_name(&pdev->dev), NULL);
10cfc5a9 FD	262	if (!tdev->root_debugfs_dir) {
8ea4484d LJ	263	dev_err(&pdev->dev, "Failed to create Mailbox debugfs\n");
	264	return -EINVAL;
	265	}
	266
10cfc5a9	267	debugfs_create_file("message", 0600, tdev->root_debugfs_dir,
8ea4484d LJ	268	tdev, &mbox_test_message_ops);
8ea4484d LJ	269
10cfc5a9	270	debugfs_create_file("signal", 0200, tdev->root_debugfs_dir,
8ea4484d LJ	271	tdev, &mbox_test_signal_ops);
	272
	273	return 0;
	274	}
	275
	276	static void mbox_test_receive_message(struct mbox_client client, void message)
	277	{
	278	struct mbox_test_device *tdev = dev_get_drvdata(client->dev);
	279	unsigned long flags;
	280
	281	spin_lock_irqsave(&tdev->lock, flags);
2d74ffdc SH	282	if (tdev->rx_mmio) {
2d74ffdc SH	283	memcpy_fromio(tdev->rx_buffer, tdev->rx_mmio, MBOX_MAX_MSG_LEN);
27fa680f SH	284	print_hex_dump_bytes("Client: Received [MMIO]: ", DUMP_PREFIX_ADDRESS,
27fa680f SH	285	tdev->rx_buffer, MBOX_MAX_MSG_LEN);
8ea4484d	286	} else if (message) {
27fa680f SH	287	print_hex_dump_bytes("Client: Received [API]: ", DUMP_PREFIX_ADDRESS,
27fa680f SH	288	message, MBOX_MAX_MSG_LEN);
8ea4484d LJ	289	memcpy(tdev->rx_buffer, message, MBOX_MAX_MSG_LEN);
8ea4484d LJ	290	}
e339c80a	291	mbox_data_ready = true;
8ea4484d	292	spin_unlock_irqrestore(&tdev->lock, flags);
baef9a35 SH	293
	294	wake_up_interruptible(&tdev->waitq);
	295
	296	kill_fasync(&tdev->async_queue, SIGIO, POLL_IN);
8ea4484d LJ	297	}
	298
	299	static void mbox_test_prepare_message(struct mbox_client client, void message)
	300	{
	301	struct mbox_test_device *tdev = dev_get_drvdata(client->dev);
	302
2d74ffdc	303	if (tdev->tx_mmio) {
8ea4484d	304	if (tdev->signal)
2d74ffdc	305	memcpy_toio(tdev->tx_mmio, tdev->message, MBOX_MAX_MSG_LEN);
8ea4484d	306	else
2d74ffdc	307	memcpy_toio(tdev->tx_mmio, message, MBOX_MAX_MSG_LEN);
8ea4484d LJ	308	}
	309	}
	310
	311	static void mbox_test_message_sent(struct mbox_client *client,
	312	void *message, int r)
	313	{
	314	if (r)
	315	dev_warn(client->dev,
	316	"Client: Message could not be sent: %d\n", r);
	317	else
	318	dev_info(client->dev,
	319	"Client: Message sent\n");
	320	}
	321
	322	static struct mbox_chan *
	323	mbox_test_request_channel(struct platform_device pdev, const char name)
	324	{
	325	struct mbox_client *client;
	326	struct mbox_chan *channel;
	327
	328	client = devm_kzalloc(&pdev->dev, sizeof(*client), GFP_KERNEL);
	329	if (!client)
	330	return ERR_PTR(-ENOMEM);
	331
	332	client->dev = &pdev->dev;
	333	client->rx_callback = mbox_test_receive_message;
	334	client->tx_prepare = mbox_test_prepare_message;
	335	client->tx_done = mbox_test_message_sent;
	336	client->tx_block = true;
	337	client->knows_txdone = false;
	338	client->tx_tout = 500;
	339
	340	channel = mbox_request_channel_byname(client, name);
	341	if (IS_ERR(channel)) {
	342	dev_warn(&pdev->dev, "Failed to request %s channel\n", name);
	343	return NULL;
	344	}
	345
	346	return channel;
	347	}
	348
	349	static int mbox_test_probe(struct platform_device *pdev)
	350	{
	351	struct mbox_test_device *tdev;
	352	struct resource *res;
db4d22c0	353	resource_size_t size;
8ea4484d LJ	354	int ret;
	355
	356	tdev = devm_kzalloc(&pdev->dev, sizeof(*tdev), GFP_KERNEL);
	357	if (!tdev)
	358	return -ENOMEM;
	359
	360	/* It's okay for MMIO to be NULL */
	361	res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
2d74ffdc	362	tdev->tx_mmio = devm_ioremap_resource(&pdev->dev, res);
6899b4f7	363	if (PTR_ERR(tdev->tx_mmio) == -EBUSY) {
db4d22c0	364	/* if reserved area in SRAM, try just ioremap */
6899b4f7	365	size = resource_size(res);
db4d22c0	366	tdev->tx_mmio = devm_ioremap(&pdev->dev, res->start, size);
6899b4f7	367	} else if (IS_ERR(tdev->tx_mmio)) {
2d74ffdc	368	tdev->tx_mmio = NULL;
6899b4f7	369	}
2d74ffdc SH	370
	371	/* If specified, second reg entry is Rx MMIO */
	372	res = platform_get_resource(pdev, IORESOURCE_MEM, 1);
	373	tdev->rx_mmio = devm_ioremap_resource(&pdev->dev, res);
6899b4f7 FD	374	if (PTR_ERR(tdev->rx_mmio) == -EBUSY) {
6899b4f7 FD	375	size = resource_size(res);
db4d22c0	376	tdev->rx_mmio = devm_ioremap(&pdev->dev, res->start, size);
6899b4f7	377	} else if (IS_ERR(tdev->rx_mmio)) {
2d74ffdc	378	tdev->rx_mmio = tdev->tx_mmio;
6899b4f7	379	}
8ea4484d LJ	380
	381	tdev->tx_channel = mbox_test_request_channel(pdev, "tx");
	382	tdev->rx_channel = mbox_test_request_channel(pdev, "rx");
	383
6c03663f	384	if (!tdev->tx_channel && !tdev->rx_channel)
8ea4484d LJ	385	return -EPROBE_DEFER;
8ea4484d LJ	386
2d74ffdc SH	387	/* If Rx is not specified but has Rx MMIO, then Rx = Tx */
	388	if (!tdev->rx_channel && (tdev->rx_mmio != tdev->tx_mmio))
	389	tdev->rx_channel = tdev->tx_channel;
	390
8ea4484d LJ	391	tdev->dev = &pdev->dev;
	392	platform_set_drvdata(pdev, tdev);
	393
	394	spin_lock_init(&tdev->lock);
	395
	396	if (tdev->rx_channel) {
	397	tdev->rx_buffer = devm_kzalloc(&pdev->dev,
	398	MBOX_MAX_MSG_LEN, GFP_KERNEL);
	399	if (!tdev->rx_buffer)
	400	return -ENOMEM;
	401	}
	402
	403	ret = mbox_test_add_debugfs(pdev, tdev);
	404	if (ret)
	405	return ret;
	406
baef9a35	407	init_waitqueue_head(&tdev->waitq);
8ea4484d LJ	408	dev_info(&pdev->dev, "Successfully registered\n");
	409
	410	return 0;
	411	}
	412
	413	static int mbox_test_remove(struct platform_device *pdev)
	414	{
	415	struct mbox_test_device *tdev = platform_get_drvdata(pdev);
	416
10cfc5a9	417	debugfs_remove_recursive(tdev->root_debugfs_dir);
8ea4484d LJ	418
	419	if (tdev->tx_channel)
	420	mbox_free_channel(tdev->tx_channel);
	421	if (tdev->rx_channel)
	422	mbox_free_channel(tdev->rx_channel);
	423
	424	return 0;
	425	}
	426
	427	static const struct of_device_id mbox_test_match[] = {
c4280137	428	{ .compatible = "mailbox-test" },
8ea4484d LJ	429	{},
8ea4484d LJ	430	};
f42cce3c	431	MODULE_DEVICE_TABLE(of, mbox_test_match);
8ea4484d LJ	432
	433	static struct platform_driver mbox_test_driver = {
	434	.driver = {
adf06ba9	435	.name = "mailbox_test",
8ea4484d LJ	436	.of_match_table = mbox_test_match,
	437	},
	438	.probe = mbox_test_probe,
	439	.remove = mbox_test_remove,
	440	};
	441	module_platform_driver(mbox_test_driver);
	442
	443	MODULE_DESCRIPTION("Generic Mailbox Testing Facility");
	444	MODULE_AUTHOR("Lee Jones <lee.jones@linaro.org");
	445	MODULE_LICENSE("GPL v2");