X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Feeprom.c;h=fb83a07148022570b427da94a059479e167f1ef1;hb=5f3952176a4e9a00ca8dd5ec4a6b994958f89e0a;hp=1729a8949d73394385fae4d16192b5ac691d18e6;hpb=277b540c0764dd376dcf583acdc97a2b2fd3d8e6;p=bertos.git diff --git a/drv/eeprom.c b/drv/eeprom.c old mode 100755 new mode 100644 index 1729a894..fb83a071 --- a/drv/eeprom.c +++ b/drv/eeprom.c @@ -1,227 +1,81 @@ -/*! +/** * \file * * - * \version $Id$ - * - * \author Stefano Fedrigo - * \author Bernardo Innocenti - * * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (implementation) * * \note This implementation is AVR specific. + * + * \version $Id$ + * \author Stefano Fedrigo + * \author Bernardo Innocenti */ /*#* *#* $Log$ - *#* Revision 1.8 2004/08/25 14:12:08 rasky - *#* Aggiornato il comment block dei log RCS + *#* Revision 1.20 2006/07/19 12:56:25 bernie + *#* Convert to new Doxygen style. *#* - *#* Revision 1.7 2004/08/24 16:48:40 bernie - *#* Note reason for including + *#* Revision 1.19 2006/03/20 17:49:50 bernie + *#* Make the TWI driver more generic to work with devices other than EEPROMS. *#* - *#* Revision 1.6 2004/08/24 14:27:20 bernie - *#* Doxygen fix. + *#* Revision 1.18 2005/11/27 23:33:40 bernie + *#* Use appconfig.h instead of cfg/config.h. *#* - *#* Revision 1.5 2004/08/24 13:46:48 bernie - *#* Include . + *#* Revision 1.17 2005/04/11 19:10:27 bernie + *#* Include top-level headers from cfg/ subdir. *#* - *#* Revision 1.4 2004/08/10 06:57:22 bernie - *#* eeprom_erase(): New function. + *#* Revision 1.16 2005/03/01 23:25:09 bernie + *#* Prune CVS log. *#* - *#* Revision 1.3 2004/07/29 22:57:09 bernie - *#* Add 24LC16 support. + *#* Revision 1.11 2004/10/26 08:35:31 bernie + *#* Reset watchdog for long operations. *#* - *#* 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. + *#* 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. *#*/ #include "eeprom.h" -#include /* cpu_to_be16() */ -#include -#include -#include // MIN() - -#include // memset() - -#include - - -/* Wait for TWINT flag set: bus is ready */ -#define WAIT_TWI_READY do {} while (!(TWCR & BV(TWINT))) - -/*! \name EEPROM control codes */ -/*@{*/ -#define SLA_W 0xA0 -#define SLA_R 0xA1 -/*@}*/ - - -/*! - * Send START condition on the bus. - * - * \return true on success, false otherwise. - */ -static bool twi_start(void) -{ - TWCR = BV(TWINT) | BV(TWSTA) | BV(TWEN); - WAIT_TWI_READY; - - if (TW_STATUS == TW_START || TW_STATUS == TW_REP_START) - return true; - - DB(kprintf("!TW_(REP)START: %x\n", TWSR);) - return false; -} - - -/*! - * Send START condition and select slave for write. - * - * \return true on success, false otherwise. - */ -static bool twi_start_w(uint8_t slave_addr) -{ - ASSERT(slave_addr < 8); - - /* - * 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 << 1); - TWCR = BV(TWINT) | BV(TWEN); - WAIT_TWI_READY; - - if (TW_STATUS == TW_MT_SLA_ACK) - return true; - else if (TW_STATUS != TW_MT_SLA_NACK) - { - DB(kprintf("!TW_MT_SLA_(N)ACK: %x\n", TWSR);) - break; - } - } +#include +#include // CONFIG_EEPROM_VERIFY +#include // MIN() +#include +#include +#include // cpu_to_be16() - return false; -} +#include // memset() -/*! - * Send START condition and select slave for read. - * - * \return true on success, false otherwise. - */ -static bool twi_start_r(uint8_t slave_addr) -{ - ASSERT(slave_addr < 8); - - if (twi_start()) - { - TWDR = SLA_R | (slave_addr << 1); - TWCR = BV(TWINT) | BV(TWEN); - WAIT_TWI_READY; - - if (TW_STATUS == TW_MR_SLA_ACK) - return true; - - DB(kprintf("!TW_MR_SLA_ACK: %x\n", TWSR);) - } - - return false; -} - +// 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 -/*! - * Send STOP condition. +/** + * EEPROM ID code */ -static void twi_stop(void) -{ - TWCR = BV(TWINT) | BV(TWEN) | BV(TWSTO); -} +#define EEPROM_ID 0xA0 - -/*! - * Send a sequence of bytes in master transmitter mode - * to the selected slave device through the TWI bus. - * - * \return true on success, false on error. +/** + * This macros form the correct slave address for EEPROMs */ -static bool twi_send(const uint8_t *buf, size_t count) -{ - while (count--) - { - TWDR = *buf++; - TWCR = BV(TWINT) | BV(TWEN); - WAIT_TWI_READY; - if (TW_STATUS != TW_MT_DATA_ACK) - { - DB(kprintf("!TW_MT_DATA_ACK: %x\n", TWSR);) - return false; - } - } - - return true; -} - +#define EEPROM_ADDR(x) (EEPROM_ID | (((uint8_t)(x)) << 1)) -/*! - * Receive a sequence of one or more bytes from the - * selected slave device in master receive mode through - * the TWI bus. - * - * Received data is placed in \c buf. - * - * \return true on success, false on error - */ -static bool twi_recv(uint8_t *buf, size_t count) -{ - /* - * When reading the last byte the TWEA bit is not - * set, and the eeprom should answer with NACK - */ - while (count--) - { - TWCR = BV(TWINT) | BV(TWEN) | (count ? BV(TWEA) : 0); - WAIT_TWI_READY; - if (count) - { - if (TW_STATUS != TW_MR_DATA_ACK) - { - DB(kprintf("!TW_MR_DATA_ACK: %x\n", TWSR);) - return false; - } - } - else - { - if (TW_STATUS != TW_MR_DATA_NACK) - { - DB(kprintf("!TW_MR_DATA_NACK: %x\n", TWSR);) - return false; - } - } - *buf++ = TWDR; - } - return true; -} -/*! +/** * Copy \c count bytes from buffer \c buf to * eeprom at address \c addr. */ -bool eeprom_write(e2addr_t addr, const void *buf, size_t count) +static bool eeprom_writeRaw(e2addr_t addr, const void *buf, size_t count) { bool result = true; ASSERT(addr + count <= EEPROM_SIZE); @@ -244,7 +98,7 @@ bool eeprom_write(e2addr_t addr, const void *buf, size_t count) uint8_t blk_offs = (uint8_t)addr; result = - twi_start_w(blk_addr) + twi_start_w(EEPROM_ADDR(blk_addr)) && twi_send(&blk_offs, sizeof blk_offs) && twi_send(buf, size); @@ -254,7 +108,7 @@ bool eeprom_write(e2addr_t addr, const void *buf, size_t count) uint16_t addr_be = cpu_to_be16(addr); result = - twi_start_w(0) + twi_start_w(EEPROM_ID) && twi_send((uint8_t *)&addr_be, sizeof addr_be) && twi_send(buf, size); @@ -276,13 +130,78 @@ bool eeprom_write(e2addr_t addr, const void *buf, size_t count) 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. + * + * \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) +{ +#if CONFIG_EEPROM_VERIFY + int retries = 5; + + while (retries--) + if (eeprom_writeRaw(addr, buf, count) + && eeprom_verify(addr, buf, count)) + return true; -/*! + return false; + +#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) { @@ -297,9 +216,9 @@ bool eeprom_read(e2addr_t addr, void *buf, size_t count) uint8_t blk_offs = (uint8_t)addr; bool res = - twi_start_w(blk_addr) + twi_start_w(EEPROM_ADDR(blk_addr)) && twi_send(&blk_offs, sizeof blk_offs) - && twi_start_r(blk_addr) + && twi_start_r(EEPROM_ADDR(blk_addr)) && twi_recv(buf, count); #elif CONFIG_EEPROM_TYPE == EEPROM_24XX256 @@ -308,9 +227,9 @@ bool eeprom_read(e2addr_t addr, void *buf, size_t count) addr = cpu_to_be16(addr); bool res = - twi_start_w(0) + twi_start_w(EEPROM_ID) && twi_send((uint8_t *)&addr, sizeof(addr)) - && twi_start_r(0) + && twi_start_r(EEPROM_ID) && twi_recv(buf, count); #else #error Unknown device type @@ -318,11 +237,13 @@ bool eeprom_read(e2addr_t addr, void *buf, size_t count) twi_stop(); + if (!res) + TRACEMSG("Read error!"); return res; } -/*! +/** * Write a single character \a c at address \a addr. */ bool eeprom_write_char(e2addr_t addr, char c) @@ -331,7 +252,7 @@ bool eeprom_write_char(e2addr_t addr, char c) } -/*! +/** * Read a single character at address \a addr. * * \return the requested character or -1 in case of failure. @@ -347,7 +268,7 @@ int eeprom_read_char(e2addr_t addr) } -/*! +/** * Erase specified part of eeprom, writing 0xFF. * * \param addr starting address @@ -361,6 +282,9 @@ void eeprom_erase(e2addr_t addr, size_t count) // 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; @@ -369,36 +293,12 @@ void eeprom_erase(e2addr_t addr, size_t count) } -/*! +/** * Initialize TWI module. */ void eeprom_init(void) { - cpuflags_t flags; - DISABLE_IRQSAVE(flags); - -#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 */ - - TWBR = (CLOCK_FREQ / (2 * TWI_FREQ * TWI_PRESC)) - (8 / TWI_PRESC); - TWSR = 0; - TWCR = BV(TWEN); - - ENABLE_IRQRESTORE(flags); + twi_init(); } @@ -408,17 +308,21 @@ void eeprom_init(void) void eeprom_test(void) { - static const char magic[13] = "Humpty Dumpty"; - char buf[sizeof magic + 1]; + 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) + { + wdt_reset(); eeprom_write(i * sizeof magic, magic, sizeof magic); + } // Read back with single-byte reads for (i = 0; i < 42 * sizeof magic; ++i) { + wdt_reset(); eeprom_read(i, buf, 1); kprintf("EEPROM byte read: %c (%d)\n", buf[0], buf[0]); ASSERT(buf[0] == magic[i % sizeof magic]); @@ -427,6 +331,7 @@ void eeprom_test(void) // Read back again using sequential reads for (i = 0; i < 42; ++i) { + wdt_reset(); 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);