2 * Copyright (C) 2014 STMicroelectronics SAS. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, see <http://www.gnu.org/licenses/>.
17 #include <net/nfc/hci.h>
21 #define ST21NFCA_EVT_UICC_ACTIVATE 0x10
22 #define ST21NFCA_EVT_UICC_DEACTIVATE 0x13
23 #define ST21NFCA_EVT_SE_HARD_RESET 0x20
24 #define ST21NFCA_EVT_SE_SOFT_RESET 0x11
25 #define ST21NFCA_EVT_SE_END_OF_APDU_TRANSFER 0x21
26 #define ST21NFCA_EVT_SE_ACTIVATE 0x22
27 #define ST21NFCA_EVT_SE_DEACTIVATE 0x23
29 #define ST21NFCA_EVT_TRANSMIT_DATA 0x10
30 #define ST21NFCA_EVT_WTX_REQUEST 0x11
32 #define ST21NFCA_EVT_CONNECTIVITY 0x10
33 #define ST21NFCA_EVT_TRANSACTION 0x12
35 #define ST21NFCA_SE_TO_HOT_PLUG 1000
36 /* Connectivity pipe only */
37 #define ST21NFCA_SE_COUNT_PIPE_UICC 0x01
38 /* Connectivity + APDU Reader pipe */
39 #define ST21NFCA_SE_COUNT_PIPE_EMBEDDED 0x02
41 #define ST21NFCA_SE_MODE_OFF 0x00
42 #define ST21NFCA_SE_MODE_ON 0x01
44 #define ST21NFCA_PARAM_ATR 0x01
45 #define ST21NFCA_ATR_DEFAULT_BWI 0x04
48 * WT = 2^BWI/10[s], convert into msecs and add a secure
49 * room by increasing by 2 this timeout
51 #define ST21NFCA_BWI_TO_TIMEOUT(x) ((1 << x) * 200)
52 #define ST21NFCA_ATR_GET_Y_FROM_TD(x) (x >> 4)
54 /* If TA is present bit 0 is set */
55 #define ST21NFCA_ATR_TA_PRESENT(x) (x & 0x01)
56 /* If TB is present bit 1 is set */
57 #define ST21NFCA_ATR_TB_PRESENT(x) (x & 0x02)
59 static u8 st21nfca_se_get_bwi(struct nfc_hci_dev *hdev)
63 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
65 /* Bits 8 to 5 of the first TB for T=1 encode BWI from zero to nine */
66 for (i = 1; i < ST21NFCA_ESE_MAX_LENGTH; i++) {
67 td = ST21NFCA_ATR_GET_Y_FROM_TD(info->se_info.atr[i]);
68 if (ST21NFCA_ATR_TA_PRESENT(td))
70 if (ST21NFCA_ATR_TB_PRESENT(td)) {
72 return info->se_info.atr[i] >> 4;
75 return ST21NFCA_ATR_DEFAULT_BWI;
78 static void st21nfca_se_get_atr(struct nfc_hci_dev *hdev)
82 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
84 r = nfc_hci_get_param(hdev, ST21NFCA_APDU_READER_GATE,
85 ST21NFCA_PARAM_ATR, &skb);
89 if (skb->len <= ST21NFCA_ESE_MAX_LENGTH) {
90 memcpy(info->se_info.atr, skb->data, skb->len);
91 info->se_info.wt_timeout =
92 ST21NFCA_BWI_TO_TIMEOUT(st21nfca_se_get_bwi(hdev));
97 static int st21nfca_hci_control_se(struct nfc_hci_dev *hdev, u32 se_idx,
100 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
102 struct sk_buff *sk_host_list;
103 u8 se_event, host_id;
106 case NFC_HCI_UICC_HOST_ID:
107 se_event = (state == ST21NFCA_SE_MODE_ON ?
108 ST21NFCA_EVT_UICC_ACTIVATE :
109 ST21NFCA_EVT_UICC_DEACTIVATE);
111 info->se_info.count_pipes = 0;
112 info->se_info.expected_pipes = ST21NFCA_SE_COUNT_PIPE_UICC;
114 case ST21NFCA_ESE_HOST_ID:
115 se_event = (state == ST21NFCA_SE_MODE_ON ?
116 ST21NFCA_EVT_SE_ACTIVATE :
117 ST21NFCA_EVT_SE_DEACTIVATE);
119 info->se_info.count_pipes = 0;
120 info->se_info.expected_pipes = ST21NFCA_SE_COUNT_PIPE_EMBEDDED;
127 * Wait for an EVT_HOT_PLUG in order to
128 * retrieve a relevant host list.
130 reinit_completion(&info->se_info.req_completion);
131 r = nfc_hci_send_event(hdev, ST21NFCA_DEVICE_MGNT_GATE, se_event,
136 mod_timer(&info->se_info.se_active_timer, jiffies +
137 msecs_to_jiffies(ST21NFCA_SE_TO_HOT_PLUG));
138 info->se_info.se_active = true;
140 /* Ignore return value and check in any case the host_list */
141 wait_for_completion_interruptible(&info->se_info.req_completion);
143 r = nfc_hci_get_param(hdev, NFC_HCI_ADMIN_GATE,
144 NFC_HCI_ADMIN_HOST_LIST,
149 for (i = 0; i < sk_host_list->len &&
150 sk_host_list->data[i] != se_idx; i++)
152 host_id = sk_host_list->data[i];
153 kfree_skb(sk_host_list);
155 if (state == ST21NFCA_SE_MODE_ON && host_id == se_idx)
157 else if (state == ST21NFCA_SE_MODE_OFF && host_id != se_idx)
163 int st21nfca_hci_discover_se(struct nfc_hci_dev *hdev)
165 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
168 if (test_bit(ST21NFCA_FACTORY_MODE, &hdev->quirks))
171 if (info->se_status->is_uicc_present) {
172 nfc_add_se(hdev->ndev, NFC_HCI_UICC_HOST_ID, NFC_SE_UICC);
176 if (info->se_status->is_ese_present) {
177 nfc_add_se(hdev->ndev, ST21NFCA_ESE_HOST_ID, NFC_SE_EMBEDDED);
183 EXPORT_SYMBOL(st21nfca_hci_discover_se);
185 int st21nfca_hci_enable_se(struct nfc_hci_dev *hdev, u32 se_idx)
190 * According to upper layer, se_idx == NFC_SE_UICC when
191 * info->se_status->is_uicc_enable is true should never happen.
194 r = st21nfca_hci_control_se(hdev, se_idx, ST21NFCA_SE_MODE_ON);
195 if (r == ST21NFCA_ESE_HOST_ID) {
196 st21nfca_se_get_atr(hdev);
197 r = nfc_hci_send_event(hdev, ST21NFCA_APDU_READER_GATE,
198 ST21NFCA_EVT_SE_SOFT_RESET, NULL, 0);
203 * The activation tentative failed, the secure element
204 * is not connected. Remove from the list.
206 nfc_remove_se(hdev->ndev, se_idx);
212 EXPORT_SYMBOL(st21nfca_hci_enable_se);
214 int st21nfca_hci_disable_se(struct nfc_hci_dev *hdev, u32 se_idx)
219 * According to upper layer, se_idx == NFC_SE_UICC when
220 * info->se_status->is_uicc_enable is true should never happen
223 r = st21nfca_hci_control_se(hdev, se_idx, ST21NFCA_SE_MODE_OFF);
229 EXPORT_SYMBOL(st21nfca_hci_disable_se);
231 int st21nfca_hci_se_io(struct nfc_hci_dev *hdev, u32 se_idx,
232 u8 *apdu, size_t apdu_length,
233 se_io_cb_t cb, void *cb_context)
235 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
237 pr_debug("se_io %x\n", se_idx);
240 case ST21NFCA_ESE_HOST_ID:
241 info->se_info.cb = cb;
242 info->se_info.cb_context = cb_context;
243 mod_timer(&info->se_info.bwi_timer, jiffies +
244 msecs_to_jiffies(info->se_info.wt_timeout));
245 info->se_info.bwi_active = true;
246 return nfc_hci_send_event(hdev, ST21NFCA_APDU_READER_GATE,
247 ST21NFCA_EVT_TRANSMIT_DATA,
253 EXPORT_SYMBOL(st21nfca_hci_se_io);
255 static void st21nfca_se_wt_timeout(unsigned long data)
258 * No answer from the secure element
259 * within the defined timeout.
260 * Let's send a reset request as recovery procedure.
261 * According to the situation, we first try to send a software reset
262 * to the secure element. If the next command is still not
263 * answering in time, we send to the CLF a secure element hardware
266 /* hardware reset managed through VCC_UICC_OUT power supply */
268 struct st21nfca_hci_info *info = (struct st21nfca_hci_info *) data;
272 info->se_info.bwi_active = false;
274 if (!info->se_info.xch_error) {
275 info->se_info.xch_error = true;
276 nfc_hci_send_event(info->hdev, ST21NFCA_APDU_READER_GATE,
277 ST21NFCA_EVT_SE_SOFT_RESET, NULL, 0);
279 info->se_info.xch_error = false;
280 nfc_hci_send_event(info->hdev, ST21NFCA_DEVICE_MGNT_GATE,
281 ST21NFCA_EVT_SE_HARD_RESET, ¶m, 1);
283 info->se_info.cb(info->se_info.cb_context, NULL, 0, -ETIME);
286 static void st21nfca_se_activation_timeout(unsigned long data)
288 struct st21nfca_hci_info *info = (struct st21nfca_hci_info *) data;
292 info->se_info.se_active = false;
294 complete(&info->se_info.req_completion);
299 * <= 0: driver handled the event, skb consumed
300 * 1: driver does not handle the event, please do standard processing
302 int st21nfca_connectivity_event_received(struct nfc_hci_dev *hdev, u8 host,
303 u8 event, struct sk_buff *skb)
306 struct device *dev = &hdev->ndev->dev;
307 struct nfc_evt_transaction *transaction;
309 pr_debug("connectivity gate event: %x\n", event);
312 case ST21NFCA_EVT_CONNECTIVITY:
313 r = nfc_se_connectivity(hdev->ndev, host);
315 case ST21NFCA_EVT_TRANSACTION:
317 * According to specification etsi 102 622
318 * 11.2.2.4 EVT_TRANSACTION Table 52
319 * Description Tag Length
321 * PARAMETERS 82 0 to 255
323 if (skb->len < NFC_MIN_AID_LENGTH + 2 &&
324 skb->data[0] != NFC_EVT_TRANSACTION_AID_TAG)
327 transaction = (struct nfc_evt_transaction *)devm_kzalloc(dev,
328 skb->len - 2, GFP_KERNEL);
330 transaction->aid_len = skb->data[1];
331 memcpy(transaction->aid, &skb->data[2],
332 transaction->aid_len);
334 /* Check next byte is PARAMETERS tag (82) */
335 if (skb->data[transaction->aid_len + 2] !=
336 NFC_EVT_TRANSACTION_PARAMS_TAG)
339 transaction->params_len = skb->data[transaction->aid_len + 3];
340 memcpy(transaction->params, skb->data +
341 transaction->aid_len + 4, transaction->params_len);
343 r = nfc_se_transaction(hdev->ndev, host, transaction);
346 nfc_err(&hdev->ndev->dev, "Unexpected event on connectivity gate\n");
352 EXPORT_SYMBOL(st21nfca_connectivity_event_received);
354 int st21nfca_apdu_reader_event_received(struct nfc_hci_dev *hdev,
355 u8 event, struct sk_buff *skb)
358 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
360 pr_debug("apdu reader gate event: %x\n", event);
363 case ST21NFCA_EVT_TRANSMIT_DATA:
364 del_timer_sync(&info->se_info.bwi_timer);
365 info->se_info.bwi_active = false;
366 r = nfc_hci_send_event(hdev, ST21NFCA_DEVICE_MGNT_GATE,
367 ST21NFCA_EVT_SE_END_OF_APDU_TRANSFER, NULL, 0);
371 info->se_info.cb(info->se_info.cb_context,
372 skb->data, skb->len, 0);
374 case ST21NFCA_EVT_WTX_REQUEST:
375 mod_timer(&info->se_info.bwi_timer, jiffies +
376 msecs_to_jiffies(info->se_info.wt_timeout));
379 nfc_err(&hdev->ndev->dev, "Unexpected event on apdu reader gate\n");
387 EXPORT_SYMBOL(st21nfca_apdu_reader_event_received);
389 void st21nfca_se_init(struct nfc_hci_dev *hdev)
391 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
393 init_completion(&info->se_info.req_completion);
394 /* initialize timers */
395 init_timer(&info->se_info.bwi_timer);
396 info->se_info.bwi_timer.data = (unsigned long)info;
397 info->se_info.bwi_timer.function = st21nfca_se_wt_timeout;
398 info->se_info.bwi_active = false;
400 init_timer(&info->se_info.se_active_timer);
401 info->se_info.se_active_timer.data = (unsigned long)info;
402 info->se_info.se_active_timer.function = st21nfca_se_activation_timeout;
403 info->se_info.se_active = false;
405 info->se_info.count_pipes = 0;
406 info->se_info.expected_pipes = 0;
408 info->se_info.xch_error = false;
410 info->se_info.wt_timeout =
411 ST21NFCA_BWI_TO_TIMEOUT(ST21NFCA_ATR_DEFAULT_BWI);
413 EXPORT_SYMBOL(st21nfca_se_init);
415 void st21nfca_se_deinit(struct nfc_hci_dev *hdev)
417 struct st21nfca_hci_info *info = nfc_hci_get_clientdata(hdev);
419 if (info->se_info.bwi_active)
420 del_timer_sync(&info->se_info.bwi_timer);
421 if (info->se_info.se_active)
422 del_timer_sync(&info->se_info.se_active_timer);
424 info->se_info.bwi_active = false;
425 info->se_info.se_active = false;
427 EXPORT_SYMBOL(st21nfca_se_deinit);