X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Feeprom.c;h=e951daee5b20bcf2cdb71cdf3c5e518ed9b47947;hb=06f0503a2066ab4fd13529b8ed8906e52b1d672b;hp=e73e1f53fa412bd6c67b9dcc564d45030b9d51a7;hpb=8e90a9cdc1bf5a30c92edcc218e9cc16327d7d21;p=bertos.git diff --git a/drv/eeprom.c b/drv/eeprom.c index e73e1f53..e951daee 100755 --- a/drv/eeprom.c +++ b/drv/eeprom.c @@ -2,30 +2,79 @@ * \file * * - * \version $Id$ + * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (implementation) * - * \author Stefano Fedrigo + * \note This implementation is AVR specific. * - * \brief I2C eeprom driver + * \version $Id$ + * \author Stefano Fedrigo + * \author Bernardo Innocenti */ -/* - * $Log$ - * Revision 1.1 2004/07/20 17:11:18 bernie - * Import into DevLib. - * - */ +/*#* + *#* $Log$ + *#* Revision 1.13 2004/11/16 20:58:51 bernie + *#* Add write verify. + *#* + *#* Revision 1.12 2004/11/02 17:50:01 bernie + *#* CONFIG_EEPROM_VERIFY: New config option. + *#* + *#* Revision 1.11 2004/10/26 08:35:31 bernie + *#* Reset watchdog for long operations. + *#* + *#* Revision 1.10 2004/09/20 03:31:22 bernie + *#* Sanitize for C++. + *#* + *#* Revision 1.9 2004/09/14 21:03:46 bernie + *#* Use debug.h instead of kdebug.h. + *#* + *#* Revision 1.8 2004/08/25 14:12:08 rasky + *#* Aggiornato il comment block dei log RCS + *#* + *#* Revision 1.7 2004/08/24 16:48:40 bernie + *#* Note reason for including + *#* + *#* Revision 1.6 2004/08/24 14:27:20 bernie + *#* Doxygen fix. + *#* + *#* Revision 1.5 2004/08/24 13:46:48 bernie + *#* Include . + *#* + *#* Revision 1.4 2004/08/10 06:57:22 bernie + *#* eeprom_erase(): New function. + *#* + *#* Revision 1.3 2004/07/29 22:57:09 bernie + *#* Add 24LC16 support. + *#* + *#* Revision 1.2 2004/07/22 01:24:43 bernie + *#* Document AVR dependency. + *#* + *#* Revision 1.1 2004/07/20 17:11:18 bernie + *#* Import into DevLib. + *#* + *#*/ #include "eeprom.h" + +#include #include /* cpu_to_be16() */ -#include +#include #include +#include // CONFIG_EEPROM_VERIFY +#include // MIN() + +#include // memset() #include +// Configuration sanity checks +#if !defined(CONFIG_EEPROM_VERIFY) || (CONFIG_EEPROM_VERIFY != 0 && CONFIG_EEPROM_VERIFY != 1) + #error CONFIG_EEPROM_VERIFY must be defined to either 0 or 1 +#endif + /* Wait for TWINT flag set: bus is ready */ #define WAIT_TWI_READY do {} while (!(TWCR & BV(TWINT))) @@ -62,16 +111,17 @@ static bool twi_start(void) */ static bool twi_start_w(uint8_t slave_addr) { - //TRACE; + ASSERT(slave_addr < 8); - /* Do a loop on the select write sequence because if the - * eeprom is busy writing precedently sent data it will respond - * with NACK to the SLA_W control byte. In this case we have - * to try until the eeprom reply with an ACK. + /* + * Loop on the select write sequence: when the eeprom is busy + * writing previously sent data it will reply to the SLA_W + * control byte with a NACK. In this case, we must + * keep trying until the eeprom responds with an ACK. */ while (twi_start()) { - TWDR = SLA_W | ((slave_addr & 0x5) << 1); + TWDR = SLA_W | (slave_addr << 1); TWCR = BV(TWINT) | BV(TWEN); WAIT_TWI_READY; @@ -95,11 +145,11 @@ static bool twi_start_w(uint8_t slave_addr) */ static bool twi_start_r(uint8_t slave_addr) { - //TRACE; + ASSERT(slave_addr < 8); if (twi_start()) { - TWDR = SLA_R | ((slave_addr & 0x5) << 1); + TWDR = SLA_R | (slave_addr << 1); TWCR = BV(TWINT) | BV(TWEN); WAIT_TWI_READY; @@ -118,8 +168,6 @@ static bool twi_start_r(uint8_t slave_addr) */ static void twi_stop(void) { - //TRACE; - TWCR = BV(TWINT) | BV(TWEN) | BV(TWSTO); } @@ -130,9 +178,9 @@ static void twi_stop(void) * * \return true on success, false on error. */ -static bool twi_send(const uint8_t *buf, size_t count) +static bool twi_send(const void *_buf, size_t count) { - //TRACE; + const uint8_t *buf = (const uint8_t *)_buf; while (count--) { @@ -159,9 +207,9 @@ static bool twi_send(const uint8_t *buf, size_t count) * * \return true on success, false on error */ -static bool twi_recv(uint8_t *buf, size_t count) +static bool twi_recv(void *_buf, size_t count) { - //TRACE; + uint8_t *buf = (uint8_t *)_buf; /* * When reading the last byte the TWEA bit is not @@ -194,37 +242,159 @@ static bool twi_recv(uint8_t *buf, size_t count) return true; } - /*! * Copy \c count bytes from buffer \c buf to * eeprom at address \c addr. + */ +static bool eeprom_writeRaw(e2addr_t addr, const void *buf, size_t count) +{ + bool result = true; + ASSERT(addr + count <= EEPROM_SIZE); + + while (count && result) + { + /* + * Split write in multiple sequential mode operations that + * don't cross page boundaries. + */ + size_t size = + MIN(count, (size_t)(EEPROM_BLKSIZE - (addr & (EEPROM_BLKSIZE - 1)))); + + #if CONFIG_EEPROM_TYPE == EEPROM_24XX16 + /* + * The 24LC16 uses the slave address as a 3-bit + * block address. + */ + uint8_t blk_addr = (uint8_t)((addr >> 8) & 0x07); + uint8_t blk_offs = (uint8_t)addr; + + result = + twi_start_w(blk_addr) + && twi_send(&blk_offs, sizeof blk_offs) + && twi_send(buf, size); + + #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256 + + // 24LC256 wants big-endian addresses + uint16_t addr_be = cpu_to_be16(addr); + + result = + twi_start_w(0) + && twi_send((uint8_t *)&addr_be, sizeof addr_be) + && twi_send(buf, size); + + #else + #error Unknown device type + #endif + + twi_stop(); + + // DEBUG + //kprintf("addr=%d, count=%d, size=%d, *#?=%d\n", + // addr, count, size, + // (EEPROM_BLKSIZE - (addr & (EEPROM_BLKSIZE - 1))) + //); + + /* Update count and addr for next operation */ + count -= size; + addr += size; + buf = ((const char *)buf) + size; + } + + if (!result) + TRACEMSG("Write error!"); + return result; +} + + +#if CONFIG_EEPROM_VERIFY +/*! + * Check that the contents of an EEPROM range + * match with a provided data buffer. * - * \note No check is done for data crossing page - * boundaries. + * \return true on success. */ +static bool eeprom_verify(e2addr_t addr, const void *buf, size_t count) +{ + uint8_t verify_buf[16]; + bool result = true; + + while (count && result) + { + /* Split read in smaller pieces */ + size_t size = MIN(count, sizeof verify_buf); + + /* Read back buffer */ + if (eeprom_read(addr, verify_buf, size)) + { + if (memcmp(buf, verify_buf, size) != 0) + { + TRACEMSG("Data mismatch!"); + result = false; + } + } + else + { + TRACEMSG("Read error!"); + result = false; + } + + /* Update count and addr for next operation */ + count -= size; + addr += size; + buf = ((const char *)buf) + size; + } + + return result; +} +#endif /* CONFIG_EEPROM_VERIFY */ + + bool eeprom_write(e2addr_t addr, const void *buf, size_t count) { - // eeprom accepts address as big endian - addr = cpu_to_be16(addr); +#if CONFIG_EEPROM_VERIFY + int retries = 5; - bool res = - twi_start_w(0) - && twi_send((uint8_t *)&addr, sizeof(addr)) - && twi_send(buf, count); + while (retries--) + if (eeprom_writeRaw(addr, buf, count) + && eeprom_verify(addr, buf, count)) + return true; - twi_stop(); + return false; - return res; +#else /* !CONFIG_EEPROM_VERIFY */ + return eeprom_writeRaw(addr, buf, count); +#endif /* !CONFIG_EEPROM_VERIFY */ } /*! * Copy \c count bytes at address \c addr * from eeprom to RAM to buffer \c buf. + * + * \return true on success. */ bool eeprom_read(e2addr_t addr, void *buf, size_t count) { - // eeprom accepts address as big endian + ASSERT(addr + count <= EEPROM_SIZE); + +#if CONFIG_EEPROM_TYPE == EEPROM_24XX16 + /* + * The 24LC16 uses the slave address as a 3-bit + * block address. + */ + uint8_t blk_addr = (uint8_t)((addr >> 8) & 0x07); + uint8_t blk_offs = (uint8_t)addr; + + bool res = + twi_start_w(blk_addr) + && twi_send(&blk_offs, sizeof blk_offs) + && twi_start_r(blk_addr) + && twi_recv(buf, count); + +#elif CONFIG_EEPROM_TYPE == EEPROM_24XX256 + + // 24LC256 wants big-endian addresses addr = cpu_to_be16(addr); bool res = @@ -232,9 +402,14 @@ bool eeprom_read(e2addr_t addr, void *buf, size_t count) && twi_send((uint8_t *)&addr, sizeof(addr)) && twi_start_r(0) && twi_recv(buf, count); +#else + #error Unknown device type +#endif twi_stop(); + if (!res) + TRACEMSG("Read error!"); return res; } @@ -264,6 +439,31 @@ int eeprom_read_char(e2addr_t addr) } +/*! + * Erase specified part of eeprom, writing 0xFF. + * + * \param addr starting address + * \param count length of block to erase + */ +void eeprom_erase(e2addr_t addr, size_t count) +{ + uint8_t buf[EEPROM_BLKSIZE]; + memset(buf, 0xFF, sizeof buf); + + // Clear all but struct hw_info at start of eeprom + while (count) + { + // Long operation, reset watchdog + wdt_reset(); + + size_t size = MIN(count, sizeof buf); + eeprom_write(addr, buf, size); + addr += size; + count -= size; + } +} + + /*! * Initialize TWI module. */ @@ -272,18 +472,33 @@ void eeprom_init(void) cpuflags_t flags; DISABLE_IRQSAVE(flags); - DDRD |= BV(PORTD0) | BV(PORTD1); - PORTD |= BV(PORTD0) | BV(PORTD1); + /* + * This is pretty useless according to AVR's datasheet, + * but it helps us driving the TWI data lines on boards + * where the bus pull-up resistors are missing. This is + * probably due to some unwanted interaction between the + * port pin and the TWI lines. + */ +#if defined(__AVR_ATmega64__) + PORTD |= BV(PD0) | BV(PD1); + DDRD |= BV(PD0) | BV(PD1); +#elif defined(__AVR_ATmega8__) + PORTC |= BV(PC4) | BV(PC5); + DDRC |= BV(PC4) | BV(PC5); +#else + #error Unsupported architecture +#endif /* * Set speed: * F = CLOCK_FREQ / (16 + 2*TWBR * 4^TWPS) */ -# define TWI_FREQ 300000 /* 300 kHz */ -# define TWI_PRESC 1 /* 4 ^ TWPS */ + #define TWI_FREQ 100000 /* ~100 kHz */ + #define TWI_PRESC 1 /* 4 ^ TWPS */ TWBR = (CLOCK_FREQ / (2 * TWI_FREQ * TWI_PRESC)) - (8 / TWI_PRESC); TWSR = 0; + TWCR = BV(TWEN); ENABLE_IRQRESTORE(flags); } @@ -291,16 +506,34 @@ void eeprom_init(void) #ifdef _DEBUG +#include + void eeprom_test(void) { - static const char magic[] = "Humpty Dumpty"; + static const char magic[14] = "Humpty Dumpty"; char buf[sizeof magic]; + size_t i; + + // Write something to EEPROM using unaligned sequential writes + for (i = 0; i < 42; ++i) + eeprom_write(i * sizeof magic, magic, sizeof magic); - // Write something to EEPROM and read it back - eeprom_write(0, magic, sizeof magic); - eeprom_read(0, buf, sizeof buf); - kprintf("EEPROM read: %s\n", buf); + // Read back with single-byte reads + for (i = 0; i < 42 * sizeof magic; ++i) + { + eeprom_read(i, buf, 1); + kprintf("EEPROM byte read: %c (%d)\n", buf[0], buf[0]); + ASSERT(buf[0] == magic[i % sizeof magic]); + } + + // Read back again using sequential reads + for (i = 0; i < 42; ++i) + { + memset(buf, 0, sizeof buf); + eeprom_read(i * sizeof magic, buf, sizeof magic); + kprintf("EEPROM seq read @ 0x%x: '%s'\n", i * sizeof magic, buf); + ASSERT(memcmp(buf, magic, sizeof magic) == 0); + } } #endif // _DEBUG -