2 * I2C Link Layer for PN544 HCI based Driver
4 * Copyright (C) 2012 Intel Corporation. All rights reserved.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
21 #include <linux/crc-ccitt.h>
22 #include <linux/module.h>
23 #include <linux/i2c.h>
24 #include <linux/gpio.h>
25 #include <linux/of_gpio.h>
26 #include <linux/of_irq.h>
27 #include <linux/acpi.h>
28 #include <linux/miscdevice.h>
29 #include <linux/interrupt.h>
30 #include <linux/delay.h>
31 #include <linux/nfc.h>
32 #include <linux/firmware.h>
33 #include <linux/gpio/consumer.h>
34 #include <linux/platform_data/pn544.h>
35 #include <asm/unaligned.h>
37 #include <net/nfc/hci.h>
38 #include <net/nfc/llc.h>
39 #include <net/nfc/nfc.h>
43 #define PN544_I2C_FRAME_HEADROOM 1
44 #define PN544_I2C_FRAME_TAILROOM 2
47 #define PN544_GPIO_NAME_IRQ "pn544_irq"
48 #define PN544_GPIO_NAME_FW "pn544_fw"
49 #define PN544_GPIO_NAME_EN "pn544_en"
51 /* framing in HCI mode */
52 #define PN544_HCI_I2C_LLC_LEN 1
53 #define PN544_HCI_I2C_LLC_CRC 2
54 #define PN544_HCI_I2C_LLC_LEN_CRC (PN544_HCI_I2C_LLC_LEN + \
55 PN544_HCI_I2C_LLC_CRC)
56 #define PN544_HCI_I2C_LLC_MIN_SIZE (1 + PN544_HCI_I2C_LLC_LEN_CRC)
57 #define PN544_HCI_I2C_LLC_MAX_PAYLOAD 29
58 #define PN544_HCI_I2C_LLC_MAX_SIZE (PN544_HCI_I2C_LLC_LEN_CRC + 1 + \
59 PN544_HCI_I2C_LLC_MAX_PAYLOAD)
61 static struct i2c_device_id pn544_hci_i2c_id_table[] = {
66 MODULE_DEVICE_TABLE(i2c, pn544_hci_i2c_id_table);
68 static const struct acpi_device_id pn544_hci_i2c_acpi_match[] = {
73 MODULE_DEVICE_TABLE(acpi, pn544_hci_i2c_acpi_match);
75 #define PN544_HCI_I2C_DRIVER_NAME "pn544_hci_i2c"
78 * Exposed through the 4 most significant bytes
79 * from the HCI SW_VERSION first byte, a.k.a.
82 #define PN544_HW_VARIANT_C2 0xa
83 #define PN544_HW_VARIANT_C3 0xb
85 #define PN544_FW_CMD_RESET 0x01
86 #define PN544_FW_CMD_WRITE 0x08
87 #define PN544_FW_CMD_CHECK 0x06
88 #define PN544_FW_CMD_SECURE_WRITE 0x0C
89 #define PN544_FW_CMD_SECURE_CHUNK_WRITE 0x0D
91 struct pn544_i2c_fw_frame_write {
99 struct pn544_i2c_fw_frame_check {
107 struct pn544_i2c_fw_frame_response {
112 struct pn544_i2c_fw_blob {
118 struct pn544_i2c_fw_secure_frame {
124 struct pn544_i2c_fw_secure_blob {
129 #define PN544_FW_CMD_RESULT_TIMEOUT 0x01
130 #define PN544_FW_CMD_RESULT_BAD_CRC 0x02
131 #define PN544_FW_CMD_RESULT_ACCESS_DENIED 0x08
132 #define PN544_FW_CMD_RESULT_PROTOCOL_ERROR 0x0B
133 #define PN544_FW_CMD_RESULT_INVALID_PARAMETER 0x11
134 #define PN544_FW_CMD_RESULT_UNSUPPORTED_COMMAND 0x13
135 #define PN544_FW_CMD_RESULT_INVALID_LENGTH 0x18
136 #define PN544_FW_CMD_RESULT_CRYPTOGRAPHIC_ERROR 0x19
137 #define PN544_FW_CMD_RESULT_VERSION_CONDITIONS_ERROR 0x1D
138 #define PN544_FW_CMD_RESULT_MEMORY_ERROR 0x20
139 #define PN544_FW_CMD_RESULT_CHUNK_OK 0x21
140 #define PN544_FW_CMD_RESULT_WRITE_FAILED 0x74
141 #define PN544_FW_CMD_RESULT_COMMAND_REJECTED 0xE0
142 #define PN544_FW_CMD_RESULT_CHUNK_ERROR 0xE6
144 #define MIN(X, Y) ((X) < (Y) ? (X) : (Y))
146 #define PN544_FW_WRITE_BUFFER_MAX_LEN 0x9f7
147 #define PN544_FW_I2C_MAX_PAYLOAD PN544_HCI_I2C_LLC_MAX_SIZE
148 #define PN544_FW_I2C_WRITE_FRAME_HEADER_LEN 8
149 #define PN544_FW_I2C_WRITE_DATA_MAX_LEN MIN((PN544_FW_I2C_MAX_PAYLOAD -\
150 PN544_FW_I2C_WRITE_FRAME_HEADER_LEN),\
151 PN544_FW_WRITE_BUFFER_MAX_LEN)
152 #define PN544_FW_SECURE_CHUNK_WRITE_HEADER_LEN 3
153 #define PN544_FW_SECURE_CHUNK_WRITE_DATA_MAX_LEN (PN544_FW_I2C_MAX_PAYLOAD -\
154 PN544_FW_SECURE_CHUNK_WRITE_HEADER_LEN)
155 #define PN544_FW_SECURE_FRAME_HEADER_LEN 3
156 #define PN544_FW_SECURE_BLOB_HEADER_LEN 8
158 #define FW_WORK_STATE_IDLE 1
159 #define FW_WORK_STATE_START 2
160 #define FW_WORK_STATE_WAIT_WRITE_ANSWER 3
161 #define FW_WORK_STATE_WAIT_CHECK_ANSWER 4
162 #define FW_WORK_STATE_WAIT_SECURE_WRITE_ANSWER 5
164 struct pn544_i2c_phy {
165 struct i2c_client *i2c_dev;
166 struct nfc_hci_dev *hdev;
168 unsigned int gpio_en;
169 unsigned int gpio_fw;
170 unsigned int en_polarity;
174 struct work_struct fw_work;
176 char firmware_name[NFC_FIRMWARE_NAME_MAXSIZE + 1];
177 const struct firmware *fw;
178 u32 fw_blob_dest_addr;
180 const u8 *fw_blob_data;
190 * < 0 if hardware error occured (e.g. i2c err)
191 * and prevents normal operation.
195 #define I2C_DUMP_SKB(info, skb) \
197 pr_debug("%s:\n", info); \
198 print_hex_dump(KERN_DEBUG, "i2c: ", DUMP_PREFIX_OFFSET, \
199 16, 1, (skb)->data, (skb)->len, 0); \
202 static void pn544_hci_i2c_platform_init(struct pn544_i2c_phy *phy)
204 int polarity, retry, ret;
205 char rset_cmd[] = { 0x05, 0xF9, 0x04, 0x00, 0xC3, 0xE5 };
206 int count = sizeof(rset_cmd);
208 nfc_info(&phy->i2c_dev->dev, "Detecting nfc_en polarity\n");
210 /* Disable fw download */
211 gpio_set_value_cansleep(phy->gpio_fw, 0);
213 for (polarity = 0; polarity < 2; polarity++) {
214 phy->en_polarity = polarity;
218 gpio_set_value_cansleep(phy->gpio_en,
220 usleep_range(10000, 15000);
223 gpio_set_value_cansleep(phy->gpio_en, phy->en_polarity);
224 usleep_range(10000, 15000);
227 dev_dbg(&phy->i2c_dev->dev, "Sending reset cmd\n");
228 ret = i2c_master_send(phy->i2c_dev, rset_cmd, count);
230 nfc_info(&phy->i2c_dev->dev,
231 "nfc_en polarity : active %s\n",
232 (polarity == 0 ? "low" : "high"));
238 nfc_err(&phy->i2c_dev->dev,
239 "Could not detect nfc_en polarity, fallback to active high\n");
242 gpio_set_value_cansleep(phy->gpio_en, !phy->en_polarity);
243 usleep_range(10000, 15000);
246 static void pn544_hci_i2c_enable_mode(struct pn544_i2c_phy *phy, int run_mode)
248 gpio_set_value_cansleep(phy->gpio_fw,
249 run_mode == PN544_FW_MODE ? 1 : 0);
250 gpio_set_value_cansleep(phy->gpio_en, phy->en_polarity);
251 usleep_range(10000, 15000);
253 phy->run_mode = run_mode;
256 static int pn544_hci_i2c_enable(void *phy_id)
258 struct pn544_i2c_phy *phy = phy_id;
260 pr_info("%s\n", __func__);
262 pn544_hci_i2c_enable_mode(phy, PN544_HCI_MODE);
269 static void pn544_hci_i2c_disable(void *phy_id)
271 struct pn544_i2c_phy *phy = phy_id;
273 gpio_set_value_cansleep(phy->gpio_fw, 0);
274 gpio_set_value_cansleep(phy->gpio_en, !phy->en_polarity);
275 usleep_range(10000, 15000);
277 gpio_set_value_cansleep(phy->gpio_en, phy->en_polarity);
278 usleep_range(10000, 15000);
280 gpio_set_value_cansleep(phy->gpio_en, !phy->en_polarity);
281 usleep_range(10000, 15000);
286 static void pn544_hci_i2c_add_len_crc(struct sk_buff *skb)
292 *skb_push(skb, 1) = len;
294 crc = crc_ccitt(0xffff, skb->data, skb->len);
296 *skb_put(skb, 1) = crc & 0xff;
297 *skb_put(skb, 1) = crc >> 8;
300 static void pn544_hci_i2c_remove_len_crc(struct sk_buff *skb)
302 skb_pull(skb, PN544_I2C_FRAME_HEADROOM);
303 skb_trim(skb, PN544_I2C_FRAME_TAILROOM);
307 * Writing a frame must not return the number of written bytes.
308 * It must return either zero for success, or <0 for error.
309 * In addition, it must not alter the skb
311 static int pn544_hci_i2c_write(void *phy_id, struct sk_buff *skb)
314 struct pn544_i2c_phy *phy = phy_id;
315 struct i2c_client *client = phy->i2c_dev;
317 if (phy->hard_fault != 0)
318 return phy->hard_fault;
320 usleep_range(3000, 6000);
322 pn544_hci_i2c_add_len_crc(skb);
324 I2C_DUMP_SKB("i2c frame written", skb);
326 r = i2c_master_send(client, skb->data, skb->len);
328 if (r == -EREMOTEIO) { /* Retry, chip was in standby */
329 usleep_range(6000, 10000);
330 r = i2c_master_send(client, skb->data, skb->len);
340 pn544_hci_i2c_remove_len_crc(skb);
345 static int check_crc(u8 *buf, int buflen)
351 crc = crc_ccitt(0xffff, buf, len - 2);
354 if (buf[len - 2] != (crc & 0xff) || buf[len - 1] != (crc >> 8)) {
355 pr_err("CRC error 0x%x != 0x%x 0x%x\n",
356 crc, buf[len - 1], buf[len - 2]);
357 pr_info("%s: BAD CRC\n", __func__);
358 print_hex_dump(KERN_DEBUG, "crc: ", DUMP_PREFIX_NONE,
359 16, 2, buf, buflen, false);
366 * Reads an shdlc frame and returns it in a newly allocated sk_buff. Guarantees
367 * that i2c bus will be flushed and that next read will start on a new frame.
368 * returned skb contains only LLC header and payload.
370 * -EREMOTEIO : i2c read error (fatal)
371 * -EBADMSG : frame was incorrect and discarded
372 * -ENOMEM : cannot allocate skb, frame dropped
374 static int pn544_hci_i2c_read(struct pn544_i2c_phy *phy, struct sk_buff **skb)
378 u8 tmp[PN544_HCI_I2C_LLC_MAX_SIZE - 1];
379 struct i2c_client *client = phy->i2c_dev;
381 r = i2c_master_recv(client, &len, 1);
383 nfc_err(&client->dev, "cannot read len byte\n");
387 if ((len < (PN544_HCI_I2C_LLC_MIN_SIZE - 1)) ||
388 (len > (PN544_HCI_I2C_LLC_MAX_SIZE - 1))) {
389 nfc_err(&client->dev, "invalid len byte\n");
394 *skb = alloc_skb(1 + len, GFP_KERNEL);
400 *skb_put(*skb, 1) = len;
402 r = i2c_master_recv(client, skb_put(*skb, len), len);
408 I2C_DUMP_SKB("i2c frame read", *skb);
410 r = check_crc((*skb)->data, (*skb)->len);
418 skb_trim(*skb, (*skb)->len - 2);
420 usleep_range(3000, 6000);
425 if (i2c_master_recv(client, tmp, sizeof(tmp)) < 0)
428 usleep_range(3000, 6000);
433 static int pn544_hci_i2c_fw_read_status(struct pn544_i2c_phy *phy)
436 struct pn544_i2c_fw_frame_response response;
437 struct i2c_client *client = phy->i2c_dev;
439 r = i2c_master_recv(client, (char *) &response, sizeof(response));
440 if (r != sizeof(response)) {
441 nfc_err(&client->dev, "cannot read fw status\n");
445 usleep_range(3000, 6000);
447 switch (response.status) {
450 case PN544_FW_CMD_RESULT_CHUNK_OK:
451 return response.status;
452 case PN544_FW_CMD_RESULT_TIMEOUT:
454 case PN544_FW_CMD_RESULT_BAD_CRC:
456 case PN544_FW_CMD_RESULT_ACCESS_DENIED:
458 case PN544_FW_CMD_RESULT_PROTOCOL_ERROR:
460 case PN544_FW_CMD_RESULT_INVALID_PARAMETER:
462 case PN544_FW_CMD_RESULT_UNSUPPORTED_COMMAND:
464 case PN544_FW_CMD_RESULT_INVALID_LENGTH:
466 case PN544_FW_CMD_RESULT_CRYPTOGRAPHIC_ERROR:
468 case PN544_FW_CMD_RESULT_VERSION_CONDITIONS_ERROR:
470 case PN544_FW_CMD_RESULT_MEMORY_ERROR:
472 case PN544_FW_CMD_RESULT_COMMAND_REJECTED:
474 case PN544_FW_CMD_RESULT_WRITE_FAILED:
475 case PN544_FW_CMD_RESULT_CHUNK_ERROR:
483 * Reads an shdlc frame from the chip. This is not as straightforward as it
484 * seems. There are cases where we could loose the frame start synchronization.
485 * The frame format is len-data-crc, and corruption can occur anywhere while
486 * transiting on i2c bus, such that we could read an invalid len.
487 * In order to recover synchronization with the next frame, we must be sure
488 * to read the real amount of data without using the len byte. We do this by
489 * assuming the following:
490 * - the chip will always present only one single complete frame on the bus
491 * before triggering the interrupt
492 * - the chip will not present a new frame until we have completely read
493 * the previous one (or until we have handled the interrupt).
494 * The tricky case is when we read a corrupted len that is less than the real
495 * len. We must detect this here in order to determine that we need to flush
496 * the bus. This is the reason why we check the crc here.
498 static irqreturn_t pn544_hci_i2c_irq_thread_fn(int irq, void *phy_id)
500 struct pn544_i2c_phy *phy = phy_id;
501 struct i2c_client *client;
502 struct sk_buff *skb = NULL;
505 if (!phy || irq != phy->i2c_dev->irq) {
510 client = phy->i2c_dev;
511 dev_dbg(&client->dev, "IRQ\n");
513 if (phy->hard_fault != 0)
516 if (phy->run_mode == PN544_FW_MODE) {
517 phy->fw_cmd_result = pn544_hci_i2c_fw_read_status(phy);
518 schedule_work(&phy->fw_work);
520 r = pn544_hci_i2c_read(phy, &skb);
521 if (r == -EREMOTEIO) {
524 nfc_hci_recv_frame(phy->hdev, NULL);
527 } else if ((r == -ENOMEM) || (r == -EBADMSG)) {
531 nfc_hci_recv_frame(phy->hdev, skb);
536 static struct nfc_phy_ops i2c_phy_ops = {
537 .write = pn544_hci_i2c_write,
538 .enable = pn544_hci_i2c_enable,
539 .disable = pn544_hci_i2c_disable,
542 static int pn544_hci_i2c_fw_download(void *phy_id, const char *firmware_name,
545 struct pn544_i2c_phy *phy = phy_id;
547 pr_info("Starting Firmware Download (%s)\n", firmware_name);
549 strcpy(phy->firmware_name, firmware_name);
551 phy->hw_variant = hw_variant;
552 phy->fw_work_state = FW_WORK_STATE_START;
554 schedule_work(&phy->fw_work);
559 static void pn544_hci_i2c_fw_work_complete(struct pn544_i2c_phy *phy,
562 pr_info("Firmware Download Complete, result=%d\n", result);
564 pn544_hci_i2c_disable(phy);
566 phy->fw_work_state = FW_WORK_STATE_IDLE;
569 release_firmware(phy->fw);
573 nfc_fw_download_done(phy->hdev->ndev, phy->firmware_name, (u32) -result);
576 static int pn544_hci_i2c_fw_write_cmd(struct i2c_client *client, u32 dest_addr,
577 const u8 *data, u16 datalen)
579 u8 frame[PN544_FW_I2C_MAX_PAYLOAD];
580 struct pn544_i2c_fw_frame_write *framep;
585 if (datalen > PN544_FW_I2C_WRITE_DATA_MAX_LEN)
586 datalen = PN544_FW_I2C_WRITE_DATA_MAX_LEN;
588 framep = (struct pn544_i2c_fw_frame_write *) frame;
590 params_len = sizeof(framep->be_dest_addr) +
591 sizeof(framep->be_datalen) + datalen;
592 framelen = params_len + sizeof(framep->cmd) +
593 sizeof(framep->be_length);
595 framep->cmd = PN544_FW_CMD_WRITE;
597 put_unaligned_be16(params_len, &framep->be_length);
599 framep->be_dest_addr[0] = (dest_addr & 0xff0000) >> 16;
600 framep->be_dest_addr[1] = (dest_addr & 0xff00) >> 8;
601 framep->be_dest_addr[2] = dest_addr & 0xff;
603 put_unaligned_be16(datalen, &framep->be_datalen);
605 memcpy(framep->data, data, datalen);
607 r = i2c_master_send(client, frame, framelen);
617 static int pn544_hci_i2c_fw_check_cmd(struct i2c_client *client, u32 start_addr,
618 const u8 *data, u16 datalen)
620 struct pn544_i2c_fw_frame_check frame;
624 /* calculate local crc for the data we want to check */
625 crc = crc_ccitt(0xffff, data, datalen);
627 frame.cmd = PN544_FW_CMD_CHECK;
629 put_unaligned_be16(sizeof(frame.be_start_addr) +
630 sizeof(frame.be_datalen) + sizeof(frame.be_crc),
633 /* tell the chip the memory region to which our crc applies */
634 frame.be_start_addr[0] = (start_addr & 0xff0000) >> 16;
635 frame.be_start_addr[1] = (start_addr & 0xff00) >> 8;
636 frame.be_start_addr[2] = start_addr & 0xff;
638 put_unaligned_be16(datalen, &frame.be_datalen);
641 * and give our local crc. Chip will calculate its own crc for the
642 * region and compare with ours.
644 put_unaligned_be16(crc, &frame.be_crc);
646 r = i2c_master_send(client, (const char *) &frame, sizeof(frame));
648 if (r == sizeof(frame))
656 static int pn544_hci_i2c_fw_write_chunk(struct pn544_i2c_phy *phy)
660 r = pn544_hci_i2c_fw_write_cmd(phy->i2c_dev,
661 phy->fw_blob_dest_addr + phy->fw_written,
662 phy->fw_blob_data + phy->fw_written,
663 phy->fw_blob_size - phy->fw_written);
667 phy->fw_written += r;
668 phy->fw_work_state = FW_WORK_STATE_WAIT_WRITE_ANSWER;
673 static int pn544_hci_i2c_fw_secure_write_frame_cmd(struct pn544_i2c_phy *phy,
674 const u8 *data, u16 datalen)
676 u8 buf[PN544_FW_I2C_MAX_PAYLOAD];
677 struct pn544_i2c_fw_secure_frame *chunk;
681 if (datalen > PN544_FW_SECURE_CHUNK_WRITE_DATA_MAX_LEN)
682 datalen = PN544_FW_SECURE_CHUNK_WRITE_DATA_MAX_LEN;
684 chunk = (struct pn544_i2c_fw_secure_frame *) buf;
686 chunk->cmd = PN544_FW_CMD_SECURE_CHUNK_WRITE;
688 put_unaligned_be16(datalen, &chunk->be_datalen);
690 memcpy(chunk->data, data, datalen);
692 chunklen = sizeof(chunk->cmd) + sizeof(chunk->be_datalen) + datalen;
694 r = i2c_master_send(phy->i2c_dev, buf, chunklen);
705 static int pn544_hci_i2c_fw_secure_write_frame(struct pn544_i2c_phy *phy)
707 struct pn544_i2c_fw_secure_frame *framep;
710 framep = (struct pn544_i2c_fw_secure_frame *) phy->fw_blob_data;
711 if (phy->fw_written == 0)
712 phy->fw_blob_size = get_unaligned_be16(&framep->be_datalen)
713 + PN544_FW_SECURE_FRAME_HEADER_LEN;
715 /* Only secure write command can be chunked*/
716 if (phy->fw_blob_size > PN544_FW_I2C_MAX_PAYLOAD &&
717 framep->cmd != PN544_FW_CMD_SECURE_WRITE)
720 /* The firmware also have other commands, we just send them directly */
721 if (phy->fw_blob_size < PN544_FW_I2C_MAX_PAYLOAD) {
722 r = i2c_master_send(phy->i2c_dev,
723 (const char *) phy->fw_blob_data, phy->fw_blob_size);
725 if (r == phy->fw_blob_size)
733 r = pn544_hci_i2c_fw_secure_write_frame_cmd(phy,
734 phy->fw_blob_data + phy->fw_written,
735 phy->fw_blob_size - phy->fw_written);
740 phy->fw_written += r;
741 phy->fw_work_state = FW_WORK_STATE_WAIT_SECURE_WRITE_ANSWER;
743 /* SW reset command will not trig any response from PN544 */
744 if (framep->cmd == PN544_FW_CMD_RESET) {
745 pn544_hci_i2c_enable_mode(phy, PN544_FW_MODE);
746 phy->fw_cmd_result = 0;
747 schedule_work(&phy->fw_work);
753 static void pn544_hci_i2c_fw_work(struct work_struct *work)
755 struct pn544_i2c_phy *phy = container_of(work, struct pn544_i2c_phy,
758 struct pn544_i2c_fw_blob *blob;
759 struct pn544_i2c_fw_secure_blob *secure_blob;
761 switch (phy->fw_work_state) {
762 case FW_WORK_STATE_START:
763 pn544_hci_i2c_enable_mode(phy, PN544_FW_MODE);
765 r = reject_firmware(&phy->fw, phy->firmware_name,
768 goto exit_state_start;
772 switch (phy->hw_variant) {
773 case PN544_HW_VARIANT_C2:
774 blob = (struct pn544_i2c_fw_blob *) phy->fw->data;
775 phy->fw_blob_size = get_unaligned_be32(&blob->be_size);
776 phy->fw_blob_dest_addr = get_unaligned_be32(
778 phy->fw_blob_data = blob->data;
780 r = pn544_hci_i2c_fw_write_chunk(phy);
782 case PN544_HW_VARIANT_C3:
783 secure_blob = (struct pn544_i2c_fw_secure_blob *)
785 phy->fw_blob_data = secure_blob->data;
786 phy->fw_size = phy->fw->size;
787 r = pn544_hci_i2c_fw_secure_write_frame(phy);
796 pn544_hci_i2c_fw_work_complete(phy, r);
799 case FW_WORK_STATE_WAIT_WRITE_ANSWER:
800 r = phy->fw_cmd_result;
802 goto exit_state_wait_write_answer;
804 if (phy->fw_written == phy->fw_blob_size) {
805 r = pn544_hci_i2c_fw_check_cmd(phy->i2c_dev,
806 phy->fw_blob_dest_addr,
810 goto exit_state_wait_write_answer;
811 phy->fw_work_state = FW_WORK_STATE_WAIT_CHECK_ANSWER;
815 r = pn544_hci_i2c_fw_write_chunk(phy);
817 exit_state_wait_write_answer:
819 pn544_hci_i2c_fw_work_complete(phy, r);
822 case FW_WORK_STATE_WAIT_CHECK_ANSWER:
823 r = phy->fw_cmd_result;
825 goto exit_state_wait_check_answer;
827 blob = (struct pn544_i2c_fw_blob *) (phy->fw_blob_data +
829 phy->fw_blob_size = get_unaligned_be32(&blob->be_size);
830 if (phy->fw_blob_size != 0) {
831 phy->fw_blob_dest_addr =
832 get_unaligned_be32(&blob->be_destaddr);
833 phy->fw_blob_data = blob->data;
836 r = pn544_hci_i2c_fw_write_chunk(phy);
839 exit_state_wait_check_answer:
840 if (r < 0 || phy->fw_blob_size == 0)
841 pn544_hci_i2c_fw_work_complete(phy, r);
844 case FW_WORK_STATE_WAIT_SECURE_WRITE_ANSWER:
845 r = phy->fw_cmd_result;
847 goto exit_state_wait_secure_write_answer;
849 if (r == PN544_FW_CMD_RESULT_CHUNK_OK) {
850 r = pn544_hci_i2c_fw_secure_write_frame(phy);
851 goto exit_state_wait_secure_write_answer;
854 if (phy->fw_written == phy->fw_blob_size) {
855 secure_blob = (struct pn544_i2c_fw_secure_blob *)
856 (phy->fw_blob_data + phy->fw_blob_size);
857 phy->fw_size -= phy->fw_blob_size +
858 PN544_FW_SECURE_BLOB_HEADER_LEN;
859 if (phy->fw_size >= PN544_FW_SECURE_BLOB_HEADER_LEN
860 + PN544_FW_SECURE_FRAME_HEADER_LEN) {
861 phy->fw_blob_data = secure_blob->data;
864 r = pn544_hci_i2c_fw_secure_write_frame(phy);
868 exit_state_wait_secure_write_answer:
869 if (r < 0 || phy->fw_size == 0)
870 pn544_hci_i2c_fw_work_complete(phy, r);
878 static int pn544_hci_i2c_acpi_request_resources(struct i2c_client *client)
880 struct pn544_i2c_phy *phy = i2c_get_clientdata(client);
881 struct gpio_desc *gpiod_en, *gpiod_fw;
882 struct device *dev = &client->dev;
884 /* Get EN GPIO from ACPI */
885 gpiod_en = devm_gpiod_get_index(dev, PN544_GPIO_NAME_EN, 1,
887 if (IS_ERR(gpiod_en)) {
888 nfc_err(dev, "Unable to get EN GPIO\n");
892 phy->gpio_en = desc_to_gpio(gpiod_en);
894 /* Get FW GPIO from ACPI */
895 gpiod_fw = devm_gpiod_get_index(dev, PN544_GPIO_NAME_FW, 2,
897 if (IS_ERR(gpiod_fw)) {
898 nfc_err(dev, "Unable to get FW GPIO\n");
902 phy->gpio_fw = desc_to_gpio(gpiod_fw);
907 static int pn544_hci_i2c_of_request_resources(struct i2c_client *client)
909 struct pn544_i2c_phy *phy = i2c_get_clientdata(client);
910 struct device_node *pp;
913 pp = client->dev.of_node;
919 /* Obtention of EN GPIO from device tree */
920 ret = of_get_named_gpio(pp, "enable-gpios", 0);
922 if (ret != -EPROBE_DEFER)
923 nfc_err(&client->dev,
924 "Failed to get EN gpio, error: %d\n", ret);
929 /* Configuration of EN GPIO */
930 ret = gpio_request(phy->gpio_en, PN544_GPIO_NAME_EN);
932 nfc_err(&client->dev, "Fail EN pin\n");
935 ret = gpio_direction_output(phy->gpio_en, 0);
937 nfc_err(&client->dev, "Fail EN pin direction\n");
941 /* Obtention of FW GPIO from device tree */
942 ret = of_get_named_gpio(pp, "firmware-gpios", 0);
944 if (ret != -EPROBE_DEFER)
945 nfc_err(&client->dev,
946 "Failed to get FW gpio, error: %d\n", ret);
951 /* Configuration of FW GPIO */
952 ret = gpio_request(phy->gpio_fw, PN544_GPIO_NAME_FW);
954 nfc_err(&client->dev, "Fail FW pin\n");
957 ret = gpio_direction_output(phy->gpio_fw, 0);
959 nfc_err(&client->dev, "Fail FW pin direction\n");
966 gpio_free(phy->gpio_fw);
968 gpio_free(phy->gpio_en);
973 static int pn544_hci_i2c_probe(struct i2c_client *client,
974 const struct i2c_device_id *id)
976 struct pn544_i2c_phy *phy;
977 struct pn544_nfc_platform_data *pdata;
980 dev_dbg(&client->dev, "%s\n", __func__);
981 dev_dbg(&client->dev, "IRQ: %d\n", client->irq);
983 if (!i2c_check_functionality(client->adapter, I2C_FUNC_I2C)) {
984 nfc_err(&client->dev, "Need I2C_FUNC_I2C\n");
988 phy = devm_kzalloc(&client->dev, sizeof(struct pn544_i2c_phy),
993 INIT_WORK(&phy->fw_work, pn544_hci_i2c_fw_work);
994 phy->fw_work_state = FW_WORK_STATE_IDLE;
996 phy->i2c_dev = client;
997 i2c_set_clientdata(client, phy);
999 pdata = client->dev.platform_data;
1001 /* No platform data, using device tree. */
1002 if (!pdata && client->dev.of_node) {
1003 r = pn544_hci_i2c_of_request_resources(client);
1005 nfc_err(&client->dev, "No DT data\n");
1008 /* Using platform data. */
1011 if (pdata->request_resources == NULL) {
1012 nfc_err(&client->dev, "request_resources() missing\n");
1016 r = pdata->request_resources(client);
1018 nfc_err(&client->dev,
1019 "Cannot get platform resources\n");
1023 phy->gpio_en = pdata->get_gpio(NFC_GPIO_ENABLE);
1024 phy->gpio_fw = pdata->get_gpio(NFC_GPIO_FW_RESET);
1026 } else if (ACPI_HANDLE(&client->dev)) {
1027 r = pn544_hci_i2c_acpi_request_resources(client);
1029 nfc_err(&client->dev,
1030 "Cannot get ACPI data\n");
1034 nfc_err(&client->dev, "No platform data\n");
1038 pn544_hci_i2c_platform_init(phy);
1040 r = request_threaded_irq(client->irq, NULL, pn544_hci_i2c_irq_thread_fn,
1041 IRQF_TRIGGER_RISING | IRQF_ONESHOT,
1042 PN544_HCI_I2C_DRIVER_NAME, phy);
1044 nfc_err(&client->dev, "Unable to register IRQ handler\n");
1048 r = pn544_hci_probe(phy, &i2c_phy_ops, LLC_SHDLC_NAME,
1049 PN544_I2C_FRAME_HEADROOM, PN544_I2C_FRAME_TAILROOM,
1050 PN544_HCI_I2C_LLC_MAX_PAYLOAD,
1051 pn544_hci_i2c_fw_download, &phy->hdev);
1058 free_irq(client->irq, phy);
1062 gpio_free(phy->gpio_en);
1063 gpio_free(phy->gpio_fw);
1064 } else if (pdata->free_resources) {
1065 pdata->free_resources();
1071 static int pn544_hci_i2c_remove(struct i2c_client *client)
1073 struct pn544_i2c_phy *phy = i2c_get_clientdata(client);
1074 struct pn544_nfc_platform_data *pdata = client->dev.platform_data;
1076 dev_dbg(&client->dev, "%s\n", __func__);
1078 cancel_work_sync(&phy->fw_work);
1079 if (phy->fw_work_state != FW_WORK_STATE_IDLE)
1080 pn544_hci_i2c_fw_work_complete(phy, -ENODEV);
1082 pn544_hci_remove(phy->hdev);
1085 pn544_hci_i2c_disable(phy);
1087 free_irq(client->irq, phy);
1089 /* No platform data, GPIOs have been requested by this driver */
1091 gpio_free(phy->gpio_en);
1092 gpio_free(phy->gpio_fw);
1093 /* Using platform data */
1094 } else if (pdata->free_resources) {
1095 pdata->free_resources();
1101 static const struct of_device_id of_pn544_i2c_match[] = {
1102 { .compatible = "nxp,pn544-i2c", },
1105 MODULE_DEVICE_TABLE(of, of_pn544_i2c_match);
1107 static struct i2c_driver pn544_hci_i2c_driver = {
1109 .name = PN544_HCI_I2C_DRIVER_NAME,
1110 .of_match_table = of_match_ptr(of_pn544_i2c_match),
1111 .acpi_match_table = ACPI_PTR(pn544_hci_i2c_acpi_match),
1113 .probe = pn544_hci_i2c_probe,
1114 .id_table = pn544_hci_i2c_id_table,
1115 .remove = pn544_hci_i2c_remove,
1118 module_i2c_driver(pn544_hci_i2c_driver);
1120 MODULE_LICENSE("GPL");
1121 MODULE_DESCRIPTION(DRIVER_DESC);