CONFIG_EEPROM_VERIFY: New config option.
[bertos.git] / drv / eeprom.c
index ed5db170c8156430062239921f334aa8af27646d..cf5da31ad7f2d8d3d81b993965f16648bdf2d3bb 100755 (executable)
@@ -2,55 +2,76 @@
  * \file
  * <!--
  * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
- * All Rights Reserved.
+ * This file is part of DevLib - See devlib/README for information.
  * -->
  *
- * \version $Id$
- *
- * \author Stefano Fedrigo <aleph@develer.com>
- * \author Bernardo Innocenti <bernie@develer.com>
- *
  * \brief Driver for the 24xx16 and 24xx256 I2C EEPROMS (implementation)
  *
  * \note This implementation is AVR specific.
- */
-
-/*
- * $Log$
- * Revision 1.7  2004/08/24 16:48:40  bernie
- * Note reason for including <macros.h>
- *
- * Revision 1.6  2004/08/24 14:27:20  bernie
- * Doxygen fix.
- *
- * Revision 1.5  2004/08/24 13:46:48  bernie
- * Include <macros.h>.
- *
- * 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.
  *
+ * \version $Id$
+ * \author Stefano Fedrigo <aleph@develer.com>
+ * \author Bernardo Innocenti <bernie@develer.com>
  */
 
+/*#*
+ *#* $Log$
+ *#* 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 <macros.h>
+ *#*
+ *#* Revision 1.6  2004/08/24 14:27:20  bernie
+ *#* Doxygen fix.
+ *#*
+ *#* Revision 1.5  2004/08/24 13:46:48  bernie
+ *#* Include <macros.h>.
+ *#*
+ *#* 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 <drv/wdt.h>
 #include <mware/byteorder.h> /* cpu_to_be16() */
-#include <drv/kdebug.h>
+#include <debug.h>
 #include <hw.h>
+#include <config.h>  // CONFIG_EEPROM_VERIFY
 #include <macros.h>  // MIN()
 
-#include <string.h> // memset()
+#include <string.h>  // memset()
 
 #include <avr/twi.h>
 
+// 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)))
@@ -154,8 +175,10 @@ 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)
 {
+       const uint8_t *buf = (const uint8_t *)_buf;
+
        while (count--)
        {
                TWDR = *buf++;
@@ -181,8 +204,10 @@ 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)
 {
+       uint8_t *buf = (uint8_t *)_buf;
+
        /*
         * When reading the last byte the TWEA bit is not
         * set, and the eeprom should answer with NACK
@@ -218,7 +243,7 @@ static bool twi_recv(uint8_t *buf, size_t count)
  * 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);
@@ -277,9 +302,70 @@ bool eeprom_write(e2addr_t addr, const void *buf, size_t count)
 }
 
 
+#if CONFIG_EEPROM_VERIFY
+/*!
+ * Check that the contents of an EEPROM range
+ * match with a provided data buffer.
+ */
+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!\n");
+                               result = false;
+                       }
+               }
+               else
+               {
+                       TRACEMSG("Read error!\n");
+                       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)
 {
@@ -358,6 +444,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;
@@ -405,8 +494,8 @@ 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