1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* -------------------------------------------------------------------------
3 * Copyright (C) 2014-2016, Intel Corporation
5 * -------------------------------------------------------------------------
8 #include <linux/module.h>
10 #include <linux/i2c.h>
11 #include <linux/delay.h>
12 #include <linux/firmware.h>
13 #include <net/nfc/nci_core.h>
17 #define FDP_OTP_PATCH_NAME "otp.bin"
18 #define FDP_RAM_PATCH_NAME "ram.bin"
19 #define FDP_FW_HEADER_SIZE 576
20 #define FDP_FW_UPDATE_SLEEP 1000
22 #define NCI_GET_VERSION_TIMEOUT 8000
23 #define NCI_PATCH_REQUEST_TIMEOUT 8000
24 #define FDP_PATCH_CONN_DEST 0xC2
25 #define FDP_PATCH_CONN_PARAM_TYPE 0xA0
27 #define NCI_PATCH_TYPE_RAM 0x00
28 #define NCI_PATCH_TYPE_OTP 0x01
29 #define NCI_PATCH_TYPE_EOT 0xFF
31 #define NCI_PARAM_ID_FW_RAM_VERSION 0xA0
32 #define NCI_PARAM_ID_FW_OTP_VERSION 0xA1
33 #define NCI_PARAM_ID_OTP_LIMITED_VERSION 0xC5
34 #define NCI_PARAM_ID_KEY_INDEX_ID 0xC6
36 #define NCI_GID_PROP 0x0F
37 #define NCI_OP_PROP_PATCH_OID 0x08
38 #define NCI_OP_PROP_SET_PDATA_OID 0x23
41 const struct nfc_phy_ops *phy_ops;
42 struct fdp_i2c_phy *phy;
45 const struct firmware *otp_patch;
46 const struct firmware *ram_patch;
47 u32 otp_patch_version;
48 u32 ram_patch_version;
52 u32 limited_otp_version;
59 atomic_t data_pkt_counter;
60 void (*data_pkt_counter_cb)(struct nci_dev *ndev);
63 u8 setup_patch_status;
65 wait_queue_head_t setup_wq;
68 static const u8 nci_core_get_config_otp_ram_version[5] = {
70 NCI_PARAM_ID_FW_RAM_VERSION,
71 NCI_PARAM_ID_FW_OTP_VERSION,
72 NCI_PARAM_ID_OTP_LIMITED_VERSION,
73 NCI_PARAM_ID_KEY_INDEX_ID
76 struct nci_core_get_config_rsp {
82 static int fdp_nci_create_conn(struct nci_dev *ndev)
84 struct fdp_nci_info *info = nci_get_drvdata(ndev);
85 struct core_conn_create_dest_spec_params param;
88 /* proprietary destination specific paramerer without value */
89 param.type = FDP_PATCH_CONN_PARAM_TYPE;
92 r = nci_core_conn_create(info->ndev, FDP_PATCH_CONN_DEST, 1,
93 sizeof(param), ¶m);
97 return nci_get_conn_info_by_dest_type_params(ndev,
98 FDP_PATCH_CONN_DEST, NULL);
101 static inline int fdp_nci_get_versions(struct nci_dev *ndev)
103 return nci_core_cmd(ndev, NCI_OP_CORE_GET_CONFIG_CMD,
104 sizeof(nci_core_get_config_otp_ram_version),
105 (__u8 *) &nci_core_get_config_otp_ram_version);
108 static inline int fdp_nci_patch_cmd(struct nci_dev *ndev, u8 type)
110 return nci_prop_cmd(ndev, NCI_OP_PROP_PATCH_OID, sizeof(type), &type);
113 static inline int fdp_nci_set_production_data(struct nci_dev *ndev, u8 len,
116 return nci_prop_cmd(ndev, NCI_OP_PROP_SET_PDATA_OID, len, data);
119 static int fdp_nci_set_clock(struct nci_dev *ndev, u8 clock_type,
126 nd = (24 * fc) / clock_freq;
127 delta = 24 * fc - nd * clock_freq;
128 num = (32768 * delta) / clock_freq;
136 data[5] = num & 0xFF;
137 data[6] = (num >> 8) & 0xff;
139 data[8] = clock_type;
141 return fdp_nci_set_production_data(ndev, 9, data);
144 static void fdp_nci_send_patch_cb(struct nci_dev *ndev)
146 struct fdp_nci_info *info = nci_get_drvdata(ndev);
148 info->setup_patch_sent = 1;
149 wake_up(&info->setup_wq);
153 * Register a packet sent counter and a callback
155 * We have no other way of knowing when all firmware packets were sent out
156 * on the i2c bus. We need to know that in order to close the connection and
157 * send the patch end message.
159 static void fdp_nci_set_data_pkt_counter(struct nci_dev *ndev,
160 void (*cb)(struct nci_dev *ndev), int count)
162 struct fdp_nci_info *info = nci_get_drvdata(ndev);
163 struct device *dev = &info->phy->i2c_dev->dev;
165 dev_dbg(dev, "NCI data pkt counter %d\n", count);
166 atomic_set(&info->data_pkt_counter, count);
167 info->data_pkt_counter_cb = cb;
171 * The device is expecting a stream of packets. All packets need to
172 * have the PBF flag set to 0x0 (last packet) even if the firmware
173 * file is segmented and there are multiple packets. If we give the
174 * whole firmware to nci_send_data it will segment it and it will set
175 * the PBF flag to 0x01 so we need to do the segmentation here.
177 * The firmware will be analyzed and applied when we send NCI_OP_PROP_PATCH_CMD
178 * command with NCI_PATCH_TYPE_EOT parameter. The device will send a
179 * NFCC_PATCH_NTF packet and a NCI_OP_CORE_RESET_NTF packet.
181 static int fdp_nci_send_patch(struct nci_dev *ndev, u8 conn_id, u8 type)
183 struct fdp_nci_info *info = nci_get_drvdata(ndev);
184 const struct firmware *fw;
187 int max_size, payload_size;
190 if ((type == NCI_PATCH_TYPE_OTP && !info->otp_patch) ||
191 (type == NCI_PATCH_TYPE_RAM && !info->ram_patch))
194 if (type == NCI_PATCH_TYPE_OTP)
195 fw = info->otp_patch;
197 fw = info->ram_patch;
199 max_size = nci_conn_max_data_pkt_payload_size(ndev, conn_id);
205 fdp_nci_set_data_pkt_counter(ndev, fdp_nci_send_patch_cb,
206 DIV_ROUND_UP(fw->size, max_size));
210 payload_size = min_t(unsigned long, max_size, len);
212 skb = nci_skb_alloc(ndev, (NCI_CTRL_HDR_SIZE + payload_size),
215 fdp_nci_set_data_pkt_counter(ndev, NULL, 0);
220 skb_reserve(skb, NCI_CTRL_HDR_SIZE);
222 skb_put_data(skb, fw->data + (fw->size - len), payload_size);
224 rc = nci_send_data(ndev, conn_id, skb);
227 fdp_nci_set_data_pkt_counter(ndev, NULL, 0);
237 static int fdp_nci_open(struct nci_dev *ndev)
239 const struct fdp_nci_info *info = nci_get_drvdata(ndev);
241 return info->phy_ops->enable(info->phy);
244 static int fdp_nci_close(struct nci_dev *ndev)
249 static int fdp_nci_send(struct nci_dev *ndev, struct sk_buff *skb)
251 struct fdp_nci_info *info = nci_get_drvdata(ndev);
254 if (atomic_dec_and_test(&info->data_pkt_counter))
255 info->data_pkt_counter_cb(ndev);
257 ret = info->phy_ops->write(info->phy, skb);
267 static int fdp_nci_request_firmware(struct nci_dev *ndev)
269 struct fdp_nci_info *info = nci_get_drvdata(ndev);
270 struct device *dev = &info->phy->i2c_dev->dev;
274 r = request_firmware(&info->ram_patch, FDP_RAM_PATCH_NAME, dev);
276 nfc_err(dev, "RAM patch request error\n");
280 data = info->ram_patch->data;
281 info->ram_patch_version =
282 data[FDP_FW_HEADER_SIZE] |
283 (data[FDP_FW_HEADER_SIZE + 1] << 8) |
284 (data[FDP_FW_HEADER_SIZE + 2] << 16) |
285 (data[FDP_FW_HEADER_SIZE + 3] << 24);
287 dev_dbg(dev, "RAM patch version: %d, size: %zu\n",
288 info->ram_patch_version, info->ram_patch->size);
291 r = request_firmware(&info->otp_patch, FDP_OTP_PATCH_NAME, dev);
293 nfc_err(dev, "OTP patch request error\n");
297 data = (u8 *) info->otp_patch->data;
298 info->otp_patch_version =
299 data[FDP_FW_HEADER_SIZE] |
300 (data[FDP_FW_HEADER_SIZE + 1] << 8) |
301 (data[FDP_FW_HEADER_SIZE+2] << 16) |
302 (data[FDP_FW_HEADER_SIZE+3] << 24);
304 dev_dbg(dev, "OTP patch version: %d, size: %zu\n",
305 info->otp_patch_version, info->otp_patch->size);
309 static void fdp_nci_release_firmware(struct nci_dev *ndev)
311 struct fdp_nci_info *info = nci_get_drvdata(ndev);
313 if (info->otp_patch) {
314 release_firmware(info->otp_patch);
315 info->otp_patch = NULL;
318 if (info->ram_patch) {
319 release_firmware(info->ram_patch);
320 info->ram_patch = NULL;
324 static int fdp_nci_patch_otp(struct nci_dev *ndev)
326 struct fdp_nci_info *info = nci_get_drvdata(ndev);
327 struct device *dev = &info->phy->i2c_dev->dev;
331 if (info->otp_version >= info->otp_patch_version)
334 info->setup_patch_sent = 0;
335 info->setup_reset_ntf = 0;
336 info->setup_patch_ntf = 0;
338 /* Patch init request */
339 r = fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_OTP);
343 /* Patch data connection creation */
344 conn_id = fdp_nci_create_conn(ndev);
348 /* Send the patch over the data connection */
349 r = fdp_nci_send_patch(ndev, conn_id, NCI_PATCH_TYPE_OTP);
353 /* Wait for all the packets to be send over i2c */
354 wait_event_interruptible(info->setup_wq,
355 info->setup_patch_sent == 1);
357 /* make sure that the NFCC processed the last data packet */
358 msleep(FDP_FW_UPDATE_SLEEP);
360 /* Close the data connection */
361 r = nci_core_conn_close(info->ndev, conn_id);
365 /* Patch finish message */
366 if (fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_EOT)) {
367 nfc_err(dev, "OTP patch error 0x%x\n", r);
371 /* If the patch notification didn't arrive yet, wait for it */
372 wait_event_interruptible(info->setup_wq, info->setup_patch_ntf);
374 /* Check if the patching was successful */
375 r = info->setup_patch_status;
377 nfc_err(dev, "OTP patch error 0x%x\n", r);
382 * We need to wait for the reset notification before we
385 wait_event_interruptible(info->setup_wq, info->setup_reset_ntf);
390 static int fdp_nci_patch_ram(struct nci_dev *ndev)
392 struct fdp_nci_info *info = nci_get_drvdata(ndev);
393 struct device *dev = &info->phy->i2c_dev->dev;
397 if (info->ram_version >= info->ram_patch_version)
400 info->setup_patch_sent = 0;
401 info->setup_reset_ntf = 0;
402 info->setup_patch_ntf = 0;
404 /* Patch init request */
405 r = fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_RAM);
409 /* Patch data connection creation */
410 conn_id = fdp_nci_create_conn(ndev);
414 /* Send the patch over the data connection */
415 r = fdp_nci_send_patch(ndev, conn_id, NCI_PATCH_TYPE_RAM);
419 /* Wait for all the packets to be send over i2c */
420 wait_event_interruptible(info->setup_wq,
421 info->setup_patch_sent == 1);
423 /* make sure that the NFCC processed the last data packet */
424 msleep(FDP_FW_UPDATE_SLEEP);
426 /* Close the data connection */
427 r = nci_core_conn_close(info->ndev, conn_id);
431 /* Patch finish message */
432 if (fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_EOT)) {
433 nfc_err(dev, "RAM patch error 0x%x\n", r);
437 /* If the patch notification didn't arrive yet, wait for it */
438 wait_event_interruptible(info->setup_wq, info->setup_patch_ntf);
440 /* Check if the patching was successful */
441 r = info->setup_patch_status;
443 nfc_err(dev, "RAM patch error 0x%x\n", r);
448 * We need to wait for the reset notification before we
451 wait_event_interruptible(info->setup_wq, info->setup_reset_ntf);
456 static int fdp_nci_setup(struct nci_dev *ndev)
458 /* Format: total length followed by an NCI packet */
459 struct fdp_nci_info *info = nci_get_drvdata(ndev);
460 struct device *dev = &info->phy->i2c_dev->dev;
464 r = nci_core_init(ndev);
468 /* Get RAM and OTP version */
469 r = fdp_nci_get_versions(ndev);
473 /* Load firmware from disk */
474 r = fdp_nci_request_firmware(ndev);
479 if (info->otp_version < info->otp_patch_version) {
480 r = fdp_nci_patch_otp(ndev);
487 if (info->ram_version < info->ram_patch_version) {
488 r = fdp_nci_patch_ram(ndev);
494 /* Release the firmware buffers */
495 fdp_nci_release_firmware(ndev);
497 /* If a patch was applied the new version is checked */
499 r = nci_core_init(ndev);
503 r = fdp_nci_get_versions(ndev);
507 if (info->otp_version != info->otp_patch_version ||
508 info->ram_version != info->ram_patch_version) {
509 nfc_err(dev, "Firmware update failed");
516 * We initialized the devices but the NFC subsystem expects
517 * it to not be initialized.
519 return nci_core_reset(ndev);
522 fdp_nci_release_firmware(ndev);
523 nfc_err(dev, "Setup error %d\n", r);
527 static int fdp_nci_post_setup(struct nci_dev *ndev)
529 struct fdp_nci_info *info = nci_get_drvdata(ndev);
530 struct device *dev = &info->phy->i2c_dev->dev;
533 /* Check if the device has VSC */
534 if (info->fw_vsc_cfg && info->fw_vsc_cfg[0]) {
536 /* Set the vendor specific configuration */
537 r = fdp_nci_set_production_data(ndev, info->fw_vsc_cfg[3],
538 &info->fw_vsc_cfg[4]);
540 nfc_err(dev, "Vendor specific config set error %d\n",
546 /* Set clock type and frequency */
547 r = fdp_nci_set_clock(ndev, info->clock_type, info->clock_freq);
549 nfc_err(dev, "Clock set error %d\n", r);
554 * In order to apply the VSC FDP needs a reset
556 r = nci_core_reset(ndev);
561 * The nci core was initialized when post setup was called
562 * so we leave it like that
564 return nci_core_init(ndev);
567 static int fdp_nci_core_reset_ntf_packet(struct nci_dev *ndev,
570 struct fdp_nci_info *info = nci_get_drvdata(ndev);
572 info->setup_reset_ntf = 1;
573 wake_up(&info->setup_wq);
578 static int fdp_nci_prop_patch_ntf_packet(struct nci_dev *ndev,
581 struct fdp_nci_info *info = nci_get_drvdata(ndev);
583 info->setup_patch_ntf = 1;
584 info->setup_patch_status = skb->data[0];
585 wake_up(&info->setup_wq);
590 static int fdp_nci_prop_patch_rsp_packet(struct nci_dev *ndev,
593 struct fdp_nci_info *info = nci_get_drvdata(ndev);
594 struct device *dev = &info->phy->i2c_dev->dev;
595 u8 status = skb->data[0];
597 dev_dbg(dev, "%s: status 0x%x\n", __func__, status);
598 nci_req_complete(ndev, status);
603 static int fdp_nci_prop_set_production_data_rsp_packet(struct nci_dev *ndev,
606 struct fdp_nci_info *info = nci_get_drvdata(ndev);
607 struct device *dev = &info->phy->i2c_dev->dev;
608 u8 status = skb->data[0];
610 dev_dbg(dev, "%s: status 0x%x\n", __func__, status);
611 nci_req_complete(ndev, status);
616 static int fdp_nci_core_get_config_rsp_packet(struct nci_dev *ndev,
619 struct fdp_nci_info *info = nci_get_drvdata(ndev);
620 struct device *dev = &info->phy->i2c_dev->dev;
621 const struct nci_core_get_config_rsp *rsp = (void *) skb->data;
625 if (rsp->status == NCI_STATUS_OK) {
628 for (i = 0; i < 4; i++) {
631 case NCI_PARAM_ID_FW_RAM_VERSION:
633 info->ram_version = le32_to_cpup((__le32 *) p);
636 case NCI_PARAM_ID_FW_OTP_VERSION:
638 info->otp_version = le32_to_cpup((__le32 *) p);
641 case NCI_PARAM_ID_OTP_LIMITED_VERSION:
643 info->otp_version = le32_to_cpup((__le32 *) p);
646 case NCI_PARAM_ID_KEY_INDEX_ID:
648 info->key_index = *p++;
653 dev_dbg(dev, "OTP version %d\n", info->otp_version);
654 dev_dbg(dev, "RAM version %d\n", info->ram_version);
655 dev_dbg(dev, "key index %d\n", info->key_index);
656 dev_dbg(dev, "%s: status 0x%x\n", __func__, rsp->status);
658 nci_req_complete(ndev, rsp->status);
663 static const struct nci_driver_ops fdp_core_ops[] = {
665 .opcode = NCI_OP_CORE_GET_CONFIG_RSP,
666 .rsp = fdp_nci_core_get_config_rsp_packet,
669 .opcode = NCI_OP_CORE_RESET_NTF,
670 .ntf = fdp_nci_core_reset_ntf_packet,
674 static const struct nci_driver_ops fdp_prop_ops[] = {
676 .opcode = nci_opcode_pack(NCI_GID_PROP, NCI_OP_PROP_PATCH_OID),
677 .rsp = fdp_nci_prop_patch_rsp_packet,
678 .ntf = fdp_nci_prop_patch_ntf_packet,
681 .opcode = nci_opcode_pack(NCI_GID_PROP,
682 NCI_OP_PROP_SET_PDATA_OID),
683 .rsp = fdp_nci_prop_set_production_data_rsp_packet,
687 static const struct nci_ops nci_ops = {
688 .open = fdp_nci_open,
689 .close = fdp_nci_close,
690 .send = fdp_nci_send,
691 .setup = fdp_nci_setup,
692 .post_setup = fdp_nci_post_setup,
693 .prop_ops = fdp_prop_ops,
694 .n_prop_ops = ARRAY_SIZE(fdp_prop_ops),
695 .core_ops = fdp_core_ops,
696 .n_core_ops = ARRAY_SIZE(fdp_core_ops),
699 int fdp_nci_probe(struct fdp_i2c_phy *phy, const struct nfc_phy_ops *phy_ops,
700 struct nci_dev **ndevp, int tx_headroom,
701 int tx_tailroom, u8 clock_type, u32 clock_freq,
702 const u8 *fw_vsc_cfg)
704 struct device *dev = &phy->i2c_dev->dev;
705 struct fdp_nci_info *info;
706 struct nci_dev *ndev;
710 info = devm_kzalloc(dev, sizeof(struct fdp_nci_info), GFP_KERNEL);
715 info->phy_ops = phy_ops;
716 info->clock_type = clock_type;
717 info->clock_freq = clock_freq;
718 info->fw_vsc_cfg = fw_vsc_cfg;
720 init_waitqueue_head(&info->setup_wq);
722 protocols = NFC_PROTO_JEWEL_MASK |
723 NFC_PROTO_MIFARE_MASK |
724 NFC_PROTO_FELICA_MASK |
725 NFC_PROTO_ISO14443_MASK |
726 NFC_PROTO_ISO14443_B_MASK |
727 NFC_PROTO_NFC_DEP_MASK |
728 NFC_PROTO_ISO15693_MASK;
730 BUILD_BUG_ON(ARRAY_SIZE(fdp_prop_ops) > NCI_MAX_PROPRIETARY_CMD);
731 ndev = nci_allocate_device(&nci_ops, protocols, tx_headroom,
734 nfc_err(dev, "Cannot allocate nfc ndev\n");
738 r = nci_register_device(ndev);
745 nci_set_drvdata(ndev, info);
750 nci_free_device(ndev);
753 EXPORT_SYMBOL(fdp_nci_probe);
755 void fdp_nci_remove(struct nci_dev *ndev)
757 nci_unregister_device(ndev);
758 nci_free_device(ndev);
760 EXPORT_SYMBOL(fdp_nci_remove);
762 MODULE_LICENSE("GPL");
763 MODULE_DESCRIPTION("NFC NCI driver for Intel Fields Peak NFC controller");
764 MODULE_AUTHOR("Robert Dolca <robert.dolca@intel.com>");
766 MODULE_FIRMWARE(FDP_OTP_PATCH_NAME);
767 MODULE_FIRMWARE(FDP_RAM_PATCH_NAME);