2 * The NFC Controller Interface is the communication protocol between an
3 * NFC Controller (NFCC) and a Device Host (DH).
5 * Copyright (C) 2014 Marvell International Ltd.
6 * Copyright (C) 2011 Texas Instruments, Inc.
8 * Written by Ilan Elias <ilane@ti.com>
11 * This file is based on hci.h, which was written
12 * by Maxim Krasnyansky.
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2
16 * as published by the Free Software Foundation
18 * This program is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU General Public License for more details.
23 * You should have received a copy of the GNU General Public License
24 * along with this program; if not, see <http://www.gnu.org/licenses/>.
31 #include <net/nfc/nfc.h>
34 #define NCI_MAX_NUM_MAPPING_CONFIGS 10
35 #define NCI_MAX_NUM_RF_CONFIGS 10
36 #define NCI_MAX_NUM_CONN 10
37 #define NCI_MAX_PARAM_LEN 251
38 #define NCI_MAX_PAYLOAD_SIZE 255
39 #define NCI_MAX_PACKET_SIZE 258
41 /* NCI Status Codes */
42 #define NCI_STATUS_OK 0x00
43 #define NCI_STATUS_REJECTED 0x01
44 #define NCI_STATUS_RF_FRAME_CORRUPTED 0x02
45 #define NCI_STATUS_FAILED 0x03
46 #define NCI_STATUS_NOT_INITIALIZED 0x04
47 #define NCI_STATUS_SYNTAX_ERROR 0x05
48 #define NCI_STATUS_SEMANTIC_ERROR 0x06
49 #define NCI_STATUS_UNKNOWN_GID 0x07
50 #define NCI_STATUS_UNKNOWN_OID 0x08
51 #define NCI_STATUS_INVALID_PARAM 0x09
52 #define NCI_STATUS_MESSAGE_SIZE_EXCEEDED 0x0a
53 /* Discovery Specific Status Codes */
54 #define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0
55 #define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1
56 #define NCI_STATUS_DISCOVERY_TEAR_DOWN 0xa2
57 /* RF Interface Specific Status Codes */
58 #define NCI_STATUS_RF_TRANSMISSION_ERROR 0xb0
59 #define NCI_STATUS_RF_PROTOCOL_ERROR 0xb1
60 #define NCI_STATUS_RF_TIMEOUT_ERROR 0xb2
61 /* NFCEE Interface Specific Status Codes */
62 #define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED 0xc0
63 #define NCI_STATUS_NFCEE_TRANSMISSION_ERROR 0xc1
64 #define NCI_STATUS_NFCEE_PROTOCOL_ERROR 0xc2
65 #define NCI_STATUS_NFCEE_TIMEOUT_ERROR 0xc3
67 /* NFCEE Interface/Protocols */
68 #define NCI_NFCEE_INTERFACE_APDU 0x00
69 #define NCI_NFCEE_INTERFACE_HCI_ACCESS 0x01
70 #define NCI_NFCEE_INTERFACE_TYPE3_CMD_SET 0x02
71 #define NCI_NFCEE_INTERFACE_TRANSPARENT 0x03
73 /* Destination type */
74 #define NCI_DESTINATION_NFCC_LOOPBACK 0x01
75 #define NCI_DESTINATION_REMOTE_NFC_ENDPOINT 0x02
76 #define NCI_DESTINATION_NFCEE 0x03
78 /* Destination-specific parameters type */
79 #define NCI_DESTINATION_SPECIFIC_PARAM_RF_TYPE 0x00
80 #define NCI_DESTINATION_SPECIFIC_PARAM_NFCEE_TYPE 0x01
82 /* NFCEE Discovery Action */
83 #define NCI_NFCEE_DISCOVERY_ACTION_DISABLE 0x00
84 #define NCI_NFCEE_DISCOVERY_ACTION_ENABLE 0x01
86 /* NCI RF Technology and Mode */
87 #define NCI_NFC_A_PASSIVE_POLL_MODE 0x00
88 #define NCI_NFC_B_PASSIVE_POLL_MODE 0x01
89 #define NCI_NFC_F_PASSIVE_POLL_MODE 0x02
90 #define NCI_NFC_A_ACTIVE_POLL_MODE 0x03
91 #define NCI_NFC_F_ACTIVE_POLL_MODE 0x05
92 #define NCI_NFC_V_PASSIVE_POLL_MODE 0x06
93 #define NCI_NFC_A_PASSIVE_LISTEN_MODE 0x80
94 #define NCI_NFC_B_PASSIVE_LISTEN_MODE 0x81
95 #define NCI_NFC_F_PASSIVE_LISTEN_MODE 0x82
96 #define NCI_NFC_A_ACTIVE_LISTEN_MODE 0x83
97 #define NCI_NFC_F_ACTIVE_LISTEN_MODE 0x85
99 #define NCI_RF_TECH_MODE_LISTEN_MASK 0x80
101 /* NCI RF Technologies */
102 #define NCI_NFC_RF_TECHNOLOGY_A 0x00
103 #define NCI_NFC_RF_TECHNOLOGY_B 0x01
104 #define NCI_NFC_RF_TECHNOLOGY_F 0x02
105 #define NCI_NFC_RF_TECHNOLOGY_V 0x03
108 #define NCI_NFC_BIT_RATE_106 0x00
109 #define NCI_NFC_BIT_RATE_212 0x01
110 #define NCI_NFC_BIT_RATE_424 0x02
111 #define NCI_NFC_BIT_RATE_848 0x03
112 #define NCI_NFC_BIT_RATE_1695 0x04
113 #define NCI_NFC_BIT_RATE_3390 0x05
114 #define NCI_NFC_BIT_RATE_6780 0x06
115 #define NCI_NFC_BIT_RATE_26 0x20
117 /* NCI RF Protocols */
118 #define NCI_RF_PROTOCOL_UNKNOWN 0x00
119 #define NCI_RF_PROTOCOL_T1T 0x01
120 #define NCI_RF_PROTOCOL_T2T 0x02
121 #define NCI_RF_PROTOCOL_T3T 0x03
122 #define NCI_RF_PROTOCOL_ISO_DEP 0x04
123 #define NCI_RF_PROTOCOL_NFC_DEP 0x05
124 #define NCI_RF_PROTOCOL_T5T 0x06
126 /* NCI RF Interfaces */
127 #define NCI_RF_INTERFACE_NFCEE_DIRECT 0x00
128 #define NCI_RF_INTERFACE_FRAME 0x01
129 #define NCI_RF_INTERFACE_ISO_DEP 0x02
130 #define NCI_RF_INTERFACE_NFC_DEP 0x03
132 /* NCI Configuration Parameter Tags */
133 #define NCI_PN_ATR_REQ_GEN_BYTES 0x29
134 #define NCI_LN_ATR_RES_GEN_BYTES 0x61
135 #define NCI_LA_SEL_INFO 0x32
136 #define NCI_LF_PROTOCOL_TYPE 0x50
137 #define NCI_LF_CON_BITR_F 0x54
139 /* NCI Configuration Parameters masks */
140 #define NCI_LA_SEL_INFO_ISO_DEP_MASK 0x20
141 #define NCI_LA_SEL_INFO_NFC_DEP_MASK 0x40
142 #define NCI_LF_PROTOCOL_TYPE_NFC_DEP_MASK 0x02
143 #define NCI_LF_CON_BITR_F_212 0x02
144 #define NCI_LF_CON_BITR_F_424 0x04
146 /* NCI Reset types */
147 #define NCI_RESET_TYPE_KEEP_CONFIG 0x00
148 #define NCI_RESET_TYPE_RESET_CONFIG 0x01
150 /* NCI Static RF connection ID */
151 #define NCI_STATIC_RF_CONN_ID 0x00
153 /* NCI Data Flow Control */
154 #define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff
156 /* NCI RF_DISCOVER_MAP_CMD modes */
157 #define NCI_DISC_MAP_MODE_POLL 0x01
158 #define NCI_DISC_MAP_MODE_LISTEN 0x02
160 /* NCI Discover Notification Type */
161 #define NCI_DISCOVER_NTF_TYPE_LAST 0x00
162 #define NCI_DISCOVER_NTF_TYPE_LAST_NFCC 0x01
163 #define NCI_DISCOVER_NTF_TYPE_MORE 0x02
165 /* NCI Deactivation Type */
166 #define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00
167 #define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01
168 #define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02
169 #define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03
171 /* Message Type (MT) */
172 #define NCI_MT_DATA_PKT 0x00
173 #define NCI_MT_CMD_PKT 0x01
174 #define NCI_MT_RSP_PKT 0x02
175 #define NCI_MT_NTF_PKT 0x03
177 #define nci_mt(hdr) (((hdr)[0]>>5)&0x07)
178 #define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5))
180 /* Packet Boundary Flag (PBF) */
181 #define NCI_PBF_LAST 0x00
182 #define NCI_PBF_CONT 0x01
184 #define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01)
185 #define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4))
187 /* Control Opcode manipulation */
188 #define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\
189 ((__u16)((oid)&0x3f)))
190 #define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1])
191 #define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8)
192 #define nci_opcode_oid(op) (__u8)((op)&0x003f)
195 #define nci_plen(hdr) (__u8)((hdr)[2])
198 #define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f)
201 #define NCI_GID_CORE 0x0
202 #define NCI_GID_RF_MGMT 0x1
203 #define NCI_GID_NFCEE_MGMT 0x2
204 #define NCI_GID_PROPRIETARY 0xf
206 /* ----- NCI over SPI head/crc(tail) room needed for outgoing frames ----- */
207 #define NCI_SPI_HDR_LEN 4
208 #define NCI_SPI_CRC_LEN 2
210 /* ---- NCI Packet structures ---- */
211 #define NCI_CTRL_HDR_SIZE 3
212 #define NCI_DATA_HDR_SIZE 3
214 struct nci_ctrl_hdr
{
215 __u8 gid
; /* MT & PBF & GID */
220 struct nci_data_hdr
{
221 __u8 conn_id
; /* MT & PBF & ConnID */
226 /* ------------------------ */
227 /* ----- NCI Commands ---- */
228 /* ------------------------ */
229 #define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00)
230 struct nci_core_reset_cmd
{
234 #define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01)
236 #define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02)
237 struct set_config_param
{
240 __u8 val
[NCI_MAX_PARAM_LEN
];
243 struct nci_core_set_config_cmd
{
245 struct set_config_param param
; /* support 1 param per cmd is enough */
248 #define NCI_OP_CORE_CONN_CREATE_CMD nci_opcode_pack(NCI_GID_CORE, 0x04)
249 #define DEST_SPEC_PARAMS_ID_INDEX 0
250 #define DEST_SPEC_PARAMS_PROTOCOL_INDEX 1
251 struct dest_spec_params
{
256 struct core_conn_create_dest_spec_params
{
262 struct nci_core_conn_create_cmd
{
263 __u8 destination_type
;
264 __u8 number_destination_params
;
265 struct core_conn_create_dest_spec_params params
[0];
268 #define NCI_OP_CORE_CONN_CLOSE_CMD nci_opcode_pack(NCI_GID_CORE, 0x05)
270 #define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
271 struct disc_map_config
{
277 struct nci_rf_disc_map_cmd
{
278 __u8 num_mapping_configs
;
279 struct disc_map_config mapping_configs
280 [NCI_MAX_NUM_MAPPING_CONFIGS
];
283 #define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
285 __u8 rf_tech_and_mode
;
289 struct nci_rf_disc_cmd
{
290 __u8 num_disc_configs
;
291 struct disc_config disc_configs
[NCI_MAX_NUM_RF_CONFIGS
];
294 #define NCI_OP_RF_DISCOVER_SELECT_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
295 struct nci_rf_discover_select_cmd
{
296 __u8 rf_discovery_id
;
301 #define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
302 struct nci_rf_deactivate_cmd
{
306 #define NCI_OP_NFCEE_DISCOVER_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
307 struct nci_nfcee_discover_cmd
{
308 __u8 discovery_action
;
311 #define NCI_OP_NFCEE_MODE_SET_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
312 #define NCI_NFCEE_DISABLE 0x00
313 #define NCI_NFCEE_ENABLE 0x01
314 struct nci_nfcee_mode_set_cmd
{
319 #define NCI_OP_CORE_GET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x03)
321 /* ----------------------- */
322 /* ---- NCI Responses ---- */
323 /* ----------------------- */
324 #define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00)
325 struct nci_core_reset_rsp
{
331 #define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01)
332 struct nci_core_init_rsp_1
{
334 __le32 nfcc_features
;
335 __u8 num_supported_rf_interfaces
;
336 __u8 supported_rf_interfaces
[0]; /* variable size array */
337 /* continuted in nci_core_init_rsp_2 */
340 struct nci_core_init_rsp_2
{
341 __u8 max_logical_connections
;
342 __le16 max_routing_table_size
;
343 __u8 max_ctrl_pkt_payload_len
;
344 __le16 max_size_for_large_params
;
346 __le32 manufact_specific_info
;
349 #define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02)
350 struct nci_core_set_config_rsp
{
353 __u8 params_id
[0]; /* variable size array */
356 #define NCI_OP_CORE_CONN_CREATE_RSP nci_opcode_pack(NCI_GID_CORE, 0x04)
357 struct nci_core_conn_create_rsp
{
359 __u8 max_ctrl_pkt_payload_len
;
364 #define NCI_OP_CORE_CONN_CLOSE_RSP nci_opcode_pack(NCI_GID_CORE, 0x05)
366 #define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
368 #define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
370 #define NCI_OP_RF_DISCOVER_SELECT_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
372 #define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
374 #define NCI_OP_NFCEE_DISCOVER_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
375 struct nci_nfcee_discover_rsp
{
380 #define NCI_OP_NFCEE_MODE_SET_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
382 #define NCI_OP_CORE_GET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x03)
384 /* --------------------------- */
385 /* ---- NCI Notifications ---- */
386 /* --------------------------- */
387 #define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x06)
388 struct conn_credit_entry
{
393 struct nci_core_conn_credit_ntf
{
395 struct conn_credit_entry conn_entries
[NCI_MAX_NUM_CONN
];
398 #define NCI_OP_CORE_GENERIC_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x07)
400 #define NCI_OP_CORE_INTF_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x08)
401 struct nci_core_intf_error_ntf
{
406 #define NCI_OP_RF_DISCOVER_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
407 struct rf_tech_specific_params_nfca_poll
{
409 __u8 nfcid1_len
; /* 0, 4, 7, or 10 Bytes */
410 __u8 nfcid1
[NFC_NFCID1_MAXSIZE
];
411 __u8 sel_res_len
; /* 0 or 1 Bytes */
415 struct rf_tech_specific_params_nfcb_poll
{
417 __u8 sensb_res
[NFC_SENSB_RES_MAXSIZE
]; /* 11 or 12 Bytes */
420 struct rf_tech_specific_params_nfcf_poll
{
423 __u8 sensf_res
[NFC_SENSF_RES_MAXSIZE
]; /* 16 or 18 Bytes */
426 struct rf_tech_specific_params_nfcv_poll
{
429 __u8 uid
[NFC_ISO15693_UID_MAXSIZE
]; /* 8 Bytes */
432 struct rf_tech_specific_params_nfcf_listen
{
433 __u8 local_nfcid2_len
;
434 __u8 local_nfcid2
[NFC_NFCID2_MAXSIZE
]; /* 0 or 8 Bytes */
437 struct nci_rf_discover_ntf
{
438 __u8 rf_discovery_id
;
440 __u8 rf_tech_and_mode
;
441 __u8 rf_tech_specific_params_len
;
444 struct rf_tech_specific_params_nfca_poll nfca_poll
;
445 struct rf_tech_specific_params_nfcb_poll nfcb_poll
;
446 struct rf_tech_specific_params_nfcf_poll nfcf_poll
;
447 struct rf_tech_specific_params_nfcv_poll nfcv_poll
;
448 } rf_tech_specific_params
;
453 #define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
454 struct activation_params_nfca_poll_iso_dep
{
459 struct activation_params_nfcb_poll_iso_dep
{
464 struct activation_params_poll_nfc_dep
{
466 __u8 atr_res
[NFC_ATR_RES_MAXSIZE
- 2]; /* ATR_RES from byte 3 */
469 struct activation_params_listen_nfc_dep
{
471 __u8 atr_req
[NFC_ATR_REQ_MAXSIZE
- 2]; /* ATR_REQ from byte 3 */
474 struct nci_rf_intf_activated_ntf
{
475 __u8 rf_discovery_id
;
478 __u8 activation_rf_tech_and_mode
;
479 __u8 max_data_pkt_payload_size
;
480 __u8 initial_num_credits
;
481 __u8 rf_tech_specific_params_len
;
484 struct rf_tech_specific_params_nfca_poll nfca_poll
;
485 struct rf_tech_specific_params_nfcb_poll nfcb_poll
;
486 struct rf_tech_specific_params_nfcf_poll nfcf_poll
;
487 struct rf_tech_specific_params_nfcv_poll nfcv_poll
;
488 struct rf_tech_specific_params_nfcf_listen nfcf_listen
;
489 } rf_tech_specific_params
;
491 __u8 data_exch_rf_tech_and_mode
;
492 __u8 data_exch_tx_bit_rate
;
493 __u8 data_exch_rx_bit_rate
;
494 __u8 activation_params_len
;
497 struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep
;
498 struct activation_params_nfcb_poll_iso_dep nfcb_poll_iso_dep
;
499 struct activation_params_poll_nfc_dep poll_nfc_dep
;
500 struct activation_params_listen_nfc_dep listen_nfc_dep
;
505 #define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
506 struct nci_rf_deactivate_ntf
{
511 #define NCI_OP_RF_NFCEE_ACTION_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x09)
512 struct nci_rf_nfcee_action_ntf
{
515 __u8 supported_data_length
;
516 __u8 supported_data
[0];
519 #define NCI_OP_NFCEE_DISCOVER_NTF nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
520 struct nci_nfcee_supported_protocol
{
522 __u8 supported_protocol
[0];
525 struct nci_nfcee_information_tlv
{
527 __u8 information_tlv
[0];
530 struct nci_nfcee_discover_ntf
{
533 struct nci_nfcee_supported_protocol supported_protocols
;
534 struct nci_nfcee_information_tlv information_tlv
;
537 #define NCI_OP_CORE_RESET_NTF nci_opcode_pack(NCI_GID_CORE, 0x00)