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 "/*(DEBLOBBED)*/"
18 #define FDP_RAM_PATCH_NAME "/*(DEBLOBBED)*/"
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 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 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 packaet 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)
240 struct fdp_nci_info *info = nci_get_drvdata(ndev);
242 r = info->phy_ops->enable(info->phy);
247 static int fdp_nci_close(struct nci_dev *ndev)
252 static int fdp_nci_send(struct nci_dev *ndev, struct sk_buff *skb)
254 struct fdp_nci_info *info = nci_get_drvdata(ndev);
257 if (atomic_dec_and_test(&info->data_pkt_counter))
258 info->data_pkt_counter_cb(ndev);
260 ret = info->phy_ops->write(info->phy, skb);
270 static int fdp_nci_request_firmware(struct nci_dev *ndev)
272 struct fdp_nci_info *info = nci_get_drvdata(ndev);
273 struct device *dev = &info->phy->i2c_dev->dev;
277 r = reject_firmware(&info->ram_patch, FDP_RAM_PATCH_NAME, dev);
279 nfc_err(dev, "RAM patch request error\n");
283 data = (u8 *) info->ram_patch->data;
284 info->ram_patch_version =
285 data[FDP_FW_HEADER_SIZE] |
286 (data[FDP_FW_HEADER_SIZE + 1] << 8) |
287 (data[FDP_FW_HEADER_SIZE + 2] << 16) |
288 (data[FDP_FW_HEADER_SIZE + 3] << 24);
290 dev_dbg(dev, "RAM patch version: %d, size: %d\n",
291 info->ram_patch_version, (int) info->ram_patch->size);
294 r = reject_firmware(&info->otp_patch, FDP_OTP_PATCH_NAME, dev);
296 nfc_err(dev, "OTP patch request error\n");
300 data = (u8 *) info->otp_patch->data;
301 info->otp_patch_version =
302 data[FDP_FW_HEADER_SIZE] |
303 (data[FDP_FW_HEADER_SIZE + 1] << 8) |
304 (data[FDP_FW_HEADER_SIZE+2] << 16) |
305 (data[FDP_FW_HEADER_SIZE+3] << 24);
307 dev_dbg(dev, "OTP patch version: %d, size: %d\n",
308 info->otp_patch_version, (int) info->otp_patch->size);
315 static void fdp_nci_release_firmware(struct nci_dev *ndev)
317 struct fdp_nci_info *info = nci_get_drvdata(ndev);
319 if (info->otp_patch) {
320 release_firmware(info->otp_patch);
321 info->otp_patch = NULL;
324 if (info->ram_patch) {
325 release_firmware(info->ram_patch);
326 info->ram_patch = NULL;
330 static int fdp_nci_patch_otp(struct nci_dev *ndev)
332 struct fdp_nci_info *info = nci_get_drvdata(ndev);
333 struct device *dev = &info->phy->i2c_dev->dev;
337 if (info->otp_version >= info->otp_patch_version)
340 info->setup_patch_sent = 0;
341 info->setup_reset_ntf = 0;
342 info->setup_patch_ntf = 0;
344 /* Patch init request */
345 r = fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_OTP);
349 /* Patch data connection creation */
350 conn_id = fdp_nci_create_conn(ndev);
356 /* Send the patch over the data connection */
357 r = fdp_nci_send_patch(ndev, conn_id, NCI_PATCH_TYPE_OTP);
361 /* Wait for all the packets to be send over i2c */
362 wait_event_interruptible(info->setup_wq,
363 info->setup_patch_sent == 1);
365 /* make sure that the NFCC processed the last data packet */
366 msleep(FDP_FW_UPDATE_SLEEP);
368 /* Close the data connection */
369 r = nci_core_conn_close(info->ndev, conn_id);
373 /* Patch finish message */
374 if (fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_EOT)) {
375 nfc_err(dev, "OTP patch error 0x%x\n", r);
380 /* If the patch notification didn't arrive yet, wait for it */
381 wait_event_interruptible(info->setup_wq, info->setup_patch_ntf);
383 /* Check if the patching was successful */
384 r = info->setup_patch_status;
386 nfc_err(dev, "OTP patch error 0x%x\n", r);
392 * We need to wait for the reset notification before we
395 wait_event_interruptible(info->setup_wq, info->setup_reset_ntf);
401 static int fdp_nci_patch_ram(struct nci_dev *ndev)
403 struct fdp_nci_info *info = nci_get_drvdata(ndev);
404 struct device *dev = &info->phy->i2c_dev->dev;
408 if (info->ram_version >= info->ram_patch_version)
411 info->setup_patch_sent = 0;
412 info->setup_reset_ntf = 0;
413 info->setup_patch_ntf = 0;
415 /* Patch init request */
416 r = fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_RAM);
420 /* Patch data connection creation */
421 conn_id = fdp_nci_create_conn(ndev);
427 /* Send the patch over the data connection */
428 r = fdp_nci_send_patch(ndev, conn_id, NCI_PATCH_TYPE_RAM);
432 /* Wait for all the packets to be send over i2c */
433 wait_event_interruptible(info->setup_wq,
434 info->setup_patch_sent == 1);
436 /* make sure that the NFCC processed the last data packet */
437 msleep(FDP_FW_UPDATE_SLEEP);
439 /* Close the data connection */
440 r = nci_core_conn_close(info->ndev, conn_id);
444 /* Patch finish message */
445 if (fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_EOT)) {
446 nfc_err(dev, "RAM patch error 0x%x\n", r);
451 /* If the patch notification didn't arrive yet, wait for it */
452 wait_event_interruptible(info->setup_wq, info->setup_patch_ntf);
454 /* Check if the patching was successful */
455 r = info->setup_patch_status;
457 nfc_err(dev, "RAM patch error 0x%x\n", r);
463 * We need to wait for the reset notification before we
466 wait_event_interruptible(info->setup_wq, info->setup_reset_ntf);
472 static int fdp_nci_setup(struct nci_dev *ndev)
474 /* Format: total length followed by an NCI packet */
475 struct fdp_nci_info *info = nci_get_drvdata(ndev);
476 struct device *dev = &info->phy->i2c_dev->dev;
480 r = nci_core_init(ndev);
484 /* Get RAM and OTP version */
485 r = fdp_nci_get_versions(ndev);
489 /* Load firmware from disk */
490 r = fdp_nci_request_firmware(ndev);
495 if (info->otp_version < info->otp_patch_version) {
496 r = fdp_nci_patch_otp(ndev);
503 if (info->ram_version < info->ram_patch_version) {
504 r = fdp_nci_patch_ram(ndev);
510 /* Release the firmware buffers */
511 fdp_nci_release_firmware(ndev);
513 /* If a patch was applied the new version is checked */
515 r = nci_core_init(ndev);
519 r = fdp_nci_get_versions(ndev);
523 if (info->otp_version != info->otp_patch_version ||
524 info->ram_version != info->ram_patch_version) {
525 nfc_err(dev, "Firmware update failed");
532 * We initialized the devices but the NFC subsystem expects
533 * it to not be initialized.
535 return nci_core_reset(ndev);
538 fdp_nci_release_firmware(ndev);
539 nfc_err(dev, "Setup error %d\n", r);
543 static int fdp_nci_post_setup(struct nci_dev *ndev)
545 struct fdp_nci_info *info = nci_get_drvdata(ndev);
546 struct device *dev = &info->phy->i2c_dev->dev;
549 /* Check if the device has VSC */
550 if (info->fw_vsc_cfg && info->fw_vsc_cfg[0]) {
552 /* Set the vendor specific configuration */
553 r = fdp_nci_set_production_data(ndev, info->fw_vsc_cfg[3],
554 &info->fw_vsc_cfg[4]);
556 nfc_err(dev, "Vendor specific config set error %d\n",
562 /* Set clock type and frequency */
563 r = fdp_nci_set_clock(ndev, info->clock_type, info->clock_freq);
565 nfc_err(dev, "Clock set error %d\n", r);
570 * In order to apply the VSC FDP needs a reset
572 r = nci_core_reset(ndev);
577 * The nci core was initialized when post setup was called
578 * so we leave it like that
580 return nci_core_init(ndev);
583 static int fdp_nci_core_reset_ntf_packet(struct nci_dev *ndev,
586 struct fdp_nci_info *info = nci_get_drvdata(ndev);
588 info->setup_reset_ntf = 1;
589 wake_up(&info->setup_wq);
594 static int fdp_nci_prop_patch_ntf_packet(struct nci_dev *ndev,
597 struct fdp_nci_info *info = nci_get_drvdata(ndev);
599 info->setup_patch_ntf = 1;
600 info->setup_patch_status = skb->data[0];
601 wake_up(&info->setup_wq);
606 static int fdp_nci_prop_patch_rsp_packet(struct nci_dev *ndev,
609 struct fdp_nci_info *info = nci_get_drvdata(ndev);
610 struct device *dev = &info->phy->i2c_dev->dev;
611 u8 status = skb->data[0];
613 dev_dbg(dev, "%s: status 0x%x\n", __func__, status);
614 nci_req_complete(ndev, status);
619 static int fdp_nci_prop_set_production_data_rsp_packet(struct nci_dev *ndev,
622 struct fdp_nci_info *info = nci_get_drvdata(ndev);
623 struct device *dev = &info->phy->i2c_dev->dev;
624 u8 status = skb->data[0];
626 dev_dbg(dev, "%s: status 0x%x\n", __func__, status);
627 nci_req_complete(ndev, status);
632 static int fdp_nci_core_get_config_rsp_packet(struct nci_dev *ndev,
635 struct fdp_nci_info *info = nci_get_drvdata(ndev);
636 struct device *dev = &info->phy->i2c_dev->dev;
637 struct nci_core_get_config_rsp *rsp = (void *) skb->data;
640 if (rsp->status == NCI_STATUS_OK) {
643 for (i = 0; i < 4; i++) {
646 case NCI_PARAM_ID_FW_RAM_VERSION:
648 info->ram_version = le32_to_cpup((__le32 *) p);
651 case NCI_PARAM_ID_FW_OTP_VERSION:
653 info->otp_version = le32_to_cpup((__le32 *) p);
656 case NCI_PARAM_ID_OTP_LIMITED_VERSION:
658 info->otp_version = le32_to_cpup((__le32 *) p);
661 case NCI_PARAM_ID_KEY_INDEX_ID:
663 info->key_index = *p++;
668 dev_dbg(dev, "OTP version %d\n", info->otp_version);
669 dev_dbg(dev, "RAM version %d\n", info->ram_version);
670 dev_dbg(dev, "key index %d\n", info->key_index);
671 dev_dbg(dev, "%s: status 0x%x\n", __func__, rsp->status);
673 nci_req_complete(ndev, rsp->status);
678 static struct nci_driver_ops fdp_core_ops[] = {
680 .opcode = NCI_OP_CORE_GET_CONFIG_RSP,
681 .rsp = fdp_nci_core_get_config_rsp_packet,
684 .opcode = NCI_OP_CORE_RESET_NTF,
685 .ntf = fdp_nci_core_reset_ntf_packet,
689 static struct nci_driver_ops fdp_prop_ops[] = {
691 .opcode = nci_opcode_pack(NCI_GID_PROP, NCI_OP_PROP_PATCH_OID),
692 .rsp = fdp_nci_prop_patch_rsp_packet,
693 .ntf = fdp_nci_prop_patch_ntf_packet,
696 .opcode = nci_opcode_pack(NCI_GID_PROP,
697 NCI_OP_PROP_SET_PDATA_OID),
698 .rsp = fdp_nci_prop_set_production_data_rsp_packet,
702 static struct nci_ops nci_ops = {
703 .open = fdp_nci_open,
704 .close = fdp_nci_close,
705 .send = fdp_nci_send,
706 .setup = fdp_nci_setup,
707 .post_setup = fdp_nci_post_setup,
708 .prop_ops = fdp_prop_ops,
709 .n_prop_ops = ARRAY_SIZE(fdp_prop_ops),
710 .core_ops = fdp_core_ops,
711 .n_core_ops = ARRAY_SIZE(fdp_core_ops),
714 int fdp_nci_probe(struct fdp_i2c_phy *phy, struct nfc_phy_ops *phy_ops,
715 struct nci_dev **ndevp, int tx_headroom,
716 int tx_tailroom, u8 clock_type, u32 clock_freq,
719 struct device *dev = &phy->i2c_dev->dev;
720 struct fdp_nci_info *info;
721 struct nci_dev *ndev;
725 info = devm_kzalloc(dev, sizeof(struct fdp_nci_info), GFP_KERNEL);
730 info->phy_ops = phy_ops;
731 info->clock_type = clock_type;
732 info->clock_freq = clock_freq;
733 info->fw_vsc_cfg = fw_vsc_cfg;
735 init_waitqueue_head(&info->setup_wq);
737 protocols = NFC_PROTO_JEWEL_MASK |
738 NFC_PROTO_MIFARE_MASK |
739 NFC_PROTO_FELICA_MASK |
740 NFC_PROTO_ISO14443_MASK |
741 NFC_PROTO_ISO14443_B_MASK |
742 NFC_PROTO_NFC_DEP_MASK |
743 NFC_PROTO_ISO15693_MASK;
745 ndev = nci_allocate_device(&nci_ops, protocols, tx_headroom,
748 nfc_err(dev, "Cannot allocate nfc ndev\n");
752 r = nci_register_device(ndev);
759 nci_set_drvdata(ndev, info);
764 nci_free_device(ndev);
767 EXPORT_SYMBOL(fdp_nci_probe);
769 void fdp_nci_remove(struct nci_dev *ndev)
771 nci_unregister_device(ndev);
772 nci_free_device(ndev);
774 EXPORT_SYMBOL(fdp_nci_remove);
776 MODULE_LICENSE("GPL");
777 MODULE_DESCRIPTION("NFC NCI driver for Intel Fields Peak NFC controller");
778 MODULE_AUTHOR("Robert Dolca <robert.dolca@intel.com>");