STM8L libraries for CR95HF 1.0
Functions
ISO15693_Get_Functions
ISO15693_Support_Functions

Functions

u8 ISO15693_Get_Subcarrier_Flag (const u8 Request_flags)
 This function returns the subcarrier flag determining if the contactless tag's response is made with one or two subcarriers.
u8 ISO15693_Get_DataRate_Flag (const u8 Request_flags)
 This function returns the datarate flag determining if the contactless tag's response is made in high or low datarate.
u8 ISO15693_Get_Inventory_Flag (const u8 Request_flags)
 This function returns the inventory flag to determine if the ccontactless should run the anticollision sequence (inventory command).
u8 ISO15693_Get_ProtocolExtension_Flag (const u8 Request_flags)
 This function returns the protocol extension flag.
u8 ISO15693_Get_Select_Flag (const u8 Request_flags)
 This function returns the select flag to determine if the command is destineted to the contactless tag in selected mode. Note that a check is made to ensure that the inventory flag is reset.
u8 ISO15693_Get_Address_Flag (const u8 Request_flags)
 This function returns the address flag to determine if the command is addressed to the contactless tag designted by its UID. Note that a check is made to ensure that the inventory flag is reset.
u8 ISO15693_Get_AFI_Flag (const u8 Request_flags)
 This function returns the AFI flag to determine if the AFI is present within the command (inventory). Note that a check is made to ensure that the inventory flag is set.
u8 ISO15693_Get_Slots_Flag (const u8 RequestFlags)
 This function returns the number of slots flag (1 or 16) that the contactless tag has to answer an inventory command. Note that a check is made to ensure that the inventory flag is set.
u8 ISO15693_Get_Option_Flag (const u8 Request_flags)
 This function returns the option flag. Note: this function assumes that the option flag has the same meaning whatever the inventory flag value.
u8 ISO15693_Get_RFU_Flag (const u8 Request_flags)
 This function returns RFU flag. The function may need to be tailored when RFU will be defined. Note: this function assumes the RFU flag is the same whatever the inventory flag.
u8 ISO15693_Get_SubCarrier_parameter_CR95HF (const CR95HF_Protocol_Config *Protocol_Settings)
 This function returns if the protocol in use is set with dual Subcarrier or single subcarrier.
u8 ISO15693_Get_Modulation_parameter_CR95HF (const CR95HF_Protocol_Config *Protocol_Settings)
 this function returns if the protocol in use is set with 10 percent modulation or 100 percent modultaion
u8 ISO15693_Get_Delay_parameter_CR95HF (const CR95HF_Protocol_Config *Protocol_Settings)
 this function returns if the protocol in use is set with wait Start of frame or respect 312 micro seconds delay for response slots
u8 ISO15693_Get_DataRate_parameter_CR95HF (const CR95HF_Protocol_Config *Protocol_Settings)
 this function returns if the protocol in use is set with wait Start of frame or respect 312 micro seconds delay for response slots
u8 ISO15693_Get_NumberofByte_MemSize_using_ICREF (const u8 ICRef)
 This functions returns the number of byte used to describe the memory size of the contactless tag (STMicroelectronics manufactured tag)
u8 ISO15693_Get_Size_of_Block_using_ICRef (const u8 ICRef)
 This functions returns the size of a block using the UID of the Tag ( STMicroelectronics' manufactured contactless tag).
u8 ISO15693_Get_Size_of_Block_using_MemSize (const ISO15693_Tag *MyTag)
 This functions returns the size of a block using the MemSize field of the tag structure a get system info command should have been performed before calling this function.
u16 ISO15693_Get_MemSize_kbits (const u8 *MemSize, const u8 Number_of_Bytes_MemSize)
 This function returns the memory size of the contactless tag in a whole number of kilo bits .Note that the size max handled will be 256kbits.
u32 ISO15693_Get_MemSize_bits (u8 *MemSize, u8 Number_of_Bytes_MemSize)
 This function returns the memory size of the contactless tag in bits. This function should be called if the size of the memory is not an interger number of kilo bits.
u8 ISO15693_Get_UID_from_EEPROM (u8 *UID_Tag, u8 UID_number)
 This function retrieves the UID stored into the EEPROM by the inventory 16 slots commands.

Function Documentation

u8 ISO15693_Get_Address_Flag ( const u8  Request_flags)

This function returns the address flag to determine if the command is addressed to the contactless tag designted by its UID. Note that a check is made to ensure that the inventory flag is reset.

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_ADDRESS_FLAG_SET: the address flag is set
ISO15693_ADDRESS_FLAG_RESET: the address flag is reset
ISO15693_ERROR_INVALID_FLAG: bit 3 is set so the parameter does not exist
u8 ISO15693_Get_AFI_Flag ( const u8  Request_flags)

This function returns the AFI flag to determine if the AFI is present within the command (inventory). Note that a check is made to ensure that the inventory flag is set.

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_AFI_PRESENT: the AFI flag is set
ISO15693_AFI_NOT_PRESENT: the AFI flag is reset
ISO15693_ERROR_INVALID_FLAG: bit 3 is reset so the parameter does not exist
u8 ISO15693_Get_DataRate_Flag ( const u8  Request_flags)

This function returns the datarate flag determining if the contactless tag's response is made in high or low datarate.

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_LOW_DATARATE: the contactless tag must answer with low datarate
ISO15693_HIGH_DATARATE: the contactless tag must answer with high datarate
u8 ISO15693_Get_DataRate_parameter_CR95HF ( const CR95HF_Protocol_Config Protocol_Settings)

this function returns if the protocol in use is set with wait Start of frame or respect 312 micro seconds delay for response slots

Parameters:
Protocol_Settings: pointer on the structure to use for verifying
Return values:
CR95HF_DATARATE_RFU: Reserved for Future Use
CR95HF_DATARATE_6KBITS: 6kbits/s datarate is in use
CR95HF_DATARATE_52KBITS:52kbits/s datarate is in use
CR95HF_DATARATE_26KBITS: 26kbits/s datarate is in use
CR95HF_INVALID_PROTOCOL: the protocol in use is not ISO15693
u8 ISO15693_Get_Delay_parameter_CR95HF ( const CR95HF_Protocol_Config Protocol_Settings)

this function returns if the protocol in use is set with wait Start of frame or respect 312 micro seconds delay for response slots

Parameters:
Protocol_Settings: structure to use for verifying
Return values:
CR95HF_RESPECT312_DELAY: respect 312 micro seconds is in use
CR95HF_WAIT_FOR_SOF: wait for start of frame is in use
CR95HF_INVALID_PROTOCOL: the protocol in use is not ISO15693
u8 ISO15693_Get_Inventory_Flag ( const u8  Request_flags)

This function returns the inventory flag to determine if the ccontactless should run the anticollision sequence (inventory command).

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_INVENTORY_FLAG_SET: the inventory flag is set
ISO15693_SELECT_FLAG_RESET: the inventory flag is reset
u32 ISO15693_Get_MemSize_bits ( u8 *  MemSize,
u8  Number_of_Bytes_MemSize 
)

This function returns the memory size of the contactless tag in bits. This function should be called if the size of the memory is not an interger number of kilo bits.

Parameters:
MemSize: pointer on the bytes describing the memory size.
Number_of_Bytes_MemSize: number of bytes describing the memory
Return values:
size: the size of the memory in bits
u16 ISO15693_Get_MemSize_kbits ( const u8 *  MemSize,
const u8  Number_of_Bytes_MemSize 
)

This function returns the memory size of the contactless tag in a whole number of kilo bits .Note that the size max handled will be 256kbits.

Parameters:
MemSize: pointer on the bytes describing the memory size
Number_of_Bytes_MemSize: number of bytes describing the memory
Return values:
size: the size of the memory in kilo bits max 255 kbits
INIT_VALUE: the size is not a whole number of Kbits
u8 ISO15693_Get_Modulation_parameter_CR95HF ( const CR95HF_Protocol_Config Protocol_Settings)

this function returns if the protocol in use is set with 10 percent modulation or 100 percent modultaion

Parameters:
Protocol_Settings: pointer on the structure to use for verifying
Return values:
CR95HF_MODULATION_10: 10 percent modulation is in use
CR95HF_MODULATION_100: 100 percent modulation is in use
CR95HF_INVALID_PROTOCOL: the protocol in use is not ISO15693
u8 ISO15693_Get_NumberofByte_MemSize_using_ICREF ( const u8  ICRef)

This functions returns the number of byte used to describe the memory size of the contactless tag (STMicroelectronics manufactured tag)

Parameters:
ICRef: the ICref to compare with ICref referenced in the miscellaneous.h ( those available at the date of creation of this file, as a matter of fact update should be necessary.)
Return values:
number_of_byte,:the number of byte composing the word
NO_ICREF_MATCHING: No Icref matches, 0 is returned
u8 ISO15693_Get_Option_Flag ( const u8  Request_flags)

This function returns the option flag. Note: this function assumes that the option flag has the same meaning whatever the inventory flag value.

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_OPTION_FLAG_RESET: the option flag is reset
ISO15693_OPTION_FLAG_SET: the option flag is set
u8 ISO15693_Get_ProtocolExtension_Flag ( const u8  Request_flags)

This function returns the protocol extension flag.

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_NO_PROTOCOL_EXTENSION: there is no protocol extension
ISO15693_PROTOCOL_EXTENSION: the protocol extension flag is set (for example for a Get System Info with a LRi64k
u8 ISO15693_Get_RFU_Flag ( const u8  Request_flags)

This function returns RFU flag. The function may need to be tailored when RFU will be defined. Note: this function assumes the RFU flag is the same whatever the inventory flag.

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_BIT8_RFU_SET: the address flag is set
ISO15693_BIT8_RFU_RESET: the address flag is reset
u8 ISO15693_Get_Select_Flag ( const u8  Request_flags)

This function returns the select flag to determine if the command is destineted to the contactless tag in selected mode. Note that a check is made to ensure that the inventory flag is reset.

Parameters:
Request_flags: First byte of RF command sent to contacless tag
Return values:
ISO15693_SELECT_FLAG_SET: the select flag is set
ISO15693_SELECT_FLAG_RESET: the select flag is reset
ISO15693_ERROR_INVALID_FLAG: bit 3 is set so the parameter does not exist
u8 ISO15693_Get_Size_of_Block_using_ICRef ( const u8  ICRef)

This functions returns the size of a block using the UID of the Tag ( STMicroelectronics' manufactured contactless tag).

Parameters:
ICRef: the ICRef to compared with contactless Tag "database" . ICref referenced in the miscellaneous.h are those available at the date of creation of this file. As a matter of fact update should be necessary.
Return values:
number_of_byte,:the number of byte composing the word
ISO15693_BLOCK_SIZE_ERROR: No Icref matches, 0 is returned
u8 ISO15693_Get_Size_of_Block_using_MemSize ( const ISO15693_Tag MyTag)

This functions returns the size of a block using the MemSize field of the tag structure a get system info command should have been performed before calling this function.

Parameters:
MyTag: the structure containing the data drecibing the contactless tag
Return values:
size_of_Block,:the number of byte composing the block
ISO15693_BLOCK_SIZE_ERROR: memsize contains no valid value, 0 is returned
u8 ISO15693_Get_Slots_Flag ( const u8  RequestFlags)

This function returns the number of slots flag (1 or 16) that the contactless tag has to answer an inventory command. Note that a check is made to ensure that the inventory flag is set.

Parameters:
RequestFlags: First byte of RF command sent to contacless tag
Return values:
ISO15693_1_SLOT: the contactless tag has one slot to answer
ISO15693_16_SLOTS: the contactless tag has 16 slots to answer
ISO15693_ERROR_INVALID_FLAG: bit 3 is reset so the parameter does not exist
u8 ISO15693_Get_Subcarrier_Flag ( const u8  Request_flags)

This function returns the subcarrier flag determining if the contactless tag's response is made with one or two subcarriers.

Parameters:
Request_flags: First byte of RF command sent to contacless contactless tag
Return values:
ISO15693_SINGLE_SUBCARRIER: the contactless tag must answer with a single subcarrier
ISO15693_TWO_SUBCARRIERS: the contactless tag must answer with two subcarriers
u8 ISO15693_Get_SubCarrier_parameter_CR95HF ( const CR95HF_Protocol_Config Protocol_Settings)

This function returns if the protocol in use is set with dual Subcarrier or single subcarrier.

Parameters:
Protocol_Settings: pointer on the structure to use for verifying
Return values:
CR95HF_DUAL_SUBCARRIERS: dual subcarrier is in use
CR95HF_SINGLE_SUBCARRIER: single subcarrier is in use
CR95HF_INVALID_PROTOCOL: the protocol in use is not ISO15693
u8 ISO15693_Get_UID_from_EEPROM ( u8 *  UID_Tag,
u8  UID_number 
)

This function retrieves the UID stored into the EEPROM by the inventory 16 slots commands.

Parameters:
UID_Tag: pointer on the UID to fill in with the data stored in the EEPROM
UID_number: the number of the UID to retrieved . For instance to retrieved the UID number 3 UID_number=3 and UID_number=1 for the first one
Return values:
ISO15693_ERROR_CODE: the MSB of the UID is not E0 data shouls have been modified
ISO15693_SUCCESS_CODE: there is no sign of error into the UID retrieved
 All Data Structures Files Functions Variables Defines