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).
6 * Copyright (C) 2014 Marvell International Ltd.
7 * Copyright (C) 2011 Texas Instruments, Inc.
9 * Written by Ilan Elias <ilane@ti.com>
12 * This file is based on hci.h, which was written
13 * by Maxim Krasnyansky.
19 #include <net/nfc/nfc.h>
22 #define NCI_MAX_NUM_MAPPING_CONFIGS 10
23 #define NCI_MAX_NUM_RF_CONFIGS 10
24 #define NCI_MAX_NUM_CONN 10
25 #define NCI_MAX_PARAM_LEN 251
26 #define NCI_MAX_PAYLOAD_SIZE 255
27 #define NCI_MAX_PACKET_SIZE 258
28 #define NCI_MAX_LARGE_PARAMS_NCI_v2 15
29 #define NCI_VER_2_MASK 0x20
31 /* NCI Status Codes */
32 #define NCI_STATUS_OK 0x00
33 #define NCI_STATUS_REJECTED 0x01
34 #define NCI_STATUS_RF_FRAME_CORRUPTED 0x02
35 #define NCI_STATUS_FAILED 0x03
36 #define NCI_STATUS_NOT_INITIALIZED 0x04
37 #define NCI_STATUS_SYNTAX_ERROR 0x05
38 #define NCI_STATUS_SEMANTIC_ERROR 0x06
39 #define NCI_STATUS_UNKNOWN_GID 0x07
40 #define NCI_STATUS_UNKNOWN_OID 0x08
41 #define NCI_STATUS_INVALID_PARAM 0x09
42 #define NCI_STATUS_MESSAGE_SIZE_EXCEEDED 0x0a
43 /* Discovery Specific Status Codes */
44 #define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0
45 #define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1
46 #define NCI_STATUS_DISCOVERY_TEAR_DOWN 0xa2
47 /* RF Interface Specific Status Codes */
48 #define NCI_STATUS_RF_TRANSMISSION_ERROR 0xb0
49 #define NCI_STATUS_RF_PROTOCOL_ERROR 0xb1
50 #define NCI_STATUS_RF_TIMEOUT_ERROR 0xb2
51 /* NFCEE Interface Specific Status Codes */
52 #define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED 0xc0
53 #define NCI_STATUS_NFCEE_TRANSMISSION_ERROR 0xc1
54 #define NCI_STATUS_NFCEE_PROTOCOL_ERROR 0xc2
55 #define NCI_STATUS_NFCEE_TIMEOUT_ERROR 0xc3
57 /* NFCEE Interface/Protocols */
58 #define NCI_NFCEE_INTERFACE_APDU 0x00
59 #define NCI_NFCEE_INTERFACE_HCI_ACCESS 0x01
60 #define NCI_NFCEE_INTERFACE_TYPE3_CMD_SET 0x02
61 #define NCI_NFCEE_INTERFACE_TRANSPARENT 0x03
63 /* Destination type */
64 #define NCI_DESTINATION_NFCC_LOOPBACK 0x01
65 #define NCI_DESTINATION_REMOTE_NFC_ENDPOINT 0x02
66 #define NCI_DESTINATION_NFCEE 0x03
68 /* Destination-specific parameters type */
69 #define NCI_DESTINATION_SPECIFIC_PARAM_RF_TYPE 0x00
70 #define NCI_DESTINATION_SPECIFIC_PARAM_NFCEE_TYPE 0x01
72 /* NFCEE Discovery Action */
73 #define NCI_NFCEE_DISCOVERY_ACTION_DISABLE 0x00
74 #define NCI_NFCEE_DISCOVERY_ACTION_ENABLE 0x01
76 /* NCI RF Technology and Mode */
77 #define NCI_NFC_A_PASSIVE_POLL_MODE 0x00
78 #define NCI_NFC_B_PASSIVE_POLL_MODE 0x01
79 #define NCI_NFC_F_PASSIVE_POLL_MODE 0x02
80 #define NCI_NFC_A_ACTIVE_POLL_MODE 0x03
81 #define NCI_NFC_F_ACTIVE_POLL_MODE 0x05
82 #define NCI_NFC_V_PASSIVE_POLL_MODE 0x06
83 #define NCI_NFC_A_PASSIVE_LISTEN_MODE 0x80
84 #define NCI_NFC_B_PASSIVE_LISTEN_MODE 0x81
85 #define NCI_NFC_F_PASSIVE_LISTEN_MODE 0x82
86 #define NCI_NFC_A_ACTIVE_LISTEN_MODE 0x83
87 #define NCI_NFC_F_ACTIVE_LISTEN_MODE 0x85
89 #define NCI_RF_TECH_MODE_LISTEN_MASK 0x80
91 /* NCI RF Technologies */
92 #define NCI_NFC_RF_TECHNOLOGY_A 0x00
93 #define NCI_NFC_RF_TECHNOLOGY_B 0x01
94 #define NCI_NFC_RF_TECHNOLOGY_F 0x02
95 #define NCI_NFC_RF_TECHNOLOGY_V 0x03
98 #define NCI_NFC_BIT_RATE_106 0x00
99 #define NCI_NFC_BIT_RATE_212 0x01
100 #define NCI_NFC_BIT_RATE_424 0x02
101 #define NCI_NFC_BIT_RATE_848 0x03
102 #define NCI_NFC_BIT_RATE_1695 0x04
103 #define NCI_NFC_BIT_RATE_3390 0x05
104 #define NCI_NFC_BIT_RATE_6780 0x06
105 #define NCI_NFC_BIT_RATE_26 0x20
107 /* NCI RF Protocols */
108 #define NCI_RF_PROTOCOL_UNKNOWN 0x00
109 #define NCI_RF_PROTOCOL_T1T 0x01
110 #define NCI_RF_PROTOCOL_T2T 0x02
111 #define NCI_RF_PROTOCOL_T3T 0x03
112 #define NCI_RF_PROTOCOL_ISO_DEP 0x04
113 #define NCI_RF_PROTOCOL_NFC_DEP 0x05
114 #define NCI_RF_PROTOCOL_T5T 0x06
116 /* NCI RF Interfaces */
117 #define NCI_RF_INTERFACE_NFCEE_DIRECT 0x00
118 #define NCI_RF_INTERFACE_FRAME 0x01
119 #define NCI_RF_INTERFACE_ISO_DEP 0x02
120 #define NCI_RF_INTERFACE_NFC_DEP 0x03
122 /* NCI Configuration Parameter Tags */
123 #define NCI_PN_ATR_REQ_GEN_BYTES 0x29
124 #define NCI_LN_ATR_RES_GEN_BYTES 0x61
125 #define NCI_LA_SEL_INFO 0x32
126 #define NCI_LF_PROTOCOL_TYPE 0x50
127 #define NCI_LF_CON_BITR_F 0x54
129 /* NCI Configuration Parameters masks */
130 #define NCI_LA_SEL_INFO_ISO_DEP_MASK 0x20
131 #define NCI_LA_SEL_INFO_NFC_DEP_MASK 0x40
132 #define NCI_LF_PROTOCOL_TYPE_NFC_DEP_MASK 0x02
133 #define NCI_LF_CON_BITR_F_212 0x02
134 #define NCI_LF_CON_BITR_F_424 0x04
136 /* NCI 2.x Feature Enable Bit */
137 #define NCI_FEATURE_DISABLE 0x00
139 /* NCI Reset types */
140 #define NCI_RESET_TYPE_KEEP_CONFIG 0x00
141 #define NCI_RESET_TYPE_RESET_CONFIG 0x01
143 /* NCI Static RF connection ID */
144 #define NCI_STATIC_RF_CONN_ID 0x00
146 /* NCI Data Flow Control */
147 #define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff
149 /* NCI RF_DISCOVER_MAP_CMD modes */
150 #define NCI_DISC_MAP_MODE_POLL 0x01
151 #define NCI_DISC_MAP_MODE_LISTEN 0x02
153 /* NCI Discover Notification Type */
154 #define NCI_DISCOVER_NTF_TYPE_LAST 0x00
155 #define NCI_DISCOVER_NTF_TYPE_LAST_NFCC 0x01
156 #define NCI_DISCOVER_NTF_TYPE_MORE 0x02
158 /* NCI Deactivation Type */
159 #define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00
160 #define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01
161 #define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02
162 #define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03
164 /* Message Type (MT) */
165 #define NCI_MT_DATA_PKT 0x00
166 #define NCI_MT_CMD_PKT 0x01
167 #define NCI_MT_RSP_PKT 0x02
168 #define NCI_MT_NTF_PKT 0x03
170 #define nci_mt(hdr) (((hdr)[0]>>5)&0x07)
171 #define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5))
173 /* Packet Boundary Flag (PBF) */
174 #define NCI_PBF_LAST 0x00
175 #define NCI_PBF_CONT 0x01
177 #define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01)
178 #define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4))
180 /* Control Opcode manipulation */
181 #define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\
182 ((__u16)((oid)&0x3f)))
183 #define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1])
184 #define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8)
185 #define nci_opcode_oid(op) (__u8)((op)&0x003f)
188 #define nci_plen(hdr) (__u8)((hdr)[2])
191 #define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f)
194 #define NCI_GID_CORE 0x0
195 #define NCI_GID_RF_MGMT 0x1
196 #define NCI_GID_NFCEE_MGMT 0x2
197 #define NCI_GID_PROPRIETARY 0xf
199 /* ----- NCI over SPI head/crc(tail) room needed for outgoing frames ----- */
200 #define NCI_SPI_HDR_LEN 4
201 #define NCI_SPI_CRC_LEN 2
203 /* ---- NCI Packet structures ---- */
204 #define NCI_CTRL_HDR_SIZE 3
205 #define NCI_DATA_HDR_SIZE 3
207 struct nci_ctrl_hdr
{
208 __u8 gid
; /* MT & PBF & GID */
213 struct nci_data_hdr
{
214 __u8 conn_id
; /* MT & PBF & ConnID */
219 /* ------------------------ */
220 /* ----- NCI Commands ---- */
221 /* ------------------------ */
222 #define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00)
223 struct nci_core_reset_cmd
{
227 #define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01)
228 /* To support NCI 2.x */
229 struct nci_core_init_v2_cmd
{
234 #define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02)
235 struct set_config_param
{
238 __u8 val
[NCI_MAX_PARAM_LEN
];
241 struct nci_core_set_config_cmd
{
243 struct set_config_param param
; /* support 1 param per cmd is enough */
246 #define NCI_OP_CORE_CONN_CREATE_CMD nci_opcode_pack(NCI_GID_CORE, 0x04)
247 #define DEST_SPEC_PARAMS_ID_INDEX 0
248 #define DEST_SPEC_PARAMS_PROTOCOL_INDEX 1
249 struct dest_spec_params
{
254 struct core_conn_create_dest_spec_params
{
260 struct nci_core_conn_create_cmd
{
261 __u8 destination_type
;
262 __u8 number_destination_params
;
263 struct core_conn_create_dest_spec_params params
[];
266 #define NCI_OP_CORE_CONN_CLOSE_CMD nci_opcode_pack(NCI_GID_CORE, 0x05)
268 #define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
269 struct disc_map_config
{
275 struct nci_rf_disc_map_cmd
{
276 __u8 num_mapping_configs
;
277 struct disc_map_config mapping_configs
278 [NCI_MAX_NUM_MAPPING_CONFIGS
];
281 #define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
283 __u8 rf_tech_and_mode
;
287 struct nci_rf_disc_cmd
{
288 __u8 num_disc_configs
;
289 struct disc_config disc_configs
[NCI_MAX_NUM_RF_CONFIGS
];
292 #define NCI_OP_RF_DISCOVER_SELECT_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
293 struct nci_rf_discover_select_cmd
{
294 __u8 rf_discovery_id
;
299 #define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
300 struct nci_rf_deactivate_cmd
{
304 #define NCI_OP_NFCEE_DISCOVER_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
305 struct nci_nfcee_discover_cmd
{
306 __u8 discovery_action
;
309 #define NCI_OP_NFCEE_MODE_SET_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
310 #define NCI_NFCEE_DISABLE 0x00
311 #define NCI_NFCEE_ENABLE 0x01
312 struct nci_nfcee_mode_set_cmd
{
317 #define NCI_OP_CORE_GET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x03)
319 /* ----------------------- */
320 /* ---- NCI Responses ---- */
321 /* ----------------------- */
322 #define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00)
323 struct nci_core_reset_rsp
{
329 #define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01)
330 struct nci_core_init_rsp_1
{
332 __le32 nfcc_features
;
333 __u8 num_supported_rf_interfaces
;
334 __u8 supported_rf_interfaces
[]; /* variable size array */
335 /* continuted in nci_core_init_rsp_2 */
338 struct nci_core_init_rsp_2
{
339 __u8 max_logical_connections
;
340 __le16 max_routing_table_size
;
341 __u8 max_ctrl_pkt_payload_len
;
342 __le16 max_size_for_large_params
;
344 __le32 manufact_specific_info
;
347 /* To support NCI ver 2.x */
348 struct nci_core_init_rsp_nci_ver2
{
350 __le32 nfcc_features
;
351 u8 max_logical_connections
;
352 __le16 max_routing_table_size
;
353 u8 max_ctrl_pkt_payload_len
;
354 u8 max_data_pkt_hci_payload_len
;
355 u8 number_of_hci_credit
;
356 __le16 max_nfc_v_frame_size
;
357 u8 num_supported_rf_interfaces
;
358 u8 supported_rf_interfaces
[];
361 #define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02)
362 struct nci_core_set_config_rsp
{
365 __u8 params_id
[]; /* variable size array */
368 #define NCI_OP_CORE_CONN_CREATE_RSP nci_opcode_pack(NCI_GID_CORE, 0x04)
369 struct nci_core_conn_create_rsp
{
371 __u8 max_ctrl_pkt_payload_len
;
376 #define NCI_OP_CORE_CONN_CLOSE_RSP nci_opcode_pack(NCI_GID_CORE, 0x05)
378 #define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
380 #define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
382 #define NCI_OP_RF_DISCOVER_SELECT_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
384 #define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
386 #define NCI_OP_NFCEE_DISCOVER_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
387 struct nci_nfcee_discover_rsp
{
392 #define NCI_OP_NFCEE_MODE_SET_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
394 #define NCI_OP_CORE_GET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x03)
396 /* --------------------------- */
397 /* ---- NCI Notifications ---- */
398 /* --------------------------- */
399 #define NCI_OP_CORE_RESET_NTF nci_opcode_pack(NCI_GID_CORE, 0x00)
400 struct nci_core_reset_ntf
{
405 u8 manufacturer_specific_len
;
406 __le32 manufact_specific_info
;
409 #define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x06)
410 struct conn_credit_entry
{
415 struct nci_core_conn_credit_ntf
{
417 struct conn_credit_entry conn_entries
[NCI_MAX_NUM_CONN
];
420 #define NCI_OP_CORE_GENERIC_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x07)
422 #define NCI_OP_CORE_INTF_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x08)
423 struct nci_core_intf_error_ntf
{
428 #define NCI_OP_RF_DISCOVER_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
429 struct rf_tech_specific_params_nfca_poll
{
431 __u8 nfcid1_len
; /* 0, 4, 7, or 10 Bytes */
432 __u8 nfcid1
[NFC_NFCID1_MAXSIZE
];
433 __u8 sel_res_len
; /* 0 or 1 Bytes */
437 struct rf_tech_specific_params_nfcb_poll
{
439 __u8 sensb_res
[NFC_SENSB_RES_MAXSIZE
]; /* 11 or 12 Bytes */
442 struct rf_tech_specific_params_nfcf_poll
{
445 __u8 sensf_res
[NFC_SENSF_RES_MAXSIZE
]; /* 16 or 18 Bytes */
448 struct rf_tech_specific_params_nfcv_poll
{
451 __u8 uid
[NFC_ISO15693_UID_MAXSIZE
]; /* 8 Bytes */
454 struct rf_tech_specific_params_nfcf_listen
{
455 __u8 local_nfcid2_len
;
456 __u8 local_nfcid2
[NFC_NFCID2_MAXSIZE
]; /* 0 or 8 Bytes */
459 struct nci_rf_discover_ntf
{
460 __u8 rf_discovery_id
;
462 __u8 rf_tech_and_mode
;
463 __u8 rf_tech_specific_params_len
;
466 struct rf_tech_specific_params_nfca_poll nfca_poll
;
467 struct rf_tech_specific_params_nfcb_poll nfcb_poll
;
468 struct rf_tech_specific_params_nfcf_poll nfcf_poll
;
469 struct rf_tech_specific_params_nfcv_poll nfcv_poll
;
470 } rf_tech_specific_params
;
475 #define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
476 struct activation_params_nfca_poll_iso_dep
{
481 struct activation_params_nfcb_poll_iso_dep
{
486 struct activation_params_poll_nfc_dep
{
488 __u8 atr_res
[NFC_ATR_RES_MAXSIZE
- 2]; /* ATR_RES from byte 3 */
491 struct activation_params_listen_nfc_dep
{
493 __u8 atr_req
[NFC_ATR_REQ_MAXSIZE
- 2]; /* ATR_REQ from byte 3 */
496 struct nci_rf_intf_activated_ntf
{
497 __u8 rf_discovery_id
;
500 __u8 activation_rf_tech_and_mode
;
501 __u8 max_data_pkt_payload_size
;
502 __u8 initial_num_credits
;
503 __u8 rf_tech_specific_params_len
;
506 struct rf_tech_specific_params_nfca_poll nfca_poll
;
507 struct rf_tech_specific_params_nfcb_poll nfcb_poll
;
508 struct rf_tech_specific_params_nfcf_poll nfcf_poll
;
509 struct rf_tech_specific_params_nfcv_poll nfcv_poll
;
510 struct rf_tech_specific_params_nfcf_listen nfcf_listen
;
511 } rf_tech_specific_params
;
513 __u8 data_exch_rf_tech_and_mode
;
514 __u8 data_exch_tx_bit_rate
;
515 __u8 data_exch_rx_bit_rate
;
516 __u8 activation_params_len
;
519 struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep
;
520 struct activation_params_nfcb_poll_iso_dep nfcb_poll_iso_dep
;
521 struct activation_params_poll_nfc_dep poll_nfc_dep
;
522 struct activation_params_listen_nfc_dep listen_nfc_dep
;
527 #define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
528 struct nci_rf_deactivate_ntf
{
533 #define NCI_OP_RF_NFCEE_ACTION_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x09)
534 struct nci_rf_nfcee_action_ntf
{
537 __u8 supported_data_length
;
538 __u8 supported_data
[];
541 #define NCI_OP_NFCEE_DISCOVER_NTF nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
542 struct nci_nfcee_supported_protocol
{
544 __u8 supported_protocol
[];
547 struct nci_nfcee_information_tlv
{
549 __u8 information_tlv
[];
552 struct nci_nfcee_discover_ntf
{
555 struct nci_nfcee_supported_protocol supported_protocols
;
556 struct nci_nfcee_information_tlv information_tlv
;
559 #define NCI_OP_CORE_RESET_NTF nci_opcode_pack(NCI_GID_CORE, 0x00)