ptxNDEF_T4TOP.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_NDEF_OP_T4T_H_
#define APIS_PTX_NDEF_OP_T4T_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include <stdint.h>
#include "ptxNativeTag_T4T.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_T4T_DEFAULT_TIMEOUT_MS   (uint32_t)50000        
#define PTX_T4T_MAXIMUM_NLEN_LENGTH  (uint8_t)4u            
#define PTX_T4T_CC_LEN               (uint8_t)2u            
#define PTX_T4T_FILEIDENTIFIER_LEN   (uint8_t)2u            
/*
 * ####################################################################################################################
 * TYPES
 * ####################################################################################################################
 */
 
typedef struct ptxNDEF_T4TOP_InitParams
{
    uint8_t                         *RxBuffer;     
    uint32_t                        RxBufferSize;  
    ptxNativeTag_T4T_InitParams_t   T4TInitParams; 
} ptxNDEF_T4TOP_InitParams_t;
 
typedef struct ptxNDEF_T4TOP_CC
{
    uint8_t                         CCLen[PTX_T4T_CC_LEN];  
    uint8_t                         MappingVersion;         
    uint8_t                         MappingMajor;
    uint8_t                         MappingMinor;
    uint16_t                        MLeDigit;               
    uint16_t                        MLcDigit;               
    uint8_t                         NDEFTLV[10];            
    uint8_t                         NDEFFileIdentifier[PTX_T4T_FILEIDENTIFIER_LEN];  
    uint32_t                        NDEFFileSize;           
    uint8_t                         NDEFAccessRead;         
    uint8_t                         NDEFAccessWrite;        
} ptxNDEF_T4TOP_CC_t;
 
typedef struct ptxNDEF_T4TOP_NLEN
{
    uint8_t                         NLEN[PTX_T4T_MAXIMUM_NLEN_LENGTH];                
    uint8_t                         NbrNLENBytes;           
    uint32_t                        DigitNLEN;              
} ptxNDEF_T4TOP_NLEN_t;
 
typedef struct ptxNDEF_T4TOP
{
    /* Components */
    ptxStatus_Comps_t               CompId;                
    ptxNativeTag_T4T_t              NativeTagT4T;          
    ptxNDEF_TagLifeCycle_t          LifeCycle;             
    uint8_t                         *RxBuffer;             
    uint32_t                        RxBufferSize;          
    /* Tag Type specific members */
    ptxNDEF_T4TOP_CC_t              CCParams;              
    ptxNDEF_T4TOP_NLEN_t            NLEN;                  
    /* General Info and / or Greedy Collecting related Parameters */
 
} ptxNDEF_T4TOP_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpOpen (ptxNDEF_T4TOP_t *t4tOpComp, ptxNDEF_T4TOP_InitParams_t *initParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpFormatTag (ptxNDEF_T4TOP_t *t4tOpComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpCheckMessage (ptxNDEF_T4TOP_t *t4tOpComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpReadMessage (ptxNDEF_T4TOP_t *t4tOpComp, uint8_t *msgBuffer, uint32_t *msgLen);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpWriteMessage (ptxNDEF_T4TOP_t *t4tOpComp, uint8_t *msgBuffer, uint32_t msgLen);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpLockTag (ptxNDEF_T4TOP_t *t4tOpComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T4TOpClose (ptxNDEF_T4TOP_t *t4tOpComp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */