1 /****************************************************************************** 2 * 3 * Copyright (C) 2010-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 * 22 * This is the public interface file for NFA, Broadcom's NFC application 23 * layer for mobile phones. 24 * 25 ******************************************************************************/ 26 #ifndef NFA_API_H 27 #define NFA_API_H 28 29 #include "nfc_target.h" 30 #include "nci_defs.h" 31 #include "tags_defs.h" 32 #include "nfc_api.h" 33 #include "rw_api.h" 34 #include "nfc_hal_api.h" 35 #include "gki.h" 36 37 38 /***************************************************************************** 39 ** Constants and data types 40 *****************************************************************************/ 41 42 /* Max length of Appliction ID in 7816-4 */ 43 #define NFA_MAX_AID_LEN NFC_MAX_AID_LEN 44 #define NFA_MIN_AID_LEN 5 /* per NCI specification */ 45 46 /* NFA API return status codes */ 47 #define NFA_STATUS_OK NCI_STATUS_OK /* Command succeeded */ 48 #define NFA_STATUS_REJECTED NCI_STATUS_REJECTED /* Command is rejected. */ 49 #define NFA_STATUS_MSG_CORRUPTED NCI_STATUS_MESSAGE_CORRUPTED /* Message is corrupted */ 50 #define NFA_STATUS_BUFFER_FULL NCI_STATUS_BUFFER_FULL /* buffer full */ 51 #define NFA_STATUS_FAILED NCI_STATUS_FAILED /* failed */ 52 #define NFA_STATUS_NOT_INITIALIZED NCI_STATUS_NOT_INITIALIZED /* not initialized */ 53 #define NFA_STATUS_SYNTAX_ERROR NCI_STATUS_SYNTAX_ERROR /* Syntax error */ 54 #define NFA_STATUS_SEMANTIC_ERROR NCI_STATUS_SEMANTIC_ERROR /* Semantic error */ 55 #define NFA_STATUS_UNKNOWN_GID NCI_STATUS_UNKNOWN_GID /* Unknown NCI Group ID */ 56 #define NFA_STATUS_UNKNOWN_OID NCI_STATUS_UNKNOWN_OID /* Unknown NCI Opcode */ 57 #define NFA_STATUS_INVALID_PARAM NCI_STATUS_INVALID_PARAM /* Invalid Parameter */ 58 #define NFA_STATUS_MSG_SIZE_TOO_BIG NCI_STATUS_MSG_SIZE_TOO_BIG /* Message size too big */ 59 #define NFA_STATUS_ALREADY_STARTED NCI_STATUS_ALREADY_STARTED /* Already started */ 60 #define NFA_STATUS_ACTIVATION_FAILED NCI_STATUS_ACTIVATION_FAILED /* Activation Failed */ 61 #define NFA_STATUS_TEAR_DOWN NCI_STATUS_TEAR_DOWN /* Tear Down Error */ 62 #define NFA_STATUS_RF_TRANSMISSION_ERR NCI_STATUS_RF_TRANSMISSION_ERR /* RF transmission error*/ 63 #define NFA_STATUS_RF_PROTOCOL_ERR NCI_STATUS_RF_PROTOCOL_ERR /* RF protocol error */ 64 #define NFA_STATUS_TIMEOUT NCI_STATUS_TIMEOUT /* RF Timeout */ 65 #define NFA_STATUS_EE_INTF_ACTIVE_FAIL NCI_STATUS_EE_INTF_ACTIVE_FAIL /* EE Intf activate err */ 66 #define NFA_STATUS_EE_TRANSMISSION_ERR NCI_STATUS_EE_TRANSMISSION_ERR /* EE transmission error*/ 67 #define NFA_STATUS_EE_PROTOCOL_ERR NCI_STATUS_EE_PROTOCOL_ERR /* EE protocol error */ 68 #define NFA_STATUS_EE_TIMEOUT NCI_STATUS_EE_TIMEOUT /* EE Timeout */ 69 70 #define NFA_STATUS_CMD_STARTED NFC_STATUS_CMD_STARTED /* Command started successfully */ 71 #define NFA_STATUS_HW_TIMEOUT NFC_STATUS_HW_TIMEOUT /* NFCC Timeout in responding to an NCI command */ 72 #define NFA_STATUS_CONTINUE NFC_STATUS_CONTINUE /* More NFA_CE_GET_ROUTING_REVT to follow */ 73 #define NFA_STATUS_REFUSED NFC_STATUS_REFUSED /* API is called to perform illegal function */ 74 #define NFA_STATUS_BAD_RESP NFC_STATUS_BAD_RESP /* Wrong format of R-APDU, CC file or NDEF file */ 75 #define NFA_STATUS_CMD_NOT_CMPLTD NFC_STATUS_CMD_NOT_CMPLTD /* 7816 Status Word is not command complete(0x9000) */ 76 #define NFA_STATUS_NO_BUFFERS NFC_STATUS_NO_BUFFERS /* Out of GKI buffers */ 77 #define NFA_STATUS_WRONG_PROTOCOL NFC_STATUS_WRONG_PROTOCOL /* Protocol mismatch between API and activated one */ 78 #define NFA_STATUS_BUSY NFC_STATUS_BUSY /* Another Tag command is already in progress */ 79 80 #define NFA_STATUS_BAD_LENGTH NFC_STATUS_BAD_LENGTH /* data len exceeds MIU */ 81 #define NFA_STATUS_BAD_HANDLE NFC_STATUS_BAD_HANDLE /* invalid handle */ 82 #define NFA_STATUS_CONGESTED NFC_STATUS_CONGESTED /* congested */ 83 typedef UINT8 tNFA_STATUS; 84 85 /* Handle for NFA registrations and connections */ 86 typedef UINT16 tNFA_HANDLE; 87 #define NFA_HANDLE_INVALID (0xFFFF) 88 /* NFA Handle definitions */ 89 90 /* The upper byte of NFA_HANDLE signifies the handle group */ 91 #define NFA_HANDLE_GROUP_CONNECTION 0x0100 /* Connection handles */ 92 #define NFA_HANDLE_GROUP_NDEF_HANDLER 0x0200 /* NDEF Type Handler handles */ 93 #define NFA_HANDLE_GROUP_CE 0x0300 /* DH Card Emulation handles */ 94 #define NFA_HANDLE_GROUP_EE 0x0400 /* Handles to identify NFCEE */ 95 #define NFA_HANDLE_GROUP_P2P 0x0500 /* P2P handles */ 96 #define NFA_HANDLE_GROUP_CHO 0x0600 /* Connection Handvoer handles */ 97 #define NFA_HANDLE_GROUP_SNEP 0x0700 /* SNEP handles */ 98 #define NFA_HANDLE_GROUP_HCI 0x0800 /* HCI handles */ 99 #define NFA_HANDLE_GROUP_LOCAL_NDEF 0x0900 /* Local NDEF message handle */ 100 #define NFA_HANDLE_GROUP_MASK 0xFF00 101 #define NFA_HANDLE_MASK 0x00FF 102 103 /* NCI Parameter IDs */ 104 typedef UINT8 tNFA_PMID; 105 106 /* Definitions for tNFA_TECHNOLOGY_MASK */ 107 #define NFA_TECHNOLOGY_MASK_A 0x01 /* NFC Technology A */ 108 #define NFA_TECHNOLOGY_MASK_B 0x02 /* NFC Technology B */ 109 #define NFA_TECHNOLOGY_MASK_F 0x04 /* NFC Technology F */ 110 #define NFA_TECHNOLOGY_MASK_ISO15693 0x08 /* Proprietary Technology */ 111 #define NFA_TECHNOLOGY_MASK_B_PRIME 0x10 /* Proprietary Technology */ 112 #define NFA_TECHNOLOGY_MASK_KOVIO 0x20 /* Proprietary Technology */ 113 #define NFA_TECHNOLOGY_MASK_A_ACTIVE 0x40 /* NFC Technology A active mode */ 114 #define NFA_TECHNOLOGY_MASK_F_ACTIVE 0x80 /* NFC Technology F active mode */ 115 #define NFA_TECHNOLOGY_MASK_ALL 0xFF /* All supported technologies */ 116 typedef UINT8 tNFA_TECHNOLOGY_MASK; 117 118 /* Definitions for NFC protocol for RW, CE and P2P APIs */ 119 #define NFA_PROTOCOL_T1T NFC_PROTOCOL_T1T /* Type1Tag - NFC-A */ 120 #define NFA_PROTOCOL_T2T NFC_PROTOCOL_T2T /* MIFARE/Type2Tag - NFC-A */ 121 #define NFA_PROTOCOL_T3T NFC_PROTOCOL_T3T /* Felica/Type3Tag - NFC-F */ 122 #define NFA_PROTOCOL_ISO_DEP NFC_PROTOCOL_ISO_DEP /* Type 4A,4B - NFC-A or NFC-B */ 123 #define NFA_PROTOCOL_NFC_DEP NFC_PROTOCOL_NFC_DEP /* NFCDEP/LLCP - NFC-A or NFC-F */ 124 #define NFA_PROTOCOL_ISO15693 NFC_PROTOCOL_15693 125 #define NFA_PROTOCOL_B_PRIME NFC_PROTOCOL_B_PRIME 126 #define NFA_PROTOCOL_KOVIO NFC_PROTOCOL_KOVIO 127 #define NFA_PROTOCOL_INVALID 0xFF 128 #define NFA_MAX_NUM_PROTOCOLS 8 129 typedef UINT8 tNFA_NFC_PROTOCOL; 130 131 /* Definitions for tNFA_PROTOCOL_MASK */ 132 #define NFA_PROTOCOL_MASK_T1T 0x01 /* Type 1 tag */ 133 #define NFA_PROTOCOL_MASK_T2T 0x02 /* MIFARE / Type 2 tag */ 134 #define NFA_PROTOCOL_MASK_T3T 0x04 /* FeliCa / Type 3 tag */ 135 #define NFA_PROTOCOL_MASK_ISO_DEP 0x08 /* ISODEP/4A,4B */ 136 #define NFA_PROTOCOL_MASK_NFC_DEP 0x10 /* NFCDEP/LLCP */ 137 typedef UINT8 tNFA_PROTOCOL_MASK; 138 139 140 /* NFA_DM callback events */ 141 #define NFA_DM_ENABLE_EVT 0 /* Result of NFA_Enable */ 142 #define NFA_DM_DISABLE_EVT 1 /* Result of NFA_Disable */ 143 #define NFA_DM_SET_CONFIG_EVT 2 /* Result of NFA_SetConfig */ 144 #define NFA_DM_GET_CONFIG_EVT 3 /* Result of NFA_GetConfig */ 145 #define NFA_DM_PWR_MODE_CHANGE_EVT 4 /* Result of NFA_PowerOffSleepMode */ 146 #define NFA_DM_RF_FIELD_EVT 5 /* Status of RF Field */ 147 #define NFA_DM_NFCC_TIMEOUT_EVT 6 /* NFCC is not responding */ 148 #define NFA_DM_NFCC_TRANSPORT_ERR_EVT 7 /* NCI Tranport error */ 149 150 #define NFA_T1T_HR_LEN T1T_HR_LEN /* T1T HR length */ 151 #define NFA_MAX_UID_LEN TAG_MAX_UID_LEN /* Max UID length of T1/T2 */ 152 #define NFA_T1T_UID_LEN T1T_UID_LEN /* T1T UID length */ 153 #define NFA_T1T_CMD_UID_LEN T1T_CMD_UID_LEN /* UID len for T1T cmds */ 154 #define NFA_T2T_UID_LEN T2T_UID_LEN /* T2T UID length */ 155 156 #define NFA_RW_NDEF_FL_READ_ONLY RW_NDEF_FL_READ_ONLY /* Tag is read only */ 157 #define NFA_RW_NDEF_FL_FORMATED RW_NDEF_FL_FORMATED /* Tag formated for NDEF */ 158 #define NFA_RW_NDEF_FL_SUPPORTED RW_NDEF_FL_SUPPORTED /* NDEF supported by the tag */ 159 #define NFA_RW_NDEF_FL_UNKNOWN RW_NDEF_FL_UNKNOWN /* Unable to find if tag is ndef capable/formated/read only */ 160 #define NFA_RW_NDEF_FL_FORMATABLE RW_NDEF_FL_FORMATABLE /* Tag supports format operation */ 161 #define NFA_RW_NDEF_FL_SOFT_LOCKABLE RW_NDEF_FL_SOFT_LOCKABLE /* Tag can be soft locked */ 162 #define NFA_RW_NDEF_FL_HARD_LOCKABLE RW_NDEF_FL_HARD_LOCKABLE /* Tag can be hard locked */ 163 #define NFA_RW_NDEF_FL_OTP RW_NDEF_FL_OTP /* Tag is one time programmable */ 164 165 typedef UINT8 tNFA_RW_NDEF_FLAG; 166 167 /* Data for NFA_DM_SET_CONFIG_EVT */ 168 typedef struct 169 { 170 tNFA_STATUS status; /* NFA_STATUS_OK if successful */ 171 UINT8 num_param_id; /* Number of rejected Param ID */ 172 tNFA_PMID param_ids[NFC_MAX_NUM_IDS]; /* Rejected Param ID */ 173 } tNFA_SET_CONFIG; 174 175 /* Data for NFA_DM_GET_CONFIG_EVT */ 176 typedef struct 177 { 178 tNFA_STATUS status; /* NFA_STATUS_OK if successful */ 179 UINT16 tlv_size; /* The length of TLV */ 180 UINT8 param_tlvs[1]; /* TLV (Parameter ID-Len-Value byte stream) */ 181 } tNFA_GET_CONFIG; 182 183 #define NFA_DM_PWR_MODE_FULL 0x04 184 #define NFA_DM_PWR_MODE_OFF_SLEEP 0x00 185 186 typedef UINT8 tNFA_DM_PWR_MODE; 187 188 /* Data for NFA_DM_PWR_MODE_CHANGE_EVT */ 189 typedef struct 190 { 191 tNFA_STATUS status; /* NFA_STATUS_OK if successful */ 192 tNFA_DM_PWR_MODE power_mode; /* NFA_DM_PWR_MODE_FULL or NFA_DM_PWR_MODE_OFF_SLEEP */ 193 } tNFA_DM_PWR_MODE_CHANGE; 194 195 /* Data for NFA_DM_RF_FIELD_EVT */ 196 #define NFA_DM_RF_FIELD_OFF 0x00 197 #define NFA_DM_RF_FIELD_ON 0x01 198 199 typedef struct 200 { 201 tNFA_STATUS status; /* NFA_STATUS_OK if successful */ 202 UINT8 rf_field_status;/* NFA_DM_RF_FIELD_ON if operating field generated by remote */ 203 } tNFA_DM_RF_FIELD; 204 205 /* Union of all DM callback structures */ 206 typedef union 207 { 208 tNFA_STATUS status; /* NFA_DM_ENABLE_EVT */ 209 tNFA_SET_CONFIG set_config; /* NFA_DM_SET_CONFIG_EVT */ 210 tNFA_GET_CONFIG get_config; /* NFA_DM_GET_CONFIG_EVT */ 211 tNFA_DM_PWR_MODE_CHANGE power_mode; /* NFA_DM_PWR_MODE_CHANGE_EVT */ 212 tNFA_DM_RF_FIELD rf_field; /* NFA_DM_RF_FIELD_EVT */ 213 void *p_vs_evt_data; /* Vendor-specific evt data */ 214 } tNFA_DM_CBACK_DATA; 215 216 /* NFA_DM callback */ 217 typedef void (tNFA_DM_CBACK) (UINT8 event, tNFA_DM_CBACK_DATA *p_data); 218 219 220 /* NFA Connection Callback Events */ 221 #define NFA_POLL_ENABLED_EVT 0 /* Polling enabled event */ 222 #define NFA_POLL_DISABLED_EVT 1 /* Polling disabled event */ 223 #define NFA_DISC_RESULT_EVT 2 /* NFC link/protocol discovery notificaiton */ 224 #define NFA_SELECT_RESULT_EVT 3 /* NFC link/protocol discovery select response */ 225 #define NFA_DEACTIVATE_FAIL_EVT 4 /* NFA_Deactivate failure */ 226 #define NFA_ACTIVATED_EVT 5 /* NFC link/protocol activated */ 227 #define NFA_DEACTIVATED_EVT 6 /* NFC link/protocol deactivated */ 228 #define NFA_TLV_DETECT_EVT 7 /* TLV Detection complete */ 229 #define NFA_NDEF_DETECT_EVT 8 /* NDEF Detection complete */ 230 #define NFA_DATA_EVT 9 /* Data message received */ 231 #define NFA_SELECT_CPLT_EVT 10 /* Select completed */ 232 #define NFA_READ_CPLT_EVT 11 /* Read completed */ 233 #define NFA_WRITE_CPLT_EVT 12 /* Write completed */ 234 #define NFA_LLCP_ACTIVATED_EVT 13 /* LLCP link is activated */ 235 #define NFA_LLCP_DEACTIVATED_EVT 14 /* LLCP link is deactivated */ 236 #define NFA_PRESENCE_CHECK_EVT 15 /* Response to NFA_RwPresenceCheck */ 237 #define NFA_FORMAT_CPLT_EVT 16 /* Tag Formating completed */ 238 #define NFA_I93_CMD_CPLT_EVT 17 /* ISO 15693 command completed */ 239 #define NFA_SET_TAG_RO_EVT 18 /* Tag set as Read only */ 240 #define NFA_EXCLUSIVE_RF_CONTROL_STARTED_EVT 19 /* Result for NFA_RequestExclusiveRfControl */ 241 #define NFA_EXCLUSIVE_RF_CONTROL_STOPPED_EVT 20 /* Result for NFA_ReleaseExclusiveRfControl */ 242 #define NFA_CE_REGISTERED_EVT 21 /* DH Card emulation: AID or System code reg'd */ 243 #define NFA_CE_DEREGISTERED_EVT 22 /* DH Card emulation: AID or System code dereg'd*/ 244 #define NFA_CE_DATA_EVT 23 /* DH Card emulation: data received event */ 245 #define NFA_CE_ACTIVATED_EVT 24 /* DH Card emulation: activation event */ 246 #define NFA_CE_DEACTIVATED_EVT 25 /* DH Card emulation: deactivation event */ 247 #define NFA_CE_LOCAL_TAG_CONFIGURED_EVT 26 /* DH Card emulation: local NDEF configured */ 248 #define NFA_CE_NDEF_WRITE_START_EVT 27 /* DH Card emulation: NDEF write started */ 249 #define NFA_CE_NDEF_WRITE_CPLT_EVT 28 /* DH Card emulation: NDEF write completed */ 250 #define NFA_CE_UICC_LISTEN_CONFIGURED_EVT 29 /* UICC Listen configured */ 251 #define NFA_RF_DISCOVERY_STARTED_EVT 30 /* RF Discovery started event */ 252 #define NFA_RF_DISCOVERY_STOPPED_EVT 31 /* RF Discovery stopped event */ 253 #define NFA_UPDATE_RF_PARAM_RESULT_EVT 32 /* status of updating RF communication paramters*/ 254 #define NFA_SET_P2P_LISTEN_TECH_EVT 33 /* status of setting P2P listen technologies */ 255 #define NFA_RW_INTF_ERROR_EVT 34 /* RF Interface error event */ 256 #define NFA_LLCP_FIRST_PACKET_RECEIVED_EVT 35 /* First packet received over LLCP link */ 257 #define NFA_LISTEN_ENABLED_EVT 36 /* Listening enabled event */ 258 #define NFA_LISTEN_DISABLED_EVT 37 /* Listening disabled event */ 259 #define NFA_P2P_PAUSED_EVT 38 /* P2P services paused event */ 260 #define NFA_P2P_RESUMED_EVT 39 /* P2P services resumed event */ 261 262 /* NFC deactivation type */ 263 #define NFA_DEACTIVATE_TYPE_IDLE NFC_DEACTIVATE_TYPE_IDLE 264 #define NFA_DEACTIVATE_TYPE_SLEEP NFC_DEACTIVATE_TYPE_SLEEP 265 #define NFA_DEACTIVATE_TYPE_DISCOVERY NFC_DEACTIVATE_TYPE_DISCOVERY 266 267 typedef UINT8 tNFA_DEACTIVATE_TYPE; 268 269 /* Data for NFA_DISC_RESULT_EVT */ 270 typedef struct 271 { 272 tNFA_STATUS status; /* NFA_STATUS_OK if successful */ 273 tNFC_RESULT_DEVT discovery_ntf; /* RF discovery notification details */ 274 } tNFA_DISC_RESULT; 275 276 /* Data for NFA_ACTIVATED_EVT */ 277 typedef struct 278 { 279 UINT8 hr[NFA_T1T_HR_LEN]; /* HR of Type 1 tag */ 280 UINT8 uid[NFA_T1T_CMD_UID_LEN]; /* UID used in T1T Commands */ 281 } tNFA_T1T_PARAMS; 282 283 typedef struct 284 { 285 UINT8 uid[NFA_MAX_UID_LEN]; /* UID of T2T tag */ 286 } tNFA_T2T_PARAMS; 287 288 typedef struct 289 { 290 UINT8 num_system_codes; /* Number of system codes supporte by tag */ 291 UINT16 *p_system_codes; /* Pointer to list of system codes */ 292 } tNFA_T3T_PARAMS; 293 294 typedef struct 295 { 296 UINT8 uid[I93_UID_BYTE_LEN]; /* UID[0]:MSB, ... UID[7]:LSB */ 297 UINT8 info_flags; /* information flags */ 298 UINT8 dsfid; /* DSFID if I93_INFO_FLAG_DSFID */ 299 UINT8 afi; /* AFI if I93_INFO_FLAG_AFI */ 300 UINT16 num_block; /* number of blocks if I93_INFO_FLAG_MEM_SIZE */ 301 UINT8 block_size; /* block size in byte if I93_INFO_FLAG_MEM_SIZE */ 302 UINT8 IC_reference; /* IC Reference if I93_INFO_FLAG_IC_REF */ 303 } tNFA_I93_PARAMS; 304 305 typedef union 306 { 307 tNFA_T1T_PARAMS t1t; /* HR and UID of T1T */ 308 tNFA_T2T_PARAMS t2t; /* UID of T2T */ 309 tNFA_T3T_PARAMS t3t; /* System codes */ 310 tNFA_I93_PARAMS i93; /* System Information of ISO 15693 */ 311 } tNFA_TAG_PARAMS; 312 313 typedef struct 314 { 315 tNFC_ACTIVATE_DEVT activate_ntf; /* RF discovery activation details */ 316 tNFA_TAG_PARAMS params; /* additional informaiton of tag */ 317 } tNFA_ACTIVATED; 318 319 /* Data for NFA_DEACTIVATED_EVT */ 320 typedef struct 321 { 322 tNFA_DEACTIVATE_TYPE type; /* NFA_DEACTIVATE_TYPE_IDLE or NFA_DEACTIVATE_TYPE_SLEEP */ 323 } tNFA_DEACTIVATED; 324 325 /* Structure for NFA_NDEF_DETECT_EVT event data */ 326 typedef struct 327 { 328 tNFA_STATUS status; /* Status of the ndef detecton */ 329 tNFA_NFC_PROTOCOL protocol; /* protocol used to detect NDEF */ 330 UINT32 max_size; /* max number of bytes available for NDEF data */ 331 UINT32 cur_size; /* current size of stored NDEF data (in bytes) */ 332 tNFA_RW_NDEF_FLAG flags; /* Flags to indicate NDEF capability, is formated, soft/hard lockable, formatable, otp and read only */ 333 } tNFA_NDEF_DETECT; 334 335 336 /* Structure for NFA_TLV_DETECT_EVT event data */ 337 typedef struct 338 { 339 tNFA_STATUS status; /* Status of the tlv detecton */ 340 tNFA_NFC_PROTOCOL protocol; /* protocol used to detect TLV */ 341 UINT8 num_tlvs; /* number of tlvs present in the tag */ 342 UINT8 num_bytes; /* number of lock/reserved bytes */ 343 } tNFA_TLV_DETECT; 344 345 /* Structure for NFA_DATA_EVT data */ 346 typedef struct 347 { 348 tNFA_STATUS status; /* Status of Data received */ 349 UINT8 *p_data; /* Data buffer */ 350 UINT16 len; /* Length of data */ 351 } tNFA_RX_DATA; 352 353 /* Structure for NFA_CE_NDEF_WRITE_CPLT_EVT data */ 354 typedef struct 355 { 356 tNFA_STATUS status; /* Status of the ndef write op */ 357 UINT32 len; /* Update length of NDEF data */ 358 UINT8 *p_data; /* data buffer */ 359 } tNFA_CE_NDEF_WRITE_CPLT; 360 361 /* Data for NFA_LLCP_ACTIVATED_EVT */ 362 typedef struct 363 { 364 BOOLEAN is_initiator; /* TRUE if initiator */ 365 UINT16 remote_wks; /* Well-Known service mask of peer */ 366 UINT8 remote_lsc; /* Link Service Class of peer */ 367 UINT16 remote_link_miu;/* Link MIU of peer */ 368 UINT16 local_link_miu; /* Link MIU of local */ 369 UINT8 remote_version; /* LLCP version of remote */ 370 } tNFA_LLCP_ACTIVATED; 371 372 /* Data for NFA_LLCP_DEACTIVATED_EVT */ 373 typedef struct 374 { 375 UINT8 reason; /* reason of deactivation */ 376 } tNFA_LLCP_DEACTIVATED; 377 378 /* Data for NFA_I93_CMD_CPLT_EVT */ 379 typedef struct 380 { 381 UINT8 dsfid; /* DSFID */ 382 UINT8 uid[I93_UID_BYTE_LEN]; /* UID[0]:MSB, ... UID[7]:LSB */ 383 } tNFA_I93_INVENTORY; 384 385 typedef struct /* RW_I93_SYS_INFO_EVT */ 386 { 387 UINT8 info_flags; /* information flags */ 388 UINT8 uid[I93_UID_BYTE_LEN]; /* UID */ 389 UINT8 dsfid; /* DSFID if I93_INFO_FLAG_DSFID */ 390 UINT8 afi; /* AFI if I93_INFO_FLAG_AFI */ 391 UINT16 num_block; /* number of blocks if I93_INFO_FLAG_MEM_SIZE */ 392 UINT8 block_size; /* block size in byte if I93_INFO_FLAG_MEM_SIZE */ 393 UINT8 IC_reference; /* IC Reference if I93_INFO_FLAG_IC_REF */ 394 } tNFA_I93_SYS_INFO; 395 396 typedef struct 397 { 398 tNFA_STATUS status; /* Status of sending command */ 399 UINT8 sent_command; /* sent command to tag */ 400 union 401 { 402 UINT8 error_code; /* error code defined in ISO 15693 */ 403 tNFA_I93_INVENTORY inventory; /* inventory response */ 404 tNFA_I93_SYS_INFO sys_info; /* system information */ 405 } params; 406 } tNFA_I93_CMD_CPLT; 407 408 /* Data for NFA_CE_REGISTERED_EVT */ 409 typedef struct 410 { 411 tNFA_STATUS status; /* NFA_STATUS_OK if successful */ 412 tNFA_HANDLE handle; /* handle for NFA_CeRegisterFelicaSystemCodeOnDH () */ 413 /* NFA_CeRegisterT4tAidOnDH () */ 414 } tNFA_CE_REGISTERED; 415 416 /* Data for NFA_CE_DEREGISTERED_EVT */ 417 typedef struct 418 { 419 tNFA_HANDLE handle; /* handle from NFA_CE_REGISTERED_EVT */ 420 } tNFA_CE_DEREGISTERED; 421 422 /* Data for NFA_CE_ACTIVATED_EVT */ 423 typedef struct 424 { 425 tNFA_STATUS status; /* NFA_STATUS_OK if successful */ 426 tNFA_HANDLE handle; /* handle from NFA_CE_REGISTERED_EVT */ 427 tNFC_ACTIVATE_DEVT activate_ntf; /* RF discovery activation details */ 428 } tNFA_CE_ACTIVATED; 429 430 /* Data for NFA_CE_DEACTIVATED_EVT */ 431 typedef struct 432 { 433 tNFA_HANDLE handle; /* handle from NFA_CE_REGISTERED_EVT */ 434 tNFA_DEACTIVATE_TYPE type; /* NFA_DEACTIVATE_TYPE_IDLE or NFA_DEACTIVATE_TYPE_SLEEP */ 435 } tNFA_CE_DEACTIVATED; 436 437 /* Structure for NFA_CE_DATA_EVT data */ 438 typedef struct 439 { 440 tNFA_STATUS status; /* NFA_STATUS_OK if complete packet */ 441 tNFA_HANDLE handle; /* handle from NFA_CE_REGISTERED_EVT */ 442 UINT8 *p_data; /* Data buffer */ 443 UINT16 len; /* Length of data */ 444 } tNFA_CE_DATA; 445 446 447 /* Union of all connection callback structures */ 448 typedef union 449 { 450 tNFA_STATUS status; /* NFA_POLL_ENABLED_EVT */ 451 /* NFA_POLL_DISABLED_EVT */ 452 /* NFA_CE_UICC_LISTEN_CONFIGURED_EVT */ 453 /* NFA_EXCLUSIVE_RF_CONTROL_STARTED_EVT */ 454 /* NFA_EXCLUSIVE_RF_CONTROL_STOPPED_EVT */ 455 /* NFA_SELECT_RESULT_EVT */ 456 /* NFA_DEACTIVATE_FAIL_EVT */ 457 /* NFA_CE_NDEF_WRITE_START_EVT */ 458 /* NFA_SELECT_CPLT_EVT */ 459 /* NFA_READ_CPLT_EVT */ 460 /* NFA_WRITE_CPLT_EVT */ 461 /* NFA_PRESENCE_CHECK_EVT */ 462 /* NFA_FORMAT_CPLT_EVT */ 463 /* NFA_SET_TAG_RO_EVT */ 464 /* NFA_UPDATE_RF_PARAM_RESULT_EVT */ 465 /* NFA_RW_INTF_ERROR_EVT */ 466 tNFA_DISC_RESULT disc_result; /* NFA_DISC_RESULT_EVT */ 467 tNFA_ACTIVATED activated; /* NFA_ACTIVATED_EVT */ 468 tNFA_DEACTIVATED deactivated; /* NFA_DEACTIVATED_EVT */ 469 tNFA_NDEF_DETECT ndef_detect; /* NFA_NDEF_DETECT_EVT */ 470 tNFA_TLV_DETECT tlv_detect; /* NFA_TLV_DETECT_EVT */ 471 tNFA_RX_DATA data; /* NFA_DATA_EVT */ 472 tNFA_CE_NDEF_WRITE_CPLT ndef_write_cplt; /* NFA_CE_NDEF_WRITE_CPLT_EVT */ 473 tNFA_LLCP_ACTIVATED llcp_activated; /* NFA_LLCP_ACTIVATED_EVT */ 474 tNFA_LLCP_DEACTIVATED llcp_deactivated; /* NFA_LLCP_DEACTIVATED_EVT */ 475 tNFA_I93_CMD_CPLT i93_cmd_cplt; /* NFA_I93_CMD_CPLT_EVT */ 476 tNFA_CE_REGISTERED ce_registered; /* NFA_CE_REGISTERED_EVT */ 477 tNFA_CE_DEREGISTERED ce_deregistered; /* NFA_CE_DEREGISTERED_EVT */ 478 tNFA_CE_ACTIVATED ce_activated; /* NFA_CE_ACTIVATED_EVT */ 479 tNFA_CE_DEACTIVATED ce_deactivated; /* NFA_CE_DEACTIVATED_EVT */ 480 tNFA_CE_DATA ce_data; /* NFA_CE_DATA_EVT */ 481 482 } tNFA_CONN_EVT_DATA; 483 484 /* NFA Connection Callback */ 485 typedef void (tNFA_CONN_CBACK) (UINT8 event, tNFA_CONN_EVT_DATA *p_data); 486 487 #ifndef NFA_DM_NUM_INTERFACE_MAP 488 #define NFA_DM_NUM_INTERFACE_MAP 3 489 #endif 490 491 /* compile-time configuration structure for the RF Discovery Frequency for each technology */ 492 typedef struct 493 { 494 UINT8 pa; /* Frequency for NFC Technology A */ 495 UINT8 pb; /* Frequency for NFC Technology B */ 496 UINT8 pf; /* Frequency for NFC Technology F */ 497 UINT8 pi93; /* Frequency for Proprietary Technology/15693 */ 498 UINT8 pbp; /* Frequency for Proprietary Technology/B-Prime */ 499 UINT8 pk; /* Frequency for Proprietary Technology/Kovio */ 500 UINT8 paa; /* Frequency for NFC Technology A active mode */ 501 UINT8 pfa; /* Frequency for NFC Technology F active mode */ 502 } tNFA_DM_DISC_FREQ_CFG; 503 504 /* definitions for tNFA_DM_CFG.presence_check_option */ 505 #define NFA_DM_PCO_ISO_SLEEP_WAKE 0x01 /* if NDEF is not supported by the tag, use sleep/wake(last interface) */ 506 #define NFA_DM_PCO_EMPTY_I_BLOCK 0x02 /* NFA_SendRawFrame() has been used, use empty I block for presence check 507 * if this bit is not set, use read-binary on channel 3 for presence check */ 508 509 /* compile-time configuration structure */ 510 typedef struct 511 { 512 BOOLEAN auto_detect_ndef; /* Automatic NDEF detection (when not in exclusive RF mode) */ 513 BOOLEAN auto_read_ndef; /* Automatic NDEF read (when not in exclusive RF mode) */ 514 BOOLEAN auto_presence_check; /* Automatic presence check */ 515 UINT8 presence_check_option; /* Use sleep/wake(last interface) for ISODEP presence check */ 516 UINT16 presence_check_timeout; /* Maximum time to wait for presence check response */ 517 } tNFA_DM_CFG; 518 519 /* compile-time configuration structure for HCI */ 520 typedef struct 521 { 522 UINT16 hci_netwk_enable_timeout; /* Maximum idle(no HCP Pkt) time to wait for EE DISC REQ Ntf(s) */ 523 UINT16 hcp_response_timeout; /* Maximum time to wait for EE DISC REQ NTF(s) after HOT PLUG EVT(s) */ 524 UINT8 num_whitelist_host; /* Number of host in the whitelist of Terminal host */ 525 UINT8 *p_whitelist; /* Whitelist of Terminal Host */ 526 } tNFA_HCI_CFG; 527 528 /* 529 ** Exclusive RF mode listen configuration 530 */ 531 532 #define NFA_LB_MAX_NFCID0_LEN 4 533 #define NFA_LF_MAX_SC_NFCID2 1 534 #define NFA_LA_MAX_HIST_BYTES 15 535 #define NFA_LB_MAX_H_INFO_LEN 15 536 537 typedef struct 538 { 539 /* 540 ** Discovery Configuration Parameters for Listen A 541 */ 542 BOOLEAN la_enable; /* TRUE if listening A */ 543 UINT8 la_bit_frame_sdd; /* Bit Frame SDD in Byte 1 of SENS_RES */ 544 UINT8 la_platform_config; /* Platform Config in Byte 2 of SENS_RES */ 545 UINT8 la_sel_info; /* Byte of SEL_RES */ 546 UINT8 la_nfcid1_len; /* NFCID1 (0, 4, 7 or 10 bytes) */ 547 UINT8 la_nfcid1[NCI_NFCID1_MAX_LEN]; /* if empty, NFCC will decide */ 548 549 /* 550 ** Discovery Configuration Parameters for Listen B 551 */ 552 BOOLEAN lb_enable; /* TRUE if listening B */ 553 UINT8 lb_sensb_info; /* Byte 2 of Protocol Info within SENSB_RES */ 554 UINT8 lb_nfcid0_len; /* NFCID0 (0, 1 or 4 bytes) */ 555 UINT8 lb_nfcid0[NFA_LB_MAX_NFCID0_LEN]; /* if empty, NFCC will decide */ 556 UINT8 lb_app_data[NCI_PARAM_LEN_LB_APPDATA];/* Bytes 6 - 9 in SENSB_RES */ 557 UINT8 lb_sfgi; /* Start-Up Frame Guard Time */ 558 UINT8 lb_adc_fo; /* Byte 12 in SENSB_RES */ 559 560 /* 561 ** Discovery Configuration Parameters for Listen F 562 */ 563 BOOLEAN lf_enable; /* TRUE if listening F */ 564 UINT8 lf_con_bitr_f; /* bit rate to listen */ 565 UINT8 lf_protocol_type; /* Supported Protocols */ 566 UINT16 lf_t3t_flags; /* bit field indicating which lf_t3t_identifier are enabled */ 567 UINT8 lf_t3t_identifier[NFA_LF_MAX_SC_NFCID2][NCI_SYSTEMCODE_LEN + NCI_NFCID2_LEN]; 568 /* System Code and NFCID2 */ 569 UINT8 lf_t3t_pmm[NCI_T3T_PMM_LEN]; /* Bytes 10 - 17 in SENSF_RES */ 570 571 /* 572 ** Discovery Configuration Parameters for Listen ISO-DEP 573 */ 574 BOOLEAN li_enable; /* TRUE if listening ISO-DEP */ 575 UINT8 li_fwi; /* Frame Waiting Time Integer */ 576 UINT8 la_hist_bytes_len; /* historical bytes for Listen-A */ 577 UINT8 la_hist_bytes[NFA_LA_MAX_HIST_BYTES]; 578 UINT8 lb_h_info_resp_len; /* higher layer response for Listen-B */ 579 UINT8 lb_h_info_resp[NFA_LB_MAX_H_INFO_LEN]; 580 581 /* 582 ** Discovery Configuration Parameters for Listen NFC-DEP 583 */ 584 BOOLEAN ln_enable; /* TRUE if listening NFC-DEP */ 585 UINT8 ln_wt; /* Waiting Time Integer */ 586 UINT8 ln_atr_res_gen_bytes_len; /* General bytes in ATR_RES */ 587 UINT8 ln_atr_res_gen_bytes[NCI_MAX_GEN_BYTES_LEN]; 588 UINT8 ln_atr_res_config; /* Optional parameters (PPt) in ATR_RES */ 589 } tNFA_LISTEN_CFG; 590 591 /* Data for NFA_UpdateRFCommParams () */ 592 typedef tNFC_RF_COMM_PARAMS tNFA_RF_COMM_PARAMS; 593 594 /* RF Interface type */ 595 #define NFA_INTERFACE_FRAME NFC_INTERFACE_FRAME 596 #define NFA_INTERFACE_ISO_DEP NFC_INTERFACE_ISO_DEP 597 #define NFA_INTERFACE_NFC_DEP NFC_INTERFACE_NFC_DEP 598 typedef tNFC_INTF_TYPE tNFA_INTF_TYPE; 599 600 /******************************************************************************* 601 ** NDEF Definitions 602 *******************************************************************************/ 603 604 /* Definitions for tNFA_TNF (NDEF type name format ID) */ 605 #define NFA_TNF_EMPTY NDEF_TNF_EMPTY /* Empty or no type specified */ 606 #define NFA_TNF_WKT NDEF_TNF_WKT /* NFC Forum well-known type [NFC RTD] */ 607 #define NFA_TNF_RFC2046_MEDIA NDEF_TNF_MEDIA /* Media-type as defined in RFC 2046 [RFC 2046] */ 608 #define NFA_TNF_RFC3986_URI NDEF_TNF_URI /* Absolute URI as defined in RFC 3986 [RFC 3986] */ 609 #define NFA_TNF_EXTERNAL NDEF_TNF_EXT /* NFC Forum external type [NFC RTD] */ 610 #define NFA_TNF_UNKNOWN NDEF_TNF_UNKNOWN /* Unknown */ 611 #define NFA_TNF_UNCHANGED NDEF_TNF_UNCHANGED /* Unchanged */ 612 #define NFA_TNF_RESERVED NDEF_TNF_RESERVED /* Reserved */ 613 #define NFA_TNF_DEFAULT 0xFF /* Used to register default NDEF type handler */ 614 typedef UINT8 tNFA_TNF; 615 616 /* Definitions for tNFA_NDEF_URI_ID (Frequently used prefixes. For additional values, see [NFC RTD URI] */ 617 #define NFA_NDEF_URI_ID_ABSOLUTE 0x00 /* Unabridged URI. */ 618 #define NFA_NDEF_URI_ID_HTTP 0x03 /* http:// */ 619 #define NFA_NDEF_URI_ID_HTTPS 0x04 /* https:// */ 620 #define NFA_NDEF_URI_ID_TEL 0x05 /* tel: */ 621 #define NFA_NDEF_URI_ID_MAILTO 0x06 /* mailto: */ 622 #define NFA_NDEF_URI_ID_FTP 0x0D /* ftp:// */ 623 #define NFA_NDEF_URI_ID_FILE 0x1D /* file:// */ 624 625 typedef UINT8 tNFA_NDEF_URI_ID; 626 627 /* Events for tNFA_NDEF_CBACK */ 628 #define NFA_NDEF_REGISTER_EVT 0 /* NDEF record type registered. (In response to NFA_RegisterNDefTypeHandler) */ 629 #define NFA_NDEF_DATA_EVT 1 /* Received an NDEF message with the registered type. See [tNFA_NDEF_DATA] */ 630 typedef UINT8 tNFA_NDEF_EVT; 631 632 /* Structure for NFA_NDEF_REGISTER_EVT event data */ 633 typedef struct 634 { 635 tNFA_STATUS status; /* Status of the registration */ 636 tNFA_HANDLE ndef_type_handle; /* Handle for this NDEF type registration. */ 637 } tNFA_NDEF_REGISTER; 638 639 /* Structure for NFA_NDEF_DATA_EVT event data */ 640 typedef struct 641 { 642 tNFA_HANDLE ndef_type_handle; /* Handle for NDEF type registration. */ 643 UINT8 *p_data; /* Data buffer */ 644 UINT32 len; /* Length of data */ 645 } tNFA_NDEF_DATA; 646 647 /* Union of all NDEF callback structures */ 648 typedef union 649 { 650 tNFA_NDEF_REGISTER ndef_reg; /* Structure for NFA_NDEF_REGISTER_EVT event data */ 651 tNFA_NDEF_DATA ndef_data; /* Structure for NFA_NDEF_DATA_EVT event data */ 652 } tNFA_NDEF_EVT_DATA; 653 654 /* NFA_NDEF callback */ 655 typedef void (tNFA_NDEF_CBACK) (tNFA_NDEF_EVT event, tNFA_NDEF_EVT_DATA *p_data); 656 657 /* NFA VSC Callback */ 658 typedef void (tNFA_VSC_CBACK)(UINT8 event, UINT16 param_len, UINT8 *p_param); 659 660 661 /***************************************************************************** 662 ** External Function Declarations 663 *****************************************************************************/ 664 #ifdef __cplusplus 665 extern "C" 666 { 667 #endif 668 669 /******************************************************************************* 670 ** 671 ** Function NFA_Init 672 ** 673 ** Description This function initializes control blocks for NFA 674 ** 675 ** p_hal_entry_tbl points to a table of HAL entry points 676 ** 677 ** NOTE: the buffer that p_hal_entry_tbl points must be 678 ** persistent until NFA is disabled. 679 ** 680 ** 681 ** Returns none 682 ** 683 *******************************************************************************/ 684 NFC_API extern void NFA_Init (tHAL_NFC_ENTRY *p_hal_entry_tbl); 685 686 /******************************************************************************* 687 ** 688 ** Function NFA_Enable 689 ** 690 ** Description This function enables NFC. Prior to calling NFA_Enable, 691 ** the NFCC must be powered up, and ready to receive commands. 692 ** This function enables the tasks needed by NFC, opens the NCI 693 ** transport, resets the NFC controller, downloads patches to 694 ** the NFCC (if necessary), and initializes the NFC subsystems. 695 ** 696 ** This function should only be called once - typically when NFC 697 ** is enabled during boot-up, or when NFC is enabled from a 698 ** settings UI. Subsequent calls to NFA_Enable while NFA is 699 ** enabling or enabled will be ignored. When the NFC startup 700 ** procedure is completed, an NFA_DM_ENABLE_EVT is returned to the 701 ** application using the tNFA_DM_CBACK. 702 ** 703 ** The tNFA_CONN_CBACK parameter is used to register a callback 704 ** for polling, p2p and card emulation events. 705 ** 706 ** 707 ** Returns NFA_STATUS_OK if successfully initiated 708 ** NFA_STATUS_FAILED otherwise 709 ** 710 *******************************************************************************/ 711 NFC_API extern tNFA_STATUS NFA_Enable (tNFA_DM_CBACK *p_dm_cback, 712 tNFA_CONN_CBACK *p_conn_cback); 713 714 /******************************************************************************* 715 ** 716 ** Function NFA_Disable 717 ** 718 ** Description This function is called to shutdown NFC. The tasks for NFC 719 ** are terminated, and clean up routines are performed. This 720 ** function is typically called during platform shut-down, or 721 ** when NFC is disabled from a settings UI. When the NFC 722 ** shutdown procedure is completed, an NFA_DM_DISABLE_EVT is 723 ** returned to the application using the tNFA_DM_CBACK. 724 ** 725 ** The platform should wait until the NFC_DISABLE_REVT is 726 ** received before powering down the NFC chip and NCI transport. 727 ** This is required to so that NFA can gracefully shut down any 728 ** open connections. 729 ** 730 ** Returns NFA_STATUS_OK if successfully initiated 731 ** NFA_STATUS_FAILED otherwise 732 ** 733 *******************************************************************************/ 734 NFC_API extern tNFA_STATUS NFA_Disable (BOOLEAN graceful); 735 736 /******************************************************************************* 737 ** 738 ** Function NFA_SetConfig 739 ** 740 ** Description Set the configuration parameters to NFCC. The result is 741 ** reported with an NFA_DM_SET_CONFIG_EVT in the tNFA_DM_CBACK 742 ** callback. 743 ** 744 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 745 ** should happen before calling this function. Most Configuration 746 ** parameters are related to RF discovery. 747 ** 748 ** Returns NFA_STATUS_OK if successfully initiated 749 ** NFA_STATUS_BUSY if previous setting is on-going 750 ** NFA_STATUS_FAILED otherwise 751 ** 752 *******************************************************************************/ 753 NFC_API extern tNFA_STATUS NFA_SetConfig (tNFA_PMID param_id, 754 UINT8 length, 755 UINT8 *p_data); 756 757 /******************************************************************************* 758 ** 759 ** Function NFA_GetConfig 760 ** 761 ** Description Get the configuration parameters from NFCC. The result is 762 ** reported with an NFA_DM_GET_CONFIG_EVT in the tNFA_DM_CBACK 763 ** callback. 764 ** 765 ** Returns NFA_STATUS_OK if successfully initiated 766 ** NFA_STATUS_FAILED otherwise 767 ** 768 *******************************************************************************/ 769 NFC_API extern tNFA_STATUS NFA_GetConfig (UINT8 num_ids, tNFA_PMID *p_param_ids); 770 771 /******************************************************************************* 772 ** 773 ** Function NFA_RequestExclusiveRfControl 774 ** 775 ** Description Request exclusive control of NFC. 776 ** - Previous behavior (polling/tag reading, DH card emulation) 777 ** will be suspended . 778 ** - Polling and listening will be done based on the specified 779 ** params 780 ** 781 ** The NFA_EXCLUSIVE_RF_CONTROL_STARTED_EVT event of 782 ** tNFA_CONN_CBACK indicates the status of the operation. 783 ** 784 ** NFA_ACTIVATED_EVT and NFA_DEACTIVATED_EVT indicates link 785 ** activation/deactivation. 786 ** 787 ** NFA_SendRawFrame is used to send data to the peer. NFA_DATA_EVT 788 ** indicates data from the peer. 789 ** 790 ** If a tag is activated, then the NFA_RW APIs may be used to 791 ** send commands to the tag. Incoming NDEF messages are sent to 792 ** the NDEF callback. 793 ** 794 ** Once exclusive RF control has started, NFA will not activate 795 ** LLCP internally. The application has exclusive control of 796 ** the link. 797 ** 798 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 799 ** should happen before calling this function 800 ** 801 ** Returns NFA_STATUS_OK if successfully initiated 802 ** NFA_STATUS_FAILED otherwise 803 ** 804 *******************************************************************************/ 805 NFC_API extern tNFA_STATUS NFA_RequestExclusiveRfControl (tNFA_TECHNOLOGY_MASK poll_mask, 806 tNFA_LISTEN_CFG *p_listen_cfg, 807 tNFA_CONN_CBACK *p_conn_cback, 808 tNFA_NDEF_CBACK *p_ndef_cback); 809 810 /******************************************************************************* 811 ** 812 ** Function NFA_ReleaseExclusiveRfControl 813 ** 814 ** Description Release exclusive control of NFC. Once released, behavior 815 ** prior to obtaining exclusive RF control will resume. 816 ** 817 Note?? 818 ** Returns NFA_STATUS_OK if successfully initiated 819 ** NFA_STATUS_FAILED otherwise 820 ** 821 *******************************************************************************/ 822 NFC_API extern tNFA_STATUS NFA_ReleaseExclusiveRfControl (void); 823 824 /******************************************************************************* 825 ** 826 ** Function NFA_EnablePolling 827 ** 828 ** Description Enable polling for technologies specified by poll_mask. 829 ** 830 ** The following events (notified using the connection 831 ** callback registered with NFA_Enable) are generated during 832 ** polling: 833 ** 834 ** - NFA_POLL_ENABLED_EVT indicates whether or not polling 835 ** successfully enabled. 836 ** - NFA_DISC_RESULT_EVT indicates there are more than one devices, 837 ** so application must select one of tags by calling NFA_Select(). 838 ** - NFA_SELECT_RESULT_EVT indicates whether previous selection was 839 ** successful or not. If it was failed then application must select 840 ** again or deactivate by calling NFA_Deactivate(). 841 ** - NFA_ACTIVATED_EVT is generated when an NFC link is activated. 842 ** - NFA_NDEF_DETECT_EVT is generated if tag is activated 843 ** - NFA_LLCP_ACTIVATED_EVT/NFA_LLCP_DEACTIVATED_EVT is generated 844 ** if NFC-DEP is activated 845 ** - NFA_DEACTIVATED_EVT will be returned after deactivating NFC link. 846 ** 847 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 848 ** should happen before calling this function 849 ** 850 ** Returns NFA_STATUS_OK if successfully initiated 851 ** NFA_STATUS_FAILED otherwise 852 ** 853 *******************************************************************************/ 854 NFC_API extern tNFA_STATUS NFA_EnablePolling (tNFA_TECHNOLOGY_MASK poll_mask); 855 856 /******************************************************************************* 857 ** 858 ** Function NFA_DisablePolling 859 ** 860 ** Description Disable polling 861 ** NFA_POLL_DISABLED_EVT will be returned after stopping polling. 862 ** 863 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 864 ** should happen before calling this function 865 ** 866 ** Returns NFA_STATUS_OK if successfully initiated 867 ** NFA_STATUS_FAILED otherwise 868 ** 869 *******************************************************************************/ 870 NFC_API extern tNFA_STATUS NFA_DisablePolling (void); 871 872 /******************************************************************************* 873 ** 874 ** Function NFA_EnableListening 875 ** 876 ** Description Enable listening. 877 ** NFA_LISTEN_ENABLED_EVT will be returned after listening is allowed. 878 ** 879 ** The actual listening technologies are specified by other NFA 880 ** API functions. Such functions include (but not limited to) 881 ** NFA_CeConfigureUiccListenTech. 882 ** If NFA_DisableListening () is called to ignore the listening technologies, 883 ** NFA_EnableListening () is called to restore the listening technologies 884 ** set by these functions. 885 ** 886 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 887 ** should happen before calling this function 888 ** 889 ** Returns NFA_STATUS_OK if successfully initiated 890 ** NFA_STATUS_FAILED otherwise 891 ** 892 *******************************************************************************/ 893 NFC_API extern tNFA_STATUS NFA_EnableListening (void); 894 895 /******************************************************************************* 896 ** 897 ** Function NFA_DisableListening 898 ** 899 ** Description Disable listening 900 ** NFA_LISTEN_DISABLED_EVT will be returned after stopping listening. 901 ** This function is called to exclude listen at RF discovery. 902 ** 903 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 904 ** should happen before calling this function 905 ** 906 ** Returns NFA_STATUS_OK if successfully initiated 907 ** NFA_STATUS_FAILED otherwise 908 ** 909 *******************************************************************************/ 910 NFC_API extern tNFA_STATUS NFA_DisableListening (void); 911 912 /******************************************************************************* 913 ** 914 ** Function NFA_PauseP2p 915 ** 916 ** Description Pause P2P services. 917 ** NFA_P2P_PAUSED_EVT will be returned after P2P services are 918 ** disabled. 919 ** 920 ** The P2P services enabled by NFA_P2p* API functions are not 921 ** available. NFA_ResumeP2p() is called to resume the P2P 922 ** services. 923 ** 924 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 925 ** should happen before calling this function 926 ** 927 ** Returns NFA_STATUS_OK if successfully initiated 928 ** NFA_STATUS_FAILED otherwise 929 ** 930 *******************************************************************************/ 931 NFC_API extern tNFA_STATUS NFA_PauseP2p (void); 932 933 /******************************************************************************* 934 ** 935 ** Function NFA_ResumeP2p 936 ** 937 ** Description Resume P2P services. 938 ** NFA_P2P_RESUMED_EVT will be returned after P2P services are. 939 ** enables again. 940 ** 941 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 942 ** should happen before calling this function 943 ** 944 ** Returns NFA_STATUS_OK if successfully initiated 945 ** NFA_STATUS_FAILED otherwise 946 ** 947 *******************************************************************************/ 948 NFC_API extern tNFA_STATUS NFA_ResumeP2p (void); 949 950 /******************************************************************************* 951 ** 952 ** Function NFA_SetP2pListenTech 953 ** 954 ** Description This function is called to set listen technology for NFC-DEP. 955 ** This funtion may be called before or after starting any server 956 ** on NFA P2P/CHO/SNEP. 957 ** If there is no technology for NFC-DEP, P2P listening will be 958 ** stopped. 959 ** 960 ** NFA_SET_P2P_LISTEN_TECH_EVT without data will be returned. 961 ** 962 ** Note: If RF discovery is started, NFA_StopRfDiscovery()/NFA_RF_DISCOVERY_STOPPED_EVT 963 ** should happen before calling this function 964 ** 965 ** Returns NFA_STATUS_OK if successfully initiated 966 ** NFA_STATUS_FAILED otherwise 967 ** 968 *******************************************************************************/ 969 NFC_API extern tNFA_STATUS NFA_SetP2pListenTech (tNFA_TECHNOLOGY_MASK tech_mask); 970 971 /******************************************************************************* 972 ** 973 ** Function NFA_StartRfDiscovery 974 ** 975 ** Description Start RF discovery 976 ** RF discovery parameters shall be set by other APIs. 977 ** 978 ** An NFA_RF_DISCOVERY_STARTED_EVT indicates whether starting was successful or not. 979 ** 980 ** Returns NFA_STATUS_OK if successfully initiated 981 ** NFA_STATUS_FAILED otherwise 982 ** 983 *******************************************************************************/ 984 NFC_API extern tNFA_STATUS NFA_StartRfDiscovery (void); 985 986 /******************************************************************************* 987 ** 988 ** Function NFA_StopRfDiscovery 989 ** 990 ** Description Stop RF discovery 991 ** 992 ** An NFA_RF_DISCOVERY_STOPPED_EVT indicates whether stopping was successful or not. 993 ** 994 ** Returns NFA_STATUS_OK if successfully initiated 995 ** NFA_STATUS_FAILED otherwise 996 ** 997 *******************************************************************************/ 998 NFC_API extern tNFA_STATUS NFA_StopRfDiscovery (void); 999 1000 /******************************************************************************* 1001 ** 1002 ** Function NFA_SetRfDiscoveryDuration 1003 ** 1004 ** Description Set the duration of the single discovery period in [ms]. 1005 ** Allowable range: 0 ms to 0xFFFF ms. 1006 ** 1007 ** Note: If discovery is already started, the application should 1008 ** call NFA_StopRfDiscovery prior to calling 1009 ** NFA_SetRfDiscoveryDuration, and then call 1010 ** NFA_StartRfDiscovery afterwards to restart discovery using 1011 ** the new duration. 1012 ** 1013 ** Returns: 1014 ** NFA_STATUS_OK, if command accepted 1015 ** NFA_STATUS_FAILED: otherwise 1016 ** 1017 *******************************************************************************/ 1018 NFC_API extern tNFA_STATUS NFA_SetRfDiscoveryDuration (UINT16 discovery_period_ms); 1019 1020 /******************************************************************************* 1021 ** 1022 ** Function NFA_Select 1023 ** 1024 ** Description Select one from detected devices by NFA_DISC_RESULT_EVT after the 1025 ** last discovery result is received. 1026 ** An NFA_SELECT_RESULT_EVT indicates whether selection was successful or not. 1027 ** If failed then application must select again or deactivate by NFA_Deactivate (). 1028 ** 1029 ** Returns NFA_STATUS_OK if successfully initiated 1030 ** NFA_STATUS_INVALID_PARAM if RF interface is not matched protocol 1031 ** NFA_STATUS_FAILED otherwise 1032 ** 1033 *******************************************************************************/ 1034 NFC_API extern tNFA_STATUS NFA_Select (UINT8 rf_disc_id, 1035 tNFA_NFC_PROTOCOL protocol, 1036 tNFA_INTF_TYPE rf_interface); 1037 1038 /******************************************************************************* 1039 ** 1040 ** Function NFA_UpdateRFCommParams 1041 ** 1042 ** Description This function is called to update RF Communication parameters 1043 ** once the Frame RF Interface has been activated. 1044 ** 1045 ** An NFA_UPDATE_RF_PARAM_RESULT_EVT indicates whether updating 1046 ** was successful or not. 1047 ** 1048 ** Returns NFA_STATUS_OK if successfully initiated 1049 ** NFA_STATUS_FAILED otherwise 1050 ** 1051 *******************************************************************************/ 1052 NFC_API extern tNFA_STATUS NFA_UpdateRFCommParams (tNFA_RF_COMM_PARAMS *p_params); 1053 1054 /******************************************************************************* 1055 ** 1056 ** Function NFA_Deactivate 1057 ** 1058 ** Description 1059 ** If sleep_mode=TRUE: 1060 ** Deselect the activated device by deactivating into sleep mode. 1061 ** 1062 ** An NFA_DEACTIVATE_FAIL_EVT indicates that selection was not successful. 1063 ** Application can select another discovered device or deactivate by NFA_Deactivate () 1064 ** after receiving NFA_DEACTIVATED_EVT. 1065 ** 1066 ** Deactivating to sleep mode is not allowed when NFCC is in wait-for-host-select 1067 ** mode, or in listen-sleep states; NFA will deactivate to idle or discovery state 1068 ** for these cases respectively. 1069 ** 1070 ** 1071 ** If sleep_mode=FALSE: 1072 ** Deactivate the connection (e.g. as a result of presence check failure) 1073 ** NFA_DEACTIVATED_EVT will indicate that link is deactivated. 1074 ** Polling/listening will resume (unless the nfcc is in wait_for-all-discoveries state) 1075 ** 1076 ** 1077 ** Returns NFA_STATUS_OK if successfully initiated 1078 ** NFA_STATUS_FAILED otherwise 1079 ** 1080 *******************************************************************************/ 1081 NFC_API extern tNFA_STATUS NFA_Deactivate (BOOLEAN sleep_mode); 1082 1083 /******************************************************************************* 1084 ** 1085 ** Function NFA_SendRawFrame 1086 ** 1087 ** Description Send a raw frame over the activated interface with the NFCC. 1088 ** This function can only be called after NFC link is activated. 1089 ** 1090 ** If the activated interface is a tag and auto-presence check is 1091 ** enabled then presence_check_start_delay can be used to indicate 1092 ** the delay in msec after which the next auto presence check 1093 ** command can be sent. NFA_DM_DEFAULT_PRESENCE_CHECK_START_DELAY 1094 ** can be used as the default value for the delay. 1095 ** 1096 ** Returns NFA_STATUS_OK if successfully initiated 1097 ** NFA_STATUS_FAILED otherwise 1098 ** 1099 *******************************************************************************/ 1100 NFC_API extern tNFA_STATUS NFA_SendRawFrame (UINT8 *p_raw_data, 1101 UINT16 data_len, 1102 UINT16 presence_check_start_delay); 1103 1104 /******************************************************************************* 1105 ** NDEF APIs 1106 *******************************************************************************/ 1107 1108 /******************************************************************************* 1109 ** 1110 ** Function NFA_RegisterNDefTypeHandler 1111 ** 1112 ** Description This function allows the applications to register for 1113 ** specific types of NDEF records. When NDEF records are 1114 ** received, NFA will parse the record-type field, and pass 1115 ** the record to the registered tNFA_NDEF_CBACK. 1116 ** 1117 ** For records types which were not registered, the record will 1118 ** be sent to the default handler. A default type-handler may 1119 ** be registered by calling this NFA_RegisterNDefTypeHandler 1120 ** with tnf=NFA_TNF_DEFAULT. In this case, all un-registered 1121 ** record types will be sent to the callback. Only one default 1122 ** handler may be registered at a time. 1123 ** 1124 ** An NFA_NDEF_REGISTER_EVT will be sent to the tNFA_NDEF_CBACK 1125 ** to indicate that registration was successful, and provide a 1126 ** handle for this record type. 1127 ** 1128 ** 1129 ** Returns NFA_STATUS_OK if successfully initiated 1130 ** NFA_STATUS_FAILED otherwise 1131 ** 1132 *******************************************************************************/ 1133 NFC_API extern tNFA_STATUS NFA_RegisterNDefTypeHandler (BOOLEAN handle_whole_message, 1134 tNFA_TNF tnf, 1135 UINT8 *p_type_name, 1136 UINT8 type_name_len, 1137 tNFA_NDEF_CBACK *p_ndef_cback); 1138 1139 /******************************************************************************* 1140 ** 1141 ** Function NFA_RegisterNDefUriHandler 1142 ** 1143 ** Description This API is a special-case of NFA_RegisterNDefTypeHandler 1144 ** with TNF=NFA_TNF_WKT, and type_name='U' (URI record); and allows 1145 ** registering for specific URI types (e.g. 'tel:' or 'mailto:'). 1146 ** 1147 ** An NFA_NDEF_REGISTER_EVT will be sent to the tNFA_NDEF_CBACK 1148 ** to indicate that registration was successful, and provide a 1149 ** handle for this registration. 1150 ** 1151 ** If uri_id=NFA_NDEF_URI_ID_ABSOLUTE, then p_abs_uri contains the 1152 ** unabridged URI. For all other uri_id values, the p_abs_uri 1153 ** parameter is ignored (i.e the URI prefix is implied by uri_id). 1154 ** See [NFC RTD URI] for more information. 1155 ** 1156 ** Returns NFA_STATUS_OK if successfully initiated 1157 ** NFA_STATUS_FAILED otherwise 1158 ** 1159 *******************************************************************************/ 1160 NFC_API extern tNFA_STATUS NFA_RegisterNDefUriHandler (BOOLEAN handle_whole_message, 1161 tNFA_NDEF_URI_ID uri_id, 1162 UINT8 *p_abs_uri, 1163 UINT8 uri_id_len, 1164 tNFA_NDEF_CBACK *p_ndef_cback); 1165 1166 1167 /******************************************************************************* 1168 ** 1169 ** Function NFA_DeregisterNDefTypeHandler 1170 ** 1171 ** Description Deregister NDEF record type handler. 1172 ** 1173 ** Returns NFA_STATUS_OK if successfully initiated 1174 ** NFA_STATUS_FAILED otherwise 1175 ** 1176 *******************************************************************************/ 1177 NFC_API extern tNFA_STATUS NFA_DeregisterNDefTypeHandler (tNFA_HANDLE ndef_type_handle); 1178 1179 1180 /******************************************************************************* 1181 ** 1182 ** Function NFA_PowerOffSleepMode 1183 ** 1184 ** Description This function is called to enter or leave NFCC Power Off Sleep mode 1185 ** NFA_DM_PWR_MODE_CHANGE_EVT will be sent to indicate status. 1186 ** 1187 ** start_stop : TRUE if entering Power Off Sleep mode 1188 ** FALSE if leaving Power Off Sleep mode 1189 ** 1190 Note?? 1191 ** Returns NFA_STATUS_OK if successfully initiated 1192 ** NFA_STATUS_FAILED otherwise 1193 ** 1194 *******************************************************************************/ 1195 NFC_API extern tNFA_STATUS NFA_PowerOffSleepMode (BOOLEAN start_stop); 1196 1197 /******************************************************************************* 1198 ** 1199 ** Function NFA_RegVSCback 1200 ** 1201 ** Description This function is called to register or de-register a callback 1202 ** function to receive Proprietary NCI response and notification 1203 ** events. 1204 ** The maximum number of callback functions allowed is NFC_NUM_VS_CBACKS 1205 ** 1206 ** Returns tNFC_STATUS 1207 ** 1208 *******************************************************************************/ 1209 NFC_API extern tNFC_STATUS NFA_RegVSCback (BOOLEAN is_register, 1210 tNFA_VSC_CBACK *p_cback); 1211 1212 /******************************************************************************* 1213 ** 1214 ** Function NFA_SendVsCommand 1215 ** 1216 ** Description This function is called to send an NCI Vendor Specific 1217 ** command to NFCC. 1218 ** 1219 ** oid - The opcode of the VS command. 1220 ** cmd_params_len - The command parameter len 1221 ** p_cmd_params - The command parameter 1222 ** p_cback - The callback function to receive the command 1223 ** status 1224 ** 1225 ** Returns NFA_STATUS_OK if successfully initiated 1226 ** NFA_STATUS_FAILED otherwise 1227 ** 1228 *******************************************************************************/ 1229 NFC_API extern tNFA_STATUS NFA_SendVsCommand (UINT8 oid, 1230 UINT8 cmd_params_len, 1231 UINT8 *p_cmd_params, 1232 tNFA_VSC_CBACK *p_cback); 1233 1234 /******************************************************************************* 1235 ** 1236 ** Function NFA_SetTraceLevel 1237 ** 1238 ** Description This function sets the trace level for NFA. If called with 1239 ** a value of 0xFF, it simply returns the current trace level. 1240 ** 1241 ** Returns The new or current trace level 1242 ** 1243 *******************************************************************************/ 1244 NFC_API extern UINT8 NFA_SetTraceLevel (UINT8 new_level); 1245 1246 1247 #ifdef __cplusplus 1248 } 1249 #endif 1250 1251 #endif /* NFA_API_H */ 1252 1253
