nfc.h

Go to the documentation of this file.

#pragma once
#include <wut.h>
#include <vpadbase/base.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int32_t NFCError;
typedef uint8_t NFCProtocol;
typedef uint8_t NFCTechnology;
typedef uint8_t NFCTechnologyMask;
typedef uint8_t NFCNDEFFlags;
typedef struct NFCUid NFCUid;
typedef struct NFCTagInfo NFCTagInfo;
typedef struct NFCNTAGVersion NFCNTAGVersion;
typedef struct NFCReadT2TResult NFCReadT2TResult;
 
typedef enum NFCMode
{
 NFC_MODE_INVALID = -1,
 NFC_MODE_IDLE = 0,
 NFC_MODE_ACTIVE = 1,
} NFCMode;
 
typedef enum NFCProtocolEnum
{
 NFC_PROTOCOL_UNKNOWN = 0x00,
 NFC_PROTOCOL_T1T = 0x01,
 NFC_PROTOCOL_T2T = 0x02,
 NFC_PROTOCOL_T3T = 0x03,
 NFC_PROTOCOL_ISO_DEP = 0x04,
 NFC_PROTOCOL_15693 = 0x83,
} NFCProtocolEnum;
 
typedef enum NFCTechnologyEnum
{
 NFC_TECHNOLOGY_A = 0x00,
 NFC_TECHNOLOGY_B = 0x01,
 NFC_TECHNOLOGY_F = 0x02,
 NFC_TECHNOLOGY_ISO15693 = 0x06,
} NFCTechnologyEnum;
 
typedef enum NFCTechnologyMaskEnum
{
 NFC_TECHNOLOGY_MASK_ALL = 0,
 NFC_TECHNOLOGY_MASK_A = (1 << 0),
 NFC_TECHNOLOGY_MASK_B = (1 << 1),
 NFC_TECHNOLOGY_MASK_F = (1 << 2),
 NFC_TECHNOLOGY_MASK_ISO15693 = (1 << 3),
} NFCTechnologyMaskEnum;
 
typedef enum NFCNDEFFlagsEnum
{
 NFC_NDEF_FLAG_READ_ONLY = (1 << 0),
 NFC_NDEF_FLAG_FORMATED = (1 << 1),
 NFC_NDEF_FLAG_SUPPORTED = (1 << 2),
 NFC_NDEF_FLAG_UNKNOWN = (1 << 3),
 NFC_NDEF_FLAG_FORMATABLE = (1 << 4),
 NFC_NDEF_FLAG_SOFT_LOCKABLE = (1 << 5),
 NFC_NDEF_FLAG_HARD_LOCKABLE = (1 << 6),
 NFC_NDEF_FLAG_OTP = (1 << 7),
} NFCNDEFFlagsEnum;
 
struct NFCUid
{
 uint8_t uid[7];
};
WUT_CHECK_OFFSET(NFCUid, 0x00, uid);
WUT_CHECK_SIZE(NFCUid, 0x07);
 
struct NFCTagInfo
{
 uint8_t uidSize;
 uint8_t uid[10];
 NFCTechnology technology;
 NFCProtocol protocol;
 WUT_PADDING_BYTES(0x20); // reserved
};
WUT_CHECK_OFFSET(NFCTagInfo, 0x00, uidSize);
WUT_CHECK_OFFSET(NFCTagInfo, 0x01, uid);
WUT_CHECK_OFFSET(NFCTagInfo, 0x0B, technology);
WUT_CHECK_OFFSET(NFCTagInfo, 0x0C, protocol);
WUT_CHECK_SIZE(NFCTagInfo, 0x2D);
 
// GET_VERSION response for NTAG213, NTAG215 and NTAG216
struct NFCNTAGVersion
{
 uint8_t header;
 uint8_t vendorId;
 uint8_t productType;
 uint8_t productSubtype;
 uint8_t majorProductVersion;
 uint8_t minorProductversion;
 uint8_t storageSize;
 uint8_t protocolType;
};
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x00, header);
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x01, vendorId);
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x02, productType);
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x03, productSubtype);
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x04, majorProductVersion);
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x05, minorProductversion);
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x06, storageSize);
WUT_CHECK_OFFSET(NFCNTAGVersion, 0x07, protocolType);
WUT_CHECK_SIZE(NFCNTAGVersion, 0x08);
 
struct NFCReadT2TResult
{
 uint8_t numReads;
 uint8_t read0Start;
 uint8_t read0End;
 uint8_t read1Start;
 uint8_t read1End;
 uint8_t read2Start;
 uint8_t read2End;
 uint8_t read3Start;
 uint8_t read3End;
 uint8_t data[0x3A0];
};
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x00, numReads);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x01, read0Start);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x02, read0End);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x03, read1Start);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x04, read1End);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x05, read2Start);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x06, read2End);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x07, read3Start);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x08, read3End);
WUT_CHECK_OFFSET(NFCReadT2TResult, 0x09, data);
WUT_CHECK_SIZE(NFCReadT2TResult, 0x3A9);
 
typedef void
(*NFCCallbackFn)(VPADChan chan,
 NFCError error,
 void *userContext);
 
typedef void
(*NFCTagDetectCallbackFn)(VPADChan chan,
 BOOL hasTag,
 void *userContext);
 
typedef void
(*NFCDetectCallbackFn)(VPADChan chan,
 NFCError error,
 NFCUid *uid,
 BOOL readOnly,
 BOOL hasLockedData,
 NFCNDEFFlags flags,
 void *userContext);
 
typedef void
(*NFCRawDataCallbackFn)(VPADChan chan,
 NFCError error,
 uint32_t responseSize,
 void *responseData,
 void *userContext);
 
typedef void
(*NFCRawDataTwiceCallbackFn)(VPADChan chan,
 NFCError error,
 uint8_t numCompleted,
 uint32_t response0Size,
 void *response0Data,
 uint32_t response1Size,
 void *response1Data,
 void *userContext);
 
typedef void
(*NFCReadCallbackFn)(VPADChan chan,
 NFCError error,
 NFCUid *uid,
 BOOL readOnly,
 uint32_t dataSize,
 void *data,
 uint32_t lockedDataSize,
 void *lockedData,
 void *userContext);
 
typedef void
(*NFCReadT2TCallbackFn)(VPADChan chan,
 NFCError error,
 uint8_t rfDiscId,
 NFCProtocol protocol,
 NFCTechnology technology,
 uint8_t uidSize,
 uint8_t *uid,
 NFCNTAGVersion *version,
 NFCReadT2TResult *result,
 void *userContext);
 
typedef void
(*NFCGetTagInfoCallbackFn)(VPADChan chan,
 NFCError error,
 NFCTagInfo *tagInfo,
 void *userContext);
 
typedef void
(*NFCGetTagInfoMultiCallbackFn)(VPADChan chan,
 NFCError error,
 uint8_t numTagInfos,
 NFCTagInfo *tagInfo0,
 NFCTagInfo *tagInfo1,
 NFCTagInfo *tagInfo2,
 void *userContext);
 
NFCError
NFCInit(VPADChan chan);
 
NFCError
NFCInitEx(VPADChan chan,
 uint32_t powerMode);
 
NFCError
NFCShutdown(VPADChan chan);
 
BOOL
NFCIsInit(VPADChan chan);
 
void
NFCProc(VPADChan chan);
 
void
NFCSetTagDetectCallback(VPADChan chan,
 NFCTagDetectCallbackFn callback,
 void *userContext);
 
NFCMode
NFCGetMode(VPADChan chan);
 
NFCError
NFCSetMode(VPADChan chan,
 NFCMode mode);
 
NFCError
NFCAbort(VPADChan chan,
 NFCCallbackFn callback,
 void *userContext);
 
NFCError
NFCAntennaCheck(VPADChan chan,
 NFCCallbackFn callback,
 void *userContext);
 
NFCError
NFCDetect(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCDetectCallbackFn callback,
 void *userContext);
 
NFCError
NFCSetLockBitsForT1T(VPADChan chan,
 uint8_t numBlocks,
 NFCRawDataCallbackFn callback,
 void *userContext);
 
NFCError
NFCRead(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCUid *uid,
 NFCUid *uidMask,
 NFCReadCallbackFn callback,
 void *userContext);
 
NFCError
NFCWrite(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCUid *uid,
 NFCUid *uidMask,
 uint32_t size,
 void *data,
 NFCCallbackFn callback,
 void *userContext);
 
NFCError
NFCSendRawData(VPADChan chan,
 BOOL startDiscovery,
 uint32_t discoveryTimeout,
 uint32_t commandTimeout,
 uint32_t commandSize,
 uint32_t responseSize,
 void *commandData,
 NFCRawDataCallbackFn callback,
 void *userContext);
 
NFCError
NFCSendRawDataEx(VPADChan chan,
 BOOL startDiscovery,
 uint32_t discoveryTimeout,
 uint32_t commandTimeout,
 uint32_t commandSize,
 uint32_t responseSize,
 void *commandData,
 BOOL disableCRC,
 NFCRawDataCallbackFn callback,
 void *userContext);
 
NFCError
NFCSendRawDataEx2(VPADChan chan,
 BOOL startDiscovery,
 uint32_t discoveryTimeout,
 uint32_t commandTimeout,
 uint32_t commandSize,
 uint32_t responseSize,
 void *commandData,
 BOOL disableCRC,
 NFCTechnologyMask techMask,
 NFCRawDataCallbackFn callback,
 void *userContext);
 
NFCError
NFCSendRawDataWithPrePolling(VPADChan chan,
 BOOL startDiscovery,
 uint32_t discoveryTimeout,
 uint32_t commandTimeout,
 uint32_t commandSize,
 uint32_t responseSize,
 void *commandData,
 NFCRawDataCallbackFn callback,
 void *userContext);
 
NFCError
NFCSendRawDataWithPrePollingEx(VPADChan chan,
 BOOL startDiscovery,
 uint32_t discoveryTimeout,
 uint32_t commandTimeout,
 uint32_t commandSize,
 uint32_t responseSize,
 void *commandData,
 NFCRawDataCallbackFn callback,
 void *userContext);
 
NFCError
NFCSendRawDataTwice(VPADChan chan,
 uint32_t command0Timeout,
 uint32_t command0Size,
 uint32_t response0Size,
 void *command0Data,
 uint32_t command1Timeout,
 uint32_t command1Size,
 uint32_t response1Size,
 void *command1Data,
 NFCRawDataTwiceCallbackFn callback,
 void *userContext);
 
NFCError
NFCFormat(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCUid *uid,
 NFCUid *uidMask,
 NFCCallbackFn callback,
 void *userContext);
 
NFCError
NFCGetTagInfo(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCGetTagInfoCallbackFn callback,
 void *userContext);
 
NFCError
NFCGetTagInfoMulti(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCGetTagInfoMultiCallbackFn callback,
 void *userContext);
 
NFCError
NFCIsTagPresent(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCUid *uid,
 NFCUid *uidMask,
 NFCCallbackFn callback,
 void *userContext);
 
NFCError
NFCSetReadOnly(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCUid *uid,
 NFCUid *uidMask,
 BOOL readOnly,
 NFCCallbackFn callback,
 void *userContext);
 
NFCError
NFCReadT2T(VPADChan chan,
 uint32_t discoveryTimeout,
 NFCUid *uid,
 NFCUid *uidMask,
 NFCNTAGVersion *version,
 uint32_t commandTimeout,
 uint8_t numReads,
 uint8_t read0Start, uint8_t read0End,
 uint8_t read1Start, uint8_t read1End,
 uint8_t read2Start, uint8_t read2End,
 uint8_t read3Start, uint8_t read3End,
 uint8_t authenticate,
 NFCReadT2TCallbackFn callback,
 void *userContext);
 
NFCError
NFCWriteT2T(VPADChan chan,
 uint16_t discoveryTimeout,
 NFCUid *uid,
 NFCUid *uidMask,
 NFCNTAGVersion *version,
 uint32_t commandTimeout,
 uint8_t numWrites,
 uint8_t write0Start, uint8_t write0Size, void *write0Data,
 uint8_t write1Start, uint8_t write1Size, void *write1Data,
 uint8_t write2Start, uint8_t write2Size, void *write2Data,
 uint8_t write3Start, uint8_t write3Size, void *write3Data,
 uint8_t activationStart, uint32_t *deactivationData, uint32_t *activationData,
 uint8_t authenticate, uint8_t activate,
 NFCCallbackFn callback,
 void *userContext);
 
void
NFCGetUIDFromActivationEventData(void *data,
 NFCProtocol *outProtocol,
 NFCTechnology *outTechnology,
 uint8_t *outUidSize,
 uint8_t *outUid);
 
NFCError
__NFCSystemAbort(VPADChan chan);
 
#ifdef __cplusplus
}
#endif