Linux 4.1.18
[linux/fpc-iii.git] / include / net / nfc / nci.h
bloba2f2f3d3196dfc8c3b10719d4833b2c084d2bf64
1 /*
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>
10 * Acknowledgements:
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/>.
28 #ifndef __NCI_H
29 #define __NCI_H
31 #include <net/nfc/nfc.h>
33 /* NCI constants */
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
39 /* NCI Status Codes */
40 #define NCI_STATUS_OK 0x00
41 #define NCI_STATUS_REJECTED 0x01
42 #define NCI_STATUS_RF_FRAME_CORRUPTED 0x02
43 #define NCI_STATUS_FAILED 0x03
44 #define NCI_STATUS_NOT_INITIALIZED 0x04
45 #define NCI_STATUS_SYNTAX_ERROR 0x05
46 #define NCI_STATUS_SEMANTIC_ERROR 0x06
47 #define NCI_STATUS_UNKNOWN_GID 0x07
48 #define NCI_STATUS_UNKNOWN_OID 0x08
49 #define NCI_STATUS_INVALID_PARAM 0x09
50 #define NCI_STATUS_MESSAGE_SIZE_EXCEEDED 0x0a
51 /* Discovery Specific Status Codes */
52 #define NCI_STATUS_DISCOVERY_ALREADY_STARTED 0xa0
53 #define NCI_STATUS_DISCOVERY_TARGET_ACTIVATION_FAILED 0xa1
54 #define NCI_STATUS_DISCOVERY_TEAR_DOWN 0xa2
55 /* RF Interface Specific Status Codes */
56 #define NCI_STATUS_RF_TRANSMISSION_ERROR 0xb0
57 #define NCI_STATUS_RF_PROTOCOL_ERROR 0xb1
58 #define NCI_STATUS_RF_TIMEOUT_ERROR 0xb2
59 /* NFCEE Interface Specific Status Codes */
60 #define NCI_STATUS_NFCEE_INTERFACE_ACTIVATION_FAILED 0xc0
61 #define NCI_STATUS_NFCEE_TRANSMISSION_ERROR 0xc1
62 #define NCI_STATUS_NFCEE_PROTOCOL_ERROR 0xc2
63 #define NCI_STATUS_NFCEE_TIMEOUT_ERROR 0xc3
65 /* NFCEE Interface/Protocols */
66 #define NCI_NFCEE_INTERFACE_APDU 0x00
67 #define NCI_NFCEE_INTERFACE_HCI_ACCESS 0x01
68 #define NCI_NFCEE_INTERFACE_TYPE3_CMD_SET 0x02
69 #define NCI_NFCEE_INTERFACE_TRANSPARENT 0x03
71 /* Destination type */
72 #define NCI_DESTINATION_NFCC_LOOPBACK 0x01
73 #define NCI_DESTINATION_REMOTE_NFC_ENDPOINT 0x02
74 #define NCI_DESTINATION_NFCEE 0x03
76 /* Destination-specific parameters type */
77 #define NCI_DESTINATION_SPECIFIC_PARAM_RF_TYPE 0x00
78 #define NCI_DESTINATION_SPECIFIC_PARAM_NFCEE_TYPE 0x01
80 /* NFCEE Discovery Action */
81 #define NCI_NFCEE_DISCOVERY_ACTION_DISABLE 0x00
82 #define NCI_NFCEE_DISCOVERY_ACTION_ENABLE 0x01
84 /* NCI RF Technology and Mode */
85 #define NCI_NFC_A_PASSIVE_POLL_MODE 0x00
86 #define NCI_NFC_B_PASSIVE_POLL_MODE 0x01
87 #define NCI_NFC_F_PASSIVE_POLL_MODE 0x02
88 #define NCI_NFC_A_ACTIVE_POLL_MODE 0x03
89 #define NCI_NFC_F_ACTIVE_POLL_MODE 0x05
90 #define NCI_NFC_V_PASSIVE_POLL_MODE 0x06
91 #define NCI_NFC_A_PASSIVE_LISTEN_MODE 0x80
92 #define NCI_NFC_B_PASSIVE_LISTEN_MODE 0x81
93 #define NCI_NFC_F_PASSIVE_LISTEN_MODE 0x82
94 #define NCI_NFC_A_ACTIVE_LISTEN_MODE 0x83
95 #define NCI_NFC_F_ACTIVE_LISTEN_MODE 0x85
97 #define NCI_RF_TECH_MODE_LISTEN_MASK 0x80
99 /* NCI RF Technologies */
100 #define NCI_NFC_RF_TECHNOLOGY_A 0x00
101 #define NCI_NFC_RF_TECHNOLOGY_B 0x01
102 #define NCI_NFC_RF_TECHNOLOGY_F 0x02
103 #define NCI_NFC_RF_TECHNOLOGY_V 0x03
105 /* NCI Bit Rates */
106 #define NCI_NFC_BIT_RATE_106 0x00
107 #define NCI_NFC_BIT_RATE_212 0x01
108 #define NCI_NFC_BIT_RATE_424 0x02
109 #define NCI_NFC_BIT_RATE_848 0x03
110 #define NCI_NFC_BIT_RATE_1695 0x04
111 #define NCI_NFC_BIT_RATE_3390 0x05
112 #define NCI_NFC_BIT_RATE_6780 0x06
113 #define NCI_NFC_BIT_RATE_26 0x20
115 /* NCI RF Protocols */
116 #define NCI_RF_PROTOCOL_UNKNOWN 0x00
117 #define NCI_RF_PROTOCOL_T1T 0x01
118 #define NCI_RF_PROTOCOL_T2T 0x02
119 #define NCI_RF_PROTOCOL_T3T 0x03
120 #define NCI_RF_PROTOCOL_ISO_DEP 0x04
121 #define NCI_RF_PROTOCOL_NFC_DEP 0x05
122 #define NCI_RF_PROTOCOL_T5T 0x06
124 /* NCI RF Interfaces */
125 #define NCI_RF_INTERFACE_NFCEE_DIRECT 0x00
126 #define NCI_RF_INTERFACE_FRAME 0x01
127 #define NCI_RF_INTERFACE_ISO_DEP 0x02
128 #define NCI_RF_INTERFACE_NFC_DEP 0x03
130 /* NCI Configuration Parameter Tags */
131 #define NCI_PN_ATR_REQ_GEN_BYTES 0x29
132 #define NCI_LN_ATR_RES_GEN_BYTES 0x61
133 #define NCI_LA_SEL_INFO 0x32
134 #define NCI_LF_PROTOCOL_TYPE 0x50
135 #define NCI_LF_CON_BITR_F 0x54
137 /* NCI Configuration Parameters masks */
138 #define NCI_LA_SEL_INFO_ISO_DEP_MASK 0x20
139 #define NCI_LA_SEL_INFO_NFC_DEP_MASK 0x40
140 #define NCI_LF_PROTOCOL_TYPE_NFC_DEP_MASK 0x02
141 #define NCI_LF_CON_BITR_F_212 0x02
142 #define NCI_LF_CON_BITR_F_424 0x04
144 /* NCI Reset types */
145 #define NCI_RESET_TYPE_KEEP_CONFIG 0x00
146 #define NCI_RESET_TYPE_RESET_CONFIG 0x01
148 /* NCI Static RF connection ID */
149 #define NCI_STATIC_RF_CONN_ID 0x00
151 /* NCI Data Flow Control */
152 #define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff
154 /* NCI RF_DISCOVER_MAP_CMD modes */
155 #define NCI_DISC_MAP_MODE_POLL 0x01
156 #define NCI_DISC_MAP_MODE_LISTEN 0x02
158 /* NCI Discover Notification Type */
159 #define NCI_DISCOVER_NTF_TYPE_LAST 0x00
160 #define NCI_DISCOVER_NTF_TYPE_LAST_NFCC 0x01
161 #define NCI_DISCOVER_NTF_TYPE_MORE 0x02
163 /* NCI Deactivation Type */
164 #define NCI_DEACTIVATE_TYPE_IDLE_MODE 0x00
165 #define NCI_DEACTIVATE_TYPE_SLEEP_MODE 0x01
166 #define NCI_DEACTIVATE_TYPE_SLEEP_AF_MODE 0x02
167 #define NCI_DEACTIVATE_TYPE_DISCOVERY 0x03
169 /* Message Type (MT) */
170 #define NCI_MT_DATA_PKT 0x00
171 #define NCI_MT_CMD_PKT 0x01
172 #define NCI_MT_RSP_PKT 0x02
173 #define NCI_MT_NTF_PKT 0x03
175 #define nci_mt(hdr) (((hdr)[0]>>5)&0x07)
176 #define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5))
178 /* Packet Boundary Flag (PBF) */
179 #define NCI_PBF_LAST 0x00
180 #define NCI_PBF_CONT 0x01
182 #define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01)
183 #define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4))
185 /* Control Opcode manipulation */
186 #define nci_opcode_pack(gid, oid) (__u16)((((__u16)((gid)&0x0f))<<8)|\
187 ((__u16)((oid)&0x3f)))
188 #define nci_opcode(hdr) nci_opcode_pack(hdr[0], hdr[1])
189 #define nci_opcode_gid(op) (__u8)(((op)&0x0f00)>>8)
190 #define nci_opcode_oid(op) (__u8)((op)&0x003f)
192 /* Payload Length */
193 #define nci_plen(hdr) (__u8)((hdr)[2])
195 /* Connection ID */
196 #define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f)
198 /* GID values */
199 #define NCI_GID_CORE 0x0
200 #define NCI_GID_RF_MGMT 0x1
201 #define NCI_GID_NFCEE_MGMT 0x2
202 #define NCI_GID_PROPRIETARY 0xf
204 /* ----- NCI over SPI head/crc(tail) room needed for outgoing frames ----- */
205 #define NCI_SPI_HDR_LEN 4
206 #define NCI_SPI_CRC_LEN 2
208 /* ---- NCI Packet structures ---- */
209 #define NCI_CTRL_HDR_SIZE 3
210 #define NCI_DATA_HDR_SIZE 3
212 struct nci_ctrl_hdr {
213 __u8 gid; /* MT & PBF & GID */
214 __u8 oid;
215 __u8 plen;
216 } __packed;
218 struct nci_data_hdr {
219 __u8 conn_id; /* MT & PBF & ConnID */
220 __u8 rfu;
221 __u8 plen;
222 } __packed;
224 /* ------------------------ */
225 /* ----- NCI Commands ---- */
226 /* ------------------------ */
227 #define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00)
228 struct nci_core_reset_cmd {
229 __u8 reset_type;
230 } __packed;
232 #define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01)
234 #define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02)
235 struct set_config_param {
236 __u8 id;
237 __u8 len;
238 __u8 val[NCI_MAX_PARAM_LEN];
239 } __packed;
241 struct nci_core_set_config_cmd {
242 __u8 num_params;
243 struct set_config_param param; /* support 1 param per cmd is enough */
244 } __packed;
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 {
250 __u8 id;
251 __u8 protocol;
252 } __packed;
254 struct core_conn_create_dest_spec_params {
255 __u8 type;
256 __u8 length;
257 __u8 value[0];
258 } __packed;
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[0];
264 } __packed;
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 {
270 __u8 rf_protocol;
271 __u8 mode;
272 __u8 rf_interface;
273 } __packed;
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];
279 } __packed;
281 #define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
282 struct disc_config {
283 __u8 rf_tech_and_mode;
284 __u8 frequency;
285 } __packed;
287 struct nci_rf_disc_cmd {
288 __u8 num_disc_configs;
289 struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS];
290 } __packed;
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;
295 __u8 rf_protocol;
296 __u8 rf_interface;
297 } __packed;
299 #define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
300 struct nci_rf_deactivate_cmd {
301 __u8 type;
302 } __packed;
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;
307 } __packed;
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 {
313 __u8 nfcee_id;
314 __u8 nfcee_mode;
315 } __packed;
317 /* ----------------------- */
318 /* ---- NCI Responses ---- */
319 /* ----------------------- */
320 #define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00)
321 struct nci_core_reset_rsp {
322 __u8 status;
323 __u8 nci_ver;
324 __u8 config_status;
325 } __packed;
327 #define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01)
328 struct nci_core_init_rsp_1 {
329 __u8 status;
330 __le32 nfcc_features;
331 __u8 num_supported_rf_interfaces;
332 __u8 supported_rf_interfaces[0]; /* variable size array */
333 /* continuted in nci_core_init_rsp_2 */
334 } __packed;
336 struct nci_core_init_rsp_2 {
337 __u8 max_logical_connections;
338 __le16 max_routing_table_size;
339 __u8 max_ctrl_pkt_payload_len;
340 __le16 max_size_for_large_params;
341 __u8 manufact_id;
342 __le32 manufact_specific_info;
343 } __packed;
345 #define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02)
346 struct nci_core_set_config_rsp {
347 __u8 status;
348 __u8 num_params;
349 __u8 params_id[0]; /* variable size array */
350 } __packed;
352 #define NCI_OP_CORE_CONN_CREATE_RSP nci_opcode_pack(NCI_GID_CORE, 0x04)
353 struct nci_core_conn_create_rsp {
354 __u8 status;
355 __u8 max_ctrl_pkt_payload_len;
356 __u8 credits_cnt;
357 __u8 conn_id;
358 } __packed;
360 #define NCI_OP_CORE_CONN_CLOSE_RSP nci_opcode_pack(NCI_GID_CORE, 0x05)
362 #define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
364 #define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
366 #define NCI_OP_RF_DISCOVER_SELECT_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
368 #define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
370 #define NCI_OP_NFCEE_DISCOVER_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
371 struct nci_nfcee_discover_rsp {
372 __u8 status;
373 __u8 num_nfcee;
374 } __packed;
376 #define NCI_OP_NFCEE_MODE_SET_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
377 /* --------------------------- */
378 /* ---- NCI Notifications ---- */
379 /* --------------------------- */
380 #define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x06)
381 struct conn_credit_entry {
382 __u8 conn_id;
383 __u8 credits;
384 } __packed;
386 struct nci_core_conn_credit_ntf {
387 __u8 num_entries;
388 struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN];
389 } __packed;
391 #define NCI_OP_CORE_GENERIC_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x07)
393 #define NCI_OP_CORE_INTF_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x08)
394 struct nci_core_intf_error_ntf {
395 __u8 status;
396 __u8 conn_id;
397 } __packed;
399 #define NCI_OP_RF_DISCOVER_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
400 struct rf_tech_specific_params_nfca_poll {
401 __u16 sens_res;
402 __u8 nfcid1_len; /* 0, 4, 7, or 10 Bytes */
403 __u8 nfcid1[NFC_NFCID1_MAXSIZE];
404 __u8 sel_res_len; /* 0 or 1 Bytes */
405 __u8 sel_res;
406 } __packed;
408 struct rf_tech_specific_params_nfcb_poll {
409 __u8 sensb_res_len;
410 __u8 sensb_res[NFC_SENSB_RES_MAXSIZE]; /* 11 or 12 Bytes */
411 } __packed;
413 struct rf_tech_specific_params_nfcf_poll {
414 __u8 bit_rate;
415 __u8 sensf_res_len;
416 __u8 sensf_res[NFC_SENSF_RES_MAXSIZE]; /* 16 or 18 Bytes */
417 } __packed;
419 struct rf_tech_specific_params_nfcv_poll {
420 __u8 res_flags;
421 __u8 dsfid;
422 __u8 uid[NFC_ISO15693_UID_MAXSIZE]; /* 8 Bytes */
423 } __packed;
425 struct rf_tech_specific_params_nfcf_listen {
426 __u8 local_nfcid2_len;
427 __u8 local_nfcid2[NFC_NFCID2_MAXSIZE]; /* 0 or 8 Bytes */
428 } __packed;
430 struct nci_rf_discover_ntf {
431 __u8 rf_discovery_id;
432 __u8 rf_protocol;
433 __u8 rf_tech_and_mode;
434 __u8 rf_tech_specific_params_len;
436 union {
437 struct rf_tech_specific_params_nfca_poll nfca_poll;
438 struct rf_tech_specific_params_nfcb_poll nfcb_poll;
439 struct rf_tech_specific_params_nfcf_poll nfcf_poll;
440 struct rf_tech_specific_params_nfcv_poll nfcv_poll;
441 } rf_tech_specific_params;
443 __u8 ntf_type;
444 } __packed;
446 #define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
447 struct activation_params_nfca_poll_iso_dep {
448 __u8 rats_res_len;
449 __u8 rats_res[20];
452 struct activation_params_nfcb_poll_iso_dep {
453 __u8 attrib_res_len;
454 __u8 attrib_res[50];
457 struct activation_params_poll_nfc_dep {
458 __u8 atr_res_len;
459 __u8 atr_res[NFC_ATR_RES_MAXSIZE - 2]; /* ATR_RES from byte 3 */
462 struct activation_params_listen_nfc_dep {
463 __u8 atr_req_len;
464 __u8 atr_req[NFC_ATR_REQ_MAXSIZE - 2]; /* ATR_REQ from byte 3 */
467 struct nci_rf_intf_activated_ntf {
468 __u8 rf_discovery_id;
469 __u8 rf_interface;
470 __u8 rf_protocol;
471 __u8 activation_rf_tech_and_mode;
472 __u8 max_data_pkt_payload_size;
473 __u8 initial_num_credits;
474 __u8 rf_tech_specific_params_len;
476 union {
477 struct rf_tech_specific_params_nfca_poll nfca_poll;
478 struct rf_tech_specific_params_nfcb_poll nfcb_poll;
479 struct rf_tech_specific_params_nfcf_poll nfcf_poll;
480 struct rf_tech_specific_params_nfcv_poll nfcv_poll;
481 struct rf_tech_specific_params_nfcf_listen nfcf_listen;
482 } rf_tech_specific_params;
484 __u8 data_exch_rf_tech_and_mode;
485 __u8 data_exch_tx_bit_rate;
486 __u8 data_exch_rx_bit_rate;
487 __u8 activation_params_len;
489 union {
490 struct activation_params_nfca_poll_iso_dep nfca_poll_iso_dep;
491 struct activation_params_nfcb_poll_iso_dep nfcb_poll_iso_dep;
492 struct activation_params_poll_nfc_dep poll_nfc_dep;
493 struct activation_params_listen_nfc_dep listen_nfc_dep;
494 } activation_params;
496 } __packed;
498 #define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
499 struct nci_rf_deactivate_ntf {
500 __u8 type;
501 __u8 reason;
502 } __packed;
504 #define NCI_OP_RF_NFCEE_ACTION_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x09)
505 struct nci_rf_nfcee_action_ntf {
506 __u8 nfcee_id;
507 __u8 trigger;
508 __u8 supported_data_length;
509 __u8 supported_data[0];
510 } __packed;
512 #define NCI_OP_NFCEE_DISCOVER_NTF nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
513 struct nci_nfcee_supported_protocol {
514 __u8 num_protocol;
515 __u8 supported_protocol[0];
516 } __packed;
518 struct nci_nfcee_information_tlv {
519 __u8 num_tlv;
520 __u8 information_tlv[0];
521 } __packed;
523 struct nci_nfcee_discover_ntf {
524 __u8 nfcee_id;
525 __u8 nfcee_status;
526 struct nci_nfcee_supported_protocol supported_protocols;
527 struct nci_nfcee_information_tlv information_tlv;
528 } __packed;
530 #endif /* __NCI_H */