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