blob: 078e62feba1715e9c4cc3bfd246e6c947082735b [file] [log] [blame]
Eric Lapuyadebbed0de2012-05-07 12:31:29 +02001/*
2 * HCI based Driver for NXP PN544 NFC Chip
3 *
4 * Copyright (C) 2012 Intel Corporation. All rights reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the
17 * Free Software Foundation, Inc.,
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 */
20
Eric Lapuyadebbed0de2012-05-07 12:31:29 +020021#include <linux/delay.h>
22#include <linux/slab.h>
Samuel Ortizaa741032012-12-18 16:26:23 +010023#include <linux/module.h>
Eric Lapuyadebbed0de2012-05-07 12:31:29 +020024
25#include <linux/nfc.h>
26#include <net/nfc/hci.h>
Eric Lapuyade412fda52012-09-18 19:45:48 +020027#include <net/nfc/llc.h>
Eric Lapuyadebbed0de2012-05-07 12:31:29 +020028
Eric Lapuyade97f18412012-10-02 18:44:06 +020029#include "pn544.h"
Eric Lapuyadebbed0de2012-05-07 12:31:29 +020030
31/* Timing restrictions (ms) */
32#define PN544_HCI_RESETVEN_TIME 30
33
Eric Lapuyadebbed0de2012-05-07 12:31:29 +020034enum pn544_state {
35 PN544_ST_COLD,
36 PN544_ST_FW_READY,
37 PN544_ST_READY,
38};
39
40#define FULL_VERSION_LEN 11
41
42/* Proprietary commands */
43#define PN544_WRITE 0x3f
44
45/* Proprietary gates, events, commands and registers */
46
47/* NFC_HCI_RF_READER_A_GATE additional registers and commands */
48#define PN544_RF_READER_A_AUTO_ACTIVATION 0x10
49#define PN544_RF_READER_A_CMD_CONTINUE_ACTIVATION 0x12
50#define PN544_MIFARE_CMD 0x21
51
52/* Commands that apply to all RF readers */
53#define PN544_RF_READER_CMD_PRESENCE_CHECK 0x30
54#define PN544_RF_READER_CMD_ACTIVATE_NEXT 0x32
55
56/* NFC_HCI_ID_MGMT_GATE additional registers */
57#define PN544_ID_MGMT_FULL_VERSION_SW 0x10
58
59#define PN544_RF_READER_ISO15693_GATE 0x12
60
61#define PN544_RF_READER_F_GATE 0x14
62#define PN544_FELICA_ID 0x04
63#define PN544_FELICA_RAW 0x20
64
65#define PN544_RF_READER_JEWEL_GATE 0x15
66#define PN544_JEWEL_RAW_CMD 0x23
67
68#define PN544_RF_READER_NFCIP1_INITIATOR_GATE 0x30
69#define PN544_RF_READER_NFCIP1_TARGET_GATE 0x31
70
71#define PN544_SYS_MGMT_GATE 0x90
72#define PN544_SYS_MGMT_INFO_NOTIFICATION 0x02
73
74#define PN544_POLLING_LOOP_MGMT_GATE 0x94
Arron Wang7e2afc92012-09-27 17:32:54 +080075#define PN544_DEP_MODE 0x01
76#define PN544_DEP_ATR_REQ 0x02
77#define PN544_DEP_ATR_RES 0x03
78#define PN544_DEP_MERGE 0x0D
Eric Lapuyadebbed0de2012-05-07 12:31:29 +020079#define PN544_PL_RDPHASES 0x06
80#define PN544_PL_EMULATION 0x07
81#define PN544_PL_NFCT_DEACTIVATED 0x09
82
83#define PN544_SWP_MGMT_GATE 0xA0
84
85#define PN544_NFC_WI_MGMT_GATE 0xA1
86
Arron Wangf7a5f6c2012-09-27 17:32:55 +080087#define PN544_HCI_EVT_SND_DATA 0x01
88#define PN544_HCI_EVT_ACTIVATED 0x02
89#define PN544_HCI_EVT_DEACTIVATED 0x03
90#define PN544_HCI_EVT_RCV_DATA 0x04
91#define PN544_HCI_EVT_CONTINUE_MI 0x05
92
Arron Wangda052852012-09-27 17:32:59 +080093#define PN544_HCI_CMD_ATTREQUEST 0x12
Arron Wang928326f2012-09-27 17:32:56 +080094#define PN544_HCI_CMD_CONTINUE_ACTIVATION 0x13
95
Eric Lapuyadea10d5952012-06-05 14:42:11 +020096static struct nfc_hci_gate pn544_gates[] = {
97 {NFC_HCI_ADMIN_GATE, NFC_HCI_INVALID_PIPE},
98 {NFC_HCI_LOOPBACK_GATE, NFC_HCI_INVALID_PIPE},
99 {NFC_HCI_ID_MGMT_GATE, NFC_HCI_INVALID_PIPE},
100 {NFC_HCI_LINK_MGMT_GATE, NFC_HCI_INVALID_PIPE},
101 {NFC_HCI_RF_READER_B_GATE, NFC_HCI_INVALID_PIPE},
102 {NFC_HCI_RF_READER_A_GATE, NFC_HCI_INVALID_PIPE},
103 {PN544_SYS_MGMT_GATE, NFC_HCI_INVALID_PIPE},
104 {PN544_SWP_MGMT_GATE, NFC_HCI_INVALID_PIPE},
105 {PN544_POLLING_LOOP_MGMT_GATE, NFC_HCI_INVALID_PIPE},
106 {PN544_NFC_WI_MGMT_GATE, NFC_HCI_INVALID_PIPE},
107 {PN544_RF_READER_F_GATE, NFC_HCI_INVALID_PIPE},
108 {PN544_RF_READER_JEWEL_GATE, NFC_HCI_INVALID_PIPE},
109 {PN544_RF_READER_ISO15693_GATE, NFC_HCI_INVALID_PIPE},
110 {PN544_RF_READER_NFCIP1_INITIATOR_GATE, NFC_HCI_INVALID_PIPE},
111 {PN544_RF_READER_NFCIP1_TARGET_GATE, NFC_HCI_INVALID_PIPE}
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200112};
113
114/* Largest headroom needed for outgoing custom commands */
115#define PN544_CMDS_HEADROOM 2
116
117struct pn544_hci_info {
Eric Lapuyade97f18412012-10-02 18:44:06 +0200118 struct nfc_phy_ops *phy_ops;
119 void *phy_id;
120
Eric Lapuyade412fda52012-09-18 19:45:48 +0200121 struct nfc_hci_dev *hdev;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200122
123 enum pn544_state state;
124
125 struct mutex info_lock;
126
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200127 int async_cb_type;
128 data_exchange_cb_t async_cb;
129 void *async_cb_context;
Eric Lapuyade8bd7fc82013-07-19 14:58:39 +0200130
131 fw_download_t fw_download;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200132};
133
Eric Lapuyade412fda52012-09-18 19:45:48 +0200134static int pn544_hci_open(struct nfc_hci_dev *hdev)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200135{
Eric Lapuyade412fda52012-09-18 19:45:48 +0200136 struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200137 int r = 0;
138
139 mutex_lock(&info->info_lock);
140
141 if (info->state != PN544_ST_COLD) {
142 r = -EBUSY;
143 goto out;
144 }
145
Eric Lapuyade97f18412012-10-02 18:44:06 +0200146 r = info->phy_ops->enable(info->phy_id);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200147
Eric Lapuyadeeae202a2012-05-30 18:13:06 +0200148 if (r == 0)
149 info->state = PN544_ST_READY;
150
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200151out:
152 mutex_unlock(&info->info_lock);
153 return r;
154}
155
Eric Lapuyade412fda52012-09-18 19:45:48 +0200156static void pn544_hci_close(struct nfc_hci_dev *hdev)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200157{
Eric Lapuyade412fda52012-09-18 19:45:48 +0200158 struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200159
160 mutex_lock(&info->info_lock);
161
162 if (info->state == PN544_ST_COLD)
163 goto out;
164
Eric Lapuyade97f18412012-10-02 18:44:06 +0200165 info->phy_ops->disable(info->phy_id);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200166
Eric Lapuyadeeae202a2012-05-30 18:13:06 +0200167 info->state = PN544_ST_COLD;
168
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200169out:
170 mutex_unlock(&info->info_lock);
171}
172
Eric Lapuyade412fda52012-09-18 19:45:48 +0200173static int pn544_hci_ready(struct nfc_hci_dev *hdev)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200174{
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200175 struct sk_buff *skb;
176 static struct hw_config {
177 u8 adr[2];
178 u8 value;
179 } hw_config[] = {
180 {{0x9f, 0x9a}, 0x00},
181
182 {{0x98, 0x10}, 0xbc},
183
184 {{0x9e, 0x71}, 0x00},
185
186 {{0x98, 0x09}, 0x00},
187
188 {{0x9e, 0xb4}, 0x00},
189
190 {{0x9e, 0xd9}, 0xff},
191 {{0x9e, 0xda}, 0xff},
192 {{0x9e, 0xdb}, 0x23},
193 {{0x9e, 0xdc}, 0x21},
194 {{0x9e, 0xdd}, 0x22},
195 {{0x9e, 0xde}, 0x24},
196
197 {{0x9c, 0x01}, 0x08},
198
199 {{0x9e, 0xaa}, 0x01},
200
201 {{0x9b, 0xd1}, 0x0d},
202 {{0x9b, 0xd2}, 0x24},
203 {{0x9b, 0xd3}, 0x0a},
204 {{0x9b, 0xd4}, 0x22},
205 {{0x9b, 0xd5}, 0x08},
206 {{0x9b, 0xd6}, 0x1e},
207 {{0x9b, 0xdd}, 0x1c},
208
209 {{0x9b, 0x84}, 0x13},
210 {{0x99, 0x81}, 0x7f},
211 {{0x99, 0x31}, 0x70},
212
213 {{0x98, 0x00}, 0x3f},
214
215 {{0x9f, 0x09}, 0x00},
216
217 {{0x9f, 0x0a}, 0x05},
218
219 {{0x9e, 0xd1}, 0xa1},
220 {{0x99, 0x23}, 0x00},
221
222 {{0x9e, 0x74}, 0x80},
223
224 {{0x9f, 0x28}, 0x10},
225
226 {{0x9f, 0x35}, 0x14},
227
228 {{0x9f, 0x36}, 0x60},
229
230 {{0x9c, 0x31}, 0x00},
231
232 {{0x9c, 0x32}, 0xc8},
233
234 {{0x9c, 0x19}, 0x40},
235
236 {{0x9c, 0x1a}, 0x40},
237
238 {{0x9c, 0x0c}, 0x00},
239
240 {{0x9c, 0x0d}, 0x00},
241
242 {{0x9c, 0x12}, 0x00},
243
244 {{0x9c, 0x13}, 0x00},
245
246 {{0x98, 0xa2}, 0x0e},
247
248 {{0x98, 0x93}, 0x40},
249
250 {{0x98, 0x7d}, 0x02},
251 {{0x98, 0x7e}, 0x00},
252 {{0x9f, 0xc8}, 0x01},
253 };
254 struct hw_config *p = hw_config;
255 int count = ARRAY_SIZE(hw_config);
256 struct sk_buff *res_skb;
257 u8 param[4];
258 int r;
259
260 param[0] = 0;
261 while (count--) {
262 param[1] = p->adr[0];
263 param[2] = p->adr[1];
264 param[3] = p->value;
265
266 r = nfc_hci_send_cmd(hdev, PN544_SYS_MGMT_GATE, PN544_WRITE,
267 param, 4, &res_skb);
268 if (r < 0)
269 return r;
270
271 if (res_skb->len != 1) {
272 kfree_skb(res_skb);
273 return -EPROTO;
274 }
275
276 if (res_skb->data[0] != p->value) {
277 kfree_skb(res_skb);
278 return -EIO;
279 }
280
281 kfree_skb(res_skb);
282
283 p++;
284 }
285
286 param[0] = NFC_HCI_UICC_HOST_ID;
287 r = nfc_hci_set_param(hdev, NFC_HCI_ADMIN_GATE,
288 NFC_HCI_ADMIN_WHITELIST, param, 1);
289 if (r < 0)
290 return r;
291
292 param[0] = 0x3d;
293 r = nfc_hci_set_param(hdev, PN544_SYS_MGMT_GATE,
294 PN544_SYS_MGMT_INFO_NOTIFICATION, param, 1);
295 if (r < 0)
296 return r;
297
298 param[0] = 0x0;
299 r = nfc_hci_set_param(hdev, NFC_HCI_RF_READER_A_GATE,
300 PN544_RF_READER_A_AUTO_ACTIVATION, param, 1);
301 if (r < 0)
302 return r;
303
304 r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
305 NFC_HCI_EVT_END_OPERATION, NULL, 0);
306 if (r < 0)
307 return r;
308
309 param[0] = 0x1;
310 r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
311 PN544_PL_NFCT_DEACTIVATED, param, 1);
312 if (r < 0)
313 return r;
314
315 param[0] = 0x0;
316 r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
317 PN544_PL_RDPHASES, param, 1);
318 if (r < 0)
319 return r;
320
321 r = nfc_hci_get_param(hdev, NFC_HCI_ID_MGMT_GATE,
322 PN544_ID_MGMT_FULL_VERSION_SW, &skb);
323 if (r < 0)
324 return r;
325
326 if (skb->len != FULL_VERSION_LEN) {
327 kfree_skb(skb);
328 return -EINVAL;
329 }
330
331 print_hex_dump(KERN_DEBUG, "FULL VERSION SOFTWARE INFO: ",
332 DUMP_PREFIX_NONE, 16, 1,
333 skb->data, FULL_VERSION_LEN, false);
334
335 kfree_skb(skb);
336
337 return 0;
338}
339
Eric Lapuyade412fda52012-09-18 19:45:48 +0200340static int pn544_hci_xmit(struct nfc_hci_dev *hdev, struct sk_buff *skb)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200341{
Eric Lapuyade412fda52012-09-18 19:45:48 +0200342 struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200343
Eric Lapuyade97f18412012-10-02 18:44:06 +0200344 return info->phy_ops->write(info->phy_id, skb);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200345}
346
Eric Lapuyade412fda52012-09-18 19:45:48 +0200347static int pn544_hci_start_poll(struct nfc_hci_dev *hdev,
Samuel Ortizfe7c5802012-05-15 15:57:06 +0200348 u32 im_protocols, u32 tm_protocols)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200349{
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200350 u8 phases = 0;
351 int r;
352 u8 duration[2];
353 u8 activated;
Arron Wang7e2afc92012-09-27 17:32:54 +0800354 u8 i_mode = 0x3f; /* Enable all supported modes */
355 u8 t_mode = 0x0f;
356 u8 t_merge = 0x01; /* Enable merge by default */
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200357
Samuel Ortizfe7c5802012-05-15 15:57:06 +0200358 pr_info(DRIVER_DESC ": %s protocols 0x%x 0x%x\n",
359 __func__, im_protocols, tm_protocols);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200360
361 r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
362 NFC_HCI_EVT_END_OPERATION, NULL, 0);
363 if (r < 0)
364 return r;
365
366 duration[0] = 0x18;
367 duration[1] = 0x6a;
368 r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
369 PN544_PL_EMULATION, duration, 2);
370 if (r < 0)
371 return r;
372
373 activated = 0;
374 r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
375 PN544_PL_NFCT_DEACTIVATED, &activated, 1);
376 if (r < 0)
377 return r;
378
Samuel Ortizfe7c5802012-05-15 15:57:06 +0200379 if (im_protocols & (NFC_PROTO_ISO14443_MASK | NFC_PROTO_MIFARE_MASK |
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200380 NFC_PROTO_JEWEL_MASK))
381 phases |= 1; /* Type A */
Samuel Ortizfe7c5802012-05-15 15:57:06 +0200382 if (im_protocols & NFC_PROTO_FELICA_MASK) {
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200383 phases |= (1 << 2); /* Type F 212 */
384 phases |= (1 << 3); /* Type F 424 */
385 }
386
387 phases |= (1 << 5); /* NFC active */
388
389 r = nfc_hci_set_param(hdev, PN544_POLLING_LOOP_MGMT_GATE,
390 PN544_PL_RDPHASES, &phases, 1);
391 if (r < 0)
392 return r;
393
Arron Wang7e2afc92012-09-27 17:32:54 +0800394 if ((im_protocols | tm_protocols) & NFC_PROTO_NFC_DEP_MASK) {
395 hdev->gb = nfc_get_local_general_bytes(hdev->ndev,
396 &hdev->gb_len);
397 pr_debug("generate local bytes %p", hdev->gb);
398 if (hdev->gb == NULL || hdev->gb_len == 0) {
399 im_protocols &= ~NFC_PROTO_NFC_DEP_MASK;
400 tm_protocols &= ~NFC_PROTO_NFC_DEP_MASK;
401 }
402 }
403
404 if (im_protocols & NFC_PROTO_NFC_DEP_MASK) {
405 r = nfc_hci_send_event(hdev,
406 PN544_RF_READER_NFCIP1_INITIATOR_GATE,
407 NFC_HCI_EVT_END_OPERATION, NULL, 0);
408 if (r < 0)
409 return r;
410
411 r = nfc_hci_set_param(hdev,
412 PN544_RF_READER_NFCIP1_INITIATOR_GATE,
413 PN544_DEP_MODE, &i_mode, 1);
414 if (r < 0)
415 return r;
416
417 r = nfc_hci_set_param(hdev,
418 PN544_RF_READER_NFCIP1_INITIATOR_GATE,
419 PN544_DEP_ATR_REQ, hdev->gb, hdev->gb_len);
420 if (r < 0)
421 return r;
422
423 r = nfc_hci_send_event(hdev,
424 PN544_RF_READER_NFCIP1_INITIATOR_GATE,
425 NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
426 if (r < 0)
427 nfc_hci_send_event(hdev,
428 PN544_RF_READER_NFCIP1_INITIATOR_GATE,
429 NFC_HCI_EVT_END_OPERATION, NULL, 0);
430 }
431
432 if (tm_protocols & NFC_PROTO_NFC_DEP_MASK) {
433 r = nfc_hci_set_param(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
434 PN544_DEP_MODE, &t_mode, 1);
435 if (r < 0)
436 return r;
437
438 r = nfc_hci_set_param(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
439 PN544_DEP_ATR_RES, hdev->gb, hdev->gb_len);
440 if (r < 0)
441 return r;
442
443 r = nfc_hci_set_param(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
444 PN544_DEP_MERGE, &t_merge, 1);
445 if (r < 0)
446 return r;
447 }
448
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200449 r = nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
450 NFC_HCI_EVT_READER_REQUESTED, NULL, 0);
451 if (r < 0)
452 nfc_hci_send_event(hdev, NFC_HCI_RF_READER_A_GATE,
453 NFC_HCI_EVT_END_OPERATION, NULL, 0);
454
455 return r;
456}
457
Arron Wangc40d1742012-09-27 17:32:57 +0800458static int pn544_hci_dep_link_up(struct nfc_hci_dev *hdev,
459 struct nfc_target *target, u8 comm_mode,
460 u8 *gb, size_t gb_len)
461{
462 struct sk_buff *rgb_skb = NULL;
463 int r;
464
465 r = nfc_hci_get_param(hdev, target->hci_reader_gate,
466 PN544_DEP_ATR_RES, &rgb_skb);
467 if (r < 0)
468 return r;
469
470 if (rgb_skb->len == 0 || rgb_skb->len > NFC_GB_MAXSIZE) {
471 r = -EPROTO;
472 goto exit;
473 }
474 print_hex_dump(KERN_DEBUG, "remote gb: ", DUMP_PREFIX_OFFSET,
475 16, 1, rgb_skb->data, rgb_skb->len, true);
476
477 r = nfc_set_remote_general_bytes(hdev->ndev, rgb_skb->data,
478 rgb_skb->len);
479
480 if (r == 0)
481 r = nfc_dep_link_is_up(hdev->ndev, target->idx, comm_mode,
482 NFC_RF_INITIATOR);
483exit:
484 kfree_skb(rgb_skb);
485 return r;
486}
487
488static int pn544_hci_dep_link_down(struct nfc_hci_dev *hdev)
489{
490
491 return nfc_hci_send_event(hdev, PN544_RF_READER_NFCIP1_INITIATOR_GATE,
492 NFC_HCI_EVT_END_OPERATION, NULL, 0);
493}
494
Eric Lapuyade412fda52012-09-18 19:45:48 +0200495static int pn544_hci_target_from_gate(struct nfc_hci_dev *hdev, u8 gate,
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200496 struct nfc_target *target)
497{
498 switch (gate) {
499 case PN544_RF_READER_F_GATE:
500 target->supported_protocols = NFC_PROTO_FELICA_MASK;
501 break;
502 case PN544_RF_READER_JEWEL_GATE:
503 target->supported_protocols = NFC_PROTO_JEWEL_MASK;
504 target->sens_res = 0x0c00;
505 break;
Arron Wang928326f2012-09-27 17:32:56 +0800506 case PN544_RF_READER_NFCIP1_INITIATOR_GATE:
507 target->supported_protocols = NFC_PROTO_NFC_DEP_MASK;
508 break;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200509 default:
510 return -EPROTO;
511 }
512
513 return 0;
514}
515
Eric Lapuyade412fda52012-09-18 19:45:48 +0200516static int pn544_hci_complete_target_discovered(struct nfc_hci_dev *hdev,
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200517 u8 gate,
518 struct nfc_target *target)
519{
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200520 struct sk_buff *uid_skb;
521 int r = 0;
522
Arron Wang928326f2012-09-27 17:32:56 +0800523 if (gate == PN544_RF_READER_NFCIP1_INITIATOR_GATE)
524 return r;
525
526 if (target->supported_protocols & NFC_PROTO_NFC_DEP_MASK) {
527 r = nfc_hci_send_cmd(hdev,
528 PN544_RF_READER_NFCIP1_INITIATOR_GATE,
529 PN544_HCI_CMD_CONTINUE_ACTIVATION, NULL, 0, NULL);
530 if (r < 0)
531 return r;
532
533 target->hci_reader_gate = PN544_RF_READER_NFCIP1_INITIATOR_GATE;
534 } else if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200535 if (target->nfcid1_len != 4 && target->nfcid1_len != 7 &&
536 target->nfcid1_len != 10)
537 return -EPROTO;
538
539 r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
540 PN544_RF_READER_CMD_ACTIVATE_NEXT,
541 target->nfcid1, target->nfcid1_len, NULL);
542 } else if (target->supported_protocols & NFC_PROTO_FELICA_MASK) {
543 r = nfc_hci_get_param(hdev, PN544_RF_READER_F_GATE,
544 PN544_FELICA_ID, &uid_skb);
545 if (r < 0)
546 return r;
547
548 if (uid_skb->len != 8) {
549 kfree_skb(uid_skb);
550 return -EPROTO;
551 }
552
Arron Wang9c598442013-04-22 17:21:04 +0800553 /* Type F NFC-DEP IDm has prefix 0x01FE */
554 if ((uid_skb->data[0] == 0x01) && (uid_skb->data[1] == 0xfe)) {
555 kfree_skb(uid_skb);
556 r = nfc_hci_send_cmd(hdev,
Arron Wang928326f2012-09-27 17:32:56 +0800557 PN544_RF_READER_NFCIP1_INITIATOR_GATE,
558 PN544_HCI_CMD_CONTINUE_ACTIVATION,
559 NULL, 0, NULL);
Arron Wang9c598442013-04-22 17:21:04 +0800560 if (r < 0)
561 return r;
Arron Wang928326f2012-09-27 17:32:56 +0800562
Arron Wang9c598442013-04-22 17:21:04 +0800563 target->supported_protocols = NFC_PROTO_NFC_DEP_MASK;
564 target->hci_reader_gate =
565 PN544_RF_READER_NFCIP1_INITIATOR_GATE;
566 } else {
567 r = nfc_hci_send_cmd(hdev, PN544_RF_READER_F_GATE,
568 PN544_RF_READER_CMD_ACTIVATE_NEXT,
569 uid_skb->data, uid_skb->len, NULL);
570 kfree_skb(uid_skb);
571 }
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200572 } else if (target->supported_protocols & NFC_PROTO_ISO14443_MASK) {
573 /*
574 * TODO: maybe other ISO 14443 require some kind of continue
575 * activation, but for now we've seen only this one below.
576 */
577 if (target->sens_res == 0x4403) /* Type 4 Mifare DESFire */
578 r = nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
579 PN544_RF_READER_A_CMD_CONTINUE_ACTIVATION,
580 NULL, 0, NULL);
581 }
582
583 return r;
584}
585
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200586#define PN544_CB_TYPE_READER_F 1
587
588static void pn544_hci_data_exchange_cb(void *context, struct sk_buff *skb,
589 int err)
590{
591 struct pn544_hci_info *info = context;
592
593 switch (info->async_cb_type) {
594 case PN544_CB_TYPE_READER_F:
595 if (err == 0)
596 skb_pull(skb, 1);
597 info->async_cb(info->async_cb_context, skb, err);
598 break;
599 default:
600 if (err == 0)
601 kfree_skb(skb);
602 break;
603 }
604}
605
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200606#define MIFARE_CMD_AUTH_KEY_A 0x60
607#define MIFARE_CMD_AUTH_KEY_B 0x61
608#define MIFARE_CMD_HEADER 2
609#define MIFARE_UID_LEN 4
610#define MIFARE_KEY_LEN 6
611#define MIFARE_CMD_LEN 12
612/*
613 * Returns:
614 * <= 0: driver handled the data exchange
615 * 1: driver doesn't especially handle, please do standard processing
616 */
Arron Wange8107622012-09-27 17:32:58 +0800617static int pn544_hci_im_transceive(struct nfc_hci_dev *hdev,
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200618 struct nfc_target *target,
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200619 struct sk_buff *skb, data_exchange_cb_t cb,
620 void *cb_context)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200621{
Eric Lapuyade412fda52012-09-18 19:45:48 +0200622 struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200623
624 pr_info(DRIVER_DESC ": %s for gate=%d\n", __func__,
625 target->hci_reader_gate);
626
627 switch (target->hci_reader_gate) {
628 case NFC_HCI_RF_READER_A_GATE:
629 if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
630 /*
631 * It seems that pn544 is inverting key and UID for
632 * MIFARE authentication commands.
633 */
634 if (skb->len == MIFARE_CMD_LEN &&
635 (skb->data[0] == MIFARE_CMD_AUTH_KEY_A ||
636 skb->data[0] == MIFARE_CMD_AUTH_KEY_B)) {
637 u8 uid[MIFARE_UID_LEN];
638 u8 *data = skb->data + MIFARE_CMD_HEADER;
639
640 memcpy(uid, data + MIFARE_KEY_LEN,
641 MIFARE_UID_LEN);
642 memmove(data + MIFARE_UID_LEN, data,
643 MIFARE_KEY_LEN);
644 memcpy(data, uid, MIFARE_UID_LEN);
645 }
646
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200647 return nfc_hci_send_cmd_async(hdev,
648 target->hci_reader_gate,
649 PN544_MIFARE_CMD,
650 skb->data, skb->len,
651 cb, cb_context);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200652 } else
653 return 1;
654 case PN544_RF_READER_F_GATE:
655 *skb_push(skb, 1) = 0;
656 *skb_push(skb, 1) = 0;
657
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200658 info->async_cb_type = PN544_CB_TYPE_READER_F;
659 info->async_cb = cb;
660 info->async_cb_context = cb_context;
661
662 return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
663 PN544_FELICA_RAW, skb->data,
664 skb->len,
665 pn544_hci_data_exchange_cb, info);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200666 case PN544_RF_READER_JEWEL_GATE:
Eric Lapuyadef3e8fb52012-09-11 10:43:50 +0200667 return nfc_hci_send_cmd_async(hdev, target->hci_reader_gate,
668 PN544_JEWEL_RAW_CMD, skb->data,
669 skb->len, cb, cb_context);
Arron Wange8107622012-09-27 17:32:58 +0800670 case PN544_RF_READER_NFCIP1_INITIATOR_GATE:
671 *skb_push(skb, 1) = 0;
672
673 return nfc_hci_send_event(hdev, target->hci_reader_gate,
674 PN544_HCI_EVT_SND_DATA, skb->data,
675 skb->len);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200676 default:
677 return 1;
678 }
679}
680
Arron Wange8107622012-09-27 17:32:58 +0800681static int pn544_hci_tm_send(struct nfc_hci_dev *hdev, struct sk_buff *skb)
682{
Eric Lapuyade924d4a02012-12-04 16:44:25 +0100683 int r;
684
Arron Wange8107622012-09-27 17:32:58 +0800685 /* Set default false for multiple information chaining */
686 *skb_push(skb, 1) = 0;
687
Eric Lapuyade924d4a02012-12-04 16:44:25 +0100688 r = nfc_hci_send_event(hdev, PN544_RF_READER_NFCIP1_TARGET_GATE,
689 PN544_HCI_EVT_SND_DATA, skb->data, skb->len);
690
691 kfree_skb(skb);
692
693 return r;
Arron Wange8107622012-09-27 17:32:58 +0800694}
695
Eric Lapuyade412fda52012-09-18 19:45:48 +0200696static int pn544_hci_check_presence(struct nfc_hci_dev *hdev,
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200697 struct nfc_target *target)
698{
Arron Wangda052852012-09-27 17:32:59 +0800699 pr_debug("supported protocol %d", target->supported_protocols);
700 if (target->supported_protocols & (NFC_PROTO_ISO14443_MASK |
701 NFC_PROTO_ISO14443_B_MASK)) {
702 return nfc_hci_send_cmd(hdev, target->hci_reader_gate,
703 PN544_RF_READER_CMD_PRESENCE_CHECK,
704 NULL, 0, NULL);
705 } else if (target->supported_protocols & NFC_PROTO_MIFARE_MASK) {
706 if (target->nfcid1_len != 4 && target->nfcid1_len != 7 &&
707 target->nfcid1_len != 10)
Eric Lapuyade632c0162012-10-02 17:27:36 +0200708 return -EOPNOTSUPP;
Arron Wangda052852012-09-27 17:32:59 +0800709
710 return nfc_hci_send_cmd(hdev, NFC_HCI_RF_READER_A_GATE,
711 PN544_RF_READER_CMD_ACTIVATE_NEXT,
712 target->nfcid1, target->nfcid1_len, NULL);
Arron Wanga69bdc12013-04-22 17:21:27 +0800713 } else if (target->supported_protocols & (NFC_PROTO_JEWEL_MASK |
714 NFC_PROTO_FELICA_MASK)) {
715 return -EOPNOTSUPP;
Arron Wangda052852012-09-27 17:32:59 +0800716 } else if (target->supported_protocols & NFC_PROTO_NFC_DEP_MASK) {
717 return nfc_hci_send_cmd(hdev, target->hci_reader_gate,
718 PN544_HCI_CMD_ATTREQUEST,
719 NULL, 0, NULL);
720 }
721
722 return 0;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200723}
724
Eric Lapuyade40d06d32012-12-04 16:43:24 +0100725/*
726 * Returns:
727 * <= 0: driver handled the event, skb consumed
728 * 1: driver does not handle the event, please do standard processing
729 */
Eric Lapuyade27c31192012-11-28 15:48:44 +0100730static int pn544_hci_event_received(struct nfc_hci_dev *hdev, u8 gate, u8 event,
731 struct sk_buff *skb)
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800732{
733 struct sk_buff *rgb_skb = NULL;
Eric Lapuyade40d06d32012-12-04 16:43:24 +0100734 int r;
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800735
736 pr_debug("hci event %d", event);
737 switch (event) {
738 case PN544_HCI_EVT_ACTIVATED:
Eric Lapuyade40d06d32012-12-04 16:43:24 +0100739 if (gate == PN544_RF_READER_NFCIP1_INITIATOR_GATE) {
Eric Lapuyade27c31192012-11-28 15:48:44 +0100740 r = nfc_hci_target_discovered(hdev, gate);
Eric Lapuyade40d06d32012-12-04 16:43:24 +0100741 } else if (gate == PN544_RF_READER_NFCIP1_TARGET_GATE) {
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800742 r = nfc_hci_get_param(hdev, gate, PN544_DEP_ATR_REQ,
Eric Lapuyade27c31192012-11-28 15:48:44 +0100743 &rgb_skb);
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800744 if (r < 0)
745 goto exit;
746
Eric Lapuyade27c31192012-11-28 15:48:44 +0100747 r = nfc_tm_activated(hdev->ndev, NFC_PROTO_NFC_DEP_MASK,
748 NFC_COMM_PASSIVE, rgb_skb->data,
749 rgb_skb->len);
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800750
751 kfree_skb(rgb_skb);
Eric Lapuyade40d06d32012-12-04 16:43:24 +0100752 } else {
753 r = -EINVAL;
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800754 }
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800755 break;
756 case PN544_HCI_EVT_DEACTIVATED:
Eric Lapuyade27c31192012-11-28 15:48:44 +0100757 r = nfc_hci_send_event(hdev, gate, NFC_HCI_EVT_END_OPERATION,
758 NULL, 0);
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800759 break;
Arron Wange8107622012-09-27 17:32:58 +0800760 case PN544_HCI_EVT_RCV_DATA:
761 if (skb->len < 2) {
762 r = -EPROTO;
763 goto exit;
764 }
765
766 if (skb->data[0] != 0) {
767 pr_debug("data0 %d", skb->data[0]);
768 r = -EPROTO;
769 goto exit;
770 }
771
772 skb_pull(skb, 2);
Eric Lapuyade27c31192012-11-28 15:48:44 +0100773 return nfc_tm_data_received(hdev->ndev, skb);
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800774 default:
Eric Lapuyade40d06d32012-12-04 16:43:24 +0100775 return 1;
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800776 }
777
778exit:
779 kfree_skb(skb);
Eric Lapuyade27c31192012-11-28 15:48:44 +0100780
781 return r;
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800782}
783
Eric Lapuyade8bd7fc82013-07-19 14:58:39 +0200784static int pn544_hci_fw_download(struct nfc_hci_dev *hdev,
785 const char *firmware_name)
786{
787 struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
788
789 if (info->fw_download == NULL)
790 return -ENOTSUPP;
791
792 return info->fw_download(info->phy_id, firmware_name);
793}
794
Eric Lapuyade412fda52012-09-18 19:45:48 +0200795static struct nfc_hci_ops pn544_hci_ops = {
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200796 .open = pn544_hci_open,
797 .close = pn544_hci_close,
798 .hci_ready = pn544_hci_ready,
799 .xmit = pn544_hci_xmit,
800 .start_poll = pn544_hci_start_poll,
Arron Wangc40d1742012-09-27 17:32:57 +0800801 .dep_link_up = pn544_hci_dep_link_up,
802 .dep_link_down = pn544_hci_dep_link_down,
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200803 .target_from_gate = pn544_hci_target_from_gate,
804 .complete_target_discovered = pn544_hci_complete_target_discovered,
Arron Wange8107622012-09-27 17:32:58 +0800805 .im_transceive = pn544_hci_im_transceive,
806 .tm_send = pn544_hci_tm_send,
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200807 .check_presence = pn544_hci_check_presence,
Arron Wangf7a5f6c2012-09-27 17:32:55 +0800808 .event_received = pn544_hci_event_received,
Eric Lapuyade8bd7fc82013-07-19 14:58:39 +0200809 .fw_download = pn544_hci_fw_download,
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200810};
811
Eric Lapuyade97f18412012-10-02 18:44:06 +0200812int pn544_hci_probe(void *phy_id, struct nfc_phy_ops *phy_ops, char *llc_name,
813 int phy_headroom, int phy_tailroom, int phy_payload,
Eric Lapuyade8bd7fc82013-07-19 14:58:39 +0200814 fw_download_t fw_download, struct nfc_hci_dev **hdev)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200815{
816 struct pn544_hci_info *info;
Samuel Ortiz0b456c42013-05-07 19:22:11 +0200817 u32 protocols;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200818 struct nfc_hci_init_data init_data;
Eric Lapuyade97f18412012-10-02 18:44:06 +0200819 int r;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200820
821 info = kzalloc(sizeof(struct pn544_hci_info), GFP_KERNEL);
822 if (!info) {
Eric Lapuyade97f18412012-10-02 18:44:06 +0200823 pr_err("Cannot allocate memory for pn544_hci_info.\n");
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200824 r = -ENOMEM;
825 goto err_info_alloc;
826 }
827
Eric Lapuyade97f18412012-10-02 18:44:06 +0200828 info->phy_ops = phy_ops;
829 info->phy_id = phy_id;
Eric Lapuyade8bd7fc82013-07-19 14:58:39 +0200830 info->fw_download = fw_download;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200831 info->state = PN544_ST_COLD;
832 mutex_init(&info->info_lock);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200833
Eric Lapuyadea10d5952012-06-05 14:42:11 +0200834 init_data.gate_count = ARRAY_SIZE(pn544_gates);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200835
Eric Lapuyadea10d5952012-06-05 14:42:11 +0200836 memcpy(init_data.gates, pn544_gates, sizeof(pn544_gates));
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200837
838 /*
839 * TODO: Session id must include the driver name + some bus addr
840 * persistent info to discriminate 2 identical chips
841 */
842 strcpy(init_data.session_id, "ID544HCI");
843
844 protocols = NFC_PROTO_JEWEL_MASK |
845 NFC_PROTO_MIFARE_MASK |
846 NFC_PROTO_FELICA_MASK |
847 NFC_PROTO_ISO14443_MASK |
Samuel Ortiz01d719a2012-07-04 00:14:04 +0200848 NFC_PROTO_ISO14443_B_MASK |
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200849 NFC_PROTO_NFC_DEP_MASK;
850
Eric Lapuyadebf71ab82012-12-18 14:15:49 +0100851 info->hdev = nfc_hci_allocate_device(&pn544_hci_ops, &init_data, 0,
Samuel Ortiz0b456c42013-05-07 19:22:11 +0200852 protocols, llc_name,
Eric Lapuyade97f18412012-10-02 18:44:06 +0200853 phy_headroom + PN544_CMDS_HEADROOM,
854 phy_tailroom, phy_payload);
Eric Lapuyade412fda52012-09-18 19:45:48 +0200855 if (!info->hdev) {
Eric Lapuyade97f18412012-10-02 18:44:06 +0200856 pr_err("Cannot allocate nfc hdev.\n");
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200857 r = -ENOMEM;
Eric Lapuyade412fda52012-09-18 19:45:48 +0200858 goto err_alloc_hdev;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200859 }
860
Eric Lapuyade412fda52012-09-18 19:45:48 +0200861 nfc_hci_set_clientdata(info->hdev, info);
862
863 r = nfc_hci_register_device(info->hdev);
864 if (r)
865 goto err_regdev;
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200866
Eric Lapuyade97f18412012-10-02 18:44:06 +0200867 *hdev = info->hdev;
868
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200869 return 0;
870
Eric Lapuyade412fda52012-09-18 19:45:48 +0200871err_regdev:
872 nfc_hci_free_device(info->hdev);
873
874err_alloc_hdev:
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200875 kfree(info);
876
877err_info_alloc:
878 return r;
879}
Samuel Ortizaa741032012-12-18 16:26:23 +0100880EXPORT_SYMBOL(pn544_hci_probe);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200881
Eric Lapuyade97f18412012-10-02 18:44:06 +0200882void pn544_hci_remove(struct nfc_hci_dev *hdev)
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200883{
Eric Lapuyade97f18412012-10-02 18:44:06 +0200884 struct pn544_hci_info *info = nfc_hci_get_clientdata(hdev);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200885
Eric Lapuyade97f18412012-10-02 18:44:06 +0200886 nfc_hci_unregister_device(hdev);
887 nfc_hci_free_device(hdev);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200888 kfree(info);
Eric Lapuyadebbed0de2012-05-07 12:31:29 +0200889}
Samuel Ortizaa741032012-12-18 16:26:23 +0100890EXPORT_SYMBOL(pn544_hci_remove);
891
892MODULE_LICENSE("GPL");
893MODULE_DESCRIPTION(DRIVER_DESC);