NFC: nfcmrvl: configure head/tail room values per low level drivers
[firefly-linux-kernel-4.4.55.git] / drivers / nfc / nfcmrvl / main.c
1 /*
2  * Marvell NFC driver: major functions
3  *
4  * Copyright (C) 2014-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/gpio.h>
21 #include <linux/delay.h>
22 #include <linux/of_gpio.h>
23 #include <linux/nfc.h>
24 #include <net/nfc/nci.h>
25 #include <net/nfc/nci_core.h>
26 #include "nfcmrvl.h"
27
28 static int nfcmrvl_nci_open(struct nci_dev *ndev)
29 {
30         struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
31         int err;
32
33         if (test_and_set_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
34                 return 0;
35
36         err = priv->if_ops->nci_open(priv);
37
38         if (err)
39                 clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags);
40
41         return err;
42 }
43
44 static int nfcmrvl_nci_close(struct nci_dev *ndev)
45 {
46         struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
47
48         if (!test_and_clear_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
49                 return 0;
50
51         priv->if_ops->nci_close(priv);
52
53         return 0;
54 }
55
56 static int nfcmrvl_nci_send(struct nci_dev *ndev, struct sk_buff *skb)
57 {
58         struct nfcmrvl_private *priv = nci_get_drvdata(ndev);
59
60         nfc_info(priv->dev, "send entry, len %d\n", skb->len);
61
62         skb->dev = (void *)ndev;
63
64         if (priv->config.hci_muxed) {
65                 unsigned char *hdr;
66                 unsigned char len = skb->len;
67
68                 hdr = (char *) skb_push(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
69                 hdr[0] = NFCMRVL_HCI_COMMAND_CODE;
70                 hdr[1] = NFCMRVL_HCI_OGF;
71                 hdr[2] = NFCMRVL_HCI_OCF;
72                 hdr[3] = len;
73         }
74
75         return priv->if_ops->nci_send(priv, skb);
76 }
77
78 static int nfcmrvl_nci_setup(struct nci_dev *ndev)
79 {
80         __u8 val = 1;
81
82         nci_set_config(ndev, NFCMRVL_PB_BAIL_OUT, 1, &val);
83         return 0;
84 }
85
86 static int nfcmrvl_nci_fw_download(struct nci_dev *ndev,
87                                    const char *firmware_name)
88 {
89         return nfcmrvl_fw_dnld_start(ndev, firmware_name);
90 }
91
92 static struct nci_ops nfcmrvl_nci_ops = {
93         .open = nfcmrvl_nci_open,
94         .close = nfcmrvl_nci_close,
95         .send = nfcmrvl_nci_send,
96         .setup = nfcmrvl_nci_setup,
97         .fw_download = nfcmrvl_nci_fw_download,
98 };
99
100 struct nfcmrvl_private *nfcmrvl_nci_register_dev(enum nfcmrvl_phy phy,
101                                 void *drv_data,
102                                 struct nfcmrvl_if_ops *ops,
103                                 struct device *dev,
104                                 struct nfcmrvl_platform_data *pdata)
105 {
106         struct nfcmrvl_private *priv;
107         int rc;
108         int headroom;
109         int tailroom;
110         u32 protocols;
111
112         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
113         if (!priv)
114                 return ERR_PTR(-ENOMEM);
115
116         priv->drv_data = drv_data;
117         priv->if_ops = ops;
118         priv->dev = dev;
119         priv->phy = phy;
120
121         memcpy(&priv->config, pdata, sizeof(*pdata));
122
123         if (priv->config.reset_n_io) {
124                 rc = devm_gpio_request_one(dev,
125                                            priv->config.reset_n_io,
126                                            GPIOF_OUT_INIT_LOW,
127                                            "nfcmrvl_reset_n");
128                 if (rc < 0)
129                         nfc_err(dev, "failed to request reset_n io\n");
130         }
131
132         headroom = tailroom = 0;
133
134         if (priv->config.hci_muxed)
135                 headroom += NFCMRVL_HCI_EVENT_HEADER_SIZE;
136
137         protocols = NFC_PROTO_JEWEL_MASK
138                 | NFC_PROTO_MIFARE_MASK
139                 | NFC_PROTO_FELICA_MASK
140                 | NFC_PROTO_ISO14443_MASK
141                 | NFC_PROTO_ISO14443_B_MASK
142                 | NFC_PROTO_ISO15693_MASK
143                 | NFC_PROTO_NFC_DEP_MASK;
144
145         priv->ndev = nci_allocate_device(&nfcmrvl_nci_ops, protocols,
146                                          headroom, tailroom);
147         if (!priv->ndev) {
148                 nfc_err(dev, "nci_allocate_device failed\n");
149                 rc = -ENOMEM;
150                 goto error;
151         }
152
153         nci_set_drvdata(priv->ndev, priv);
154
155         rc = nci_register_device(priv->ndev);
156         if (rc) {
157                 nfc_err(dev, "nci_register_device failed %d\n", rc);
158                 goto error_free_dev;
159         }
160
161         /* Ensure that controller is powered off */
162         nfcmrvl_chip_halt(priv);
163
164         rc = nfcmrvl_fw_dnld_init(priv);
165         if (rc) {
166                 nfc_err(dev, "failed to initialize FW download %d\n", rc);
167                 goto error_free_dev;
168         }
169
170         nfc_info(dev, "registered with nci successfully\n");
171         return priv;
172
173 error_free_dev:
174         nci_free_device(priv->ndev);
175 error:
176         kfree(priv);
177         return ERR_PTR(rc);
178 }
179 EXPORT_SYMBOL_GPL(nfcmrvl_nci_register_dev);
180
181 void nfcmrvl_nci_unregister_dev(struct nfcmrvl_private *priv)
182 {
183         struct nci_dev *ndev = priv->ndev;
184
185         if (priv->ndev->nfc_dev->fw_download_in_progress)
186                 nfcmrvl_fw_dnld_abort(priv);
187
188         nfcmrvl_fw_dnld_deinit(priv);
189
190         nci_unregister_device(ndev);
191         nci_free_device(ndev);
192         kfree(priv);
193 }
194 EXPORT_SYMBOL_GPL(nfcmrvl_nci_unregister_dev);
195
196 int nfcmrvl_nci_recv_frame(struct nfcmrvl_private *priv, struct sk_buff *skb)
197 {
198         if (priv->config.hci_muxed) {
199                 if (skb->data[0] == NFCMRVL_HCI_EVENT_CODE &&
200                     skb->data[1] == NFCMRVL_HCI_NFC_EVENT_CODE) {
201                         /* Data packet, let's extract NCI payload */
202                         skb_pull(skb, NFCMRVL_HCI_EVENT_HEADER_SIZE);
203                 } else {
204                         /* Skip this packet */
205                         kfree_skb(skb);
206                         return 0;
207                 }
208         }
209
210         if (priv->ndev->nfc_dev->fw_download_in_progress) {
211                 nfcmrvl_fw_dnld_recv_frame(priv, skb);
212                 return 0;
213         }
214
215         if (test_bit(NFCMRVL_NCI_RUNNING, &priv->flags))
216                 nci_recv_frame(priv->ndev, skb);
217         else {
218                 /* Drop this packet since nobody wants it */
219                 kfree_skb(skb);
220                 return 0;
221         }
222
223         return 0;
224 }
225 EXPORT_SYMBOL_GPL(nfcmrvl_nci_recv_frame);
226
227 void nfcmrvl_chip_reset(struct nfcmrvl_private *priv)
228 {
229         /*
230          * This function does not take care if someone is using the device.
231          * To be improved.
232          */
233
234         if (priv->config.reset_n_io) {
235                 nfc_info(priv->dev, "reset the chip\n");
236                 gpio_set_value(priv->config.reset_n_io, 0);
237                 usleep_range(5000, 10000);
238                 gpio_set_value(priv->config.reset_n_io, 1);
239         } else
240                 nfc_info(priv->dev, "no reset available on this interface\n");
241 }
242
243 void nfcmrvl_chip_halt(struct nfcmrvl_private *priv)
244 {
245         if (priv->config.reset_n_io)
246                 gpio_set_value(priv->config.reset_n_io, 0);
247 }
248
249 #ifdef CONFIG_OF
250
251 int nfcmrvl_parse_dt(struct device_node *node,
252                      struct nfcmrvl_platform_data *pdata)
253 {
254         int reset_n_io;
255
256         reset_n_io = of_get_named_gpio(node, "reset-n-io", 0);
257         if (reset_n_io < 0) {
258                 pr_info("no reset-n-io config\n");
259                 reset_n_io = 0;
260         } else if (!gpio_is_valid(reset_n_io)) {
261                 pr_err("invalid reset-n-io GPIO\n");
262                 return reset_n_io;
263         }
264         pdata->reset_n_io = reset_n_io;
265
266         if (of_find_property(node, "hci-muxed", NULL))
267                 pdata->hci_muxed = 1;
268         else
269                 pdata->hci_muxed = 0;
270
271         return 0;
272 }
273
274 #else
275
276 int nfcmrvl_parse_dt(struct device_node *node,
277                      struct nfcmrvl_platform_data *pdata)
278 {
279         return -ENODEV;
280 }
281
282 #endif
283 EXPORT_SYMBOL_GPL(nfcmrvl_parse_dt);
284
285 MODULE_AUTHOR("Marvell International Ltd.");
286 MODULE_DESCRIPTION("Marvell NFC driver");
287 MODULE_LICENSE("GPL v2");