1 // SPDX-License-Identifier: GPL-2.0-only
3 * The NFC Controller Interface is the communication protocol between an
4 * NFC Controller (NFCC) and a Device Host (DH).
5 * This is the HCI over NCI implementation, as specified in the 10.2
6 * section of the NCI 1.1 specification.
8 * Copyright (C) 2014 STMicroelectronics SAS. All rights reserved.
11 #include <linux/skbuff.h>
14 #include <net/nfc/nci.h>
15 #include <net/nfc/nci_core.h>
16 #include <linux/nfc.h>
26 struct nci_hci_create_pipe_params {
32 struct nci_hci_create_pipe_resp {
40 struct nci_hci_delete_pipe_noti {
44 struct nci_hci_all_pipe_cleared_noti {
48 struct nci_hcp_message {
49 u8 header; /* type -cmd,evt,rsp- + instruction */
53 struct nci_hcp_packet {
54 u8 header; /* cbit+pipe */
55 struct nci_hcp_message message;
58 #define NCI_HCI_ANY_SET_PARAMETER 0x01
59 #define NCI_HCI_ANY_GET_PARAMETER 0x02
60 #define NCI_HCI_ANY_CLOSE_PIPE 0x04
61 #define NCI_HCI_ADM_CLEAR_ALL_PIPE 0x14
63 #define NCI_HFP_NO_CHAINING 0x80
65 #define NCI_NFCEE_ID_HCI 0x80
67 #define NCI_EVT_HOT_PLUG 0x03
69 #define NCI_HCI_ADMIN_PARAM_SESSION_IDENTITY 0x01
70 #define NCI_HCI_ADM_CREATE_PIPE 0x10
71 #define NCI_HCI_ADM_DELETE_PIPE 0x11
74 #define NCI_HCI_HCP_PACKET_HEADER_LEN 1
75 #define NCI_HCI_HCP_MESSAGE_HEADER_LEN 1
76 #define NCI_HCI_HCP_HEADER_LEN 2
79 #define NCI_HCI_HCP_COMMAND 0x00
80 #define NCI_HCI_HCP_EVENT 0x01
81 #define NCI_HCI_HCP_RESPONSE 0x02
83 #define NCI_HCI_ADM_NOTIFY_PIPE_CREATED 0x12
84 #define NCI_HCI_ADM_NOTIFY_PIPE_DELETED 0x13
85 #define NCI_HCI_ADM_NOTIFY_ALL_PIPE_CLEARED 0x15
87 #define NCI_HCI_FRAGMENT 0x7f
88 #define NCI_HCP_HEADER(type, instr) ((((type) & 0x03) << 6) |\
91 #define NCI_HCP_MSG_GET_TYPE(header) ((header & 0xc0) >> 6)
92 #define NCI_HCP_MSG_GET_CMD(header) (header & 0x3f)
93 #define NCI_HCP_MSG_GET_PIPE(header) (header & 0x7f)
95 static int nci_hci_result_to_errno(u8 result)
100 case NCI_HCI_ANY_E_REG_PAR_UNKNOWN:
102 case NCI_HCI_ANY_E_TIMEOUT:
110 static void nci_hci_reset_pipes(struct nci_hci_dev *hdev)
114 for (i = 0; i < NCI_HCI_MAX_PIPES; i++) {
115 hdev->pipes[i].gate = NCI_HCI_INVALID_GATE;
116 hdev->pipes[i].host = NCI_HCI_INVALID_HOST;
118 memset(hdev->gate2pipe, NCI_HCI_INVALID_PIPE, sizeof(hdev->gate2pipe));
121 static void nci_hci_reset_pipes_per_host(struct nci_dev *ndev, u8 host)
125 for (i = 0; i < NCI_HCI_MAX_PIPES; i++) {
126 if (ndev->hci_dev->pipes[i].host == host) {
127 ndev->hci_dev->pipes[i].gate = NCI_HCI_INVALID_GATE;
128 ndev->hci_dev->pipes[i].host = NCI_HCI_INVALID_HOST;
133 /* Fragment HCI data over NCI packet.
134 * NFC Forum NCI 10.2.2 Data Exchange:
135 * The payload of the Data Packets sent on the Logical Connection SHALL be
136 * valid HCP packets, as defined within [ETSI_102622]. Each Data Packet SHALL
137 * contain a single HCP packet. NCI Segmentation and Reassembly SHALL NOT be
138 * applied to Data Messages in either direction. The HCI fragmentation mechanism
139 * is used if required.
141 static int nci_hci_send_data(struct nci_dev *ndev, u8 pipe,
142 const u8 data_type, const u8 *data,
145 struct nci_conn_info *conn_info;
150 conn_info = ndev->hci_dev->conn_info;
155 skb = nci_skb_alloc(ndev, conn_info->max_pkt_payload_len +
156 NCI_DATA_HDR_SIZE, GFP_KERNEL);
160 skb_reserve(skb, NCI_DATA_HDR_SIZE + 2);
161 *(u8 *)skb_push(skb, 1) = data_type;
164 /* If last packet add NCI_HFP_NO_CHAINING */
165 if (i + conn_info->max_pkt_payload_len -
166 (skb->len + 1) >= data_len) {
167 cb |= NCI_HFP_NO_CHAINING;
170 len = conn_info->max_pkt_payload_len - skb->len - 1;
173 *(u8 *)skb_push(skb, 1) = cb;
176 skb_put_data(skb, data + i, len);
178 r = nci_send_data(ndev, conn_info->conn_id, skb);
185 skb = nci_skb_alloc(ndev,
186 conn_info->max_pkt_payload_len +
187 NCI_DATA_HDR_SIZE, GFP_KERNEL);
191 skb_reserve(skb, NCI_DATA_HDR_SIZE + 1);
193 } while (i < data_len);
198 static void nci_hci_send_data_req(struct nci_dev *ndev, unsigned long opt)
200 struct nci_data *data = (struct nci_data *)opt;
202 nci_hci_send_data(ndev, data->pipe, data->cmd,
203 data->data, data->data_len);
206 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
207 const u8 *param, size_t param_len)
209 u8 pipe = ndev->hci_dev->gate2pipe[gate];
211 if (pipe == NCI_HCI_INVALID_PIPE)
212 return -EADDRNOTAVAIL;
214 return nci_hci_send_data(ndev, pipe,
215 NCI_HCP_HEADER(NCI_HCI_HCP_EVENT, event),
218 EXPORT_SYMBOL(nci_hci_send_event);
220 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate, u8 cmd,
221 const u8 *param, size_t param_len,
222 struct sk_buff **skb)
224 struct nci_hcp_message *message;
225 struct nci_conn_info *conn_info;
226 struct nci_data data;
228 u8 pipe = ndev->hci_dev->gate2pipe[gate];
230 if (pipe == NCI_HCI_INVALID_PIPE)
231 return -EADDRNOTAVAIL;
233 conn_info = ndev->hci_dev->conn_info;
237 data.conn_id = conn_info->conn_id;
239 data.cmd = NCI_HCP_HEADER(NCI_HCI_HCP_COMMAND, cmd);
241 data.data_len = param_len;
243 r = nci_request(ndev, nci_hci_send_data_req, (unsigned long)&data,
244 msecs_to_jiffies(NCI_DATA_TIMEOUT));
245 if (r == NCI_STATUS_OK) {
246 message = (struct nci_hcp_message *)conn_info->rx_skb->data;
247 r = nci_hci_result_to_errno(
248 NCI_HCP_MSG_GET_CMD(message->header));
249 skb_pull(conn_info->rx_skb, NCI_HCI_HCP_MESSAGE_HEADER_LEN);
252 *skb = conn_info->rx_skb;
257 EXPORT_SYMBOL(nci_hci_send_cmd);
259 int nci_hci_clear_all_pipes(struct nci_dev *ndev)
263 r = nci_hci_send_cmd(ndev, NCI_HCI_ADMIN_GATE,
264 NCI_HCI_ADM_CLEAR_ALL_PIPE, NULL, 0, NULL);
268 nci_hci_reset_pipes(ndev->hci_dev);
271 EXPORT_SYMBOL(nci_hci_clear_all_pipes);
273 static void nci_hci_event_received(struct nci_dev *ndev, u8 pipe,
274 u8 event, struct sk_buff *skb)
276 if (ndev->ops->hci_event_received)
277 ndev->ops->hci_event_received(ndev, pipe, event, skb);
280 static void nci_hci_cmd_received(struct nci_dev *ndev, u8 pipe,
281 u8 cmd, struct sk_buff *skb)
283 u8 gate = ndev->hci_dev->pipes[pipe].gate;
284 u8 status = NCI_HCI_ANY_OK | ~NCI_HCI_FRAGMENT;
285 u8 dest_gate, new_pipe;
286 struct nci_hci_create_pipe_resp *create_info;
287 struct nci_hci_delete_pipe_noti *delete_info;
288 struct nci_hci_all_pipe_cleared_noti *cleared_info;
290 pr_debug("from gate %x pipe %x cmd %x\n", gate, pipe, cmd);
293 case NCI_HCI_ADM_NOTIFY_PIPE_CREATED:
295 status = NCI_HCI_ANY_E_NOK;
298 create_info = (struct nci_hci_create_pipe_resp *)skb->data;
299 dest_gate = create_info->dest_gate;
300 new_pipe = create_info->pipe;
301 if (new_pipe >= NCI_HCI_MAX_PIPES) {
302 status = NCI_HCI_ANY_E_NOK;
306 /* Save the new created pipe and bind with local gate,
307 * the description for skb->data[3] is destination gate id
308 * but since we received this cmd from host controller, we
309 * are the destination and it is our local gate
311 ndev->hci_dev->gate2pipe[dest_gate] = new_pipe;
312 ndev->hci_dev->pipes[new_pipe].gate = dest_gate;
313 ndev->hci_dev->pipes[new_pipe].host =
314 create_info->src_host;
316 case NCI_HCI_ANY_OPEN_PIPE:
317 /* If the pipe is not created report an error */
318 if (gate == NCI_HCI_INVALID_GATE) {
319 status = NCI_HCI_ANY_E_NOK;
323 case NCI_HCI_ADM_NOTIFY_PIPE_DELETED:
325 status = NCI_HCI_ANY_E_NOK;
328 delete_info = (struct nci_hci_delete_pipe_noti *)skb->data;
329 if (delete_info->pipe >= NCI_HCI_MAX_PIPES) {
330 status = NCI_HCI_ANY_E_NOK;
334 ndev->hci_dev->pipes[delete_info->pipe].gate =
335 NCI_HCI_INVALID_GATE;
336 ndev->hci_dev->pipes[delete_info->pipe].host =
337 NCI_HCI_INVALID_HOST;
339 case NCI_HCI_ADM_NOTIFY_ALL_PIPE_CLEARED:
341 status = NCI_HCI_ANY_E_NOK;
346 (struct nci_hci_all_pipe_cleared_noti *)skb->data;
347 nci_hci_reset_pipes_per_host(ndev, cleared_info->host);
350 pr_debug("Discarded unknown cmd %x to gate %x\n", cmd, gate);
354 if (ndev->ops->hci_cmd_received)
355 ndev->ops->hci_cmd_received(ndev, pipe, cmd, skb);
358 nci_hci_send_data(ndev, pipe, status, NULL, 0);
363 static void nci_hci_resp_received(struct nci_dev *ndev, u8 pipe,
366 struct nci_conn_info *conn_info;
368 conn_info = ndev->hci_dev->conn_info;
372 conn_info->rx_skb = skb;
375 nci_req_complete(ndev, NCI_STATUS_OK);
378 /* Receive hcp message for pipe, with type and cmd.
379 * skb contains optional message data only.
381 static void nci_hci_hcp_message_rx(struct nci_dev *ndev, u8 pipe,
382 u8 type, u8 instruction, struct sk_buff *skb)
385 case NCI_HCI_HCP_RESPONSE:
386 nci_hci_resp_received(ndev, pipe, skb);
388 case NCI_HCI_HCP_COMMAND:
389 nci_hci_cmd_received(ndev, pipe, instruction, skb);
391 case NCI_HCI_HCP_EVENT:
392 nci_hci_event_received(ndev, pipe, instruction, skb);
395 pr_err("UNKNOWN MSG Type %d, instruction=%d\n",
401 nci_req_complete(ndev, NCI_STATUS_OK);
404 static void nci_hci_msg_rx_work(struct work_struct *work)
406 struct nci_hci_dev *hdev =
407 container_of(work, struct nci_hci_dev, msg_rx_work);
409 struct nci_hcp_message *message;
410 u8 pipe, type, instruction;
412 while ((skb = skb_dequeue(&hdev->msg_rx_queue)) != NULL) {
413 pipe = NCI_HCP_MSG_GET_PIPE(skb->data[0]);
414 skb_pull(skb, NCI_HCI_HCP_PACKET_HEADER_LEN);
415 message = (struct nci_hcp_message *)skb->data;
416 type = NCI_HCP_MSG_GET_TYPE(message->header);
417 instruction = NCI_HCP_MSG_GET_CMD(message->header);
418 skb_pull(skb, NCI_HCI_HCP_MESSAGE_HEADER_LEN);
420 nci_hci_hcp_message_rx(hdev->ndev, pipe,
421 type, instruction, skb);
425 void nci_hci_data_received_cb(void *context,
426 struct sk_buff *skb, int err)
428 struct nci_dev *ndev = (struct nci_dev *)context;
429 struct nci_hcp_packet *packet;
431 struct sk_buff *hcp_skb;
432 struct sk_buff *frag_skb;
438 nci_req_complete(ndev, err);
442 packet = (struct nci_hcp_packet *)skb->data;
443 if ((packet->header & ~NCI_HCI_FRAGMENT) == 0) {
444 skb_queue_tail(&ndev->hci_dev->rx_hcp_frags, skb);
448 /* it's the last fragment. Does it need re-aggregation? */
449 if (skb_queue_len(&ndev->hci_dev->rx_hcp_frags)) {
450 pipe = NCI_HCP_MSG_GET_PIPE(packet->header);
451 skb_queue_tail(&ndev->hci_dev->rx_hcp_frags, skb);
454 skb_queue_walk(&ndev->hci_dev->rx_hcp_frags, frag_skb) {
455 msg_len += (frag_skb->len -
456 NCI_HCI_HCP_PACKET_HEADER_LEN);
459 hcp_skb = nfc_alloc_recv_skb(NCI_HCI_HCP_PACKET_HEADER_LEN +
460 msg_len, GFP_KERNEL);
462 nci_req_complete(ndev, -ENOMEM);
466 skb_put_u8(hcp_skb, pipe);
468 skb_queue_walk(&ndev->hci_dev->rx_hcp_frags, frag_skb) {
469 msg_len = frag_skb->len - NCI_HCI_HCP_PACKET_HEADER_LEN;
470 skb_put_data(hcp_skb,
471 frag_skb->data + NCI_HCI_HCP_PACKET_HEADER_LEN,
475 skb_queue_purge(&ndev->hci_dev->rx_hcp_frags);
477 packet->header &= NCI_HCI_FRAGMENT;
481 /* if this is a response, dispatch immediately to
482 * unblock waiting cmd context. Otherwise, enqueue to dispatch
483 * in separate context where handler can also execute command.
485 packet = (struct nci_hcp_packet *)hcp_skb->data;
486 type = NCI_HCP_MSG_GET_TYPE(packet->message.header);
487 if (type == NCI_HCI_HCP_RESPONSE) {
488 pipe = NCI_HCP_MSG_GET_PIPE(packet->header);
489 skb_pull(hcp_skb, NCI_HCI_HCP_PACKET_HEADER_LEN);
490 nci_hci_hcp_message_rx(ndev, pipe, type,
491 NCI_STATUS_OK, hcp_skb);
493 skb_queue_tail(&ndev->hci_dev->msg_rx_queue, hcp_skb);
494 schedule_work(&ndev->hci_dev->msg_rx_work);
498 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe)
500 struct nci_data data;
501 struct nci_conn_info *conn_info;
503 conn_info = ndev->hci_dev->conn_info;
507 data.conn_id = conn_info->conn_id;
509 data.cmd = NCI_HCP_HEADER(NCI_HCI_HCP_COMMAND,
510 NCI_HCI_ANY_OPEN_PIPE);
514 return nci_request(ndev, nci_hci_send_data_req,
515 (unsigned long)&data,
516 msecs_to_jiffies(NCI_DATA_TIMEOUT));
518 EXPORT_SYMBOL(nci_hci_open_pipe);
520 static u8 nci_hci_create_pipe(struct nci_dev *ndev, u8 dest_host,
521 u8 dest_gate, int *result)
525 struct nci_hci_create_pipe_params params;
526 struct nci_hci_create_pipe_resp *resp;
528 pr_debug("gate=%d\n", dest_gate);
530 params.src_gate = NCI_HCI_ADMIN_GATE;
531 params.dest_host = dest_host;
532 params.dest_gate = dest_gate;
534 *result = nci_hci_send_cmd(ndev, NCI_HCI_ADMIN_GATE,
535 NCI_HCI_ADM_CREATE_PIPE,
536 (u8 *)¶ms, sizeof(params), &skb);
538 return NCI_HCI_INVALID_PIPE;
540 resp = (struct nci_hci_create_pipe_resp *)skb->data;
544 pr_debug("pipe created=%d\n", pipe);
549 static int nci_hci_delete_pipe(struct nci_dev *ndev, u8 pipe)
553 return nci_hci_send_cmd(ndev, NCI_HCI_ADMIN_GATE,
554 NCI_HCI_ADM_DELETE_PIPE, &pipe, 1, NULL);
557 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
558 const u8 *param, size_t param_len)
560 struct nci_hcp_message *message;
561 struct nci_conn_info *conn_info;
562 struct nci_data data;
565 u8 pipe = ndev->hci_dev->gate2pipe[gate];
567 pr_debug("idx=%d to gate %d\n", idx, gate);
569 if (pipe == NCI_HCI_INVALID_PIPE)
570 return -EADDRNOTAVAIL;
572 conn_info = ndev->hci_dev->conn_info;
576 tmp = kmalloc(1 + param_len, GFP_KERNEL);
581 memcpy(tmp + 1, param, param_len);
583 data.conn_id = conn_info->conn_id;
585 data.cmd = NCI_HCP_HEADER(NCI_HCI_HCP_COMMAND,
586 NCI_HCI_ANY_SET_PARAMETER);
588 data.data_len = param_len + 1;
590 r = nci_request(ndev, nci_hci_send_data_req,
591 (unsigned long)&data,
592 msecs_to_jiffies(NCI_DATA_TIMEOUT));
593 if (r == NCI_STATUS_OK) {
594 message = (struct nci_hcp_message *)conn_info->rx_skb->data;
595 r = nci_hci_result_to_errno(
596 NCI_HCP_MSG_GET_CMD(message->header));
597 skb_pull(conn_info->rx_skb, NCI_HCI_HCP_MESSAGE_HEADER_LEN);
603 EXPORT_SYMBOL(nci_hci_set_param);
605 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
606 struct sk_buff **skb)
608 struct nci_hcp_message *message;
609 struct nci_conn_info *conn_info;
610 struct nci_data data;
612 u8 pipe = ndev->hci_dev->gate2pipe[gate];
614 pr_debug("idx=%d to gate %d\n", idx, gate);
616 if (pipe == NCI_HCI_INVALID_PIPE)
617 return -EADDRNOTAVAIL;
619 conn_info = ndev->hci_dev->conn_info;
623 data.conn_id = conn_info->conn_id;
625 data.cmd = NCI_HCP_HEADER(NCI_HCI_HCP_COMMAND,
626 NCI_HCI_ANY_GET_PARAMETER);
630 r = nci_request(ndev, nci_hci_send_data_req, (unsigned long)&data,
631 msecs_to_jiffies(NCI_DATA_TIMEOUT));
633 if (r == NCI_STATUS_OK) {
634 message = (struct nci_hcp_message *)conn_info->rx_skb->data;
635 r = nci_hci_result_to_errno(
636 NCI_HCP_MSG_GET_CMD(message->header));
637 skb_pull(conn_info->rx_skb, NCI_HCI_HCP_MESSAGE_HEADER_LEN);
640 *skb = conn_info->rx_skb;
645 EXPORT_SYMBOL(nci_hci_get_param);
647 int nci_hci_connect_gate(struct nci_dev *ndev,
648 u8 dest_host, u8 dest_gate, u8 pipe)
650 bool pipe_created = false;
653 if (pipe == NCI_HCI_DO_NOT_OPEN_PIPE)
656 if (ndev->hci_dev->gate2pipe[dest_gate] != NCI_HCI_INVALID_PIPE)
659 if (pipe != NCI_HCI_INVALID_PIPE)
663 case NCI_HCI_LINK_MGMT_GATE:
664 pipe = NCI_HCI_LINK_MGMT_PIPE;
666 case NCI_HCI_ADMIN_GATE:
667 pipe = NCI_HCI_ADMIN_PIPE;
670 pipe = nci_hci_create_pipe(ndev, dest_host, dest_gate, &r);
671 if (pipe == NCI_HCI_INVALID_PIPE)
678 r = nci_hci_open_pipe(ndev, pipe);
681 if (nci_hci_delete_pipe(ndev, pipe) < 0) {
682 /* TODO: Cannot clean by deleting pipe...
683 * -> inconsistent state
690 ndev->hci_dev->pipes[pipe].gate = dest_gate;
691 ndev->hci_dev->pipes[pipe].host = dest_host;
692 ndev->hci_dev->gate2pipe[dest_gate] = pipe;
696 EXPORT_SYMBOL(nci_hci_connect_gate);
698 static int nci_hci_dev_connect_gates(struct nci_dev *ndev,
700 struct nci_hci_gate *gates)
704 while (gate_count--) {
705 r = nci_hci_connect_gate(ndev, gates->dest_host,
706 gates->gate, gates->pipe);
715 int nci_hci_dev_session_init(struct nci_dev *ndev)
717 struct nci_conn_info *conn_info;
721 ndev->hci_dev->count_pipes = 0;
722 ndev->hci_dev->expected_pipes = 0;
724 conn_info = ndev->hci_dev->conn_info;
728 conn_info->data_exchange_cb = nci_hci_data_received_cb;
729 conn_info->data_exchange_cb_context = ndev;
731 nci_hci_reset_pipes(ndev->hci_dev);
733 if (ndev->hci_dev->init_data.gates[0].gate != NCI_HCI_ADMIN_GATE)
736 r = nci_hci_connect_gate(ndev,
737 ndev->hci_dev->init_data.gates[0].dest_host,
738 ndev->hci_dev->init_data.gates[0].gate,
739 ndev->hci_dev->init_data.gates[0].pipe);
743 r = nci_hci_get_param(ndev, NCI_HCI_ADMIN_GATE,
744 NCI_HCI_ADMIN_PARAM_SESSION_IDENTITY, &skb);
749 skb->len == strlen(ndev->hci_dev->init_data.session_id) &&
750 !memcmp(ndev->hci_dev->init_data.session_id, skb->data, skb->len) &&
751 ndev->ops->hci_load_session) {
752 /* Restore gate<->pipe table from some proprietary location. */
753 r = ndev->ops->hci_load_session(ndev);
755 r = nci_hci_clear_all_pipes(ndev);
759 r = nci_hci_dev_connect_gates(ndev,
760 ndev->hci_dev->init_data.gate_count,
761 ndev->hci_dev->init_data.gates);
765 r = nci_hci_set_param(ndev, NCI_HCI_ADMIN_GATE,
766 NCI_HCI_ADMIN_PARAM_SESSION_IDENTITY,
767 ndev->hci_dev->init_data.session_id,
768 strlen(ndev->hci_dev->init_data.session_id));
776 EXPORT_SYMBOL(nci_hci_dev_session_init);
778 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev)
780 struct nci_hci_dev *hdev;
782 hdev = kzalloc(sizeof(*hdev), GFP_KERNEL);
786 skb_queue_head_init(&hdev->rx_hcp_frags);
787 INIT_WORK(&hdev->msg_rx_work, nci_hci_msg_rx_work);
788 skb_queue_head_init(&hdev->msg_rx_queue);
794 void nci_hci_deallocate(struct nci_dev *ndev)
796 kfree(ndev->hci_dev);