2 * I2C link layer for the NXP NCI driver
4 * Copyright (C) 2014 NXP Semiconductors All rights reserved.
5 * Copyright (C) 2012-2015 Intel Corporation. All rights reserved.
7 * Authors: Clément Perrochaud <clement.perrochaud@nxp.com>
8 * Authors: Oleg Zhurakivskyy <oleg.zhurakivskyy@intel.com>
10 * Derived from PN544 device driver:
11 * Copyright (C) 2012 Intel Corporation. All rights reserved.
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms and conditions of the GNU General Public License,
15 * version 2, as published by the Free Software Foundation.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <http://www.gnu.org/licenses/>.
26 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
28 #include <linux/acpi.h>
29 #include <linux/delay.h>
30 #include <linux/i2c.h>
31 #include <linux/interrupt.h>
32 #include <linux/module.h>
33 #include <linux/nfc.h>
34 #include <linux/gpio/consumer.h>
35 #include <linux/of_gpio.h>
36 #include <linux/of_irq.h>
37 #include <linux/platform_data/nxp-nci.h>
38 #include <asm/unaligned.h>
40 #include <net/nfc/nfc.h>
44 #define NXP_NCI_I2C_DRIVER_NAME "nxp-nci_i2c"
46 #define NXP_NCI_I2C_MAX_PAYLOAD 32
48 struct nxp_nci_i2c_phy {
49 struct i2c_client *i2c_dev;
56 * < 0 if hardware error occurred (e.g. i2c err)
57 * and prevents normal operation.
61 static int nxp_nci_i2c_set_mode(void *phy_id,
62 enum nxp_nci_mode mode)
64 struct nxp_nci_i2c_phy *phy = (struct nxp_nci_i2c_phy *) phy_id;
66 gpio_set_value(phy->gpio_fw, (mode == NXP_NCI_MODE_FW) ? 1 : 0);
67 gpio_set_value(phy->gpio_en, (mode != NXP_NCI_MODE_COLD) ? 1 : 0);
68 usleep_range(10000, 15000);
70 if (mode == NXP_NCI_MODE_COLD)
76 static int nxp_nci_i2c_write(void *phy_id, struct sk_buff *skb)
79 struct nxp_nci_i2c_phy *phy = phy_id;
80 struct i2c_client *client = phy->i2c_dev;
82 if (phy->hard_fault != 0)
83 return phy->hard_fault;
85 r = i2c_master_send(client, skb->data, skb->len);
87 /* Retry, chip was in standby */
89 r = i2c_master_send(client, skb->data, skb->len);
93 nfc_err(&client->dev, "Error %d on I2C send\n", r);
94 } else if (r != skb->len) {
96 "Invalid length sent: %u (expected %u)\n",
100 /* Success but return 0 and not number of bytes */
107 static const struct nxp_nci_phy_ops i2c_phy_ops = {
108 .set_mode = nxp_nci_i2c_set_mode,
109 .write = nxp_nci_i2c_write,
112 static int nxp_nci_i2c_fw_read(struct nxp_nci_i2c_phy *phy,
113 struct sk_buff **skb)
115 struct i2c_client *client = phy->i2c_dev;
120 r = i2c_master_recv(client, (u8 *) &header, NXP_NCI_FW_HDR_LEN);
123 } else if (r != NXP_NCI_FW_HDR_LEN) {
124 nfc_err(&client->dev, "Incorrect header length: %u\n", r);
129 frame_len = (be16_to_cpu(header) & NXP_NCI_FW_FRAME_LEN_MASK) +
132 *skb = alloc_skb(NXP_NCI_FW_HDR_LEN + frame_len, GFP_KERNEL);
138 memcpy(skb_put(*skb, NXP_NCI_FW_HDR_LEN), &header, NXP_NCI_FW_HDR_LEN);
140 r = i2c_master_recv(client, skb_put(*skb, frame_len), frame_len);
141 if (r != frame_len) {
142 nfc_err(&client->dev,
143 "Invalid frame length: %u (expected %zu)\n",
146 goto fw_read_exit_free_skb;
151 fw_read_exit_free_skb:
157 static int nxp_nci_i2c_nci_read(struct nxp_nci_i2c_phy *phy,
158 struct sk_buff **skb)
160 struct nci_ctrl_hdr header; /* May actually be a data header */
161 struct i2c_client *client = phy->i2c_dev;
164 r = i2c_master_recv(client, (u8 *) &header, NCI_CTRL_HDR_SIZE);
167 } else if (r != NCI_CTRL_HDR_SIZE) {
168 nfc_err(&client->dev, "Incorrect header length: %u\n", r);
173 *skb = alloc_skb(NCI_CTRL_HDR_SIZE + header.plen, GFP_KERNEL);
179 memcpy(skb_put(*skb, NCI_CTRL_HDR_SIZE), (void *) &header,
182 r = i2c_master_recv(client, skb_put(*skb, header.plen), header.plen);
183 if (r != header.plen) {
184 nfc_err(&client->dev,
185 "Invalid frame payload length: %u (expected %u)\n",
188 goto nci_read_exit_free_skb;
193 nci_read_exit_free_skb:
199 static irqreturn_t nxp_nci_i2c_irq_thread_fn(int irq, void *phy_id)
201 struct nxp_nci_i2c_phy *phy = phy_id;
202 struct i2c_client *client;
203 struct nxp_nci_info *info;
205 struct sk_buff *skb = NULL;
208 if (!phy || !phy->ndev)
211 client = phy->i2c_dev;
213 if (!client || irq != client->irq)
216 info = nci_get_drvdata(phy->ndev);
221 mutex_lock(&info->info_lock);
223 if (phy->hard_fault != 0)
224 goto exit_irq_handled;
226 switch (info->mode) {
227 case NXP_NCI_MODE_NCI:
228 r = nxp_nci_i2c_nci_read(phy, &skb);
230 case NXP_NCI_MODE_FW:
231 r = nxp_nci_i2c_fw_read(phy, &skb);
233 case NXP_NCI_MODE_COLD:
238 if (r == -EREMOTEIO) {
242 nfc_err(&client->dev, "Read failed with error %d\n", r);
243 goto exit_irq_handled;
246 switch (info->mode) {
247 case NXP_NCI_MODE_NCI:
248 nci_recv_frame(phy->ndev, skb);
250 case NXP_NCI_MODE_FW:
251 nxp_nci_fw_recv_frame(phy->ndev, skb);
253 case NXP_NCI_MODE_COLD:
258 mutex_unlock(&info->info_lock);
265 static int nxp_nci_i2c_parse_devtree(struct i2c_client *client)
267 struct nxp_nci_i2c_phy *phy = i2c_get_clientdata(client);
268 struct device_node *pp;
271 pp = client->dev.of_node;
275 r = of_get_named_gpio(pp, "enable-gpios", 0);
276 if (r == -EPROBE_DEFER)
277 r = of_get_named_gpio(pp, "enable-gpios", 0);
279 nfc_err(&client->dev, "Failed to get EN gpio, error: %d\n", r);
284 r = of_get_named_gpio(pp, "firmware-gpios", 0);
285 if (r == -EPROBE_DEFER)
286 r = of_get_named_gpio(pp, "firmware-gpios", 0);
288 nfc_err(&client->dev, "Failed to get FW gpio, error: %d\n", r);
296 static int nxp_nci_i2c_acpi_config(struct nxp_nci_i2c_phy *phy)
298 struct i2c_client *client = phy->i2c_dev;
299 struct gpio_desc *gpiod_en, *gpiod_fw;
301 gpiod_en = devm_gpiod_get_index(&client->dev, NULL, 2, GPIOD_OUT_LOW);
302 gpiod_fw = devm_gpiod_get_index(&client->dev, NULL, 1, GPIOD_OUT_LOW);
304 if (IS_ERR(gpiod_en) || IS_ERR(gpiod_fw)) {
305 nfc_err(&client->dev, "No GPIOs\n");
309 phy->gpio_en = desc_to_gpio(gpiod_en);
310 phy->gpio_fw = desc_to_gpio(gpiod_fw);
315 static int nxp_nci_i2c_probe(struct i2c_client *client,
316 const struct i2c_device_id *id)
318 struct nxp_nci_i2c_phy *phy;
319 struct nxp_nci_nfc_platform_data *pdata;
322 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
323 nfc_err(&client->dev, "Need I2C_FUNC_I2C\n");
328 phy = devm_kzalloc(&client->dev, sizeof(struct nxp_nci_i2c_phy),
335 phy->i2c_dev = client;
336 i2c_set_clientdata(client, phy);
338 pdata = client->dev.platform_data;
340 if (!pdata && client->dev.of_node) {
341 r = nxp_nci_i2c_parse_devtree(client);
343 nfc_err(&client->dev, "Failed to get DT data\n");
347 phy->gpio_en = pdata->gpio_en;
348 phy->gpio_fw = pdata->gpio_fw;
349 } else if (ACPI_HANDLE(&client->dev)) {
350 r = nxp_nci_i2c_acpi_config(phy);
355 nfc_err(&client->dev, "No platform data\n");
360 r = devm_gpio_request_one(&phy->i2c_dev->dev, phy->gpio_en,
361 GPIOF_OUT_INIT_LOW, "nxp_nci_en");
365 r = devm_gpio_request_one(&phy->i2c_dev->dev, phy->gpio_fw,
366 GPIOF_OUT_INIT_LOW, "nxp_nci_fw");
371 r = nxp_nci_probe(phy, &client->dev, &i2c_phy_ops,
372 NXP_NCI_I2C_MAX_PAYLOAD, &phy->ndev);
376 r = request_threaded_irq(client->irq, NULL,
377 nxp_nci_i2c_irq_thread_fn,
378 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
379 NXP_NCI_I2C_DRIVER_NAME, phy);
381 nfc_err(&client->dev, "Unable to register IRQ handler\n");
387 static int nxp_nci_i2c_remove(struct i2c_client *client)
389 struct nxp_nci_i2c_phy *phy = i2c_get_clientdata(client);
391 nxp_nci_remove(phy->ndev);
392 free_irq(client->irq, phy);
397 static struct i2c_device_id nxp_nci_i2c_id_table[] = {
401 MODULE_DEVICE_TABLE(i2c, nxp_nci_i2c_id_table);
403 static const struct of_device_id of_nxp_nci_i2c_match[] = {
404 { .compatible = "nxp,nxp-nci-i2c", },
407 MODULE_DEVICE_TABLE(of, of_nxp_nci_i2c_match);
410 static struct acpi_device_id acpi_id[] = {
414 MODULE_DEVICE_TABLE(acpi, acpi_id);
417 static struct i2c_driver nxp_nci_i2c_driver = {
419 .name = NXP_NCI_I2C_DRIVER_NAME,
420 .acpi_match_table = ACPI_PTR(acpi_id),
421 .of_match_table = of_match_ptr(of_nxp_nci_i2c_match),
423 .probe = nxp_nci_i2c_probe,
424 .id_table = nxp_nci_i2c_id_table,
425 .remove = nxp_nci_i2c_remove,
428 module_i2c_driver(nxp_nci_i2c_driver);
430 MODULE_LICENSE("GPL");
431 MODULE_DESCRIPTION("I2C driver for NXP NCI NFC controllers");
432 MODULE_AUTHOR("Clément Perrochaud <clement.perrochaud@nxp.com>");
433 MODULE_AUTHOR("Oleg Zhurakivskyy <oleg.zhurakivskyy@intel.com>");