ptxNDEF_T5TOP.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_NDEF_OP_T5T_H_
#define APIS_PTX_NDEF_OP_T5T_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include <stdint.h>
#include "ptxNativeTag_T5T.h"
#include "ptxNDEF_Defines.h"
#include "ptx_Status.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 * ####################################################################################################################
 * DEFINES / TYPES
 * ####################################################################################################################
 */
#if defined (_WIN32) || defined (_WIN64) || defined (ming) || defined (__MINGW32__) || defined (__GNUWIN32__)
    #define PTX_API_LIBFUNC __declspec(dllexport) /* */
#else
 
    #if defined (__GNUC__)                                                  /* GCC */
        #define PTX_API_LIBFUNC __attribute__ ((visibility("default")))      /* requires  -fvisibility=hidden  as compiler option */
    #elif defined (_linux) || defined (__linux)                             /* Linux with some other compiler */
        #error Missing Platform Specification                               /* To be added */
    #else
        #error Missing Platform Specification
    #endif
#endif
 
#define PTX_T5T_DEFAULT_TIMEOUT_MS   (uint32_t)202          
#define PTX_T5T_SUPPORTED_VERSION    (uint8_t)0x10          
/*
 * ####################################################################################################################
 * TYPES
 * ####################################################################################################################
 */
 
typedef struct ptxNDEF_T5TOP_InitParams
{
    ptxNativeTag_T5T_InitParams_t       T5TInitParams;          
    uint8_t                             *WorkBuffer;            
    uint32_t                            WorkBufferSize;         
    uint8_t                             *RxBuffer;              
    uint32_t                            RxBufferSize;           
} ptxNDEF_T5TOP_InitParams_t;
 
typedef struct ptxNDEF_T5TOP_CC
{
    uint8_t                         MagicNumber;                
    uint8_t                         Version;                    
    uint8_t                         ReadAccess;                 
    uint8_t                         WriteAccess;                
    uint16_t                        MLEN;                       
    uint16_t                        ExtCommandTypeRequired;     
    uint8_t                         SpecialFrameRequired;       
    uint8_t                         MultiBlockReadSupported;    
    uint8_t                         LockBlockSupported;         
    uint8_t                         Size;                       
} ptxNDEF_T5TOP_CC_t;
 
typedef struct ptxNDEF_T5TOP
{
    /* Components */
    ptxStatus_Comps_t               CompId;                 
    ptxNativeTag_T5T_t              NativeTagT5T;           
    ptxNDEF_TagLifeCycle_t          LifeCycle;              
    uint8_t                         *RxBuffer;              
    uint32_t                        RxBufferSize;           
    uint8_t                         *WorkBuffer;            
    uint32_t                        WorkBufferSize;         
    /* Tag Type specific members */
    ptxNDEF_T5TOP_CC_t              CCParams;               
    /* General Info and / or Greedy Collectin related Parameters */
    uint8_t                         BlockSize;              
    uint16_t                        NDEF_TLV_POS_BN;        
    uint8_t                         NDEF_TLV_POS_BY;        
    uint16_t                        NDEF_TLV_LENGTH;        
} ptxNDEF_T5TOP_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpOpen (ptxNDEF_T5TOP_t *t5tOpComp, ptxNDEF_T5TOP_InitParams_t *initParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpFormatTag (ptxNDEF_T5TOP_t *t5tOpComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpCheckMessage (ptxNDEF_T5TOP_t *t5tOpComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpReadMessage (ptxNDEF_T5TOP_t *t5tOpComp, uint8_t *msgBuffer, uint32_t *msgLen);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpWriteMessage (ptxNDEF_T5TOP_t *t5tOpComp, uint8_t *msgBuffer, uint32_t msgLen);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpLockTag (ptxNDEF_T5TOP_t *t5tOpComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T5TOpClose (ptxNDEF_T5TOP_t *t5tOpComp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */