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