1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28#ifndef __NCI_H
29#define __NCI_H
30
31#include <net/nfc/nfc.h>
32
33
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
40
41
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
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
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
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
66
67
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
72
73
74#define NCI_DESTINATION_NFCC_LOOPBACK 0x01
75#define NCI_DESTINATION_REMOTE_NFC_ENDPOINT 0x02
76#define NCI_DESTINATION_NFCEE 0x03
77
78
79#define NCI_DESTINATION_SPECIFIC_PARAM_RF_TYPE 0x00
80#define NCI_DESTINATION_SPECIFIC_PARAM_NFCEE_TYPE 0x01
81
82
83#define NCI_NFCEE_DISCOVERY_ACTION_DISABLE 0x00
84#define NCI_NFCEE_DISCOVERY_ACTION_ENABLE 0x01
85
86
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
98
99#define NCI_RF_TECH_MODE_LISTEN_MASK 0x80
100
101
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
106
107
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
116
117
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
125
126
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
131
132
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
138
139
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
145
146
147#define NCI_RESET_TYPE_KEEP_CONFIG 0x00
148#define NCI_RESET_TYPE_RESET_CONFIG 0x01
149
150
151#define NCI_STATIC_RF_CONN_ID 0x00
152
153
154#define NCI_DATA_FLOW_CONTROL_NOT_USED 0xff
155
156
157#define NCI_DISC_MAP_MODE_POLL 0x01
158#define NCI_DISC_MAP_MODE_LISTEN 0x02
159
160
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
164
165
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
170
171
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
176
177#define nci_mt(hdr) (((hdr)[0]>>5)&0x07)
178#define nci_mt_set(hdr, mt) ((hdr)[0] |= (__u8)(((mt)&0x07)<<5))
179
180
181#define NCI_PBF_LAST 0x00
182#define NCI_PBF_CONT 0x01
183
184#define nci_pbf(hdr) (__u8)(((hdr)[0]>>4)&0x01)
185#define nci_pbf_set(hdr, pbf) ((hdr)[0] |= (__u8)(((pbf)&0x01)<<4))
186
187
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)
193
194
195#define nci_plen(hdr) (__u8)((hdr)[2])
196
197
198#define nci_conn_id(hdr) (__u8)(((hdr)[0])&0x0f)
199
200
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
205
206
207#define NCI_SPI_HDR_LEN 4
208#define NCI_SPI_CRC_LEN 2
209
210
211#define NCI_CTRL_HDR_SIZE 3
212#define NCI_DATA_HDR_SIZE 3
213
214struct nci_ctrl_hdr {
215 __u8 gid;
216 __u8 oid;
217 __u8 plen;
218} __packed;
219
220struct nci_data_hdr {
221 __u8 conn_id;
222 __u8 rfu;
223 __u8 plen;
224} __packed;
225
226
227
228
229#define NCI_OP_CORE_RESET_CMD nci_opcode_pack(NCI_GID_CORE, 0x00)
230struct nci_core_reset_cmd {
231 __u8 reset_type;
232} __packed;
233
234#define NCI_OP_CORE_INIT_CMD nci_opcode_pack(NCI_GID_CORE, 0x01)
235
236#define NCI_OP_CORE_SET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x02)
237struct set_config_param {
238 __u8 id;
239 __u8 len;
240 __u8 val[NCI_MAX_PARAM_LEN];
241} __packed;
242
243struct nci_core_set_config_cmd {
244 __u8 num_params;
245 struct set_config_param param;
246} __packed;
247
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
251struct dest_spec_params {
252 __u8 id;
253 __u8 protocol;
254} __packed;
255
256struct core_conn_create_dest_spec_params {
257 __u8 type;
258 __u8 length;
259 __u8 value[0];
260} __packed;
261
262struct nci_core_conn_create_cmd {
263 __u8 destination_type;
264 __u8 number_destination_params;
265 struct core_conn_create_dest_spec_params params[0];
266} __packed;
267
268#define NCI_OP_CORE_CONN_CLOSE_CMD nci_opcode_pack(NCI_GID_CORE, 0x05)
269
270#define NCI_OP_RF_DISCOVER_MAP_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
271struct disc_map_config {
272 __u8 rf_protocol;
273 __u8 mode;
274 __u8 rf_interface;
275} __packed;
276
277struct nci_rf_disc_map_cmd {
278 __u8 num_mapping_configs;
279 struct disc_map_config mapping_configs
280 [NCI_MAX_NUM_MAPPING_CONFIGS];
281} __packed;
282
283#define NCI_OP_RF_DISCOVER_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
284struct disc_config {
285 __u8 rf_tech_and_mode;
286 __u8 frequency;
287} __packed;
288
289struct nci_rf_disc_cmd {
290 __u8 num_disc_configs;
291 struct disc_config disc_configs[NCI_MAX_NUM_RF_CONFIGS];
292} __packed;
293
294#define NCI_OP_RF_DISCOVER_SELECT_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
295struct nci_rf_discover_select_cmd {
296 __u8 rf_discovery_id;
297 __u8 rf_protocol;
298 __u8 rf_interface;
299} __packed;
300
301#define NCI_OP_RF_DEACTIVATE_CMD nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
302struct nci_rf_deactivate_cmd {
303 __u8 type;
304} __packed;
305
306#define NCI_OP_NFCEE_DISCOVER_CMD nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
307struct nci_nfcee_discover_cmd {
308 __u8 discovery_action;
309} __packed;
310
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
314struct nci_nfcee_mode_set_cmd {
315 __u8 nfcee_id;
316 __u8 nfcee_mode;
317} __packed;
318
319#define NCI_OP_CORE_GET_CONFIG_CMD nci_opcode_pack(NCI_GID_CORE, 0x03)
320
321
322
323
324#define NCI_OP_CORE_RESET_RSP nci_opcode_pack(NCI_GID_CORE, 0x00)
325struct nci_core_reset_rsp {
326 __u8 status;
327 __u8 nci_ver;
328 __u8 config_status;
329} __packed;
330
331#define NCI_OP_CORE_INIT_RSP nci_opcode_pack(NCI_GID_CORE, 0x01)
332struct nci_core_init_rsp_1 {
333 __u8 status;
334 __le32 nfcc_features;
335 __u8 num_supported_rf_interfaces;
336 __u8 supported_rf_interfaces[0];
337
338} __packed;
339
340struct 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;
345 __u8 manufact_id;
346 __le32 manufact_specific_info;
347} __packed;
348
349#define NCI_OP_CORE_SET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x02)
350struct nci_core_set_config_rsp {
351 __u8 status;
352 __u8 num_params;
353 __u8 params_id[0];
354} __packed;
355
356#define NCI_OP_CORE_CONN_CREATE_RSP nci_opcode_pack(NCI_GID_CORE, 0x04)
357struct nci_core_conn_create_rsp {
358 __u8 status;
359 __u8 max_ctrl_pkt_payload_len;
360 __u8 credits_cnt;
361 __u8 conn_id;
362} __packed;
363
364#define NCI_OP_CORE_CONN_CLOSE_RSP nci_opcode_pack(NCI_GID_CORE, 0x05)
365
366#define NCI_OP_RF_DISCOVER_MAP_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x00)
367
368#define NCI_OP_RF_DISCOVER_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
369
370#define NCI_OP_RF_DISCOVER_SELECT_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x04)
371
372#define NCI_OP_RF_DEACTIVATE_RSP nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
373
374#define NCI_OP_NFCEE_DISCOVER_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
375struct nci_nfcee_discover_rsp {
376 __u8 status;
377 __u8 num_nfcee;
378} __packed;
379
380#define NCI_OP_NFCEE_MODE_SET_RSP nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x01)
381
382#define NCI_OP_CORE_GET_CONFIG_RSP nci_opcode_pack(NCI_GID_CORE, 0x03)
383
384
385
386
387#define NCI_OP_CORE_CONN_CREDITS_NTF nci_opcode_pack(NCI_GID_CORE, 0x06)
388struct conn_credit_entry {
389 __u8 conn_id;
390 __u8 credits;
391} __packed;
392
393struct nci_core_conn_credit_ntf {
394 __u8 num_entries;
395 struct conn_credit_entry conn_entries[NCI_MAX_NUM_CONN];
396} __packed;
397
398#define NCI_OP_CORE_GENERIC_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x07)
399
400#define NCI_OP_CORE_INTF_ERROR_NTF nci_opcode_pack(NCI_GID_CORE, 0x08)
401struct nci_core_intf_error_ntf {
402 __u8 status;
403 __u8 conn_id;
404} __packed;
405
406#define NCI_OP_RF_DISCOVER_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x03)
407struct rf_tech_specific_params_nfca_poll {
408 __u16 sens_res;
409 __u8 nfcid1_len;
410 __u8 nfcid1[NFC_NFCID1_MAXSIZE];
411 __u8 sel_res_len;
412 __u8 sel_res;
413} __packed;
414
415struct rf_tech_specific_params_nfcb_poll {
416 __u8 sensb_res_len;
417 __u8 sensb_res[NFC_SENSB_RES_MAXSIZE];
418} __packed;
419
420struct rf_tech_specific_params_nfcf_poll {
421 __u8 bit_rate;
422 __u8 sensf_res_len;
423 __u8 sensf_res[NFC_SENSF_RES_MAXSIZE];
424} __packed;
425
426struct rf_tech_specific_params_nfcv_poll {
427 __u8 res_flags;
428 __u8 dsfid;
429 __u8 uid[NFC_ISO15693_UID_MAXSIZE];
430} __packed;
431
432struct rf_tech_specific_params_nfcf_listen {
433 __u8 local_nfcid2_len;
434 __u8 local_nfcid2[NFC_NFCID2_MAXSIZE];
435} __packed;
436
437struct nci_rf_discover_ntf {
438 __u8 rf_discovery_id;
439 __u8 rf_protocol;
440 __u8 rf_tech_and_mode;
441 __u8 rf_tech_specific_params_len;
442
443 union {
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;
449
450 __u8 ntf_type;
451} __packed;
452
453#define NCI_OP_RF_INTF_ACTIVATED_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x05)
454struct activation_params_nfca_poll_iso_dep {
455 __u8 rats_res_len;
456 __u8 rats_res[20];
457};
458
459struct activation_params_nfcb_poll_iso_dep {
460 __u8 attrib_res_len;
461 __u8 attrib_res[50];
462};
463
464struct activation_params_poll_nfc_dep {
465 __u8 atr_res_len;
466 __u8 atr_res[NFC_ATR_RES_MAXSIZE - 2];
467};
468
469struct activation_params_listen_nfc_dep {
470 __u8 atr_req_len;
471 __u8 atr_req[NFC_ATR_REQ_MAXSIZE - 2];
472};
473
474struct nci_rf_intf_activated_ntf {
475 __u8 rf_discovery_id;
476 __u8 rf_interface;
477 __u8 rf_protocol;
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;
482
483 union {
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;
490
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;
495
496 union {
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;
501 } activation_params;
502
503} __packed;
504
505#define NCI_OP_RF_DEACTIVATE_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x06)
506struct nci_rf_deactivate_ntf {
507 __u8 type;
508 __u8 reason;
509} __packed;
510
511#define NCI_OP_RF_NFCEE_ACTION_NTF nci_opcode_pack(NCI_GID_RF_MGMT, 0x09)
512struct nci_rf_nfcee_action_ntf {
513 __u8 nfcee_id;
514 __u8 trigger;
515 __u8 supported_data_length;
516 __u8 supported_data[0];
517} __packed;
518
519#define NCI_OP_NFCEE_DISCOVER_NTF nci_opcode_pack(NCI_GID_NFCEE_MGMT, 0x00)
520struct nci_nfcee_supported_protocol {
521 __u8 num_protocol;
522 __u8 supported_protocol[0];
523} __packed;
524
525struct nci_nfcee_information_tlv {
526 __u8 num_tlv;
527 __u8 information_tlv[0];
528} __packed;
529
530struct nci_nfcee_discover_ntf {
531 __u8 nfcee_id;
532 __u8 nfcee_status;
533 struct nci_nfcee_supported_protocol supported_protocols;
534 struct nci_nfcee_information_tlv information_tlv;
535} __packed;
536
537#define NCI_OP_CORE_RESET_NTF nci_opcode_pack(NCI_GID_CORE, 0x00)
538
539#endif
540
