xref: /openbmc/linux/drivers/nfc/s3fwrn5/core.c (revision 7ae9fb1b7ecbb5d85d07857943f677fd1a559b18)
19dd0abd2SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
2c04c674fSRobert Baldyga /*
3c04c674fSRobert Baldyga  * NCI based driver for Samsung S3FWRN5 NFC chip
4c04c674fSRobert Baldyga  *
5c04c674fSRobert Baldyga  * Copyright (C) 2015 Samsung Electrnoics
6c04c674fSRobert Baldyga  * Robert Baldyga <r.baldyga@samsung.com>
7c04c674fSRobert Baldyga  */
8c04c674fSRobert Baldyga 
9c04c674fSRobert Baldyga #include <linux/module.h>
10c04c674fSRobert Baldyga #include <net/nfc/nci_core.h>
11c04c674fSRobert Baldyga 
12c04c674fSRobert Baldyga #include "s3fwrn5.h"
13c04c674fSRobert Baldyga #include "firmware.h"
14c04c674fSRobert Baldyga #include "nci.h"
15c04c674fSRobert Baldyga 
16c04c674fSRobert Baldyga #define S3FWRN5_NFC_PROTOCOLS  (NFC_PROTO_JEWEL_MASK | \
17c04c674fSRobert Baldyga 				NFC_PROTO_MIFARE_MASK | \
18c04c674fSRobert Baldyga 				NFC_PROTO_FELICA_MASK | \
19c04c674fSRobert Baldyga 				NFC_PROTO_ISO14443_MASK | \
20c04c674fSRobert Baldyga 				NFC_PROTO_ISO14443_B_MASK | \
21c04c674fSRobert Baldyga 				NFC_PROTO_ISO15693_MASK)
22c04c674fSRobert Baldyga 
s3fwrn5_firmware_init(struct s3fwrn5_info * info)234fb7b98cSBongsu Jeon static int s3fwrn5_firmware_init(struct s3fwrn5_info *info)
244fb7b98cSBongsu Jeon {
254fb7b98cSBongsu Jeon 	struct s3fwrn5_fw_info *fw_info = &info->fw_info;
264fb7b98cSBongsu Jeon 	int ret;
274fb7b98cSBongsu Jeon 
284fb7b98cSBongsu Jeon 	s3fwrn5_fw_init(fw_info, "sec_s3fwrn5_firmware.bin");
294fb7b98cSBongsu Jeon 
304fb7b98cSBongsu Jeon 	/* Get firmware data */
314fb7b98cSBongsu Jeon 	ret = s3fwrn5_fw_request_firmware(fw_info);
324fb7b98cSBongsu Jeon 	if (ret < 0)
334fb7b98cSBongsu Jeon 		dev_err(&fw_info->ndev->nfc_dev->dev,
344fb7b98cSBongsu Jeon 			"Failed to get fw file, ret=%02x\n", ret);
354fb7b98cSBongsu Jeon 	return ret;
364fb7b98cSBongsu Jeon }
374fb7b98cSBongsu Jeon 
s3fwrn5_firmware_update(struct s3fwrn5_info * info)38c04c674fSRobert Baldyga static int s3fwrn5_firmware_update(struct s3fwrn5_info *info)
39c04c674fSRobert Baldyga {
40c04c674fSRobert Baldyga 	bool need_update;
41c04c674fSRobert Baldyga 	int ret;
42c04c674fSRobert Baldyga 
43c04c674fSRobert Baldyga 	/* Update firmware */
44c04c674fSRobert Baldyga 
45c04c674fSRobert Baldyga 	s3fwrn5_set_wake(info, false);
46c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_FW);
47c04c674fSRobert Baldyga 
48c04c674fSRobert Baldyga 	ret = s3fwrn5_fw_setup(&info->fw_info);
49c04c674fSRobert Baldyga 	if (ret < 0)
50c04c674fSRobert Baldyga 		return ret;
51c04c674fSRobert Baldyga 
52c04c674fSRobert Baldyga 	need_update = s3fwrn5_fw_check_version(&info->fw_info,
53c04c674fSRobert Baldyga 		info->ndev->manufact_specific_info);
54c04c674fSRobert Baldyga 	if (!need_update)
55c04c674fSRobert Baldyga 		goto out;
56c04c674fSRobert Baldyga 
57c04c674fSRobert Baldyga 	dev_info(&info->ndev->nfc_dev->dev, "Detected new firmware version\n");
58c04c674fSRobert Baldyga 
59c04c674fSRobert Baldyga 	ret = s3fwrn5_fw_download(&info->fw_info);
60c04c674fSRobert Baldyga 	if (ret < 0)
61c04c674fSRobert Baldyga 		goto out;
62c04c674fSRobert Baldyga 
63c04c674fSRobert Baldyga 	/* Update RF configuration */
64c04c674fSRobert Baldyga 
65c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_NCI);
66c04c674fSRobert Baldyga 
67c04c674fSRobert Baldyga 	s3fwrn5_set_wake(info, true);
68c04c674fSRobert Baldyga 	ret = s3fwrn5_nci_rf_configure(info, "sec_s3fwrn5_rfreg.bin");
69c04c674fSRobert Baldyga 	s3fwrn5_set_wake(info, false);
70c04c674fSRobert Baldyga 
71c04c674fSRobert Baldyga out:
72c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_COLD);
73c04c674fSRobert Baldyga 	s3fwrn5_fw_cleanup(&info->fw_info);
74c04c674fSRobert Baldyga 	return ret;
75c04c674fSRobert Baldyga }
76c04c674fSRobert Baldyga 
s3fwrn5_nci_open(struct nci_dev * ndev)77c04c674fSRobert Baldyga static int s3fwrn5_nci_open(struct nci_dev *ndev)
78c04c674fSRobert Baldyga {
79c04c674fSRobert Baldyga 	struct s3fwrn5_info *info = nci_get_drvdata(ndev);
80c04c674fSRobert Baldyga 
81c04c674fSRobert Baldyga 	if (s3fwrn5_get_mode(info) != S3FWRN5_MODE_COLD)
82c04c674fSRobert Baldyga 		return  -EBUSY;
83c04c674fSRobert Baldyga 
84c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_NCI);
85c04c674fSRobert Baldyga 	s3fwrn5_set_wake(info, true);
86c04c674fSRobert Baldyga 
87c04c674fSRobert Baldyga 	return 0;
88c04c674fSRobert Baldyga }
89c04c674fSRobert Baldyga 
s3fwrn5_nci_close(struct nci_dev * ndev)90c04c674fSRobert Baldyga static int s3fwrn5_nci_close(struct nci_dev *ndev)
91c04c674fSRobert Baldyga {
92c04c674fSRobert Baldyga 	struct s3fwrn5_info *info = nci_get_drvdata(ndev);
93c04c674fSRobert Baldyga 
94c04c674fSRobert Baldyga 	s3fwrn5_set_wake(info, false);
95c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_COLD);
96c04c674fSRobert Baldyga 
97c04c674fSRobert Baldyga 	return 0;
98c04c674fSRobert Baldyga }
99c04c674fSRobert Baldyga 
s3fwrn5_nci_send(struct nci_dev * ndev,struct sk_buff * skb)100c04c674fSRobert Baldyga static int s3fwrn5_nci_send(struct nci_dev *ndev, struct sk_buff *skb)
101c04c674fSRobert Baldyga {
102c04c674fSRobert Baldyga 	struct s3fwrn5_info *info = nci_get_drvdata(ndev);
103c04c674fSRobert Baldyga 	int ret;
104c04c674fSRobert Baldyga 
105c04c674fSRobert Baldyga 	mutex_lock(&info->mutex);
106c04c674fSRobert Baldyga 
107c04c674fSRobert Baldyga 	if (s3fwrn5_get_mode(info) != S3FWRN5_MODE_NCI) {
108*60dcb5ffSShang XiaoJing 		kfree_skb(skb);
109c04c674fSRobert Baldyga 		mutex_unlock(&info->mutex);
110c04c674fSRobert Baldyga 		return -EINVAL;
111c04c674fSRobert Baldyga 	}
112c04c674fSRobert Baldyga 
113c04c674fSRobert Baldyga 	ret = s3fwrn5_write(info, skb);
1143a146b7eSShang XiaoJing 	if (ret < 0) {
115c04c674fSRobert Baldyga 		kfree_skb(skb);
116c04c674fSRobert Baldyga 		mutex_unlock(&info->mutex);
117c04c674fSRobert Baldyga 		return ret;
118c04c674fSRobert Baldyga 	}
119c04c674fSRobert Baldyga 
1203a146b7eSShang XiaoJing 	consume_skb(skb);
1213a146b7eSShang XiaoJing 	mutex_unlock(&info->mutex);
1223a146b7eSShang XiaoJing 	return 0;
1233a146b7eSShang XiaoJing }
1243a146b7eSShang XiaoJing 
s3fwrn5_nci_post_setup(struct nci_dev * ndev)125c04c674fSRobert Baldyga static int s3fwrn5_nci_post_setup(struct nci_dev *ndev)
126c04c674fSRobert Baldyga {
127c04c674fSRobert Baldyga 	struct s3fwrn5_info *info = nci_get_drvdata(ndev);
128c04c674fSRobert Baldyga 	int ret;
129c04c674fSRobert Baldyga 
1304fb7b98cSBongsu Jeon 	if (s3fwrn5_firmware_init(info)) {
1314fb7b98cSBongsu Jeon 		//skip bootloader mode
132b58c4649Swengjianfeng 		return 0;
1334fb7b98cSBongsu Jeon 	}
1344fb7b98cSBongsu Jeon 
135c04c674fSRobert Baldyga 	ret = s3fwrn5_firmware_update(info);
136c04c674fSRobert Baldyga 	if (ret < 0)
137b58c4649Swengjianfeng 		return ret;
138c04c674fSRobert Baldyga 
139c04c674fSRobert Baldyga 	/* NCI core reset */
140c04c674fSRobert Baldyga 
141c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_NCI);
142c04c674fSRobert Baldyga 	s3fwrn5_set_wake(info, true);
143c04c674fSRobert Baldyga 
144c04c674fSRobert Baldyga 	ret = nci_core_reset(info->ndev);
145c04c674fSRobert Baldyga 	if (ret < 0)
146c04c674fSRobert Baldyga 		return ret;
147b58c4649Swengjianfeng 
148b58c4649Swengjianfeng 	return nci_core_init(info->ndev);
149c04c674fSRobert Baldyga }
150c04c674fSRobert Baldyga 
151d08ba0fdSKrzysztof Kozlowski static const struct nci_ops s3fwrn5_nci_ops = {
152c04c674fSRobert Baldyga 	.open = s3fwrn5_nci_open,
153c04c674fSRobert Baldyga 	.close = s3fwrn5_nci_close,
154c04c674fSRobert Baldyga 	.send = s3fwrn5_nci_send,
155c04c674fSRobert Baldyga 	.post_setup = s3fwrn5_nci_post_setup,
156d08ba0fdSKrzysztof Kozlowski 	.prop_ops = s3fwrn5_nci_prop_ops,
157d08ba0fdSKrzysztof Kozlowski 	.n_prop_ops = ARRAY_SIZE(s3fwrn5_nci_prop_ops),
158c04c674fSRobert Baldyga };
159c04c674fSRobert Baldyga 
s3fwrn5_probe(struct nci_dev ** ndev,void * phy_id,struct device * pdev,const struct s3fwrn5_phy_ops * phy_ops)160c04c674fSRobert Baldyga int s3fwrn5_probe(struct nci_dev **ndev, void *phy_id, struct device *pdev,
161b50e2964SBongsu Jeon 	const struct s3fwrn5_phy_ops *phy_ops)
162c04c674fSRobert Baldyga {
163c04c674fSRobert Baldyga 	struct s3fwrn5_info *info;
164c04c674fSRobert Baldyga 	int ret;
165c04c674fSRobert Baldyga 
166c04c674fSRobert Baldyga 	info = devm_kzalloc(pdev, sizeof(*info), GFP_KERNEL);
167c04c674fSRobert Baldyga 	if (!info)
168c04c674fSRobert Baldyga 		return -ENOMEM;
169c04c674fSRobert Baldyga 
170c04c674fSRobert Baldyga 	info->phy_id = phy_id;
171c04c674fSRobert Baldyga 	info->pdev = pdev;
172c04c674fSRobert Baldyga 	info->phy_ops = phy_ops;
173c04c674fSRobert Baldyga 	mutex_init(&info->mutex);
174c04c674fSRobert Baldyga 
175c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_COLD);
176c04c674fSRobert Baldyga 
177c04c674fSRobert Baldyga 	info->ndev = nci_allocate_device(&s3fwrn5_nci_ops,
178c04c674fSRobert Baldyga 		S3FWRN5_NFC_PROTOCOLS, 0, 0);
179c04c674fSRobert Baldyga 	if (!info->ndev)
180c04c674fSRobert Baldyga 		return -ENOMEM;
181c04c674fSRobert Baldyga 
182c04c674fSRobert Baldyga 	nci_set_parent_dev(info->ndev, pdev);
183c04c674fSRobert Baldyga 	nci_set_drvdata(info->ndev, info);
184c04c674fSRobert Baldyga 
185c04c674fSRobert Baldyga 	ret = nci_register_device(info->ndev);
186c04c674fSRobert Baldyga 	if (ret < 0) {
187c04c674fSRobert Baldyga 		nci_free_device(info->ndev);
188c04c674fSRobert Baldyga 		return ret;
189c04c674fSRobert Baldyga 	}
190c04c674fSRobert Baldyga 
191c04c674fSRobert Baldyga 	info->fw_info.ndev = info->ndev;
192c04c674fSRobert Baldyga 
193c04c674fSRobert Baldyga 	*ndev = info->ndev;
194c04c674fSRobert Baldyga 
195c04c674fSRobert Baldyga 	return ret;
196c04c674fSRobert Baldyga }
197c04c674fSRobert Baldyga EXPORT_SYMBOL(s3fwrn5_probe);
198c04c674fSRobert Baldyga 
s3fwrn5_remove(struct nci_dev * ndev)199c04c674fSRobert Baldyga void s3fwrn5_remove(struct nci_dev *ndev)
200c04c674fSRobert Baldyga {
201c04c674fSRobert Baldyga 	struct s3fwrn5_info *info = nci_get_drvdata(ndev);
202c04c674fSRobert Baldyga 
203c04c674fSRobert Baldyga 	s3fwrn5_set_mode(info, S3FWRN5_MODE_COLD);
204c04c674fSRobert Baldyga 
205c04c674fSRobert Baldyga 	nci_unregister_device(ndev);
206c04c674fSRobert Baldyga 	nci_free_device(ndev);
207c04c674fSRobert Baldyga }
208c04c674fSRobert Baldyga EXPORT_SYMBOL(s3fwrn5_remove);
209c04c674fSRobert Baldyga 
s3fwrn5_recv_frame(struct nci_dev * ndev,struct sk_buff * skb,enum s3fwrn5_mode mode)210c04c674fSRobert Baldyga int s3fwrn5_recv_frame(struct nci_dev *ndev, struct sk_buff *skb,
211c04c674fSRobert Baldyga 	enum s3fwrn5_mode mode)
212c04c674fSRobert Baldyga {
213c04c674fSRobert Baldyga 	switch (mode) {
214c04c674fSRobert Baldyga 	case S3FWRN5_MODE_NCI:
215c04c674fSRobert Baldyga 		return nci_recv_frame(ndev, skb);
216c04c674fSRobert Baldyga 	case S3FWRN5_MODE_FW:
217c04c674fSRobert Baldyga 		return s3fwrn5_fw_recv_frame(ndev, skb);
218c04c674fSRobert Baldyga 	default:
2191e8fd3a9SNavid Emamdoost 		kfree_skb(skb);
220c04c674fSRobert Baldyga 		return -ENODEV;
221c04c674fSRobert Baldyga 	}
222c04c674fSRobert Baldyga }
223c04c674fSRobert Baldyga EXPORT_SYMBOL(s3fwrn5_recv_frame);
224c04c674fSRobert Baldyga 
225c04c674fSRobert Baldyga MODULE_LICENSE("GPL");
226c04c674fSRobert Baldyga MODULE_DESCRIPTION("Samsung S3FWRN5 NFC driver");
227c04c674fSRobert Baldyga MODULE_AUTHOR("Robert Baldyga <r.baldyga@samsung.com>");
228