xref: /OK3568_Linux_fs/kernel/drivers/nfc/nfcmrvl/main.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Marvell NFC driver: major functions
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (C) 2014-2015 Marvell International Ltd.
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * This software file (the "File") is distributed by Marvell International
7*4882a593Smuzhiyun  * Ltd. under the terms of the GNU General Public License Version 2, June 1991
8*4882a593Smuzhiyun  * (the "License").  You may use, redistribute and/or modify this File in
9*4882a593Smuzhiyun  * accordance with the terms and conditions of the License, a copy of which
10*4882a593Smuzhiyun  * is available on the worldwide web at
11*4882a593Smuzhiyun  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  * THE FILE IS DISTRIBUTED AS-IS, WITHOUT WARRANTY OF ANY KIND, AND THE
14*4882a593Smuzhiyun  * IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE
15*4882a593Smuzhiyun  * ARE EXPRESSLY DISCLAIMED.  The License provides additional details about
16*4882a593Smuzhiyun  * this warranty disclaimer.
17*4882a593Smuzhiyun  */
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #include <linux/module.h>
20*4882a593Smuzhiyun #include <linux/gpio.h>
21*4882a593Smuzhiyun #include <linux/delay.h>
22*4882a593Smuzhiyun #include <linux/of_gpio.h>
23*4882a593Smuzhiyun #include <linux/nfc.h>
24*4882a593Smuzhiyun #include <net/nfc/nci.h>
25*4882a593Smuzhiyun #include <net/nfc/nci_core.h>
26*4882a593Smuzhiyun #include "nfcmrvl.h"
27*4882a593Smuzhiyun 
nfcmrvl_nci_open(struct nci_dev * ndev)28*4882a593Smuzhiyun static int nfcmrvl_nci_open(struct nci_dev *ndev)
29*4882a593Smuzhiyun {
30*4882a593Smuzhiyun 	struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
31*4882a593Smuzhiyun 	int err;
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun 	if (test_and_set_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
34*4882a593Smuzhiyun 		return 0;
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun 	/* Reset possible fault of previous session */
37*4882a593Smuzhiyun 	clear_bit(NFCMRVL_PHY_ERROR, &priv->flags);
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun 	err = priv->if_ops->nci_open(priv);
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun 	if (err)
42*4882a593Smuzhiyun 		clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags);
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	return err;
45*4882a593Smuzhiyun }
46*4882a593Smuzhiyun 
nfcmrvl_nci_close(struct nci_dev * ndev)47*4882a593Smuzhiyun static int nfcmrvl_nci_close(struct nci_dev *ndev)
48*4882a593Smuzhiyun {
49*4882a593Smuzhiyun 	struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun 	if (!test_and_clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
52*4882a593Smuzhiyun 		return 0;
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 	priv->if_ops->nci_close(priv);
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 	return 0;
57*4882a593Smuzhiyun }
58*4882a593Smuzhiyun 
nfcmrvl_nci_send(struct nci_dev * ndev,struct sk_buff * skb)59*4882a593Smuzhiyun static int nfcmrvl_nci_send(struct nci_dev *ndev, struct sk_buff *skb)
60*4882a593Smuzhiyun {
61*4882a593Smuzhiyun 	struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun 	nfc_info(priv->dev, "send entry, len %d\n", skb->len);
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun 	skb->dev = (void *)ndev;
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun 	if (priv->config.hci_muxed) {
68*4882a593Smuzhiyun 		unsigned char *hdr;
69*4882a593Smuzhiyun 		unsigned char len = skb->len;
70*4882a593Smuzhiyun 
71*4882a593Smuzhiyun 		hdr = skb_push(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
72*4882a593Smuzhiyun 		hdr[0] = NFCMRVL_HCI_COMMAND_CODE;
73*4882a593Smuzhiyun 		hdr[1] = NFCMRVL_HCI_OGF;
74*4882a593Smuzhiyun 		hdr[2] = NFCMRVL_HCI_OCF;
75*4882a593Smuzhiyun 		hdr[3] = len;
76*4882a593Smuzhiyun 	}
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun 	return priv->if_ops->nci_send(priv, skb);
79*4882a593Smuzhiyun }
80*4882a593Smuzhiyun 
nfcmrvl_nci_setup(struct nci_dev * ndev)81*4882a593Smuzhiyun static int nfcmrvl_nci_setup(struct nci_dev *ndev)
82*4882a593Smuzhiyun {
83*4882a593Smuzhiyun 	__u8 val = 1;
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun 	nci_set_config(ndev, NFCMRVL_PB_BAIL_OUT, 1, &val);
86*4882a593Smuzhiyun 	return 0;
87*4882a593Smuzhiyun }
88*4882a593Smuzhiyun 
nfcmrvl_nci_fw_download(struct nci_dev * ndev,const char * firmware_name)89*4882a593Smuzhiyun static int nfcmrvl_nci_fw_download(struct nci_dev *ndev,
90*4882a593Smuzhiyun 				   const char *firmware_name)
91*4882a593Smuzhiyun {
92*4882a593Smuzhiyun 	return nfcmrvl_fw_dnld_start(ndev, firmware_name);
93*4882a593Smuzhiyun }
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun static struct nci_ops nfcmrvl_nci_ops = {
96*4882a593Smuzhiyun 	.open = nfcmrvl_nci_open,
97*4882a593Smuzhiyun 	.close = nfcmrvl_nci_close,
98*4882a593Smuzhiyun 	.send = nfcmrvl_nci_send,
99*4882a593Smuzhiyun 	.setup = nfcmrvl_nci_setup,
100*4882a593Smuzhiyun 	.fw_download = nfcmrvl_nci_fw_download,
101*4882a593Smuzhiyun };
102*4882a593Smuzhiyun 
nfcmrvl_nci_register_dev(enum nfcmrvl_phy phy,void * drv_data,struct nfcmrvl_if_ops * ops,struct device * dev,struct nfcmrvl_platform_data * pdata)103*4882a593Smuzhiyun struct nfcmrvl_private *nfcmrvl_nci_register_dev(enum nfcmrvl_phy phy,
104*4882a593Smuzhiyun 				void *drv_data,
105*4882a593Smuzhiyun 				struct nfcmrvl_if_ops *ops,
106*4882a593Smuzhiyun 				struct device *dev,
107*4882a593Smuzhiyun 				struct nfcmrvl_platform_data *pdata)
108*4882a593Smuzhiyun {
109*4882a593Smuzhiyun 	struct nfcmrvl_private *priv;
110*4882a593Smuzhiyun 	int rc;
111*4882a593Smuzhiyun 	int headroom;
112*4882a593Smuzhiyun 	int tailroom;
113*4882a593Smuzhiyun 	u32 protocols;
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	priv = kzalloc(sizeof(*priv), GFP_KERNEL);
116*4882a593Smuzhiyun 	if (!priv)
117*4882a593Smuzhiyun 		return ERR_PTR(-ENOMEM);
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun 	priv->drv_data = drv_data;
120*4882a593Smuzhiyun 	priv->if_ops = ops;
121*4882a593Smuzhiyun 	priv->dev = dev;
122*4882a593Smuzhiyun 	priv->phy = phy;
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun 	memcpy(&priv->config, pdata, sizeof(*pdata));
125*4882a593Smuzhiyun 
126*4882a593Smuzhiyun 	if (gpio_is_valid(priv->config.reset_n_io)) {
127*4882a593Smuzhiyun 		rc = gpio_request_one(priv->config.reset_n_io,
128*4882a593Smuzhiyun 				      GPIOF_OUT_INIT_LOW,
129*4882a593Smuzhiyun 				      "nfcmrvl_reset_n");
130*4882a593Smuzhiyun 		if (rc < 0) {
131*4882a593Smuzhiyun 			priv->config.reset_n_io = -EINVAL;
132*4882a593Smuzhiyun 			nfc_err(dev, "failed to request reset_n io\n");
133*4882a593Smuzhiyun 		}
134*4882a593Smuzhiyun 	}
135*4882a593Smuzhiyun 
136*4882a593Smuzhiyun 	if (phy == NFCMRVL_PHY_SPI) {
137*4882a593Smuzhiyun 		headroom = NCI_SPI_HDR_LEN;
138*4882a593Smuzhiyun 		tailroom = 1;
139*4882a593Smuzhiyun 	} else
140*4882a593Smuzhiyun 		headroom = tailroom = 0;
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun 	if (priv->config.hci_muxed)
143*4882a593Smuzhiyun 		headroom += NFCMRVL_HCI_EVENT_HEADER_SIZE;
144*4882a593Smuzhiyun 
145*4882a593Smuzhiyun 	protocols = NFC_PROTO_JEWEL_MASK
146*4882a593Smuzhiyun 		| NFC_PROTO_MIFARE_MASK
147*4882a593Smuzhiyun 		| NFC_PROTO_FELICA_MASK
148*4882a593Smuzhiyun 		| NFC_PROTO_ISO14443_MASK
149*4882a593Smuzhiyun 		| NFC_PROTO_ISO14443_B_MASK
150*4882a593Smuzhiyun 		| NFC_PROTO_ISO15693_MASK
151*4882a593Smuzhiyun 		| NFC_PROTO_NFC_DEP_MASK;
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	priv->ndev = nci_allocate_device(&nfcmrvl_nci_ops, protocols,
154*4882a593Smuzhiyun 					 headroom, tailroom);
155*4882a593Smuzhiyun 	if (!priv->ndev) {
156*4882a593Smuzhiyun 		nfc_err(dev, "nci_allocate_device failed\n");
157*4882a593Smuzhiyun 		rc = -ENOMEM;
158*4882a593Smuzhiyun 		goto error_free_gpio;
159*4882a593Smuzhiyun 	}
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 	rc = nfcmrvl_fw_dnld_init(priv);
162*4882a593Smuzhiyun 	if (rc) {
163*4882a593Smuzhiyun 		nfc_err(dev, "failed to initialize FW download %d\n", rc);
164*4882a593Smuzhiyun 		goto error_free_dev;
165*4882a593Smuzhiyun 	}
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun 	nci_set_drvdata(priv->ndev, priv);
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun 	rc = nci_register_device(priv->ndev);
170*4882a593Smuzhiyun 	if (rc) {
171*4882a593Smuzhiyun 		nfc_err(dev, "nci_register_device failed %d\n", rc);
172*4882a593Smuzhiyun 		goto error_fw_dnld_deinit;
173*4882a593Smuzhiyun 	}
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun 	/* Ensure that controller is powered off */
176*4882a593Smuzhiyun 	nfcmrvl_chip_halt(priv);
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun 	nfc_info(dev, "registered with nci successfully\n");
179*4882a593Smuzhiyun 	return priv;
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun error_fw_dnld_deinit:
182*4882a593Smuzhiyun 	nfcmrvl_fw_dnld_deinit(priv);
183*4882a593Smuzhiyun error_free_dev:
184*4882a593Smuzhiyun 	nci_free_device(priv->ndev);
185*4882a593Smuzhiyun error_free_gpio:
186*4882a593Smuzhiyun 	if (gpio_is_valid(priv->config.reset_n_io))
187*4882a593Smuzhiyun 		gpio_free(priv->config.reset_n_io);
188*4882a593Smuzhiyun 	kfree(priv);
189*4882a593Smuzhiyun 	return ERR_PTR(rc);
190*4882a593Smuzhiyun }
191*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(nfcmrvl_nci_register_dev);
192*4882a593Smuzhiyun 
nfcmrvl_nci_unregister_dev(struct nfcmrvl_private * priv)193*4882a593Smuzhiyun void nfcmrvl_nci_unregister_dev(struct nfcmrvl_private *priv)
194*4882a593Smuzhiyun {
195*4882a593Smuzhiyun 	struct nci_dev *ndev = priv->ndev;
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 	nci_unregister_device(ndev);
198*4882a593Smuzhiyun 	if (priv->ndev->nfc_dev->fw_download_in_progress)
199*4882a593Smuzhiyun 		nfcmrvl_fw_dnld_abort(priv);
200*4882a593Smuzhiyun 
201*4882a593Smuzhiyun 	nfcmrvl_fw_dnld_deinit(priv);
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun 	if (gpio_is_valid(priv->config.reset_n_io))
204*4882a593Smuzhiyun 		gpio_free(priv->config.reset_n_io);
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun 	nci_free_device(ndev);
207*4882a593Smuzhiyun 	kfree(priv);
208*4882a593Smuzhiyun }
209*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(nfcmrvl_nci_unregister_dev);
210*4882a593Smuzhiyun 
nfcmrvl_nci_recv_frame(struct nfcmrvl_private * priv,struct sk_buff * skb)211*4882a593Smuzhiyun int nfcmrvl_nci_recv_frame(struct nfcmrvl_private *priv, struct sk_buff *skb)
212*4882a593Smuzhiyun {
213*4882a593Smuzhiyun 	if (priv->config.hci_muxed) {
214*4882a593Smuzhiyun 		if (skb->data[0] == NFCMRVL_HCI_EVENT_CODE &&
215*4882a593Smuzhiyun 		    skb->data[1] == NFCMRVL_HCI_NFC_EVENT_CODE) {
216*4882a593Smuzhiyun 			/* Data packet, let's extract NCI payload */
217*4882a593Smuzhiyun 			skb_pull(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
218*4882a593Smuzhiyun 		} else {
219*4882a593Smuzhiyun 			/* Skip this packet */
220*4882a593Smuzhiyun 			kfree_skb(skb);
221*4882a593Smuzhiyun 			return 0;
222*4882a593Smuzhiyun 		}
223*4882a593Smuzhiyun 	}
224*4882a593Smuzhiyun 
225*4882a593Smuzhiyun 	if (priv->ndev->nfc_dev->fw_download_in_progress) {
226*4882a593Smuzhiyun 		nfcmrvl_fw_dnld_recv_frame(priv, skb);
227*4882a593Smuzhiyun 		return 0;
228*4882a593Smuzhiyun 	}
229*4882a593Smuzhiyun 
230*4882a593Smuzhiyun 	if (test_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
231*4882a593Smuzhiyun 		nci_recv_frame(priv->ndev, skb);
232*4882a593Smuzhiyun 	else {
233*4882a593Smuzhiyun 		/* Drop this packet since nobody wants it */
234*4882a593Smuzhiyun 		kfree_skb(skb);
235*4882a593Smuzhiyun 		return 0;
236*4882a593Smuzhiyun 	}
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun 	return 0;
239*4882a593Smuzhiyun }
240*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(nfcmrvl_nci_recv_frame);
241*4882a593Smuzhiyun 
nfcmrvl_chip_reset(struct nfcmrvl_private * priv)242*4882a593Smuzhiyun void nfcmrvl_chip_reset(struct nfcmrvl_private *priv)
243*4882a593Smuzhiyun {
244*4882a593Smuzhiyun 	/* Reset possible fault of previous session */
245*4882a593Smuzhiyun 	clear_bit(NFCMRVL_PHY_ERROR, &priv->flags);
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun 	if (gpio_is_valid(priv->config.reset_n_io)) {
248*4882a593Smuzhiyun 		nfc_info(priv->dev, "reset the chip\n");
249*4882a593Smuzhiyun 		gpio_set_value(priv->config.reset_n_io, 0);
250*4882a593Smuzhiyun 		usleep_range(5000, 10000);
251*4882a593Smuzhiyun 		gpio_set_value(priv->config.reset_n_io, 1);
252*4882a593Smuzhiyun 	} else
253*4882a593Smuzhiyun 		nfc_info(priv->dev, "no reset available on this interface\n");
254*4882a593Smuzhiyun }
255*4882a593Smuzhiyun 
nfcmrvl_chip_halt(struct nfcmrvl_private * priv)256*4882a593Smuzhiyun void nfcmrvl_chip_halt(struct nfcmrvl_private *priv)
257*4882a593Smuzhiyun {
258*4882a593Smuzhiyun 	if (gpio_is_valid(priv->config.reset_n_io))
259*4882a593Smuzhiyun 		gpio_set_value(priv->config.reset_n_io, 0);
260*4882a593Smuzhiyun }
261*4882a593Smuzhiyun 
nfcmrvl_parse_dt(struct device_node * node,struct nfcmrvl_platform_data * pdata)262*4882a593Smuzhiyun int nfcmrvl_parse_dt(struct device_node *node,
263*4882a593Smuzhiyun 		     struct nfcmrvl_platform_data *pdata)
264*4882a593Smuzhiyun {
265*4882a593Smuzhiyun 	int reset_n_io;
266*4882a593Smuzhiyun 
267*4882a593Smuzhiyun 	reset_n_io = of_get_named_gpio(node, "reset-n-io", 0);
268*4882a593Smuzhiyun 	if (reset_n_io < 0) {
269*4882a593Smuzhiyun 		pr_info("no reset-n-io config\n");
270*4882a593Smuzhiyun 	} else if (!gpio_is_valid(reset_n_io)) {
271*4882a593Smuzhiyun 		pr_err("invalid reset-n-io GPIO\n");
272*4882a593Smuzhiyun 		return reset_n_io;
273*4882a593Smuzhiyun 	}
274*4882a593Smuzhiyun 	pdata->reset_n_io = reset_n_io;
275*4882a593Smuzhiyun 
276*4882a593Smuzhiyun 	if (of_find_property(node, "hci-muxed", NULL))
277*4882a593Smuzhiyun 		pdata->hci_muxed = 1;
278*4882a593Smuzhiyun 	else
279*4882a593Smuzhiyun 		pdata->hci_muxed = 0;
280*4882a593Smuzhiyun 
281*4882a593Smuzhiyun 	return 0;
282*4882a593Smuzhiyun }
283*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(nfcmrvl_parse_dt);
284*4882a593Smuzhiyun 
285*4882a593Smuzhiyun MODULE_AUTHOR("Marvell International Ltd.");
286*4882a593Smuzhiyun MODULE_DESCRIPTION("Marvell NFC driver");
287*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
288