1 // SPDX-License-Identifier: GPL-2.0-only
3 * I2C link layer for the NXP NCI driver
5 * Copyright (C) 2014 NXP Semiconductors All rights reserved.
6 * Copyright (C) 2012-2015 Intel Corporation. All rights reserved.
8 * Authors: Clément Perrochaud <clement.perrochaud@nxp.com>
9 * Authors: Oleg Zhurakivskyy <oleg.zhurakivskyy@intel.com>
11 * Derived from PN544 device driver:
12 * Copyright (C) 2012 Intel Corporation. All rights reserved.
15 #include <linux/acpi.h>
16 #include <linux/delay.h>
17 #include <linux/i2c.h>
18 #include <linux/interrupt.h>
19 #include <linux/module.h>
20 #include <linux/nfc.h>
21 #include <linux/gpio/consumer.h>
22 #include <asm/unaligned.h>
24 #include <net/nfc/nfc.h>
28 #define NXP_NCI_I2C_DRIVER_NAME "nxp-nci_i2c"
30 #define NXP_NCI_I2C_MAX_PAYLOAD 32
32 struct nxp_nci_i2c_phy {
33 struct i2c_client *i2c_dev;
36 struct gpio_desc *gpiod_en;
37 struct gpio_desc *gpiod_fw;
40 * < 0 if hardware error occurred (e.g. i2c err)
41 * and prevents normal operation.
45 static int nxp_nci_i2c_set_mode(void *phy_id,
46 enum nxp_nci_mode mode)
48 struct nxp_nci_i2c_phy *phy = (struct nxp_nci_i2c_phy *) phy_id;
50 gpiod_set_value(phy->gpiod_fw, (mode == NXP_NCI_MODE_FW) ? 1 : 0);
51 gpiod_set_value(phy->gpiod_en, (mode != NXP_NCI_MODE_COLD) ? 1 : 0);
52 usleep_range(10000, 15000);
54 if (mode == NXP_NCI_MODE_COLD)
60 static int nxp_nci_i2c_write(void *phy_id, struct sk_buff *skb)
63 struct nxp_nci_i2c_phy *phy = phy_id;
64 struct i2c_client *client = phy->i2c_dev;
66 if (phy->hard_fault != 0)
67 return phy->hard_fault;
69 r = i2c_master_send(client, skb->data, skb->len);
71 /* Retry, chip was in standby */
73 r = i2c_master_send(client, skb->data, skb->len);
77 nfc_err(&client->dev, "Error %d on I2C send\n", r);
78 } else if (r != skb->len) {
80 "Invalid length sent: %u (expected %u)\n",
84 /* Success but return 0 and not number of bytes */
91 static const struct nxp_nci_phy_ops i2c_phy_ops = {
92 .set_mode = nxp_nci_i2c_set_mode,
93 .write = nxp_nci_i2c_write,
96 static int nxp_nci_i2c_fw_read(struct nxp_nci_i2c_phy *phy,
99 struct i2c_client *client = phy->i2c_dev;
104 r = i2c_master_recv(client, (u8 *) &header, NXP_NCI_FW_HDR_LEN);
107 } else if (r != NXP_NCI_FW_HDR_LEN) {
108 nfc_err(&client->dev, "Incorrect header length: %u\n", r);
113 frame_len = (be16_to_cpu(header) & NXP_NCI_FW_FRAME_LEN_MASK) +
116 *skb = alloc_skb(NXP_NCI_FW_HDR_LEN + frame_len, GFP_KERNEL);
122 skb_put_data(*skb, &header, NXP_NCI_FW_HDR_LEN);
124 r = i2c_master_recv(client, skb_put(*skb, frame_len), frame_len);
125 if (r != frame_len) {
126 nfc_err(&client->dev,
127 "Invalid frame length: %u (expected %zu)\n",
130 goto fw_read_exit_free_skb;
135 fw_read_exit_free_skb:
141 static int nxp_nci_i2c_nci_read(struct nxp_nci_i2c_phy *phy,
142 struct sk_buff **skb)
144 struct nci_ctrl_hdr header; /* May actually be a data header */
145 struct i2c_client *client = phy->i2c_dev;
148 r = i2c_master_recv(client, (u8 *) &header, NCI_CTRL_HDR_SIZE);
151 } else if (r != NCI_CTRL_HDR_SIZE) {
152 nfc_err(&client->dev, "Incorrect header length: %u\n", r);
157 *skb = alloc_skb(NCI_CTRL_HDR_SIZE + header.plen, GFP_KERNEL);
163 skb_put_data(*skb, (void *)&header, NCI_CTRL_HDR_SIZE);
168 r = i2c_master_recv(client, skb_put(*skb, header.plen), header.plen);
169 if (r != header.plen) {
170 nfc_err(&client->dev,
171 "Invalid frame payload length: %u (expected %u)\n",
174 goto nci_read_exit_free_skb;
179 nci_read_exit_free_skb:
185 static irqreturn_t nxp_nci_i2c_irq_thread_fn(int irq, void *phy_id)
187 struct nxp_nci_i2c_phy *phy = phy_id;
188 struct i2c_client *client;
189 struct nxp_nci_info *info;
191 struct sk_buff *skb = NULL;
194 if (!phy || !phy->ndev)
197 client = phy->i2c_dev;
199 if (!client || irq != client->irq)
202 info = nci_get_drvdata(phy->ndev);
207 mutex_lock(&info->info_lock);
209 if (phy->hard_fault != 0)
210 goto exit_irq_handled;
212 switch (info->mode) {
213 case NXP_NCI_MODE_NCI:
214 r = nxp_nci_i2c_nci_read(phy, &skb);
216 case NXP_NCI_MODE_FW:
217 r = nxp_nci_i2c_fw_read(phy, &skb);
219 case NXP_NCI_MODE_COLD:
224 if (r == -EREMOTEIO) {
226 if (info->mode == NXP_NCI_MODE_FW)
227 nxp_nci_fw_recv_frame(phy->ndev, NULL);
230 nfc_err(&client->dev, "Read failed with error %d\n", r);
231 goto exit_irq_handled;
234 switch (info->mode) {
235 case NXP_NCI_MODE_NCI:
236 nci_recv_frame(phy->ndev, skb);
238 case NXP_NCI_MODE_FW:
239 nxp_nci_fw_recv_frame(phy->ndev, skb);
241 case NXP_NCI_MODE_COLD:
246 mutex_unlock(&info->info_lock);
253 static const struct acpi_gpio_params firmware_gpios = { 1, 0, false };
254 static const struct acpi_gpio_params enable_gpios = { 2, 0, false };
256 static const struct acpi_gpio_mapping acpi_nxp_nci_gpios[] = {
257 { "enable-gpios", &enable_gpios, 1 },
258 { "firmware-gpios", &firmware_gpios, 1 },
262 static int nxp_nci_i2c_probe(struct i2c_client *client,
263 const struct i2c_device_id *id)
265 struct device *dev = &client->dev;
266 struct nxp_nci_i2c_phy *phy;
269 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
270 nfc_err(&client->dev, "Need I2C_FUNC_I2C\n");
274 phy = devm_kzalloc(&client->dev, sizeof(struct nxp_nci_i2c_phy),
279 phy->i2c_dev = client;
280 i2c_set_clientdata(client, phy);
282 r = devm_acpi_dev_add_driver_gpios(dev, acpi_nxp_nci_gpios);
284 dev_dbg(dev, "Unable to add GPIO mapping table\n");
286 phy->gpiod_en = devm_gpiod_get(dev, "enable", GPIOD_OUT_LOW);
287 if (IS_ERR(phy->gpiod_en)) {
288 nfc_err(dev, "Failed to get EN gpio\n");
289 return PTR_ERR(phy->gpiod_en);
292 phy->gpiod_fw = devm_gpiod_get_optional(dev, "firmware", GPIOD_OUT_LOW);
293 if (IS_ERR(phy->gpiod_fw)) {
294 nfc_err(dev, "Failed to get FW gpio\n");
295 return PTR_ERR(phy->gpiod_fw);
298 r = nxp_nci_probe(phy, &client->dev, &i2c_phy_ops,
299 NXP_NCI_I2C_MAX_PAYLOAD, &phy->ndev);
303 r = request_threaded_irq(client->irq, NULL,
304 nxp_nci_i2c_irq_thread_fn,
305 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
306 NXP_NCI_I2C_DRIVER_NAME, phy);
308 nfc_err(&client->dev, "Unable to register IRQ handler\n");
313 static int nxp_nci_i2c_remove(struct i2c_client *client)
315 struct nxp_nci_i2c_phy *phy = i2c_get_clientdata(client);
317 nxp_nci_remove(phy->ndev);
318 free_irq(client->irq, phy);
323 static const struct i2c_device_id nxp_nci_i2c_id_table[] = {
327 MODULE_DEVICE_TABLE(i2c, nxp_nci_i2c_id_table);
329 static const struct of_device_id of_nxp_nci_i2c_match[] = {
330 { .compatible = "nxp,nxp-nci-i2c", },
333 MODULE_DEVICE_TABLE(of, of_nxp_nci_i2c_match);
336 static const struct acpi_device_id acpi_id[] = {
341 MODULE_DEVICE_TABLE(acpi, acpi_id);
344 static struct i2c_driver nxp_nci_i2c_driver = {
346 .name = NXP_NCI_I2C_DRIVER_NAME,
347 .acpi_match_table = ACPI_PTR(acpi_id),
348 .of_match_table = of_nxp_nci_i2c_match,
350 .probe = nxp_nci_i2c_probe,
351 .id_table = nxp_nci_i2c_id_table,
352 .remove = nxp_nci_i2c_remove,
355 module_i2c_driver(nxp_nci_i2c_driver);
357 MODULE_LICENSE("GPL");
358 MODULE_DESCRIPTION("I2C driver for NXP NCI NFC controllers");
359 MODULE_AUTHOR("Clément Perrochaud <clement.perrochaud@nxp.com>");
360 MODULE_AUTHOR("Oleg Zhurakivskyy <oleg.zhurakivskyy@intel.com>");