1 /****************************************************************************** 2 * 3 * Copyright (C) 2009-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 Near Field Communication (NFC) API function 22 * external definitions. 23 * 24 ******************************************************************************/ 25 26 #ifndef NFC_API_H 27 #define NFC_API_H 28 29 #include "gki.h" 30 #include "nci_defs.h" 31 #include "nfc_hal_api.h" 32 #include "nfc_target.h" 33 34 #include "vendor_cfg.h" 35 36 /* NFC application return status codes */ 37 /* Command succeeded */ 38 #define NFC_STATUS_OK NCI_STATUS_OK 39 /* Command is rejected. */ 40 #define NFC_STATUS_REJECTED NCI_STATUS_REJECTED 41 /* Message is corrupted */ 42 #define NFC_STATUS_MSG_CORRUPTED NCI_STATUS_MESSAGE_CORRUPTED 43 /* buffer full */ 44 #define NFC_STATUS_BUFFER_FULL NCI_STATUS_BUFFER_FULL 45 /* failed */ 46 #define NFC_STATUS_FAILED NCI_STATUS_FAILED 47 /* not initialized */ 48 #define NFC_STATUS_NOT_INITIALIZED NCI_STATUS_NOT_INITIALIZED 49 /* Syntax error */ 50 #define NFC_STATUS_SYNTAX_ERROR NCI_STATUS_SYNTAX_ERROR 51 /* Semantic error */ 52 #define NFC_STATUS_SEMANTIC_ERROR NCI_STATUS_SEMANTIC_ERROR 53 /* Unknown NCI Group ID */ 54 #define NFC_STATUS_UNKNOWN_GID NCI_STATUS_UNKNOWN_GID 55 /* Unknown NCI Opcode */ 56 #define NFC_STATUS_UNKNOWN_OID NCI_STATUS_UNKNOWN_OID 57 /* Invalid Parameter */ 58 #define NFC_STATUS_INVALID_PARAM NCI_STATUS_INVALID_PARAM 59 /* Message size too big */ 60 #define NFC_STATUS_MSG_SIZE_TOO_BIG NCI_STATUS_MSG_SIZE_TOO_BIG 61 /* Already started */ 62 #define NFC_STATUS_ALREADY_STARTED NCI_STATUS_ALREADY_STARTED 63 /* Activation Failed */ 64 #define NFC_STATUS_ACTIVATION_FAILED NCI_STATUS_ACTIVATION_FAILED 65 /* Tear Down Error */ 66 #define NFC_STATUS_TEAR_DOWN NCI_STATUS_TEAR_DOWN 67 /* RF transmission error*/ 68 #define NFC_STATUS_RF_TRANSMISSION_ERR NCI_STATUS_RF_TRANSMISSION_ERR 69 /* RF protocol error */ 70 #define NFC_STATUS_RF_PROTOCOL_ERR NCI_STATUS_RF_PROTOCOL_ERR 71 /* RF Timeout */ 72 #define NFC_STATUS_TIMEOUT NCI_STATUS_TIMEOUT 73 /* EE Intf activate err */ 74 #define NFC_STATUS_EE_INTF_ACTIVE_FAIL NCI_STATUS_EE_INTF_ACTIVE_FAIL 75 /* EE transmission error*/ 76 #define NFC_STATUS_EE_TRANSMISSION_ERR NCI_STATUS_EE_TRANSMISSION_ERR 77 /* EE protocol error */ 78 #define NFC_STATUS_EE_PROTOCOL_ERR NCI_STATUS_EE_PROTOCOL_ERR 79 /* EE Timeout */ 80 #define NFC_STATUS_EE_TIMEOUT NCI_STATUS_EE_TIMEOUT 81 82 /* 0xE0 ~0xFF are proprietary status codes */ 83 /* Command started successfully */ 84 #define NFC_STATUS_CMD_STARTED 0xE3 85 /* NFCC Timeout in responding to an NCI command */ 86 #define NFC_STATUS_HW_TIMEOUT 0xE4 87 /* More (same) event to follow */ 88 #define NFC_STATUS_CONTINUE 0xE5 89 /* API is called to perform illegal function */ 90 #define NFC_STATUS_REFUSED 0xE6 91 /* Wrong format of R-APDU, CC file or NDEF file */ 92 #define NFC_STATUS_BAD_RESP 0xE7 93 /* 7816 Status Word is not command complete(0x9000) */ 94 #define NFC_STATUS_CMD_NOT_CMPLTD 0xE8 95 /* Out of GKI buffers */ 96 #define NFC_STATUS_NO_BUFFERS 0xE9 97 /* Protocol mismatch between API and activated one */ 98 #define NFC_STATUS_WRONG_PROTOCOL 0xEA 99 /* Another Tag command is already in progress */ 100 #define NFC_STATUS_BUSY 0xEB 101 102 /* Link Loss */ 103 #define NFC_STATUS_LINK_LOSS 0xFC 104 /* data len exceeds MIU */ 105 #define NFC_STATUS_BAD_LENGTH 0xFD 106 /* invalid handle */ 107 #define NFC_STATUS_BAD_HANDLE 0xFE 108 /* congested */ 109 #define NFC_STATUS_CONGESTED 0xFF 110 typedef uint8_t tNFC_STATUS; 111 112 /********************************************** 113 * NFC Config Parameter IDs defined by NCI 114 **********************************************/ 115 #define NFC_PMID_TOTAL_DURATION NCI_PARAM_ID_TOTAL_DURATION 116 #define NFC_PMID_PF_RC NCI_PARAM_ID_PF_RC 117 #define NFC_PMID_ATR_REQ_GEN_BYTES NCI_PARAM_ID_ATR_REQ_GEN_BYTES 118 #define NFC_PMID_LA_HIST_BY NCI_PARAM_ID_LA_HIST_BY 119 #define NFC_PMID_LA_NFCID1 NCI_PARAM_ID_LA_NFCID1 120 #define NFC_PMID_LA_BIT_FRAME_SDD NCI_PARAM_ID_LA_BIT_FRAME_SDD 121 #define NFC_PMID_LA_PLATFORM_CONFIG NCI_PARAM_ID_LA_PLATFORM_CONFIG 122 #define NFC_PMID_LA_SEL_INFO NCI_PARAM_ID_LA_SEL_INFO 123 #define NFC_PMID_LB_SENSB_INFO NCI_PARAM_ID_LB_SENSB_INFO 124 #define NFC_PMID_LB_H_INFO NCI_PARAM_ID_LB_H_INFO_RSP 125 #define NFC_PMID_LB_NFCID0 NCI_PARAM_ID_LB_NFCID0 126 #define NFC_PMID_LB_APPDATA NCI_PARAM_ID_LB_APPDATA 127 #define NFC_PMID_LB_SFGI NCI_PARAM_ID_LB_SFGI 128 #define NFC_PMID_LB_ADC_FO NCI_PARAM_ID_LB_ADC_FO 129 #define NFC_PMID_LF_T3T_ID1 NCI_PARAM_ID_LF_T3T_ID1 130 #define NFC_PMID_LF_PROTOCOL NCI_PARAM_ID_LF_PROTOCOL 131 #define NFC_PMID_LF_T3T_PMM NCI_PARAM_ID_LF_T3T_PMM 132 #define NFC_PMID_LF_T3T_FLAGS2 NCI_PARAM_ID_LF_T3T_FLAGS2 133 #define NFC_PMID_FWI NCI_PARAM_ID_FWI 134 #define NFC_PMID_LF_CON_BITR_F NCI_PARAM_ID_LF_CON_BITR_F 135 #define NFC_PMID_WT NCI_PARAM_ID_WT 136 #define NFC_PMID_ATR_RES_GEN_BYTES NCI_PARAM_ID_ATR_RES_GEN_BYTES 137 #define NFC_PMID_ATR_RSP_CONFIG NCI_PARAM_ID_ATR_RSP_CONFIG 138 #define NFC_PMID_RF_FIELD_INFO NCI_PARAM_ID_RF_FIELD_INFO 139 140 /* Technology based routing */ 141 #define NFC_ROUTE_TAG_TECH NCI_ROUTE_TAG_TECH 142 /* Protocol based routing */ 143 #define NFC_ROUTE_TAG_PROTO NCI_ROUTE_TAG_PROTO 144 #define NFC_ROUTE_TAG_AID NCI_ROUTE_TAG_AID /* AID routing */ 145 #define NFC_ROUTE_TAG_SYSCODE NCI_ROUTE_TAG_SYSCODE /* System Code routing*/ 146 /* tag, len, 2 byte value for technology/protocol based routing */ 147 148 /* For routing */ 149 #define NFC_DH_ID NCI_DH_ID /* for DH */ 150 /* To identify the loopback test */ 151 /* use a proprietary range */ 152 #define NFC_TEST_ID NCI_TEST_ID 153 154 #define NFC_TL_SIZE 2 155 #define NFC_SAVED_CMD_SIZE 2 156 157 typedef tNCI_DISCOVER_MAPS tNFC_DISCOVER_MAPS; 158 typedef tNCI_DISCOVER_PARAMS tNFC_DISCOVER_PARAMS; 159 160 /* all NFC Manager Callback functions have prototype like void (cback) (uint8_t 161 * event, void *p_data) 162 * tNFC_DATA_CBACK uses connection id as the first parameter; range 0x00-0x0F. 163 * tNFC_DISCOVER_CBACK uses tNFC_DISCOVER_EVT; range 0x4000 ~ 164 * tNFC_RESPONSE_CBACK uses tNFC_RESPONSE_EVT; range 0x5000 ~ 165 */ 166 167 #define NFC_FIRST_DEVT 0x4000 168 #define NFC_FIRST_REVT 0x5000 169 #define NFC_FIRST_CEVT 0x6000 170 #define NFC_FIRST_TEVT 0x8000 171 172 /* the events reported on tNFC_RESPONSE_CBACK */ 173 enum { 174 NFC_ENABLE_REVT = NFC_FIRST_REVT, /* 0 Enable event */ 175 NFC_DISABLE_REVT, /* 1 Disable event */ 176 NFC_SET_CONFIG_REVT, /* 2 Set Config Response */ 177 NFC_GET_CONFIG_REVT, /* 3 Get Config Response */ 178 NFC_NFCEE_DISCOVER_REVT, /* 4 Discover NFCEE response */ 179 NFC_NFCEE_INFO_REVT, /* 5 Discover NFCEE Notification */ 180 NFC_NFCEE_MODE_SET_REVT, /* 6 NFCEE Mode Set response */ 181 NFC_RF_FIELD_REVT, /* 7 RF Field information */ 182 NFC_EE_ACTION_REVT, /* 8 EE Action notification */ 183 NFC_EE_DISCOVER_REQ_REVT, /* 9 EE Discover Req notification */ 184 NFC_SET_ROUTING_REVT, /* 10 Configure Routing response */ 185 NFC_GET_ROUTING_REVT, /* 11 Retrieve Routing response */ 186 NFC_RF_COMM_PARAMS_UPDATE_REVT, /* 12 RF Communication Param Update */ 187 NFC_GEN_ERROR_REVT, /* 13 generic error notification */ 188 NFC_NFCC_RESTART_REVT, /* 14 NFCC has been re-initialized */ 189 NFC_NFCC_TIMEOUT_REVT, /* 15 NFCC is not responding */ 190 NFC_NFCC_TRANSPORT_ERR_REVT, /* 16 NCI Tranport error */ 191 NFC_NFCC_POWER_OFF_REVT, /* 17 NFCC turned off */ 192 NFC_SET_POWER_SUB_STATE_REVT, /* 18 Set power sub state response */ 193 NFC_NFCEE_PL_CONTROL_REVT, /* NFCEE Power/Link Ctrl response*/ 194 NFC_NFCEE_STATUS_REVT /* NFCEE Status Notification */ 195 /* First vendor-specific rsp event */ 196 }; 197 typedef uint16_t tNFC_RESPONSE_EVT; 198 199 enum { 200 NFC_CONN_CREATE_CEVT = NFC_FIRST_CEVT, /* 0 Conn Create Response */ 201 NFC_CONN_CLOSE_CEVT, /* 1 Conn Close Response */ 202 NFC_DEACTIVATE_CEVT, /* 2 Deactivate response/notificatn*/ 203 NFC_DATA_CEVT, /* 3 Data */ 204 NFC_ERROR_CEVT, /* 4 generic or interface error */ 205 NFC_DATA_START_CEVT /* 5 received the first fragment on RF link */ 206 }; 207 typedef uint16_t tNFC_CONN_EVT; 208 209 #define NFC_NFCC_INFO_LEN 4 210 #ifndef NFC_NFCC_MAX_NUM_VS_INTERFACE 211 #define NFC_NFCC_MAX_NUM_VS_INTERFACE 5 212 #endif 213 typedef struct { 214 tNFC_STATUS status; /* The event status. */ 215 uint8_t nci_version; /* the NCI version of NFCC */ 216 uint8_t max_conn; /* max number of connections by NFCC*/ 217 uint32_t nci_features; /* the NCI features of NFCC */ 218 uint16_t nci_interfaces; /* the NCI interfaces of NFCC */ 219 uint16_t max_ce_table; /* the max routing table size */ 220 uint16_t max_param_size; /* Max Size for Large Parameters */ 221 uint8_t manufacture_id; /* the Manufacture ID for NFCC */ 222 uint8_t nfcc_info[NFC_NFCC_INFO_LEN]; /* the Manufacture Info for NFCC */ 223 uint8_t vs_interface 224 [NFC_NFCC_MAX_NUM_VS_INTERFACE]; /* the NCI VS interfaces of NFCC */ 225 uint8_t hci_packet_size; /*HCI payload size*/ 226 uint8_t hci_conn_credits; /*max number of HCI credits*/ 227 uint16_t max_nfc_v_size; /* maximum frame size for NFC-V*/ 228 } tNFC_ENABLE_REVT; 229 230 #define NFC_MAX_NUM_IDS 125 231 /* the data type associated with NFC_SET_CONFIG_REVT */ 232 typedef struct { 233 tNFC_STATUS status; /* The event status. */ 234 uint8_t num_param_id; /* Number of rejected NCI Param ID */ 235 uint8_t param_ids[NFC_MAX_NUM_IDS]; /* NCI Param ID */ 236 } tNFC_SET_CONFIG_REVT; 237 238 /* the data type associated with NFC_GET_CONFIG_REVT */ 239 typedef struct { 240 tNFC_STATUS status; /* The event status. */ 241 uint16_t tlv_size; /* The length of TLV */ 242 uint8_t* p_param_tlvs; /* TLV */ 243 } tNFC_GET_CONFIG_REVT; 244 245 /* the data type associated with NFC_NFCEE_DISCOVER_REVT */ 246 typedef struct { 247 tNFC_STATUS status; /* The event status. */ 248 uint8_t num_nfcee; /* The number of NFCEE */ 249 } tNFC_NFCEE_DISCOVER_REVT; 250 251 #define NFC_NFCEE_INTERFACE_APDU NCI_NFCEE_INTERFACE_APDU 252 #define NFC_NFCEE_INTERFACE_HCI_ACCESS NCI_NFCEE_INTERFACE_HCI_ACCESS 253 #define NFC_NFCEE_INTERFACE_T3T NCI_NFCEE_INTERFACE_T3T 254 #define NFC_NFCEE_INTERFACE_TRANSPARENT NCI_NFCEE_INTERFACE_TRANSPARENT 255 #define NFC_NFCEE_INTERFACE_PROPRIETARY NCI_NFCEE_INTERFACE_PROPRIETARY 256 257 #define NFC_NFCEE_TAG_HW_ID NCI_NFCEE_TAG_HW_ID 258 #define NFC_NFCEE_TAG_ATR_BYTES NCI_NFCEE_TAG_ATR_BYTES 259 #define NFC_NFCEE_TAG_T3T_INFO NCI_NFCEE_TAG_T3T_INFO 260 #define NFC_NFCEE_TAG_HCI_HOST_ID NCI_NFCEE_TAG_HCI_HOST_ID 261 typedef uint8_t tNFC_NFCEE_TAG; 262 /* additional NFCEE Info */ 263 typedef struct { 264 tNFC_NFCEE_TAG tag; 265 uint8_t len; 266 uint8_t info[NFC_MAX_EE_INFO]; 267 } tNFC_NFCEE_TLV; 268 269 /* NFCEE unrecoverable error */ 270 #define NFC_NFCEE_STATUS_UNRECOVERABLE_ERROR NCI_NFCEE_STS_UNRECOVERABLE_ERROR 271 /* NFCEE connected and inactive */ 272 #define NFC_NFCEE_STATUS_INACTIVE NCI_NFCEE_STS_CONN_INACTIVE 273 /* NFCEE connected and active */ 274 #define NFC_NFCEE_STATUS_ACTIVE NCI_NFCEE_STS_CONN_ACTIVE 275 /* NFCEE removed */ 276 #define NFC_NFCEE_STATUS_REMOVED NCI_NFCEE_STS_REMOVED 277 278 /* the data type associated with NFC_NFCEE_INFO_REVT */ 279 typedef struct { 280 tNFC_STATUS status; /* The event status - place holder */ 281 uint8_t nfcee_id; /* NFCEE ID */ 282 uint8_t ee_status; /* The NFCEE status. */ 283 uint8_t num_interface; /* number of NFCEE interfaces */ 284 uint8_t ee_interface[NFC_MAX_EE_INTERFACE]; /* NFCEE interface */ 285 uint8_t num_tlvs; /* number of TLVs */ 286 tNFC_NFCEE_TLV ee_tlv[NFC_MAX_EE_TLVS]; /* The TLVs associated with NFCEE */ 287 bool nfcee_power_ctrl; /* 1, if NFCC has control of NFCEE Power Supply */ 288 } tNFC_NFCEE_INFO_REVT; 289 290 #define NFC_MODE_ACTIVATE NCI_NFCEE_MD_ACTIVATE 291 #define NFC_MODE_DEACTIVATE NCI_NFCEE_MD_DEACTIVATE 292 typedef uint8_t tNFC_NFCEE_MODE; 293 /* the data type associated with NFC_NFCEE_MODE_SET_REVT */ 294 typedef struct { 295 tNFC_STATUS status; /* The event status.*/ 296 uint8_t nfcee_id; /* NFCEE ID */ 297 tNFC_NFCEE_MODE mode; /* NFCEE mode */ 298 } tNFC_NFCEE_MODE_SET_REVT; 299 300 #if (APPL_DTA_MODE == TRUE) 301 /* This data type is for FW Version */ 302 typedef struct { 303 uint8_t rom_code_version; /* ROM code Version */ 304 uint8_t major_version; /* Major Version */ 305 uint8_t minor_version; /* Minor Version */ 306 } tNFC_FW_VERSION; 307 #endif 308 #define NFC_MAX_AID_LEN NCI_MAX_AID_LEN /* 16 */ 309 310 /* the data type associated with NFC_CE_GET_ROUTING_REVT */ 311 typedef struct { 312 tNFC_STATUS status; /* The event status */ 313 uint8_t nfcee_id; /* NFCEE ID */ 314 uint8_t num_tlvs; /* number of TLVs */ 315 uint8_t tlv_size; /* the total len of all TLVs */ 316 uint8_t param_tlvs[NFC_MAX_EE_TLV_SIZE]; /* the TLVs */ 317 } tNFC_GET_ROUTING_REVT; 318 319 /* the data type associated with NFC_CONN_CREATE_CEVT */ 320 typedef struct { 321 tNFC_STATUS status; /* The event status */ 322 uint8_t dest_type; /* the destination type */ 323 uint8_t id; /* NFCEE ID or RF Discovery ID */ 324 uint8_t buff_size; /* The max buffer size */ 325 uint8_t num_buffs; /* The number of buffers */ 326 } tNFC_CONN_CREATE_CEVT; 327 328 /* the data type associated with NFC_CONN_CLOSE_CEVT */ 329 typedef struct { 330 tNFC_STATUS status; /* The event status */ 331 } tNFC_CONN_CLOSE_CEVT; 332 333 /* the data type associated with NFC_DATA_CEVT */ 334 typedef struct { 335 tNFC_STATUS status; /* The event status */ 336 NFC_HDR* p_data; /* The received Data */ 337 } tNFC_DATA_CEVT; 338 339 /* the data type associated with NFC_NFCEE_PL_CONTROL_REVT */ 340 typedef struct { 341 tNFC_STATUS status; /* The event status */ 342 uint8_t nfcee_id; /* NFCEE ID */ 343 tNCI_NFCEE_PL_CONFIG pl_control; /* Power/Link Control command */ 344 } tNFC_NFCEE_PL_CONTROL_REVT; 345 346 /* the data type associated with NFC_NFCEE_STATUS_REVT */ 347 typedef struct { 348 tNFC_STATUS status; /* The event status */ 349 uint8_t nfcee_id; /* NFCEE ID */ 350 tNCI_EE_NTF_STATUS nfcee_status; /* NFCEE status */ 351 } tNFC_NFCEE_STATUS_REVT; 352 /* RF Field Status */ 353 typedef uint8_t tNFC_RF_STS; 354 355 /* RF Field Technologies */ 356 #define NFC_RF_TECHNOLOGY_A NCI_RF_TECHNOLOGY_A 357 #define NFC_RF_TECHNOLOGY_B NCI_RF_TECHNOLOGY_B 358 #define NFC_RF_TECHNOLOGY_F NCI_RF_TECHNOLOGY_F 359 typedef uint8_t tNFC_RF_TECH; 360 361 extern uint8_t NFC_GetNCIVersion(); 362 363 /* Supported Protocols */ 364 #define NFC_PROTOCOL_UNKNOWN NCI_PROTOCOL_UNKNOWN /* Unknown */ 365 /* Type1Tag - NFC-A */ 366 #define NFC_PROTOCOL_T1T NCI_PROTOCOL_T1T 367 /* Type2Tag - NFC-A */ 368 #define NFC_PROTOCOL_T2T NCI_PROTOCOL_T2T 369 /* Type3Tag - NFC-F */ 370 #define NFC_PROTOCOL_T3T NCI_PROTOCOL_T3T 371 /* Type5Tag - NFC-V/ISO15693*/ 372 #define NFC_PROTOCOL_T5T NFC_PROTOCOL_T5T_(NFC_GetNCIVersion()) 373 #define NFC_PROTOCOL_T5T_(x) \ 374 (((x) == NCI_VERSION_2_0) ? NCI_PROTOCOL_T5T : NCI_PROTOCOL_15693) 375 /* Type 4A,4B - NFC-A or NFC-B */ 376 #define NFC_PROTOCOL_ISO_DEP NCI_PROTOCOL_ISO_DEP 377 /* NFCDEP/LLCP - NFC-A or NFC-F */ 378 #define NFC_PROTOCOL_NFC_DEP NCI_PROTOCOL_NFC_DEP 379 #define NFC_PROTOCOL_MIFARE NCI_PROTOCOL_MIFARE 380 #define NFC_PROTOCOL_ISO15693 NCI_PROTOCOL_15693 381 #define NFC_PROTOCOL_B_PRIME NCI_PROTOCOL_B_PRIME 382 #define NFC_PROTOCOL_KOVIO NCI_PROTOCOL_KOVIO 383 typedef uint8_t tNFC_PROTOCOL; 384 385 /* Discovery Types/Detected Technology and Mode */ 386 #define NFC_DISCOVERY_TYPE_POLL_A NCI_DISCOVERY_TYPE_POLL_A 387 #define NFC_DISCOVERY_TYPE_POLL_B NCI_DISCOVERY_TYPE_POLL_B 388 #define NFC_DISCOVERY_TYPE_POLL_F NCI_DISCOVERY_TYPE_POLL_F 389 #define NFC_DISCOVERY_TYPE_POLL_A_ACTIVE NCI_DISCOVERY_TYPE_POLL_A_ACTIVE 390 #define NFC_DISCOVERY_TYPE_POLL_F_ACTIVE NCI_DISCOVERY_TYPE_POLL_F_ACTIVE 391 #define NFC_DISCOVERY_TYPE_POLL_ACTIVE NCI_DISCOVERY_TYPE_POLL_ACTIVE 392 #define NFC_DISCOVERY_TYPE_POLL_V NCI_DISCOVERY_TYPE_POLL_V 393 #define NFC_DISCOVERY_TYPE_POLL_B_PRIME NCI_DISCOVERY_TYPE_POLL_B_PRIME 394 #define NFC_DISCOVERY_TYPE_POLL_KOVIO NCI_DISCOVERY_TYPE_POLL_KOVIO 395 #define NFC_DISCOVERY_TYPE_LISTEN_A NCI_DISCOVERY_TYPE_LISTEN_A 396 #define NFC_DISCOVERY_TYPE_LISTEN_B NCI_DISCOVERY_TYPE_LISTEN_B 397 #define NFC_DISCOVERY_TYPE_LISTEN_F NCI_DISCOVERY_TYPE_LISTEN_F 398 #define NFC_DISCOVERY_TYPE_LISTEN_A_ACTIVE NCI_DISCOVERY_TYPE_LISTEN_A_ACTIVE 399 #define NFC_DISCOVERY_TYPE_LISTEN_F_ACTIVE NCI_DISCOVERY_TYPE_LISTEN_F_ACTIVE 400 #define NFC_DISCOVERY_TYPE_LISTEN_ACTIVE NCI_DISCOVERY_TYPE_LISTEN_ACTIVE 401 #define NFC_DISCOVERY_TYPE_LISTEN_ISO15693 NCI_DISCOVERY_TYPE_LISTEN_ISO15693 402 #define NFC_DISCOVERY_TYPE_LISTEN_B_PRIME NCI_DISCOVERY_TYPE_LISTEN_B_PRIME 403 typedef uint8_t tNFC_DISCOVERY_TYPE; 404 typedef uint8_t tNFC_RF_TECH_N_MODE; 405 406 /* Select Response codes */ 407 #define NFC_SEL_RES_NFC_FORUM_T2T 0x00 408 #define NFC_SEL_RES_MF_CLASSIC 0x08 409 410 /* Bit Rates */ 411 #define NFC_BIT_RATE_212 NCI_BIT_RATE_212 /* 212 kbit/s */ 412 #define NFC_BIT_RATE_424 NCI_BIT_RATE_424 /* 424 kbit/s */ 413 typedef uint8_t tNFC_BIT_RATE; 414 415 /********************************************** 416 * Interface Types 417 **********************************************/ 418 #define NFC_INTERFACE_EE_DIRECT_RF NCI_INTERFACE_EE_DIRECT_RF 419 #define NFC_INTERFACE_FRAME NCI_INTERFACE_FRAME 420 #define NFC_INTERFACE_ISO_DEP NCI_INTERFACE_ISO_DEP 421 #define NFC_INTERFACE_NFC_DEP NCI_INTERFACE_NFC_DEP 422 #define NFC_INTERFACE_MIFARE NCI_INTERFACE_VS_MIFARE 423 typedef tNCI_INTF_TYPE tNFC_INTF_TYPE; 424 425 /********************************************** 426 * Deactivation Type 427 **********************************************/ 428 #define NFC_DEACTIVATE_TYPE_IDLE NCI_DEACTIVATE_TYPE_IDLE 429 #define NFC_DEACTIVATE_TYPE_SLEEP NCI_DEACTIVATE_TYPE_SLEEP 430 #define NFC_DEACTIVATE_TYPE_SLEEP_AF NCI_DEACTIVATE_TYPE_SLEEP_AF 431 #define NFC_DEACTIVATE_TYPE_DISCOVERY NCI_DEACTIVATE_TYPE_DISCOVERY 432 typedef uint8_t tNFC_DEACT_TYPE; 433 434 /********************************************** 435 * Deactivation Reasons 436 **********************************************/ 437 #define NFC_DEACTIVATE_REASON_DH_REQ_FAILED NCI_DEACTIVATE_REASON_DH_REQ_FAILED 438 typedef uint8_t tNFC_DEACT_REASON; 439 440 /* the data type associated with NFC_RF_FIELD_REVT */ 441 typedef struct { 442 tNFC_STATUS status; /* The event status - place holder. */ 443 tNFC_RF_STS rf_field; /* RF Field Status */ 444 } tNFC_RF_FIELD_REVT; 445 446 #define NFC_MAX_APP_DATA_LEN 40 447 typedef struct { 448 uint8_t len_aid; /* length of application id */ 449 uint8_t aid[NFC_MAX_AID_LEN]; /* application id */ 450 } tNFC_AID; 451 typedef struct { 452 uint8_t len_aid; /* length of application id */ 453 uint8_t aid[NFC_MAX_AID_LEN]; /* application id */ 454 uint8_t len_data; /* len of application data */ 455 uint8_t data[NFC_MAX_APP_DATA_LEN]; /* application data */ 456 } tNFC_APP_INIT; 457 458 /* ISO 7816-4 SELECT command */ 459 #define NFC_EE_TRIG_SELECT NCI_EE_TRIG_7816_SELECT 460 /* RF Protocol changed */ 461 #define NFC_EE_TRIG_RF_PROTOCOL NCI_EE_TRIG_RF_PROTOCOL 462 /* RF Technology changed */ 463 #define NFC_EE_TRIG_RF_TECHNOLOGY NCI_EE_TRIG_RF_TECHNOLOGY 464 /* Application initiation */ 465 #define NFC_EE_TRIG_APP_INIT NCI_EE_TRIG_APP_INIT 466 typedef uint8_t tNFC_EE_TRIGGER; 467 typedef struct { 468 tNFC_EE_TRIGGER trigger; /* the trigger of this event */ 469 union { 470 tNFC_PROTOCOL protocol; 471 tNFC_RF_TECH technology; 472 tNFC_AID aid; 473 tNFC_APP_INIT app_init; 474 } param; /* Discovery Type specific parameters */ 475 } tNFC_ACTION_DATA; 476 477 /* the data type associated with NFC_EE_ACTION_REVT */ 478 typedef struct { 479 tNFC_STATUS status; /* The event status - place holder */ 480 uint8_t nfcee_id; /* NFCEE ID */ 481 tNFC_ACTION_DATA act_data; /* data associated /w the action */ 482 } tNFC_EE_ACTION_REVT; 483 484 #define NFC_EE_DISC_OP_ADD 0 485 typedef uint8_t tNFC_EE_DISC_OP; 486 typedef struct { 487 tNFC_EE_DISC_OP op; /* add or remove this entry */ 488 uint8_t nfcee_id; /* NFCEE ID */ 489 tNFC_RF_TECH_N_MODE tech_n_mode; /* Discovery Technology and Mode */ 490 tNFC_PROTOCOL protocol; /* NFC protocol */ 491 } tNFC_EE_DISCOVER_INFO; 492 493 #ifndef NFC_MAX_EE_DISC_ENTRIES 494 #define NFC_MAX_EE_DISC_ENTRIES 6 495 #endif 496 /* T, L, V(NFCEE ID, TechnMode, Protocol) */ 497 #define NFC_EE_DISCOVER_ENTRY_LEN 5 498 #define NFC_EE_DISCOVER_INFO_LEN 3 /* NFCEE ID, TechnMode, Protocol */ 499 /* the data type associated with NFC_EE_DISCOVER_REQ_REVT */ 500 typedef struct { 501 tNFC_STATUS status; /* The event status - place holder */ 502 uint8_t num_info; /* number of entries in info[] */ 503 tNFC_EE_DISCOVER_INFO 504 info[NFC_MAX_EE_DISC_ENTRIES]; /* discovery request from NFCEE */ 505 } tNFC_EE_DISCOVER_REQ_REVT; 506 507 typedef union { 508 tNFC_STATUS status; /* The event status. */ 509 tNFC_ENABLE_REVT enable; 510 tNFC_SET_CONFIG_REVT set_config; 511 tNFC_GET_CONFIG_REVT get_config; 512 tNFC_NFCEE_DISCOVER_REVT nfcee_discover; 513 tNFC_NFCEE_INFO_REVT nfcee_info; 514 tNFC_NFCEE_MODE_SET_REVT mode_set; 515 tNFC_NFCEE_PL_CONTROL_REVT pl_control; 516 tNFC_NFCEE_STATUS_REVT nfcee_status; 517 tNFC_RF_FIELD_REVT rf_field; 518 tNFC_STATUS cfg_routing; 519 tNFC_GET_ROUTING_REVT get_routing; 520 tNFC_EE_ACTION_REVT ee_action; 521 tNFC_EE_DISCOVER_REQ_REVT ee_discover_req; 522 void* p_vs_evt_data; 523 } tNFC_RESPONSE; 524 525 /************************************* 526 ** RESPONSE Callback Functions 527 **************************************/ 528 typedef void(tNFC_RESPONSE_CBACK)(tNFC_RESPONSE_EVT event, 529 tNFC_RESPONSE* p_data); 530 531 /* The events reported on tNFC_VS_CBACK */ 532 /* The event is (NCI_RSP_BIT|oid) for response and (NCI_NTF_BIT|oid) for 533 * notification*/ 534 535 typedef uint8_t tNFC_VS_EVT; 536 537 /************************************* 538 ** Proprietary (Vendor Specific) Callback Functions 539 **************************************/ 540 typedef void(tNFC_VS_CBACK)(tNFC_VS_EVT event, uint16_t data_len, 541 uint8_t* p_data); 542 543 /* the events reported on tNFC_DISCOVER_CBACK */ 544 enum { 545 NFC_START_DEVT = NFC_FIRST_DEVT, /* Status of NFC_DiscoveryStart */ 546 NFC_MAP_DEVT, /* Status of NFC_DiscoveryMap */ 547 NFC_RESULT_DEVT, /* The responses from remote device */ 548 NFC_SELECT_DEVT, /* Status of NFC_DiscoverySelect */ 549 NFC_ACTIVATE_DEVT, /* RF interface is activated */ 550 NFC_DEACTIVATE_DEVT /* Status of RF deactivation */ 551 }; 552 typedef uint16_t tNFC_DISCOVER_EVT; 553 554 /* the data type associated with NFC_START_DEVT */ 555 typedef tNFC_STATUS tNFC_START_DEVT; 556 557 typedef tNCI_RF_PA_PARAMS tNFC_RF_PA_PARAMS; 558 #define NFC_MAX_SENSB_RES_LEN NCI_MAX_SENSB_RES_LEN 559 #define NFC_NFCID0_MAX_LEN 4 560 typedef struct { 561 uint8_t sensb_res_len; /* Length of SENSB_RES Response (Byte 2 - Byte 12 or 562 13) Available after Technology Detection */ 563 uint8_t sensb_res[NFC_MAX_SENSB_RES_LEN]; /* SENSB_RES Response (ATQ) */ 564 uint8_t nfcid0[NFC_NFCID0_MAX_LEN]; 565 } tNFC_RF_PB_PARAMS; 566 567 #define NFC_MAX_SENSF_RES_LEN NCI_MAX_SENSF_RES_LEN 568 #define NFC_NFCID2_LEN NCI_NFCID2_LEN 569 typedef struct { 570 uint8_t bit_rate; /* NFC_BIT_RATE_212 or NFC_BIT_RATE_424 */ 571 uint8_t sensf_res_len; /* Length of SENSF_RES Response (Byte 2 - Byte 17 or 572 19) Available after Technology Detection */ 573 uint8_t sensf_res[NFC_MAX_SENSF_RES_LEN]; /* SENSB_RES Response */ 574 uint8_t nfcid2[NFC_NFCID2_LEN]; /* NFCID2 generated by the Local NFCC for 575 NFC-DEP Protocol.Available for Frame 576 Interface */ 577 uint8_t mrti_check; 578 uint8_t mrti_update; 579 } tNFC_RF_PF_PARAMS; 580 581 typedef tNCI_RF_LF_PARAMS tNFC_RF_LF_PARAMS; 582 583 #define NFC_ISO15693_UID_LEN 8 584 typedef struct { 585 uint8_t flag; 586 uint8_t dsfid; 587 uint8_t uid[NFC_ISO15693_UID_LEN]; 588 } tNFC_RF_PISO15693_PARAMS; 589 590 #ifndef NFC_KOVIO_MAX_LEN 591 #define NFC_KOVIO_MAX_LEN 32 592 #endif 593 typedef struct { 594 uint8_t uid_len; 595 uint8_t uid[NFC_KOVIO_MAX_LEN]; 596 } tNFC_RF_PKOVIO_PARAMS; 597 598 typedef tNCI_RF_ACM_P_PARAMS tNFC_RF_ACM_P_PARAMS; 599 600 typedef union { 601 tNFC_RF_PA_PARAMS pa; 602 tNFC_RF_PB_PARAMS pb; 603 tNFC_RF_PF_PARAMS pf; 604 tNFC_RF_LF_PARAMS lf; 605 tNFC_RF_PISO15693_PARAMS pi93; 606 tNFC_RF_PKOVIO_PARAMS pk; 607 tNFC_RF_ACM_P_PARAMS acm_p; 608 } tNFC_RF_TECH_PARAMU; 609 610 typedef struct { 611 tNFC_DISCOVERY_TYPE mode; 612 tNFC_RF_TECH_PARAMU param; 613 } tNFC_RF_TECH_PARAMS; 614 615 /* the data type associated with NFC_RESULT_DEVT */ 616 typedef struct { 617 tNFC_STATUS status; /* The event status - place holder. */ 618 uint8_t rf_disc_id; /* RF Discovery ID */ 619 uint8_t protocol; /* supported protocol */ 620 tNFC_RF_TECH_PARAMS rf_tech_param; /* RF technology parameters */ 621 uint8_t more; /* 0: last, 1: last (limit), 2: more */ 622 } tNFC_RESULT_DEVT; 623 624 /* the data type associated with NFC_SELECT_DEVT */ 625 typedef tNFC_STATUS tNFC_SELECT_DEVT; 626 627 /* the data type associated with NFC_STOP_DEVT */ 628 typedef tNFC_STATUS tNFC_STOP_DEVT; 629 630 #define NFC_MAX_ATS_LEN NCI_MAX_ATS_LEN 631 #define NFC_MAX_HIS_BYTES_LEN NCI_MAX_HIS_BYTES_LEN 632 #define NFC_MAX_GEN_BYTES_LEN NCI_MAX_GEN_BYTES_LEN 633 634 typedef struct { 635 uint8_t ats_res_len; /* Length of ATS RES */ 636 uint8_t ats_res[NFC_MAX_ATS_LEN]; /* ATS RES */ 637 bool nad_used; /* NAD is used or not */ 638 uint8_t fwi; /* Frame Waiting time Integer */ 639 uint8_t sfgi; /* Start-up Frame Guard time Integer*/ 640 uint8_t his_byte_len; /* len of historical bytes */ 641 uint8_t his_byte[NFC_MAX_HIS_BYTES_LEN]; /* historical bytes */ 642 } tNFC_INTF_PA_ISO_DEP; 643 644 typedef struct { uint8_t rats; /* RATS */ } tNFC_INTF_LA_ISO_DEP; 645 646 typedef struct { 647 uint8_t atr_res_len; /* Length of ATR_RES */ 648 uint8_t atr_res[NFC_MAX_ATS_LEN]; /* ATR_RES (Byte 3 - Byte 17+n) */ 649 uint8_t max_payload_size; /* 64, 128, 192 or 254 */ 650 uint8_t gen_bytes_len; /* len of general bytes */ 651 uint8_t gen_bytes[NFC_MAX_GEN_BYTES_LEN]; /* general bytes */ 652 uint8_t 653 waiting_time; /* WT -> Response Waiting Time RWT = (256 x 16/fC) x 2WT */ 654 } tNFC_INTF_PA_NFC_DEP; 655 656 /* Note: keep tNFC_INTF_PA_NFC_DEP data member in the same order as 657 * tNFC_INTF_LA_NFC_DEP */ 658 typedef struct { 659 uint8_t atr_req_len; /* Length of ATR_REQ */ 660 uint8_t atr_req[NFC_MAX_ATS_LEN]; /* ATR_REQ (Byte 3 - Byte 18+n) */ 661 uint8_t max_payload_size; /* 64, 128, 192 or 254 */ 662 uint8_t gen_bytes_len; /* len of general bytes */ 663 uint8_t gen_bytes[NFC_MAX_GEN_BYTES_LEN]; /* general bytes */ 664 } tNFC_INTF_LA_NFC_DEP; 665 typedef tNFC_INTF_LA_NFC_DEP tNFC_INTF_LF_NFC_DEP; 666 typedef tNFC_INTF_PA_NFC_DEP tNFC_INTF_PF_NFC_DEP; 667 668 #define NFC_MAX_ATTRIB_LEN NCI_MAX_ATTRIB_LEN 669 670 typedef struct { 671 uint8_t attrib_res_len; /* Length of ATTRIB RES */ 672 uint8_t attrib_res[NFC_MAX_ATTRIB_LEN]; /* ATTRIB RES */ 673 uint8_t hi_info_len; /* len of Higher layer Info */ 674 uint8_t hi_info[NFC_MAX_GEN_BYTES_LEN]; /* Higher layer Info */ 675 uint8_t mbli; /* Maximum buffer length. */ 676 } tNFC_INTF_PB_ISO_DEP; 677 678 typedef struct { 679 uint8_t attrib_req_len; /* Length of ATTRIB REQ */ 680 uint8_t attrib_req[NFC_MAX_ATTRIB_LEN]; /* ATTRIB REQ (Byte 2 - 10+k)*/ 681 uint8_t hi_info_len; /* len of Higher layer Info */ 682 uint8_t hi_info[NFC_MAX_GEN_BYTES_LEN]; /* Higher layer Info */ 683 uint8_t nfcid0[NFC_NFCID0_MAX_LEN]; /* NFCID0 */ 684 } tNFC_INTF_LB_ISO_DEP; 685 686 #ifndef NFC_MAX_RAW_PARAMS 687 #define NFC_MAX_RAW_PARAMS 16 688 #endif 689 #define NFC_MAX_RAW_PARAMS 16 690 typedef struct { 691 uint8_t param_len; 692 uint8_t param[NFC_MAX_RAW_PARAMS]; 693 } tNFC_INTF_FRAME; 694 695 typedef struct { 696 tNFC_INTF_TYPE type; /* Interface Type 1 Byte See Table 67 */ 697 union { 698 tNFC_INTF_LA_ISO_DEP la_iso; 699 tNFC_INTF_PA_ISO_DEP pa_iso; 700 tNFC_INTF_LB_ISO_DEP lb_iso; 701 tNFC_INTF_PB_ISO_DEP pb_iso; 702 tNFC_INTF_LA_NFC_DEP la_nfc; 703 tNFC_INTF_PA_NFC_DEP pa_nfc; 704 tNFC_INTF_LF_NFC_DEP lf_nfc; 705 tNFC_INTF_PF_NFC_DEP pf_nfc; 706 tNFC_INTF_FRAME frame; 707 } intf_param; /* Activation Parameters 0 - n Bytes */ 708 } tNFC_INTF_PARAMS; 709 710 /* the data type associated with NFC_ACTIVATE_DEVT */ 711 typedef struct { 712 uint8_t rf_disc_id; /* RF Discovery ID */ 713 tNFC_PROTOCOL protocol; /* supported protocol */ 714 tNFC_RF_TECH_PARAMS rf_tech_param; /* RF technology parameters */ 715 tNFC_DISCOVERY_TYPE data_mode; /* for future Data Exchange */ 716 tNFC_BIT_RATE tx_bitrate; /* Data Exchange Tx Bitrate */ 717 tNFC_BIT_RATE rx_bitrate; /* Data Exchange Rx Bitrate */ 718 tNFC_INTF_PARAMS intf_param; /* interface type and params*/ 719 } tNFC_ACTIVATE_DEVT; 720 721 /* the data type associated with NFC_DEACTIVATE_DEVT and NFC_DEACTIVATE_CEVT */ 722 typedef struct { 723 tNFC_STATUS status; /* The event status. */ 724 tNFC_DEACT_TYPE type; /* De-activate type */ 725 bool is_ntf; /* TRUE, if deactivate notif*/ 726 tNFC_DEACT_REASON reason; /* De-activate reason */ 727 } tNFC_DEACTIVATE_DEVT; 728 729 typedef union { 730 tNFC_STATUS status; /* The event status. */ 731 tNFC_START_DEVT start; 732 tNFC_RESULT_DEVT result; 733 tNFC_SELECT_DEVT select; 734 tNFC_STOP_DEVT stop; 735 tNFC_ACTIVATE_DEVT activate; 736 tNFC_DEACTIVATE_DEVT deactivate; 737 } tNFC_DISCOVER; 738 739 typedef struct { 740 bool include_rf_tech_mode; /* TRUE if including RF Tech and Mode update */ 741 tNFC_RF_TECH_N_MODE rf_tech_n_mode; /* RF tech and mode */ 742 bool include_tx_bit_rate; /* TRUE if including Tx bit rate update */ 743 tNFC_BIT_RATE tx_bit_rate; /* Transmit Bit Rate */ 744 bool include_rx_bit_rate; /* TRUE if including Rx bit rate update */ 745 tNFC_BIT_RATE rx_bit_rate; /* Receive Bit Rate */ 746 bool include_nfc_b_config; /* TRUE if including NFC-B data exchange config */ 747 uint8_t min_tr0; /* Minimun TR0 */ 748 uint8_t min_tr1; /* Minimun TR1 */ 749 uint8_t suppression_eos; /* Suppression of EoS */ 750 uint8_t suppression_sos; /* Suppression of SoS */ 751 uint8_t min_tr2; /* Minimun TR1 */ 752 } tNFC_RF_COMM_PARAMS; 753 754 /************************************* 755 ** DISCOVER Callback Functions 756 **************************************/ 757 typedef void(tNFC_DISCOVER_CBACK)(tNFC_DISCOVER_EVT event, 758 tNFC_DISCOVER* p_data); 759 760 typedef uint16_t tNFC_TEST_EVT; 761 762 /* the data type associated with NFC_LOOPBACK_TEVT */ 763 typedef struct { 764 tNFC_STATUS status; /* The event status. */ 765 NFC_HDR* p_data; /* The loop back data from NFCC */ 766 } tNFC_LOOPBACK_TEVT; 767 768 /* the data type associated with NFC_RF_CONTROL_TEVT */ 769 typedef tNFC_STATUS tNFC_RF_CONTROL_TEVT; 770 771 typedef union { 772 tNFC_STATUS status; /* The event status. */ 773 tNFC_LOOPBACK_TEVT loop_back; 774 tNFC_RF_CONTROL_TEVT rf_control; 775 } tNFC_TEST; 776 777 /************************************* 778 ** TEST Callback Functions 779 **************************************/ 780 typedef void(tNFC_TEST_CBACK)(tNFC_TEST_EVT event, tNFC_TEST* p_data); 781 782 typedef tNFC_DEACTIVATE_DEVT tNFC_DEACTIVATE_CEVT; 783 typedef union { 784 tNFC_STATUS status; /* The event status. */ 785 tNFC_CONN_CREATE_CEVT conn_create; 786 tNFC_CONN_CLOSE_CEVT conn_close; 787 tNFC_DEACTIVATE_CEVT deactivate; 788 tNFC_DATA_CEVT data; 789 } tNFC_CONN; 790 791 /************************************* 792 ** Data Callback Functions 793 **************************************/ 794 typedef void(tNFC_CONN_CBACK)(uint8_t conn_id, tNFC_CONN_EVT event, 795 tNFC_CONN* p_data); 796 #define NFC_MAX_CONN_ID 15 797 #define NFC_ILLEGAL_CONN_ID 0xFF 798 /* the static connection ID for RF traffic */ 799 #define NFC_RF_CONN_ID 0 800 /* the static connection ID for HCI transport */ 801 #define NFC_HCI_CONN_ID 1 802 803 /***************************************************************************** 804 ** EXTERNAL FUNCTION DECLARATIONS 805 *****************************************************************************/ 806 807 /******************************************************************************* 808 ** 809 ** Function NFC_Enable 810 ** 811 ** Description This function enables NFC. Prior to calling NFC_Enable: 812 ** - the NFCC must be powered up, and ready to receive 813 ** commands. 814 ** - GKI must be enabled 815 ** - NFC_TASK must be started 816 ** - NCIT_TASK must be started (if using dedicated NCI 817 ** transport) 818 ** 819 ** This function opens the NCI transport (if applicable), 820 ** resets the NFC controller, and initializes the NFC 821 ** subsystems. 822 ** 823 ** When the NFC startup procedure is completed, an 824 ** NFC_ENABLE_REVT is returned to the application using the 825 ** tNFC_RESPONSE_CBACK. 826 ** 827 ** Returns tNFC_STATUS 828 ** 829 *******************************************************************************/ 830 extern tNFC_STATUS NFC_Enable(tNFC_RESPONSE_CBACK* p_cback); 831 832 /******************************************************************************* 833 ** 834 ** Function NFC_Disable 835 ** 836 ** Description This function performs clean up routines for shutting down 837 ** NFC and closes the NCI transport (if using dedicated NCI 838 ** transport). 839 ** 840 ** When the NFC shutdown procedure is completed, an 841 ** NFC_DISABLED_REVT is returned to the application using the 842 ** tNFC_RESPONSE_CBACK. 843 ** 844 ** Returns nothing 845 ** 846 *******************************************************************************/ 847 extern void NFC_Disable(void); 848 849 /******************************************************************************* 850 ** 851 ** Function NFC_Init 852 ** 853 ** Description This function initializes control blocks for NFC 854 ** 855 ** Returns nothing 856 ** 857 *******************************************************************************/ 858 extern void NFC_Init(tHAL_NFC_ENTRY* p_hal_entry_tbl); 859 860 /******************************************************************************* 861 ** 862 ** Function NFC_GetLmrtSize 863 ** 864 ** Description Called by application wto query the Listen Mode Routing 865 ** Table size supported by NFCC 866 ** 867 ** Returns Listen Mode Routing Table size 868 ** 869 *******************************************************************************/ 870 extern uint16_t NFC_GetLmrtSize(void); 871 872 /******************************************************************************* 873 ** 874 ** Function NFC_SetConfig 875 ** 876 ** Description This function is called to send the configuration parameter 877 ** TLV to NFCC. The response from NFCC is reported by 878 ** tNFC_RESPONSE_CBACK as NFC_SET_CONFIG_REVT. 879 ** 880 ** Parameters tlv_size - the length of p_param_tlvs. 881 ** p_param_tlvs - the parameter ID/Len/Value list 882 ** 883 ** Returns tNFC_STATUS 884 ** 885 *******************************************************************************/ 886 extern tNFC_STATUS NFC_SetConfig(uint8_t tlv_size, uint8_t* p_param_tlvs); 887 888 /******************************************************************************* 889 ** 890 ** Function NFC_GetConfig 891 ** 892 ** Description This function is called to retrieve the parameter TLV from 893 ** NFCC. The response from NFCC is reported by 894 ** tNFC_RESPONSE_CBACK as NFC_GET_CONFIG_REVT. 895 ** 896 ** Parameters num_ids - the number of parameter IDs 897 ** p_param_ids - the parameter ID list. 898 ** 899 ** Returns tNFC_STATUS 900 ** 901 *******************************************************************************/ 902 extern tNFC_STATUS NFC_GetConfig(uint8_t num_ids, uint8_t* p_param_ids); 903 904 /******************************************************************************* 905 ** 906 ** Function NFC_NfceeDiscover 907 ** 908 ** Description This function is called to enable or disable NFCEE 909 ** Discovery. The response from NFCC is reported by 910 ** tNFC_RESPONSE_CBACK as NFC_NFCEE_DISCOVER_REVT. 911 ** The notification from NFCC is reported by 912 ** tNFC_RESPONSE_CBACK as NFC_NFCEE_INFO_REVT. 913 ** 914 ** Parameters discover - 1 to enable discover, 0 to disable. 915 ** 916 ** Returns tNFC_STATUS 917 ** 918 *******************************************************************************/ 919 extern tNFC_STATUS NFC_NfceeDiscover(bool discover); 920 921 /******************************************************************************* 922 ** 923 ** Function NFC_NfceeModeSet 924 ** 925 ** Description This function is called to activate or de-activate an NFCEE 926 ** connected to the NFCC. 927 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 928 ** as NFC_NFCEE_MODE_SET_REVT. 929 ** 930 ** Parameters nfcee_id - the NFCEE to activate or de-activate. 931 ** mode - 0 to activate NFCEE, 1 to de-activate. 932 ** 933 ** Returns tNFC_STATUS 934 ** 935 *******************************************************************************/ 936 extern tNFC_STATUS NFC_NfceeModeSet(uint8_t nfcee_id, tNFC_NFCEE_MODE mode); 937 /******************************************************************************* 938 ** 939 ** Function NFC_DiscoveryMap 940 ** 941 ** Description This function is called to set the discovery interface 942 ** mapping. The response from NFCC is reported by 943 ** tNFC_DISCOVER_CBACK as. NFC_MAP_DEVT. 944 ** 945 ** Parameters num - the number of items in p_params. 946 ** p_maps - the discovery interface mappings 947 ** p_cback - the discovery callback function 948 ** 949 ** Returns tNFC_STATUS 950 ** 951 *******************************************************************************/ 952 extern tNFC_STATUS NFC_DiscoveryMap(uint8_t num, tNFC_DISCOVER_MAPS* p_maps, 953 tNFC_DISCOVER_CBACK* p_cback); 954 955 /******************************************************************************* 956 ** 957 ** Function NFC_DiscoveryStart 958 ** 959 ** Description This function is called to start Polling and/or Listening. 960 ** The response from NFCC is reported by tNFC_DISCOVER_CBACK 961 ** as NFC_START_DEVT. The notification from NFCC is reported by 962 ** tNFC_DISCOVER_CBACK as NFC_RESULT_DEVT. 963 ** 964 ** Parameters num_params - the number of items in p_params. 965 ** p_params - the discovery parameters 966 ** p_cback - the discovery callback function 967 ** 968 ** Returns tNFC_STATUS 969 ** 970 *******************************************************************************/ 971 extern tNFC_STATUS NFC_DiscoveryStart(uint8_t num_params, 972 tNFC_DISCOVER_PARAMS* p_params, 973 tNFC_DISCOVER_CBACK* p_cback); 974 975 /******************************************************************************* 976 ** 977 ** Function NFC_DiscoverySelect 978 ** 979 ** Description If tNFC_DISCOVER_CBACK reports status=NFC_MULTIPLE_PROT, 980 ** the application needs to use this function to select the 981 ** the logical endpoint to continue. The response from NFCC is 982 ** reported by tNFC_DISCOVER_CBACK as NFC_SELECT_DEVT. 983 ** 984 ** Parameters rf_disc_id - The ID identifies the remote device. 985 ** protocol - the logical endpoint on the remote devide 986 ** rf_interface - the RF interface to communicate with NFCC 987 ** 988 ** Returns tNFC_STATUS 989 ** 990 *******************************************************************************/ 991 extern tNFC_STATUS NFC_DiscoverySelect(uint8_t rf_disc_id, uint8_t protocol, 992 uint8_t rf_interface); 993 994 /******************************************************************************* 995 ** 996 ** Function NFC_ConnCreate 997 ** 998 ** Description This function is called to create a logical connection with 999 ** NFCC for data exchange. 1000 ** The response from NFCC is reported in tNFC_CONN_CBACK 1001 ** as NFC_CONN_CREATE_CEVT. 1002 ** 1003 ** Parameters dest_type - the destination type 1004 ** id - the NFCEE ID or RF Discovery ID . 1005 ** protocol - the protocol 1006 ** p_cback - the data callback function to receive data from 1007 ** NFCC 1008 ** 1009 ** Returns tNFC_STATUS 1010 ** 1011 *******************************************************************************/ 1012 extern tNFC_STATUS NFC_ConnCreate(uint8_t dest_type, uint8_t id, 1013 uint8_t protocol, tNFC_CONN_CBACK* p_cback); 1014 1015 /******************************************************************************* 1016 ** 1017 ** Function NFC_ConnClose 1018 ** 1019 ** Description This function is called to close a logical connection with 1020 ** NFCC. 1021 ** The response from NFCC is reported in tNFC_CONN_CBACK 1022 ** as NFC_CONN_CLOSE_CEVT. 1023 ** 1024 ** Parameters conn_id - the connection id. 1025 ** 1026 ** Returns tNFC_STATUS 1027 ** 1028 *******************************************************************************/ 1029 extern tNFC_STATUS NFC_ConnClose(uint8_t conn_id); 1030 1031 /******************************************************************************* 1032 ** 1033 ** Function NFC_SetStaticRfCback 1034 ** 1035 ** Description This function is called to update the data callback function 1036 ** to receive the data for the given connection id. 1037 ** 1038 ** Parameters p_cback - the connection callback function 1039 ** 1040 ** Returns Nothing 1041 ** 1042 *******************************************************************************/ 1043 extern void NFC_SetStaticRfCback(tNFC_CONN_CBACK* p_cback); 1044 1045 /******************************************************************************* 1046 ** 1047 ** Function NFC_SetReassemblyFlag 1048 ** 1049 ** Description This function is called to set if nfc will reassemble 1050 ** nci packet as much as its buffer can hold or it should not 1051 ** reassemble but forward the fragmented nci packet to layer 1052 ** above. If nci data pkt is fragmented, nfc may send multiple 1053 ** NFC_DATA_CEVT with status NFC_STATUS_CONTINUE before sending 1054 ** NFC_DATA_CEVT with status NFC_STATUS_OK based on reassembly 1055 ** configuration and reassembly buffer size 1056 ** 1057 ** Parameters reassembly - flag to indicate if nfc may reassemble or not 1058 ** 1059 ** Returns Nothing 1060 ** 1061 *******************************************************************************/ 1062 extern void NFC_SetReassemblyFlag(bool reassembly); 1063 1064 /******************************************************************************* 1065 ** 1066 ** Function NFC_SendData 1067 ** 1068 ** Description This function is called to send the given data packet 1069 ** to the connection identified by the given connection id. 1070 ** 1071 ** Parameters conn_id - the connection id. 1072 ** p_data - the data packet 1073 ** 1074 ** Returns tNFC_STATUS 1075 ** 1076 *******************************************************************************/ 1077 extern tNFC_STATUS NFC_SendData(uint8_t conn_id, NFC_HDR* p_data); 1078 1079 /******************************************************************************* 1080 ** 1081 ** Function NFC_FlushData 1082 ** 1083 ** Description This function is called to discard the tx data queue of 1084 ** the given connection id. 1085 ** 1086 ** Parameters conn_id - the connection id. 1087 ** 1088 ** Returns tNFC_STATUS 1089 ** 1090 *******************************************************************************/ 1091 extern tNFC_STATUS NFC_FlushData(uint8_t conn_id); 1092 1093 /******************************************************************************* 1094 ** 1095 ** Function NFC_Deactivate 1096 ** 1097 ** Description This function is called to stop the discovery process or 1098 ** put the listen device in sleep mode or terminate the NFC 1099 ** link. 1100 ** 1101 ** The response from NFCC is reported by tNFC_DISCOVER_CBACK 1102 ** as NFC_DEACTIVATE_DEVT. 1103 ** 1104 ** Parameters deactivate_type - NFC_DEACTIVATE_TYPE_IDLE, to IDLE mode. 1105 ** NFC_DEACTIVATE_TYPE_SLEEP to SLEEP mode. 1106 ** NFC_DEACTIVATE_TYPE_SLEEP_AF to SLEEP_AF 1107 ** mode. 1108 ** 1109 ** Returns tNFC_STATUS 1110 ** 1111 *******************************************************************************/ 1112 extern tNFC_STATUS NFC_Deactivate(tNFC_DEACT_TYPE deactivate_type); 1113 1114 /******************************************************************************* 1115 ** 1116 ** Function NFC_UpdateRFCommParams 1117 ** 1118 ** Description This function is called to update RF Communication 1119 ** parameters once the Frame RF Interface has been activated. 1120 ** 1121 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 1122 ** as NFC_RF_COMM_PARAMS_UPDATE_REVT. 1123 ** 1124 ** Returns tNFC_STATUS 1125 ** 1126 *******************************************************************************/ 1127 extern tNFC_STATUS NFC_UpdateRFCommParams(tNFC_RF_COMM_PARAMS* p_params); 1128 1129 /******************************************************************************* 1130 ** 1131 ** Function NFC_SetPowerOffSleep 1132 ** 1133 ** Description This function closes/opens transport and turns off/on NFCC. 1134 ** 1135 ** Returns tNFC_STATUS 1136 ** 1137 *******************************************************************************/ 1138 extern tNFC_STATUS NFC_SetPowerOffSleep(bool enable); 1139 1140 /******************************************************************************* 1141 ** 1142 ** Function NFC_SetPowerSubState 1143 ** 1144 ** Description This function is called to send the power sub state(screen 1145 ** state) to NFCC. The response from NFCC is reported by 1146 ** tNFC_RESPONSE_CBACK as NFC_SET_POWER_STATE_REVT. 1147 ** 1148 ** Parameters scree_state 1149 ** 1150 ** Returns tNFC_STATUS 1151 ** 1152 *******************************************************************************/ 1153 extern tNFC_STATUS NFC_SetPowerSubState(uint8_t screen_state); 1154 1155 /******************************************************************************* 1156 ** 1157 ** Function NFC_PowerCycleNFCC 1158 ** 1159 ** Description This function turns off and then on NFCC. 1160 ** 1161 ** Returns tNFC_STATUS 1162 ** 1163 *******************************************************************************/ 1164 extern tNFC_STATUS NFC_PowerCycleNFCC(void); 1165 1166 /******************************************************************************* 1167 ** 1168 ** Function NFC_SetRouting 1169 ** 1170 ** Description This function is called to configure the CE routing table. 1171 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 1172 ** as NFC_SET_ROUTING_REVT. 1173 ** 1174 ** Parameters 1175 ** 1176 ** Returns tNFC_STATUS 1177 ** 1178 *******************************************************************************/ 1179 extern tNFC_STATUS NFC_SetRouting(bool more, uint8_t num_tlv, uint8_t tlv_size, 1180 uint8_t* p_param_tlvs); 1181 1182 /******************************************************************************* 1183 ** 1184 ** Function NFC_GetRouting 1185 ** 1186 ** Description This function is called to retrieve the CE routing table 1187 ** from NFCC. The response from NFCC is reported by 1188 ** tNFC_RESPONSE_CBACK as NFC_GET_ROUTING_REVT. 1189 ** 1190 ** Returns tNFC_STATUS 1191 ** 1192 *******************************************************************************/ 1193 extern tNFC_STATUS NFC_GetRouting(void); 1194 1195 /******************************************************************************* 1196 ** 1197 ** Function NFC_RegVSCback 1198 ** 1199 ** Description This function is called to register or de-register a 1200 ** callback function to receive Proprietary NCI response and 1201 ** notification events. 1202 ** The maximum number of callback functions allowed is 1203 ** NFC_NUM_VS_CBACKS 1204 ** 1205 ** Returns tNFC_STATUS 1206 ** 1207 *******************************************************************************/ 1208 extern tNFC_STATUS NFC_RegVSCback(bool is_register, tNFC_VS_CBACK* p_cback); 1209 1210 /******************************************************************************* 1211 ** 1212 ** Function NFC_SendVsCommand 1213 ** 1214 ** Description This function is called to send the given vendor specific 1215 ** command to NFCC. The response from NFCC is reported to the 1216 ** given tNFC_VS_CBACK as (oid). 1217 ** 1218 ** Parameters oid - The opcode of the VS command. 1219 ** p_data - The parameters for the VS command 1220 ** 1221 ** Returns tNFC_STATUS 1222 ** 1223 *******************************************************************************/ 1224 extern tNFC_STATUS NFC_SendVsCommand(uint8_t oid, NFC_HDR* p_data, 1225 tNFC_VS_CBACK* p_cback); 1226 1227 /******************************************************************************* 1228 ** 1229 ** Function NFC_SendRawVsCommand 1230 ** 1231 ** Description This function is called to send the given raw command to 1232 ** NFCC. The response from NFCC is reported to the given 1233 ** tNFC_VS_CBACK. 1234 ** 1235 ** Parameters p_data - The command buffer 1236 ** 1237 ** Returns tNFC_STATUS 1238 ** 1239 *******************************************************************************/ 1240 extern tNFC_STATUS NFC_SendRawVsCommand(NFC_HDR* p_data, 1241 tNFC_VS_CBACK* p_cback); 1242 1243 /******************************************************************************* 1244 ** 1245 ** Function NFC_TestLoopback 1246 ** 1247 ** Description This function is called to send the given data packet 1248 ** to NFCC for loopback test. 1249 ** When loopback data is received from NFCC, tNFC_TEST_CBACK . 1250 ** reports a NFC_LOOPBACK_TEVT. 1251 ** 1252 ** Parameters p_data - the data packet 1253 ** 1254 ** Returns tNFC_STATUS 1255 ** 1256 *******************************************************************************/ 1257 extern tNFC_STATUS NFC_TestLoopback(NFC_HDR* p_data); 1258 1259 /******************************************************************************* 1260 ** 1261 ** Function NFC_ISODEPNakPresCheck 1262 ** 1263 ** Description This function is called to send the ISO DEP nak presence 1264 ** check cmd to check that the remote end point in RF field. 1265 ** 1266 ** Returns tNFC_STATUS 1267 ** 1268 *******************************************************************************/ 1269 extern tNFC_STATUS NFC_ISODEPNakPresCheck(); 1270 1271 #if (APPL_DTA_MODE == TRUE) 1272 /******************************************************************************* 1273 ** 1274 ** Function nfc_ncif_getFWVersion 1275 ** 1276 ** Description This function sets the trace level for NFC. If called with 1277 ** a value of 0xFF, it simply returns the current trace level. 1278 ** 1279 ** Returns The new or current trace level 1280 ** 1281 *******************************************************************************/ 1282 extern tNFC_FW_VERSION nfc_ncif_getFWVersion(); 1283 #endif 1284 1285 /******************************************************************************* 1286 ** 1287 ** Function NFC_NfceePLConfig 1288 ** 1289 ** Description This function is called to set the Power and Link Control 1290 ** to an NFCEE connected to the NFCC. 1291 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 1292 ** as NFC_NFCEE_PL_CONTROL_REVT. 1293 ** 1294 ** Parameters nfcee_id - the NFCEE to activate or de-activate. 1295 ** pl_config - 1296 ** NFCEE_PL_CONFIG_NFCC_DECIDES -NFCC decides (default) 1297 ** NFCEE_PL_CONFIG_PWR_ALWAYS_ON -NFCEE power supply always on 1298 ** NFCEE_PL_CONFIG_LNK_ON_WHEN_PWR_ON - 1299 ** communication link is always active 1300 ** when NFCEE is powered on 1301 ** NFCEE_PL_CONFIG_PWR_LNK_ALWAYS_ON - 1302 ** power supply and communication 1303 ** link are always on 1304 ** Returns tNFC_STATUS 1305 ** 1306 *******************************************************************************/ 1307 extern tNFC_STATUS NFC_NfceePLConfig(uint8_t nfcee_id, 1308 tNCI_NFCEE_PL_CONFIG pl_config); 1309 1310 /******************************************************************************* 1311 ** 1312 ** Function NFC_SetStaticHciCback 1313 ** 1314 ** Description This function to update the data callback function 1315 ** to receive the data for the static Hci connection id. 1316 ** 1317 ** Parameters p_cback - the connection callback function 1318 ** 1319 ** Returns Nothing 1320 ** 1321 *******************************************************************************/ 1322 extern void NFC_SetStaticHciCback(tNFC_CONN_CBACK* p_cback); 1323 1324 /******************************************************************************* 1325 ** 1326 ** Function NFC_GetStatusName 1327 ** 1328 ** Description This function returns the status name. 1329 ** 1330 ** NOTE conditionally compiled to save memory. 1331 ** 1332 ** Returns pointer to the name 1333 ** 1334 *******************************************************************************/ 1335 extern std::string NFC_GetStatusName(tNFC_STATUS status); 1336 1337 #endif /* NFC_API_H */ 1338