Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / system / nfc / e9df6ba5a8fcccf306a80b1670b423be8fe7746a / . / src / hal / include / nci_defs.h
blob: befffd9c99c323fc11dc6872ca43bbfb3e171979 [file] [log] [blame]
The Android Open Source Projecte9df6ba2012-12-13 14:55:37 -0800[diff] [blame^]1/******************************************************************************
2 *
3 * Copyright (C) 1999-2012 Broadcom Corporation
4 *
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 *
17 ******************************************************************************/
18
19/******************************************************************************
20 *
21 * This file contains the definition from NCI specification
22 *
23 ******************************************************************************/
24
25#ifndef NFC_NCI_DEFS_H
26#define NFC_NCI_DEFS_H
27
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32#define NCI_BRCM_CO_ID 0x2E
33
34/* Define the message header size for all NCI Commands and Notifications.
35*/
36#define NCI_MSG_HDR_SIZE 3 /* per NCI spec */
37#define NCI_DATA_HDR_SIZE 3 /* per NCI spec */
38#define NCI_MAX_PAYLOAD_SIZE 0xFE
39#define NCI_MAX_CTRL_SIZE 0xFF/* max control message size */
40#define NCI_CTRL_INIT_SIZE 32 /* initial NFCC control payload size */
41#define NCI_MAX_VSC_SIZE 0xFF
42#define NCI_VSC_MSG_HDR_SIZE 12 /* NCI header (3) + callback function pointer(8; use 8 to be safe) + HCIT (1 byte) */
43#define NCI_TL_SIZE 2
44
45#define NCI_ISO_DEP_MAX_INFO 253 /* Max frame size (256) - Prologue (1) - Epilogue (2) in ISO-DEP, CID and NAD are not used*/
46#define NCI_NFC_DEP_MAX_DATA 251 /* Max payload (254) - Protocol Header (3) in NFC-DEP, DID and NAD are not used */
47
48/* NCI Command and Notification Format:
49 * 3 byte message header:
50 * byte 0: MT PBF GID
51 * byte 1: OID
52 * byte 2: Message Length */
53/* MT: Message Type (byte 0) */
54#define NCI_MT_MASK 0xE0
55#define NCI_MT_SHIFT 5
56#define NCI_MT_DATA 0x00
57#define NCI_MT_CMD 1 /* (NCI_MT_CMD << NCI_MT_SHIFT) = 0x20 */
58#define NCI_MT_RSP 2 /* (NCI_MT_RSP << NCI_MT_SHIFT) = 0x40 */
59#define NCI_MT_NTF 3 /* (NCI_MT_NTF << NCI_MT_SHIFT) = 0x60 */
60#define NCI_MT_CFG 4 /* (NCI_MT_CFG << NCI_MT_SHIFT) = 0x80 */
61
62#define NCI_MTS_CMD 0x20
63#define NCI_MTS_RSP 0x40
64#define NCI_MTS_NTF 0x60
65#define NCI_MTS_CFG 0x80
66
67#define NCI_NTF_BIT 0x80 /* the tNFC_VS_EVT is a notification */
68#define NCI_RSP_BIT 0x40 /* the tNFC_VS_EVT is a response */
69
70/* for internal use only; not from specification */
71/* the following 2 flags are used in layer_specific for fragmentation/reassembly of data packets */
72#define NCI_LS_DATA 0x00
73#define NCI_LS_DATA_PBF 0x01
74
75/* PBF: Packet Boundary Flag (byte 0) */
76#define NCI_PBF_MASK 0x10
77#define NCI_PBF_SHIFT 4
78#define NCI_PBF_NO_OR_LAST 0x00 /* not fragmented or last fragment */
79#define NCI_PBF_ST_CONT 0x10 /* start or continuing fragment */
80
81/* GID: Group Identifier (byte 0) */
82#define NCI_GID_MASK 0x0F
83#define NCI_GID_SHIFT 0
84#define NCI_GID_CORE 0x00 /* 0000b NCI Core group */
85#define NCI_GID_RF_MANAGE 0x01 /* 0001b RF Management group */
86#define NCI_GID_EE_MANAGE 0x02 /* 0010b NFCEE Management group */
87#define NCI_GID_PROP 0x0F /* 1111b Proprietary */
88/* 0111b - 1110b RFU */
89
90/* OID: Opcode Identifier (byte 1) */
91#define NCI_OID_MASK 0x3F
92#define NCI_OID_SHIFT 0
93
94/* For routing */
95#define NCI_DH_ID 0 /* for DH */
96/* To identify the loopback test */
97#define NCI_TEST_ID 0xFE/* for loopback test */
98
99/* Destination Type */
100#define NCI_DEST_TYPE_NFCC 1 /* NFCC - loopback */
101#define NCI_DEST_TYPE_REMOTE 2 /* Remote NFC Endpoint */
102#define NCI_DEST_TYPE_NFCEE 3 /* NFCEE */
103
104/* builds byte0 of NCI Command and Notification packet */
105#define NCI_MSG_BLD_HDR0(p, mt, gid) \
106 *(p)++ = (UINT8) (((mt) << NCI_MT_SHIFT) | (gid));
107
108#define NCI_MSG_PBLD_HDR0(p, mt, pbf, gid) \
109 *(p)++ = (UINT8) (((mt) << NCI_MT_SHIFT) | ((pbf) << NCI_PBF_SHIFT) | (gid));
110
111/* builds byte1 of NCI Command and Notification packet */
112#define NCI_MSG_BLD_HDR1(p, oid) \
113 *(p)++ = (UINT8) (((oid) << NCI_OID_SHIFT));
114
115/* parse byte0 of NCI packet */
116#define NCI_MSG_PRS_HDR0(p, mt, pbf, gid) \
117 mt = (*(p) & NCI_MT_MASK) >> NCI_MT_SHIFT; \
118 pbf = (*(p) & NCI_PBF_MASK) >> NCI_PBF_SHIFT; \
119 gid = *(p)++ & NCI_GID_MASK;
120
121/* parse MT and PBF bits of NCI packet */
122#define NCI_MSG_PRS_MT_PBF(p, mt, pbf) \
123 mt = (*(p) & NCI_MT_MASK) >> NCI_MT_SHIFT; \
124 pbf = (*(p) & NCI_PBF_MASK) >> NCI_PBF_SHIFT;
125
126/* parse byte1 of NCI Cmd/Ntf */
127#define NCI_MSG_PRS_HDR1(p, oid) \
128 oid = (*(p) & NCI_OID_MASK); (p)++;
129
130/* NCI Data Format:
131 * byte 0: MT(0) PBF CID
132 * byte 1: RFU
133 * byte 2: Data Length */
134/* CID: Connection Identifier (byte 0) 1-0xF Dynamically assigned (by NFCC), 0 is predefined */
135#define NCI_CID_MASK 0x0F
136
137/* builds 3-byte message header of NCI Data packet */
138#define NCI_DATA_BLD_HDR(p, cid, len) \
139 *(p)++ = (UINT8) (cid); *(p)++ = 0; *(p)++ = (UINT8) (len);
140
141#define NCI_DATA_PBLD_HDR(p, pbf, cid, len) \
142 *(p)++ = (UINT8) (((pbf) << NCI_PBF_SHIFT) | (cid)); *(p)++=0; *(p)++ = (len);
143
144#define NCI_DATA_PRS_HDR(p, pbf, cid, len) \
145 (pbf) = (*(p) & NCI_PBF_MASK) >> NCI_PBF_SHIFT; (cid) = (*(p) & NCI_CID_MASK); p++; p++; (len) = *(p)++;
146
147
148/* Logical target ID 0x01-0xFE */
149
150
151
152/* Status Codes */
153#define NCI_STATUS_OK 0x00
154#define NCI_STATUS_REJECTED 0x01
155#define NCI_STATUS_MESSAGE_CORRUPTED 0x02
156#define NCI_STATUS_BUFFER_FULL 0xE0
157#define NCI_STATUS_FAILED 0x03
158#define NCI_STATUS_NOT_INITIALIZED 0x04
159#define NCI_STATUS_SYNTAX_ERROR 0x05
160#define NCI_STATUS_SEMANTIC_ERROR 0x06
161#define NCI_STATUS_UNKNOWN_GID 0x07
162#define NCI_STATUS_UNKNOWN_OID 0x08
163#define NCI_STATUS_INVALID_PARAM 0x09
164#define NCI_STATUS_MSG_SIZE_TOO_BIG 0x0A
165/* discovery */
166#define NCI_STATUS_ALREADY_STARTED 0xA0
167#define NCI_STATUS_ACTIVATION_FAILED 0xA1
168#define NCI_STATUS_TEAR_DOWN 0xA2
169/* RF Interface */
170#define NCI_STATUS_RF_TRANSMISSION_ERR 0xB0
171#define NCI_STATUS_RF_PROTOCOL_ERR 0xB1
172#define NCI_STATUS_TIMEOUT 0xB2
173/* NFCEE Interface */
174#define NCI_STATUS_EE_INTF_ACTIVE_FAIL 0xC0
175#define NCI_STATUS_EE_TRANSMISSION_ERR 0xC1
176#define NCI_STATUS_EE_PROTOCOL_ERR 0xC2
177#define NCI_STATUS_EE_TIMEOUT 0xC3
178
179
180typedef UINT8 tNCI_STATUS;
181
182/* RF Technologies */
183#define NCI_RF_TECHNOLOGY_A 0x00
184#define NCI_RF_TECHNOLOGY_B 0x01
185#define NCI_RF_TECHNOLOGY_F 0x02
186#define NCI_RF_TECHNOLOGY_15693 0x03
187
188/* Bit Rates */
189#define NCI_BIT_RATE_106 0x00/* 106 kbit/s */
190#define NCI_BIT_RATE_212 0x01/* 212 kbit/s */
191#define NCI_BIT_RATE_424 0x02/* 424 kbit/s */
192#define NCI_BIT_RATE_848 0x03/* 848 Kbit/s */
193#define NCI_BIT_RATE_1696 0x04/* 1696 Kbit/s*/
194#define NCI_BIT_RATE_3392 0x05/* 3392 Kbit/s*/
195#define NCI_BIT_RATE_6784 0x06/* 6784 Kbit/s*/
196
197/**********************************************
198 * NCI Core Group Opcode - 0
199 **********************************************/
200#define NCI_MSG_CORE_RESET 0
201#define NCI_MSG_CORE_INIT 1
202#define NCI_MSG_CORE_SET_CONFIG 2
203#define NCI_MSG_CORE_GET_CONFIG 3
204#define NCI_MSG_CORE_CONN_CREATE 4
205#define NCI_MSG_CORE_CONN_CLOSE 5
206#define NCI_MSG_CORE_CONN_CREDITS 6
207#define NCI_MSG_CORE_GEN_ERR_STATUS 7
208#define NCI_MSG_CORE_INTF_ERR_STATUS 8
209
210/**********************************************
211 * RF MANAGEMENT Group Opcode - 1
212 **********************************************/
213#define NCI_MSG_RF_DISCOVER_MAP 0
214#define NCI_MSG_RF_SET_ROUTING 1
215#define NCI_MSG_RF_GET_ROUTING 2
216#define NCI_MSG_RF_DISCOVER 3
217#define NCI_MSG_RF_DISCOVER_SELECT 4
218#define NCI_MSG_RF_INTF_ACTIVATED 5
219#define NCI_MSG_RF_DEACTIVATE 6
220#define NCI_MSG_RF_FIELD 7
221#define NCI_MSG_RF_T3T_POLLING 8
222#define NCI_MSG_RF_EE_ACTION 9
223#define NCI_MSG_RF_EE_DISCOVERY_REQ 10
224#define NCI_MSG_RF_PARAMETER_UPDATE 11
225
226/**********************************************
227 * NFCEE MANAGEMENT Group Opcode - 2
228 **********************************************/
229#define NCI_MSG_NFCEE_DISCOVER 0
230#define NCI_MSG_NFCEE_MODE_SET 1
231
232/**********************************************
233 * NCI Proprietary Group - F
234 **********************************************/
235
236/**********************************************
237 * NCI Core Group Params
238 **********************************************/
239#define NCI_CORE_PARAM_SIZE_RESET 0x01
240#define NCI_CORE_PARAM_SIZE_RESET_RSP 0x03
241#define NCI_CORE_PARAM_SIZE_RESET_NTF 0x02
242
243#define NCI_CORE_PARAM_SIZE_INIT 0x00 /* no payload */
244#define NCI_CORE_PARAM_SIZE_INIT_RSP 0x11
245#define NCI_CORE_INIT_RSP_OFFSET_NUM_INTF 0x05
246
247#define NCI_CORE_PARAM_SIZE_SET_CONFIG_RSP 0x02 /* Status (1 octet) and number of params */
248
249
250/* octet 0 */
251#define NCI_FEAT_DISCOVERY_FREG 0x00000001
252#define NCI_FEAT_DISCOVERY_CFGM 0x00000006
253/* octet 1 */
254#define NCI_FEAT_TECHNOLOGY_ROUTING 0x00000200
255#define NCI_FEAT_PROTOCOL_ROUTING 0x00000400
256#define NCI_FEAT_AID_ROUTING 0x00000800
257/* octet 2 */
258#define NCI_FEAT_BATTERY_OFF_MD 0x00010000
259#define NCI_FEAT_SWITCH_OFF_MD 0x00020000
260
261
262/* supported Interfaces */
263#define NCI_SUP_INTF_FRAME 0x0001
264#define NCI_SUP_INTF_ISO_DEP 0x0002
265#define NCI_SUP_INTF_NFC_DEP 0x0004
266
267
268
269#define NCI_CORE_PARAM_SIZE_CON_CREATE 0x02 /* handle, num_tlv, (tlv) */
270#define NCI_CORE_PARAM_SIZE_CON_CREATE_RSP 0x04 /* status, size, credits, conn_id */
271#define NCI_CON_CREATE_TAG_EE_INTF 0x00 /* old */
272#define NCI_CON_CREATE_TAG_RF_DISC_ID 0x00
273#define NCI_CON_CREATE_TAG_NFCEE_VAL 0x01
274
275#define NCI_CORE_PARAM_SIZE_CON_CLOSE 0x01 /* Conn ID (1 octet) */
276#define NCI_CORE_PARAM_SIZE_CON_CLOSE_RSP 0x01 /* Status (1 octet) */
277
278#define NCI_CORE_PARAM_SIZE_RF_FIELD_NTF 0x01 /* RF Field Status (1 octet) */
279
280#define NCI_RESET_TYPE_KEEP_CFG 0x00 /* Keep the NCI configuration (if possible) and perform NCI initialization. */
281#define NCI_RESET_TYPE_RESET_CFG 0x01 /* Reset the NCI configuration, and perform NCI initialization. */
282
283#define NCI_RESET_STATUS_KEPT_CFG 0x00 /* NCI Configuration has been kept */
284#define NCI_RESET_STATUS_RESET_CFG 0x01 /* NCI Configuration has been reset */
285
286#define NCI_RF_STS_NO_REMOTE 0x00 /* No operating field generated by remote device */
287#define NCI_RF_STS_REMOTE 0x01 /* Operating field generated by remote device */
288
289
290#define NCI_PARAM_SIZE_DISCOVER_NFCEE 0x01 /* Discovery Action (1 octet) */
291#define NCI_PARAM_SIZE_DISCOVER_NFCEE_RSP 0x02 /* Status (1 octet)Number of NFCEEs (1 octet) */
292
293#define NCI_DISCOVER_ACTION_DISABLE 0
294#define NCI_DISCOVER_ACTION_ENABLE 1
295
296#define NCI_EE_DISCOVER_REQ_TYPE_LISTEN 0x01
297#define NCI_EE_DISCOVER_REQ_TYPE_POLL 0x02
298
299#define NCI_RF_PARAM_ID_TECH_N_MODE 0x00 /* RF Technology and Mode */
300#define NCI_RF_PARAM_ID_TX_BIT_RATE 0x01 /* Transmit Bit Rate */
301#define NCI_RF_PARAM_ID_RX_BIT_RATE 0x02 /* Receive Bit Rate */
302#define NCI_RF_PARAM_ID_B_DATA_EX_PARAM 0x03 /* B Data Exchange config param */
303
304
305#define NCI_NFCEE_INTERFACE_APDU 0x00
306#define NCI_NFCEE_INTERFACE_HCI_ACCESS 0x01
307#define NCI_NFCEE_INTERFACE_T3T 0x02
308#define NCI_NFCEE_INTERFACE_TRANSPARENT 0x03
309#define NCI_NFCEE_INTERFACE_PROPRIETARY 0x80
310
311#define NCI_NFCEE_STS_CONN_ACTIVE 0x00
312#define NCI_NFCEE_STS_CONN_INACTIVE 0x01
313#define NCI_NFCEE_STS_REMOVED 0x02
314#define NCI_NUM_NFCEE_STS 3
315
316#define NCI_CORE_PARAM_SIZE_NFCEE_MODE_SET 0x02 /* Logical Target ID (1 octet)NFCEE Mode (1 octet) */
317#define NCI_CORE_PARAM_SIZE_NFCEE_MODE_SET_RSP 0x01 /* Status (1 octet) */
318
319#define NCI_NFCEE_MD_DEACTIVATE 0x00 /* Deactivate the connected NFCEE */
320#define NCI_NFCEE_MD_ACTIVATE 0x01 /* Activate the connected NFCEE */
321#define NCI_NUM_NFCEE_MODE 2
322
323/**********************************************
324 * NCI Deactivation Type
325 **********************************************/
326#define NCI_DEACTIVATE_TYPE_IDLE 0 /* Idle Mode */
327#define NCI_DEACTIVATE_TYPE_SLEEP 1 /* Sleep Mode */
328#define NCI_DEACTIVATE_TYPE_SLEEP_AF 2 /* Sleep_AF Mode */
329#define NCI_DEACTIVATE_TYPE_DISCOVERY 3 /* Discovery */
330
331/**********************************************
332 * NCI Deactivation Reasons
333 **********************************************/
334#define NCI_DEACTIVATE_REASON_DH_REQ 0 /* DH Request */
335#define NCI_DEACTIVATE_REASON_ENDPOINT_REQ 1 /* Endpoint Request */
336#define NCI_DEACTIVATE_REASON_RF_LINK_LOSS 2 /* RF Link Loss */
337#define NCI_DEACTIVATE_REASON_NFCB_BAD_AFI 3 /* NFC-B Bad AFI */
338
339 /**********************************************
340 * NCI Interface Mode
341 **********************************************/
342#define NCI_INTERFACE_MODE_POLL 1
343#define NCI_INTERFACE_MODE_LISTEN 2
344#define NCI_INTERFACE_MODE_POLL_N_LISTEN 3
345
346/**********************************************
347 * NCI Interface Types
348 **********************************************/
349#define NCI_INTERFACE_EE_DIRECT_RF 0
350#define NCI_INTERFACE_FRAME 1
351#define NCI_INTERFACE_ISO_DEP 2
352#define NCI_INTERFACE_NFC_DEP 3
353#define NCI_INTERFACE_MAX NCI_INTERFACE_NFC_DEP
354#define NCI_INTERFACE_FIRST_VS 0x80
355typedef UINT8 tNCI_INTF_TYPE;
356
357/**********************************************
358 * NCI RF Management / DISCOVERY Group Params
359 **********************************************/
360#define NCI_DISCOVER_PARAM_SIZE_RSP 0x01
361
362#define NCI_DISCOVER_PARAM_SIZE_SELECT 0x03 /* ID, protocol, interface */
363#define NCI_DISCOVER_PARAM_SIZE_SELECT_RSP 0x01 /* Status (1 octet) */
364#define NCI_DISCOVER_PARAM_SIZE_STOP 0x00 /* */
365#define NCI_DISCOVER_PARAM_SIZE_STOP_RSP 0x01 /* Status (1 octet) */
366#define NCI_DISCOVER_PARAM_SIZE_DEACT 0x01 /* type */
367#define NCI_DISCOVER_PARAM_SIZE_DEACT_RSP 0x01 /* Status (1 octet) */
368#define NCI_DISCOVER_PARAM_SIZE_DEACT_NTF 0x01 /* type */
369
370/**********************************************
371 * Supported Protocols
372 **********************************************/
373#define NCI_PROTOCOL_UNKNOWN 0x00
374#define NCI_PROTOCOL_T1T 0x01
375#define NCI_PROTOCOL_T2T 0x02
376#define NCI_PROTOCOL_T3T 0x03
377#define NCI_PROTOCOL_ISO_DEP 0x04
378#define NCI_PROTOCOL_NFC_DEP 0x05
379/**********************************************
380 * Proprietary Protocols
381 **********************************************/
382#ifndef NCI_PROTOCOL_18092_ACTIVE
383#define NCI_PROTOCOL_18092_ACTIVE 0x80
384#endif
385#ifndef NCI_PROTOCOL_B_PRIME
386#define NCI_PROTOCOL_B_PRIME 0x81
387#endif
388#ifndef NCI_PROTOCOL_DUAL
389#define NCI_PROTOCOL_DUAL 0x82
390#endif
391#ifndef NCI_PROTOCOL_15693
392#define NCI_PROTOCOL_15693 0x83
393#endif
394#ifndef NCI_PROTOCOL_KOVIO
395#define NCI_PROTOCOL_KOVIO 0x8a
396#endif
397
398
399/* Discovery Types/Detected Technology and Mode */
400#define NCI_DISCOVERY_TYPE_POLL_A 0x00
401#define NCI_DISCOVERY_TYPE_POLL_B 0x01
402#define NCI_DISCOVERY_TYPE_POLL_F 0x02
403#define NCI_DISCOVERY_TYPE_POLL_A_ACTIVE 0x03
404#define NCI_DISCOVERY_TYPE_POLL_F_ACTIVE 0x05
405#define NCI_DISCOVERY_TYPE_POLL_B_PRIME 0x74
406#define NCI_DISCOVERY_TYPE_POLL_KOVIO 0x77
407#define NCI_DISCOVERY_TYPE_LISTEN_A 0x80
408#define NCI_DISCOVERY_TYPE_LISTEN_B 0x81
409#define NCI_DISCOVERY_TYPE_LISTEN_F 0x82
410#define NCI_DISCOVERY_TYPE_LISTEN_A_ACTIVE 0x83
411#define NCI_DISCOVERY_TYPE_LISTEN_F_ACTIVE 0x85
412#define NCI_DISCOVERY_TYPE_LISTEN_B_PRIME 0xF4
413#define NCI_DISCOVERY_TYPE_POLL_ISO15693 0x06
414#define NCI_DISCOVERY_TYPE_LISTEN_ISO15693 0x86
415#define NCI_DISCOVERY_TYPE_MAX NCI_DISCOVERY_TYPE_LISTEN_ISO15693
416
417typedef UINT8 tNCI_DISCOVERY_TYPE;
418
419#define NCI_EE_TRIG_7816_SELECT 0x00
420#define NCI_EE_TRIG_RF_PROTOCOL 0x01
421#define NCI_EE_TRIG_RF_TECHNOLOGY 0x02
422#define NCI_EE_TRIG_APP_INIT 0x10
423
424#define NCI_EE_ACT_TAG_AID 0xC0 /* AID */
425#define NCI_EE_ACT_TAG_PROTO 0xC1 /* RF protocol */
426#define NCI_EE_ACT_TAG_TECH 0xC2 /* RF technology */
427#define NCI_EE_ACT_TAG_DATA 0xC3 /* hex data for app */
428#define NCI_EE_ACT_TAG_DEBUG 0xC4 /* debug trace */
429
430#define NCI_ROUTE_TAG_TECH 0x00 /* Technology based routing */
431#define NCI_ROUTE_TAG_PROTO 0x01 /* Protocol based routing */
432#define NCI_ROUTE_TAG_AID 0x02 /* AID routing */
433
434#define NCI_ROUTE_PWR_STATE_ON 0x01 /* The device is on */
435#define NCI_ROUTE_PWR_STATE_SWITCH_OFF 0x02 /* The device is switched off */
436#define NCI_ROUTE_PWR_STATE_BATT_OFF 0x04 /* The device's battery is removed */
437
438#define NCI_NFCEE_TAG_HW_ID 0x00 /* Hardware / Registration Identification */
439#define NCI_NFCEE_TAG_ATR_BYTES 0x01 /* ATR Bytes */
440#define NCI_NFCEE_TAG_T3T_INFO 0x02 /* T3T Command Set Interface Supplementary Info */
441#define NCI_NFCEE_TAG_HCI_HOST_ID 0xA0 /* HCI host ID */
442
443#define NCI_DISCOVER_NTF_LAST 0x00
444#define NCI_DISCOVER_NTF_LAST_ABORT 0x01
445#define NCI_DISCOVER_NTF_MORE 0x02
446
447
448/* NCI RF Management Group Params */
449#define NCI_RF_PARAM_SIZE_T3T_POLLING 0x04 /* System Code, RC, TSN */
450
451/**********************************************
452 * NCI Parameter IDs
453 **********************************************/
454
455#define NCI_PARAM_ID_TOTAL_DURATION 0x00
456#define NCI_PARAM_ID_CON_DEVICES_LIMIT 0x01
457#define NCI_PARAM_ID_PA_BAILOUT 0x08
458#define NCI_PARAM_ID_PB_AFI 0x10
459#define NCI_PARAM_ID_PB_BAILOUT 0x11
460#define NCI_PARAM_ID_PB_ATTRIB_PARAM1 0x12
461#define NCI_PARAM_ID_PF_BIT_RATE 0x18
462#define NCI_PARAM_ID_PB_H_INFO 0x20
463#define NCI_PARAM_ID_PI_BIT_RATE 0x21
464
465#define NCI_PARAM_ID_BITR_NFC_DEP 0x28
466#define NCI_PARAM_ID_ATR_REQ_GEN_BYTES 0x29
467#define NCI_PARAM_ID_ATR_REQ_CONFIG 0x2A
468
469#define NCI_PARAM_ID_LA_BIT_FRAME_SDD 0x30
470#define NCI_PARAM_ID_LA_PLATFORM_CONFIG 0x31
471#define NCI_PARAM_ID_LA_SEL_INFO 0x32
472#define NCI_PARAM_ID_LA_NFCID1 0x33
473#define NCI_PARAM_ID_LB_SENSB_INFO 0x38
474#define NCI_PARAM_ID_LB_NFCID0 0x39
475#define NCI_PARAM_ID_LB_APPDATA 0x3A
476#define NCI_PARAM_ID_LB_SFGI 0x3B
477#define NCI_PARAM_ID_LB_ADC_FO 0x3C
478#define NCI_PARAM_ID_LB_PROTOCOL NCI_PARAM_ID_LB_SENSB_INFO
479
480#define NCI_PARAM_ID_LF_T3T_ID1 0x40
481#define NCI_PARAM_ID_LF_T3T_ID2 0x41
482#define NCI_PARAM_ID_LF_T3T_ID3 0x42
483#define NCI_PARAM_ID_LF_T3T_ID4 0x43
484#define NCI_PARAM_ID_LF_T3T_ID5 0x44
485#define NCI_PARAM_ID_LF_T3T_ID6 0x45
486#define NCI_PARAM_ID_LF_T3T_ID7 0x46
487#define NCI_PARAM_ID_LF_T3T_ID8 0x47
488#define NCI_PARAM_ID_LF_T3T_ID9 0x48
489#define NCI_PARAM_ID_LF_T3T_ID10 0x49
490#define NCI_PARAM_ID_LF_T3T_ID11 0x4A
491#define NCI_PARAM_ID_LF_T3T_ID12 0x4B
492#define NCI_PARAM_ID_LF_T3T_ID13 0x4C
493#define NCI_PARAM_ID_LF_T3T_ID14 0x4D
494#define NCI_PARAM_ID_LF_T3T_ID15 0x4E
495#define NCI_PARAM_ID_LF_T3T_ID16 0x4F
496#define NCI_PARAM_ID_LF_PROTOCOL 0x50
497#define NCI_PARAM_ID_LF_T3T_PMM 0x51
498#define NCI_PARAM_ID_LF_T3T_MAX 0x52 /* max num of LF_T3T_ID supported by NFCC (1 for now) */
499#define NCI_PARAM_ID_LF_T3T_FLAGS2 0x53
500#define NCI_PARAM_ID_LF_CON_BITR_F 0x54
501#define NCI_PARAM_ID_FWI 0x58
502#define NCI_PARAM_ID_LA_HIST_BY 0x59
503#define NCI_PARAM_ID_LB_H_INFO_RSP 0x5A
504#define NCI_PARAM_ID_LI_BIT_RATE 0x5B
505
506#define NCI_PARAM_ID_WT 0x60
507#define NCI_PARAM_ID_ATR_RES_GEN_BYTES 0x61
508#define NCI_PARAM_ID_ATR_RSP_CONFIG 0x62
509
510#define NCI_PARAM_ID_RF_FIELD_INFO 0x80
511#define NCI_PARAM_ID_RF_NFCEE_ACTION 0x81
512#define NCI_PARAM_ID_NFC_DEP_OP 0x82
513
514
515
516/* NCI_PARAM_ID_HOST_LISTEN_MASK (byte1 for DH, byte2 for UICC) */
517#define NCI_LISTEN_MASK_A 0x01 /* (0x01 << (NCI_DISCOVERY_TYPE_LISTEN_A_PASSIVE & 0x0F)) */
518#define NCI_LISTEN_MASK_B 0x02 /* (0x01 << (NCI_DISCOVERY_TYPE_LISTEN_B_PASSIVE & 0x0F)) */
519#define NCI_LISTEN_MASK_F 0x04 /* (0x01 << (NCI_DISCOVERY_TYPE_LISTEN_F_PASSIVE & 0x0F)) */
520#define NCI_LISTEN_MASK_A_ACTIVE 0x08 /* (0x01 << (NCI_DISCOVERY_TYPE_LISTEN_A_ACTIVE & 0x0F)) */
521#define NCI_LISTEN_MASK_B_PRIME 0x10 /* (0x01 << (NCI_DISCOVERY_TYPE_LISTEN_B_PRIME & 0x0F)) */
522#define NCI_LISTEN_MASK_F_ACTIVE 0x20 /* (0x01 << (NCI_DISCOVERY_TYPE_LISTEN_F_ACTIVE & 0x0F)) */
523#define NCI_LISTEN_MASK_ISO15693 0x40 /* (0x01 << (NCI_DISCOVERY_TYPE_LISTEN_ISO15693 & 0x0F)) */
524
525/* Type A Parameters */
526#define NCI_PARAM_PLATFORM_T1T 0x0C
527#define NCI_PARAM_SEL_INFO_ISODEP 0x20
528#define NCI_PARAM_SEL_INFO_NFCDEP 0x40
529/**********************************************
530 * NCI Parameter ID Lens
531 **********************************************/
532#define NCI_PARAM_LEN_TOTAL_DURATION 2
533
534#define NCI_PARAM_LEN_PA_FSDI 1
535
536#define NCI_PARAM_LEN_LA_BIT_FRAME_SDD 1
537#define NCI_PARAM_LEN_LA_PLATFORM_CONFIG 1
538#define NCI_PARAM_LEN_LA_SEL_INFO 1
539
540#define NCI_PARAM_LEN_LB_SENSB_INFO 1
541#define NCI_PARAM_LEN_LB_NFCID0 4
542#define NCI_PARAM_LEN_LB_APPDATA 4
543#define NCI_PARAM_LEN_LB_ADC_FO 1
544
545#define NCI_PARAM_LEN_LF_PROTOCOL 1
546#define NCI_PARAM_LEN_LF_T3T_FLAGS2 2
547#define NCI_PARAM_LEN_LF_T3T_PMM 8
548#define NCI_PARAM_LEN_LF_T3T_ID 10
549
550#define NCI_PARAM_LEN_FWI 1
551#define NCI_PARAM_LEN_WT 1
552/* GEN_BYTES - variable */
553
554/* Listen protocol bits - NCI_PARAM_ID_LF_PROTOCOL and NCI_PARAM_ID_LB_SENSB_INFO */
555#define NCI_LISTEN_PROTOCOL_ISO_DEP 0x01
556#define NCI_LISTEN_PROTOCOL_NFC_DEP 0x02
557
558#define NCI_DISCOVER_PARAM_SIZE_TEST_RF 0x06
559
560
561/* LF_T3T_FLAGS2 listen bits all-disabled definition */
562#define NCI_LF_T3T_FLAGS2_ALL_DISABLED 0x0000
563#define NCI_LF_T3T_FLAGS2_ID1_ENABLED 0x0001
564
565typedef struct
566{
567 UINT16 addr;
568 UINT8 len;
569 UINT8 *data;
570} NCIP_T1T_SETMEM_CMD_t;
571
572typedef struct
573{
574 UINT8 status;
575} NCIP_T1T_SETMEM_RSP_t;
576
577typedef struct
578{
579 UINT16 addr;
580} NCIP_T1T_GETMEM_CMD_t;
581
582typedef struct
583{
584 UINT8 status;
585 UINT8 *data;
586} NCIP_T1T_GETMEM_RSP_t;
587
588typedef struct
589{
590 UINT8 hr0;
591 UINT8 hr1;
592} NCIP_T1T_SETHR_CMD_t;
593
594typedef struct
595{
596 UINT8 status;
597} NCIP_T1T_SETHR_RSP_t;
598
599
600#ifndef NCI_GET_CMD_BUF
601#if (!defined (HCI_USE_VARIABLE_SIZE_CMD_BUF) || (HCI_USE_VARIABLE_SIZE_CMD_BUF == FALSE))
602/* Allocate fixed-size buffer from HCI_CMD_POOL (default case) */
603#define NCI_GET_CMD_BUF(paramlen) ((BT_HDR *) GKI_getpoolbuf (NFC_NCI_POOL_ID))
604#else
605/* Allocate smallest possible buffer (for platforms with limited RAM) */
606#define NCI_GET_CMD_BUF(paramlen) ((BT_HDR *) GKI_getbuf ((UINT16) (BT_HDR_SIZE + NCI_MSG_HDR_SIZE + NCI_MSG_OFFSET_SIZE + (paramlen))))
607#endif
608#endif /* NCI_GET_CMD_BUF */
609
610
611#define NCI_MAX_AID_LEN 16
612
613
614typedef struct
615{
616 UINT8 type;
617 UINT8 frequency;
618} tNCI_DISCOVER_PARAMS;
619
620typedef struct
621{
622 UINT8 protocol;
623 UINT8 mode;
624 UINT8 intf_type;
625} tNCI_DISCOVER_MAPS;
626
627#define NCI_NFCID1_MAX_LEN 10
628typedef struct
629{
630 UINT8 sens_res[2];/* SENS_RES Response (ATQA). Available after Technology Detection */
631 UINT8 nfcid1_len; /* 4, 7 or 10 */
632 UINT8 nfcid1[NCI_NFCID1_MAX_LEN]; /* AKA NFCID1 */
633 UINT8 sel_rsp; /* SEL_RSP (SAK) Available after Collision Resolution */
634} tNCI_RF_PA_PARAMS;
635
636
637#define NCI_MAX_SENSB_RES_LEN 12
638typedef struct
639{
640 UINT8 sensb_res_len;/* Length of SENSB_RES Response (Byte 2 - Byte 12 or 13) Available after Technology Detection */
641 UINT8 sensb_res[NCI_MAX_SENSB_RES_LEN]; /* SENSB_RES Response (ATQ) */
642} tNCI_RF_PB_PARAMS;
643
644#define NCI_MAX_SENSF_RES_LEN 18
645#define NCI_SENSF_RES_OFFSET_PAD0 8
646#define NCI_SENSF_RES_OFFSET_RD 16
647#define NCI_NFCID2_LEN 8
648#define NCI_T3T_PMM_LEN 8
649#define NCI_SYSTEMCODE_LEN 2
650#define NCI_RF_F_UID_LEN NCI_NFCID2_LEN
651#define NCI_MRTI_CHECK_INDEX 13
652#define NCI_MRTI_UPDATE_INDEX 14
653typedef struct
654{
655 UINT8 bit_rate;/* NFC_BIT_RATE_212 or NFC_BIT_RATE_424 */
656 UINT8 sensf_res_len;/* Length of SENSF_RES Response (Byte 2 - Byte 17 or 19) Available after Technology Detection */
657 UINT8 sensf_res[NCI_MAX_SENSF_RES_LEN]; /* SENSB_RES Response */
658} tNCI_RF_PF_PARAMS;
659
660typedef struct
661{
662 UINT8 nfcid2[NCI_NFCID2_LEN]; /* NFCID2 generated by the Local NFCC for NFC-DEP Protocol.Available for Frame Interface */
663} tNCI_RF_LF_PARAMS;
664
665typedef struct
666{
667 tNCI_DISCOVERY_TYPE mode;
668 union
669 {
670 tNCI_RF_PA_PARAMS pa;
671 tNCI_RF_PB_PARAMS pb;
672 tNCI_RF_PF_PARAMS pf;
673 tNCI_RF_LF_PARAMS lf;
674 } param; /* Discovery Type specific parameters */
675} tNCI_RF_TECH_PARAMS;
676
677
678#ifndef NCI_MAX_ATS_LEN
679#define NCI_MAX_ATS_LEN 60
680#endif
681#ifndef NCI_MAX_HIS_BYTES_LEN
682#define NCI_MAX_HIS_BYTES_LEN 50
683#endif
684#ifndef NCI_MAX_GEN_BYTES_LEN
685#define NCI_MAX_GEN_BYTES_LEN 48
686#endif
687
688#define NCI_ATS_T0_INDEX 0
689#define NCI_ATS_TC_MASK 0x40
690#define NCI_ATS_TB_MASK 0x20
691#define NCI_ATS_TA_MASK 0x10
692#define NCI_ATS_FSCI_MASK 0x0F
693typedef struct
694{
695 UINT8 ats_res_len; /* Length of ATS RES */
696 UINT8 ats_res[NCI_MAX_ATS_LEN]; /* ATS RES defined in [DIGPROT] */
697} tNCI_INTF_PA_ISO_DEP;
698
699typedef struct
700{
701 UINT8 rats; /* RATS */
702} tNCI_INTF_LA_ISO_DEP;
703
704#define NCI_P_GEN_BYTE_INDEX 15
705#define NCI_L_GEN_BYTE_INDEX 14
706#define NCI_L_NFC_DEP_TO_INDEX 13
707typedef struct
708{
709 UINT8 atr_res_len; /* Length of ATR_RES */
710 UINT8 atr_res[NCI_MAX_ATS_LEN]; /* ATR_RES (Byte 3 - Byte 17+n) as defined in [DIGPROT] */
711} tNCI_INTF_PA_NFC_DEP;
712
713/* Note: keep tNCI_INTF_PA_NFC_DEP data member in the same order as tNCI_INTF_LA_NFC_DEP */
714typedef struct
715{
716 UINT8 atr_req_len; /* Length of ATR_REQ */
717 UINT8 atr_req[NCI_MAX_ATS_LEN]; /* ATR_REQ (Byte 3 - Byte 18+n) as defined in [DIGPROT] */
718} tNCI_INTF_LA_NFC_DEP;
719typedef tNCI_INTF_LA_NFC_DEP tNCI_INTF_LF_NFC_DEP;
720typedef tNCI_INTF_PA_NFC_DEP tNCI_INTF_PF_NFC_DEP;
721
722#define NCI_MAX_ATTRIB_LEN (10 + NCI_MAX_GEN_BYTES_LEN)
723
724typedef struct
725{
726 UINT8 attrib_res_len; /* Length of ATTRIB RES */
727 UINT8 attrib_res[NCI_MAX_ATTRIB_LEN]; /* ATTRIB RES as defined in [DIGPROT] */
728} tNCI_INTF_PB_ISO_DEP;
729
730typedef struct
731{
732 UINT8 attrib_req_len; /* Length of ATTRIB REQ */
733 UINT8 attrib_req[NCI_MAX_ATTRIB_LEN]; /* ATTRIB REQ (Byte 2 - Byte 10+k) as defined in [DIGPROT] */
734} tNCI_INTF_LB_ISO_DEP;
735
736typedef struct
737{
738 tNCI_INTF_TYPE type; /* Interface Type 1 Byte See Table 67 */
739 union
740 {
741 tNCI_INTF_LA_ISO_DEP la_iso;
742 tNCI_INTF_PA_ISO_DEP pa_iso;
743 tNCI_INTF_LB_ISO_DEP lb_iso;
744 tNCI_INTF_PB_ISO_DEP pb_iso;
745 tNCI_INTF_LA_NFC_DEP la_nfc;
746 tNCI_INTF_PA_NFC_DEP pa_nfc;
747 tNCI_INTF_LF_NFC_DEP lf_nfc;
748 tNCI_INTF_PF_NFC_DEP pf_nfc;
749 } intf_param; /* Activation Parameters 0 - n Bytes */
750} tNCI_INTF_PARAMS;
751
752/*
753** HCI Network CMD/NTF structure
754*/
755typedef struct
756{
757 UINT8 pipe_id; /* if MSB is set then valid, 7 bits for Pipe ID */
758 UINT8 mode; /* Type A card emulation enabled indicator, 0x02:enabled */
759 UINT8 sak;
760 UINT8 uid_reg_len;
761 UINT8 uid_reg[10];
762 UINT8 atqa[2]; /* ATQA response code */
763 UINT8 app_data_len;
764 UINT8 app_data[15]; /* 15 bytes optional storage for historic data, use 2 slots */
765 UINT8 fwi_sfgi; /* FRAME WAITING TIME, START-UP FRAME GUARD TIME */
766 UINT8 cid_support;
767 UINT8 datarate_max[3];
768 UINT8 clt_support;
769} tNCI_HCI_CE_RF_A;
770
771typedef struct
772{
773 UINT8 pipe_id; /* if MSB is set then valid, 7 bits for Pipe ID */
774 UINT8 mode; /* Type B card emulation enabled indicator, 0x02:enabled */
775 UINT8 pupi_len;
776 UINT8 pupi_reg[4];
777 UINT8 afi;
778 UINT8 atqb[4]; /* 4 bytes ATQB application data */
779 UINT8 higherlayer_resp[61]; /* 0~ 61 bytes ATRB_INF use 1~4 personality slots */
780 UINT8 datarate_max[3];
781 UINT8 natrb;
782} tNCI_HCI_CE_RF_B;
783
784typedef struct
785{
786 UINT8 pipe_id; /* if MSB is set then valid, 7 bits for Pipe ID */
787 UINT8 mode; /* Type B prime card emulation enabled indicator, 0x02:enabled */
788 UINT8 pat_in_len;
789 UINT8 pat_in[8];
790 UINT8 dat_out_len;
791 UINT8 dat_out[40]; /* ISO7816-3 <=64 byte, and other fields are 9 bytes */
792 UINT8 natr;
793} tNCI_HCI_CE_RF_BP;
794
795typedef struct
796{
797 UINT8 pipe_id; /* if MSB is set then valid, 7 bits for Pipe ID */
798 UINT8 mode; /* Type F card emulation enabled indicator, 0x02:enabled */
799 UINT8 speed_cap;
800 UINT8 clt_support;
801} tNCI_HCI_CE_RF_F;
802
803typedef struct
804{
805 UINT8 pipe_id; /* if MSB is set then valid, 7 bits for Pipe ID */
806 UINT8 datarate_max;
807} tNCI_HCI_RD_RF_A;
808
809typedef struct
810{
811 UINT8 pipe_id; /* if MSB is set then valid, 7 bits for Pipe ID */
812 UINT8 afi;
813 UINT8 hldata_len;
814 UINT8 high_layer_data[61]; /* INF field in ATTRIB command */
815} tNCI_HCI_RD_RF_B;
816
817typedef struct
818{
819 UINT8 source_host;
820 UINT8 dest_host;
821 UINT8 source_gate;
822 UINT8 dest_gate;
823 UINT8 pipe_id; /* if MSB is set then valid, 7 bits for Pipe ID */
824} tNCI_HCI_DYN_PIPE_INFO;
825
826typedef struct
827{
828 UINT8 target_handle;
829 UINT8 session_id[8];
830 UINT8 sync_id[2];
831 UINT8 static_pipe_info;
832 tNCI_HCI_CE_RF_A ce_rf_a;
833 tNCI_HCI_CE_RF_B ce_rf_b;
834 tNCI_HCI_CE_RF_BP ce_rf_bp;
835 tNCI_HCI_CE_RF_F ce_rf_f;
836} tNCI_HCI_NETWK;
837
838typedef struct
839{
840 UINT8 target_handle;
841 UINT8 session_id[8];
842 UINT8 static_pipe_info;
843 UINT8 num_dyn_pipes;
844 tNCI_HCI_DYN_PIPE_INFO dyn_pipe_info[20];
845} tNCI_HCI_NETWK_DH;
846
847#ifdef __cplusplus
848}
849#endif
850
851#endif /* NFC_NCI_DEFS_H */