ptxNDEF_T2TOP.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_NDEF_OP_T2T_H_
#define APIS_PTX_NDEF_OP_T2T_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include <stdint.h>
#include "ptxNativeTag_T2T.h"
#include "ptxNDEF_Defines.h"
#include "ptxStatus.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
#define PTX_T2T_DEFAULT_TIMEOUT_MS          (uint32_t)100   
#define PTX_T2T_SUPPORTED_VERSION           (uint8_t)0x11   
#define PTX_T2TOP_MAX_NUMBER_LOCK_CONTROL   (uint8_t)3u     
#define PTX_T2TOP_MAX_NUMBER_MEMORY_CONTROL (uint8_t)3u     
#define PTX_T2TOP_MAX_NUMBER_NDEFTLVS       (uint8_t)3u     
#define PTX_T2TOP_INTERNAL_BYTES_LENGTH     (uint8_t)10u    
/*
 * ####################################################################################################################
 * TYPES
 * ####################################################################################################################
 */
 
typedef enum ptxNDEF_T2TOP_ReadCCVariant
{
    ReadCCVariant_Block_3_Default,                              
    ReadCCVariant_Block_0,                                      
} ptxNDEF_T2TOP_ReadCCVariant_t;
 
 
typedef struct ptxNDEF_T2TOP_InitParams
{
    ptxNativeTag_T2T_InitParams_t        T2TInitParams;         
    uint8_t                              *WorkBuffer;           
    uint8_t                              *RxBuffer;             
    size_t                               WorkBufferSize;        
    size_t                               RxBufferSize;          
    ptxNDEF_T2TOP_ReadCCVariant_t        ReadCCVariant;         
} ptxNDEF_T2TOP_InitParams_t;
 
 
typedef struct ptxNDEF_T2TOP_CC
{
    uint8_t                         MagicNumber;                    
    uint8_t                         Version;                        
    uint16_t                        MLEN;                           
    uint8_t                         Access;                         
    uint8_t                         ReadAccess;                     
    uint8_t                         WriteAccess;                    
    uint8_t                         VersionMajor;                   
    uint8_t                         VersionMinor;                   
    uint16_t                        Size;                           
    uint16_t                        NumberOfBlocks;                 
} ptxNDEF_T2TOP_CC_t;
 
typedef struct ptxNDEF_T2TOP_NDEF_TLV
{
    uint16_t                        Length;                                     
    uint8_t                         LengthBlock[PTX_T2T_BLOCK_SIZE*2u];        
    uint8_t                         LengthByteOffset;                           
    uint16_t                        ByteAddress;                    
} ptxNDEF_T2TOP_NDEF_TLV_t;
 
typedef struct ptxNDEF_T2TOP_TERMINATOR_TLV
{
    uint16_t                        ByteAddress;                    
    uint8_t                         TerminatorTLVFound;             
} ptxNDEF_T2TOP_TERMINATOR_TLV_t;
 
typedef struct ptxNDEF_T2TOP_LOCK_CTRL_TLV
{
    uint16_t                        ByteAddress;                 
    uint16_t                        LockArea[2];                 
    uint8_t                         NbrReservedBits;             
    uint8_t                         BytesLockedPerLockBit;       
    uint16_t                        InternalArea[2];             
} ptxNDEF_T2TOP_LOCK_CTRL_TLV;
 
typedef struct ptxNDEF_T2TOP_MEMORY_CTRL_TLV
{
    uint16_t                        ByteAddress;              
    uint16_t                        RsvdArea[2];              
} ptxNDEF_T2TOP_MEMORY_CTRL_TLV_t;
 
typedef struct ptxNDEF_T2TOP_TLV
{
    ptxNDEF_T2TOP_TERMINATOR_TLV_t                      TerminatorTLV;                                          
    ptxNDEF_T2TOP_NDEF_TLV_t                            NDEFTLV[PTX_T2TOP_MAX_NUMBER_NDEFTLVS];                 
    uint8_t                                             NumberOfNdefTLVs;                                       
    ptxNDEF_T2TOP_LOCK_CTRL_TLV                         LockControlTLVs[PTX_T2TOP_MAX_NUMBER_LOCK_CONTROL];     
    uint8_t                                             NumberOfLockTLVs;                                       
    ptxNDEF_T2TOP_MEMORY_CTRL_TLV_t                     MemoryControlTLVs[PTX_T2TOP_MAX_NUMBER_MEMORY_CONTROL]; 
    uint8_t                                             NumberOfMemoryTLVs;                                     
    uint16_t                                            AvailableNdefLength;                                    
} ptxNDEF_T2TOP_TLV_t;
 
typedef struct ptxNDEF_T2TOP_Sector
{
    uint8_t                                             CurrentSector;                              
    uint8_t                                             NumberOfSectors;                            
} ptxNDEF_T2TOP_Sector_t;
 
 
typedef struct ptxNDEF_T2TOP
{
    /* Components */
    ptxStatus_Comps_t               CompId;                
    ptxNativeTag_T2T_t              NativeTagT2T;          
    ptxNDEF_TagLifeCycle_t          LifeCycle;             
    uint8_t                         *RxBuffer;             
    size_t                          RxBufferSize;          
    size_t                          RxLen;                 
    uint8_t                         *WorkBuffer;           
    size_t                          WorkBufferSize;        
    ptxNDEF_T2TOP_ReadCCVariant_t   ReadCCVariant;         
    uint8_t                         T2tInternalBytes[PTX_T2TOP_INTERNAL_BYTES_LENGTH];  
    /* Tag Type specific members */
    ptxNDEF_T2TOP_CC_t              CCParams;              
    ptxNDEF_T2TOP_TLV_t             TLVs;                  
    ptxNDEF_T2TOP_Sector_t          SectorParams;          
    /* Position Tracking within the T2T Memory. */
    uint8_t                         CurrentBlock;          
    uint16_t                        CurrentBlockAddress;   
    uint16_t                        CurrentByteAddress;    
    /* General Info and / or Greedy Collecting related Parameters */
    uint8_t                         LastOperationCheck;    
} ptxNDEF_T2TOP_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
ptxStatus_t ptxNDEF_T2TOpOpen (ptxNDEF_T2TOP_t *t2tOpComp, ptxNDEF_T2TOP_InitParams_t *initParams);
 
ptxStatus_t ptxNDEF_T2TOpFormatTag (ptxNDEF_T2TOP_t *t2tOpComp);
 
ptxStatus_t ptxNDEF_T2TOpCheckMessage (ptxNDEF_T2TOP_t *t2tOpComp);
 
ptxStatus_t ptxNDEF_T2TOpReadMessage (ptxNDEF_T2TOP_t *t2tOpComp, uint8_t *msgBuffer, uint32_t *msgLen);
 
ptxStatus_t ptxNDEF_T2TOpWriteMessage (ptxNDEF_T2TOP_t *t2tOpComp, uint8_t *msgBuffer, uint32_t msgLen);
 
ptxStatus_t ptxNDEF_T2TOpLockTag (ptxNDEF_T2TOP_t *t2tOpComp);
 
ptxStatus_t ptxNDEF_T2TOpClose (ptxNDEF_T2TOP_t *t2tOpComp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */