xref: /linux/drivers/nfc/nfcmrvl/main.c (revision cf1b04aaef8b83f668fac10bfc4d4d76ba6e6fa1)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Marvell NFC driver: major functions
4  *
5  * Copyright (C) 2014-2015 Marvell International Ltd.
6  */
7 
8 #include <linux/module.h>
9 #include <linux/gpio/consumer.h>
10 #include <linux/delay.h>
11 #include <linux/of.h>
12 #include <linux/nfc.h>
13 #include <net/nfc/nci.h>
14 #include <net/nfc/nci_core.h>
15 #include "nfcmrvl.h"
16 
17 static int nfcmrvl_nci_open(struct nci_dev *ndev)
18 {
19 	struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
20 	int err;
21 
22 	if (test_and_set_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
23 		return 0;
24 
25 	/* Reset possible fault of previous session */
26 	clear_bit(NFCMRVL_PHY_ERROR, &priv->flags);
27 
28 	err = priv->if_ops->nci_open(priv);
29 
30 	if (err)
31 		clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags);
32 
33 	return err;
34 }
35 
36 static int nfcmrvl_nci_close(struct nci_dev *ndev)
37 {
38 	struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
39 
40 	if (!test_and_clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
41 		return 0;
42 
43 	priv->if_ops->nci_close(priv);
44 
45 	return 0;
46 }
47 
48 static int nfcmrvl_nci_send(struct nci_dev *ndev, struct sk_buff *skb)
49 {
50 	struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
51 
52 	nfc_info(priv->dev, "send entry, len %d\n", skb->len);
53 
54 	skb->dev = (void *)ndev;
55 
56 	if (priv->config.hci_muxed) {
57 		unsigned char *hdr;
58 		unsigned char len = skb->len;
59 
60 		hdr = skb_push(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
61 		hdr[0] = NFCMRVL_HCI_COMMAND_CODE;
62 		hdr[1] = NFCMRVL_HCI_OGF;
63 		hdr[2] = NFCMRVL_HCI_OCF;
64 		hdr[3] = len;
65 	}
66 
67 	return priv->if_ops->nci_send(priv, skb);
68 }
69 
70 static int nfcmrvl_nci_setup(struct nci_dev *ndev)
71 {
72 	__u8 val = 1;
73 
74 	nci_set_config(ndev, NFCMRVL_PB_BAIL_OUT, 1, &val);
75 	return 0;
76 }
77 
78 static int nfcmrvl_nci_fw_download(struct nci_dev *ndev,
79 				   const char *firmware_name)
80 {
81 	return nfcmrvl_fw_dnld_start(ndev, firmware_name);
82 }
83 
84 static const struct nci_ops nfcmrvl_nci_ops = {
85 	.open = nfcmrvl_nci_open,
86 	.close = nfcmrvl_nci_close,
87 	.send = nfcmrvl_nci_send,
88 	.setup = nfcmrvl_nci_setup,
89 	.fw_download = nfcmrvl_nci_fw_download,
90 };
91 
92 struct nfcmrvl_private *nfcmrvl_nci_register_dev(enum nfcmrvl_phy phy,
93 				void *drv_data,
94 				const struct nfcmrvl_if_ops *ops,
95 				struct device *dev,
96 				const struct nfcmrvl_platform_data *pdata)
97 {
98 	struct nfcmrvl_private *priv;
99 	int rc;
100 	int headroom;
101 	int tailroom;
102 	u32 protocols;
103 
104 	priv = kzalloc_obj(*priv);
105 	if (!priv)
106 		return ERR_PTR(-ENOMEM);
107 
108 	priv->drv_data = drv_data;
109 	priv->if_ops = ops;
110 	priv->dev = dev;
111 	priv->phy = phy;
112 
113 	memcpy(&priv->config, pdata, sizeof(*pdata));
114 
115 	if (!priv->config.reset_gpio) {
116 		priv->config.reset_gpio =
117 			devm_gpiod_get_optional(dev, "reset", GPIOD_OUT_HIGH);
118 		if (IS_ERR(priv->config.reset_gpio)) {
119 			priv->config.reset_gpio = NULL;
120 			nfc_err(dev, "failed to get reset gpio\n");
121 		}
122 	}
123 
124 	if (phy == NFCMRVL_PHY_SPI) {
125 		headroom = NCI_SPI_HDR_LEN;
126 		tailroom = 1;
127 	} else
128 		headroom = tailroom = 0;
129 
130 	if (priv->config.hci_muxed)
131 		headroom += NFCMRVL_HCI_EVENT_HEADER_SIZE;
132 
133 	protocols = NFC_PROTO_JEWEL_MASK
134 		| NFC_PROTO_MIFARE_MASK
135 		| NFC_PROTO_FELICA_MASK
136 		| NFC_PROTO_ISO14443_MASK
137 		| NFC_PROTO_ISO14443_B_MASK
138 		| NFC_PROTO_ISO15693_MASK
139 		| NFC_PROTO_NFC_DEP_MASK;
140 
141 	priv->ndev = nci_allocate_device(&nfcmrvl_nci_ops, protocols,
142 					 headroom, tailroom);
143 	if (!priv->ndev) {
144 		nfc_err(dev, "nci_allocate_device failed\n");
145 		rc = -ENOMEM;
146 		goto error_free;
147 	}
148 
149 	rc = nfcmrvl_fw_dnld_init(priv);
150 	if (rc) {
151 		nfc_err(dev, "failed to initialize FW download %d\n", rc);
152 		goto error_free_dev;
153 	}
154 
155 	nci_set_drvdata(priv->ndev, priv);
156 
157 	rc = nci_register_device(priv->ndev);
158 	if (rc) {
159 		nfc_err(dev, "nci_register_device failed %d\n", rc);
160 		goto error_fw_dnld_deinit;
161 	}
162 
163 	/* Ensure that controller is powered off */
164 	nfcmrvl_chip_halt(priv);
165 
166 	nfc_info(dev, "registered with nci successfully\n");
167 	return priv;
168 
169 error_fw_dnld_deinit:
170 	nfcmrvl_fw_dnld_deinit(priv);
171 error_free_dev:
172 	nci_free_device(priv->ndev);
173 error_free:
174 	kfree(priv);
175 	return ERR_PTR(rc);
176 }
177 EXPORT_SYMBOL_GPL(nfcmrvl_nci_register_dev);
178 
179 void nfcmrvl_nci_unregister_dev(struct nfcmrvl_private *priv)
180 {
181 	struct nci_dev *ndev = priv->ndev;
182 
183 	nci_unregister_device(ndev);
184 	if (priv->ndev->nfc_dev->fw_download_in_progress)
185 		nfcmrvl_fw_dnld_abort(priv);
186 
187 	nfcmrvl_fw_dnld_deinit(priv);
188 
189 	nci_free_device(ndev);
190 	kfree(priv);
191 }
192 EXPORT_SYMBOL_GPL(nfcmrvl_nci_unregister_dev);
193 
194 int nfcmrvl_nci_recv_frame(struct nfcmrvl_private *priv, struct sk_buff *skb)
195 {
196 	if (priv->config.hci_muxed) {
197 		if (skb->data[0] == NFCMRVL_HCI_EVENT_CODE &&
198 		    skb->data[1] == NFCMRVL_HCI_NFC_EVENT_CODE) {
199 			/* Data packet, let's extract NCI payload */
200 			skb_pull(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
201 		} else {
202 			/* Skip this packet */
203 			kfree_skb(skb);
204 			return 0;
205 		}
206 	}
207 
208 	if (priv->ndev->nfc_dev->fw_download_in_progress) {
209 		nfcmrvl_fw_dnld_recv_frame(priv, skb);
210 		return 0;
211 	}
212 
213 	if (test_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
214 		nci_recv_frame(priv->ndev, skb);
215 	else {
216 		/* Drop this packet since nobody wants it */
217 		kfree_skb(skb);
218 		return 0;
219 	}
220 
221 	return 0;
222 }
223 EXPORT_SYMBOL_GPL(nfcmrvl_nci_recv_frame);
224 
225 void nfcmrvl_chip_reset(struct nfcmrvl_private *priv)
226 {
227 	/* Reset possible fault of previous session */
228 	clear_bit(NFCMRVL_PHY_ERROR, &priv->flags);
229 
230 	if (priv->config.reset_gpio) {
231 		nfc_info(priv->dev, "reset the chip\n");
232 		gpiod_set_value(priv->config.reset_gpio, 1);
233 		usleep_range(5000, 10000);
234 		gpiod_set_value(priv->config.reset_gpio, 0);
235 	} else
236 		nfc_info(priv->dev, "no reset available on this interface\n");
237 }
238 
239 void nfcmrvl_chip_halt(struct nfcmrvl_private *priv)
240 {
241 	if (priv->config.reset_gpio)
242 		gpiod_set_value(priv->config.reset_gpio, 1);
243 }
244 
245 int nfcmrvl_parse_dt(struct device_node *node,
246 		     struct nfcmrvl_platform_data *pdata)
247 {
248 	pdata->reset_gpio = NULL;
249 	pdata->hci_muxed = of_property_read_bool(node, "hci-muxed");
250 
251 	return 0;
252 }
253 EXPORT_SYMBOL_GPL(nfcmrvl_parse_dt);
254 
255 MODULE_AUTHOR("Marvell International Ltd.");
256 MODULE_DESCRIPTION("Marvell NFC driver");
257 MODULE_LICENSE("GPL v2");
258