C API for BALTECH SDK
iso15.h
Go to the documentation of this file.
1 
58 #ifndef __BRP_BALTECH_API_CMDS_ISO15_H__
59 #define __BRP_BALTECH_API_CMDS_ISO15_H__
60 #include "../typedefs.h"
64 #define BRP_Iso15_ErrNoTag BRP_ERR_STATUS(0x2100, 0x01)
65 
71 #define BRP_Iso15_ErrCollision BRP_ERR_STATUS(0x2100, 0x02)
72 
75 #define BRP_Iso15_ErrHf BRP_ERR_STATUS(0x2100, 0x04)
76 
79 #define BRP_Iso15_ErrLabel BRP_ERR_STATUS(0x2100, 0x05)
80 
83 #define BRP_Iso15_ErrCom BRP_ERR_STATUS(0x2100, 0x10)
84 
87 #define BRP_Iso15_ErrCmd BRP_ERR_STATUS(0x2100, 0x20)
88 
91 #define BRP_Iso15_ErrParamNotSupported BRP_ERR_STATUS(0x2100, 0x23)
92 
95 #define BRP_Iso15_ErrMem BRP_ERR_STATUS(0x2100, 0x24)
96 
99 #define BRP_Iso15_ErrLabelBlocksize BRP_ERR_STATUS(0x2100, 0x25)
100 
103 #define BRP_Iso15_ErrHwNotSupported BRP_ERR_STATUS(0x2100, 0x26)
104 
114 brp_errcode brp_Iso15_SetParam(brp_protocol protocol, bool ModulationIndex, bool TXMode, bool HighDataRate, bool DualSubcarrier);
124 brp_errcode brp_Iso15_GetParam(brp_protocol protocol, unsigned* ModulationIndex, unsigned* TXMode, unsigned* HighDataRate, unsigned* DualSubcarrier);
159 brp_errcode brp_Iso15_GetUIDList(brp_protocol protocol, bool EnAFI, bool NextBlock, bool AutoQuiet, bool EnDSFID, bool En16Slots, unsigned AFI, unsigned* More, brp_Iso15_GetUIDList_Labels_Entry** Labels, size_t* Labels_len, brp_mempool *mempool);
173 brp_errcode brp_Iso15_SetMode(brp_protocol protocol, unsigned Mode, brp_buf UID);
208 brp_errcode brp_Iso15_ReadBlock(brp_protocol protocol, unsigned BlockID, unsigned BlockNum, bool EnBlockSec, unsigned* LabelStat, unsigned* BlockLen, brp_Iso15_ReadBlock_Data_Entry** Data, size_t* Data_len, brp_mempool *mempool);
229 brp_errcode brp_Iso15_WriteBlock(brp_protocol protocol, unsigned BlockID, unsigned BlockNum, unsigned BlockLen, bool OptionFlag, brp_buf* Data, size_t Data_len, unsigned* LabelStat);
240 brp_errcode brp_Iso15_LockBlock(brp_protocol protocol, unsigned BlockID, bool OptionFlag, unsigned* LabelStat);
251 brp_errcode brp_Iso15_ResetToReady(brp_protocol protocol, unsigned* LabelStat);
262 brp_errcode brp_Iso15_WriteAFI(brp_protocol protocol, unsigned AFI, bool OptionFlag, unsigned* LabelStat);
272 brp_errcode brp_Iso15_LockAFI(brp_protocol protocol, bool OptionFlag, unsigned* LabelStat);
283 brp_errcode brp_Iso15_WriteDSFID(brp_protocol protocol, unsigned DSFID, bool OptionFlag, unsigned* LabelStat);
293 brp_errcode brp_Iso15_LockDSFID(brp_protocol protocol, bool OptionFlag, unsigned* LabelStat);
313 brp_errcode brp_Iso15_GetSystemInformation(brp_protocol protocol, unsigned* LabelStat, bool* EnICRef, bool* EnMemSize, bool* EnAFI, bool* EnDSFID, brp_buf* SNR, unsigned* DSFID, unsigned* AFI, unsigned* BlockNum, unsigned* BlockSize, unsigned* ICRef, brp_mempool *mempool);
327 brp_errcode brp_Iso15_GetSecurityStatus(brp_protocol protocol, unsigned BlockID, unsigned BlockNum, unsigned* LabelStat, unsigned** BlockStat, size_t* BlockStat_len, brp_mempool *mempool);
347 brp_errcode brp_Iso15_CustomCommand(brp_protocol protocol, unsigned Cmd, unsigned Opt, unsigned MFC, unsigned TO, brp_buf RequestData, size_t RequestData_len, unsigned* LabelStat, brp_buf* ResponseData, size_t* ResponseData_len, brp_mempool *mempool);
363 brp_errcode brp_Iso15_ReadSingleBlock(brp_protocol protocol, unsigned BlockID, bool EnBlockSec, unsigned* LabelStat, brp_buf* Payload, size_t* Payload_len, brp_mempool *mempool);
379 brp_errcode brp_Iso15_WriteSingleBlock(brp_protocol protocol, unsigned BlockID, unsigned BlockLen, bool OptionFlag, brp_buf SingleBlockData, size_t SingleBlockData_len, unsigned* LabelStat);
407 brp_errcode brp_Iso15_TransparentCmdLegacy(brp_protocol protocol, bool EnRxWait, bool EnCRCRX, bool EnCRCTX, unsigned Len, unsigned Timeout, brp_buf Data, unsigned RxWait, brp_buf* LabelData, size_t* LabelData_len, brp_mempool *mempool);
422 brp_errcode brp_Iso15_WriteMultipleBlocks(brp_protocol protocol, unsigned FirstBlockId, brp_Iso15_WriteMultipleBlocks_WriteBlocks_Entry* WriteBlocks, size_t WriteBlocks_len, bool OptionFlag, unsigned* LabelStat);
441 brp_errcode brp_Iso15_ReadMultipleBlocks(brp_protocol protocol, unsigned FirstBlockId, unsigned BlockCount, bool EnBlockSec, unsigned* LabelStat, brp_Iso15_ReadMultipleBlocks_RecvBlocks_Entry** RecvBlocks, size_t* RecvBlocks_len, unsigned** BlocksSecData, size_t* BlocksSecData_len, brp_mempool *mempool);
464 brp_errcode brp_Iso15_TransparentCmd(brp_protocol protocol, brp_buf SendData, size_t SendData_len, unsigned Timeout, bool EnCrcRx, bool EnCrcTx, unsigned RxWait, brp_buf* RecvData, size_t* RecvData_len, brp_mempool *mempool);
465 #endif
466 
Definition: typedefs.h:1721
brp_errcode brp_Iso15_TransparentCmdLegacy(brp_protocol protocol, bool EnRxWait, bool EnCRCRX, bool EnCRCTX, unsigned Len, unsigned Timeout, brp_buf Data, unsigned RxWait, brp_buf *LabelData, size_t *LabelData_len, brp_mempool *mempool)
**For new applications please use brp_Iso15_TransparentCmd() as this command is deprecated and may be...
brp_errcode brp_Iso15_SetMode(brp_protocol protocol, unsigned Mode, brp_buf UID)
This command configures the mode to address a label.
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
brp_errcode brp_Iso15_LockAFI(brp_protocol protocol, bool OptionFlag, unsigned *LabelStat)
This command locks the AFI value permanently into the reader's memory.
brp_errcode brp_Iso15_WriteAFI(brp_protocol protocol, unsigned AFI, bool OptionFlag, unsigned *LabelStat)
This commands writes the AFI value into the label's memory.
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
brp_errcode brp_Iso15_GetParam(brp_protocol protocol, unsigned *ModulationIndex, unsigned *TXMode, unsigned *HighDataRate, unsigned *DualSubcarrier)
This command reads the configuration of the reader chip.
struct brp_mempool_object_t * brp_mempool
mempool handle.
Definition: mempool.h:27
brp_errcode brp_Iso15_ReadMultipleBlocks(brp_protocol protocol, unsigned FirstBlockId, unsigned BlockCount, bool EnBlockSec, unsigned *LabelStat, brp_Iso15_ReadMultipleBlocks_RecvBlocks_Entry **RecvBlocks, size_t *RecvBlocks_len, unsigned **BlocksSecData, size_t *BlocksSecData_len, brp_mempool *mempool)
This command reads one or multiple blocks from a label.
brp_errcode brp_Iso15_GetUIDList(brp_protocol protocol, bool EnAFI, bool NextBlock, bool AutoQuiet, bool EnDSFID, bool En16Slots, unsigned AFI, unsigned *More, brp_Iso15_GetUIDList_Labels_Entry **Labels, size_t *Labels_len, brp_mempool *mempool)
This command scans for ISO 15693 labels which are in the field of the readers antenna and which are n...
brp_errcode brp_Iso15_LockBlock(brp_protocol protocol, unsigned BlockID, bool OptionFlag, unsigned *LabelStat)
This command permanently locks the block with ID BlockID.
brp_errcode brp_Iso15_TransparentCmd(brp_protocol protocol, brp_buf SendData, size_t SendData_len, unsigned Timeout, bool EnCrcRx, bool EnCrcTx, unsigned RxWait, brp_buf *RecvData, size_t *RecvData_len, brp_mempool *mempool)
This command sends a data stream to a label and returns the communication status and the received lab...
Definition: typedefs.h:1708
brp_errcode brp_Iso15_GetSecurityStatus(brp_protocol protocol, unsigned BlockID, unsigned BlockNum, unsigned *LabelStat, unsigned **BlockStat, size_t *BlockStat_len, brp_mempool *mempool)
This command retrieves the block security status of a label.
brp_errcode brp_Iso15_GetSystemInformation(brp_protocol protocol, unsigned *LabelStat, bool *EnICRef, bool *EnMemSize, bool *EnAFI, bool *EnDSFID, brp_buf *SNR, unsigned *DSFID, unsigned *AFI, unsigned *BlockNum, unsigned *BlockSize, unsigned *ICRef, brp_mempool *mempool)
This command gets the system information of a VICC.
brp_errcode brp_Iso15_ResetToReady(brp_protocol protocol, unsigned *LabelStat)
This command puts a label into ready-state , according to the VICC state transition diagram from the ...
brp_errcode brp_Iso15_ReadSingleBlock(brp_protocol protocol, unsigned BlockID, bool EnBlockSec, unsigned *LabelStat, brp_buf *Payload, size_t *Payload_len, brp_mempool *mempool)
This command reads a single block from a label.
brp_errcode brp_Iso15_CustomCommand(brp_protocol protocol, unsigned Cmd, unsigned Opt, unsigned MFC, unsigned TO, brp_buf RequestData, size_t RequestData_len, unsigned *LabelStat, brp_buf *ResponseData, size_t *ResponseData_len, brp_mempool *mempool)
This command executes any ISO 15693 manufacturer proprietary commands, so- called custom-commands...
Definition: typedefs.h:1736
brp_errcode brp_Iso15_LockDSFID(brp_protocol protocol, bool OptionFlag, unsigned *LabelStat)
This command locks the DSFID value permanently into the reader's memory.
brp_errcode brp_Iso15_WriteBlock(brp_protocol protocol, unsigned BlockID, unsigned BlockNum, unsigned BlockLen, bool OptionFlag, brp_buf *Data, size_t Data_len, unsigned *LabelStat)
**For new applications please use brp_Iso15_WriteMultipleBlocks() as this command is deprecated and m...
brp_errcode brp_Iso15_WriteMultipleBlocks(brp_protocol protocol, unsigned FirstBlockId, brp_Iso15_WriteMultipleBlocks_WriteBlocks_Entry *WriteBlocks, size_t WriteBlocks_len, bool OptionFlag, unsigned *LabelStat)
Sends the "WriteMultipleBlocks" to the card to store the data passed in WriteBlocks to the data block...
Definition: typedefs.h:1749
brp_errcode brp_Iso15_WriteDSFID(brp_protocol protocol, unsigned DSFID, bool OptionFlag, unsigned *LabelStat)
This commands writes the DSFID value into the label's memory.
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
Definition: common.h:61
brp_errcode brp_Iso15_ReadBlock(brp_protocol protocol, unsigned BlockID, unsigned BlockNum, bool EnBlockSec, unsigned *LabelStat, unsigned *BlockLen, brp_Iso15_ReadBlock_Data_Entry **Data, size_t *Data_len, brp_mempool *mempool)
**For new applications please use brp_Iso15_ReadMultipleBlocks() as this command is deprecated and ma...
brp_errcode brp_Iso15_WriteSingleBlock(brp_protocol protocol, unsigned BlockID, unsigned BlockLen, bool OptionFlag, brp_buf SingleBlockData, size_t SingleBlockData_len, unsigned *LabelStat)
This command writes a single block to a label.
brp_errcode brp_Iso15_StayQuiet(brp_protocol protocol)
This command puts a label into the quiet-state.
brp_errcode brp_Iso15_SetParam(brp_protocol protocol, bool ModulationIndex, bool TXMode, bool HighDataRate, bool DualSubcarrier)
This command configures the reader chip.