2 * HCI based Driver for STMicroelectronics NFC Chip
4 * Copyright (C) 2014 STMicroelectronics SAS. All rights reserved.
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.
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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, see <http://www.gnu.org/licenses/>.
19 #include <linux/module.h>
20 #include <linux/nfc.h>
21 #include <net/nfc/hci.h>
22 #include <net/nfc/llc.h>
26 #define DRIVER_DESC "HCI NFC driver for ST21NFCA"
28 #define FULL_VERSION_LEN 3
30 /* Proprietary gates, events, commands and registers */
32 /* Commands that apply to all RF readers */
33 #define ST21NFCA_RF_READER_CMD_PRESENCE_CHECK 0x30
35 #define ST21NFCA_RF_READER_ISO15693_GATE 0x12
36 #define ST21NFCA_RF_READER_ISO15693_INVENTORY 0x01
39 * Reader gate for communication with contact-less cards using Type A
40 * protocol ISO14443-3 but not compliant with ISO14443-4
42 #define ST21NFCA_RF_READER_14443_3_A_GATE 0x15
43 #define ST21NFCA_RF_READER_14443_3_A_UID 0x02
44 #define ST21NFCA_RF_READER_14443_3_A_ATQA 0x03
45 #define ST21NFCA_RF_READER_14443_3_A_SAK 0x04
47 #define ST21NFCA_RF_READER_F_DATARATE 0x01
48 #define ST21NFCA_RF_READER_F_DATARATE_106 0x01
49 #define ST21NFCA_RF_READER_F_DATARATE_212 0x02
50 #define ST21NFCA_RF_READER_F_DATARATE_424 0x04
51 #define ST21NFCA_RF_READER_F_POL_REQ 0x02
52 #define ST21NFCA_RF_READER_F_POL_REQ_DEFAULT 0xffff0000
53 #define ST21NFCA_RF_READER_F_NFCID2 0x03
54 #define ST21NFCA_RF_READER_F_NFCID1 0x04
56 #define ST21NFCA_RF_CARD_F_MODE 0x01
57 #define ST21NFCA_RF_CARD_F_NFCID2_LIST 0x04
58 #define ST21NFCA_RF_CARD_F_NFCID1 0x05
59 #define ST21NFCA_RF_CARD_F_SENS_RES 0x06
60 #define ST21NFCA_RF_CARD_F_SEL_RES 0x07
61 #define ST21NFCA_RF_CARD_F_DATARATE 0x08
62 #define ST21NFCA_RF_CARD_F_DATARATE_212_424 0x01
64 #define ST21NFCA_DEVICE_MGNT_PIPE 0x02
66 #define ST21NFCA_DM_GETINFO 0x13
67 #define ST21NFCA_DM_GETINFO_PIPE_LIST 0x02
68 #define ST21NFCA_DM_GETINFO_PIPE_INFO 0x01
69 #define ST21NFCA_DM_PIPE_CREATED 0x02
70 #define ST21NFCA_DM_PIPE_OPEN 0x04
71 #define ST21NFCA_DM_RF_ACTIVE 0x80
72 #define ST21NFCA_DM_DISCONNECT 0x30
74 #define ST21NFCA_DM_IS_PIPE_OPEN(p) \
75 ((p & 0x0f) == (ST21NFCA_DM_PIPE_CREATED | ST21NFCA_DM_PIPE_OPEN))
77 #define ST21NFCA_NFC_MODE 0x03 /* NFC_MODE parameter*/
79 #define ST21NFCA_EVT_HOT_PLUG 0x03
80 #define ST21NFCA_EVT_HOT_PLUG_IS_INHIBITED(x) (x->data[0] & 0x80)
82 #define ST21NFCA_SE_TO_PIPES 2000
84 static DECLARE_BITMAP(dev_mask
, ST21NFCA_NUM_DEVICES
);
86 static struct nfc_hci_gate st21nfca_gates
[] = {
87 {NFC_HCI_ADMIN_GATE
, NFC_HCI_ADMIN_PIPE
},
88 {NFC_HCI_LINK_MGMT_GATE
, NFC_HCI_LINK_MGMT_PIPE
},
89 {ST21NFCA_DEVICE_MGNT_GATE
, ST21NFCA_DEVICE_MGNT_PIPE
},
91 {NFC_HCI_LOOPBACK_GATE
, NFC_HCI_INVALID_PIPE
},
92 {NFC_HCI_ID_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 {ST21NFCA_RF_READER_F_GATE
, NFC_HCI_INVALID_PIPE
},
96 {ST21NFCA_RF_READER_14443_3_A_GATE
, NFC_HCI_INVALID_PIPE
},
97 {ST21NFCA_RF_READER_ISO15693_GATE
, NFC_HCI_INVALID_PIPE
},
98 {ST21NFCA_RF_CARD_F_GATE
, NFC_HCI_INVALID_PIPE
},
100 /* Secure element pipes are created by secure element host */
101 {ST21NFCA_CONNECTIVITY_GATE
, NFC_HCI_DO_NOT_CREATE_PIPE
},
102 {ST21NFCA_APDU_READER_GATE
, NFC_HCI_DO_NOT_CREATE_PIPE
},
105 struct st21nfca_pipe_info
{
113 /* Largest headroom needed for outgoing custom commands */
114 #define ST21NFCA_CMDS_HEADROOM 7
116 static int st21nfca_hci_load_session(struct nfc_hci_dev
*hdev
)
119 struct sk_buff
*skb_pipe_list
, *skb_pipe_info
;
120 struct st21nfca_pipe_info
*info
;
122 u8 pipe_list
[] = { ST21NFCA_DM_GETINFO_PIPE_LIST
,
123 NFC_HCI_TERMINAL_HOST_ID
125 u8 pipe_info
[] = { ST21NFCA_DM_GETINFO_PIPE_INFO
,
126 NFC_HCI_TERMINAL_HOST_ID
, 0
129 /* On ST21NFCA device pipes number are dynamics
130 * A maximum of 16 pipes can be created at the same time
131 * If pipes are already created, hci_dev_up will fail.
132 * Doing a clear all pipe is a bad idea because:
133 * - It does useless EEPROM cycling
134 * - It might cause issue for secure elements support
135 * (such as removing connectivity or APDU reader pipe)
136 * A better approach on ST21NFCA is to:
137 * - get a pipe list for each host.
138 * (eg: NFC_HCI_HOST_CONTROLLER_ID for now).
139 * (TODO Later on UICC HOST and eSE HOST)
140 * - get pipe information
141 * - match retrieved pipe list in st21nfca_gates
142 * ST21NFCA_DEVICE_MGNT_GATE is a proprietary gate
143 * with ST21NFCA_DEVICE_MGNT_PIPE.
144 * Pipe can be closed and need to be open.
146 r
= nfc_hci_connect_gate(hdev
, NFC_HCI_HOST_CONTROLLER_ID
,
147 ST21NFCA_DEVICE_MGNT_GATE
,
148 ST21NFCA_DEVICE_MGNT_PIPE
);
153 r
= nfc_hci_send_cmd(hdev
, ST21NFCA_DEVICE_MGNT_GATE
,
154 ST21NFCA_DM_GETINFO
, pipe_list
, sizeof(pipe_list
),
159 /* Complete the existing gate_pipe table */
160 for (i
= 0; i
< skb_pipe_list
->len
; i
++) {
161 pipe_info
[2] = skb_pipe_list
->data
[i
];
162 r
= nfc_hci_send_cmd(hdev
, ST21NFCA_DEVICE_MGNT_GATE
,
163 ST21NFCA_DM_GETINFO
, pipe_info
,
164 sizeof(pipe_info
), &skb_pipe_info
);
169 * Match pipe ID and gate ID
170 * Output format from ST21NFC_DM_GETINFO is:
171 * - pipe state (1byte)
172 * - source hid (1byte)
173 * - source gid (1byte)
174 * - destination hid (1byte)
175 * - destination gid (1byte)
177 info
= (struct st21nfca_pipe_info
*) skb_pipe_info
->data
;
178 if (info
->dst_gate_id
== ST21NFCA_APDU_READER_GATE
&&
179 info
->src_host_id
!= ST21NFCA_ESE_HOST_ID
) {
180 pr_err("Unexpected apdu_reader pipe on host %x\n",
182 kfree_skb(skb_pipe_info
);
186 for (j
= 3; (j
< ARRAY_SIZE(st21nfca_gates
)) &&
187 (st21nfca_gates
[j
].gate
!= info
->dst_gate_id
) ; j
++)
190 if (j
< ARRAY_SIZE(st21nfca_gates
) &&
191 st21nfca_gates
[j
].gate
== info
->dst_gate_id
&&
192 ST21NFCA_DM_IS_PIPE_OPEN(info
->pipe_state
)) {
193 hdev
->init_data
.gates
[j
].pipe
= pipe_info
[2];
195 hdev
->gate2pipe
[st21nfca_gates
[j
].gate
] =
197 hdev
->pipes
[pipe_info
[2]].gate
=
198 st21nfca_gates
[j
].gate
;
199 hdev
->pipes
[pipe_info
[2]].dest_host
=
202 kfree_skb(skb_pipe_info
);
206 * 3 gates have a well known pipe ID. Only NFC_HCI_LINK_MGMT_GATE
207 * is not yet open at this stage.
209 r
= nfc_hci_connect_gate(hdev
, NFC_HCI_HOST_CONTROLLER_ID
,
210 NFC_HCI_LINK_MGMT_GATE
,
211 NFC_HCI_LINK_MGMT_PIPE
);
213 kfree_skb(skb_pipe_list
);
217 static int st21nfca_hci_open(struct nfc_hci_dev
*hdev
)
219 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
222 mutex_lock(&info
->info_lock
);
224 if (info
->state
!= ST21NFCA_ST_COLD
) {
229 r
= info
->phy_ops
->enable(info
->phy_id
);
232 info
->state
= ST21NFCA_ST_READY
;
235 mutex_unlock(&info
->info_lock
);
239 static void st21nfca_hci_close(struct nfc_hci_dev
*hdev
)
241 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
243 mutex_lock(&info
->info_lock
);
245 if (info
->state
== ST21NFCA_ST_COLD
)
248 info
->phy_ops
->disable(info
->phy_id
);
249 info
->state
= ST21NFCA_ST_COLD
;
252 mutex_unlock(&info
->info_lock
);
255 static int st21nfca_hci_ready(struct nfc_hci_dev
*hdev
)
257 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
265 if (info
->se_status
->is_ese_present
&&
266 info
->se_status
->is_uicc_present
) {
267 white_list
[wl_size
++] = NFC_HCI_UICC_HOST_ID
;
268 white_list
[wl_size
++] = ST21NFCA_ESE_HOST_ID
;
269 } else if (!info
->se_status
->is_ese_present
&&
270 info
->se_status
->is_uicc_present
) {
271 white_list
[wl_size
++] = NFC_HCI_UICC_HOST_ID
;
272 } else if (info
->se_status
->is_ese_present
&&
273 !info
->se_status
->is_uicc_present
) {
274 white_list
[wl_size
++] = ST21NFCA_ESE_HOST_ID
;
278 r
= nfc_hci_set_param(hdev
, NFC_HCI_ADMIN_GATE
,
279 NFC_HCI_ADMIN_WHITELIST
,
280 (u8
*) &white_list
, wl_size
);
285 /* Set NFC_MODE in device management gate to enable */
286 r
= nfc_hci_get_param(hdev
, ST21NFCA_DEVICE_MGNT_GATE
,
287 ST21NFCA_NFC_MODE
, &skb
);
291 param
= skb
->data
[0];
296 r
= nfc_hci_set_param(hdev
, ST21NFCA_DEVICE_MGNT_GATE
,
297 ST21NFCA_NFC_MODE
, ¶m
, 1);
302 r
= nfc_hci_send_event(hdev
, NFC_HCI_RF_READER_A_GATE
,
303 NFC_HCI_EVT_END_OPERATION
, NULL
, 0);
307 r
= nfc_hci_get_param(hdev
, NFC_HCI_ID_MGMT_GATE
,
308 NFC_HCI_ID_MGMT_VERSION_SW
, &skb
);
312 if (skb
->len
!= FULL_VERSION_LEN
) {
317 print_hex_dump(KERN_DEBUG
, "FULL VERSION SOFTWARE INFO: ",
318 DUMP_PREFIX_NONE
, 16, 1,
319 skb
->data
, FULL_VERSION_LEN
, false);
326 static int st21nfca_hci_xmit(struct nfc_hci_dev
*hdev
, struct sk_buff
*skb
)
328 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
330 return info
->phy_ops
->write(info
->phy_id
, skb
);
333 static int st21nfca_hci_start_poll(struct nfc_hci_dev
*hdev
,
334 u32 im_protocols
, u32 tm_protocols
)
339 struct sk_buff
*datarate_skb
;
341 pr_info(DRIVER_DESC
": %s protocols 0x%x 0x%x\n",
342 __func__
, im_protocols
, tm_protocols
);
344 r
= nfc_hci_send_event(hdev
, NFC_HCI_RF_READER_A_GATE
,
345 NFC_HCI_EVT_END_OPERATION
, NULL
, 0);
350 * enable polling according to im_protocols & tm_protocols
351 * - CLOSE pipe according to im_protocols & tm_protocols
353 if ((NFC_HCI_RF_READER_B_GATE
& im_protocols
) == 0) {
354 r
= nfc_hci_disconnect_gate(hdev
,
355 NFC_HCI_RF_READER_B_GATE
);
360 if ((NFC_HCI_RF_READER_A_GATE
& im_protocols
) == 0) {
361 r
= nfc_hci_disconnect_gate(hdev
,
362 NFC_HCI_RF_READER_A_GATE
);
367 if ((ST21NFCA_RF_READER_F_GATE
& im_protocols
) == 0) {
368 r
= nfc_hci_disconnect_gate(hdev
,
369 ST21NFCA_RF_READER_F_GATE
);
373 hdev
->gb
= nfc_get_local_general_bytes(hdev
->ndev
,
376 if (hdev
->gb
== NULL
|| hdev
->gb_len
== 0) {
377 im_protocols
&= ~NFC_PROTO_NFC_DEP_MASK
;
378 tm_protocols
&= ~NFC_PROTO_NFC_DEP_MASK
;
381 param
[0] = ST21NFCA_RF_READER_F_DATARATE_106
|
382 ST21NFCA_RF_READER_F_DATARATE_212
|
383 ST21NFCA_RF_READER_F_DATARATE_424
;
384 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_READER_F_GATE
,
385 ST21NFCA_RF_READER_F_DATARATE
,
390 pol_req
= be32_to_cpu((__force __be32
)
391 ST21NFCA_RF_READER_F_POL_REQ_DEFAULT
);
392 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_READER_F_GATE
,
393 ST21NFCA_RF_READER_F_POL_REQ
,
399 if ((ST21NFCA_RF_READER_14443_3_A_GATE
& im_protocols
) == 0) {
400 r
= nfc_hci_disconnect_gate(hdev
,
401 ST21NFCA_RF_READER_14443_3_A_GATE
);
406 if ((ST21NFCA_RF_READER_ISO15693_GATE
& im_protocols
) == 0) {
407 r
= nfc_hci_disconnect_gate(hdev
,
408 ST21NFCA_RF_READER_ISO15693_GATE
);
413 r
= nfc_hci_send_event(hdev
, NFC_HCI_RF_READER_A_GATE
,
414 NFC_HCI_EVT_READER_REQUESTED
, NULL
, 0);
416 nfc_hci_send_event(hdev
, NFC_HCI_RF_READER_A_GATE
,
417 NFC_HCI_EVT_END_OPERATION
, NULL
, 0);
420 if (tm_protocols
& NFC_PROTO_NFC_DEP_MASK
) {
421 r
= nfc_hci_get_param(hdev
, ST21NFCA_RF_CARD_F_GATE
,
422 ST21NFCA_RF_CARD_F_DATARATE
,
427 /* Configure the maximum supported datarate to 424Kbps */
428 if (datarate_skb
->len
> 0 &&
429 datarate_skb
->data
[0] !=
430 ST21NFCA_RF_CARD_F_DATARATE_212_424
) {
431 param
[0] = ST21NFCA_RF_CARD_F_DATARATE_212_424
;
432 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_CARD_F_GATE
,
433 ST21NFCA_RF_CARD_F_DATARATE
,
436 kfree_skb(datarate_skb
);
440 kfree_skb(datarate_skb
);
445 * NFC Forum Digital Spec Table 7:
446 * NFCID1 size: triple (10 bytes)
450 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_CARD_F_GATE
,
451 ST21NFCA_RF_CARD_F_SENS_RES
, param
, 2);
458 * NFC Forum Digistal Spec Table 17:
459 * b3 set to 0b (value b7-b6):
460 * - 10b: Configured for NFC-DEP Protocol
463 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_CARD_F_GATE
,
464 ST21NFCA_RF_CARD_F_SEL_RES
, param
, 1);
468 /* Configure NFCID1 Random uid */
469 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_CARD_F_GATE
,
470 ST21NFCA_RF_CARD_F_NFCID1
, NULL
, 0);
474 /* Configure NFCID2_LIST */
487 /* 8 byte Pad bytes used for polling respone frame */
490 * Configuration byte:
491 * - bit 0: define the default NFCID2 entry used when the
492 * system code is equal to 'FFFF'
493 * - bit 1: use a random value for lowest 6 bytes of
495 * - bit 2: ignore polling request frame if request code
497 * - Other bits are RFU
500 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_CARD_F_GATE
,
501 ST21NFCA_RF_CARD_F_NFCID2_LIST
, param
,
507 r
= nfc_hci_set_param(hdev
, ST21NFCA_RF_CARD_F_GATE
,
508 ST21NFCA_RF_CARD_F_MODE
, param
, 1);
514 static void st21nfca_hci_stop_poll(struct nfc_hci_dev
*hdev
)
516 nfc_hci_send_cmd(hdev
, ST21NFCA_DEVICE_MGNT_GATE
,
517 ST21NFCA_DM_DISCONNECT
, NULL
, 0, NULL
);
520 static int st21nfca_get_iso14443_3_atqa(struct nfc_hci_dev
*hdev
, u16
*atqa
)
523 struct sk_buff
*atqa_skb
= NULL
;
525 r
= nfc_hci_get_param(hdev
, ST21NFCA_RF_READER_14443_3_A_GATE
,
526 ST21NFCA_RF_READER_14443_3_A_ATQA
, &atqa_skb
);
530 if (atqa_skb
->len
!= 2) {
535 *atqa
= be16_to_cpu(*(__be16
*) atqa_skb
->data
);
542 static int st21nfca_get_iso14443_3_sak(struct nfc_hci_dev
*hdev
, u8
*sak
)
545 struct sk_buff
*sak_skb
= NULL
;
547 r
= nfc_hci_get_param(hdev
, ST21NFCA_RF_READER_14443_3_A_GATE
,
548 ST21NFCA_RF_READER_14443_3_A_SAK
, &sak_skb
);
552 if (sak_skb
->len
!= 1) {
557 *sak
= sak_skb
->data
[0];
564 static int st21nfca_get_iso14443_3_uid(struct nfc_hci_dev
*hdev
, u8
*uid
,
568 struct sk_buff
*uid_skb
= NULL
;
570 r
= nfc_hci_get_param(hdev
, ST21NFCA_RF_READER_14443_3_A_GATE
,
571 ST21NFCA_RF_READER_14443_3_A_UID
, &uid_skb
);
575 if (uid_skb
->len
== 0 || uid_skb
->len
> NFC_NFCID1_MAXSIZE
) {
580 memcpy(uid
, uid_skb
->data
, uid_skb
->len
);
587 static int st21nfca_get_iso15693_inventory(struct nfc_hci_dev
*hdev
,
588 struct nfc_target
*target
)
591 struct sk_buff
*inventory_skb
= NULL
;
593 r
= nfc_hci_get_param(hdev
, ST21NFCA_RF_READER_ISO15693_GATE
,
594 ST21NFCA_RF_READER_ISO15693_INVENTORY
,
599 skb_pull(inventory_skb
, 2);
601 if (inventory_skb
->len
== 0 ||
602 inventory_skb
->len
> NFC_ISO15693_UID_MAXSIZE
) {
607 memcpy(target
->iso15693_uid
, inventory_skb
->data
, inventory_skb
->len
);
608 target
->iso15693_dsfid
= inventory_skb
->data
[1];
609 target
->is_iso15693
= 1;
611 kfree_skb(inventory_skb
);
615 static int st21nfca_hci_dep_link_up(struct nfc_hci_dev
*hdev
,
616 struct nfc_target
*target
, u8 comm_mode
,
617 u8
*gb
, size_t gb_len
)
619 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
621 info
->dep_info
.idx
= target
->idx
;
622 return st21nfca_im_send_atr_req(hdev
, gb
, gb_len
);
625 static int st21nfca_hci_dep_link_down(struct nfc_hci_dev
*hdev
)
627 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
629 info
->state
= ST21NFCA_ST_READY
;
631 return nfc_hci_send_cmd(hdev
, ST21NFCA_DEVICE_MGNT_GATE
,
632 ST21NFCA_DM_DISCONNECT
, NULL
, 0, NULL
);
635 static int st21nfca_hci_target_from_gate(struct nfc_hci_dev
*hdev
, u8 gate
,
636 struct nfc_target
*target
)
641 u8 uid
[NFC_NFCID1_MAXSIZE
];
644 case ST21NFCA_RF_READER_F_GATE
:
645 target
->supported_protocols
= NFC_PROTO_FELICA_MASK
;
647 case ST21NFCA_RF_READER_14443_3_A_GATE
:
648 /* ISO14443-3 type 1 or 2 tags */
649 r
= st21nfca_get_iso14443_3_atqa(hdev
, &atqa
);
652 if (atqa
== 0x000c) {
653 target
->supported_protocols
= NFC_PROTO_JEWEL_MASK
;
654 target
->sens_res
= 0x0c00;
656 r
= st21nfca_get_iso14443_3_sak(hdev
, &sak
);
660 r
= st21nfca_get_iso14443_3_uid(hdev
, uid
, &len
);
664 target
->supported_protocols
=
665 nfc_hci_sak_to_protocol(sak
);
666 if (target
->supported_protocols
== 0xffffffff)
669 target
->sens_res
= atqa
;
670 target
->sel_res
= sak
;
671 memcpy(target
->nfcid1
, uid
, len
);
672 target
->nfcid1_len
= len
;
676 case ST21NFCA_RF_READER_ISO15693_GATE
:
677 target
->supported_protocols
= NFC_PROTO_ISO15693_MASK
;
678 r
= st21nfca_get_iso15693_inventory(hdev
, target
);
689 static int st21nfca_hci_complete_target_discovered(struct nfc_hci_dev
*hdev
,
691 struct nfc_target
*target
)
694 struct sk_buff
*nfcid_skb
= NULL
;
696 if (gate
== ST21NFCA_RF_READER_F_GATE
) {
697 r
= nfc_hci_get_param(hdev
, ST21NFCA_RF_READER_F_GATE
,
698 ST21NFCA_RF_READER_F_NFCID2
, &nfcid_skb
);
702 if (nfcid_skb
->len
> NFC_SENSF_RES_MAXSIZE
) {
708 * - After the recepton of polling response for type F frame
709 * at 212 or 424 Kbit/s, NFCID2 registry parameters will be
711 * - After the reception of SEL_RES with NFCIP-1 compliant bit
712 * set for type A frame NFCID1 will be updated
714 if (nfcid_skb
->len
> 0) {
716 memcpy(target
->sensf_res
, nfcid_skb
->data
,
718 target
->sensf_res_len
= nfcid_skb
->len
;
719 /* NFC Forum Digital Protocol Table 44 */
720 if (target
->sensf_res
[0] == 0x01 &&
721 target
->sensf_res
[1] == 0xfe)
722 target
->supported_protocols
=
723 NFC_PROTO_NFC_DEP_MASK
;
725 target
->supported_protocols
=
726 NFC_PROTO_FELICA_MASK
;
728 kfree_skb(nfcid_skb
);
730 r
= nfc_hci_get_param(hdev
, ST21NFCA_RF_READER_F_GATE
,
731 ST21NFCA_RF_READER_F_NFCID1
,
736 if (nfcid_skb
->len
> NFC_NFCID1_MAXSIZE
) {
740 memcpy(target
->sensf_res
, nfcid_skb
->data
,
742 target
->sensf_res_len
= nfcid_skb
->len
;
743 target
->supported_protocols
= NFC_PROTO_NFC_DEP_MASK
;
745 target
->hci_reader_gate
= ST21NFCA_RF_READER_F_GATE
;
749 kfree_skb(nfcid_skb
);
753 #define ST21NFCA_CB_TYPE_READER_ISO15693 1
754 static void st21nfca_hci_data_exchange_cb(void *context
, struct sk_buff
*skb
,
757 struct st21nfca_hci_info
*info
= context
;
759 switch (info
->async_cb_type
) {
760 case ST21NFCA_CB_TYPE_READER_ISO15693
:
762 skb_trim(skb
, skb
->len
- 1);
763 info
->async_cb(info
->async_cb_context
, skb
, err
);
774 * <= 0: driver handled the data exchange
775 * 1: driver doesn't especially handle, please do standard processing
777 static int st21nfca_hci_im_transceive(struct nfc_hci_dev
*hdev
,
778 struct nfc_target
*target
,
780 data_exchange_cb_t cb
, void *cb_context
)
782 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
784 pr_info(DRIVER_DESC
": %s for gate=%d len=%d\n", __func__
,
785 target
->hci_reader_gate
, skb
->len
);
787 switch (target
->hci_reader_gate
) {
788 case ST21NFCA_RF_READER_F_GATE
:
789 if (target
->supported_protocols
== NFC_PROTO_NFC_DEP_MASK
)
790 return st21nfca_im_send_dep_req(hdev
, skb
);
792 *skb_push(skb
, 1) = 0x1a;
793 return nfc_hci_send_cmd_async(hdev
, target
->hci_reader_gate
,
794 ST21NFCA_WR_XCHG_DATA
, skb
->data
,
795 skb
->len
, cb
, cb_context
);
796 case ST21NFCA_RF_READER_14443_3_A_GATE
:
797 *skb_push(skb
, 1) = 0x1a; /* CTR, see spec:10.2.2.1 */
799 return nfc_hci_send_cmd_async(hdev
, target
->hci_reader_gate
,
800 ST21NFCA_WR_XCHG_DATA
, skb
->data
,
801 skb
->len
, cb
, cb_context
);
802 case ST21NFCA_RF_READER_ISO15693_GATE
:
803 info
->async_cb_type
= ST21NFCA_CB_TYPE_READER_ISO15693
;
805 info
->async_cb_context
= cb_context
;
807 *skb_push(skb
, 1) = 0x17;
809 return nfc_hci_send_cmd_async(hdev
, target
->hci_reader_gate
,
810 ST21NFCA_WR_XCHG_DATA
, skb
->data
,
812 st21nfca_hci_data_exchange_cb
,
820 static int st21nfca_hci_tm_send(struct nfc_hci_dev
*hdev
, struct sk_buff
*skb
)
822 return st21nfca_tm_send_dep_res(hdev
, skb
);
825 static int st21nfca_hci_check_presence(struct nfc_hci_dev
*hdev
,
826 struct nfc_target
*target
)
830 switch (target
->hci_reader_gate
) {
831 case NFC_HCI_RF_READER_A_GATE
:
832 case NFC_HCI_RF_READER_B_GATE
:
834 * PRESENCE_CHECK on those gates is available
835 * However, the answer to this command is taking 3 * fwi
836 * if the card is no present.
837 * Instead, we send an empty I-Frame with a very short
838 * configurable fwi ~604µs.
840 return nfc_hci_send_cmd(hdev
, target
->hci_reader_gate
,
841 ST21NFCA_WR_XCHG_DATA
, &fwi
, 1, NULL
);
842 case ST21NFCA_RF_READER_14443_3_A_GATE
:
843 return nfc_hci_send_cmd(hdev
, target
->hci_reader_gate
,
844 ST21NFCA_RF_READER_CMD_PRESENCE_CHECK
,
851 static void st21nfca_hci_cmd_received(struct nfc_hci_dev
*hdev
, u8 pipe
, u8 cmd
,
854 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
855 u8 gate
= hdev
->pipes
[pipe
].gate
;
857 pr_debug("cmd: %x\n", cmd
);
860 case NFC_HCI_ANY_OPEN_PIPE
:
861 if (gate
!= ST21NFCA_APDU_READER_GATE
&&
862 hdev
->pipes
[pipe
].dest_host
!= NFC_HCI_UICC_HOST_ID
)
863 info
->se_info
.count_pipes
++;
865 if (info
->se_info
.count_pipes
== info
->se_info
.expected_pipes
) {
866 del_timer_sync(&info
->se_info
.se_active_timer
);
867 info
->se_info
.se_active
= false;
868 info
->se_info
.count_pipes
= 0;
869 complete(&info
->se_info
.req_completion
);
875 static int st21nfca_admin_event_received(struct nfc_hci_dev
*hdev
, u8 event
,
878 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
880 pr_debug("admin event: %x\n", event
);
883 case ST21NFCA_EVT_HOT_PLUG
:
884 if (info
->se_info
.se_active
) {
885 if (!ST21NFCA_EVT_HOT_PLUG_IS_INHIBITED(skb
)) {
886 del_timer_sync(&info
->se_info
.se_active_timer
);
887 info
->se_info
.se_active
= false;
888 complete(&info
->se_info
.req_completion
);
890 mod_timer(&info
->se_info
.se_active_timer
,
892 msecs_to_jiffies(ST21NFCA_SE_TO_PIPES
));
897 nfc_err(&hdev
->ndev
->dev
, "Unexpected event on admin gate\n");
905 * <= 0: driver handled the event, skb consumed
906 * 1: driver does not handle the event, please do standard processing
908 static int st21nfca_hci_event_received(struct nfc_hci_dev
*hdev
, u8 pipe
,
909 u8 event
, struct sk_buff
*skb
)
911 u8 gate
= hdev
->pipes
[pipe
].gate
;
912 u8 host
= hdev
->pipes
[pipe
].dest_host
;
914 pr_debug("hci event: %d gate: %x\n", event
, gate
);
917 case NFC_HCI_ADMIN_GATE
:
918 return st21nfca_admin_event_received(hdev
, event
, skb
);
919 case ST21NFCA_RF_CARD_F_GATE
:
920 return st21nfca_dep_event_received(hdev
, event
, skb
);
921 case ST21NFCA_CONNECTIVITY_GATE
:
922 return st21nfca_connectivity_event_received(hdev
, host
,
924 case ST21NFCA_APDU_READER_GATE
:
925 return st21nfca_apdu_reader_event_received(hdev
, event
, skb
);
926 case NFC_HCI_LOOPBACK_GATE
:
927 return st21nfca_hci_loopback_event_received(hdev
, event
, skb
);
933 static struct nfc_hci_ops st21nfca_hci_ops
= {
934 .open
= st21nfca_hci_open
,
935 .close
= st21nfca_hci_close
,
936 .load_session
= st21nfca_hci_load_session
,
937 .hci_ready
= st21nfca_hci_ready
,
938 .xmit
= st21nfca_hci_xmit
,
939 .start_poll
= st21nfca_hci_start_poll
,
940 .stop_poll
= st21nfca_hci_stop_poll
,
941 .dep_link_up
= st21nfca_hci_dep_link_up
,
942 .dep_link_down
= st21nfca_hci_dep_link_down
,
943 .target_from_gate
= st21nfca_hci_target_from_gate
,
944 .complete_target_discovered
= st21nfca_hci_complete_target_discovered
,
945 .im_transceive
= st21nfca_hci_im_transceive
,
946 .tm_send
= st21nfca_hci_tm_send
,
947 .check_presence
= st21nfca_hci_check_presence
,
948 .event_received
= st21nfca_hci_event_received
,
949 .cmd_received
= st21nfca_hci_cmd_received
,
950 .discover_se
= st21nfca_hci_discover_se
,
951 .enable_se
= st21nfca_hci_enable_se
,
952 .disable_se
= st21nfca_hci_disable_se
,
953 .se_io
= st21nfca_hci_se_io
,
956 int st21nfca_hci_probe(void *phy_id
, struct nfc_phy_ops
*phy_ops
,
957 char *llc_name
, int phy_headroom
, int phy_tailroom
,
958 int phy_payload
, struct nfc_hci_dev
**hdev
,
959 struct st21nfca_se_status
*se_status
)
961 struct st21nfca_hci_info
*info
;
965 struct nfc_hci_init_data init_data
;
966 unsigned long quirks
= 0;
968 info
= kzalloc(sizeof(struct st21nfca_hci_info
), GFP_KERNEL
);
974 info
->phy_ops
= phy_ops
;
975 info
->phy_id
= phy_id
;
976 info
->state
= ST21NFCA_ST_COLD
;
977 mutex_init(&info
->info_lock
);
979 init_data
.gate_count
= ARRAY_SIZE(st21nfca_gates
);
981 memcpy(init_data
.gates
, st21nfca_gates
, sizeof(st21nfca_gates
));
984 * Session id must include the driver name + i2c bus addr
985 * persistent info to discriminate 2 identical chips
987 dev_num
= find_first_zero_bit(dev_mask
, ST21NFCA_NUM_DEVICES
);
988 if (dev_num
>= ST21NFCA_NUM_DEVICES
)
991 set_bit(dev_num
, dev_mask
);
993 scnprintf(init_data
.session_id
, sizeof(init_data
.session_id
), "%s%2x",
996 protocols
= NFC_PROTO_JEWEL_MASK
|
997 NFC_PROTO_MIFARE_MASK
|
998 NFC_PROTO_FELICA_MASK
|
999 NFC_PROTO_ISO14443_MASK
|
1000 NFC_PROTO_ISO14443_B_MASK
|
1001 NFC_PROTO_ISO15693_MASK
|
1002 NFC_PROTO_NFC_DEP_MASK
;
1004 set_bit(NFC_HCI_QUIRK_SHORT_CLEAR
, &quirks
);
1007 nfc_hci_allocate_device(&st21nfca_hci_ops
, &init_data
, quirks
,
1008 protocols
, llc_name
,
1009 phy_headroom
+ ST21NFCA_CMDS_HEADROOM
,
1010 phy_tailroom
, phy_payload
);
1013 pr_err("Cannot allocate nfc hdev.\n");
1015 goto err_alloc_hdev
;
1018 info
->se_status
= se_status
;
1020 nfc_hci_set_clientdata(info
->hdev
, info
);
1022 r
= nfc_hci_register_device(info
->hdev
);
1027 st21nfca_dep_init(info
->hdev
);
1028 st21nfca_se_init(info
->hdev
);
1029 st21nfca_vendor_cmds_init(info
->hdev
);
1034 nfc_hci_free_device(info
->hdev
);
1041 EXPORT_SYMBOL(st21nfca_hci_probe
);
1043 void st21nfca_hci_remove(struct nfc_hci_dev
*hdev
)
1045 struct st21nfca_hci_info
*info
= nfc_hci_get_clientdata(hdev
);
1047 st21nfca_dep_deinit(hdev
);
1048 st21nfca_se_deinit(hdev
);
1049 nfc_hci_unregister_device(hdev
);
1050 nfc_hci_free_device(hdev
);
1053 EXPORT_SYMBOL(st21nfca_hci_remove
);
1055 MODULE_LICENSE("GPL");
1056 MODULE_DESCRIPTION(DRIVER_DESC
);