X_NUCLEO_NFC02A1 library for M24LR
Dependencies: ST_INTERFACES
Dependents: HelloWorld_NFC02A1_mbedOS HelloWorld_NFC02A1laatste HelloWorld_NFC02A1
Fork of X_NUCLEO_NFC02A1 by
X-NUCLEO-NFC02A1 Dynamic NFC Tag Expansion Board Firmware Package
Introduction
This firmware package includes Components Device Drivers, Board Support Package and example applications for STMicroelectronics X-NUCLEO-NFC02A1 Dynamic NFC Tag Expansion Board based on M24LR.
Firmware Library
Class X_NUCLEO_NFC02A1 is intended to represent the Dynamic NFC Tag Expansion Board with the same name.
It provides an API to access to the M24LR component and to the three onboard LEDs.
It is intentionally implemented as a singleton because only one X_NUCLEO_NFC02A1 at a time might be deployed in a HW component stack.
The library also provides an implementation of the NDEF library API for M24LR, providing an simple way to read/write NDEF formatted messages from/to the M24LR dynamic NFC tag.
Example application
Hello World is a simple application to program and read an URI from the NFC tag.
Diff: m24lr/M24LR.cpp
- Revision:
- 6:8c1eca41b3a9
- Child:
- 7:b876cdcf095a
diff -r 900640bf1cff -r 8c1eca41b3a9 m24lr/M24LR.cpp --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/m24lr/M24LR.cpp Fri May 19 07:51:32 2017 +0000 @@ -0,0 +1,1022 @@ +/** + ****************************************************************************** + * @file m24lr.cpp + * @author AMG Central Lab + * @version V2.0.0 + * @date 19 May 2017 + * @brief M24LR driver file. + ****************************************************************************** + * @attention + * + * <h2><center>© COPYRIGHT(c) 2015 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 "M24LR.h" + +uint8_t M24LR::NfctagInitialized = 0; + + +/** + * @brief This function activate Energy Harvesting mode + */ +void M24LR::enable_energy_harvesting( void ) +{ + /* Initialise M24LR Board */ + + /* Enable Energy Harvesting */ + i2c_set_EH( ); + + /* Store configuration in non Volatile Memory */ + i2c_enable_EH_mode(); + i2c_write_EH_cfg( M24LR_EH_Cfg_6MA ); + +} +/** + * @brief Set M24LR nfctag Initialization + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::initialization( void ) +{ + uint8_t nfctag_id = 0; + + if( NfctagInitialized == 0 ) + { + + /* M24LR Init */ + if( i2c_init() != NFCTAG_OK ) + { + return NFCTAG_ERROR; + } + + /* Check M24LR driver ID */ + i2c_read_id(&nfctag_id); + if( (nfctag_id == I_AM_M24LR04) || (nfctag_id == I_AM_M24LR16) || (nfctag_id == I_AM_M24LR64) ) + { + NfctagInitialized = 1; + // Nfctag_Drv = &M24lr_i2c_Drv; + // Nfctag_Drv->pData = &M24lr_i2c_ExtDrv; + } + else + { + NfctagInitialized = 0; + // Nfctag_Drv = NULL; + // NfctagInitialized = 0; + return NFCTAG_ERROR; + } + } + + return NFCTAG_OK; +} + +/** + * @brief Set M24LR Initialization + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_init( void ) +{ + /* Configure the low level interface */ + return(NFCTAG_OK); + // return mM24LR_IO.Init( ); +} + +/** + * @brief Read M24LR ID + * @param pICRef : pointer to store ID + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_id( uint8_t * const pData ) +{ + uint8_t *pBuffer = (uint8_t *)pData; + NFCTAG_StatusTypeDef status; + /* Read ICRef on device */ + //return M24LR_i2c_read_register( pICRef, M24LR_ICREF_REG, 1 ); + /* Before calling this function M24LR must be ready, here is a check to detect an issue */ + status = i2c_read_register(pBuffer, M24LR_ICREF_REG, 1); + + if (status == 0) + return NFCTAG_OK; + return NFCTAG_TIMEOUT; + +} + +/** + * @brief Check M24LR availability + * @param Trials : number of max tentative tried + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_is_device_ready( const uint32_t Trials ) +{ + /* Test i2c with M24LR */ + // return mM24LR_IO.IsDeviceReady( M24LR_ADDR_DATA_I2C, Trials ); + uint8_t status = 1; + char buffer; + while (status != 0) { + /* for device is ready address in M24Lr is M24LR_ADDR_DATA_I2C */ + status = dev_I2C.read(i2c_address_data, &buffer, 1, false); + } + if ( status == 0 ) + return NFCTAG_OK; + else + return NFCTAG_TIMEOUT; + +} + +/** + * @brief Configure M24LR GPO + * @param ITConf : 0x01 = RFBUSY, 0x02 = RFWIP + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_configure_GPO( const uint16_t ITConf ) +{ + NFCTAG_StatusTypeDef status = NFCTAG_ERROR; + + /* Configure GPO function on M24LR */ + if( (ITConf & M24LR_IT_BUSY_MASK) == M24LR_IT_BUSY_MASK ) + { + status = i2c_setRF_Busy( ); + } + else if( (ITConf & M24LR_IT_WIP_MASK) == M24LR_IT_WIP_MASK ) + { + status = i2c_set_RF_WIP( ); + } + return status; +} + +/** + * @brief Configure GPO as RF WriteInProgress + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_set_RF_WIP( void ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + status = i2c_read_register(®_value, M24LR_CFG_REG, 1); + + + if( status != NFCTAG_OK ) + { + return status; + } + + /* Update register value for WIP configuration */ + reg_value |= M24LR_CFG_WIPBUSY_MASK; + + /* Write CFG register */ + return i2c_write_register( ®_value, M24LR_CFG_REG, 1 ); +} + + +/** + * @brief Get Configuration of M24LR GPO + * @param GPOStatus : 0x01 = RFBUSY, 0x02 = RFWIP + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_get_GPO_status( uint16_t * const pGPOStatus ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CFG register */ + status = i2c_read_register( ®_value, M24LR_CFG_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Extract RF WIP/BUSY information */ + if( (reg_value & M24LR_CFG_WIPBUSY_MASK) == M24LR_CFG_WIPBUSY_MASK ) + { + *pGPOStatus = M24LR_IT_WIP_MASK; + } + else + { + *pGPOStatus = M24LR_IT_BUSY_MASK; + } + + return NFCTAG_OK; +} + +/** + * @brief Read N bytes starting from specified I2C address + * @param pData : pointer of the data to store + * @param TarAddr : I2C data memory address to read + * @param NbByte : number of bytes to read + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_data( uint8_t * const pData, const uint16_t TarAddr, const uint16_t NbByte ) +{ + int status; + /* Before calling this function M24LR must be ready, here is a check to detect an issue */ + if( i2c_is_device_ready( 1 ) != NFCTAG_OK ) + { + return NFCTAG_TIMEOUT; + } + /* Rosarium : To check M24LR_ADDR_DATA_I2C is this case */ + /* return M24lr_IO_MemRead( pData, M24LR_ADDR_DATA_I2C, TarAddr, NbByte ); */ + status = dev_I2C.i2c_read(pData, i2c_address_data, TarAddr, NbByte); + if ( status == 0 ) + return NFCTAG_OK; + else + return NFCTAG_TIMEOUT; +} + +/** + * @brief Write N data bytes starting from specified I2C Address + * @brief if I2C_Write_Lock bit = 0 or I2C_Password present => ack (modification OK) + * @brief if I2C_Write_Lock bit = 1 and no I2C_Password present => No ack (no modification) + * @param pData : pointer of the data to write + * @param TarAddr : I2C data memory address to write + * @param NbByte : number of bytes to write + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_write_data( const uint8_t * const pData, const uint16_t TarAddr, const uint16_t NbByte ) +{ + int status; + uint8_t align_mem_offset; + uint16_t bytes_to_write = NbByte; + uint16_t mem_addr = TarAddr; + uint8_t *pdata_index = (uint8_t *)pData; + + /* Before calling this function M24LR must be ready, here is a check to detect an issue */ + if( i2c_is_device_ready( 1 ) != NFCTAG_OK ) + { + return NFCTAG_TIMEOUT; + } + + /* M24LR can write a maximum of 4 bytes in EEPROM per i2c communication */ + do + { + /* To write data in M24LR, data must be aligned on the same row in memory */ + /* align_mem_offset is used to copy only Bytes that are on the same row in memory */ + if( bytes_to_write > M24LR_PAGEWRITE_NBBYTE ) + { + /* DataSize higher than max page write, copy data by page */ + align_mem_offset = M24LR_PAGEWRITE_NBBYTE - (mem_addr % M24LR_PAGEWRITE_NBBYTE); + } + else + { + /* DataSize lower or equal to max page write, copy only last bytes */ + align_mem_offset = bytes_to_write; + } + /* Write align_mem_offset bytes in memory */ + /* Rosarium to Check as the address here is 0xA6 rather than 0xAE */ + /* Rosarium dev_I2C.i2c_write(pdata_index, M24LR_ADDR_DATA_I2C, mem_addr, align_mem_offset); */ + status = dev_I2C.i2c_write(pdata_index, i2c_address_data, mem_addr, align_mem_offset); + + /* update index, dest address, size for next write */ + pdata_index += align_mem_offset; + mem_addr += align_mem_offset; + bytes_to_write -= align_mem_offset; + /* Poll until EEPROM is available */ + while( i2c_is_device_ready( 1 ) != NFCTAG_OK ) {}; + } + while( ( bytes_to_write > 0 ) && ( status == NFCTAG_OK ) ); + if ( status == 0 ) + return NFCTAG_OK; + else + return NFCTAG_ERROR; +} + +/** + * @brief Read N register bytes starting from specified I2C address + * @param pData : pointer of the data to store + * @param TarAddr : I2C memory address to read + * @param NbByte : number of bytes to read + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_register( uint8_t * const pData, const uint16_t TarAddr, const uint16_t NbByte ) +{ + /* Before calling read function M24LR must be ready, here is a check to detect an issue */ + int status; + + /* Before calling any read function M24LR must be ready, here is a check to detect an issue */ + if( i2c_is_device_ready( 1 ) != NFCTAG_OK ) + { + return NFCTAG_TIMEOUT; + } + /* Read actual value of register */ + status = dev_I2C.i2c_read(pData, i2c_address_syst, TarAddr, NbByte); + + if ( status == 0 ) + return NFCTAG_OK; + else + return NFCTAG_TIMEOUT; +} + +/** + * @brief Write N bytes to specific register + * @param pData : pointer of the data to write + * @param TarAddr : I2C register address to write + * @param NbByte : number of bytes to write + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_write_register( const uint8_t * const pData, const uint16_t TarAddr, const uint16_t NbByte ) +{ + int status; + uint8_t align_mem_offset; + uint16_t bytes_to_write = NbByte; + uint16_t mem_addr = TarAddr; + uint8_t *pdata_index = (uint8_t *)pData; + + /* Before calling this function M24LR must be ready, here is a check to detect an issue */ + if( i2c_is_device_ready( 1 ) != NFCTAG_OK ) + { + return NFCTAG_TIMEOUT; + } + + /* M24LR can write a maximum of 4 bytes in EEPROM per i2c communication */ + do + { + /* To write data in M24LR, data must be aligned on the same row in memory */ + /* align_mem_offset is used to copy only Bytes that are on the same row in memory */ + if( bytes_to_write > M24LR_PAGEWRITE_NBBYTE ) + { + /* DataSize higher than max page write, copy data by page */ + align_mem_offset = M24LR_PAGEWRITE_NBBYTE - (mem_addr % M24LR_PAGEWRITE_NBBYTE); + } + else + { + /* DataSize lower or equal to max page write, copy only last bytes */ + align_mem_offset = bytes_to_write; + } + /* Write align_mem_offset bytes in register */ + // status = M24lr_IO_MemWrite( pdata_index, M24LR_ADDR_SYST_I2C, mem_addr, align_mem_offset ); + status = dev_I2C.i2c_write(pdata_index, i2c_address_syst, mem_addr, align_mem_offset); + /* update index, dest address, size for next write */ + pdata_index += align_mem_offset; + mem_addr += align_mem_offset; + bytes_to_write -= align_mem_offset; + /* Poll until EEPROM is available */ + while( i2c_is_device_ready( 1 ) != NFCTAG_OK ) {}; + } + while( ( bytes_to_write > 0 ) && ( status == NFCTAG_OK ) ); + + if ( status == 0 ) + return NFCTAG_OK; + else + return NFCTAG_ERROR; +} + +/** + * @brief Read M24LR UID + * @param UID : M24LR_UID pointer of the UID to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_UID( M24LR_UID * const pUid ) +{ + uint8_t areg_value[8]; + uint8_t i; + NFCTAG_StatusTypeDef status; + + /* Read actual value of UID registers */ + status = i2c_read_register( areg_value, M24LR_UID_REG, 8 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Store information in 2 WORD */ + pUid->MSB_UID = 0; + + for( i = 0; i < 4; i++ ) + { + pUid->MSB_UID = (pUid->MSB_UID << 8) | areg_value[7 - i]; + } + + pUid->LSB_UID = 0; + + for( i = 0; i < 4; i++ ) + { + pUid->LSB_UID = (pUid->LSB_UID << 8) | areg_value[3 - i]; + } + + return NFCTAG_OK; +} + +/** + * @brief Read DSFID + * @param pData : pointer of the DSFID to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_DSFID( uint8_t * const pDsfid ) +{ + /* Read actual value of DSFID register */ + return i2c_read_register( pDsfid, M24LR_DSFID_REG, 1 ); +} + +/** + * @brief Read AFI + * @param pData : pointer of the AFI to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_AFI( uint8_t * const pAfi ) +{ + /* Read actual value of AFI register */ + return i2c_read_register( pAfi, M24LR_AFI_REG, 1 ); +} + +/** + * @brief Read status of I2C Lock Sectors + * @param Lock_sector : M24LR_Lock_Sectors pointer of the I2c lock sector status to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_I2C_lock_sector( M24LR_Lock_Sectors * const pLock_sector ) +{ + uint8_t areg_value[8]; + NFCTAG_StatusTypeDef status; + + /* Read actual value of I2c Write Lock registers */ + status = i2c_read_register( areg_value, M24LR_LOCK_REG, 8 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Dispatch information to corresponding struct member */ + pLock_sector->sectors_63_56 = areg_value[7]; + pLock_sector->sectors_55_48 = areg_value[6]; + pLock_sector->sectors_47_40 = areg_value[5]; + pLock_sector->sectors_39_32 = areg_value[4]; + pLock_sector->sectors_31_24 = areg_value[3]; + pLock_sector->sectors_23_16 = areg_value[2]; + pLock_sector->sectors_15_8 = areg_value[1]; + pLock_sector->sectors_7_0 = areg_value[0]; + + return NFCTAG_OK; +} + +/** + * @brief Lock I2C write on an EEPROM Sectors + * @brief Need a presentation of I2C Password to be effective + * @param Sector : EEPROM Sector number to lock (between 0 to 63) + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_I2C_lock_sector( const uint8_t Sector ) +{ + NFCTAG_StatusTypeDef status; + uint8_t reg_value = 0; + uint16_t sector_write_lock_addr; + + /* Compute register address */ + sector_write_lock_addr = M24LR_LOCK_REG | (Sector >> 3); + + /* Read actual WriteLockStatus */ + status = i2c_read_register( ®_value, sector_write_lock_addr, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Compute and update new WriteLockStatus */ + reg_value |= 1 << ( Sector % 8 ); + + /* Write WriteLock register */ + return i2c_write_register( ®_value, sector_write_lock_addr, 1 ); +} + +/** + * @brief UnLock I2C write on a EEPROM Sector + * @brief Need an presentation of I2C Password to be effective + * @param pSector : EEPROM Sector number to unlock (between 0 to 63) + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_I2C_unlock_sector( const uint8_t Sector ) +{ + NFCTAG_StatusTypeDef status; + uint8_t reg_value = 0; + uint16_t sector_write_lock_addr; + + /* Compute register address */ + sector_write_lock_addr = M24LR_LOCK_REG | (Sector >> 3); + + /* Read actual WriteLockStatus */ + status = i2c_read_register( ®_value, sector_write_lock_addr, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Compute and update new WriteLockStatus */ + reg_value &= ~( 1 << ( Sector % 8 ) ); + + /* Write WriteLock register */ + return i2c_write_register( ®_value, sector_write_lock_addr, 1 ); +} + +/** + * @brief Present I2C password, authorize I2C write + * @param PassWord : Password value on 32bits + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_present_I2C_password( const uint32_t PassWord ) +{ + uint8_t ai2c_message[9] = {0}; + uint8_t i; + + /* Build I2C Message with Password + Validation code 0x09 + Password */ + ai2c_message[4] = 0x09; + i = 0; + while( i < 4 ) + { + ai2c_message[i] = ( PassWord >> (i * 8) ) & 0xFF; + ai2c_message[i + 5] = ( PassWord >> (i * 8) ) & 0xFF; + i++; + }; + + /* Present password to M24LR */ + return i2c_write_register( ai2c_message, M24LR_I2C_PWD_REG, 9 ); +} + +/** + * @brief Write new I2C password + * @brief Need to present good I2CPassword before using this function + * @param PassWord : new I2C PassWord value on 32bits + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_write_I2C_password( const uint32_t PassWord ) +{ + uint8_t ai2c_message[9] = {0}; + uint8_t i; + + /* Build I2C Message with Password + Validation code 0x07 + Password */ + ai2c_message[4] = 0x07; + i = 0; + while( i < 4 ) + { + ai2c_message[i] = ( PassWord >> (i * 8) ) & 0xFF; + ai2c_message[i + 5] = ( PassWord >> (i * 8) ) & 0xFF; + i++; + }; + + /* Write Password to register */ + return i2c_write_register( ai2c_message, M24LR_I2C_PWD_REG, 9 ); +} + +/** + * @brief Read SectorSecurityStatus (defining RF access allowed) + * @param SectorNb : Sector number to get RF security status + * @param pData : M24LR_SECTOR_SEC pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_SSSx( const uint8_t SectorNb, M24LR_SECTOR_SEC * const pData ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + uint16_t sector_security_addr; + + /* Compute Sector Security register address */ + sector_security_addr = M24LR_SSS_REG | SectorNb; + + /* Read actual value of SectorSecurityStatus register */ + status = i2c_read_register( ®_value, sector_security_addr, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Extract Sector Security Status configuration */ + pData->SectorLock = reg_value & M24LR_SSS_LOCK_MASK; + pData->RW_Protection = (reg_value & M24LR_SSS_RW_MASK) >> 1; + pData->PassCtrl = (reg_value & M24LR_SSS_PASSCTRL_MASK) >> 3; + + return NFCTAG_OK; +} + +/** + * @brief Write SectorSecurityStatus (defining RF access allowed) + * @brief Need an presentation of I2C Password to be effective + * @param SectorNb : Sector number to set RF security + * @param pData : M24LR_SECTOR_SEC pointer of the data to write + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_write_SSSx( const uint8_t SectorNb, const M24LR_SECTOR_SEC * const pData ) +{ + uint8_t reg_value; + uint16_t sector_security_addr; + + /* Compute Sector Security register address */ + sector_security_addr = M24LR_SSS_REG | SectorNb; + + /* Update Sector Security Status */ + reg_value = (pData->PassCtrl << 3) & M24LR_SSS_PASSCTRL_MASK; + reg_value |= ((pData->RW_Protection << 1) & M24LR_SSS_RW_MASK); + reg_value |= (pData->SectorLock & M24LR_SSS_LOCK_MASK); + + /* Write SectorSecurityStatus register */ + return i2c_write_register( ®_value, sector_security_addr, 1 ); +} + +/** + * @brief Read Memory Size info + * @param SizeInfo : M24LR_Mem_Size pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_mem_size( M24LR_Mem_Size * const pSizeInfo ) +{ + uint8_t areg_value[3]; + NFCTAG_StatusTypeDef status; + + /* Read actual value of Mem_Size register */ + status = i2c_read_register( areg_value, M24LR_MEMSIZE_REG, 3 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Extract Mem information */ + pSizeInfo->BlockSize = areg_value[2]; + pSizeInfo->Mem_Size = areg_value[1]; + pSizeInfo->Mem_Size = (pSizeInfo->Mem_Size << 8) | areg_value[0]; + + return NFCTAG_OK; +} + +/** + * @brief Get GPO Configuration status + * @param Rf_Wip_Busy : M24LR_GPO_STATUS pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_get_RF_WIP_busy( M24LR_GPO_STATUS * const pRf_Wip_Busy ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CFG register */ + status = i2c_read_register( ®_value, M24LR_CFG_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Extract RF WIP/BUSY information */ + if( (reg_value & M24LR_CFG_WIPBUSY_MASK) == M24LR_CFG_WIPBUSY_MASK ) + { + *pRf_Wip_Busy = M24LR_GPO_WIP; + } + else + { + *pRf_Wip_Busy = M24LR_GPO_BUSY; + } + + return NFCTAG_OK; +} + +/** + * @brief Configure GPO as RF Busy + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_setRF_Busy( void ) +{ + uint8_t reg_value; + int status; + + /* Read actual value of CFG register */ + status = dev_I2C.i2c_read( ®_value, i2c_address_syst, (uint16_t)M24LR_CFG_REG, 1 ); + if( status != 0 ) + { + return NFCTAG_TIMEOUT; + } + + /* Update register value for BUSY configuration */ + reg_value &= !M24LR_CFG_WIPBUSY_MASK; + + /* Write CFG register */ + status = i2c_write_register( ®_value, M24LR_CFG_REG, 1 ); + if ( status == 0 ) + return NFCTAG_OK; + else + return NFCTAG_TIMEOUT; +} + + +/** + * @brief Get Energy harvesting mode status + * @param EH_mode : M24LR_EH_MODE_STATUS pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_EH_mode( M24LR_EH_MODE_STATUS * const pEH_mode ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CFG register */ + status = i2c_read_register( ®_value, M24LR_CFG_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Extract EH_mode configuration */ + if( (reg_value & M24LR_CFG_EHMODE_MASK) == M24LR_CFG_EHMODE_MASK ) + { + *pEH_mode = M24LR_EH_MODE_DISABLE; + } + else + { + *pEH_mode = M24LR_EH_MODE_ENABLE; + } + + return NFCTAG_OK; +} + +/** + * @brief Enable Energy harvesting mode + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_enable_EH_mode( void ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CFG register */ + status = i2c_read_register( ®_value, M24LR_CFG_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Update EH_mode */ + reg_value &= ~M24LR_CFG_EHMODE_MASK; + + /* Write CFG register */ + return i2c_write_register( ®_value, M24LR_CFG_REG, 1 ); +} + +/** + * @brief Disable Energy harvesting mode + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_disable_EH_mode( void ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CFG register */ + status = i2c_read_register( ®_value, M24LR_CFG_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Update EH_mode */ + reg_value |= M24LR_CFG_EHMODE_MASK; + + /* Write CFG register */ + return i2c_write_register( ®_value, M24LR_CFG_REG, 1 ); +} + +/** + * @brief Read Vout sink current configuration status for Energy Harvesting + * @param EH_Cfg : M24LR_EH_CFG_VOUT pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_read_EH_cfg( M24LR_EH_CFG_VOUT * const pEH_Cfg ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CFG register */ + status = i2c_read_register( ®_value, M24LR_CFG_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Extract Vout configuration for EH information */ + reg_value &= (M24LR_CFG_EHCFG1_MASK | M24LR_CFG_EHCFG0_MASK); + switch( reg_value ) + { + case 0: + *pEH_Cfg = M24LR_EH_Cfg_6MA; + break; + case 1: + *pEH_Cfg = M24LR_EH_Cfg_3MA; + break; + case 2: + *pEH_Cfg = M24LR_EH_Cfg_1MA; + break; + case 3: + *pEH_Cfg = M24LR_EH_Cfg_300UA; + break; + + default: + *pEH_Cfg = M24LR_EH_Cfg_6MA; + } + + return NFCTAG_OK; +} + +/** + * @brief Write Vout sink current configuration status for Energy Harvesting + * @param EH_Cfg : M24LR_EH_CFG_VOUT value to configure Vout + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_write_EH_cfg( const M24LR_EH_CFG_VOUT EH_Cfg ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CFG register */ + status = i2c_read_register( ®_value, M24LR_CFG_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Update Vout configuration */ + reg_value &= ~(M24LR_CFG_EHCFG1_MASK | M24LR_CFG_EHCFG0_MASK); + reg_value |= EH_Cfg; + + /* Write CFG register */ + return i2c_write_register( ®_value, M24LR_CFG_REG, 1 ); +} + +/** + * @brief Get Energy Harvesting status + * @param EH_Val : M24LR_EH_STATUS pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_get_EH( M24LR_EH_STATUS * const pEH_Val ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CTRL register */ + status = i2c_read_register( ®_value, M24LR_CTRL_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Extract EH information */ + if( (reg_value & M24LR_CTRL_EHEN_MASK) == M24LR_CTRL_EHEN_MASK ) + { + *pEH_Val = M24LR_EH_ENABLE; + } + else + { + *pEH_Val = M24LR_EH_DISABLE; + } + + return NFCTAG_OK; +} + +/** + * @brief Enable Energy Harvesting + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_set_EH( void ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CTRL register */ + status = i2c_read_register( ®_value, M24LR_CTRL_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Update EH configuration */ + reg_value |= M24LR_CTRL_EHEN_MASK; + + /* Write CTRL Register */ + return i2c_write_register( ®_value, M24LR_CTRL_REG, 1 ); +} + +/** + * @brief Disable Energy Harvesting + * @param None + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_reset_EH( void ) +{ + uint8_t reg_value; + NFCTAG_StatusTypeDef status; + + /* Read actual value of CTRL register */ + status = i2c_read_register( ®_value, M24LR_CTRL_REG, 1 ); + if( status != NFCTAG_OK ) + { + return status; + } + + /* Update EH configuration */ + reg_value &= ~M24LR_CTRL_EHEN_MASK; + + /* Write CTRL register */ + return i2c_write_register( ®_value, M24LR_CTRL_REG, 1 ); +} + +/** + * @brief Check if RF Field is present in front of M24LR + * @param pRF_Field : M24LR_FIELD_STATUS pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_get_RF_field( M24LR_FIELD_STATUS * const pRF_Field ) +{ + NFCTAG_StatusTypeDef status; + uint8_t reg_value = 0; + + /* Read actual value of CTRL register */ + status = i2c_read_register( ®_value, M24LR_CTRL_REG, 1 ); + + /* Extract RF Field information */ + if( status == NFCTAG_OK ) + { + if( (reg_value & M24LR_CTRL_FIELD_MASK) == M24LR_CTRL_FIELD_MASK ) + { + *pRF_Field = M24LR_FIELD_ON; + } + else + { + *pRF_Field = M24LR_FIELD_OFF; + } + + return NFCTAG_OK; + } + + return status; +} + +/** + * @brief Check if Write Timing is good + * @param pT_Prog : M24LR_T_PROG_STATUS pointer of the data to store + * @retval NFCTAG enum status + */ +NFCTAG_StatusTypeDef M24LR::i2c_get_TProg( M24LR_T_PROG_STATUS * const pT_Prog ) +{ + NFCTAG_StatusTypeDef status; + uint8_t reg_value = 0; + + /* Read actual value of CTRL register */ + status = i2c_read_register( ®_value, M24LR_CTRL_REG, 1 ); + + /* Extract T-Prog information */ + if( status == NFCTAG_OK ) + { + if( (reg_value & M24LR_CTRL_TPROG_MASK) == M24LR_CTRL_TPROG_MASK ) + { + *pT_Prog = M24LR_T_PROG_OK; + } + else + { + *pT_Prog = M24LR_T_PROG_NO; + } + + return NFCTAG_OK; + } + else + return status; +} + +/** + * @} + */ + +/** + * @} + */ + +/** + * @} + */ + +/** + * @} + */ + +/******************* (C) COPYRIGHT 2016 STMicroelectronics *****END OF FILE****/