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 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);
253 if (atomic_dec_and_test(&info->data_pkt_counter))
254 info->data_pkt_counter_cb(ndev);
256 return info->phy_ops->write(info->phy, skb);
259 static int fdp_nci_request_firmware(struct nci_dev *ndev)
261 struct fdp_nci_info *info = nci_get_drvdata(ndev);
262 struct device *dev = &info->phy->i2c_dev->dev;
266 r = reject_firmware(&info->ram_patch, FDP_RAM_PATCH_NAME, dev);
268 nfc_err(dev, "RAM patch request error\n");
272 data = info->ram_patch->data;
273 info->ram_patch_version =
274 data[FDP_FW_HEADER_SIZE] |
275 (data[FDP_FW_HEADER_SIZE + 1] << 8) |
276 (data[FDP_FW_HEADER_SIZE + 2] << 16) |
277 (data[FDP_FW_HEADER_SIZE + 3] << 24);
279 dev_dbg(dev, "RAM patch version: %d, size: %zu\n",
280 info->ram_patch_version, info->ram_patch->size);
283 r = reject_firmware(&info->otp_patch, FDP_OTP_PATCH_NAME, dev);
285 nfc_err(dev, "OTP patch request error\n");
289 data = (u8 *) info->otp_patch->data;
290 info->otp_patch_version =
291 data[FDP_FW_HEADER_SIZE] |
292 (data[FDP_FW_HEADER_SIZE + 1] << 8) |
293 (data[FDP_FW_HEADER_SIZE+2] << 16) |
294 (data[FDP_FW_HEADER_SIZE+3] << 24);
296 dev_dbg(dev, "OTP patch version: %d, size: %zu\n",
297 info->otp_patch_version, info->otp_patch->size);
301 static void fdp_nci_release_firmware(struct nci_dev *ndev)
303 struct fdp_nci_info *info = nci_get_drvdata(ndev);
305 if (info->otp_patch) {
306 release_firmware(info->otp_patch);
307 info->otp_patch = NULL;
310 if (info->ram_patch) {
311 release_firmware(info->ram_patch);
312 info->ram_patch = NULL;
316 static int fdp_nci_patch_otp(struct nci_dev *ndev)
318 struct fdp_nci_info *info = nci_get_drvdata(ndev);
319 struct device *dev = &info->phy->i2c_dev->dev;
323 if (info->otp_version >= info->otp_patch_version)
326 info->setup_patch_sent = 0;
327 info->setup_reset_ntf = 0;
328 info->setup_patch_ntf = 0;
330 /* Patch init request */
331 r = fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_OTP);
335 /* Patch data connection creation */
336 conn_id = fdp_nci_create_conn(ndev);
340 /* Send the patch over the data connection */
341 r = fdp_nci_send_patch(ndev, conn_id, NCI_PATCH_TYPE_OTP);
345 /* Wait for all the packets to be send over i2c */
346 wait_event_interruptible(info->setup_wq,
347 info->setup_patch_sent == 1);
349 /* make sure that the NFCC processed the last data packet */
350 msleep(FDP_FW_UPDATE_SLEEP);
352 /* Close the data connection */
353 r = nci_core_conn_close(info->ndev, conn_id);
357 /* Patch finish message */
358 if (fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_EOT)) {
359 nfc_err(dev, "OTP patch error 0x%x\n", r);
363 /* If the patch notification didn't arrive yet, wait for it */
364 wait_event_interruptible(info->setup_wq, info->setup_patch_ntf);
366 /* Check if the patching was successful */
367 r = info->setup_patch_status;
369 nfc_err(dev, "OTP patch error 0x%x\n", r);
374 * We need to wait for the reset notification before we
377 wait_event_interruptible(info->setup_wq, info->setup_reset_ntf);
382 static int fdp_nci_patch_ram(struct nci_dev *ndev)
384 struct fdp_nci_info *info = nci_get_drvdata(ndev);
385 struct device *dev = &info->phy->i2c_dev->dev;
389 if (info->ram_version >= info->ram_patch_version)
392 info->setup_patch_sent = 0;
393 info->setup_reset_ntf = 0;
394 info->setup_patch_ntf = 0;
396 /* Patch init request */
397 r = fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_RAM);
401 /* Patch data connection creation */
402 conn_id = fdp_nci_create_conn(ndev);
406 /* Send the patch over the data connection */
407 r = fdp_nci_send_patch(ndev, conn_id, NCI_PATCH_TYPE_RAM);
411 /* Wait for all the packets to be send over i2c */
412 wait_event_interruptible(info->setup_wq,
413 info->setup_patch_sent == 1);
415 /* make sure that the NFCC processed the last data packet */
416 msleep(FDP_FW_UPDATE_SLEEP);
418 /* Close the data connection */
419 r = nci_core_conn_close(info->ndev, conn_id);
423 /* Patch finish message */
424 if (fdp_nci_patch_cmd(ndev, NCI_PATCH_TYPE_EOT)) {
425 nfc_err(dev, "RAM patch error 0x%x\n", r);
429 /* If the patch notification didn't arrive yet, wait for it */
430 wait_event_interruptible(info->setup_wq, info->setup_patch_ntf);
432 /* Check if the patching was successful */
433 r = info->setup_patch_status;
435 nfc_err(dev, "RAM patch error 0x%x\n", r);
440 * We need to wait for the reset notification before we
443 wait_event_interruptible(info->setup_wq, info->setup_reset_ntf);
448 static int fdp_nci_setup(struct nci_dev *ndev)
450 /* Format: total length followed by an NCI packet */
451 struct fdp_nci_info *info = nci_get_drvdata(ndev);
452 struct device *dev = &info->phy->i2c_dev->dev;
456 r = nci_core_init(ndev);
460 /* Get RAM and OTP version */
461 r = fdp_nci_get_versions(ndev);
465 /* Load firmware from disk */
466 r = fdp_nci_request_firmware(ndev);
471 if (info->otp_version < info->otp_patch_version) {
472 r = fdp_nci_patch_otp(ndev);
479 if (info->ram_version < info->ram_patch_version) {
480 r = fdp_nci_patch_ram(ndev);
486 /* Release the firmware buffers */
487 fdp_nci_release_firmware(ndev);
489 /* If a patch was applied the new version is checked */
491 r = nci_core_init(ndev);
495 r = fdp_nci_get_versions(ndev);
499 if (info->otp_version != info->otp_patch_version ||
500 info->ram_version != info->ram_patch_version) {
501 nfc_err(dev, "Firmware update failed");
508 * We initialized the devices but the NFC subsystem expects
509 * it to not be initialized.
511 return nci_core_reset(ndev);
514 fdp_nci_release_firmware(ndev);
515 nfc_err(dev, "Setup error %d\n", r);
519 static int fdp_nci_post_setup(struct nci_dev *ndev)
521 struct fdp_nci_info *info = nci_get_drvdata(ndev);
522 struct device *dev = &info->phy->i2c_dev->dev;
525 /* Check if the device has VSC */
526 if (info->fw_vsc_cfg && info->fw_vsc_cfg[0]) {
528 /* Set the vendor specific configuration */
529 r = fdp_nci_set_production_data(ndev, info->fw_vsc_cfg[3],
530 &info->fw_vsc_cfg[4]);
532 nfc_err(dev, "Vendor specific config set error %d\n",
538 /* Set clock type and frequency */
539 r = fdp_nci_set_clock(ndev, info->clock_type, info->clock_freq);
541 nfc_err(dev, "Clock set error %d\n", r);
546 * In order to apply the VSC FDP needs a reset
548 r = nci_core_reset(ndev);
553 * The nci core was initialized when post setup was called
554 * so we leave it like that
556 return nci_core_init(ndev);
559 static int fdp_nci_core_reset_ntf_packet(struct nci_dev *ndev,
562 struct fdp_nci_info *info = nci_get_drvdata(ndev);
564 info->setup_reset_ntf = 1;
565 wake_up(&info->setup_wq);
570 static int fdp_nci_prop_patch_ntf_packet(struct nci_dev *ndev,
573 struct fdp_nci_info *info = nci_get_drvdata(ndev);
575 info->setup_patch_ntf = 1;
576 info->setup_patch_status = skb->data[0];
577 wake_up(&info->setup_wq);
582 static int fdp_nci_prop_patch_rsp_packet(struct nci_dev *ndev,
585 struct fdp_nci_info *info = nci_get_drvdata(ndev);
586 struct device *dev = &info->phy->i2c_dev->dev;
587 u8 status = skb->data[0];
589 dev_dbg(dev, "%s: status 0x%x\n", __func__, status);
590 nci_req_complete(ndev, status);
595 static int fdp_nci_prop_set_production_data_rsp_packet(struct nci_dev *ndev,
598 struct fdp_nci_info *info = nci_get_drvdata(ndev);
599 struct device *dev = &info->phy->i2c_dev->dev;
600 u8 status = skb->data[0];
602 dev_dbg(dev, "%s: status 0x%x\n", __func__, status);
603 nci_req_complete(ndev, status);
608 static int fdp_nci_core_get_config_rsp_packet(struct nci_dev *ndev,
611 struct fdp_nci_info *info = nci_get_drvdata(ndev);
612 struct device *dev = &info->phy->i2c_dev->dev;
613 const struct nci_core_get_config_rsp *rsp = (void *) skb->data;
617 if (rsp->status == NCI_STATUS_OK) {
620 for (i = 0; i < 4; i++) {
623 case NCI_PARAM_ID_FW_RAM_VERSION:
625 info->ram_version = le32_to_cpup((__le32 *) p);
628 case NCI_PARAM_ID_FW_OTP_VERSION:
630 info->otp_version = le32_to_cpup((__le32 *) p);
633 case NCI_PARAM_ID_OTP_LIMITED_VERSION:
635 info->otp_version = le32_to_cpup((__le32 *) p);
638 case NCI_PARAM_ID_KEY_INDEX_ID:
640 info->key_index = *p++;
645 dev_dbg(dev, "OTP version %d\n", info->otp_version);
646 dev_dbg(dev, "RAM version %d\n", info->ram_version);
647 dev_dbg(dev, "key index %d\n", info->key_index);
648 dev_dbg(dev, "%s: status 0x%x\n", __func__, rsp->status);
650 nci_req_complete(ndev, rsp->status);
655 static const struct nci_driver_ops fdp_core_ops[] = {
657 .opcode = NCI_OP_CORE_GET_CONFIG_RSP,
658 .rsp = fdp_nci_core_get_config_rsp_packet,
661 .opcode = NCI_OP_CORE_RESET_NTF,
662 .ntf = fdp_nci_core_reset_ntf_packet,
666 static const struct nci_driver_ops fdp_prop_ops[] = {
668 .opcode = nci_opcode_pack(NCI_GID_PROP, NCI_OP_PROP_PATCH_OID),
669 .rsp = fdp_nci_prop_patch_rsp_packet,
670 .ntf = fdp_nci_prop_patch_ntf_packet,
673 .opcode = nci_opcode_pack(NCI_GID_PROP,
674 NCI_OP_PROP_SET_PDATA_OID),
675 .rsp = fdp_nci_prop_set_production_data_rsp_packet,
679 static const struct nci_ops nci_ops = {
680 .open = fdp_nci_open,
681 .close = fdp_nci_close,
682 .send = fdp_nci_send,
683 .setup = fdp_nci_setup,
684 .post_setup = fdp_nci_post_setup,
685 .prop_ops = fdp_prop_ops,
686 .n_prop_ops = ARRAY_SIZE(fdp_prop_ops),
687 .core_ops = fdp_core_ops,
688 .n_core_ops = ARRAY_SIZE(fdp_core_ops),
691 int fdp_nci_probe(struct fdp_i2c_phy *phy, const struct nfc_phy_ops *phy_ops,
692 struct nci_dev **ndevp, int tx_headroom,
693 int tx_tailroom, u8 clock_type, u32 clock_freq,
694 const u8 *fw_vsc_cfg)
696 struct device *dev = &phy->i2c_dev->dev;
697 struct fdp_nci_info *info;
698 struct nci_dev *ndev;
702 info = devm_kzalloc(dev, sizeof(struct fdp_nci_info), GFP_KERNEL);
707 info->phy_ops = phy_ops;
708 info->clock_type = clock_type;
709 info->clock_freq = clock_freq;
710 info->fw_vsc_cfg = fw_vsc_cfg;
712 init_waitqueue_head(&info->setup_wq);
714 protocols = NFC_PROTO_JEWEL_MASK |
715 NFC_PROTO_MIFARE_MASK |
716 NFC_PROTO_FELICA_MASK |
717 NFC_PROTO_ISO14443_MASK |
718 NFC_PROTO_ISO14443_B_MASK |
719 NFC_PROTO_NFC_DEP_MASK |
720 NFC_PROTO_ISO15693_MASK;
722 BUILD_BUG_ON(ARRAY_SIZE(fdp_prop_ops) > NCI_MAX_PROPRIETARY_CMD);
723 ndev = nci_allocate_device(&nci_ops, protocols, tx_headroom,
726 nfc_err(dev, "Cannot allocate nfc ndev\n");
730 r = nci_register_device(ndev);
737 nci_set_drvdata(ndev, info);
742 nci_free_device(ndev);
745 EXPORT_SYMBOL(fdp_nci_probe);
747 void fdp_nci_remove(struct nci_dev *ndev)
749 nci_unregister_device(ndev);
750 nci_free_device(ndev);
752 EXPORT_SYMBOL(fdp_nci_remove);
754 MODULE_LICENSE("GPL");
755 MODULE_DESCRIPTION("NFC NCI driver for Intel Fields Peak NFC controller");
756 MODULE_AUTHOR("Robert Dolca <robert.dolca@intel.com>");