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