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