ptxNDEF.h

Go to the documentation of this file.

 
#ifndef APIS_PTX_NDEF_H_
#define APIS_PTX_NDEF_H_
 
/*
 * ####################################################################################################################
 * INCLUDES
 * ####################################################################################################################
 */
 
#include <stdint.h>
#include "ptx_IOT_READER.h"
#include "ptxNDEF_T2TOP.h"
#include "ptxNDEF_T3TOP.h"
#include "ptxNDEF_T4TOP.h"
#include "ptxNDEF_T5TOP.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
 
/*
 * ####################################################################################################################
 * TYPES
 * ####################################################################################################################
 */
struct ptxIoTRd_CardRegistry;
 
typedef enum ptxNDEF_T5T_Modes
{
    ptxNDEF_T5T_Mode_None,     
    ptxNDEF_T5T_Mode_Addressed,
    ptxNDEF_T5T_Mode_Selected, 
} ptxNDEF_T5T_Modes_t;
 
typedef struct ptxNDEF_InitParams
{
    void                            *IoTRdStackComp;        
    uint8_t                         *TxBuffer;              
    uint32_t                        TxBufferSize;           
    uint8_t                         *RxBuffer;              
    uint32_t                        RxBufferSize;           
    uint8_t                         *WorkBuffer;
    uint32_t                        WorkBufferSize;
 
    ptxNDEF_T5T_Modes_t             T5TMode;                
} ptxNDEF_InitParams_t;
 
typedef struct ptxNDEF
{
    /* Components */
    ptxStatus_Comps_t               CompId;                 
    struct ptxIoTRd_CardRegistry    *CardRegistry;          
    ptxNDEF_T2TOP_t                 T2TOP;                  
    ptxNDEF_T3TOP_t                 T3TOP;                  
    ptxNDEF_T4TOP_t                 T4TOP;                  
    ptxNDEF_T5TOP_t                 T5TOP;                  
} ptxNDEF_t;
 
/*
 * ####################################################################################################################
 * API FUNCTIONS
 * ####################################################################################################################
 */
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_Open (ptxNDEF_t *ndefComp, ptxNDEF_InitParams_t *initParams);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_FormatTag (ptxNDEF_t *ndefComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_CheckMessage (ptxNDEF_t *ndefComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_ReadMessage (ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t *msgLen);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_WriteMessage (ptxNDEF_t *ndefComp, uint8_t *msgBuffer, uint32_t msgLen);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_LockTag (ptxNDEF_t *ndefComp);
 
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_Close (ptxNDEF_t *ndefComp);
 
#ifdef __cplusplus
}
#endif
 
#endif /* Guard */