xref: /linux/drivers/nfc/pn544/pn544.c (revision f2c53ea949c5048f96b3dbb5a5ee7131ce4ff2de)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * HCI based Driver for NXP PN544 NFC Chip
4  *
5  * Copyright (C) 2012  Intel Corporation. All rights reserved.
6  */
7 
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
9 
10 #include <linux/delay.h>
11 #include <linux/slab.h>
12 #include <linux/module.h>
13 
14 #include <linux/nfc.h>
15 #include <net/nfc/hci.h>
16 
17 #include "pn544.h"
18 
19 /* Timing restrictions (ms) */
20 #define PN544_HCI_RESETVEN_TIME		30
21 
22 enum pn544_state {
23 	PN544_ST_COLD,
24 	PN544_ST_FW_READY,
25 	PN544_ST_READY,
26 };
27 
28 #define FULL_VERSION_LEN 11
29 
30 /* Proprietary commands */
31 #define PN544_WRITE		0x3f
32 #define PN544_TEST_SWP		0x21
33 
34 /* Proprietary gates, events, commands and registers */
35 
36 /* NFC_HCI_RF_READER_A_GATE additional registers and commands */
37 #define PN544_RF_READER_A_AUTO_ACTIVATION			0x10
38 #define PN544_RF_READER_A_CMD_CONTINUE_ACTIVATION		0x12
39 #define PN544_MIFARE_CMD					0x21
40 
41 /* Commands that apply to all RF readers */
42 #define PN544_RF_READER_CMD_PRESENCE_CHECK	0x30
43 #define PN544_RF_READER_CMD_ACTIVATE_NEXT	0x32
44 
45 /* NFC_HCI_ID_MGMT_GATE additional registers */
46 #define PN544_ID_MGMT_FULL_VERSION_SW		0x10
47 
48 #define PN544_RF_READER_ISO15693_GATE		0x12
49 
50 #define PN544_RF_READER_F_GATE			0x14
51 #define PN544_FELICA_ID				0x04
52 #define PN544_FELICA_RAW			0x20
53 
54 #define PN544_RF_READER_JEWEL_GATE		0x15
55 #define PN544_JEWEL_RAW_CMD			0x23
56 
57 #define PN544_RF_READER_NFCIP1_INITIATOR_GATE	0x30
58 #define PN544_RF_READER_NFCIP1_TARGET_GATE	0x31
59 
60 #define PN544_SYS_MGMT_GATE			0x90
61 #define PN544_SYS_MGMT_INFO_NOTIFICATION	0x02
62 
63 #define PN544_POLLING_LOOP_MGMT_GATE		0x94
64 #define PN544_DEP_MODE				0x01
65 #define PN544_DEP_ATR_REQ			0x02
66 #define PN544_DEP_ATR_RES			0x03
67 #define PN544_DEP_MERGE				0x0D
68 #define PN544_PL_RDPHASES			0x06
69 #define PN544_PL_EMULATION			0x07
70 #define PN544_PL_NFCT_DEACTIVATED		0x09
71 
72 #define PN544_SWP_MGMT_GATE			0xA0
73 #define PN544_SWP_DEFAULT_MODE			0x01
74 
75 #define PN544_NFC_WI_MGMT_GATE			0xA1
76 #define PN544_NFC_ESE_DEFAULT_MODE		0x01
77 
78 #define PN544_HCI_EVT_SND_DATA			0x01
79 #define PN544_HCI_EVT_ACTIVATED			0x02
80 #define PN544_HCI_EVT_DEACTIVATED		0x03
81 #define PN544_HCI_EVT_RCV_DATA			0x04
82 #define PN544_HCI_EVT_CONTINUE_MI		0x05
83 #define PN544_HCI_EVT_SWITCH_MODE		0x03
84 
85 #define PN544_HCI_CMD_ATTREQUEST		0x12
86 #define PN544_HCI_CMD_CONTINUE_ACTIVATION	0x13
87 
88 static const struct nfc_hci_gate pn544_gates[] = {
89 	{NFC_HCI_ADMIN_GATE, NFC_HCI_INVALID_PIPE},
90 	{NFC_HCI_LOOPBACK_GATE, NFC_HCI_INVALID_PIPE},
91 	{NFC_HCI_ID_MGMT_GATE, NFC_HCI_INVALID_PIPE},
92 	{NFC_HCI_LINK_MGMT_GATE, NFC_HCI_INVALID_PIPE},
93 	{NFC_HCI_RF_READER_B_GATE, NFC_HCI_INVALID_PIPE},
94 	{NFC_HCI_RF_READER_A_GATE, NFC_HCI_INVALID_PIPE},
95 	{PN544_SYS_MGMT_GATE, NFC_HCI_INVALID_PIPE},
96 	{PN544_SWP_MGMT_GATE, NFC_HCI_INVALID_PIPE},
97 	{PN544_POLLING_LOOP_MGMT_GATE, NFC_HCI_INVALID_PIPE},
98 	{PN544_NFC_WI_MGMT_GATE, NFC_HCI_INVALID_PIPE},
99 	{PN544_RF_READER_F_GATE, NFC_HCI_INVALID_PIPE},
100 	{PN544_RF_READER_JEWEL_GATE, NFC_HCI_INVALID_PIPE},
101 	{PN544_RF_READER_ISO15693_GATE, NFC_HCI_INVALID_PIPE},
102 	{PN544_RF_READER_NFCIP1_INITIATOR_GATE, NFC_HCI_INVALID_PIPE},
103 	{PN544_RF_READER_NFCIP1_TARGET_GATE, NFC_HCI_INVALID_PIPE}
104 };
105 
106 /* Largest headroom needed for outgoing custom commands */
107 #define PN544_CMDS_HEADROOM	2
108 
109 struct pn544_hci_info {
110 	const struct nfc_phy_ops *phy_ops;
111 	void *phy_id;
112 
113 	struct nfc_hci_dev *hdev;
114 
115 	enum pn544_state state;
116 
117 	struct mutex info_lock;
118 
119 	int async_cb_type;
120 	data_exchange_cb_t async_cb;
121 	void *async_cb_context;
122 
123 	fw_download_t fw_download;
124 };
125 
pn544_hci_open(struct nfc_hci_dev * hdev)126 static int pn544_hci_open(struct nfc_hci_dev *hdev)
127 {
128 	struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
129 	int r = 0;
130 
131 	mutex_lock(&info->info_lock);
132 
133 	if (info->state != PN544_ST_COLD) {
134 		r = -EBUSY;
135 		goto out;
136 	}
137 
138 	r = info->phy_ops->enable(info->phy_id);
139 
140 	if (r == 0)
141 		info->state = PN544_ST_READY;
142 
143 out:
144 	mutex_unlock(&info->info_lock);
145 	return r;
146 }
147 
pn544_hci_close(struct nfc_hci_dev * hdev)148 static void pn544_hci_close(struct nfc_hci_dev *hdev)
149 {
150 	struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
151 
152 	mutex_lock(&info->info_lock);
153 
154 	if (info->state == PN544_ST_COLD)
155 		goto out;
156 
157 	info->phy_ops->disable(info->phy_id);
158 
159 	info->state = PN544_ST_COLD;
160 
161 out:
162 	mutex_unlock(&info->info_lock);
163 }
164 
pn544_hci_ready(struct nfc_hci_dev * hdev)165 static int pn544_hci_ready(struct nfc_hci_dev *hdev)
166 {
167 	struct sk_buff *skb;
168 	static struct hw_config {
169 		u8 adr[2];
170 		u8 value;
171 	} hw_config[] = {
172 		{{0x9f, 0x9a}, 0x00},
173 
174 		{{0x98, 0x10}, 0xbc},
175 
176 		{{0x9e, 0x71}, 0x00},
177 
178 		{{0x98, 0x09}, 0x00},
179 
180 		{{0x9e, 0xb4}, 0x00},
181 
182 		{{0x9c, 0x01}, 0x08},
183 
184 		{{0x9e, 0xaa}, 0x01},
185 
186 		{{0x9b, 0xd1}, 0x17},
187 		{{0x9b, 0xd2}, 0x58},
188 		{{0x9b, 0xd3}, 0x10},
189 		{{0x9b, 0xd4}, 0x47},
190 		{{0x9b, 0xd5}, 0x0c},
191 		{{0x9b, 0xd6}, 0x37},
192 		{{0x9b, 0xdd}, 0x33},
193 
194 		{{0x9b, 0x84}, 0x00},
195 		{{0x99, 0x81}, 0x79},
196 		{{0x99, 0x31}, 0x79},
197 
198 		{{0x98, 0x00}, 0x3f},
199 
200 		{{0x9f, 0x09}, 0x02},
201 
202 		{{0x9f, 0x0a}, 0x05},
203 
204 		{{0x9e, 0xd1}, 0xa1},
205 		{{0x99, 0x23}, 0x01},
206 
207 		{{0x9e, 0x74}, 0x00},
208 		{{0x9e, 0x90}, 0x00},
209 		{{0x9f, 0x28}, 0x10},
210 
211 		{{0x9f, 0x35}, 0x04},
212 
213 		{{0x9f, 0x36}, 0x11},
214 
215 		{{0x9c, 0x31}, 0x00},
216 
217 		{{0x9c, 0x32}, 0x00},
218 
219 		{{0x9c, 0x19}, 0x0a},
220 
221 		{{0x9c, 0x1a}, 0x0a},
222 
223 		{{0x9c, 0x0c}, 0x00},
224 
225 		{{0x9c, 0x0d}, 0x00},
226 
227 		{{0x9c, 0x12}, 0x00},
228 
229 		{{0x9c, 0x13}, 0x00},
230 
231 		{{0x98, 0xa2}, 0x09},
232 
233 		{{0x98, 0x93}, 0x00},
234 
235 		{{0x98, 0x7d}, 0x08},
236 		{{0x98, 0x7e}, 0x00},
237 		{{0x9f, 0xc8}, 0x00},
238 	};
239 	struct hw_config *p = hw_config;
240 	int count = ARRAY_SIZE(hw_config);
241 	struct sk_buff *res_skb;
242 	u8 param[4];
243 	int r;
244 
245 	param[0] = 0;
246 	while (count--) {
247 		param[1] = p->adr[0];
248 		param[2] = p->adr[1];
249 		param[3] = p->value;
250 
251 		r = nfc_hci_send_cmd(hdev, PN544_SYS_MGMT_GATE, PN544_WRITE,
252 				     param, 4, &res_skb);
253 		if (r < 0)
254 			return r;
255 
256 		if (res_skb->len != 1) {
257 			kfree_skb(res_skb);
258 			return -EPROTO;
259 		}
260 
261 		if (res_skb->data[0] != p->value) {
262 			kfree_skb(res_skb);
263 			return -EIO;
264 		}
265 
266 		kfree_skb(res_skb);
267 
268 		p++;
269 	}
270 
271 	param[0] = NFC_HCI_UICC_HOST_ID;
272 	r = nfc_hci_set_param(hdev, NFC_HCI_ADMIN_GATE,
273 			      NFC_HCI_ADMIN_WHITELIST, param, 1);
274 	if (r < 0)
275 		return r;
276 
277 	param[0] = 0x3d;
278 	r = nfc_hci_set_param(hdev, PN544_SYS_MGMT_GATE,
279 			      PN544_SYS_MGMT_INFO_NOTIFICATION, param, 1);
280 	if (r < 0)
281 		return r;
282 
283 	param[0] = 0x0;
284 	r = nfc_hci_set_param(hdev, NFC_HCI_RF_READER_A_GATE,
285 			      PN544_RF_READER_A_AUTO_ACTIVATION, param, 1);
286 	if (r < 0)
287 		return r;
288 
289 	r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
290 			       NFC_HCI_EVT_END_OPERATION, NULL, 0);
291 	if (r < 0)
292 		return r;
293 
294 	param[0] = 0x1;
295 	r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
296 			      PN544_PL_NFCT_DEACTIVATED, param, 1);
297 	if (r < 0)
298 		return r;
299 
300 	param[0] = 0x0;
301 	r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
302 			      PN544_PL_RDPHASES, param, 1);
303 	if (r < 0)
304 		return r;
305 
306 	r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
307 			      PN544_ID_MGMT_FULL_VERSION_SW, &skb);
308 	if (r < 0)
309 		return r;
310 
311 	if (skb->len != FULL_VERSION_LEN) {
312 		kfree_skb(skb);
313 		return -EINVAL;
314 	}
315 
316 	print_hex_dump(KERN_DEBUG, "FULL VERSION SOFTWARE INFO: ",
317 		       DUMP_PREFIX_NONE, 16, 1,
318 		       skb->data, FULL_VERSION_LEN, false);
319 
320 	kfree_skb(skb);
321 
322 	return 0;
323 }
324 
pn544_hci_xmit(struct nfc_hci_dev * hdev,struct sk_buff * skb)325 static int pn544_hci_xmit(struct nfc_hci_dev *hdev, struct sk_buff *skb)
326 {
327 	struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
328 
329 	return info->phy_ops->write(info->phy_id, skb);
330 }
331 
pn544_hci_start_poll(struct nfc_hci_dev * hdev,u32 im_protocols,u32 tm_protocols)332 static int pn544_hci_start_poll(struct nfc_hci_dev *hdev,
333 				u32 im_protocols, u32 tm_protocols)
334 {
335 	u8 phases = 0;
336 	int r;
337 	u8 duration[2];
338 	u8 activated;
339 	u8 i_mode = 0x3f; /* Enable all supported modes */
340 	u8 t_mode = 0x0f;
341 	u8 t_merge = 0x01; /* Enable merge by default */
342 
343 	pr_info(DRIVER_DESC ": %s protocols 0x%x 0x%x\n",
344 		__func__, im_protocols, tm_protocols);
345 
346 	r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
347 			       NFC_HCI_EVT_END_OPERATION, NULL, 0);
348 	if (r < 0)
349 		return r;
350 
351 	duration[0] = 0x18;
352 	duration[1] = 0x6a;
353 	r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
354 			      PN544_PL_EMULATION, duration, 2);
355 	if (r < 0)
356 		return r;
357 
358 	activated = 0;
359 	r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
360 			      PN544_PL_NFCT_DEACTIVATED, &activated, 1);
361 	if (r < 0)
362 		return r;
363 
364 	if (im_protocols & (NFC_PROTO_ISO14443_MASK | NFC_PROTO_MIFARE_MASK |
365 			 NFC_PROTO_JEWEL_MASK))
366 		phases |= 1;		/* Type A */
367 	if (im_protocols & NFC_PROTO_FELICA_MASK) {
368 		phases |= (1 << 2);	/* Type F 212 */
369 		phases |= (1 << 3);	/* Type F 424 */
370 	}
371 
372 	phases |= (1 << 5);		/* NFC active */
373 
374 	r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
375 			      PN544_PL_RDPHASES, &phases, 1);
376 	if (r < 0)
377 		return r;
378 
379 	if ((im_protocols | tm_protocols) & NFC_PROTO_NFC_DEP_MASK) {
380 		nfc_get_local_general_bytes(hdev->ndev, hdev->gb,
381 					    sizeof(hdev->gb), &hdev->gb_len);
382 		if (hdev->gb_len == 0) {
383 			im_protocols &= ~NFC_PROTO_NFC_DEP_MASK;
384 			tm_protocols &= ~NFC_PROTO_NFC_DEP_MASK;
385 		}
386 	}
387 
388 	if (im_protocols & NFC_PROTO_NFC_DEP_MASK) {
389 		r = nfc_hci_send_event(hdev,
390 				PN544_RF_READER_NFCIP1_INITIATOR_GATE,
391 				NFC_HCI_EVT_END_OPERATION, NULL, 0);
392 		if (r < 0)
393 			return r;
394 
395 		r = nfc_hci_set_param(hdev,
396 				PN544_RF_READER_NFCIP1_INITIATOR_GATE,
397 				PN544_DEP_MODE, &i_mode, 1);
398 		if (r < 0)
399 			return r;
400 
401 		r = nfc_hci_set_param(hdev,
402 				PN544_RF_READER_NFCIP1_INITIATOR_GATE,
403 				PN544_DEP_ATR_REQ, hdev->gb, hdev->gb_len);
404 		if (r < 0)
405 			return r;
406 
407 		r = nfc_hci_send_event(hdev,
408 				PN544_RF_READER_NFCIP1_INITIATOR_GATE,
409 				NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
410 		if (r < 0)
411 			nfc_hci_send_event(hdev,
412 					PN544_RF_READER_NFCIP1_INITIATOR_GATE,
413 					NFC_HCI_EVT_END_OPERATION, NULL, 0);
414 	}
415 
416 	if (tm_protocols & NFC_PROTO_NFC_DEP_MASK) {
417 		r = nfc_hci_set_param(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
418 				PN544_DEP_MODE, &t_mode, 1);
419 		if (r < 0)
420 			return r;
421 
422 		r = nfc_hci_set_param(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
423 				PN544_DEP_ATR_RES, hdev->gb, hdev->gb_len);
424 		if (r < 0)
425 			return r;
426 
427 		r = nfc_hci_set_param(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
428 				PN544_DEP_MERGE, &t_merge, 1);
429 		if (r < 0)
430 			return r;
431 	}
432 
433 	r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
434 			       NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
435 	if (r < 0)
436 		nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
437 				   NFC_HCI_EVT_END_OPERATION, NULL, 0);
438 
439 	return r;
440 }
441 
pn544_hci_dep_link_up(struct nfc_hci_dev * hdev,struct nfc_target * target,u8 comm_mode,u8 * gb,size_t gb_len)442 static int pn544_hci_dep_link_up(struct nfc_hci_dev *hdev,
443 				struct nfc_target *target, u8 comm_mode,
444 				u8 *gb, size_t gb_len)
445 {
446 	struct sk_buff *rgb_skb = NULL;
447 	int r;
448 
449 	r = nfc_hci_get_param(hdev, target->hci_reader_gate,
450 				PN544_DEP_ATR_RES, &rgb_skb);
451 	if (r < 0)
452 		return r;
453 
454 	if (rgb_skb->len == 0 || rgb_skb->len > NFC_GB_MAXSIZE) {
455 		r = -EPROTO;
456 		goto exit;
457 	}
458 	print_hex_dump(KERN_DEBUG, "remote gb: ", DUMP_PREFIX_OFFSET,
459 			16, 1, rgb_skb->data, rgb_skb->len, true);
460 
461 	r = nfc_set_remote_general_bytes(hdev->ndev, rgb_skb->data,
462 						rgb_skb->len);
463 
464 	if (r == 0)
465 		r = nfc_dep_link_is_up(hdev->ndev, target->idx, comm_mode,
466 					NFC_RF_INITIATOR);
467 exit:
468 	kfree_skb(rgb_skb);
469 	return r;
470 }
471 
pn544_hci_dep_link_down(struct nfc_hci_dev * hdev)472 static int pn544_hci_dep_link_down(struct nfc_hci_dev *hdev)
473 {
474 
475 	return nfc_hci_send_event(hdev, PN544_RF_READER_NFCIP1_INITIATOR_GATE,
476 					NFC_HCI_EVT_END_OPERATION, NULL, 0);
477 }
478 
pn544_hci_target_from_gate(struct nfc_hci_dev * hdev,u8 gate,struct nfc_target * target)479 static int pn544_hci_target_from_gate(struct nfc_hci_dev *hdev, u8 gate,
480 				      struct nfc_target *target)
481 {
482 	switch (gate) {
483 	case PN544_RF_READER_F_GATE:
484 		target->supported_protocols = NFC_PROTO_FELICA_MASK;
485 		break;
486 	case PN544_RF_READER_JEWEL_GATE:
487 		target->supported_protocols = NFC_PROTO_JEWEL_MASK;
488 		target->sens_res = 0x0c00;
489 		break;
490 	case PN544_RF_READER_NFCIP1_INITIATOR_GATE:
491 		target->supported_protocols = NFC_PROTO_NFC_DEP_MASK;
492 		break;
493 	default:
494 		return -EPROTO;
495 	}
496 
497 	return 0;
498 }
499 
pn544_hci_complete_target_discovered(struct nfc_hci_dev * hdev,u8 gate,struct nfc_target * target)500 static int pn544_hci_complete_target_discovered(struct nfc_hci_dev *hdev,
501 						u8 gate,
502 						struct nfc_target *target)
503 {
504 	struct sk_buff *uid_skb;
505 	int r = 0;
506 
507 	if (gate == PN544_RF_READER_NFCIP1_INITIATOR_GATE)
508 		return r;
509 
510 	if (target->supported_protocols & NFC_PROTO_NFC_DEP_MASK) {
511 		r = nfc_hci_send_cmd(hdev,
512 			PN544_RF_READER_NFCIP1_INITIATOR_GATE,
513 			PN544_HCI_CMD_CONTINUE_ACTIVATION, NULL, 0, NULL);
514 		if (r < 0)
515 			return r;
516 
517 		target->hci_reader_gate = PN544_RF_READER_NFCIP1_INITIATOR_GATE;
518 	} else if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
519 		if (target->nfcid1_len != 4 && target->nfcid1_len != 7 &&
520 		    target->nfcid1_len != 10)
521 			return -EPROTO;
522 
523 		r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
524 				     PN544_RF_READER_CMD_ACTIVATE_NEXT,
525 				     target->nfcid1, target->nfcid1_len, NULL);
526 	} else if (target->supported_protocols & NFC_PROTO_FELICA_MASK) {
527 		r = nfc_hci_get_param(hdev, PN544_RF_READER_F_GATE,
528 				      PN544_FELICA_ID, &uid_skb);
529 		if (r < 0)
530 			return r;
531 
532 		if (uid_skb->len != 8) {
533 			kfree_skb(uid_skb);
534 			return -EPROTO;
535 		}
536 
537 		/* Type F NFC-DEP IDm has prefix 0x01FE */
538 		if ((uid_skb->data[0] == 0x01) && (uid_skb->data[1] == 0xfe)) {
539 			kfree_skb(uid_skb);
540 			r = nfc_hci_send_cmd(hdev,
541 					PN544_RF_READER_NFCIP1_INITIATOR_GATE,
542 					PN544_HCI_CMD_CONTINUE_ACTIVATION,
543 					NULL, 0, NULL);
544 			if (r < 0)
545 				return r;
546 
547 			target->supported_protocols = NFC_PROTO_NFC_DEP_MASK;
548 			target->hci_reader_gate =
549 				PN544_RF_READER_NFCIP1_INITIATOR_GATE;
550 		} else {
551 			r = nfc_hci_send_cmd(hdev, PN544_RF_READER_F_GATE,
552 					     PN544_RF_READER_CMD_ACTIVATE_NEXT,
553 					     uid_skb->data, uid_skb->len, NULL);
554 			kfree_skb(uid_skb);
555 		}
556 	} else if (target->supported_protocols & NFC_PROTO_ISO14443_MASK) {
557 		/*
558 		 * TODO: maybe other ISO 14443 require some kind of continue
559 		 * activation, but for now we've seen only this one below.
560 		 */
561 		if (target->sens_res == 0x4403)	/* Type 4 Mifare DESFire */
562 			r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
563 			      PN544_RF_READER_A_CMD_CONTINUE_ACTIVATION,
564 			      NULL, 0, NULL);
565 	}
566 
567 	return r;
568 }
569 
570 #define PN544_CB_TYPE_READER_F 1
571 
pn544_hci_data_exchange_cb(void * context,struct sk_buff * skb,int err)572 static void pn544_hci_data_exchange_cb(void *context, struct sk_buff *skb,
573 				       int err)
574 {
575 	struct pn544_hci_info *info = context;
576 
577 	switch (info->async_cb_type) {
578 	case PN544_CB_TYPE_READER_F:
579 		if (err == 0)
580 			skb_pull(skb, 1);
581 		info->async_cb(info->async_cb_context, skb, err);
582 		break;
583 	default:
584 		if (err == 0)
585 			kfree_skb(skb);
586 		break;
587 	}
588 }
589 
590 #define MIFARE_CMD_AUTH_KEY_A	0x60
591 #define MIFARE_CMD_AUTH_KEY_B	0x61
592 #define MIFARE_CMD_HEADER	2
593 #define MIFARE_UID_LEN		4
594 #define MIFARE_KEY_LEN		6
595 #define MIFARE_CMD_LEN		12
596 /*
597  * Returns:
598  * <= 0: driver handled the data exchange
599  *    1: driver doesn't especially handle, please do standard processing
600  */
pn544_hci_im_transceive(struct nfc_hci_dev * hdev,struct nfc_target * target,struct sk_buff * skb,data_exchange_cb_t cb,void * cb_context)601 static int pn544_hci_im_transceive(struct nfc_hci_dev *hdev,
602 				   struct nfc_target *target,
603 				   struct sk_buff *skb, data_exchange_cb_t cb,
604 				   void *cb_context)
605 {
606 	struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
607 
608 	pr_info(DRIVER_DESC ": %s for gate=%d\n", __func__,
609 		target->hci_reader_gate);
610 
611 	switch (target->hci_reader_gate) {
612 	case NFC_HCI_RF_READER_A_GATE:
613 		if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
614 			/*
615 			 * It seems that pn544 is inverting key and UID for
616 			 * MIFARE authentication commands.
617 			 */
618 			if (skb->len == MIFARE_CMD_LEN &&
619 			    (skb->data[0] == MIFARE_CMD_AUTH_KEY_A ||
620 			     skb->data[0] == MIFARE_CMD_AUTH_KEY_B)) {
621 				u8 uid[MIFARE_UID_LEN];
622 				u8 *data = skb->data + MIFARE_CMD_HEADER;
623 
624 				memcpy(uid, data + MIFARE_KEY_LEN,
625 				       MIFARE_UID_LEN);
626 				memmove(data + MIFARE_UID_LEN, data,
627 					MIFARE_KEY_LEN);
628 				memcpy(data, uid, MIFARE_UID_LEN);
629 			}
630 
631 			return nfc_hci_send_cmd_async(hdev,
632 						      target->hci_reader_gate,
633 						      PN544_MIFARE_CMD,
634 						      skb->data, skb->len,
635 						      cb, cb_context);
636 		} else
637 			return 1;
638 	case PN544_RF_READER_F_GATE:
639 		*(u8 *)skb_push(skb, 1) = 0;
640 		*(u8 *)skb_push(skb, 1) = 0;
641 
642 		info->async_cb_type = PN544_CB_TYPE_READER_F;
643 		info->async_cb = cb;
644 		info->async_cb_context = cb_context;
645 
646 		return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
647 					      PN544_FELICA_RAW, skb->data,
648 					      skb->len,
649 					      pn544_hci_data_exchange_cb, info);
650 	case PN544_RF_READER_JEWEL_GATE:
651 		return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
652 					      PN544_JEWEL_RAW_CMD, skb->data,
653 					      skb->len, cb, cb_context);
654 	case PN544_RF_READER_NFCIP1_INITIATOR_GATE:
655 		*(u8 *)skb_push(skb, 1) = 0;
656 
657 		return nfc_hci_send_event(hdev, target->hci_reader_gate,
658 					PN544_HCI_EVT_SND_DATA, skb->data,
659 					skb->len);
660 	default:
661 		return 1;
662 	}
663 }
664 
pn544_hci_tm_send(struct nfc_hci_dev * hdev,struct sk_buff * skb)665 static int pn544_hci_tm_send(struct nfc_hci_dev *hdev, struct sk_buff *skb)
666 {
667 	int r;
668 
669 	/* Set default false for multiple information chaining */
670 	*(u8 *)skb_push(skb, 1) = 0;
671 
672 	r = nfc_hci_send_event(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
673 			       PN544_HCI_EVT_SND_DATA, skb->data, skb->len);
674 
675 	kfree_skb(skb);
676 
677 	return r;
678 }
679 
pn544_hci_check_presence(struct nfc_hci_dev * hdev,struct nfc_target * target)680 static int pn544_hci_check_presence(struct nfc_hci_dev *hdev,
681 				   struct nfc_target *target)
682 {
683 	pr_debug("supported protocol %d\n", target->supported_protocols);
684 	if (target->supported_protocols & (NFC_PROTO_ISO14443_MASK |
685 					NFC_PROTO_ISO14443_B_MASK)) {
686 		return nfc_hci_send_cmd(hdev, target->hci_reader_gate,
687 					PN544_RF_READER_CMD_PRESENCE_CHECK,
688 					NULL, 0, NULL);
689 	} else if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
690 		if (target->nfcid1_len != 4 && target->nfcid1_len != 7 &&
691 		    target->nfcid1_len != 10)
692 			return -EOPNOTSUPP;
693 
694 		return nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
695 				     PN544_RF_READER_CMD_ACTIVATE_NEXT,
696 				     target->nfcid1, target->nfcid1_len, NULL);
697 	} else if (target->supported_protocols & (NFC_PROTO_JEWEL_MASK |
698 						NFC_PROTO_FELICA_MASK)) {
699 		return -EOPNOTSUPP;
700 	} else if (target->supported_protocols & NFC_PROTO_NFC_DEP_MASK) {
701 		return nfc_hci_send_cmd(hdev, target->hci_reader_gate,
702 					PN544_HCI_CMD_ATTREQUEST,
703 					NULL, 0, NULL);
704 	}
705 
706 	return 0;
707 }
708 
709 /*
710  * Returns:
711  * <= 0: driver handled the event, skb consumed
712  *    1: driver does not handle the event, please do standard processing
713  */
pn544_hci_event_received(struct nfc_hci_dev * hdev,u8 pipe,u8 event,struct sk_buff * skb)714 static int pn544_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
715 				    struct sk_buff *skb)
716 {
717 	struct sk_buff *rgb_skb = NULL;
718 	u8 gate = hdev->pipes[pipe].gate;
719 	int r;
720 
721 	pr_debug("hci event %d\n", event);
722 	switch (event) {
723 	case PN544_HCI_EVT_ACTIVATED:
724 		if (gate == PN544_RF_READER_NFCIP1_INITIATOR_GATE) {
725 			r = nfc_hci_target_discovered(hdev, gate);
726 		} else if (gate == PN544_RF_READER_NFCIP1_TARGET_GATE) {
727 			r = nfc_hci_get_param(hdev, gate, PN544_DEP_ATR_REQ,
728 					      &rgb_skb);
729 			if (r < 0)
730 				goto exit;
731 
732 			r = nfc_tm_activated(hdev->ndev, NFC_PROTO_NFC_DEP_MASK,
733 					     NFC_COMM_PASSIVE, rgb_skb->data,
734 					     rgb_skb->len);
735 
736 			kfree_skb(rgb_skb);
737 		} else {
738 			r = -EINVAL;
739 		}
740 		break;
741 	case PN544_HCI_EVT_DEACTIVATED:
742 		r = nfc_hci_send_event(hdev, gate, NFC_HCI_EVT_END_OPERATION,
743 				       NULL, 0);
744 		break;
745 	case PN544_HCI_EVT_RCV_DATA:
746 		if (skb->len < 2) {
747 			r = -EPROTO;
748 			goto exit;
749 		}
750 
751 		if (skb->data[0] != 0) {
752 			pr_debug("data0 %d\n", skb->data[0]);
753 			r = -EPROTO;
754 			goto exit;
755 		}
756 
757 		skb_pull(skb, 2);
758 		return nfc_tm_data_received(hdev->ndev, skb);
759 	default:
760 		return 1;
761 	}
762 
763 exit:
764 	kfree_skb(skb);
765 
766 	return r;
767 }
768 
pn544_hci_fw_download(struct nfc_hci_dev * hdev,const char * firmware_name)769 static int pn544_hci_fw_download(struct nfc_hci_dev *hdev,
770 				 const char *firmware_name)
771 {
772 	struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
773 
774 	if (info->fw_download == NULL)
775 		return -ENOTSUPP;
776 
777 	return info->fw_download(info->phy_id, firmware_name, hdev->sw_romlib);
778 }
779 
pn544_hci_discover_se(struct nfc_hci_dev * hdev)780 static int pn544_hci_discover_se(struct nfc_hci_dev *hdev)
781 {
782 	u32 se_idx = 0;
783 	u8 ese_mode = 0x01; /* Default mode */
784 	struct sk_buff *res_skb;
785 	int r;
786 
787 	r = nfc_hci_send_cmd(hdev, PN544_SYS_MGMT_GATE, PN544_TEST_SWP,
788 			     NULL, 0, &res_skb);
789 
790 	if (r == 0) {
791 		if (res_skb->len == 2 && res_skb->data[0] == 0x00)
792 			nfc_add_se(hdev->ndev, se_idx++, NFC_SE_UICC);
793 
794 		kfree_skb(res_skb);
795 	}
796 
797 	r = nfc_hci_send_event(hdev, PN544_NFC_WI_MGMT_GATE,
798 				PN544_HCI_EVT_SWITCH_MODE,
799 				&ese_mode, 1);
800 	if (r == 0)
801 		nfc_add_se(hdev->ndev, se_idx++, NFC_SE_EMBEDDED);
802 
803 	return !se_idx;
804 }
805 
806 #define PN544_SE_MODE_OFF	0x00
807 #define PN544_SE_MODE_ON	0x01
pn544_hci_enable_se(struct nfc_hci_dev * hdev,u32 se_idx)808 static int pn544_hci_enable_se(struct nfc_hci_dev *hdev, u32 se_idx)
809 {
810 	const struct nfc_se *se;
811 	u8 enable = PN544_SE_MODE_ON;
812 	static struct uicc_gatelist {
813 		u8 head;
814 		u8 adr[2];
815 		u8 value;
816 	} uicc_gatelist[] = {
817 		{0x00, {0x9e, 0xd9}, 0x23},
818 		{0x00, {0x9e, 0xda}, 0x21},
819 		{0x00, {0x9e, 0xdb}, 0x22},
820 		{0x00, {0x9e, 0xdc}, 0x24},
821 	};
822 	struct uicc_gatelist *p = uicc_gatelist;
823 	int count = ARRAY_SIZE(uicc_gatelist);
824 	struct sk_buff *res_skb;
825 	int r;
826 
827 	se = nfc_find_se(hdev->ndev, se_idx);
828 
829 	switch (se->type) {
830 	case NFC_SE_UICC:
831 		while (count--) {
832 			r = nfc_hci_send_cmd(hdev, PN544_SYS_MGMT_GATE,
833 					PN544_WRITE, (u8 *)p, 4, &res_skb);
834 			if (r < 0)
835 				return r;
836 
837 			if (res_skb->len != 1) {
838 				kfree_skb(res_skb);
839 				return -EPROTO;
840 			}
841 
842 			if (res_skb->data[0] != p->value) {
843 				kfree_skb(res_skb);
844 				return -EIO;
845 			}
846 
847 			kfree_skb(res_skb);
848 
849 			p++;
850 		}
851 
852 		return nfc_hci_set_param(hdev, PN544_SWP_MGMT_GATE,
853 			      PN544_SWP_DEFAULT_MODE, &enable, 1);
854 	case NFC_SE_EMBEDDED:
855 		return nfc_hci_set_param(hdev, PN544_NFC_WI_MGMT_GATE,
856 			      PN544_NFC_ESE_DEFAULT_MODE, &enable, 1);
857 
858 	default:
859 		return -EINVAL;
860 	}
861 }
862 
pn544_hci_disable_se(struct nfc_hci_dev * hdev,u32 se_idx)863 static int pn544_hci_disable_se(struct nfc_hci_dev *hdev, u32 se_idx)
864 {
865 	const struct nfc_se *se;
866 	u8 disable = PN544_SE_MODE_OFF;
867 
868 	se = nfc_find_se(hdev->ndev, se_idx);
869 
870 	switch (se->type) {
871 	case NFC_SE_UICC:
872 		return nfc_hci_set_param(hdev, PN544_SWP_MGMT_GATE,
873 			      PN544_SWP_DEFAULT_MODE, &disable, 1);
874 	case NFC_SE_EMBEDDED:
875 		return nfc_hci_set_param(hdev, PN544_NFC_WI_MGMT_GATE,
876 			      PN544_NFC_ESE_DEFAULT_MODE, &disable, 1);
877 	default:
878 		return -EINVAL;
879 	}
880 }
881 
882 static const struct nfc_hci_ops pn544_hci_ops = {
883 	.open = pn544_hci_open,
884 	.close = pn544_hci_close,
885 	.hci_ready = pn544_hci_ready,
886 	.xmit = pn544_hci_xmit,
887 	.start_poll = pn544_hci_start_poll,
888 	.dep_link_up = pn544_hci_dep_link_up,
889 	.dep_link_down = pn544_hci_dep_link_down,
890 	.target_from_gate = pn544_hci_target_from_gate,
891 	.complete_target_discovered = pn544_hci_complete_target_discovered,
892 	.im_transceive = pn544_hci_im_transceive,
893 	.tm_send = pn544_hci_tm_send,
894 	.check_presence = pn544_hci_check_presence,
895 	.event_received = pn544_hci_event_received,
896 	.fw_download = pn544_hci_fw_download,
897 	.discover_se = pn544_hci_discover_se,
898 	.enable_se = pn544_hci_enable_se,
899 	.disable_se = pn544_hci_disable_se,
900 };
901 
pn544_hci_probe(void * phy_id,const struct nfc_phy_ops * phy_ops,char * llc_name,int phy_headroom,int phy_tailroom,int phy_payload,fw_download_t fw_download,struct nfc_hci_dev ** hdev)902 int pn544_hci_probe(void *phy_id, const struct nfc_phy_ops *phy_ops,
903 		    char *llc_name, int phy_headroom, int phy_tailroom,
904 		    int phy_payload, fw_download_t fw_download,
905 		    struct nfc_hci_dev **hdev)
906 {
907 	struct pn544_hci_info *info;
908 	u32 protocols;
909 	struct nfc_hci_init_data init_data;
910 	int r;
911 
912 	info = kzalloc_obj(struct pn544_hci_info);
913 	if (!info) {
914 		r = -ENOMEM;
915 		goto err_info_alloc;
916 	}
917 
918 	info->phy_ops = phy_ops;
919 	info->phy_id = phy_id;
920 	info->fw_download = fw_download;
921 	info->state = PN544_ST_COLD;
922 	mutex_init(&info->info_lock);
923 
924 	init_data.gate_count = ARRAY_SIZE(pn544_gates);
925 
926 	memcpy(init_data.gates, pn544_gates, sizeof(pn544_gates));
927 
928 	/*
929 	 * TODO: Session id must include the driver name + some bus addr
930 	 * persistent info to discriminate 2 identical chips
931 	 */
932 	strcpy(init_data.session_id, "ID544HCI");
933 
934 	protocols = NFC_PROTO_JEWEL_MASK |
935 		    NFC_PROTO_MIFARE_MASK |
936 		    NFC_PROTO_FELICA_MASK |
937 		    NFC_PROTO_ISO14443_MASK |
938 		    NFC_PROTO_ISO14443_B_MASK |
939 		    NFC_PROTO_NFC_DEP_MASK;
940 
941 	info->hdev = nfc_hci_allocate_device(&pn544_hci_ops, &init_data, 0,
942 					     protocols, llc_name,
943 					     phy_headroom + PN544_CMDS_HEADROOM,
944 					     phy_tailroom, phy_payload);
945 	if (!info->hdev) {
946 		pr_err("Cannot allocate nfc hdev\n");
947 		r = -ENOMEM;
948 		goto err_alloc_hdev;
949 	}
950 
951 	nfc_hci_set_clientdata(info->hdev, info);
952 
953 	r = nfc_hci_register_device(info->hdev);
954 	if (r)
955 		goto err_regdev;
956 
957 	*hdev = info->hdev;
958 
959 	return 0;
960 
961 err_regdev:
962 	nfc_hci_free_device(info->hdev);
963 
964 err_alloc_hdev:
965 	kfree(info);
966 
967 err_info_alloc:
968 	return r;
969 }
970 EXPORT_SYMBOL(pn544_hci_probe);
971 
pn544_hci_remove(struct nfc_hci_dev * hdev)972 void pn544_hci_remove(struct nfc_hci_dev *hdev)
973 {
974 	struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
975 
976 	nfc_hci_unregister_device(hdev);
977 	nfc_hci_free_device(hdev);
978 	kfree(info);
979 }
980 EXPORT_SYMBOL(pn544_hci_remove);
981 
982 MODULE_LICENSE("GPL");
983 MODULE_DESCRIPTION(DRIVER_DESC);
984