[linux-2.6-block.git] / drivers / nfc / nfcmrvl / uart.c

/**
 * Marvell NFC-over-UART driver
 *
 * Copyright (C) 2015, Marvell International Ltd.
 *
 * This software file (the "File") is distributed by Marvell International
 * Ltd. under the terms of the GNU General Public License Version 2, June 1991
 * (the "License").  You may use, redistribute and/or modify this File in
 * accordance with the terms and conditions of the License, a copy of which
 * is available on the worldwide web at
 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
 *
 * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
 * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
 * this warranty disclaimer.
 */

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/of_gpio.h>
#include <net/nfc/nci.h>
#include <net/nfc/nci_core.h>
#include "nfcmrvl.h"

static unsigned int hci_muxed;
static unsigned int flow_control;
static unsigned int break_control;
static unsigned int reset_n_io;

/*
** NFCMRVL NCI OPS
*/

static int nfcmrvl_uart_nci_open(struct nfcmrvl_private *priv)
{
	return 0;
}

static int nfcmrvl_uart_nci_close(struct nfcmrvl_private *priv)
{
	return 0;
}

static int nfcmrvl_uart_nci_send(struct nfcmrvl_private *priv,
				 struct sk_buff *skb)
{
	struct nci_uart *nu = priv->drv_data;

	return nu->ops.send(nu, skb);
}

static void nfcmrvl_uart_nci_update_config(struct nfcmrvl_private *priv,
					   const void *param)
{
	struct nci_uart *nu = priv->drv_data;
	const struct nfcmrvl_fw_uart_config *config = param;

	nci_uart_set_config(nu, le32_to_cpu(config->baudrate),
			    config->flow_control);
}

static struct nfcmrvl_if_ops uart_ops = {
	.nci_open = nfcmrvl_uart_nci_open,
	.nci_close = nfcmrvl_uart_nci_close,
	.nci_send = nfcmrvl_uart_nci_send,
	.nci_update_config = nfcmrvl_uart_nci_update_config
};

static int nfcmrvl_uart_parse_dt(struct device_node *node,
				 struct nfcmrvl_platform_data *pdata)
{
	struct device_node *matched_node;
	int ret;

	matched_node = of_get_compatible_child(node, "marvell,nfc-uart");
	if (!matched_node) {
		matched_node = of_get_compatible_child(node, "mrvl,nfc-uart");
		if (!matched_node)
			return -ENODEV;
	}

	ret = nfcmrvl_parse_dt(matched_node, pdata);
	if (ret < 0) {
		pr_err("Failed to get generic entries\n");
		of_node_put(matched_node);
		return ret;
	}

	if (of_find_property(matched_node, "flow-control", NULL))
		pdata->flow_control = 1;
	else
		pdata->flow_control = 0;

	if (of_find_property(matched_node, "break-control", NULL))
		pdata->break_control = 1;
	else
		pdata->break_control = 0;

	of_node_put(matched_node);

	return 0;
}

/*
** NCI UART OPS
*/

static int nfcmrvl_nci_uart_open(struct nci_uart *nu)
{
	struct nfcmrvl_private *priv;
	struct nfcmrvl_platform_data *pdata = NULL;
	struct nfcmrvl_platform_data config;
	struct device *dev = nu->tty->dev;

	/*
	 * Platform data cannot be used here since usually it is already used
	 * by low level serial driver. We can try to retrieve serial device
	 * and check if DT entries were added.
	 */

	if (dev && dev->parent && dev->parent->of_node)
		if (nfcmrvl_uart_parse_dt(dev->parent->of_node, &config) == 0)
			pdata = &config;

	if (!pdata) {
		pr_info("No platform data / DT -> fallback to module params\n");
		config.hci_muxed = hci_muxed;
		config.reset_n_io = reset_n_io;
		config.flow_control = flow_control;
		config.break_control = break_control;
		pdata = &config;
	}

	priv = nfcmrvl_nci_register_dev(NFCMRVL_PHY_UART, nu, &uart_ops,
					dev, pdata);
	if (IS_ERR(priv))
		return PTR_ERR(priv);

	priv->support_fw_dnld = true;

	nu->drv_data = priv;
	nu->ndev = priv->ndev;

	return 0;
}

static void nfcmrvl_nci_uart_close(struct nci_uart *nu)
{
	nfcmrvl_nci_unregister_dev((struct nfcmrvl_private *)nu->drv_data);
}

static int nfcmrvl_nci_uart_recv(struct nci_uart *nu, struct sk_buff *skb)
{
	return nfcmrvl_nci_recv_frame((struct nfcmrvl_private *)nu->drv_data,
				      skb);
}

static void nfcmrvl_nci_uart_tx_start(struct nci_uart *nu)
{
	struct nfcmrvl_private *priv = (struct nfcmrvl_private *)nu->drv_data;

	if (priv->ndev->nfc_dev->fw_download_in_progress)
		return;

	/* Remove BREAK to wake up the NFCC */
	if (priv->config.break_control && nu->tty->ops->break_ctl) {
		nu->tty->ops->break_ctl(nu->tty, 0);
		usleep_range(3000, 5000);
	}
}

static void nfcmrvl_nci_uart_tx_done(struct nci_uart *nu)
{
	struct nfcmrvl_private *priv = (struct nfcmrvl_private *)nu->drv_data;

	if (priv->ndev->nfc_dev->fw_download_in_progress)
		return;

	/*
	** To ensure that if the NFCC goes in DEEP SLEEP sate we can wake him
	** up. we set BREAK. Once we will be ready to send again we will remove
	** it.
	*/
	if (priv->config.break_control && nu->tty->ops->break_ctl) {
		nu->tty->ops->break_ctl(nu->tty, -1);
		usleep_range(1000, 3000);
	}
}

static struct nci_uart nfcmrvl_nci_uart = {
	.owner  = THIS_MODULE,
	.name   = "nfcmrvl_uart",
	.driver = NCI_UART_DRIVER_MARVELL,
	.ops	= {
		.open		= nfcmrvl_nci_uart_open,
		.close		= nfcmrvl_nci_uart_close,
		.recv		= nfcmrvl_nci_uart_recv,
		.tx_start	= nfcmrvl_nci_uart_tx_start,
		.tx_done	= nfcmrvl_nci_uart_tx_done,
	}
};

/*
** Module init
*/

static int nfcmrvl_uart_init_module(void)
{
	return nci_uart_register(&nfcmrvl_nci_uart);
}

static void nfcmrvl_uart_exit_module(void)
{
	nci_uart_unregister(&nfcmrvl_nci_uart);
}

module_init(nfcmrvl_uart_init_module);
module_exit(nfcmrvl_uart_exit_module);

MODULE_AUTHOR("Marvell International Ltd.");
MODULE_DESCRIPTION("Marvell NFC-over-UART");
MODULE_LICENSE("GPL v2");

module_param(flow_control, uint, 0);
MODULE_PARM_DESC(flow_control, "Tell if UART needs flow control at init.");

module_param(break_control, uint, 0);
MODULE_PARM_DESC(break_control, "Tell if UART driver must drive break signal.");

module_param(hci_muxed, uint, 0);
MODULE_PARM_DESC(hci_muxed, "Tell if transport is muxed in HCI one.");

module_param(reset_n_io, uint, 0);
MODULE_PARM_DESC(reset_n_io, "GPIO that is wired to RESET_N signal.");
Commit	Line	Data
e097dc62 VC	1	/**
	2	* Marvell NFC-over-UART driver
	3	*
	4	* Copyright (C) 2015, Marvell International Ltd.
	5	*
	6	* This software file (the "File") is distributed by Marvell International
	7	* Ltd. under the terms of the GNU General Public License Version 2, June 1991
	8	* (the "License"). You may use, redistribute and/or modify this File in
	9	* accordance with the terms and conditions of the License, a copy of which
	10	* is available on the worldwide web at
	11	* http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
	12	*
	13	* THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
	14	* IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
	15	* ARE EXPRESSLY DISCLAIMED. The License provides additional details about
	16	* this warranty disclaimer.
	17	*/
	18
	19	#include <linux/module.h>
	20	#include <linux/delay.h>
	21	#include <linux/of_gpio.h>
	22	#include <net/nfc/nci.h>
	23	#include <net/nfc/nci_core.h>
	24	#include "nfcmrvl.h"
	25
	26	static unsigned int hci_muxed;
	27	static unsigned int flow_control;
	28	static unsigned int break_control;
	29	static unsigned int reset_n_io;
	30
	31	/*
	32	** NFCMRVL NCI OPS
	33	*/
	34
	35	static int nfcmrvl_uart_nci_open(struct nfcmrvl_private *priv)
	36	{
	37	return 0;
	38	}
	39
	40	static int nfcmrvl_uart_nci_close(struct nfcmrvl_private *priv)
	41	{
	42	return 0;
	43	}
	44
	45	static int nfcmrvl_uart_nci_send(struct nfcmrvl_private *priv,
	46	struct sk_buff *skb)
	47	{
	48	struct nci_uart *nu = priv->drv_data;
	49
	50	return nu->ops.send(nu, skb);
	51	}
	52
3194c687 VC	53	static void nfcmrvl_uart_nci_update_config(struct nfcmrvl_private *priv,
	54	const void *param)
	55	{
	56	struct nci_uart *nu = priv->drv_data;
	57	const struct nfcmrvl_fw_uart_config *config = param;
	58
	59	nci_uart_set_config(nu, le32_to_cpu(config->baudrate),
	60	config->flow_control);
	61	}
	62
e097dc62 VC	63	static struct nfcmrvl_if_ops uart_ops = {
	64	.nci_open = nfcmrvl_uart_nci_open,
	65	.nci_close = nfcmrvl_uart_nci_close,
	66	.nci_send = nfcmrvl_uart_nci_send,
3194c687	67	.nci_update_config = nfcmrvl_uart_nci_update_config
e097dc62 VC	68	};
e097dc62 VC	69
e097dc62 VC	70	static int nfcmrvl_uart_parse_dt(struct device_node *node,
	71	struct nfcmrvl_platform_data *pdata)
	72	{
	73	struct device_node *matched_node;
	74	int ret;
	75
5bf59773	76	matched_node = of_get_compatible_child(node, "marvell,nfc-uart");
d8e018c0	77	if (!matched_node) {
5bf59773	78	matched_node = of_get_compatible_child(node, "mrvl,nfc-uart");
d8e018c0 VC	79	if (!matched_node)
	80	return -ENODEV;
	81	}
e097dc62 VC	82
	83	ret = nfcmrvl_parse_dt(matched_node, pdata);
	84	if (ret < 0) {
	85	pr_err("Failed to get generic entries\n");
d0607aa4	86	of_node_put(matched_node);
e097dc62 VC	87	return ret;
	88	}
	89
	90	if (of_find_property(matched_node, "flow-control", NULL))
	91	pdata->flow_control = 1;
	92	else
	93	pdata->flow_control = 0;
	94
	95	if (of_find_property(matched_node, "break-control", NULL))
	96	pdata->break_control = 1;
	97	else
	98	pdata->break_control = 0;
	99
d0607aa4 JH	100	of_node_put(matched_node);
d0607aa4 JH	101
e097dc62 VC	102	return 0;
	103	}
	104
e097dc62 VC	105	/*
	106	** NCI UART OPS
	107	*/
	108
	109	static int nfcmrvl_nci_uart_open(struct nci_uart *nu)
	110	{
	111	struct nfcmrvl_private *priv;
	112	struct nfcmrvl_platform_data *pdata = NULL;
	113	struct nfcmrvl_platform_data config;
15e0c59f	114	struct device *dev = nu->tty->dev;
e097dc62 VC	115
	116	/*
	117	* Platform data cannot be used here since usually it is already used
	118	* by low level serial driver. We can try to retrieve serial device
	119	* and check if DT entries were added.
	120	*/
	121
15e0c59f JH	122	if (dev && dev->parent && dev->parent->of_node)
15e0c59f JH	123	if (nfcmrvl_uart_parse_dt(dev->parent->of_node, &config) == 0)
e097dc62 VC	124	pdata = &config;
	125
	126	if (!pdata) {
	127	pr_info("No platform data / DT -> fallback to module params\n");
	128	config.hci_muxed = hci_muxed;
	129	config.reset_n_io = reset_n_io;
	130	config.flow_control = flow_control;
	131	config.break_control = break_control;
	132	pdata = &config;
	133	}
	134
58d34aa6	135	priv = nfcmrvl_nci_register_dev(NFCMRVL_PHY_UART, nu, &uart_ops,
15e0c59f	136	dev, pdata);
e097dc62 VC	137	if (IS_ERR(priv))
	138	return PTR_ERR(priv);
	139
3194c687	140	priv->support_fw_dnld = true;
e097dc62 VC	141
	142	nu->drv_data = priv;
	143	nu->ndev = priv->ndev;
	144
e097dc62 VC	145	return 0;
	146	}
	147
	148	static void nfcmrvl_nci_uart_close(struct nci_uart *nu)
	149	{
	150	nfcmrvl_nci_unregister_dev((struct nfcmrvl_private *)nu->drv_data);
	151	}
	152
	153	static int nfcmrvl_nci_uart_recv(struct nci_uart nu, struct sk_buff skb)
	154	{
	155	return nfcmrvl_nci_recv_frame((struct nfcmrvl_private *)nu->drv_data,
	156	skb);
	157	}
	158
	159	static void nfcmrvl_nci_uart_tx_start(struct nci_uart *nu)
	160	{
	161	struct nfcmrvl_private priv = (struct nfcmrvl_private )nu->drv_data;
	162
feacf002 VC	163	if (priv->ndev->nfc_dev->fw_download_in_progress)
	164	return;
	165
e097dc62 VC	166	/* Remove BREAK to wake up the NFCC */
	167	if (priv->config.break_control && nu->tty->ops->break_ctl) {
	168	nu->tty->ops->break_ctl(nu->tty, 0);
	169	usleep_range(3000, 5000);
	170	}
	171	}
	172
	173	static void nfcmrvl_nci_uart_tx_done(struct nci_uart *nu)
	174	{
	175	struct nfcmrvl_private priv = (struct nfcmrvl_private )nu->drv_data;
	176
feacf002 VC	177	if (priv->ndev->nfc_dev->fw_download_in_progress)
	178	return;
	179
e097dc62 VC	180	/*
	181	** To ensure that if the NFCC goes in DEEP SLEEP sate we can wake him
	182	** up. we set BREAK. Once we will be ready to send again we will remove
	183	** it.
	184	*/
d2d2e645	185	if (priv->config.break_control && nu->tty->ops->break_ctl) {
e097dc62	186	nu->tty->ops->break_ctl(nu->tty, -1);
d2d2e645 VC	187	usleep_range(1000, 3000);
d2d2e645 VC	188	}
e097dc62 VC	189	}
	190
	191	static struct nci_uart nfcmrvl_nci_uart = {
	192	.owner = THIS_MODULE,
	193	.name = "nfcmrvl_uart",
	194	.driver = NCI_UART_DRIVER_MARVELL,
	195	.ops = {
	196	.open = nfcmrvl_nci_uart_open,
	197	.close = nfcmrvl_nci_uart_close,
	198	.recv = nfcmrvl_nci_uart_recv,
	199	.tx_start = nfcmrvl_nci_uart_tx_start,
	200	.tx_done = nfcmrvl_nci_uart_tx_done,
	201	}
	202	};
	203
	204	/*
	205	** Module init
	206	*/
	207
	208	static int nfcmrvl_uart_init_module(void)
	209	{
	210	return nci_uart_register(&nfcmrvl_nci_uart);
	211	}
	212
	213	static void nfcmrvl_uart_exit_module(void)
	214	{
	215	nci_uart_unregister(&nfcmrvl_nci_uart);
	216	}
	217
	218	module_init(nfcmrvl_uart_init_module);
	219	module_exit(nfcmrvl_uart_exit_module);
	220
	221	MODULE_AUTHOR("Marvell International Ltd.");
	222	MODULE_DESCRIPTION("Marvell NFC-over-UART");
	223	MODULE_LICENSE("GPL v2");
	224
	225	module_param(flow_control, uint, 0);
	226	MODULE_PARM_DESC(flow_control, "Tell if UART needs flow control at init.");
	227
	228	module_param(break_control, uint, 0);
	229	MODULE_PARM_DESC(break_control, "Tell if UART driver must drive break signal.");
	230
	231	module_param(hci_muxed, uint, 0);
	232	MODULE_PARM_DESC(hci_muxed, "Tell if transport is muxed in HCI one.");
	233
	234	module_param(reset_n_io, uint, 0);
	235	MODULE_PARM_DESC(reset_n_io, "GPIO that is wired to RESET_N signal.");