Renesas PTX1xxR IoT-Reader API (non-OS) Version 7.3.1
Renesas Software Stack for IoT-Reader Applications (non-OS)
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 "ptxStatus.h"
60
61#ifdef __cplusplus
62extern "C" {
63#endif
64
65/*
66 * ####################################################################################################################
67 * DEFINES / TYPES
68 * ####################################################################################################################
69 */
70
75#define PTX_T5T_UID_SIZE (uint8_t)8
76#define PTX_T5T_MIN_TX_BUFFER_SIZE (uint32_t)64
77#define PTX_T5T_MAX_NR_RETRIES (uint8_t)5
80/*
81 * ####################################################################################################################
82 * TYPES
83 * ####################################################################################################################
84 */
85
89typedef struct ptxNativeTag_T5T_InitParams
90{
91 void *IotRd;
92 uint8_t *TxBuffer;
93 uint32_t TxBufferSize;
94 uint8_t *UID;
95 uint8_t UIDLen;
96 uint8_t isSelected;
98} ptxNativeTag_T5T_InitParams_t;
99
103typedef struct ptxNativeTag_T5T
104{
105 /* Components */
106 ptxStatus_Comps_t CompId;
108 void *IotRd;
109 uint8_t *TxBuffer;
111 uint8_t *UID;
112 size_t UIDLen;
114 uint8_t isSelected;
116} ptxNativeTag_T5T_t;
117
118/*
119 * ####################################################################################################################
120 * API FUNCTIONS
121 * ####################################################################################################################
122 */
123
132ptxStatus_t ptxNativeTag_T5TOpen (ptxNativeTag_T5T_t *t5tComp, ptxNativeTag_T5T_InitParams_t *initParams);
133
146ptxStatus_t ptxNativeTag_T5TReadSingleBlock (ptxNativeTag_T5T_t *t5tComp,
147 uint8_t optionFlag,
148 uint8_t blockNr,
149 uint8_t *rx,
150 size_t *rxLen,
151 uint32_t msTimeout);
152
167ptxStatus_t ptxNativeTag_T5TWriteSingleBlock (ptxNativeTag_T5T_t *t5tComp,
168 uint8_t optionFlag,
169 uint8_t blockNr,
170 uint8_t *blockData,
171 uint8_t blockDataLen,
172 uint8_t *rx,
173 size_t *rxLen,
174 uint32_t msTimeout);
175
188ptxStatus_t ptxNativeTag_T5TLockSingleBlock (ptxNativeTag_T5T_t *t5tComp,
189 uint8_t optionFlag,
190 uint8_t blockNr,
191 uint8_t *rx,
192 size_t *rxLen,
193 uint32_t msTimeout);
194
208ptxStatus_t ptxNativeTag_T5TReadMultipleBlock (ptxNativeTag_T5T_t *t5tComp,
209 uint8_t optionFlag,
210 uint8_t blockNr,
211 uint8_t nrBlocks,
212 uint8_t *rx,
213 size_t *rxLen,
214 uint32_t msTimeout);
215
228ptxStatus_t ptxNativeTag_T5TExtReadSingleBlock (ptxNativeTag_T5T_t *t5tComp,
229 uint8_t optionFlag,
230 uint16_t blockNr,
231 uint8_t *rx,
232 size_t *rxLen,
233 uint32_t msTimeout);
234
249ptxStatus_t ptxNativeTag_T5TExtWriteSingleBlock (ptxNativeTag_T5T_t *t5tComp,
250 uint8_t optionFlag,
251 uint16_t blockNr,
252 uint8_t *blockData,
253 uint8_t blockDataLen,
254 uint8_t *rx,
255 size_t *rxLen,
256 uint32_t msTimeout);
257
270ptxStatus_t ptxNativeTag_T5TExtLockSingleBlock (ptxNativeTag_T5T_t *t5tComp,
271 uint8_t optionFlag,
272 uint16_t blockNr,
273 uint8_t *rx,
274 size_t *rxLen,
275 uint32_t msTimeout);
276
290ptxStatus_t ptxNativeTag_T5TExtReadMultipleBlock (ptxNativeTag_T5T_t *t5tComp,
291 uint8_t optionFlag,
292 uint16_t blockNr,
293 uint16_t nrBlocks,
294 uint8_t *rx,
295 size_t *rxLen,
296 uint32_t msTimeout);
297
311ptxStatus_t ptxNativeTag_T5TSelect (ptxNativeTag_T5T_t *t5tComp,
312 uint8_t optionFlag,
313 uint8_t *uid,
314 uint8_t uidLen,
315 uint8_t *rx,
316 size_t *rxLen,
317 uint32_t msTimeout);
318
319
333ptxStatus_t ptxNativeTag_T5TSleep (ptxNativeTag_T5T_t *t5tComp,
334 uint8_t optionFlag,
335 uint8_t *uid,
336 uint8_t uidLen,
337 uint8_t *rx,
338 size_t *rxLen,
339 uint32_t msTimeout);
340
350ptxStatus_t ptxNativeTag_T5TSetUID (ptxNativeTag_T5T_t *t5tComp,
351 uint8_t *uid,
352 uint8_t uidLen);
353
361ptxStatus_t ptxNativeTag_T5TClose (ptxNativeTag_T5T_t *t5tComp);
362
363
364#ifdef __cplusplus
365}
366#endif
367
370#endif /* Guard */
371
ptxNativeTag_T5TExtWriteSingleBlock
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.
ptxNativeTag_T5T_InitParams_t
struct ptxNativeTag_T5T_InitParams ptxNativeTag_T5T_InitParams_t
T5T Native Tag Initialization Parameters.
ptxNativeTag_T5TExtReadSingleBlock
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.
ptxNativeTag_T5TSleep
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.
ptxNativeTag_T5TSetUID
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...
ptxNativeTag_T5TExtLockSingleBlock
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.
ptxNativeTag_T5TSelect
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.
ptxNativeTag_T5TWriteSingleBlock
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.
ptxNativeTag_T5TReadMultipleBlock
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.
ptxNativeTag_T5TLockSingleBlock
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.
ptxNativeTag_T5TOpen
ptxStatus_t ptxNativeTag_T5TOpen(ptxNativeTag_T5T_t *t5tComp, ptxNativeTag_T5T_InitParams_t *initParams)
Initialize / Open the T5T Native Tag Component.
ptxNativeTag_T5TExtReadMultipleBlock
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.
ptxNativeTag_T5TReadSingleBlock
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.
ptxNativeTag_T5T_t
struct ptxNativeTag_T5T ptxNativeTag_T5T_t
T5T Native Tag Component.
ptxNativeTag_T5TClose
ptxStatus_t ptxNativeTag_T5TClose(ptxNativeTag_T5T_t *t5tComp)
Unitialize / Close the T5T Native Tag Component.
ptxStatus_t
uint16_t ptxStatus_t
Status Type.
Definition ptxStatus.h:70
ptxStatus_Comps_t
enum ptxStatus_Comps ptxStatus_Comps_t
Component Definitions.
ptxNativeTag_T5T_InitParams
T5T Native Tag Initialization Parameters.
Definition ptxNativeTag_T5T.h:90
ptxNativeTag_T5T_InitParams::UIDLen
uint8_t UIDLen
Definition ptxNativeTag_T5T.h:95
ptxNativeTag_T5T_InitParams::UID
uint8_t * UID
Definition ptxNativeTag_T5T.h:94
ptxNativeTag_T5T_InitParams::isSelected
uint8_t isSelected
Definition ptxNativeTag_T5T.h:96
ptxNativeTag_T5T_InitParams::IotRd
void * IotRd
Definition ptxNativeTag_T5T.h:91
ptxNativeTag_T5T_InitParams::TxBuffer
uint8_t * TxBuffer
Definition ptxNativeTag_T5T.h:92
ptxNativeTag_T5T_InitParams::TxBufferSize
uint32_t TxBufferSize
Definition ptxNativeTag_T5T.h:93
ptxNativeTag_T5T
T5T Native Tag Component.
Definition ptxNativeTag_T5T.h:104
ptxNativeTag_T5T::UIDLen
size_t UIDLen
Definition ptxNativeTag_T5T.h:112
ptxNativeTag_T5T::UID
uint8_t * UID
Definition ptxNativeTag_T5T.h:111
ptxNativeTag_T5T::isSelected
uint8_t isSelected
Definition ptxNativeTag_T5T.h:114
ptxNativeTag_T5T::IotRd
void * IotRd
Definition ptxNativeTag_T5T.h:108
ptxNativeTag_T5T::TxBuffer
uint8_t * TxBuffer
Definition ptxNativeTag_T5T.h:109
ptxNativeTag_T5T::CompId
ptxStatus_Comps_t CompId
Definition ptxNativeTag_T5T.h:106
Generated by doxygen 1.10.0