Simplified access to Ramtron (Cypress) FM24Vxx F-RAM devices
Revision 1:6a16bddd7222, committed 2013-04-03
- Comitter:
- Yann
- Date:
- Wed Apr 03 12:51:20 2013 +0000
- Parent:
- 0:fa858f79d48d
- Child:
- 2:bf7d1264d3ff
- Commit message:
- Validate library and test application with FM24V10-G device
Changed in this revision
--- a/FM24Vxx_I2C.cpp Sat Mar 23 15:54:01 2013 +0000 +++ b/FM24Vxx_I2C.cpp Wed Apr 03 12:51:20 2013 +0000 @@ -57,6 +57,9 @@ // Retrieve device identifiers _deviceID = NULL; GetDevideIDs(); + + _sn = NULL; + GetSerialNumbers(); DEBUG_LEAVE("CFM24VXX_I2C") } @@ -94,10 +97,75 @@ return false; } - void CFM24VXX_I2C::GetDevideIDs() { - _deviceID = new CFM24VXX_IDs(0x00, 0x00, 0x00); + bool CFM24VXX_I2C::GetDevideIDs() { + DEBUG_ENTER("CFM24VXX_I2C::GetDevideIDs") + + // 1. Memory address + char i2cBuffer[1]; + i2cBuffer[0] = (unsigned char)(_slaveAddress & 0xfc); //FIXME Change 0xfc into a const SET_PAGE_SELECT_0 + DEBUG("CFM24VXX_I2C::GetDevideIDs: pI2CBuffer[0]: 0x%02x", i2cBuffer[0]) + // 2. Send I2C start + 0xF8 + I2C ReStart + if (_i2cInstance->write(0xf8, i2cBuffer, 1, true) == 0) { + wait(0.02); + DEBUG("CFM24VXX_I2C::GetDevideIDs: Write F8 done") + // 3. read data + I2C stop + unsigned char buffer[3]; + int result = _i2cInstance->read(0xf9, (char *)buffer, 3); + wait(0.02); + if (result == 0) { + // 4. Setup the device IDs + _deviceID = new CFM24VXX_IDs(buffer[0], buffer[1], buffer[2]); + DEBUG("CFM24VXX_I2C::GetDevideIDs: %02x - %02x - %02x", buffer[0], buffer[1], buffer[2]) + + DEBUG_LEAVE("CFM24VXX_I2C::GetDevideIDs: %x", (bool)(result == 0)) + return (bool)(result == 0); + } + } + + _deviceID = new CFM24VXX_IDs(0xff, 0xff, 0xff); + DEBUG_LEAVE("CFM24VXX_I2C::GetDevideIDs (false)") + return false; } + bool CFM24VXX_I2C::GetSerialNumbers() { + DEBUG_ENTER("CFM24VXX_I2C::GetSerialNumber") + // 1. Memory address + char i2cBuffer[1]; + i2cBuffer[0] = (unsigned char)(_slaveAddress & 0xfc); //FIXME Change 0xfc into a const SET_PAGE_SELECT_0 + DEBUG("CFM24VXX_I2C::GetSerialNumber: pI2CBuffer[0]: 0x%02x", i2cBuffer[0]) + // 2. Send I2C start + 0xF8 + I2C ReStart + if (_i2cInstance->write(0xf8, i2cBuffer, 1, true) == 0) { + wait(0.02); + DEBUG("CFM24VXX_I2C::GetSerialNumber: Write F8 done") + // 3. read data + I2C stop + unsigned char buffer[8]; // See FM24V10_ds.pdf Page 10/16 Figure 15. 8-Byte Serial Number (read-only) + int result = _i2cInstance->read(0xcd, (char *)buffer, 8); + wait(0.02); + if (result == 0) { + // 4. Check if it is supported + if (buffer[7] != 0x00) { // SN supported + // 5. Compute CRC + unsigned char crc = ChecksumSN(buffer); + // 6. Check CRCs + if (buffer[7] == crc) { + _sn = new CFM24VXX_SN(buffer); + DEBUG_LEAVE("CFM24VXX_I2C::GetSerialNumber: true") + return true; + } else { // SN supported + DEBUG_LEAVE("CFM24VXX_I2C::GetSerialNumber: Checksum mismatch") + return false; + } + } else { // SN supported + DEBUG_LEAVE("CFM24VXX_I2C::GetSerialNumber: Serial number not supported") + return true; + } + } + } + + DEBUG_LEAVE("CFM24VXX_I2C::GetSerialNumber (false)") + return false; + } + bool CFM24VXX_I2C::EraseMemoryArea(const short p_startAddress, const int p_count, const unsigned char p_pattern) { DEBUG_ENTER("CFM24VXX_I2C::EraseMemoryArea: 0x%02x - %d - 0x%02x", p_startAddress, p_count, p_pattern) @@ -211,6 +279,7 @@ bool CFM24VXX_I2C::Write(const short p_address, const char *p_datas, const bool p_storeLength, const int p_length2write) { DEBUG_ENTER("CFM24VXX_I2C::Write (char *): Memory address: 0x%02x - %x - %d", p_address, p_storeLength, p_length2write) + DEBUG("CFM24VXX_I2C::Write (char *): Slave address: %02x", _slaveAddress) // 1.Prepare buffer int length = (p_length2write == -1) ? strlen(p_datas) : p_length2write; if (p_storeLength) { @@ -299,7 +368,7 @@ // 2. Read data + I2C stop int result = _i2cInstance->read(_slaveAddress, i2cBuffer, 2); if (result == 0) { -DEBUG("CFM24VXX_I2C::Read (short): value: 0x%02x - 0x%02x", i2cBuffer[0], i2cBuffer[1]) + DEBUG("CFM24VXX_I2C::Read (short): value: 0x%02x - 0x%02x", i2cBuffer[0], i2cBuffer[1]) if (p_mode == BigEndian) { *p_short = (short)(i2cBuffer[0] << 8 | i2cBuffer[1]); } else { @@ -333,7 +402,7 @@ // 2. Read data + I2C stop int result = _i2cInstance->read(_slaveAddress, i2cBuffer, 4); if (result == 0) { -DEBUG("CFM24VXX_I2C::Read (int): value: 0x%02x - 0x%02x - 0x%02x - 0x%02x", i2cBuffer[0], i2cBuffer[1], i2cBuffer[2], i2cBuffer[3]) + DEBUG("CFM24VXX_I2C::Read (int): value: 0x%02x - 0x%02x - 0x%02x - 0x%02x", i2cBuffer[0], i2cBuffer[1], i2cBuffer[2], i2cBuffer[3]) wait(0.02); if (p_mode == BigEndian) { *p_int = (int)(i2cBuffer[0] << 24 | i2cBuffer[1] << 16 | i2cBuffer[2] << 8 | i2cBuffer[3]); @@ -470,7 +539,56 @@ DEBUG_LEAVE("CFM24VXX_I2C::Read (string) (false)") return false; } - + + unsigned char CFM24VXX_I2C::ChecksumSN(const unsigned char *pdatas, const unsigned int length) { + DEBUG_ENTER("CFM24VXX_I2C::ChecksumSN") + + unsigned char crctable[256] = { + 0x00, 0x07, 0x0E, 0x09, 0x1C, 0x1B, 0x12, 0x15, + 0x38, 0x3F, 0x36, 0x31, 0x24, 0x23, 0x2A, 0x2D, + 0x70, 0x77, 0x7E, 0x79, 0x6C, 0x6B, 0x62, 0x65, + 0x48, 0x4F, 0x46, 0x41, 0x54, 0x53, 0x5A, 0x5D, + 0xE0, 0xE7, 0xEE, 0xE9, 0xFC, 0xFB, 0xF2, 0xF5, + 0xD8, 0xDF, 0xD6, 0xD1, 0xC4, 0xC3, 0xCA, 0xCD, + 0x90, 0x97, 0x9E, 0x99, 0x8C, 0x8B, 0x82, 0x85, + 0xA8, 0xAF, 0xA6, 0xA1, 0xB4, 0xB3, 0xBA, 0xBD, + 0xC7, 0xC0, 0xC9, 0xCE, 0xDB, 0xDC, 0xD5, 0xD2, + 0xFF, 0xF8, 0xF1, 0xF6, 0xE3, 0xE4, 0xED, 0xEA, + 0xB7, 0xB0, 0xB9, 0xBE, 0xAB, 0xAC, 0xA5, 0xA2, + 0x8F, 0x88, 0x81, 0x86, 0x93, 0x94, 0x9D, 0x9A, + 0x27, 0x20, 0x29, 0x2E, 0x3B, 0x3C, 0x35, 0x32, + 0x1F, 0x18, 0x11, 0x16, 0x03, 0x04, 0x0D, 0x0A, + 0x57, 0x50, 0x59, 0x5E, 0x4B, 0x4C, 0x45, 0x42, + 0x6F, 0x68, 0x61, 0x66, 0x73, 0x74, 0x7D, 0x7A, + 0x89, 0x8E, 0x87, 0x80, 0x95, 0x92, 0x9B, 0x9C, + 0xB1, 0xB6, 0xBF, 0xB8, 0xAD, 0xAA, 0xA3, 0xA4, + 0xF9, 0xFE, 0xF7, 0xF0, 0xE5, 0xE2, 0xEB, 0xEC, + 0xC1, 0xC6, 0xCF, 0xC8, 0xDD, 0xDA, 0xD3, 0xD4, + 0x69, 0x6E, 0x67, 0x60, 0x75, 0x72, 0x7B, 0x7C, + 0x51, 0x56, 0x5F, 0x58, 0x4D, 0x4A, 0x43, 0x44, + 0x19, 0x1E, 0x17, 0x10, 0x05, 0x02, 0x0B, 0x0C, + 0x21, 0x26, 0x2F, 0x28, 0x3D, 0x3A, 0x33, 0x34, + 0x4E, 0x49, 0x40, 0x47, 0x52, 0x55, 0x5C, 0x5B, + 0x76, 0x71, 0x78, 0x7F, 0x6A, 0x6D, 0x64, 0x63, + 0x3E, 0x39, 0x30, 0x37, 0x22, 0x25, 0x2C, 0x2B, + 0x06, 0x01, 0x08, 0x0F, 0x1A, 0x1D, 0x14, 0x13, + 0xAE, 0xA9, 0xA0, 0xA7, 0xB2, 0xB5, 0xBC, 0xBB, + 0x96, 0x91, 0x98, 0x9F, 0x8A, 0x8D, 0x84, 0x83, + 0xDE, 0xD9, 0xD0, 0xD7, 0xC2, 0xC5, 0xCC, 0xCB, + 0xE6, 0xE1, 0xE8, 0xEF, 0xFA, 0xFD, 0xF4, 0xF3 + }; + unsigned char crc = 0x00; + unsigned int length_ = length; + unsigned char *pdata = (unsigned char *)pdatas; + while (length_-- != 0) { + crc = crctable[crc ^ *pdata++]; + DEBUG("CFM24VXX_I2C::ChecksumSN: current checksum= 0x%02x - pdata:%08x", crc, pdata) + } + + DEBUG_LEAVE("CFM24VXX_I2C::ChecksumSN: 0x%02x", crc) + return crc; + } + #if defined(__DEBUG) void CFM24VXX_I2C::DumpMemoryArea(const int p_address, const int p_count) { DEBUG_ENTER("CFM24VXX_I2C::DumpMemoryArea: %d - %d", p_address, p_count)
--- a/FM24Vxx_I2C.h Sat Mar 23 15:54:01 2013 +0000 +++ b/FM24Vxx_I2C.h Wed Apr 03 12:51:20 2013 +0000 @@ -23,6 +23,7 @@ #include <vector> #include "FM24Vxx_IDs.h" +#include "FM24Vxx_SN.h" #include "Debug.h" // Include mbed header + debug primitives. See DebugLibrary namespace _FM24VXX_I2C { @@ -50,9 +51,12 @@ /** An unique instance of I2C class */ I2C *_i2cInstance; - /** Device ID. Used for Sleep mode + /** Device ID */ CFM24VXX_IDs *_deviceID; + /** Serial number + */ + CFM24VXX_SN *_sn; public: /** Memory storage mode */ @@ -83,8 +87,15 @@ /** Used to return the unique device identifier */ - inline const CFM24VXX_IDs * GetDevideID() { return (const CFM24VXX_IDs *)_deviceID; }; + inline const CFM24VXX_IDs * GetDeviceID() { return (const CFM24VXX_IDs *)_deviceID; }; + /** + * Used to return the serial number + * Note This functionality is available only for the FM24VN10. In other case, it will return 0xff + * @remark See FM24V10_ds.pdf Page 10/16 Clause Unique Serial Number (FM24VN10 only) + */ + inline const CFM24VXX_SN * GetSerialNumber() { return (const CFM24VXX_SN *)_sn; }; + /** * Used to swith high speed mode * @param highSpeedMode Set to true to switch to high speed mode @@ -99,7 +110,7 @@ inline void EnterSleepMode() { /* FIXME To be done */ }; /** - * Used to enter in sleep mode + * Used to leave sleep mode * @remark See FM24V10_ds.pdf Page 8/16 Clause Sleep Mode */ inline void LeaveSpeedMode() { /* FIXME To be done */ }; @@ -109,7 +120,7 @@ * @param memoryPage The selected memory page (0 or 1) * @remark See FM24V10_ds.pdf Page 3/16 Clause Memory Architecture */ - inline void SelectMemoryPage(const unsigned char memoryPage) { _slaveAddress |= ((memoryPage & 0x01) << 1) | 0xa0; }; + inline void SelectMemoryPage(const unsigned char memoryPage) { _slaveAddress |= ((memoryPage & 0x01) << 1); }; /** Erase of memory area starting at the specified address, using the specified pattern to fill the memory area * @@ -338,12 +349,28 @@ std::string _internalId; private: - /** - * Retrieve device identifiers + + /** Retrieve device identifiers * @remark See FM24V10_ds.pdf Page 9/16 Clause Device ID */ - void GetDevideIDs(); + bool GetDevideIDs(); + /** + * Used to return the serial number + * Note This functionality is available only for the FM24VN10. In other case, it will return 0xff + * @remark See FM24V10_ds.pdf Page 10/16 Clause Unique Serial Number (FM24VN10 only) + */ + bool GetSerialNumbers(); + + /** + * Function to Calculate CRC + * @param pdatas The read Serial Number + * @param length The number of bytes in the pdatas array. Default: 7 bytes length + * @return The 8-bits length checksum + * @see See FM24V10_ds.pdf Page 10/16 Clause Unique Serial Number (FM24VN10 only) + */ + unsigned char ChecksumSN(const unsigned char *pdatas, const unsigned int length = 7); + }; // End of class CFM24VXX_I2C }; // End of namespace _FM24VXX_I2C
--- a/FM24Vxx_IDs.h Sat Mar 23 15:54:01 2013 +0000 +++ b/FM24Vxx_IDs.h Wed Apr 03 12:51:20 2013 +0000 @@ -25,13 +25,13 @@ /** * Device ID description - * @remark See Figure 14. Manufacturer and Product ID + * @remark See FM24V10_ds Figure 14. Manufacturer and Product ID */ class CFM24VXX_IDs { /** Device ID description */ - struct { + struct { // FM24V10_ds Figure 14. Manufacturer and Product ID unsigned char manufacturerID; union { unsigned char id; @@ -40,21 +40,24 @@ unsigned char density:4; } vd; } productID; - unsigned char dieRevision; + struct { + unsigned char dierev:3; + unsigned char reserved:5; + } dieRevision; } _deviceID; public: inline CFM24VXX_IDs(const unsigned char manufacturerID, const unsigned char productID, const unsigned char dieRevision) { _deviceID.manufacturerID = manufacturerID; _deviceID.productID.id = productID; - _deviceID.dieRevision = dieRevision; + _deviceID.dieRevision.dierev = dieRevision & 0x07; // FM24V10_ds Figure 14. Manufacturer and Product ID } // End of Constructor inline unsigned char GetManufacturerID() const { return _deviceID.manufacturerID; }; inline unsigned char GetProductID() const { return _deviceID.productID.id; }; - inline unsigned char GetRevisionID() const { return _deviceID.dieRevision; }; + inline unsigned char GetRevisionID() const { return _deviceID.dieRevision.dierev; }; inline unsigned char GetDensity() const { return _deviceID.productID.vd.density >> 4; };
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/FM24Vxx_SN.h Wed Apr 03 12:51:20 2013 +0000 @@ -0,0 +1,62 @@ +/* mbed simplified access to RAMTRON FV24xx Serial 3V F-RAM Memory (I2C) + * Copyright (c) 2013 ygarcia, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ +#if !defined(__FM24VXX_SN_H__) +#define __FM24VXX_SN_H__ + +#include <mbed.h> +//#include "Debug.h" + +namespace _FM24VXX_I2C { + +/** + * Device ID description + * @remark See FM24V10_ds Figure 14. Manufacturer and Product ID + */ +class CFM24VXX_SN { + + /** Serial number description + */ + union { // See FM24V10_ds Figure 15. 8-Byte Serial Number (read-only) + unsigned char snumber[8]; + struct { + unsigned char crc; + unsigned char un[5]; + unsigned char cid[2]; + } sn; + } _sn; + + public: + inline CFM24VXX_SN(const unsigned char *pdatas) { +// for (int i = 0; i < 8; i++) { +// DEBUG("CFM24VXX_SN::CFM24VXX_SN: byte #%d = 0x%02x", i, *(pdatas + i)) +// } + memcpy((void *)&(_sn.snumber[0]), pdatas, 8 * sizeof(unsigned char)); + } // End of Constructor + + inline unsigned short GetCustomerID() const { return _sn.sn.cid[0] << 8 | _sn.sn.cid[1]; }; + + inline unsigned char * GetUniqueID() const { return (unsigned char *)&(_sn.sn.un[0]); }; + + inline unsigned char GetChecksum() const { return _sn.sn.crc; }; + +}; // End of class CFM24VXX_SN + +} // End of namespace _FM24VXX_I2C + +#endif // __FM24VXX_SN_H__