Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
ptxNDEF_T3TOP.h
Go to the documentation of this file.
1
49#ifndef APIS_PTX_NDEF_OP_T3T_H_
50#define APIS_PTX_NDEF_OP_T3T_H_
51
52/*
53 * ####################################################################################################################
54 * INCLUDES
55 * ####################################################################################################################
56 */
57
58#include <stdint.h>
59#include "ptxNativeTag_T3T.h"
60#include "ptxNDEF_Defines.h"
61#include "ptx_Status.h"
62
63#ifdef __cplusplus
64extern "C" {
65#endif
66
67/*
68 * ####################################################################################################################
69 * DEFINES / TYPES
70 * ####################################################################################################################
71 */
72#if defined (_WIN32) || defined (_WIN64) || defined (ming) || defined (__MINGW32__) || defined (__GNUWIN32__)
73 #define PTX_API_LIBFUNC __declspec(dllexport) /* */
74#else
75
76 #if defined (__GNUC__) /* GCC */
77 #define PTX_API_LIBFUNC __attribute__ ((visibility("default"))) /* requires -fvisibility=hidden as compiler option */
78 #elif defined (_linux) || defined (__linux) /* Linux with some other compiler */
79 #error Missing Platform Specification /* To be added */
80 #else
81 #error Missing Platform Specification
82 #endif
83#endif
84
89#define PTX_T3T_BLOCK_SIZE (uint8_t)16u
90#define PTX_T3T_RFU_SIZE (uint8_t)4u
91#define PTX_T3T_DEFAULT_TIMEOUT_MS (uint32_t)500
92#define PTX_T3T_SUPPORTED_VERSION (uint8_t)0x10
95/*
96 * ####################################################################################################################
97 * TYPES
98 * ####################################################################################################################
99 */
100
114
118typedef struct ptxNDEF_T3TOP_CC
119{
121 uint8_t Version;
122 uint8_t MajorVersion;
123 uint8_t MinorVersion;
124 uint8_t Nbr;
125 uint8_t Nbw;
126 uint8_t NbrInt;
127 uint8_t NbwInt;
128 uint16_t NmaxB;
130 uint8_t WriteFlag;
131 uint8_t RWFlag;
132 uint32_t Ln;
133 uint16_t Nbc;
134 uint16_t Checksum;
137
159
160
161/*
162 * ####################################################################################################################
163 * API FUNCTIONS
164 * ####################################################################################################################
165 */
166
176
185
194
204PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpReadMessage (ptxNDEF_T3TOP_t *t3tOpComp, uint8_t *msgBuffer, uint32_t *msgLen);
205
215PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpWriteMessage (ptxNDEF_T3TOP_t *t3tOpComp, uint8_t *msgBuffer, uint32_t msgLen);
216
225
233PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpClose (ptxNDEF_T3TOP_t *t3tOpComp);
234
235#ifdef __cplusplus
236}
237#endif
238
241#endif /* Guard */
242
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpCheckMessage(ptxNDEF_T3TOP_t *t3tOpComp)
Checks if a NDEF-message is present on the given Tag (or not).
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpReadMessage(ptxNDEF_T3TOP_t *t3tOpComp, uint8_t *msgBuffer, uint32_t *msgLen)
Reads a NDEF-message from a given Tag.
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpLockTag(ptxNDEF_T3TOP_t *t3tOpComp)
Puts a Tag into READ-ONLY state (Attention: This is a irreversible Operation!).
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpClose(ptxNDEF_T3TOP_t *t3tOpComp)
Unitialize / Close the T3T OP Component.
struct ptxNDEF_T3TOP_CC ptxNDEF_T3TOP_CC_t
T3T NDEF OP Capability Container Parameters.
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpWriteMessage(ptxNDEF_T3TOP_t *t3tOpComp, uint8_t *msgBuffer, uint32_t msgLen)
Writes a NDEF-message onto a given Tag.
#define PTX_T3T_BLOCK_SIZE
Definition ptxNDEF_T3TOP.h:89
struct ptxNDEF_T3TOP ptxNDEF_T3TOP_t
T3T NDEF OP Component.
struct ptxNDEF_T3TOP_InitParams ptxNDEF_T3TOP_InitParams_t
T3T NDEF OP Initialization Parameters.
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpFormatTag(ptxNDEF_T3TOP_t *t3tOpComp)
Formats a Type 3 Tag to INITIALIZED state.
PTX_API_LIBFUNC ptxStatus_t ptxNDEF_T3TOpOpen(ptxNDEF_T3TOP_t *t3tOpComp, ptxNDEF_T3TOP_InitParams_t *initParams)
Initialize / Open the T3T OP Component.
#define PTX_T3T_RFU_SIZE
Definition ptxNDEF_T3TOP.h:90
enum ptxNDEF_TagLifeCycle ptxNDEF_TagLifeCycle_t
NDEF Tag Life-Cycle.
uint16_t ptxStatus_t
Status Type.
Definition ptx_Status.h:82
enum ptxStatus_Comps ptxStatus_Comps_t
Component Definitions.
T3T NDEF OP Capability Container Parameters.
Definition ptxNDEF_T3TOP.h:119
uint16_t Checksum
Definition ptxNDEF_T3TOP.h:134
uint8_t Nbr
Definition ptxNDEF_T3TOP.h:124
uint8_t RFU[PTX_T3T_RFU_SIZE]
Definition ptxNDEF_T3TOP.h:129
uint8_t WriteFlag
Definition ptxNDEF_T3TOP.h:130
uint8_t Version
Definition ptxNDEF_T3TOP.h:121
uint8_t Nbw
Definition ptxNDEF_T3TOP.h:125
uint8_t NbrInt
Definition ptxNDEF_T3TOP.h:126
uint8_t NbwInt
Definition ptxNDEF_T3TOP.h:127
uint32_t Ln
Definition ptxNDEF_T3TOP.h:132
uint8_t MajorVersion
Definition ptxNDEF_T3TOP.h:122
uint8_t RWFlag
Definition ptxNDEF_T3TOP.h:131
uint8_t MinorVersion
Definition ptxNDEF_T3TOP.h:123
uint16_t NmaxB
Definition ptxNDEF_T3TOP.h:128
uint8_t AttributeInformationBlock[PTX_T3T_BLOCK_SIZE]
Definition ptxNDEF_T3TOP.h:120
uint16_t Nbc
Definition ptxNDEF_T3TOP.h:133
T3T NDEF OP Initialization Parameters.
Definition ptxNDEF_T3TOP.h:105
uint8_t * RxBuffer
Definition ptxNDEF_T3TOP.h:108
uint32_t RxBufferSize
Definition ptxNDEF_T3TOP.h:109
uint8_t * TxBuffer
Definition ptxNDEF_T3TOP.h:106
ptxNativeTag_T3T_InitParams_t T3TInitParams
Definition ptxNDEF_T3TOP.h:111
uint32_t TxBufferSize
Definition ptxNDEF_T3TOP.h:107
T3T NDEF OP Component.
Definition ptxNDEF_T3TOP.h:142
uint8_t MRTI_Check
Definition ptxNDEF_T3TOP.h:154
uint8_t NFCID2Len
Definition ptxNDEF_T3TOP.h:153
uint8_t * RxBuffer
Definition ptxNDEF_T3TOP.h:148
ptxNativeTag_T3T_t NativeTagT3T
Definition ptxNDEF_T3TOP.h:146
ptxNDEF_T3TOP_CC_t CCParams
Definition ptxNDEF_T3TOP.h:151
uint32_t RxBufferSize
Definition ptxNDEF_T3TOP.h:149
void * StackComp
Definition ptxNDEF_T3TOP.h:156
uint8_t WorkBuffer[64]
Definition ptxNDEF_T3TOP.h:150
uint8_t * NFCID2
Definition ptxNDEF_T3TOP.h:152
ptxStatus_Comps_t CompId
Definition ptxNDEF_T3TOP.h:144
ptxNDEF_TagLifeCycle_t LifeCycle
Definition ptxNDEF_T3TOP.h:147
uint32_t MRTI_Update
Definition ptxNDEF_T3TOP.h:155
T3T Native Tag Initialization Parameters.
Definition ptxNativeTag_T3T.h:130
T3T Native Tag Component.
Definition ptxNativeTag_T3T.h:145