mbed OS 5 example application using X-NUCLEO-NFC02A1
Dependencies: NDefLib X_NUCLEO_NFC02A1
Fork of HelloWorld_NFC02A1 by
X_NUCLEO_NFC02A1/m24lr/NDefNfcTagM24LR.cpp
- Committer:
- rosarium
- Date:
- 2016-08-30
- Revision:
- 1:11ae12d41082
- Child:
- 2:6f1b1f7f8d12
File content as of revision 1:11ae12d41082:
/**
******************************************************************************
* @file NdefNfcTagM24LR.cpp
* @author AMG Central Lab
* @version V1.0.0
* @date 30 Aug 2016
* @brief Wrapper class of the NDefLib library to write/read NDEF messages.
******************************************************************************
* @attention
*
* <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of STMicroelectronics nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
******************************************************************************
*/
#include <cmath>
#include "NDefNfcTagM24LR.h"
/* wait 1sec, driver is configured to let 200ms for command to complete */
/* which is enough for all commands except GetSession if RF session is already opened */
/* Smartphone generally releases the session within the second, anyway the user can modify this value */
#define OPENSESSION_NTRIALS 5
#define CC_FILE_LENGTH_BYTE 15
/**
* @brief This function read the data stored in NDEF file at defined offset.
* @param Offset : Offset in the NDEF file.
* @param DataSize : Number of byte to read.
* @param pData : pointer on buffer to store read data.
* @retval NDEF_ERROR_MEMORY_INTERNAL : Size not compatible with memory.
* @retval NDEF_ERROR_NOT_FORMATED : CCFile data not supported.
* @retval NDEF_ERROR : No NDEF in the tag.
* @retval NDEF_OK : The operation is completed.
*/
uint16_t NDefNfcTagM24LR::ReadData( uint16_t Offset , uint16_t DataSize , uint8_t* pData )
{
uint16_t status = NDEF_ERROR;
uint8_t atlv_detect[4];
uint8_t index = 0;
/* Do not include length bytes */
DataSize -= FIRST_RECORD_OFFSET;
/* If too many data to write return error */
if( DataSize > NDEF_MAX_SIZE )
{
return NDEF_ERROR_MEMORY_INTERNAL;
}
/* Detect NDEF message in memory */
status = NfcType5_NDEFDetection( );
if( status != NDEF_OK )
{
return status;
}
/* Read TL of Type 5 */
status = NDefReadByte(CCFileStruct.NDEF_offset, 4, atlv_detect);
if( status != NDEF_OK )
{
return status;
}
/* Check if L is on 3 or 1 byte and update length in buffer */
if( atlv_detect[1] == NFCT5_3_BYTES_L_TLV )
{
pData[0] = atlv_detect[2];
pData[1] = atlv_detect[3];
index += 4;
}
else
{
pData[0] = 0x00;
pData[1] = atlv_detect[1];
index += 2;
}
/* Check CC file is in the correct mode to proceed */
if( CCFileStruct.State == TT5_INITIALIZED )
{
return NDEF_ERROR;
}
if( ((Offset == 0) && (DataSize > 0)) || (Offset > 0) )
{
/* Read NDEF */
if( NDefReadByte(CCFileStruct.NDEF_offset + index + Offset, DataSize, (pData + FIRST_RECORD_OFFSET)) != NFC_OK )
{
return NDEF_ERROR;
}
}
return NDEF_OK;
}
/**
* @brief This function writes data in NDEF file at defined offset.
* @param Offset : Offset in the NDEF file.
* @param DataSize : Number of byte to write.
* @param pData : pointer on buffer to copy.
* @retval NDEF_ERROR_MEMORY_INTERNAL : Size not compatible with memory.
* @retval NDEF_ERROR_NOT_FORMATED : CCFile data not supported.
* @retval NDEF_ERROR : No NDEF in the tag.
* @retval NDEF_OK : The operation is completed.
*/
uint16_t NDefNfcTagM24LR::WriteData( uint16_t Offset , uint32_t DataSize , uint8_t *pData )
{
uint8_t atlv[4];
uint8_t index = 0;
uint16_t NDEF_Size = 0;
bool status;
/* Do not include length bytes */
DataSize -= FIRST_RECORD_OFFSET;
/* If too many data to write return error */
if( DataSize > NDEF_MAX_SIZE )
{
return NDEF_ERROR_MEMORY_INTERNAL;
}
/* Detect NDEF message in memory */
if( NfcType5_NDEFDetection( ) != NDEF_OK )
{
return NDEF_ERROR;
}
/* Extract NDEF Size from buffer */
NDEF_Size = (uint16_t)(pData[0] << 8);
NDEF_Size = NDEF_Size | (uint16_t)(pData[1] );
/* If entire NDEF is written, update Length of Type 5 */
if( DataSize == NDEF_Size )
{
/* Check if L is on 3 or 1 byte */
if( NDEF_Size >= NFCT5_3_BYTES_L_TLV )
{
/* First init L with 0, will be updated at the end */
atlv[1] = 0x00;
atlv[2] = 0x00;
atlv[3] = 0x00;
status = NDefWriteByte( (atlv + 1), 3, (CCFileStruct.NDEF_offset + 1));
index += 4;
}
else
{
/* First inti L with 0, will be updated at the end */
atlv[1] = 0x00;
status = NDefWriteByte( (atlv + 1), 1, (CCFileStruct.NDEF_offset + 1));
index += 2;
}
}
/* Start write NDEF message to EEPROM */
status = NDefWriteByte( (pData + FIRST_RECORD_OFFSET), DataSize, CCFileStruct.NDEF_offset + index + Offset);
if( status != NFC_OK )
{
return NDEF_ERROR;
}
/* If entire NDEF is written, update Length of Type 5 */
if( DataSize == NDEF_Size )
{
/* Check if L is on 3 or 1 byte */
if( NDEF_Size >= NFCT5_3_BYTES_L_TLV )
{
/* Update Length value */
atlv[1] = NFCT5_3_BYTES_L_TLV;
atlv[2] = pData[0];
atlv[3] = pData[1];
status = NDefWriteByte( (atlv + 1), 3, (CCFileStruct.NDEF_offset + 1));
}
else
{
/* Update Length value */
atlv[1] = pData[1];
status = NDefWriteByte( (atlv + 1), 1, (CCFileStruct.NDEF_offset + 1));
}
/* Write Terminator TLV */
atlv[0] = NFCT5_TERMINATOR_TLV;
status = NDefWriteByte( atlv, 1, CCFileStruct.NDEF_offset + index + NDEF_Size);
}
return NDEF_OK;
}
/**
* @brief This functions writes CCFile in EEPROM.
* @Param pCCBuffer : pointer on the buffer containnig CC file.
* @retval NFCTAG status.
*/
uint16_t NDefNfcTagM24LR::NfcType5_WriteCCFile( const uint8_t * const pCCBuffer )
{
bool ret_value;
/* Write first block of CCFile */
ret_value = NDefWriteByte( pCCBuffer, 0x4, 0x00);
/* If extended memory writes the next 4 bytes */
if( (pCCBuffer[2] == 0x00) && (ret_value == NFC_OK) )
{
ret_value = NDefWriteByte( pCCBuffer + 4, 4, 0x04);
}
if( ret_value != NFC_OK )
{
return NDEF_ERROR;
}
return NDEF_OK;
}
uint16_t NDefNfcTagM24LR::NfcType5_ReadCCFile( uint8_t * const pCCBuffer )
{
bool ret_value;
/* Read 4 bytes of CC File */
ret_value = NDefReadByte(0x00, 4, pCCBuffer);
/* If extended memory reads the next 4 bytes */
if( (pCCBuffer[2] == 0x00) && (ret_value == NFC_OK) )
{
ret_value = NDefReadByte(0x04, 4, pCCBuffer + 4 );
}
if( ret_value != NFC_OK )
{
return NDEF_ERROR;
}
return NDEF_OK;
}
uint16_t NDefNfcTagM24LR::NfcType5_TT5Init( void )
{
bool ret_value = NFC_OK;
uint16_t status;
uint8_t accbuffer[8];
uint8_t cdata;
/* Prepare buffer to update CCFile */
accbuffer[0] = CCFileStruct.MagicNumber;
accbuffer[1] = CCFileStruct.Version;
accbuffer[2] = CCFileStruct.MemorySize;
accbuffer[3] = CCFileStruct.TT5Tag;
CCFileStruct.NDEF_offset = 0x04;
/* If extended memory prepare the length bytes */
if( CCFileStruct.MemorySize == NFCT5_EXTENDED_CCFILE )
{
accbuffer[6] = (uint8_t)(CCFileStruct.ExtMemorySize >> 8);
accbuffer[7] = (uint8_t)(CCFileStruct.ExtMemorySize & 0xFF);
CCFileStruct.NDEF_offset = 0x08;
}
/* Update CCFile */
status = NfcType5_WriteCCFile( accbuffer );
if( status != NDEF_OK )
{
return status;
}
/* Update NDEF TLV for INITIALIZED state */
/* Update T */
cdata = NFCT5_NDEF_MSG_TLV;
ret_value = NDefWriteByte( &cdata, 1, CCFileStruct.NDEF_offset);
if( ret_value != NFC_OK )
{
return NDEF_ERROR;
}
/* Update L */
cdata = 0x00;
ret_value = NDefWriteByte( &cdata, 1, (CCFileStruct.NDEF_offset + 1));
if( ret_value != NFC_OK )
{
return NDEF_ERROR;
}
return NDEF_OK;
}
uint16_t NDefNfcTagM24LR::NfcType5_NDEFDetection( void )
{
uint8_t acc_buffer[8];
uint8_t atlv_detect[4];
uint16_t status;
uint32_t memory_size;
CCFileStruct.State = TT5_NO_NDEF;
/* Read CCFile */
status = NfcType5_ReadCCFile( acc_buffer );
if( status != NDEF_OK )
{
return status;
}
/* Check Byte 0 is equal to magic number */
if( ( acc_buffer[0] != NFCT5_MAGICNUMBER_E1_CCFILE ) && ( acc_buffer[0] != NFCT5_MAGICNUMBER_E2_CCFILE ) )
{
return NDEF_ERROR_NOT_FORMATED;
}
/* Check Version number */
else if( ( (acc_buffer[1]&0xFC) != 0x40 ) )
{
return NDEF_ERROR_NOT_FORMATED;
}
/* Check if CCFile is on 4 Bytes or 8 Bytes */
if( acc_buffer[2] == 0x00 )
{
/* Update CCFIle structure */
CCFileStruct.MemorySize = 0x0;
CCFileStruct.ExtMemorySize = (uint16_t)acc_buffer[6];
CCFileStruct.ExtMemorySize = ( CCFileStruct.ExtMemorySize << 8 ) | acc_buffer[7];
memory_size = CCFileStruct.ExtMemorySize;
CCFileStruct.NDEF_offset = 8;
}
else
{
/* Update CCFIle structure */
CCFileStruct.MemorySize = acc_buffer[2];
CCFileStruct.ExtMemorySize = 0x0;
memory_size = CCFileStruct.MemorySize;
CCFileStruct.NDEF_offset = 4;
}
/* Update CCFIle structure */
CCFileStruct.MagicNumber = acc_buffer[0];
CCFileStruct.Version = acc_buffer[1];
CCFileStruct.TT5Tag = acc_buffer[3];
/* Search for position of NDEF TLV in memory and tag status */
while( ( NDefReadByte(CCFileStruct.NDEF_offset, 4, atlv_detect) == NFC_OK ) && ( CCFileStruct.NDEF_offset < memory_size ) )
{
/* Detect first NDEF Message in memory */
if( atlv_detect[0] == NFCT5_NDEF_MSG_TLV )
{
if( atlv_detect[1] == 0x00 )
{
CCFileStruct.State = TT5_INITIALIZED;
}
else
{
if( CCFileStruct.Version & 0x3 )
{
CCFileStruct.State = TT5_READ;
}
else
{
CCFileStruct.State = TT5_READ_WRITE;
}
}
return NDEF_OK;
}
/* If Proprietary NDEF jump to end of proprietary message */
else if( atlv_detect[0] == NFCT5_PROPRIETARY_TLV )
{
if( atlv_detect[1] == NFCT5_3_BYTES_L_TLV )
{
CCFileStruct.NDEF_offset = CCFileStruct.NDEF_offset + ( (uint32_t)atlv_detect[2] << 8 ) + atlv_detect[3];
continue;
}
else
{
CCFileStruct.NDEF_offset = CCFileStruct.NDEF_offset + atlv_detect[1];
continue;
}
}
/* if Terminator no NDEF detected */
else if( atlv_detect[0] == NFCT5_TERMINATOR_TLV )
{
return NDEF_ERROR_NOT_FORMATED;
}
CCFileStruct.NDEF_offset++;
}
return NDEF_ERROR_NOT_FORMATED;
}
bool NDefNfcTagM24LR::openSession(bool force) {
bool status;
// if (isSessionOpen()){
// mCallBack->onSessionOpen(this,true);
// return true;
// }
//
// mDevice.SetCallback(&mOpenSessionCallback);
// if(force)
// return mDevice.ForceGetSession() == NFC_SUCCESS;
// else
// return mDevice.GetSession() == NFC_SUCCESS;
status = NfcType5_NDEFDetection();
if ( status != NFC_SUCCESS )
{
CCFileStruct.MagicNumber = NFCT5_MAGICNUMBER_E1_CCFILE;
CCFileStruct.Version = NFCT5_VERSION_V1_0;
CCFileStruct.MemorySize = ( M24LR_MAX_SIZE / 8 ) & 0xFF;
CCFileStruct.TT5Tag = 0x05;
/* Init of the Type Tag 5 component (M24LR) */
while( NfcType5_TT5Init( ) != NFC_OK );
}
mIsSessionOpen = 1;
return NFC_SUCCESS;
}
bool NDefNfcTagM24LR::closeSession() {
return NFC_SUCCESS;
}
bool NDefNfcTagM24LR::writeByte(const uint8_t *buffer, uint16_t length,uint16_t offset,
byteOperationCallback_t callback,CallbackStatus_t *callbackStatus){
return WriteData(offset + FIRST_RECORD_OFFSET, length, (uint8_t*)buffer);
}
bool NDefNfcTagM24LR::readByte(const uint16_t byteOffset, const uint16_t length,
uint8_t *buffer, byteOperationCallback_t callback,CallbackStatus_t *callbackStatus){
return ReadData(byteOffset, length, (uint8_t*)buffer);
}
bool NDefNfcTagM24LR::NDefWriteByte(const uint8_t *buffer, uint16_t length,uint16_t offset){
return mDevice.UpdateBinary(offset, length, (uint8_t*)buffer);
}
bool NDefNfcTagM24LR::NDefReadByte(const uint16_t byteOffset, const uint16_t length, uint8_t *buffer){
return mDevice.ReadBinary(byteOffset, length, (uint8_t*)buffer);
}
