Renesas PTX1xxR IoT-Reader API Version 7.3.1
Renesas Software Stack for IoT-Reader Applications
ptxNativeTag_T5T.h
Go to the documentation of this file.
1
49#ifndef APIS_PTX_NATIVE_TAG_T5T_H_
50#define APIS_PTX_NATIVE_TAG_T5T_H_
51
52/*
53 * ####################################################################################################################
54 * INCLUDES
55 * ####################################################################################################################
56 */
57
58#include <stdint.h>
59#include "ptx_Status.h"
60#include "ptxTbInt.h"
61
62#ifdef __cplusplus
63extern "C" {
64#endif
65
66/*
67 * ####################################################################################################################
68 * DEFINES / TYPES
69 * ####################################################################################################################
70 */
71#if defined (_WIN32) || defined (_WIN64) || defined (ming) || defined (__MINGW32__) || defined (__GNUWIN32__)
72 #define PTX_API_LIBFUNC __declspec(dllexport) /* */
73#else
74
75 #if defined (__GNUC__) /* GCC */
76 #define PTX_API_LIBFUNC __attribute__ ((visibility("default"))) /* requires -fvisibility=hidden as compiler option */
77 #elif defined (_linux) || defined (__linux) /* Linux with some other compiler */
78 #error Missing Platform Specification /* To be added */
79 #else
80 #error Missing Platform Specification
81 #endif
82#endif
83
88#define PTX_T5T_UID_SIZE (uint8_t)8
89#define PTX_T5T_MIN_TX_BUFFER_SIZE (uint32_t)64
90#define PTX_T5T_MAX_NR_RETRIES (uint8_t)5
93/*
94 * ####################################################################################################################
95 * TYPES
96 * ####################################################################################################################
97 */
98
112
116typedef struct ptxNativeTag_T5T
117{
118 /* Components */
121 void *StackComp;
122 uint8_t *TxBuffer;
124 uint8_t *UID;
125 size_t UIDLen;
127 uint8_t isSelected;
130
131/*
132 * ####################################################################################################################
133 * API FUNCTIONS
134 * ####################################################################################################################
135 */
136
146
160 uint8_t optionFlag,
161 uint8_t blockNr,
162 uint8_t *rx,
163 size_t *rxLen,
164 uint32_t msTimeout);
165
181 uint8_t optionFlag,
182 uint8_t blockNr,
183 uint8_t *blockData,
184 uint8_t blockDataLen,
185 uint8_t *rx,
186 size_t *rxLen,
187 uint32_t msTimeout);
188
202 uint8_t optionFlag,
203 uint8_t blockNr,
204 uint8_t *rx,
205 size_t *rxLen,
206 uint32_t msTimeout);
207
222 uint8_t optionFlag,
223 uint8_t blockNr,
224 uint8_t nrBlocks,
225 uint8_t *rx,
226 size_t *rxLen,
227 uint32_t msTimeout);
228
242 uint8_t optionFlag,
243 uint16_t blockNr,
244 uint8_t *rx,
245 size_t *rxLen,
246 uint32_t msTimeout);
247
263 uint8_t optionFlag,
264 uint16_t blockNr,
265 uint8_t *blockData,
266 uint8_t blockDataLen,
267 uint8_t *rx,
268 size_t *rxLen,
269 uint32_t msTimeout);
270
284 uint8_t optionFlag,
285 uint16_t blockNr,
286 uint8_t *rx,
287 size_t *rxLen,
288 uint32_t msTimeout);
289
304 uint8_t optionFlag,
305 uint16_t blockNr,
306 uint16_t nrBlocks,
307 uint8_t *rx,
308 size_t *rxLen,
309 uint32_t msTimeout);
310
325 uint8_t optionFlag,
326 uint8_t *uid,
327 uint8_t uidLen,
328 uint8_t *rx,
329 size_t *rxLen,
330 uint32_t msTimeout);
331
332
347 uint8_t optionFlag,
348 uint8_t *uid,
349 uint8_t uidLen,
350 uint8_t *rx,
351 size_t *rxLen,
352 uint32_t msTimeout);
353
364 uint8_t *uid,
365 uint8_t uidLen);
366
375
376
377#ifdef __cplusplus
378}
379#endif
380
383#endif /* Guard */
384
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TClose(ptxNativeTag_T5T_t *t5tComp)
Unitialize / Close the T5T Native Tag Component.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtWriteSingleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint16_t blockNr, uint8_t *blockData, uint8_t blockDataLen, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a EXTENDED_WRITE_SINGLE_BLOCK_REQ-command.
struct ptxNativeTag_T5T_InitParams ptxNativeTag_T5T_InitParams_t
T5T Native Tag Initialization Parameters.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TLockSingleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a LOCK_SINGLE_BLOCK_REQ-command.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TOpen(ptxNativeTag_T5T_t *t5tComp, ptxNativeTag_T5T_InitParams_t *initParams)
Initialize / Open the T5T Native Tag Component.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TWriteSingleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t *blockData, uint8_t blockDataLen, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a WRITE_SINGLE_BLOCK_REQ-command.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtReadMultipleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint16_t blockNr, uint16_t nrBlocks, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a EXTENDED_READ_MUTLIPLE_BLOCK_REQ-command.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TReadSingleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a READ_SINGLE_BLOCK_REQ-command.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TSetUID(ptxNativeTag_T5T_t *t5tComp, uint8_t *uid, uint8_t uidLen)
Sets / Updates the UID to be used (needs to be called after "ptxNativeTag_T5TSelect() is called and a...
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TReadMultipleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint8_t blockNr, uint8_t nrBlocks, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a READ_MUTLIPLE_BLOCK_REQ-command.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtReadSingleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint16_t blockNr, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a EXTENDED_READ_SINGLE_BLOCK_REQ-command.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TSleep(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint8_t *uid, uint8_t uidLen, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a SELECT_REQ-command.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TSelect(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint8_t *uid, uint8_t uidLen, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a SELECT_REQ-command.
struct ptxNativeTag_T5T ptxNativeTag_T5T_t
T5T Native Tag Component.
PTX_API_LIBFUNC ptxStatus_t ptxNativeTag_T5TExtLockSingleBlock(ptxNativeTag_T5T_t *t5tComp, uint8_t optionFlag, uint16_t blockNr, uint8_t *rx, size_t *rxLen, uint32_t msTimeout)
Performs a EXTENDED_LOCK_SINGLE_BLOCK_REQ-command.
uint16_t ptxStatus_t
Status Type.
Definition ptx_Status.h:82
enum ptxStatus_Comps ptxStatus_Comps_t
Component Definitions.
T5T Native Tag Initialization Parameters.
Definition ptxNativeTag_T5T.h:103
uint8_t UIDLen
Definition ptxNativeTag_T5T.h:108
uint8_t * UID
Definition ptxNativeTag_T5T.h:107
uint8_t isSelected
Definition ptxNativeTag_T5T.h:109
void * StackComp
Definition ptxNativeTag_T5T.h:104
uint8_t * TxBuffer
Definition ptxNativeTag_T5T.h:105
uint32_t TxBufferSize
Definition ptxNativeTag_T5T.h:106
T5T Native Tag Component.
Definition ptxNativeTag_T5T.h:117
size_t UIDLen
Definition ptxNativeTag_T5T.h:125
uint8_t * UID
Definition ptxNativeTag_T5T.h:124
uint8_t isSelected
Definition ptxNativeTag_T5T.h:127
void * StackComp
Definition ptxNativeTag_T5T.h:121
uint8_t * TxBuffer
Definition ptxNativeTag_T5T.h:122
ptxStatus_Comps_t CompId
Definition ptxNativeTag_T5T.h:119