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 #define NFC_DEACTIVATE_REASON_DH_REQ NCI_DEACTIVATE_REASON_DH_REQ 439 typedef uint8_t tNFC_DEACT_REASON; 440 441 /* the data type associated with NFC_RF_FIELD_REVT */ 442 typedef struct { 443 tNFC_STATUS status; /* The event status - place holder. */ 444 tNFC_RF_STS rf_field; /* RF Field Status */ 445 } tNFC_RF_FIELD_REVT; 446 447 #define NFC_MAX_APP_DATA_LEN 40 448 typedef struct { 449 uint8_t len_aid; /* length of application id */ 450 uint8_t aid[NFC_MAX_AID_LEN]; /* application id */ 451 } tNFC_AID; 452 typedef struct { 453 uint8_t len_aid; /* length of application id */ 454 uint8_t aid[NFC_MAX_AID_LEN]; /* application id */ 455 uint8_t len_data; /* len of application data */ 456 uint8_t data[NFC_MAX_APP_DATA_LEN]; /* application data */ 457 } tNFC_APP_INIT; 458 459 /* ISO 7816-4 SELECT command */ 460 #define NFC_EE_TRIG_SELECT NCI_EE_TRIG_7816_SELECT 461 /* RF Protocol changed */ 462 #define NFC_EE_TRIG_RF_PROTOCOL NCI_EE_TRIG_RF_PROTOCOL 463 /* RF Technology changed */ 464 #define NFC_EE_TRIG_RF_TECHNOLOGY NCI_EE_TRIG_RF_TECHNOLOGY 465 /* Application initiation */ 466 #define NFC_EE_TRIG_APP_INIT NCI_EE_TRIG_APP_INIT 467 typedef uint8_t tNFC_EE_TRIGGER; 468 typedef struct { 469 tNFC_EE_TRIGGER trigger; /* the trigger of this event */ 470 union { 471 tNFC_PROTOCOL protocol; 472 tNFC_RF_TECH technology; 473 tNFC_AID aid; 474 tNFC_APP_INIT app_init; 475 } param; /* Discovery Type specific parameters */ 476 } tNFC_ACTION_DATA; 477 478 /* the data type associated with NFC_EE_ACTION_REVT */ 479 typedef struct { 480 tNFC_STATUS status; /* The event status - place holder */ 481 uint8_t nfcee_id; /* NFCEE ID */ 482 tNFC_ACTION_DATA act_data; /* data associated /w the action */ 483 } tNFC_EE_ACTION_REVT; 484 485 #define NFC_EE_DISC_OP_ADD 0 486 typedef uint8_t tNFC_EE_DISC_OP; 487 typedef struct { 488 tNFC_EE_DISC_OP op; /* add or remove this entry */ 489 uint8_t nfcee_id; /* NFCEE ID */ 490 tNFC_RF_TECH_N_MODE tech_n_mode; /* Discovery Technology and Mode */ 491 tNFC_PROTOCOL protocol; /* NFC protocol */ 492 } tNFC_EE_DISCOVER_INFO; 493 494 #ifndef NFC_MAX_EE_DISC_ENTRIES 495 #define NFC_MAX_EE_DISC_ENTRIES 6 496 #endif 497 /* T, L, V(NFCEE ID, TechnMode, Protocol) */ 498 #define NFC_EE_DISCOVER_ENTRY_LEN 5 499 #define NFC_EE_DISCOVER_INFO_LEN 3 /* NFCEE ID, TechnMode, Protocol */ 500 /* the data type associated with NFC_EE_DISCOVER_REQ_REVT */ 501 typedef struct { 502 tNFC_STATUS status; /* The event status - place holder */ 503 uint8_t num_info; /* number of entries in info[] */ 504 tNFC_EE_DISCOVER_INFO 505 info[NFC_MAX_EE_DISC_ENTRIES]; /* discovery request from NFCEE */ 506 } tNFC_EE_DISCOVER_REQ_REVT; 507 508 typedef union { 509 tNFC_STATUS status; /* The event status. */ 510 tNFC_ENABLE_REVT enable; 511 tNFC_SET_CONFIG_REVT set_config; 512 tNFC_GET_CONFIG_REVT get_config; 513 tNFC_NFCEE_DISCOVER_REVT nfcee_discover; 514 tNFC_NFCEE_INFO_REVT nfcee_info; 515 tNFC_NFCEE_MODE_SET_REVT mode_set; 516 tNFC_NFCEE_PL_CONTROL_REVT pl_control; 517 tNFC_NFCEE_STATUS_REVT nfcee_status; 518 tNFC_RF_FIELD_REVT rf_field; 519 tNFC_STATUS cfg_routing; 520 tNFC_GET_ROUTING_REVT get_routing; 521 tNFC_EE_ACTION_REVT ee_action; 522 tNFC_EE_DISCOVER_REQ_REVT ee_discover_req; 523 void* p_vs_evt_data; 524 } tNFC_RESPONSE; 525 526 /************************************* 527 ** RESPONSE Callback Functions 528 **************************************/ 529 typedef void(tNFC_RESPONSE_CBACK)(tNFC_RESPONSE_EVT event, 530 tNFC_RESPONSE* p_data); 531 532 /* The events reported on tNFC_VS_CBACK */ 533 /* The event is (NCI_RSP_BIT|oid) for response and (NCI_NTF_BIT|oid) for 534 * notification*/ 535 536 typedef uint8_t tNFC_VS_EVT; 537 538 /************************************* 539 ** Proprietary (Vendor Specific) Callback Functions 540 **************************************/ 541 typedef void(tNFC_VS_CBACK)(tNFC_VS_EVT event, uint16_t data_len, 542 uint8_t* p_data); 543 544 /* the events reported on tNFC_DISCOVER_CBACK */ 545 enum { 546 NFC_START_DEVT = NFC_FIRST_DEVT, /* Status of NFC_DiscoveryStart */ 547 NFC_MAP_DEVT, /* Status of NFC_DiscoveryMap */ 548 NFC_RESULT_DEVT, /* The responses from remote device */ 549 NFC_SELECT_DEVT, /* Status of NFC_DiscoverySelect */ 550 NFC_ACTIVATE_DEVT, /* RF interface is activated */ 551 NFC_DEACTIVATE_DEVT /* Status of RF deactivation */ 552 }; 553 typedef uint16_t tNFC_DISCOVER_EVT; 554 555 /* the data type associated with NFC_START_DEVT */ 556 typedef tNFC_STATUS tNFC_START_DEVT; 557 558 typedef tNCI_RF_PA_PARAMS tNFC_RF_PA_PARAMS; 559 #define NFC_MAX_SENSB_RES_LEN NCI_MAX_SENSB_RES_LEN 560 #define NFC_NFCID0_MAX_LEN 4 561 typedef struct { 562 uint8_t sensb_res_len; /* Length of SENSB_RES Response (Byte 2 - Byte 12 or 563 13) Available after Technology Detection */ 564 uint8_t sensb_res[NFC_MAX_SENSB_RES_LEN]; /* SENSB_RES Response (ATQ) */ 565 uint8_t nfcid0[NFC_NFCID0_MAX_LEN]; 566 } tNFC_RF_PB_PARAMS; 567 568 #define NFC_MAX_SENSF_RES_LEN NCI_MAX_SENSF_RES_LEN 569 #define NFC_NFCID2_LEN NCI_NFCID2_LEN 570 typedef struct { 571 uint8_t bit_rate; /* NFC_BIT_RATE_212 or NFC_BIT_RATE_424 */ 572 uint8_t sensf_res_len; /* Length of SENSF_RES Response (Byte 2 - Byte 17 or 573 19) Available after Technology Detection */ 574 uint8_t sensf_res[NFC_MAX_SENSF_RES_LEN]; /* SENSB_RES Response */ 575 uint8_t nfcid2[NFC_NFCID2_LEN]; /* NFCID2 generated by the Local NFCC for 576 NFC-DEP Protocol.Available for Frame 577 Interface */ 578 uint8_t mrti_check; 579 uint8_t mrti_update; 580 } tNFC_RF_PF_PARAMS; 581 582 typedef tNCI_RF_LF_PARAMS tNFC_RF_LF_PARAMS; 583 584 #define NFC_ISO15693_UID_LEN 8 585 typedef struct { 586 uint8_t flag; 587 uint8_t dsfid; 588 uint8_t uid[NFC_ISO15693_UID_LEN]; 589 } tNFC_RF_PISO15693_PARAMS; 590 591 #ifndef NFC_KOVIO_MAX_LEN 592 #define NFC_KOVIO_MAX_LEN 32 593 #endif 594 typedef struct { 595 uint8_t uid_len; 596 uint8_t uid[NFC_KOVIO_MAX_LEN]; 597 } tNFC_RF_PKOVIO_PARAMS; 598 599 typedef tNCI_RF_ACM_P_PARAMS tNFC_RF_ACM_P_PARAMS; 600 601 typedef union { 602 tNFC_RF_PA_PARAMS pa; 603 tNFC_RF_PB_PARAMS pb; 604 tNFC_RF_PF_PARAMS pf; 605 tNFC_RF_LF_PARAMS lf; 606 tNFC_RF_PISO15693_PARAMS pi93; 607 tNFC_RF_PKOVIO_PARAMS pk; 608 tNFC_RF_ACM_P_PARAMS acm_p; 609 } tNFC_RF_TECH_PARAMU; 610 611 typedef struct { 612 tNFC_DISCOVERY_TYPE mode; 613 tNFC_RF_TECH_PARAMU param; 614 } tNFC_RF_TECH_PARAMS; 615 616 /* the data type associated with NFC_RESULT_DEVT */ 617 typedef struct { 618 tNFC_STATUS status; /* The event status - place holder. */ 619 uint8_t rf_disc_id; /* RF Discovery ID */ 620 uint8_t protocol; /* supported protocol */ 621 tNFC_RF_TECH_PARAMS rf_tech_param; /* RF technology parameters */ 622 uint8_t more; /* 0: last, 1: last (limit), 2: more */ 623 } tNFC_RESULT_DEVT; 624 625 /* the data type associated with NFC_SELECT_DEVT */ 626 typedef tNFC_STATUS tNFC_SELECT_DEVT; 627 628 /* the data type associated with NFC_STOP_DEVT */ 629 typedef tNFC_STATUS tNFC_STOP_DEVT; 630 631 #define NFC_MAX_ATS_LEN NCI_MAX_ATS_LEN 632 #define NFC_MAX_HIS_BYTES_LEN NCI_MAX_HIS_BYTES_LEN 633 #define NFC_MAX_GEN_BYTES_LEN NCI_MAX_GEN_BYTES_LEN 634 635 typedef struct { 636 uint8_t ats_res_len; /* Length of ATS RES */ 637 uint8_t ats_res[NFC_MAX_ATS_LEN]; /* ATS RES */ 638 bool nad_used; /* NAD is used or not */ 639 uint8_t fwi; /* Frame Waiting time Integer */ 640 uint8_t sfgi; /* Start-up Frame Guard time Integer*/ 641 uint8_t his_byte_len; /* len of historical bytes */ 642 uint8_t his_byte[NFC_MAX_HIS_BYTES_LEN]; /* historical bytes */ 643 } tNFC_INTF_PA_ISO_DEP; 644 645 typedef struct { uint8_t rats; /* RATS */ } tNFC_INTF_LA_ISO_DEP; 646 647 typedef struct { 648 uint8_t atr_res_len; /* Length of ATR_RES */ 649 uint8_t atr_res[NFC_MAX_ATS_LEN]; /* ATR_RES (Byte 3 - Byte 17+n) */ 650 uint8_t max_payload_size; /* 64, 128, 192 or 254 */ 651 uint8_t gen_bytes_len; /* len of general bytes */ 652 uint8_t gen_bytes[NFC_MAX_GEN_BYTES_LEN]; /* general bytes */ 653 uint8_t 654 waiting_time; /* WT -> Response Waiting Time RWT = (256 x 16/fC) x 2WT */ 655 } tNFC_INTF_PA_NFC_DEP; 656 657 /* Note: keep tNFC_INTF_PA_NFC_DEP data member in the same order as 658 * tNFC_INTF_LA_NFC_DEP */ 659 typedef struct { 660 uint8_t atr_req_len; /* Length of ATR_REQ */ 661 uint8_t atr_req[NFC_MAX_ATS_LEN]; /* ATR_REQ (Byte 3 - Byte 18+n) */ 662 uint8_t max_payload_size; /* 64, 128, 192 or 254 */ 663 uint8_t gen_bytes_len; /* len of general bytes */ 664 uint8_t gen_bytes[NFC_MAX_GEN_BYTES_LEN]; /* general bytes */ 665 } tNFC_INTF_LA_NFC_DEP; 666 typedef tNFC_INTF_LA_NFC_DEP tNFC_INTF_LF_NFC_DEP; 667 typedef tNFC_INTF_PA_NFC_DEP tNFC_INTF_PF_NFC_DEP; 668 669 #define NFC_MAX_ATTRIB_LEN NCI_MAX_ATTRIB_LEN 670 671 typedef struct { 672 uint8_t attrib_res_len; /* Length of ATTRIB RES */ 673 uint8_t attrib_res[NFC_MAX_ATTRIB_LEN]; /* ATTRIB RES */ 674 uint8_t hi_info_len; /* len of Higher layer Info */ 675 uint8_t hi_info[NFC_MAX_GEN_BYTES_LEN]; /* Higher layer Info */ 676 uint8_t mbli; /* Maximum buffer length. */ 677 } tNFC_INTF_PB_ISO_DEP; 678 679 typedef struct { 680 uint8_t attrib_req_len; /* Length of ATTRIB REQ */ 681 uint8_t attrib_req[NFC_MAX_ATTRIB_LEN]; /* ATTRIB REQ (Byte 2 - 10+k)*/ 682 uint8_t hi_info_len; /* len of Higher layer Info */ 683 uint8_t hi_info[NFC_MAX_GEN_BYTES_LEN]; /* Higher layer Info */ 684 uint8_t nfcid0[NFC_NFCID0_MAX_LEN]; /* NFCID0 */ 685 } tNFC_INTF_LB_ISO_DEP; 686 687 #ifndef NFC_MAX_RAW_PARAMS 688 #define NFC_MAX_RAW_PARAMS 16 689 #endif 690 #define NFC_MAX_RAW_PARAMS 16 691 typedef struct { 692 uint8_t param_len; 693 uint8_t param[NFC_MAX_RAW_PARAMS]; 694 } tNFC_INTF_FRAME; 695 696 typedef struct { 697 tNFC_INTF_TYPE type; /* Interface Type 1 Byte See Table 67 */ 698 union { 699 tNFC_INTF_LA_ISO_DEP la_iso; 700 tNFC_INTF_PA_ISO_DEP pa_iso; 701 tNFC_INTF_LB_ISO_DEP lb_iso; 702 tNFC_INTF_PB_ISO_DEP pb_iso; 703 tNFC_INTF_LA_NFC_DEP la_nfc; 704 tNFC_INTF_PA_NFC_DEP pa_nfc; 705 tNFC_INTF_LF_NFC_DEP lf_nfc; 706 tNFC_INTF_PF_NFC_DEP pf_nfc; 707 tNFC_INTF_FRAME frame; 708 } intf_param; /* Activation Parameters 0 - n Bytes */ 709 } tNFC_INTF_PARAMS; 710 711 /* the data type associated with NFC_ACTIVATE_DEVT */ 712 typedef struct { 713 uint8_t rf_disc_id; /* RF Discovery ID */ 714 tNFC_PROTOCOL protocol; /* supported protocol */ 715 tNFC_RF_TECH_PARAMS rf_tech_param; /* RF technology parameters */ 716 tNFC_DISCOVERY_TYPE data_mode; /* for future Data Exchange */ 717 tNFC_BIT_RATE tx_bitrate; /* Data Exchange Tx Bitrate */ 718 tNFC_BIT_RATE rx_bitrate; /* Data Exchange Rx Bitrate */ 719 tNFC_INTF_PARAMS intf_param; /* interface type and params*/ 720 } tNFC_ACTIVATE_DEVT; 721 722 /* the data type associated with NFC_DEACTIVATE_DEVT and NFC_DEACTIVATE_CEVT */ 723 typedef struct { 724 tNFC_STATUS status; /* The event status. */ 725 tNFC_DEACT_TYPE type; /* De-activate type */ 726 bool is_ntf; /* TRUE, if deactivate notif*/ 727 tNFC_DEACT_REASON reason; /* De-activate reason */ 728 } tNFC_DEACTIVATE_DEVT; 729 730 typedef union { 731 tNFC_STATUS status; /* The event status. */ 732 tNFC_START_DEVT start; 733 tNFC_RESULT_DEVT result; 734 tNFC_SELECT_DEVT select; 735 tNFC_STOP_DEVT stop; 736 tNFC_ACTIVATE_DEVT activate; 737 tNFC_DEACTIVATE_DEVT deactivate; 738 } tNFC_DISCOVER; 739 740 typedef struct { 741 bool include_rf_tech_mode; /* TRUE if including RF Tech and Mode update */ 742 tNFC_RF_TECH_N_MODE rf_tech_n_mode; /* RF tech and mode */ 743 bool include_tx_bit_rate; /* TRUE if including Tx bit rate update */ 744 tNFC_BIT_RATE tx_bit_rate; /* Transmit Bit Rate */ 745 bool include_rx_bit_rate; /* TRUE if including Rx bit rate update */ 746 tNFC_BIT_RATE rx_bit_rate; /* Receive Bit Rate */ 747 bool include_nfc_b_config; /* TRUE if including NFC-B data exchange config */ 748 uint8_t min_tr0; /* Minimun TR0 */ 749 uint8_t min_tr1; /* Minimun TR1 */ 750 uint8_t suppression_eos; /* Suppression of EoS */ 751 uint8_t suppression_sos; /* Suppression of SoS */ 752 uint8_t min_tr2; /* Minimun TR1 */ 753 } tNFC_RF_COMM_PARAMS; 754 755 /************************************* 756 ** DISCOVER Callback Functions 757 **************************************/ 758 typedef void(tNFC_DISCOVER_CBACK)(tNFC_DISCOVER_EVT event, 759 tNFC_DISCOVER* p_data); 760 761 typedef uint16_t tNFC_TEST_EVT; 762 763 /* the data type associated with NFC_LOOPBACK_TEVT */ 764 typedef struct { 765 tNFC_STATUS status; /* The event status. */ 766 NFC_HDR* p_data; /* The loop back data from NFCC */ 767 } tNFC_LOOPBACK_TEVT; 768 769 /* the data type associated with NFC_RF_CONTROL_TEVT */ 770 typedef tNFC_STATUS tNFC_RF_CONTROL_TEVT; 771 772 typedef union { 773 tNFC_STATUS status; /* The event status. */ 774 tNFC_LOOPBACK_TEVT loop_back; 775 tNFC_RF_CONTROL_TEVT rf_control; 776 } tNFC_TEST; 777 778 /************************************* 779 ** TEST Callback Functions 780 **************************************/ 781 typedef void(tNFC_TEST_CBACK)(tNFC_TEST_EVT event, tNFC_TEST* p_data); 782 783 typedef tNFC_DEACTIVATE_DEVT tNFC_DEACTIVATE_CEVT; 784 typedef union { 785 tNFC_STATUS status; /* The event status. */ 786 tNFC_CONN_CREATE_CEVT conn_create; 787 tNFC_CONN_CLOSE_CEVT conn_close; 788 tNFC_DEACTIVATE_CEVT deactivate; 789 tNFC_DATA_CEVT data; 790 } tNFC_CONN; 791 792 /************************************* 793 ** Data Callback Functions 794 **************************************/ 795 typedef void(tNFC_CONN_CBACK)(uint8_t conn_id, tNFC_CONN_EVT event, 796 tNFC_CONN* p_data); 797 #define NFC_MAX_CONN_ID 15 798 #define NFC_ILLEGAL_CONN_ID 0xFF 799 /* the static connection ID for RF traffic */ 800 #define NFC_RF_CONN_ID 0 801 /* the static connection ID for HCI transport */ 802 #define NFC_HCI_CONN_ID 1 803 804 /***************************************************************************** 805 ** EXTERNAL FUNCTION DECLARATIONS 806 *****************************************************************************/ 807 808 /******************************************************************************* 809 ** 810 ** Function NFC_Enable 811 ** 812 ** Description This function enables NFC. Prior to calling NFC_Enable: 813 ** - the NFCC must be powered up, and ready to receive 814 ** commands. 815 ** - GKI must be enabled 816 ** - NFC_TASK must be started 817 ** - NCIT_TASK must be started (if using dedicated NCI 818 ** transport) 819 ** 820 ** This function opens the NCI transport (if applicable), 821 ** resets the NFC controller, and initializes the NFC 822 ** subsystems. 823 ** 824 ** When the NFC startup procedure is completed, an 825 ** NFC_ENABLE_REVT is returned to the application using the 826 ** tNFC_RESPONSE_CBACK. 827 ** 828 ** Returns tNFC_STATUS 829 ** 830 *******************************************************************************/ 831 extern tNFC_STATUS NFC_Enable(tNFC_RESPONSE_CBACK* p_cback); 832 833 /******************************************************************************* 834 ** 835 ** Function NFC_Disable 836 ** 837 ** Description This function performs clean up routines for shutting down 838 ** NFC and closes the NCI transport (if using dedicated NCI 839 ** transport). 840 ** 841 ** When the NFC shutdown procedure is completed, an 842 ** NFC_DISABLED_REVT is returned to the application using the 843 ** tNFC_RESPONSE_CBACK. 844 ** 845 ** Returns nothing 846 ** 847 *******************************************************************************/ 848 extern void NFC_Disable(void); 849 850 /******************************************************************************* 851 ** 852 ** Function NFC_Init 853 ** 854 ** Description This function initializes control blocks for NFC 855 ** 856 ** Returns nothing 857 ** 858 *******************************************************************************/ 859 extern void NFC_Init(tHAL_NFC_ENTRY* p_hal_entry_tbl); 860 861 /******************************************************************************* 862 ** 863 ** Function NFC_GetLmrtSize 864 ** 865 ** Description Called by application wto query the Listen Mode Routing 866 ** Table size supported by NFCC 867 ** 868 ** Returns Listen Mode Routing Table size 869 ** 870 *******************************************************************************/ 871 extern uint16_t NFC_GetLmrtSize(void); 872 873 /******************************************************************************* 874 ** 875 ** Function NFC_SetConfig 876 ** 877 ** Description This function is called to send the configuration parameter 878 ** TLV to NFCC. The response from NFCC is reported by 879 ** tNFC_RESPONSE_CBACK as NFC_SET_CONFIG_REVT. 880 ** 881 ** Parameters tlv_size - the length of p_param_tlvs. 882 ** p_param_tlvs - the parameter ID/Len/Value list 883 ** 884 ** Returns tNFC_STATUS 885 ** 886 *******************************************************************************/ 887 extern tNFC_STATUS NFC_SetConfig(uint8_t tlv_size, uint8_t* p_param_tlvs); 888 889 /******************************************************************************* 890 ** 891 ** Function NFC_GetConfig 892 ** 893 ** Description This function is called to retrieve the parameter TLV from 894 ** NFCC. The response from NFCC is reported by 895 ** tNFC_RESPONSE_CBACK as NFC_GET_CONFIG_REVT. 896 ** 897 ** Parameters num_ids - the number of parameter IDs 898 ** p_param_ids - the parameter ID list. 899 ** 900 ** Returns tNFC_STATUS 901 ** 902 *******************************************************************************/ 903 extern tNFC_STATUS NFC_GetConfig(uint8_t num_ids, uint8_t* p_param_ids); 904 905 /******************************************************************************* 906 ** 907 ** Function NFC_NfceeDiscover 908 ** 909 ** Description This function is called to enable or disable NFCEE 910 ** Discovery. The response from NFCC is reported by 911 ** tNFC_RESPONSE_CBACK as NFC_NFCEE_DISCOVER_REVT. 912 ** The notification from NFCC is reported by 913 ** tNFC_RESPONSE_CBACK as NFC_NFCEE_INFO_REVT. 914 ** 915 ** Parameters discover - 1 to enable discover, 0 to disable. 916 ** 917 ** Returns tNFC_STATUS 918 ** 919 *******************************************************************************/ 920 extern tNFC_STATUS NFC_NfceeDiscover(bool discover); 921 922 /******************************************************************************* 923 ** 924 ** Function NFC_NfceeModeSet 925 ** 926 ** Description This function is called to activate or de-activate an NFCEE 927 ** connected to the NFCC. 928 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 929 ** as NFC_NFCEE_MODE_SET_REVT. 930 ** 931 ** Parameters nfcee_id - the NFCEE to activate or de-activate. 932 ** mode - 0 to activate NFCEE, 1 to de-activate. 933 ** 934 ** Returns tNFC_STATUS 935 ** 936 *******************************************************************************/ 937 extern tNFC_STATUS NFC_NfceeModeSet(uint8_t nfcee_id, tNFC_NFCEE_MODE mode); 938 /******************************************************************************* 939 ** 940 ** Function NFC_DiscoveryMap 941 ** 942 ** Description This function is called to set the discovery interface 943 ** mapping. The response from NFCC is reported by 944 ** tNFC_DISCOVER_CBACK as. NFC_MAP_DEVT. 945 ** 946 ** Parameters num - the number of items in p_params. 947 ** p_maps - the discovery interface mappings 948 ** p_cback - the discovery callback function 949 ** 950 ** Returns tNFC_STATUS 951 ** 952 *******************************************************************************/ 953 extern tNFC_STATUS NFC_DiscoveryMap(uint8_t num, tNFC_DISCOVER_MAPS* p_maps, 954 tNFC_DISCOVER_CBACK* p_cback); 955 956 /******************************************************************************* 957 ** 958 ** Function NFC_DiscoveryStart 959 ** 960 ** Description This function is called to start Polling and/or Listening. 961 ** The response from NFCC is reported by tNFC_DISCOVER_CBACK 962 ** as NFC_START_DEVT. The notification from NFCC is reported by 963 ** tNFC_DISCOVER_CBACK as NFC_RESULT_DEVT. 964 ** 965 ** Parameters num_params - the number of items in p_params. 966 ** p_params - the discovery parameters 967 ** p_cback - the discovery callback function 968 ** 969 ** Returns tNFC_STATUS 970 ** 971 *******************************************************************************/ 972 extern tNFC_STATUS NFC_DiscoveryStart(uint8_t num_params, 973 tNFC_DISCOVER_PARAMS* p_params, 974 tNFC_DISCOVER_CBACK* p_cback); 975 976 /******************************************************************************* 977 ** 978 ** Function NFC_DiscoverySelect 979 ** 980 ** Description If tNFC_DISCOVER_CBACK reports status=NFC_MULTIPLE_PROT, 981 ** the application needs to use this function to select the 982 ** the logical endpoint to continue. The response from NFCC is 983 ** reported by tNFC_DISCOVER_CBACK as NFC_SELECT_DEVT. 984 ** 985 ** Parameters rf_disc_id - The ID identifies the remote device. 986 ** protocol - the logical endpoint on the remote devide 987 ** rf_interface - the RF interface to communicate with NFCC 988 ** 989 ** Returns tNFC_STATUS 990 ** 991 *******************************************************************************/ 992 extern tNFC_STATUS NFC_DiscoverySelect(uint8_t rf_disc_id, uint8_t protocol, 993 uint8_t rf_interface); 994 995 /******************************************************************************* 996 ** 997 ** Function NFC_ConnCreate 998 ** 999 ** Description This function is called to create a logical connection with 1000 ** NFCC for data exchange. 1001 ** The response from NFCC is reported in tNFC_CONN_CBACK 1002 ** as NFC_CONN_CREATE_CEVT. 1003 ** 1004 ** Parameters dest_type - the destination type 1005 ** id - the NFCEE ID or RF Discovery ID . 1006 ** protocol - the protocol 1007 ** p_cback - the data callback function to receive data from 1008 ** NFCC 1009 ** 1010 ** Returns tNFC_STATUS 1011 ** 1012 *******************************************************************************/ 1013 extern tNFC_STATUS NFC_ConnCreate(uint8_t dest_type, uint8_t id, 1014 uint8_t protocol, tNFC_CONN_CBACK* p_cback); 1015 1016 /******************************************************************************* 1017 ** 1018 ** Function NFC_ConnClose 1019 ** 1020 ** Description This function is called to close a logical connection with 1021 ** NFCC. 1022 ** The response from NFCC is reported in tNFC_CONN_CBACK 1023 ** as NFC_CONN_CLOSE_CEVT. 1024 ** 1025 ** Parameters conn_id - the connection id. 1026 ** 1027 ** Returns tNFC_STATUS 1028 ** 1029 *******************************************************************************/ 1030 extern tNFC_STATUS NFC_ConnClose(uint8_t conn_id); 1031 1032 /******************************************************************************* 1033 ** 1034 ** Function NFC_SetStaticRfCback 1035 ** 1036 ** Description This function is called to update the data callback function 1037 ** to receive the data for the given connection id. 1038 ** 1039 ** Parameters p_cback - the connection callback function 1040 ** 1041 ** Returns Nothing 1042 ** 1043 *******************************************************************************/ 1044 extern void NFC_SetStaticRfCback(tNFC_CONN_CBACK* p_cback); 1045 1046 /******************************************************************************* 1047 ** 1048 ** Function NFC_SetReassemblyFlag 1049 ** 1050 ** Description This function is called to set if nfc will reassemble 1051 ** nci packet as much as its buffer can hold or it should not 1052 ** reassemble but forward the fragmented nci packet to layer 1053 ** above. If nci data pkt is fragmented, nfc may send multiple 1054 ** NFC_DATA_CEVT with status NFC_STATUS_CONTINUE before sending 1055 ** NFC_DATA_CEVT with status NFC_STATUS_OK based on reassembly 1056 ** configuration and reassembly buffer size 1057 ** 1058 ** Parameters reassembly - flag to indicate if nfc may reassemble or not 1059 ** 1060 ** Returns Nothing 1061 ** 1062 *******************************************************************************/ 1063 extern void NFC_SetReassemblyFlag(bool reassembly); 1064 1065 /******************************************************************************* 1066 ** 1067 ** Function NFC_SendData 1068 ** 1069 ** Description This function is called to send the given data packet 1070 ** to the connection identified by the given connection id. 1071 ** 1072 ** Parameters conn_id - the connection id. 1073 ** p_data - the data packet 1074 ** 1075 ** Returns tNFC_STATUS 1076 ** 1077 *******************************************************************************/ 1078 extern tNFC_STATUS NFC_SendData(uint8_t conn_id, NFC_HDR* p_data); 1079 1080 /******************************************************************************* 1081 ** 1082 ** Function NFC_FlushData 1083 ** 1084 ** Description This function is called to discard the tx data queue of 1085 ** the given connection id. 1086 ** 1087 ** Parameters conn_id - the connection id. 1088 ** 1089 ** Returns tNFC_STATUS 1090 ** 1091 *******************************************************************************/ 1092 extern tNFC_STATUS NFC_FlushData(uint8_t conn_id); 1093 1094 /******************************************************************************* 1095 ** 1096 ** Function NFC_Deactivate 1097 ** 1098 ** Description This function is called to stop the discovery process or 1099 ** put the listen device in sleep mode or terminate the NFC 1100 ** link. 1101 ** 1102 ** The response from NFCC is reported by tNFC_DISCOVER_CBACK 1103 ** as NFC_DEACTIVATE_DEVT. 1104 ** 1105 ** Parameters deactivate_type - NFC_DEACTIVATE_TYPE_IDLE, to IDLE mode. 1106 ** NFC_DEACTIVATE_TYPE_SLEEP to SLEEP mode. 1107 ** NFC_DEACTIVATE_TYPE_SLEEP_AF to SLEEP_AF 1108 ** mode. 1109 ** 1110 ** Returns tNFC_STATUS 1111 ** 1112 *******************************************************************************/ 1113 extern tNFC_STATUS NFC_Deactivate(tNFC_DEACT_TYPE deactivate_type); 1114 1115 /******************************************************************************* 1116 ** 1117 ** Function NFC_UpdateRFCommParams 1118 ** 1119 ** Description This function is called to update RF Communication 1120 ** parameters once the Frame RF Interface has been activated. 1121 ** 1122 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 1123 ** as NFC_RF_COMM_PARAMS_UPDATE_REVT. 1124 ** 1125 ** Returns tNFC_STATUS 1126 ** 1127 *******************************************************************************/ 1128 extern tNFC_STATUS NFC_UpdateRFCommParams(tNFC_RF_COMM_PARAMS* p_params); 1129 1130 /******************************************************************************* 1131 ** 1132 ** Function NFC_SetPowerOffSleep 1133 ** 1134 ** Description This function closes/opens transport and turns off/on NFCC. 1135 ** 1136 ** Returns tNFC_STATUS 1137 ** 1138 *******************************************************************************/ 1139 extern tNFC_STATUS NFC_SetPowerOffSleep(bool enable); 1140 1141 /******************************************************************************* 1142 ** 1143 ** Function NFC_SetPowerSubState 1144 ** 1145 ** Description This function is called to send the power sub state(screen 1146 ** state) to NFCC. The response from NFCC is reported by 1147 ** tNFC_RESPONSE_CBACK as NFC_SET_POWER_STATE_REVT. 1148 ** 1149 ** Parameters scree_state 1150 ** 1151 ** Returns tNFC_STATUS 1152 ** 1153 *******************************************************************************/ 1154 extern tNFC_STATUS NFC_SetPowerSubState(uint8_t screen_state); 1155 1156 /******************************************************************************* 1157 ** 1158 ** Function NFC_PowerCycleNFCC 1159 ** 1160 ** Description This function turns off and then on NFCC. 1161 ** 1162 ** Returns tNFC_STATUS 1163 ** 1164 *******************************************************************************/ 1165 extern tNFC_STATUS NFC_PowerCycleNFCC(void); 1166 1167 /******************************************************************************* 1168 ** 1169 ** Function NFC_SetRouting 1170 ** 1171 ** Description This function is called to configure the CE routing table. 1172 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 1173 ** as NFC_SET_ROUTING_REVT. 1174 ** 1175 ** Parameters 1176 ** 1177 ** Returns tNFC_STATUS 1178 ** 1179 *******************************************************************************/ 1180 extern tNFC_STATUS NFC_SetRouting(bool more, uint8_t num_tlv, uint8_t tlv_size, 1181 uint8_t* p_param_tlvs); 1182 1183 /******************************************************************************* 1184 ** 1185 ** Function NFC_GetRouting 1186 ** 1187 ** Description This function is called to retrieve the CE routing table 1188 ** from NFCC. The response from NFCC is reported by 1189 ** tNFC_RESPONSE_CBACK as NFC_GET_ROUTING_REVT. 1190 ** 1191 ** Returns tNFC_STATUS 1192 ** 1193 *******************************************************************************/ 1194 extern tNFC_STATUS NFC_GetRouting(void); 1195 1196 /******************************************************************************* 1197 ** 1198 ** Function NFC_RegVSCback 1199 ** 1200 ** Description This function is called to register or de-register a 1201 ** callback function to receive Proprietary NCI response and 1202 ** notification events. 1203 ** The maximum number of callback functions allowed is 1204 ** NFC_NUM_VS_CBACKS 1205 ** 1206 ** Returns tNFC_STATUS 1207 ** 1208 *******************************************************************************/ 1209 extern tNFC_STATUS NFC_RegVSCback(bool is_register, tNFC_VS_CBACK* p_cback); 1210 1211 /******************************************************************************* 1212 ** 1213 ** Function NFC_SendVsCommand 1214 ** 1215 ** Description This function is called to send the given vendor specific 1216 ** command to NFCC. The response from NFCC is reported to the 1217 ** given tNFC_VS_CBACK as (oid). 1218 ** 1219 ** Parameters oid - The opcode of the VS command. 1220 ** p_data - The parameters for the VS command 1221 ** 1222 ** Returns tNFC_STATUS 1223 ** 1224 *******************************************************************************/ 1225 extern tNFC_STATUS NFC_SendVsCommand(uint8_t oid, NFC_HDR* p_data, 1226 tNFC_VS_CBACK* p_cback); 1227 1228 /******************************************************************************* 1229 ** 1230 ** Function NFC_SendRawVsCommand 1231 ** 1232 ** Description This function is called to send the given raw command to 1233 ** NFCC. The response from NFCC is reported to the given 1234 ** tNFC_VS_CBACK. 1235 ** 1236 ** Parameters p_data - The command buffer 1237 ** 1238 ** Returns tNFC_STATUS 1239 ** 1240 *******************************************************************************/ 1241 extern tNFC_STATUS NFC_SendRawVsCommand(NFC_HDR* p_data, 1242 tNFC_VS_CBACK* p_cback); 1243 1244 /******************************************************************************* 1245 ** 1246 ** Function NFC_TestLoopback 1247 ** 1248 ** Description This function is called to send the given data packet 1249 ** to NFCC for loopback test. 1250 ** When loopback data is received from NFCC, tNFC_TEST_CBACK . 1251 ** reports a NFC_LOOPBACK_TEVT. 1252 ** 1253 ** Parameters p_data - the data packet 1254 ** 1255 ** Returns tNFC_STATUS 1256 ** 1257 *******************************************************************************/ 1258 extern tNFC_STATUS NFC_TestLoopback(NFC_HDR* p_data); 1259 1260 /******************************************************************************* 1261 ** 1262 ** Function NFC_ISODEPNakPresCheck 1263 ** 1264 ** Description This function is called to send the ISO DEP nak presence 1265 ** check cmd to check that the remote end point in RF field. 1266 ** 1267 ** Returns tNFC_STATUS 1268 ** 1269 *******************************************************************************/ 1270 extern tNFC_STATUS NFC_ISODEPNakPresCheck(); 1271 1272 #if (APPL_DTA_MODE == TRUE) 1273 /******************************************************************************* 1274 ** 1275 ** Function nfc_ncif_getFWVersion 1276 ** 1277 ** Description This function sets the trace level for NFC. If called with 1278 ** a value of 0xFF, it simply returns the current trace level. 1279 ** 1280 ** Returns The new or current trace level 1281 ** 1282 *******************************************************************************/ 1283 extern tNFC_FW_VERSION nfc_ncif_getFWVersion(); 1284 #endif 1285 1286 /******************************************************************************* 1287 ** 1288 ** Function NFC_NfceePLConfig 1289 ** 1290 ** Description This function is called to set the Power and Link Control 1291 ** to an NFCEE connected to the NFCC. 1292 ** The response from NFCC is reported by tNFC_RESPONSE_CBACK 1293 ** as NFC_NFCEE_PL_CONTROL_REVT. 1294 ** 1295 ** Parameters nfcee_id - the NFCEE to activate or de-activate. 1296 ** pl_config - 1297 ** NFCEE_PL_CONFIG_NFCC_DECIDES -NFCC decides (default) 1298 ** NFCEE_PL_CONFIG_PWR_ALWAYS_ON -NFCEE power supply always on 1299 ** NFCEE_PL_CONFIG_LNK_ON_WHEN_PWR_ON - 1300 ** communication link is always active 1301 ** when NFCEE is powered on 1302 ** NFCEE_PL_CONFIG_PWR_LNK_ALWAYS_ON - 1303 ** power supply and communication 1304 ** link are always on 1305 ** Returns tNFC_STATUS 1306 ** 1307 *******************************************************************************/ 1308 extern tNFC_STATUS NFC_NfceePLConfig(uint8_t nfcee_id, 1309 tNCI_NFCEE_PL_CONFIG pl_config); 1310 1311 /******************************************************************************* 1312 ** 1313 ** Function NFC_SetStaticHciCback 1314 ** 1315 ** Description This function to update the data callback function 1316 ** to receive the data for the static Hci connection id. 1317 ** 1318 ** Parameters p_cback - the connection callback function 1319 ** 1320 ** Returns Nothing 1321 ** 1322 *******************************************************************************/ 1323 extern void NFC_SetStaticHciCback(tNFC_CONN_CBACK* p_cback); 1324 1325 /******************************************************************************* 1326 ** 1327 ** Function NFC_GetStatusName 1328 ** 1329 ** Description This function returns the status name. 1330 ** 1331 ** NOTE conditionally compiled to save memory. 1332 ** 1333 ** Returns pointer to the name 1334 ** 1335 *******************************************************************************/ 1336 extern std::string NFC_GetStatusName(tNFC_STATUS status); 1337 1338 #endif /* NFC_API_H */ 1339