mirror of
https://github.com/RobTillaart/Arduino.git
synced 2024-09-19 16:46:11 -04:00
+ version 1.2.02
+ corrected version number + corrected history in .cpp + stricter interface where possible
This commit is contained in:
rob tillaart
parent
a4312c1b98
commit
9f891dc3a9
@ -1,7 +1,7 @@
|
||||
//
|
||||
// FILE: I2C_eeprom.cpp
|
||||
// AUTHOR: Rob Tillaart
|
||||
// VERSION: 1.1.00
|
||||
// VERSION: 1.2.02
|
||||
// PURPOSE: I2C_eeprom library for Arduino with EEPROM 24LC256 et al.
|
||||
//
|
||||
// HISTORY:
|
||||
@ -20,8 +20,9 @@
|
||||
// 1.1.00 - 2013-11-13 added begin() function (Note breaking interface)
|
||||
// use faster block Wire.write()
|
||||
// int casting removed
|
||||
// 1.2.00 - 2015-05-21 Added support for Arduino DUE ( thanks to Tyler F.)
|
||||
// 1.2.01 - 2013-05-21 Refactoring
|
||||
// 1.2.00 - 2014-05-21 Added support for Arduino DUE ( thanks to Tyler F.)
|
||||
// 1.2.01 - 2014-05-21 Refactoring
|
||||
// 1.2.02 - 2015-03-06 stricter interface
|
||||
//
|
||||
// Released to the public domain
|
||||
//
|
||||
@ -29,24 +30,24 @@
|
||||
#include <I2C_eeprom.h>
|
||||
|
||||
#if defined(ARDUINO) && ARDUINO >= 100
|
||||
#define WIRE_WRITE Wire.write
|
||||
#define WIRE_READ Wire.read
|
||||
#define WIRE_WRITE Wire.write
|
||||
#define WIRE_READ Wire.read
|
||||
#else
|
||||
#define WIRE_WRITE Wire.send
|
||||
#define WIRE_READ Wire.receive
|
||||
#define WIRE_WRITE Wire.send
|
||||
#define WIRE_READ Wire.receive
|
||||
#endif
|
||||
|
||||
|
||||
I2C_eeprom::I2C_eeprom(uint8_t deviceAddress)
|
||||
I2C_eeprom::I2C_eeprom(const uint8_t deviceAddress)
|
||||
{
|
||||
I2C_eeprom(deviceAddress, I2C_EEPROM_PAGESIZE);
|
||||
}
|
||||
|
||||
I2C_eeprom::I2C_eeprom(uint8_t deviceAddress, unsigned int deviceSize)
|
||||
I2C_eeprom::I2C_eeprom(const uint8_t deviceAddress, const unsigned int deviceSize)
|
||||
{
|
||||
_deviceAddress = deviceAddress;
|
||||
|
||||
// Chips 16Kbit (2048KB) or smaller only have one-word addresses.
|
||||
// Chips 16Kbit (2048 Bytes) or smaller only have one-word addresses.
|
||||
// Also try to guess page size from device size (going by Microchip 24LCXX datasheets here).
|
||||
if (deviceSize <= 256)
|
||||
{
|
||||
@ -70,7 +71,7 @@ void I2C_eeprom::begin()
|
||||
Wire.begin();
|
||||
_lastWrite = 0;
|
||||
|
||||
// TWBR is not available on Arduino Due
|
||||
// TWBR is not available on Arduino Due
|
||||
#ifdef TWBR
|
||||
TWBR = 72;
|
||||
// 0=1000 1=888 2=800 8=500
|
||||
@ -81,44 +82,46 @@ void I2C_eeprom::begin()
|
||||
|
||||
|
||||
|
||||
int I2C_eeprom::writeByte(uint16_t memoryAddress, uint8_t data)
|
||||
int I2C_eeprom::writeByte(const uint16_t memoryAddress, const uint8_t data)
|
||||
{
|
||||
int rv = _WriteBlock(memoryAddress, &data, 1);
|
||||
return rv;
|
||||
}
|
||||
|
||||
int I2C_eeprom::setBlock(uint16_t memoryAddress, uint8_t data, uint16_t length)
|
||||
int I2C_eeprom::setBlock(const uint16_t memoryAddress, const uint8_t data, const uint16_t length)
|
||||
{
|
||||
uint8_t buffer[I2C_TWIBUFFERSIZE];
|
||||
for (uint8_t i = 0; i< I2C_TWIBUFFERSIZE; i++) buffer[i] = data;
|
||||
for (uint8_t i = 0; i < I2C_TWIBUFFERSIZE; i++) buffer[i] = data;
|
||||
|
||||
int rv = _pageBlock(memoryAddress, buffer, length, false);
|
||||
return rv;
|
||||
}
|
||||
|
||||
int I2C_eeprom::writeBlock(uint16_t memoryAddress, uint8_t* buffer, uint16_t length)
|
||||
int I2C_eeprom::writeBlock(const uint16_t memoryAddress, const uint8_t* buffer, const uint16_t length)
|
||||
{
|
||||
int rv = _pageBlock(memoryAddress, buffer, length, true);
|
||||
return rv;
|
||||
}
|
||||
|
||||
uint8_t I2C_eeprom::readByte(uint16_t memoryAddress)
|
||||
uint8_t I2C_eeprom::readByte(const uint16_t memoryAddress)
|
||||
{
|
||||
uint8_t rdata;
|
||||
_ReadBlock(memoryAddress, &rdata, 1);
|
||||
return rdata;
|
||||
}
|
||||
|
||||
uint16_t I2C_eeprom::readBlock(uint16_t memoryAddress, uint8_t* buffer, uint16_t length)
|
||||
uint16_t I2C_eeprom::readBlock(const uint16_t memoryAddress, uint8_t* buffer, const uint16_t length)
|
||||
{
|
||||
uint16_t addr = memoryAddress;
|
||||
uint16_t len = length;
|
||||
uint16_t rv = 0;
|
||||
while (length > 0)
|
||||
while (len > 0)
|
||||
{
|
||||
uint8_t cnt = min(length, I2C_TWIBUFFERSIZE);
|
||||
rv += _ReadBlock(memoryAddress, buffer, cnt);
|
||||
memoryAddress += cnt;
|
||||
uint8_t cnt = min(len, I2C_TWIBUFFERSIZE);
|
||||
rv += _ReadBlock(addr, buffer, cnt);
|
||||
addr += cnt;
|
||||
buffer += cnt;
|
||||
length -= cnt;
|
||||
len -= cnt;
|
||||
}
|
||||
return rv;
|
||||
}
|
||||
@ -126,12 +129,16 @@ uint16_t I2C_eeprom::readBlock(uint16_t memoryAddress, uint8_t* buffer, uint16_t
|
||||
#ifdef I2C_EEPROM_EXTENDED
|
||||
// returns 64, 32, 16, 8, 4, 2, 1, 0
|
||||
// 0 is smaller than 1K
|
||||
uint8_t I2C_eeprom::determineSize()
|
||||
int I2C_eeprom::determineSize()
|
||||
{
|
||||
uint8_t rv = 0; // unknown
|
||||
int rv = 0; // unknown
|
||||
uint8_t orgValues[8];
|
||||
uint16_t addr;
|
||||
|
||||
// try to read a byte to see if connected
|
||||
rv += _ReadBlock(0x00, orgValues, 1);
|
||||
if (rv == 0) return -1;
|
||||
|
||||
// remember old values, non destructive
|
||||
for (uint8_t i=0; i<8; i++)
|
||||
{
|
||||
@ -171,27 +178,29 @@ uint8_t I2C_eeprom::determineSize()
|
||||
// _pageBlock aligns buffer to page boundaries for writing.
|
||||
// and to TWI buffer size
|
||||
// returns 0 = OK otherwise error
|
||||
int I2C_eeprom::_pageBlock(uint16_t address, uint8_t* buffer, uint16_t length, bool incrBuffer)
|
||||
int I2C_eeprom::_pageBlock(const uint16_t memoryAddress, const uint8_t* buffer, const uint16_t length, const bool incrBuffer)
|
||||
{
|
||||
uint16_t addr = memoryAddress;
|
||||
uint16_t len = length;
|
||||
int rv = 0;
|
||||
while (length > 0)
|
||||
{
|
||||
uint8_t bytesUntilPageBoundary = this->_pageSize - address % this->_pageSize;
|
||||
uint8_t cnt = min(length, bytesUntilPageBoundary);
|
||||
uint8_t bytesUntilPageBoundary = this->_pageSize - addr % this->_pageSize;
|
||||
uint8_t cnt = min(len, bytesUntilPageBoundary);
|
||||
cnt = min(cnt, I2C_TWIBUFFERSIZE);
|
||||
|
||||
int rv = _WriteBlock(address, buffer, cnt);
|
||||
int rv = _WriteBlock(addr, buffer, cnt);
|
||||
if (rv != 0) return rv;
|
||||
|
||||
address += cnt;
|
||||
addr += cnt;
|
||||
if (incrBuffer) buffer += cnt;
|
||||
length -= cnt;
|
||||
len -= cnt;
|
||||
}
|
||||
return rv;
|
||||
}
|
||||
|
||||
// supports one and 2 bytes addresses
|
||||
void I2C_eeprom::_beginTransmission(uint16_t memoryAddress)
|
||||
void I2C_eeprom::_beginTransmission(const uint16_t memoryAddress)
|
||||
{
|
||||
Wire.beginTransmission(_deviceAddress);
|
||||
|
||||
@ -205,7 +214,7 @@ void I2C_eeprom::_beginTransmission(uint16_t memoryAddress)
|
||||
|
||||
// pre: length <= this->_pageSize && length <= I2C_TWIBUFFERSIZE;
|
||||
// returns 0 = OK otherwise error
|
||||
int I2C_eeprom::_WriteBlock(uint16_t memoryAddress, uint8_t* buffer, uint8_t length)
|
||||
int I2C_eeprom::_WriteBlock(const uint16_t memoryAddress, const uint8_t* buffer, const uint8_t length)
|
||||
{
|
||||
waitEEReady();
|
||||
|
||||
@ -220,7 +229,7 @@ int I2C_eeprom::_WriteBlock(uint16_t memoryAddress, uint8_t* buffer, uint8_t len
|
||||
|
||||
// pre: buffer is large enough to hold length bytes
|
||||
// returns bytes read
|
||||
uint8_t I2C_eeprom::_ReadBlock(uint16_t memoryAddress, uint8_t* buffer, uint8_t length)
|
||||
uint8_t I2C_eeprom::_ReadBlock(const uint16_t memoryAddress, uint8_t* buffer, const uint8_t length)
|
||||
{
|
||||
waitEEReady();
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
// FILE: I2C_eeprom.h
|
||||
// AUTHOR: Rob Tillaart
|
||||
// PURPOSE: I2C_eeprom library for Arduino with EEPROM 24LC256 et al.
|
||||
// VERSION: 1.1.00
|
||||
// VERSION: 1.2.02
|
||||
// HISTORY: See I2C_eeprom.cpp
|
||||
// URL: http://arduino.cc/playground/Main/LibraryForI2CEEPROM
|
||||
//
|
||||
@ -21,7 +21,7 @@
|
||||
#include "Wiring.h"
|
||||
#endif
|
||||
|
||||
#define I2C_EEPROM_VERSION "1.1.00"
|
||||
#define I2C_EEPROM_VERSION "1.2.02"
|
||||
|
||||
// The DEFAULT page size. This is overriden if you use the second constructor.
|
||||
// I2C_EEPROM_PAGESIZE must be multiple of 2 e.g. 16, 32 or 64
|
||||
@ -35,7 +35,7 @@
|
||||
// to break blocking read/write after n millis()
|
||||
#define I2C_EEPROM_TIMEOUT 1000
|
||||
|
||||
// comment next line to keep lib small
|
||||
// comment next line to keep lib small (idea a read only lib?)
|
||||
#define I2C_EEPROM_EXTENDED
|
||||
|
||||
class I2C_eeprom
|
||||
@ -44,7 +44,7 @@ public:
|
||||
/**
|
||||
* Initializes the EEPROM with a default pagesize of I2C_EEPROM_PAGESIZE.
|
||||
*/
|
||||
I2C_eeprom(uint8_t deviceAddress);
|
||||
I2C_eeprom(const uint8_t deviceAddress);
|
||||
|
||||
/**
|
||||
* Initializes the EEPROM for the given device address.
|
||||
@ -54,18 +54,18 @@ public:
|
||||
* @param deviceAddress Byte address of the device.
|
||||
* @param deviceSize Max size in bytes of the device (divide your device size in Kbits by 8)
|
||||
*/
|
||||
I2C_eeprom(uint8_t deviceAddress, unsigned int deviceSize);
|
||||
I2C_eeprom(const uint8_t deviceAddress, const unsigned int deviceSize);
|
||||
|
||||
void begin();
|
||||
int writeByte(uint16_t memoryAddress, uint8_t value);
|
||||
int writeBlock(uint16_t memoryAddress, uint8_t* buffer, uint16_t length);
|
||||
int setBlock(uint16_t memoryAddress, uint8_t value, uint16_t length);
|
||||
int writeByte(const uint16_t memoryAddress, const uint8_t value);
|
||||
int writeBlock(const uint16_t memoryAddress, const uint8_t* buffer, const uint16_t length);
|
||||
int setBlock(const uint16_t memoryAddress, const uint8_t value, const uint16_t length);
|
||||
|
||||
uint8_t readByte(uint16_t memoryAddress);
|
||||
uint16_t readBlock(uint16_t memoryAddress, uint8_t* buffer, uint16_t length);
|
||||
uint8_t readByte(const uint16_t memoryAddress);
|
||||
uint16_t readBlock(const uint16_t memoryAddress, uint8_t* buffer, const uint16_t length);
|
||||
|
||||
#ifdef I2C_EEPROM_EXTENDED
|
||||
uint8_t determineSize();
|
||||
int determineSize();
|
||||
#endif
|
||||
|
||||
private:
|
||||
@ -81,11 +81,11 @@ private:
|
||||
*
|
||||
* @param memoryAddress Address to write/read
|
||||
*/
|
||||
void _beginTransmission(uint16_t memoryAddress);
|
||||
void _beginTransmission(const uint16_t memoryAddress);
|
||||
|
||||
int _pageBlock(uint16_t memoryAddress, uint8_t* buffer, uint16_t length, bool incrBuffer);
|
||||
int _WriteBlock(uint16_t memoryAddress, uint8_t* buffer, uint8_t length);
|
||||
uint8_t _ReadBlock(uint16_t memoryAddress, uint8_t* buffer, uint8_t length);
|
||||
int _pageBlock(const uint16_t memoryAddress, const uint8_t* buffer, const uint16_t length, const bool incrBuffer);
|
||||
int _WriteBlock(const uint16_t memoryAddress, const uint8_t* buffer, const uint8_t length);
|
||||
uint8_t _ReadBlock(const uint16_t memoryAddress, uint8_t* buffer, const uint8_t length);
|
||||
|
||||
void waitEEReady();
|
||||
};
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
//
|
||||
// FILE: I2C_eeprom_test.ino
|
||||
// AUTHOR: Rob Tillaart
|
||||
// VERSION: 0.1.07
|
||||
// VERSION: 0.1.08
|
||||
// PURPOSE: show/test I2C_EEPROM library
|
||||
//
|
||||
|
||||
@ -15,7 +15,7 @@
|
||||
|
||||
I2C_eeprom ee(0x50);
|
||||
|
||||
uint32_t totals = 0;
|
||||
uint32_t start, diff, totals = 0;
|
||||
|
||||
void setup()
|
||||
{
|
||||
@ -28,6 +28,27 @@ void setup()
|
||||
SERIAL_OUT.print(I2C_EEPROM_VERSION);
|
||||
SERIAL_OUT.println("\n");
|
||||
|
||||
SERIAL_OUT.println("\nTEST: determine size");
|
||||
start = micros();
|
||||
int size = ee.determineSize();
|
||||
diff = micros() - start;
|
||||
SERIAL_OUT.print("TIME: ");
|
||||
SERIAL_OUT.println(diff);
|
||||
if (size > 0)
|
||||
{
|
||||
SERIAL_OUT.print("SIZE: ");
|
||||
SERIAL_OUT.print(size);
|
||||
SERIAL_OUT.println(" KB");
|
||||
} else if (size = 0)
|
||||
{
|
||||
SERIAL_OUT.println("WARNING: Can't determine eeprom size");
|
||||
}
|
||||
else
|
||||
{
|
||||
SERIAL_OUT.println("ERROR: Can't find eeprom\nstopped...");
|
||||
while(1);
|
||||
}
|
||||
|
||||
SERIAL_OUT.println("\nTEST: 64 byte page boundary writeBlock");
|
||||
ee.setBlock(0, 0, 128);
|
||||
dumpEEPROM(0, 128);
|
||||
@ -165,16 +186,6 @@ void setup()
|
||||
// does it go well?
|
||||
SERIAL_OUT.println(xx);
|
||||
|
||||
SERIAL_OUT.println("\nTEST: determine size");
|
||||
start = micros();
|
||||
int size = ee.determineSize();
|
||||
diff = micros() - start;
|
||||
SERIAL_OUT.print("TIME: ");
|
||||
SERIAL_OUT.println(diff);
|
||||
SERIAL_OUT.print("SIZE: ");
|
||||
SERIAL_OUT.print(size);
|
||||
SERIAL_OUT.println(" KB");
|
||||
|
||||
SERIAL_OUT.println("\tDone...");
|
||||
}
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user